Technical Reference Guide
Uploaded by
monjezi.vTechnical Reference Guide
Uploaded by
monjezi.vStruxureWare Building Operation
Technical
Reference Guide
04-16006-04-en
March 2015
StruxureWare Building Operation
Technical
Reference Guide
04-16006-04-en
March 2015
Copyright © 2015 Schneider Electric. All rights reserved.
The Schneider Electric brand and any registered trademarks of Schneider Electric Industries SAS referred to in this guide are the sole property of Schneider
Electric SA and its subsidiaries. They may not be used for any purpose without the owner's permission, given in writing. This guide and its content are
protected, within the meaning of the French intellectual property code (Code de la propriété intellectuelle français, referred to hereafter as "the Code"), under
the laws of copyright covering texts, drawings and models, as well as by trademark law. You agree not to reproduce, other than for your own personal, non-
commercial use as defined in the Code, all or part of this guide on any medium whatsoever without Schneider Electric's permission, given in writing. You also
agree not to establish any hypertext links to this guide or its content. Schneider Electric does not grant any right or license for the personal and non-
commercial use of the guide or its content, except for a non-exclusive license to consult it on an "as is" basis, at your own risk. All other rights are reserved.
Trademarks and registered trademarks are the property of their respective owners.
Contents
Introduction
1 About This Guide ....................................................... 117
1.1 Purpose of This Guide ............................................................... 119
1.2 How This Guide is Organized .................................................... 120
1.3 Typographical Conventions ....................................................... 121
2 Additional Information ................................................ 123
2.1 Where to Find Additional Information ......................................... 125
2.2 Regulatory Notices .................................................................... 127
Reference
3 Building Operation Servers ......................................... 131
3.1 Server Overview ........................................................................ 133
3.1.1 Project Configuration Server .................................................... 135
3.1.2 Enterprise Server .................................................................... 135
3.1.3 Automation Server .................................................................. 135
3.1.4 Server System ........................................................................ 135
3.1.5 Automation Server Web Configuration Page ............................ 135
3.2 Enterprise Server ...................................................................... 136
3.2.1 Engineering ............................................................................. 136
3.2.2 Features ................................................................................. 136
3.2.3 The Enterprise Server in Context ............................................. 137
3.3 Server System .......................................................................... 138
3.3.1 Server Communication ............................................................ 139
3.3.2 Server Status .......................................................................... 139
3.3.3 Server Management ................................................................ 139
3.4 Server Management .................................................................. 140
3.5 Device Discovery ....................................................................... 141
3.6 Automation Server .................................................................... 142
3.6.1 Central I/O and Field Busses ................................................... 142
3.6.2 Features ................................................................................. 143
3.6.3 SNMP ..................................................................................... 144
3.6.4 Automation Server Upgrade .................................................... 145
3.7 Creating an Automation Server .................................................. 146
04-16006-04-en, March 2015 Technical
5
3.8 Creating an Automation Server from a Backup Set .................... 148
3.9 Deleting an Automation Server .................................................. 151
3.10 Renaming a Server .................................................................... 152
3.11 Connecting to an Automation Server Using the USB Device
Port .......................................................................................... 153
3.12 Connecting to an Automation Server Using the IP Network ........ 154
3.13 Saving a List of Automation Servers .......................................... 155
3.14 Restoring a List of Automation Servers ...................................... 156
3.15 Setting Device Log On Options ................................................. 157
3.16 Getting Automation Server Debug Information ........................... 158
3.17 Identifying the Automation Server IP Address ............................ 159
3.18 Setting the Automation Server IP Address ................................. 160
3.19 Configuring an Automation Server to Use DHCP ....................... 162
3.20 Configuring the Time for an Automation Server with Factory
Settings .................................................................................... 163
3.21 Restoring the Software of a Damaged Automation Server ......... 164
3.22 Creating an SNMP User ............................................................ 165
3.23 Automation Server Upgrade ..................................................... 166
3.23.1 Set Time on Device ................................................................. 166
3.23.2 Status ..................................................................................... 167
3.23.3 Conversion Logs ..................................................................... 167
3.24 Server Object Properties ........................................................... 168
3.25 Displaying CPU and System Memory Usage ............................. 169
4 Server Communication .............................................. 171
4.1 Server Communication ............................................................. 173
4.1.1 Communication Parameters .................................................... 173
4.1.2 Server Communication Parameters ......................................... 173
4.1.3 Server-to-Server Communication Parameters ......................... 175
4.1.4 Server Communication in Project Configuration Server ............ 176
4.1.5 E-mail Server Settings ............................................................. 176
4.2 Server Status ............................................................................ 177
4.2.1 Offline Server Causes .............................................................. 177
4.2.2 Offline Server Problems ........................................................... 177
4.3 Repairing Server Communication ............................................. 178
4.4 Updating Communication Parameters ....................................... 179
4.5 Updating References ................................................................ 180
4.6 Selecting the Schneider Electric E-mail Server for E-mail
Notifications .............................................................................. 181
4.7 Selecting and Specifying an E-mail Server for E-mail
Notifications .............................................................................. 183
4.8 Server Communication in Project Configuration Server ............. 186
4.9 Updating Project Configuration Server Communication
Parameters ............................................................................... 187
4.10 Setting Server Logon Credential ................................................ 188
5 WorkStation for Projects Introduction ......................... 189
5.1 WorkStation for Projects Overview ............................................ 191
Technical 04-16006-04-en, March 2015
6
5.1.1 Project Configuration Server .................................................... 191
5.1.2 Compatibility Notes ................................................................. 191
5.1.3 WorkStation for Projects ......................................................... 191
5.1.4 Projects .................................................................................. 191
5.1.5 Project Configuration Server Backup and Restore ................... 192
5.1.6 Server Communication in Project Configuration Server ........... 192
5.1.7 Time Zone Configuration in Project Configuration Server ........ 192
5.2 Project Configuration Server ..................................................... 193
5.2.1 Engineering ............................................................................. 194
5.2.2 Features ................................................................................. 194
5.2.3 License ................................................................................... 195
5.3 Compatibility Notes ................................................................... 196
5.3.1 INET Interface ......................................................................... 196
5.3.2 MNL LonWorks ....................................................................... 196
5.3.3 Reports .................................................................................. 196
5.3.4 Sigma ..................................................................................... 196
5.3.5 Script Debugger ...................................................................... 196
5.4 Installing the Project Configuration Server .................................. 197
5.5 Upgrading the Project Configuration Server ............................... 203
5.6 Configuring Server Port Settings ............................................... 208
5.7 Stopping the Project Configuration Server Windows Service ..... 209
5.8 Starting the Project Configuration Server Windows Service ........ 210
5.9 Restarting the Server Windows Service ..................................... 211
5.10 Uninstalling the Project Configuration Server ............................. 212
5.11 Reinstalling the Project Configuration Server .............................. 215
5.12 WorkStation for Projects .......................................................... 220
5.12.1 Log on to WorkStation for Projects .......................................... 220
5.12.2 License ................................................................................... 220
5.12.3 WorkStation for Projects User Account Management .............. 220
5.13 Log on to WorkStation for Projects ............................................ 221
5.14 Logging on to WorkStation for Projects ..................................... 222
5.15 Logging off WorkStation for Projects ......................................... 223
5.16 WorkStation for Projects User Account Management ................ 224
5.16.1 Administrator Account ............................................................ 224
5.16.2 User Account .......................................................................... 224
5.17 Creating a WorkStation for Projects User Account ..................... 225
5.18 Deleting a WorkStation for Projects User Account ..................... 228
5.19 Changing the WorkStation for Projects User Password ............. 229
5.20 Changing other WorkStation for Projects Users Password ......... 230
5.21 Disabling a WorkStation for Projects User Account .................... 231
5.22 Enabling a WorkStation for Projects User Account ..................... 232
5.23 Setting an Expiration Date for a WorkStation for Projects User
Account .................................................................................... 233
5.24 Removing the Expiration Date for a WorkStation for Projects User
Account .................................................................................... 234
5.25 Forcing WorkStation for Projects User to Change Password ...... 235
04-16006-04-en, March 2015 Technical
7
6 WorkStation for Projects Projects ............................... 237
6.1 Projects .................................................................................... 239
6.1.1 Deploy .................................................................................... 239
6.1.2 Synchronization Events ........................................................... 239
6.1.3 Project Upgrade ...................................................................... 239
6.2 Creating a Project ..................................................................... 240
6.3 Opening a Project ..................................................................... 241
6.4 Closing a Project ....................................................................... 242
6.5 Deleting a Project ...................................................................... 243
6.6 Creating an Enterprise Server in a Project .................................. 244
6.7 Creating an Automation Server in a Project ................................ 246
6.8 Deploy ...................................................................................... 248
6.8.1 Deploy Workflow ..................................................................... 249
6.8.2 Alternative Deploy Workflow .................................................... 249
6.8.3 Variables in Project Configuration Server ................................. 250
6.9 Deploy Workflow ....................................................................... 251
6.10 Alternative Deploy Workflow ...................................................... 254
6.11 Variables in Project Configuration Server .................................. 259
6.12 Deploying a Server .................................................................... 260
6.13 Moving a Project Database ....................................................... 261
6.14 Synchronization Events ............................................................. 265
6.15 Viewing Synchronization Events ................................................ 266
6.16 Project Upgrade ....................................................................... 267
6.16.1 Parallel installation of new version of Project Configuration
Server ..................................................................................... 267
6.16.2 Upgrade of Project Configuration Server ................................. 267
6.17 Upgrading a Project .................................................................. 268
7 Project Configuration Server Time Zone ..................... 269
7.1 Time and Time Zone ................................................................. 271
7.1.1 Network Time ......................................................................... 271
7.1.2 Time and Time Zone Configuration in WorkStation .................. 271
7.1.3 Time and Time Zone Configuration in Enterprise Server ........... 271
7.1.4 Time and Time Zone Configuration in Automation Server ......... 271
7.2 Time Zone Configuration in Project Configuration Server ........... 272
7.3 Changing the Time Zone of a Project ......................................... 273
7.4 Creating a Custom Time Zone for a Project ............................... 275
8 Project Configuration Server Backup and Restore
Overview .................................................................... 277
8.1 Backup and Restore Overview .................................................. 279
8.1.1 Backup ................................................................................... 279
8.1.2 Restore ................................................................................... 279
8.1.3 BACnet Backup and Restore .................................................. 279
8.1.4 Archiving Overview .................................................................. 280
8.1.5 Comparison of Backup and Restore Methods ......................... 280
8.2 Project Backup and Restore ..................................................... 281
8.2.1 Project Backup ....................................................................... 281
Technical 04-16006-04-en, March 2015
8
8.2.2 Project Restore ....................................................................... 281
8.3 Project Backup ......................................................................... 282
8.3.1 Project Configuration Server Backup Sets ............................... 282
8.3.2 Project Configuration Server Backup Status ............................ 282
8.4 Project Configuration Server Backup Sets ................................. 284
8.4.1 Backup Set Storage and Protection ........................................ 284
8.5 Backup Set Storage and Protection .......................................... 285
8.6 Project Configuration Backup Status ......................................... 286
8.7 Checking the Backup Status of a Project ................................... 287
8.8 Backing Up a Project ................................................................ 288
8.9 Locating the Local Backup Path on the Project Configuration
Server ....................................................................................... 290
8.10 Deleting a Backup Set from a Project ........................................ 291
8.11 Project Restore ......................................................................... 292
8.11.1 Restored Data ......................................................................... 292
8.12 Restored Data ........................................................................... 293
8.13 Restoring a Project .................................................................... 294
9 WorkStation for Projects User Interface ..................... 297
9.1 Software Administrator – Project Configuration Server View ...... 299
9.2 Building Operation WorkStation for Projects Window ................. 301
9.3 WorkStation for Projects View ................................................... 303
9.4 WorkStation for Projects – Projects View ................................... 305
9.5 WorkStation for Projects – Users View ...................................... 306
9.6 WorkStation for Projects Manager Toolbar ................................ 307
9.7 WorkStation for Projects Toolbar ............................................... 308
9.8 File Menu ................................................................................. 310
9.9 Actions Menu ............................................................................ 312
9.10 Synchronization Event View ....................................................... 321
9.11 Create Object Wizard – Naming the Object Page ...................... 322
9.12 Create Object Wizard – Server Information Page ....................... 323
9.13 Create Report Wizard – Select Report Pack Page ..................... 324
9.14 Confirm Deploy Dialog Box ....................................................... 325
9.15 Progress View – Advanced ....................................................... 326
9.15.1 Detail View .............................................................................. 326
9.16 Operation Details Dialog Box ..................................................... 328
9.17 Project Control Panel View ........................................................ 329
9.18 Backup and Restore Manager on the Project Configuration
Server ....................................................................................... 330
9.19 WorkStation for Projects - Servers View .................................... 331
9.20 Project Server – Date & Time View ............................................ 332
9.21 Enterprise Server – Date & Time View ........................................ 334
9.22 Automation Server – Date & Time View ..................................... 337
9.23 Communication View ................................................................ 340
9.24 User Account Properties ........................................................... 341
10 Building Operation Servers User Interface .................. 343
10.1 Server Wizard – Configure IP/DNS Address and Port Page ....... 345
04-16006-04-en, March 2015 Technical
9
10.2 Log On Dialog Box .................................................................... 346
10.3 Enterprise Server Properties – Basic Tab ................................... 347
10.4 Enterprise Server Properties – Network Tab .............................. 349
10.5 Enterprise Server Properties – E-mail Tab ................................. 350
10.6 Automation Server Properties – Basic Tab ................................ 352
10.7 Automation Server Properties – E-mail Tab ............................... 355
10.8 Automation Server Properties – Network Tab ............................ 357
10.9 Communication View ................................................................ 359
10.10 Device Discovery View .............................................................. 360
10.11 Variables View ........................................................................... 361
11 Device Administrator User Interface ............................ 363
11.1 Device Administrator ................................................................. 365
11.2 Device Administrator Toolbar .................................................... 366
11.3 Device Administrator List ........................................................... 368
11.4 Upgrade Device Dialog Box ....................................................... 369
11.5 Connect to Device Dialog Box ................................................... 370
11.6 Detailed Progress Dialog Box .................................................... 371
11.7 Device Log On Options Dialog Box ............................................ 372
11.8 Enter User Name and Password Dialog Box .............................. 373
11.9 Edit Connection Dialog Box ....................................................... 374
11.10 Confirm Download Dialog Box ................................................... 375
11.11 Device Administrator Properties – General Tab .......................... 376
11.12 Device Administrator Properties – Network Tab ......................... 378
11.13 Device Administrator Properties – SNMP Configuration Tab ...... 380
11.14 Device Administrator Properties – Firewall Tab .......................... 382
11.15 Device Administrator Properties – Time Tab .............................. 383
12 Building Operation Servers Troubleshooting ............... 385
12.1 Cannot Connect to the Automation Server ............................... 387
12.1.1 Solution .................................................................................. 387
12.2 Enterprise Server Service Disabled ............................................ 388
12.2.1 Solution .................................................................................. 388
12.3 Error – Upgrade Using DFU Mode ............................................. 389
12.3.1 Solution .................................................................................. 389
12.4 Lead-Shadow Reference Server Communication Problems ...... 390
12.4.1 Solution .................................................................................. 390
13 Automation Server Web Configuration ....................... 391
13.1 Automation Server Web Configuration Page .............................. 393
13.1.1 TCP/IP Settings and System Info ............................................ 393
13.1.2 Automation Server Log Files .................................................... 393
13.2 Configuring the Automation Server TCP/IP Settings and Ports ... 394
13.3 Displaying the Automation Server System Information .............. 396
13.4 Exporting Automation Server Log Files ...................................... 397
13.5 Refreshing the Automation Server System Log ......................... 399
14 Automation Server Web Configuration User Interface . 401
Technical 04-16006-04-en, March 2015
10
14.1 Automation Server Web Configuration – TCP/IP Page ............... 403
14.2 Automation Server Web Configuration – System Information
Page ......................................................................................... 405
14.3 Automation Server Web Configuration – Server Log Page ......... 408
15 Bindings .................................................................... 409
15.1 Bindings Overview .................................................................... 411
15.1.1 Methods of Binding ................................................................. 412
15.1.2 Binding Rules .......................................................................... 412
15.1.3 Direction of Bindings ............................................................... 412
15.1.4 Value Transfer Interval ............................................................. 412
15.1.5 Binding Path Format ............................................................... 412
15.1.6 Bindings Management ............................................................ 412
15.1.7 LonWorks Bindings ................................................................. 413
15.1.8 Server Values .......................................................................... 413
15.2 Methods of Binding ................................................................... 414
15.2.1 Manual ................................................................................... 414
15.2.2 Binding Templates .................................................................. 415
15.3 Binding Values Manually ............................................................ 416
15.4 Binding Rules ........................................................................... 417
15.5 Direction of Bindings ................................................................. 418
15.6 Value Transfer Settings ............................................................ 420
15.6.1 Requested Transfer Rate ........................................................ 420
15.6.2 Delta Value Transfer ................................................................ 421
15.6.3 Guaranteed Transfer .............................................................. 422
15.6.4 Combined Methods ................................................................ 422
15.7 Value Transfer ........................................................................... 424
15.7.1 Application Value Transfer ....................................................... 424
15.7.2 Central Value Transfer ............................................................. 424
15.7.3 Field Bus Value Transfer .......................................................... 425
15.7.4 Cautions ................................................................................. 427
15.8 Configuring the Value Transfer Interval ....................................... 428
15.9 Locked and Unlocked Binding Paths ......................................... 429
15.9.1 Locked ................................................................................... 429
15.9.2 Unlocked ................................................................................ 431
15.10 Locking or Unlocking a Path ...................................................... 433
15.11 Bindings Management .............................................................. 434
15.12 Checking the Status of Bindings ................................................ 435
15.13 LonWorks Bindings .................................................................. 436
15.13.1 LonWorks Bindings in WorkStation ......................................... 436
15.13.2 Bindable objects in LonWorks ................................................. 436
15.13.3 LonWorks Binding Profiles ...................................................... 437
15.13.4 LonWorks Binding Types ........................................................ 437
15.13.5 LonWorks Selectors and Bindings ........................................... 437
15.14 Server Values ............................................................................ 438
15.14.1 Minimizing the Transfer Interval Intensity .................................. 438
15.14.2 Server Value Workflow ............................................................ 438
04-16006-04-en, March 2015 Technical
11
15.15 Creating a Server Value ............................................................. 440
15.16 Creating a Server Analog Value ................................................. 441
15.17 Configuring the Value and the Unit for a Server Analog Value ..... 442
15.18 Creating a Server Digital Value ................................................... 445
16 Binding Templates ..................................................... 447
16.1 Binding Templates .................................................................... 449
16.1.1 Purpose of Binding Templates ................................................ 449
16.1.2 Binding Template Location ...................................................... 449
16.1.3 How to Use Binding Templates ............................................... 450
16.1.4 Binding Template Types .......................................................... 450
16.2 Binding Template Types ............................................................ 451
16.2.1 Type Binding Templates .......................................................... 451
16.2.2 Type Binding Template Examples ........................................... 451
16.2.3 Path Matching Binding Templates and Syntax ......................... 451
16.2.4 Path Matching Binding Template Examples ............................. 451
16.3 Type Binding Templates ............................................................ 452
16.4 Type Binding Template Examples ............................................. 453
16.4.1 Fan Coil – Bind to Zone Controller ........................................... 456
16.4.2 Fan Coil – Bind to Occupancy Sensor ..................................... 456
16.4.3 Fan Coil – Bind to Temperature Sensor ................................... 456
16.5 Fan Coil - Bind to Zone Controller .............................................. 457
16.6 Fan Coil - Bind to Occupancy Sensor ........................................ 461
16.7 Fan Coil - Bind to Temperature Sensor ..................................... 465
16.8 Path Matching Binding Templates and Syntax ........................... 469
16.8.1 Path Matching ........................................................................ 469
16.8.2 Path Syntax ............................................................................ 469
16.9 Path Matching ........................................................................... 470
16.10 Path Syntax .............................................................................. 471
16.11 Path Matching Binding Template Examples ............................... 473
16.11.1 Path Matching Binding Template Example 1 ............................ 475
16.11.2 Path Matching Binding Template Example 2 ............................ 475
16.11.3 Path Matching Binding Template Example 3 ............................ 475
16.11.4 Path Matching Binding Template Example 4 ............................ 475
16.11.5 Path Matching Binding Template Example 5 ............................ 476
16.12 Path Matching Binding Template Example 1 .............................. 477
16.13 Path Matching Binding Template Example 2 .............................. 482
16.14 Path Matching Binding Template Example 3 .............................. 488
16.15 Path Matching Binding Template Example 4 .............................. 493
16.16 Path Matching Binding Template Example 5 .............................. 500
16.17 Binding Values Using a Binding Template .................................. 507
16.18 Binding Values in Script Editor Using a Binding Template .......... 510
16.19 Creating a Type Binding Template from Instance ....................... 512
16.20 Creating a Type Binding Template ............................................. 514
16.21 Creating a Path Matching Binding Template .............................. 517
17 Bindings User Interface .............................................. 521
Technical 04-16006-04-en, March 2015
12
17.1 Bindings View ........................................................................... 523
17.2 Bindings Diagnostics ................................................................. 525
17.3 Binding Point List Toolbar ......................................................... 526
17.4 Binding Templates List .............................................................. 527
17.5 Browser Toolbar ....................................................................... 528
17.6 Browser .................................................................................... 529
17.7 Bind Dialog Box – Select Direction ............................................ 530
17.8 Bind Dialog Box – Replace or Keep ........................................... 531
17.9 Bind Dialog Box – Replace or Add ............................................. 532
17.10 Value Transfer Settings Dialog Box ............................................ 533
17.11 Variables View Features ............................................................ 535
17.12 Confirm Bindings Dialog Box ..................................................... 539
17.13 Bindings Status Icons ............................................................... 540
17.14 Binding Templates View ............................................................ 541
17.15 Binding Template Wizard – Choosing the Type and Naming the
Object Page .............................................................................. 542
17.16 Binding Template Wizard – What Type Do You Want to Bind in the
Template Page .......................................................................... 543
17.17 Binding Template Wizard – What Type(s) Do You Want to Bind to
with the Template Page ............................................................. 544
17.18 Binding Template Wizard – Specify the Bindings in The Template
Page ......................................................................................... 545
17.19 Binding Template Wizard – Specify the Path Matching Patterns in
the Template Page .................................................................... 546
17.20 Binding Template Properties ..................................................... 548
17.21 Edit Binding Template Dialog Box – Type Binding Template ...... 550
17.22 Edit Binding Template Dialog Box – Path Matching Binding
Template .................................................................................. 552
17.23 Time Stamp Value Properties .................................................... 554
18 Import and Export ...................................................... 555
18.1 Import and Export Overview ...................................................... 557
18.1.1 Export ..................................................................................... 558
18.1.2 Exportable and Non-exportable Objects .................................. 558
18.1.3 Import ..................................................................................... 558
18.1.4 Import and Export of Supporting Objects ................................ 558
18.1.5 Import and Export of Bindings and Binding Templates ............. 558
18.2 Export ....................................................................................... 559
18.2.1 Export of Networks, Devices, and Protocols ............................ 559
18.2.2 Export of Programs, Functions, and Applications .................... 560
18.3 Exporting a Solution .................................................................. 561
18.4 Selecting Multiple Solutions for Export ....................................... 562
18.5 Export of Networks, Devices, and Protocols .............................. 563
18.5.1 Import and Export of I/O Solutions .......................................... 563
18.5.2 Import and Export of b3 Solutions ........................................... 563
18.5.3 Import and Export of BACnet Solutions ................................... 563
18.5.4 Import and Export of GCM Solutions ....................................... 563
18.5.5 Import and Export of LonWorks Solutions ............................... 563
04-16006-04-en, March 2015 Technical
13
18.5.6 Import and Export of MNL LonWorks Solutions ....................... 564
18.5.7 Import and Export of MicroNet Solutions ................................. 564
18.5.8 Import and Export of Modbus Solutions .................................. 564
18.5.9 Import and Export of Sigma Solutions ..................................... 564
18.5.10 Import and Export of Xenta Solutions ...................................... 564
18.6 Import and Export of I/O Solutions ............................................ 565
18.7 Import and Export of b3 Solutions ............................................. 566
18.8 Import and Export of BACnet Solutions ..................................... 567
18.9 Import and Export of GCM Solutions ......................................... 569
18.10 Import and Export of LonWorks Solutions ................................. 570
18.11 Import and Export of MNL LonWorks Solutions ......................... 571
18.11.1 Exporting an MNL LonWorks Solution ..................................... 571
18.11.2 Importing an MNL LonWorks Solution ..................................... 571
18.12 Import and Export of MicroNet Solutions ................................... 572
18.13 Import and Export of Modbus Solutions .................................... 573
18.14 Import and Export of Sigma Solutions ....................................... 574
18.15 Import and Export of Xenta Solutions ........................................ 575
18.16 Export of Programs, Functions, and Applications ...................... 576
18.16.1 Import and Export of Script Solutions ...................................... 576
18.16.2 Import and Export of User Management Solutions ................... 576
18.16.3 Import and Export of Alarm Solutions ...................................... 576
18.16.4 Import and Export of Trend Solutions ...................................... 576
18.16.5 Import and Export of Schedule Solutions ................................. 576
18.16.6 Import and Export of Report Solutions ..................................... 577
18.16.7 Custom Object Type ............................................................... 577
18.16.8 Export Library Mode ................................................................ 577
18.17 Import and Export of Script Solutions ........................................ 578
18.18 Import and Export of User Management Solutions ..................... 579
18.19 Import and Export of Alarm Solutions ........................................ 583
18.20 Import and Export of Trend Solutions ........................................ 584
18.21 Import and Export of Schedule Solutions ................................... 585
18.22 Import and Export of Report Solutions ....................................... 587
18.23 Custom Object Type ................................................................. 588
18.24 Export Library Mode .................................................................. 589
18.25 Exportable and Non-exportable Objects .................................... 590
18.26 Import ....................................................................................... 591
18.26.1 Import of Networks, Devices, and Protocols ............................ 592
18.26.2 Import of Programs, Functions, and Applications .................... 593
18.27 Importing a Solution .................................................................. 594
18.28 Import of Networks, Devices, and Protocols .............................. 595
18.28.1 Import and Export of I/O Solutions .......................................... 595
18.28.2 Import and Export of b3 Solutions ........................................... 595
18.28.3 Import and Export of BACnet Solutions ................................... 595
18.28.4 Import and Export of GCM Solutions ....................................... 595
18.28.5 Import and Export of LonWorks Solutions ............................... 595
18.28.6 Import and Export of MNL LonWorks Solutions ....................... 596
18.28.7 Import and Export of MicroNet Solutions ................................. 596
Technical 04-16006-04-en, March 2015
14
18.28.8 Import and Export of Modbus Solutions .................................. 596
18.28.9 Import and Export of Sigma Solutions ..................................... 596
18.28.10 Import and Export of Xenta Solutions ...................................... 596
18.29 Import of Programs, Functions, and Applications ...................... 597
18.29.1 Import and Export of Script Solutions ...................................... 597
18.29.2 Import and Export of User Management Solutions ................... 597
18.29.3 Import and Export of Alarm Solutions ...................................... 597
18.29.4 Import and Export of Trend Solutions ...................................... 597
18.29.5 Import and Export of Schedule Solutions ................................. 597
18.29.6 Import and Export of Report Solutions ..................................... 598
18.30 Import and Export of Supporting Objects .................................. 599
18.31 Import and Export of Bindings and Binding Templates ............... 601
19 Import and Export User Interface ................................ 603
19.1 Export Status Dialog Box .......................................................... 605
19.2 Export Preview Dialog Box ........................................................ 606
19.3 Import and Export Toolbar ........................................................ 607
19.4 Import Dialog Box ..................................................................... 608
19.5 Import Status Dialog Box .......................................................... 610
20 I/O Modules ............................................................... 611
20.1 I/O Modules Overview ............................................................... 613
20.1.1 I/O Modules ............................................................................ 613
20.1.2 I/O Module Workflows ............................................................. 613
20.1.3 Physical Devices and I/O Module Objects ................................ 613
20.1.4 I/O Points ................................................................................ 613
20.1.5 Output Override Status ........................................................... 613
20.1.6 I/O Module Low Power Mode .................................................. 614
20.2 I/O Module Workflows ............................................................... 615
20.2.1 Discover and Create ............................................................... 615
20.2.2 Create and Discover ............................................................... 615
20.3 Physical Devices and I/O Module Objects .................................. 617
20.4 Creating an I/O Module ............................................................. 618
20.5 Configuring an I/O Module ........................................................ 621
20.6 Discovering an I/O Module ........................................................ 623
20.7 Creating Multiple I/O Modules ................................................... 624
20.8 Updating I/O Module Firmware .................................................. 625
20.9 Moving an I/O Module ............................................................... 627
20.10 Recovering from an I/O Module Failure ..................................... 629
20.11 Assigning and Unassigning Logical I/O Modules ........................ 630
20.12 I/O Points ................................................................................. 631
20.12.1 I/O Point Types ....................................................................... 631
20.12.2 2-Wire RTD-DI-16 Temperature Input Wiring Resistance ......... 631
20.12.3 2-Wire or 3-Wire RTD-DI-16 Temperature Input Values and
Reliability Levels ...................................................................... 632
20.12.4 Reliability of I/O Points ............................................................. 632
20.12.5 Forced I/O Point Values .......................................................... 632
20.12.6 I/O Point Scaling ..................................................................... 632
04-16006-04-en, March 2015 Technical
15
20.12.7 Implicit Trend Logs for I/O Points ............................................. 632
20.12.8 Input Point Offsets .................................................................. 632
20.12.9 Threshold Settings for I/O Points ............................................. 633
20.13 Creating Multiple Objects .......................................................... 634
20.14 Configuring Multiple Objects ...................................................... 636
20.15 Copying from MS Excel to Spreadsheet View ............................ 637
20.16 Copying from Spreadsheet View to MS Excel ............................ 639
20.17 I/O Module Low Power Mode .................................................... 641
20.18 Setting and Recovering an I/O Module from Low Power ............ 642
20.19 Printing a Label to Identify I/O Channels .................................... 644
20.20 Correcting a Module Type Mismatch ......................................... 646
20.21 Output Override Status ............................................................. 647
20.22 Overriding a Digital Output ........................................................ 648
20.23 Overriding an Analog Output .................................................... 650
20.24 Associating an Engineering Unit with Property Values ................ 652
20.25 Inserting a New Module in the Middle of an Existing I/O Bus ...... 654
20.26 Resolving I/O Module Device Address Changed and Blacklisted
Device Detection Errors ............................................................. 657
21 I/O Points ................................................................... 661
21.1 I/O Point Types ......................................................................... 663
21.1.1 Valid Point Types for I/O Modules ............................................ 663
21.1.2 Null Value Selection ................................................................. 664
21.1.3 I/O Point Binding ..................................................................... 665
21.2 Creating an I/O Module Input Point ........................................... 666
21.3 Creating an I/O Module Output Point ........................................ 668
21.4 Creating an I/O Module Digital Input .......................................... 670
21.5 Creating an I/O Module Counter Input ....................................... 672
21.6 Creating an I/O Module Temperature Input ................................ 674
21.7 Creating an I/O Module 2-Wire or 3-Wire RTD Temperature
Input ......................................................................................... 676
21.8 2-Wire RTD-DI-16 Temperature Input Wiring Resistance ........... 678
21.9 2-Wire or 3-Wire RTD-DI-16 Temperature Input Value and Reliability
Levels ....................................................................................... 679
21.10 Creating an I/O Module 2-Wire or 3-Wire RTD Resistive Input .... 680
21.11 Creating an I/O Module Voltage Input ........................................ 683
21.12 Creating an I/O Module Digital Output ....................................... 685
21.13 Creating an I/O Module Voltage Output ..................................... 687
21.14 Configuring I/O Module Input or Output Points .......................... 689
21.15 Creating Multiple I/O Points ....................................................... 690
21.16 Reliability of I/O Points ............................................................... 692
21.17 Reviewing the Reliability of I/O Point Values ............................... 693
21.18 Forced I/O Point Values ............................................................. 694
21.19 Forcing Input Values .................................................................. 696
21.20 Forcing Output Values ............................................................... 697
21.21 I/O Point Scaling ....................................................................... 698
21.21.1 Input Scaling ........................................................................... 698
21.21.2 Output Scaling ........................................................................ 699
Technical 04-16006-04-en, March 2015
16
21.21.3 Pulse Width Modulation Scaling .............................................. 701
21.22 Scaling an Input or Output I/O Point .......................................... 703
21.23 Implicit Trend Logs for I/O Points ............................................... 705
21.24 Input Point Offsets .................................................................... 706
21.25 Configuring Offsets for Input Points ........................................... 707
21.26 Printing a Wiring List for the I/O Bus .......................................... 709
21.27 Threshold Settings for I/O Points ............................................... 712
22 I/O User Interface ...................................................... 715
22.1 Central I/O System Tree Pane Icons .......................................... 717
22.2 I/O Module Management Tool Dialog Box ................................. 718
22.3 I/O Bus Properties – Basic Tab ................................................. 720
22.4 I/O Module Properties – Basic Tab ............................................ 721
22.5 I/O Modules in the Work Area .................................................... 724
22.6 Counter Input Properties – Basic Tab ........................................ 726
22.7 Current Input Properties – Basic Tab ......................................... 728
22.8 Digital Input Properties – Basic Tab ........................................... 730
22.9 Resistive Input Properties – Basic Tab ....................................... 731
22.10 2-Wire or 3-Wire RTD Resistive Input Properties – Basic Tab ..... 733
22.11 Supervised Input Properties – Basic Tab ................................... 736
22.12 Temperature Input Properties – Basic Tab ................................. 737
22.13 2-Wire or 3-Wire RTD Temperature Input Properties – Basic
Tab ........................................................................................... 739
22.14 Voltage Input Properties – Basic Tab ......................................... 742
22.15 Current Output Properties – Basic Tab ...................................... 744
22.16 Voltage Output Properties – Basic Tab ...................................... 746
22.17 Digital Output Properties – Basic Tab ........................................ 748
22.18 Digital Pulsed Output Properties – Basic Tab ............................. 750
22.19 Tristate Output Properties – Basic Tab ...................................... 752
22.20 Tristate Pulsed Output Properties – Basic Tab ........................... 754
22.21 I/O Points in the Work Area ....................................................... 756
22.22 Print I/O Wiring List Dialog Box .................................................. 757
22.23 Counter Input – Basic Settings Page ......................................... 759
22.24 Current Input – Basic Settings Page .......................................... 760
22.25 Digital Input – Basic Settings Page ............................................ 762
22.26 Resistive Input – Basic Settings Page ........................................ 763
22.27 2-Wire or 3-Wire RTD Resistive Input – Basic Settings Page ...... 765
22.28 Supervised Input – Basic Settings Page .................................... 767
22.29 Temperature Input – Basic Settings Page .................................. 768
22.30 2-Wire or 3-Wire RTD Temperature Input – Basic Settings Page 770
22.31 Voltage Input – Basic Settings Page .......................................... 772
22.32 New I/O Module Wizard – Basic Settings Page .......................... 774
22.33 Current Output – Basic Settings Page ....................................... 775
22.34 Voltage Output – Basic Settings Page ....................................... 777
22.35 Digital Output – Basic Settings Page ......................................... 779
22.36 Digital Pulsed Output – Basic Settings Page .............................. 780
22.37 Tristate Output – Basic Settings Page ....................................... 782
04-16006-04-en, March 2015 Technical
17
22.38 Tristate Pulsed Output – Basic Settings Page ............................ 783
22.39 Print I/O Module Labels Dialog Box ........................................... 785
22.40 Update I/O Module Firmware Dialog Box ................................... 786
23 Graphics Introduction ................................................ 787
23.1 Graphics Editor Overview .......................................................... 789
23.1.1 Graphics ................................................................................ 792
23.1.2 Figures ................................................................................... 792
23.1.3 Components ........................................................................... 792
23.1.4 Layers .................................................................................... 792
23.2 Graphics Editor Libraries ........................................................... 793
23.2.1 Folder for Brushes, Components and Snippets ....................... 793
23.3 Graphics in WorkStation ............................................................ 794
23.4 Creating a Graphic .................................................................... 796
23.5 Adjusting the Graphic Work Area ............................................... 798
23.6 Saving a Graphic ....................................................................... 800
23.7 Drawing Tools ........................................................................... 801
23.7.1 Lines ....................................................................................... 801
23.7.2 Polylines ................................................................................. 801
23.7.3 Curves .................................................................................... 801
23.7.4 Polygons ................................................................................ 801
23.7.5 Rectangle ............................................................................... 801
23.7.6 Ellipses ................................................................................... 801
23.7.7 Arcs ........................................................................................ 802
23.7.8 Pies ........................................................................................ 802
23.7.9 Texts and Textboxes ............................................................... 802
23.7.10 Pictures .................................................................................. 802
23.8 Keyboard Shortcuts for Graphics Editor .................................... 803
23.9 Testing ..................................................................................... 805
23.10 Testing a Graphic in Preview Mode ........................................... 806
24 Components and Snippets ........................................ 807
24.1 Components ............................................................................. 809
24.1.1 Component Design ................................................................. 809
24.1.2 Categories .............................................................................. 809
24.1.3 Snippets ................................................................................. 809
24.1.4 Properties ............................................................................... 809
24.1.5 Binds and Links ...................................................................... 809
24.1.6 Editing Tools ........................................................................... 810
24.2 Component Design ................................................................... 811
24.2.1 The Design Process ................................................................ 811
24.2.2 Component Documentation and Saving ................................. 811
24.3 Documenting and Saving a Component .................................... 813
24.4 Inhibiting Clipping ...................................................................... 815
24.5 Controlling the Appearance of the Component .......................... 816
24.6 Grouping Drawing Objects as a Component ............................. 819
24.7 Adding a Component ................................................................ 820
Technical 04-16006-04-en, March 2015
18
24.8 Creating a New Component ...................................................... 822
24.9 Editing a Component ................................................................ 824
24.10 Saving as a Component ............................................................ 826
24.11 Snippets ................................................................................... 828
24.12 Adding a Snippet ...................................................................... 829
24.13 Saving as a Snippet .................................................................. 830
25 Printing and Testing ................................................... 831
25.1 Printing Graphics ...................................................................... 833
25.2 Setting Up a Page for Printing ................................................... 834
25.3 Previewing a Print ..................................................................... 835
26 Categories ................................................................. 837
26.1 Categories ................................................................................ 839
26.2 Creating a Category .................................................................. 840
26.3 Selecting a Category ................................................................. 841
26.4 Renaming a Category ............................................................... 842
26.5 Hiding a Category ..................................................................... 843
26.6 Displaying a Hidden Category ................................................... 844
26.7 Importing a Components Category ........................................... 845
26.8 Importing a Snippets Category .................................................. 846
26.9 Exporting a Category ................................................................ 847
26.10 Deleting a Category ................................................................... 848
27 Attributes ................................................................... 849
27.1 Attributes .................................................................................. 851
27.1.1 Graphic Object Attributes ........................................................ 852
27.1.2 Inherited Attributes .................................................................. 852
27.1.3 Exposed Properties ................................................................. 852
27.2 Graphic Object Attributes .......................................................... 853
27.2.1 Generic Properties .................................................................. 853
27.3 Inherited Attributes .................................................................... 854
27.4 Defining Inheritance ................................................................... 859
27.5 Setting Up Inherited Properties .................................................. 861
27.6 Exposed Properties ................................................................... 863
27.7 Adding an Expose Element ....................................................... 864
27.8 Exposing a Property .................................................................. 865
27.9 Modifying the Behavior of a Component .................................... 867
28 Binds and Links ......................................................... 869
28.1 Binds and Links ........................................................................ 871
28.1.1 Object Binding ........................................................................ 871
28.1.2 Object Linking ........................................................................ 874
28.2 Adding a Link ............................................................................ 875
28.3 Adding a Bind ........................................................................... 876
28.4 Binding a Graphic to a Variable ................................................. 877
28.5 Dynamic Updates ..................................................................... 879
28.6 Activating a binding with a dynamic update attribute .................. 880
04-16006-04-en, March 2015 Technical
19
29 Groups ...................................................................... 881
29.1 Groups ..................................................................................... 883
29.2 Grouping Multiple Objects ......................................................... 886
29.3 Ungrouping Objects .................................................................. 887
29.4 Selecting an Object ................................................................... 888
29.5 Selecting Multiple Objects ......................................................... 889
29.6 Selecting All Objects ................................................................. 890
29.7 Clearing the Selection of Multiple Objects .................................. 891
29.8 Selecting a Group ..................................................................... 892
30 Editing Tools .............................................................. 893
30.1 Selecting an Object Within a Group .......................................... 895
30.2 Graphics Editing Tools .............................................................. 896
30.2.1 Selection Within a Group ......................................................... 896
30.2.2 Object Organization ................................................................ 896
30.2.3 Colors ..................................................................................... 897
30.2.4 Gradients ................................................................................ 897
30.2.5 Animations .............................................................................. 897
30.2.6 Paths ...................................................................................... 897
30.3 Object Organization ................................................................. 898
30.3.1 Object Moving ........................................................................ 898
30.3.2 Object Aligment ...................................................................... 898
30.3.3 Object Arrangement ................................................................ 899
30.3.4 Object Distribution .................................................................. 899
30.3.5 Object Rotation ....................................................................... 899
30.3.6 Object Skewing ....................................................................... 900
30.3.7 Object Flipping ........................................................................ 900
30.3.8 Object Resizing ....................................................................... 900
30.4 Moving Objects ......................................................................... 901
30.5 Aligning Objects ........................................................................ 902
30.6 Arranging Objects ..................................................................... 903
30.7 Distributing Objects ................................................................... 904
30.8 Arranging a Table-like Layout .................................................... 905
30.9 Duplicating an Object to the Same Position ............................... 908
30.10 Duplicating an Object with a Controlled Offset ........................... 909
30.11 Resizing an Object .................................................................... 910
30.12 Resizing an Object to the Same Size ......................................... 911
30.13 Rotating a Single Object ............................................................ 912
30.14 Rotating Multiple Objects .......................................................... 913
30.15 Skewing Horizontally ................................................................. 914
30.16 Skewing Vertically ..................................................................... 915
30.17 Flipping an Object ..................................................................... 916
30.18 Copying an Object .................................................................... 917
30.19 Editing a Point of an Object ....................................................... 918
30.20 Editing Object Properties ........................................................... 919
30.21 Editing Multiple Objects ............................................................. 920
30.22 Deleting an Object ..................................................................... 921
Technical 04-16006-04-en, March 2015
20
30.23 Colors ....................................................................................... 922
30.24 Adding a Custom Color ............................................................. 923
30.25 Using a Custom Color ............................................................... 924
30.26 Gradients .................................................................................. 925
30.26.1 Linear Gradient Adjustment ..................................................... 925
30.26.2 Radial Gradient Adjustment ..................................................... 925
30.26.3 Gradient Properties ................................................................. 925
30.27 Gradient Properties ................................................................... 926
30.28 Adding a Linear Gradient ........................................................... 931
30.29 Adjusting a Linear Gradient ....................................................... 932
30.30 Adding a Radial Gradient ........................................................... 934
30.31 Adjusting a Radial Gradient ....................................................... 935
30.32 Animations ................................................................................ 937
30.33 Adding an Animation ................................................................. 940
31 Layers ........................................................................ 943
31.1 Layers ....................................................................................... 945
31.2 Adding a Layer .......................................................................... 949
31.3 Copying a Layer ........................................................................ 950
31.4 Deleting a Layer ........................................................................ 951
31.5 Renaming a Layer ..................................................................... 952
31.6 Selecting a Layer ....................................................................... 953
31.7 Hiding a Layer ........................................................................... 954
31.8 Controlling the Visibility of a Layer .............................................. 955
32 Grid and Zoom .......................................................... 957
32.1 Grid .......................................................................................... 959
32.2 Showing/Hiding the Grid ........................................................... 960
32.3 Switching on/off Snap to Grid .................................................... 961
32.4 Nudging an Object .................................................................... 962
32.5 Zooming ................................................................................... 963
32.6 Zoom to a Specified Value ......................................................... 964
33 Graphics Editor Figures .............................................. 965
33.1 Figures ..................................................................................... 967
33.1.1 Figure Tools ............................................................................ 968
33.1.2 Snippets ................................................................................. 968
33.1.3 Attributes ................................................................................ 968
33.1.4 Binds and Links ...................................................................... 968
33.1.5 Graphics Editing Tools ............................................................ 968
33.2 Lines ......................................................................................... 969
33.3 Drawing a Line .......................................................................... 970
33.4 Polylines ................................................................................... 971
33.5 Drawing a Polyline ..................................................................... 972
33.6 Curves ...................................................................................... 973
33.7 Drawing a Curve ....................................................................... 974
33.8 Editing a Curve .......................................................................... 975
33.9 Polygons .................................................................................. 976
04-16006-04-en, March 2015 Technical
21
33.10 Drawing a Polygon .................................................................... 977
33.11 Rectangles ............................................................................... 979
33.12 Drawing a Rectangle ................................................................. 980
33.13 Drawing a Square ..................................................................... 981
33.14 Ellipses ..................................................................................... 982
33.15 Drawing an Ellipse ..................................................................... 983
33.16 Circles ...................................................................................... 985
33.17 Drawing a Circle ........................................................................ 986
33.18 Arcs .......................................................................................... 987
33.19 Pies .......................................................................................... 988
33.20 Drawing an Arc or a Pie ............................................................. 989
33.21 Editing an Arc ........................................................................... 990
33.22 Texts and Textboxes ................................................................. 991
33.22.1 Text Path ................................................................................ 991
33.23 Adding Text Using the Text Tool ................................................ 992
33.24 Making Text Content Dynamic .................................................. 993
33.25 Adding Text Using the Textbox tool ........................................... 996
33.26 Editing Text ............................................................................... 997
33.27 Paths ........................................................................................ 998
33.28 Creating a Text Path ................................................................. 999
33.29 Editing a Text Path .................................................................. 1000
33.30 Pictures .................................................................................. 1001
33.30.1 Image Insertion ..................................................................... 1001
33.31 SVG Support .......................................................................... 1003
33.31.1 Supported SVG Elements ..................................................... 1003
33.31.2 Supported SVG Attributes ..................................................... 1003
33.32 Inserting a Picture .................................................................. 1006
33.33 Adjusting a Picture .................................................................. 1007
33.34 Adding an Animated Picture .................................................... 1008
33.35 Making an Animated Picture Dynamic ..................................... 1009
34 Graphics TGML Format Specification ....................... 1011
34.1 TGML Overview ...................................................................... 1015
34.1.1 Properties and Attributes ....................................................... 1015
34.2 TGML Coordinate System ....................................................... 1017
34.3 TGML Rendering Model .......................................................... 1018
34.4 TGML Types and Enumerations .............................................. 1019
34.4.1 Arrays ................................................................................... 1021
34.5 TGML File Format ................................................................... 1022
34.5.1 Supported File Formats ......................................................... 1022
34.6 TGML Code Snippets ............................................................. 1024
34.7 TGML Common Attributes ...................................................... 1025
34.8 TGML Components ................................................................ 1026
34.9 TGML Document Structure ..................................................... 1027
34.10 TGML Document Type Element and Metadata ........................ 1028
34.11 TGML User-Defined Descriptions of Custom Attributes ........... 1030
34.12 TGML Animations ................................................................... 1031
Technical 04-16006-04-en, March 2015
22
34.12.1 Animation: <Animate> ........................................................... 1031
34.12.2 Sequences: <Sequence> ...................................................... 1031
34.13 TGML Animation: <Animate> .................................................. 1032
34.14 TGML Sequences: <Sequence> ............................................. 1034
34.15 TGML Attribute Exposure ........................................................ 1035
34.15.1 Expose Element: <Expose> .................................................. 1035
34.16 TGML Expose Element: <Expose> .......................................... 1036
34.17 TGML Curves and Paths ......................................................... 1037
34.17.1 Cubic Bezier Curve: <Curve> ................................................ 1037
34.17.2 Path Element: <Path> ........................................................... 1037
34.18 TGML Cubic Bezier Curve: <Curve> ....................................... 1038
34.19 TGML Path Element: <Path> .................................................. 1040
34.20 TGML Dynamics ..................................................................... 1042
34.20.1 Signal Binding: <Bind> .......................................................... 1043
34.20.2 Value Conversion: <ConvertValue> ....................................... 1043
34.20.3 Text Value Conversion: <ConvertText> ................................. 1043
34.20.4 Value Range Conversion: <ConvertRange> ........................... 1043
34.20.5 Custom Conversion: <ConvertCustom> ................................ 1043
34.20.6 Status Conversion: <ConvertStatus> .................................... 1044
34.21 TGML Signal Binding: <Bind> ................................................. 1045
34.22 TGML Value Conversion: <ConvertValue> ............................... 1047
34.23 TGML Text Value Conversion: <ConvertText> ......................... 1049
34.24 TGML Value Range Conversion: <ConvertRange> .................. 1050
34.25 TGML Custom Conversion: <ConvertCustom> ....................... 1052
34.26 TGML Status Conversion: <ConvertStatus> ............................ 1053
34.27 TGML Basic Shapes ............................................................... 1054
34.27.1 Shape Attributes ................................................................... 1054
34.27.2 Line: <Line> .......................................................................... 1055
34.27.3 Polyline: <Polyline> ............................................................... 1055
34.27.4 Polygon: <Polygon> .............................................................. 1055
34.27.5 Rectangle: <Rectangle> ........................................................ 1055
34.27.6 Ellipse: <Ellipse> ................................................................... 1055
34.28 TGML Line: <Line> ................................................................. 1056
34.29 TGML Polyline: <Polyline> ....................................................... 1058
34.30 TGML Polygon: <Polygon> ..................................................... 1060
34.31 TGML Rectangle: <Rectangle> ............................................... 1062
34.32 TGML Ellipse: <Ellipse> ........................................................... 1065
34.33 TGML Segment Shapes .......................................................... 1068
34.33.1 Elliptical Arc: <Arc> ............................................................... 1068
34.33.2 Elliptical Pie: <Pie> ................................................................ 1068
34.33.3 Elliptical Chord: <Chord> ...................................................... 1068
34.34 TGML Elliptical Arc: <Arc> ...................................................... 1069
34.35 TGML Elliptical Pie: <Pie> ....................................................... 1071
34.36 TGML Elliptical Chord: <Chord> .............................................. 1073
34.37 TGML Gradients ..................................................................... 1075
34.37.1 Linear Gradient: <LinearGradient> ........................................ 1075
34.37.2 Radial Gradient: <RadialGradient> ........................................ 1075
04-16006-04-en, March 2015 Technical
23
34.37.3 Gradient Stop: <GradientStop> ............................................ 1075
34.38 TGML Linear Gradient: <LinearGradient> ................................ 1076
34.39 TGML Radial Gradient: <RadialGradient> ................................ 1078
34.40 TGML Gradient Stop: <GradientStop> .................................... 1080
34.41 TGML Grouping Elements ....................................................... 1082
34.41.1 Grouping: <Group> .............................................................. 1082
34.41.2 Components: <Component> ................................................ 1082
34.41.3 Layers: <Layer> .................................................................... 1082
34.42 TGML Grouping: <Group> ...................................................... 1083
34.43 TGML Components: <Component> ........................................ 1084
34.44 TGML Layers: <Layer> ............................................................ 1086
34.45 TGML Link element: <Link> .................................................... 1087
34.46 TGML Raster Images .............................................................. 1088
34.46.1 Image Element: <Image> ...................................................... 1088
34.46.2 Animated Images (GIF89a): <Animated Image> ..................... 1088
34.47 TGML Image Element: <Image> .............................................. 1089
34.48 TGML Animated Images (GIF89a): <AnimatedImage> ............. 1091
34.49 TGML Scripting ....................................................................... 1093
34.49.1 Script Element: Script ........................................................... 1093
34.49.2 Target Area Element: TargetArea .......................................... 1093
34.50 TGML Script Element: Script ................................................... 1103
34.51 TGML Target Area Element: <TargetArea> .............................. 1105
34.52 TGML Text .............................................................................. 1107
34.52.1 Text Line: <Text> .................................................................. 1107
34.52.2 Text Flow: <TextBox> ........................................................... 1107
34.53 TGML Text Line: <Text> .......................................................... 1110
34.54 TGML Text Flow: <TextBox> ................................................... 1113
34.55 TGML Transformations ........................................................... 1116
34.55.1 Rotation: <Rotate> ............................................................... 1116
34.55.2 Skewing: <SkewX> and <SkewY> ........................................ 1116
34.55.3 Scaling: <Scale> ................................................................... 1116
34.55.4 Translations: <Translate> ...................................................... 1116
34.56 TGML Rotation: <Rotate> ....................................................... 1117
34.57 TGML Skewing: <SkewX> and <SkewY> ................................ 1119
34.58 TGML Scaling: <Scale> .......................................................... 1121
34.59 TGML Translations: <Translate> ............................................. 1122
35 TGML Additions for Building Operation .................... 1123
35.1 TGML Elements ...................................................................... 1125
35.2 TGML Limitations .................................................................... 1135
35.3 Displaying the TGML Version ................................................... 1136
35.4 Global Scripts in TGML Graphics ............................................ 1137
35.5 Invoke Function ...................................................................... 1138
35.5.1 Invoke Function Attributes ..................................................... 1139
35.6 Panel Navigation ..................................................................... 1141
36 Graphics User Interface ............................................ 1143
Technical 04-16006-04-en, March 2015
24
36.1 Graphics Editor ....................................................................... 1145
36.2 Graphics Editor Menu Bar ....................................................... 1147
36.3 Graphics Editor File Menu ....................................................... 1149
36.4 Graphics Editor File Menu – New Submenu ............................. 1151
36.5 File Menu – Open Submenu .................................................... 1152
36.6 File Menu – Save As Submenu ................................................ 1153
36.7 File Menu – Print Submenu ..................................................... 1154
36.8 File Menu – Settings Submenu ................................................ 1155
36.9 Graphics Editor View Menu ..................................................... 1156
36.10 Categories Context Menu ....................................................... 1157
36.11 Graphics Editor Drawing Toolbar ............................................. 1158
36.12 Graphics Editor Options Toolbar ............................................. 1161
36.13 Components Pane .................................................................. 1165
36.14 Graphics Editor Snippets Pane ................................................ 1167
36.15 Graphics Editor Panes ............................................................ 1169
36.16 Graphics Editor Objects Pane ................................................. 1171
36.17 Graphics Editor Properties Pane ............................................. 1172
36.18 Graphics Editor Statistics Pane ............................................... 1173
36.19 Graphics Editor Test Pane ....................................................... 1175
36.20 Graphics Editor Binds and Links Pane ..................................... 1176
36.21 Graphics Editor Layers Pane ................................................... 1177
36.22 Create Graphics Wizard - Basic Settings Page ........................ 1179
36.23 Graphic Properties - Basic Tab ................................................ 1180
36.24 Graphic Properties – Bindings Tab .......................................... 1181
36.25 Graphic Properties – Links Tab ............................................... 1182
36.26 Graphic Properties - References Tab ....................................... 1183
36.27 Document Properties Dialog Box ............................................ 1184
36.28 Unsupported Characters ......................................................... 1185
37 Function Block Introduction ..................................... 1187
37.1 Graphical Programming .......................................................... 1189
37.1.1 How a Function Block Program Works .................................. 1189
37.1.2 Printouts of Function Block Programs with Multiple Pages ..... 1189
37.2 Function Block Editor Overview ............................................... 1190
37.3 Function Block Workflow ......................................................... 1191
37.4 Function Block Editor File Type ............................................... 1195
37.5 Function Block Editor Shortcut Keys ....................................... 1196
37.6 Programming Hints ................................................................. 1197
37.6.1 Program Cycle Time .............................................................. 1197
37.6.2 Time Counter ........................................................................ 1197
37.6.3 Equality ................................................................................. 1197
37.6.4 Reset Counter ....................................................................... 1197
37.6.5 Bitwise Operators ................................................................. 1198
37.6.6 Sliding Average Value ............................................................ 1198
37.6.7 Time Shift .............................................................................. 1198
37.6.8 Expression Blocks ................................................................ 1198
37.6.9 Start-Up Delay ...................................................................... 1199
04-16006-04-en, March 2015 Technical
25
37.7 Units of Measure ..................................................................... 1200
37.8 Function Block Diagram Structure ........................................... 1201
37.9 Programming Phases ............................................................. 1203
37.9.1 Function Phase ..................................................................... 1203
37.9.2 Design Phase ........................................................................ 1203
37.9.3 Test Phase ............................................................................ 1203
37.10 Design Phase ......................................................................... 1204
37.10.1 Point Identification and Allocation .......................................... 1204
37.10.2 Points and Alarms Naming Conventions ................................ 1204
37.10.3 The Function Block Diagram Structure .................................. 1204
37.11 Operation Modes .................................................................... 1205
37.11.1 Edit Mode ............................................................................. 1205
37.11.2 Simulation Mode ................................................................... 1205
38 Function Block Programs ......................................... 1207
38.1 Function Block Programs in WorkStation ................................ 1209
38.2 Function Block Program Printouts ........................................... 1210
38.3 Creating a Function Block Program ......................................... 1211
38.4 Function Block Program Import ............................................... 1213
38.5 Importing Function Block Program Code ................................. 1214
38.6 Exporting Function Block Program Code ................................. 1216
38.7 Opening a Function Block Program ......................................... 1217
38.8 Editing a Function Block Program ........................................... 1218
38.9 Binding a Function Block Program to I/Os ............................... 1219
38.10 Binding Values Using a Binding Template ................................ 1220
38.11 Saving a Function Block Program ............................................ 1223
38.12 Tasks ...................................................................................... 1224
38.13 Adding a Task to a Program .................................................... 1225
38.14 Program Cycles in Building Operation .................................... 1226
38.14.1 Example A ........................................................................... 1227
38.14.2 Example B ............................................................................ 1229
38.14.3 Application Scheduler ........................................................... 1229
38.15 Configuring the Execution Precedence for a Program .............. 1232
38.16 Finding Cycles in a Task .......................................................... 1233
38.17 Module Names ....................................................................... 1234
38.18 Default Names ........................................................................ 1235
38.19 Adding and Editing the Module Name ..................................... 1236
38.20 Adding Default Names to Function Blocks ............................... 1237
38.21 Searching for a Text String ...................................................... 1238
38.22 Replacing a Text String ........................................................... 1240
38.23 Program Conversion ............................................................... 1241
38.24 Importing a Xenta 280/300/401 Program ................................ 1242
39 Function Blocks ....................................................... 1243
39.1 Edit Mode ............................................................................... 1245
39.1.1 Function Block Programming ................................................ 1245
39.1.2 Programming Phases ............................................................ 1245
Technical 04-16006-04-en, March 2015
26
39.2 Changing to Edit Mode ........................................................... 1246
39.3 Duplicating a Function Block ................................................... 1247
39.4 Selecting a Function Block ...................................................... 1248
39.5 Copying a Selection to the Clipboard ...................................... 1249
39.6 Clearing a Function Block Selection ......................................... 1250
39.7 Printing a Selection ................................................................. 1251
39.8 Moving a Function Block ......................................................... 1253
39.9 Copying a Function Block ....................................................... 1254
39.10 Deleting a Function Block ........................................................ 1255
39.11 Naming a Function Block ........................................................ 1256
39.12 Selecting a Group ................................................................... 1257
39.13 Centering a Group .................................................................. 1258
39.14 Moving a Group ...................................................................... 1259
39.15 Deleting a Group ..................................................................... 1260
39.16 Copying a Group ..................................................................... 1261
39.17 Disconnecting a Group ........................................................... 1262
40 Hierarchical Function Blocks .................................... 1263
40.1 Hierarchical Function Blocks ................................................... 1265
40.2 Creating an Empty HFB ........................................................... 1267
40.3 Adding an HFB I/O Block ........................................................ 1268
40.4 Creating an HFB of Existing Function Blocks ........................... 1269
40.5 Expanding an HFB .................................................................. 1270
40.6 Compressing an HFB .............................................................. 1271
40.7 Navigating in a Hierarchical Structure of HFBs ......................... 1272
40.8 Printing an HFB ....................................................................... 1274
41 Macros .................................................................... 1275
41.1 Function Block Editor Macros ................................................. 1277
41.2 Function Block Editor Macro Commands ................................ 1278
41.3 Saving a Macro ....................................................................... 1279
41.4 Loading a Macro ..................................................................... 1280
41.5 Replacing a String ................................................................... 1281
41.6 Adding a Message Box .......................................................... 1283
41.7 Adding a Reminder ................................................................. 1284
41.8 Adding a Sound ...................................................................... 1285
42 Constants ................................................................ 1287
42.1 Constants ............................................................................... 1289
42.1.1 Public Constants ................................................................... 1289
42.2 Using a Constant .................................................................... 1291
42.3 Making a Constant Public ....................................................... 1292
42.4 Deleting All Unused Constants ................................................ 1293
42.5 Deleting a Constant ................................................................. 1294
42.6 Editing a Constant ................................................................... 1295
42.7 Adding a Constant .................................................................. 1296
42.8 Changing the Value of a Constant ........................................... 1297
04-16006-04-en, March 2015 Technical
27
43 Signals ..................................................................... 1299
43.1 Signals .................................................................................... 1301
43.1.1 Signal Types ......................................................................... 1301
43.1.2 Public Signals ....................................................................... 1301
43.1.3 Accessing Signals ................................................................. 1301
43.1.4 Signal Names ........................................................................ 1302
43.2 Signal Names .......................................................................... 1303
44 Simulation Mode ...................................................... 1305
44.1 Simulation Mode ..................................................................... 1307
44.2 Changing to Simulation Mode ................................................. 1308
44.3 Setting Date and Time ............................................................. 1309
44.4 Tiling the Simulation Area Vertically and Horizontally ................ 1310
44.5 Simulating One Cycle Only ...................................................... 1311
44.6 Simulating a Defined Number of Cycles ................................... 1312
44.7 Starting a Simulation ............................................................... 1313
44.8 Setting Analog Simulation Inputs ............................................. 1314
44.9 Setting Digital Simulation Inputs .............................................. 1315
44.10 Changing from Function Diagram View to Table View .............. 1316
44.11 Adding a Binary Signal to the Recorder ................................... 1317
44.12 Removing a Signal from the Recorder ..................................... 1318
44.13 Editing the Range of a Recorded Value .................................... 1319
44.14 Restarting the Recorder .......................................................... 1320
44.15 Resetting the Recorder ........................................................... 1321
44.16 Viewing Sampled Values ......................................................... 1322
44.17 Scanning Sampled Values ....................................................... 1323
44.18 Defining the Sampling Period .................................................. 1324
44.19 Automatically Generated Input Signals .................................... 1325
44.20 Automatically Generating an Analog Input Signal .................... 1326
44.21 Automatically Generating a Binary Input Signal ....................... 1327
44.22 Modifying an Analog Signal ..................................................... 1328
44.23 Modifying a Binary Signal ........................................................ 1329
44.24 Viewing Parameters in a Function Block .................................. 1330
45 Function Block Programming ................................... 1331
45.1 Function Block Programming .................................................. 1333
45.1.1 Simple Blocks ....................................................................... 1333
45.1.2 Operators ............................................................................. 1333
45.1.3 Expression Blocks ................................................................ 1333
45.1.4 Connections ......................................................................... 1333
45.1.5 Signals .................................................................................. 1333
45.1.6 Macros ................................................................................. 1334
45.1.7 Comments ............................................................................ 1334
45.2 Connections ........................................................................... 1335
45.3 Connecting a Block Output to a Block Input ............................ 1337
45.4 Creating a Node on a Connection Line .................................... 1338
45.5 Drawing a Connection Line from a Node ................................. 1339
Technical 04-16006-04-en, March 2015
28
45.6 Drawing a Connection Line in the Diagram Window ................. 1340
45.7 Disconnecting All Connections ................................................ 1341
45.8 Disconnecting a Connection ................................................... 1342
45.9 Changing a Connection ........................................................... 1343
45.10 Deleting a Connection ............................................................. 1344
45.11 Detaching a Connection .......................................................... 1345
45.12 Changing the Color of a Connection Line ................................ 1346
45.13 Changing the Orthogonal Connection Setting .......................... 1347
46 Expression Blocks and Comments ........................... 1349
46.1 Expression Blocks .................................................................. 1351
46.1.1 Expression Block Input Variables ........................................... 1351
46.1.2 Expression Block Constants ................................................. 1352
46.1.3 Expression Block Operators .................................................. 1352
46.1.4 Expression Block Arithmetical Functions ............................... 1352
46.2 Adding an Expression Block .................................................... 1353
46.3 Expression Block Arithmetical Functions ................................. 1355
46.4 Expression Block Operators .................................................... 1356
46.5 Function Block Editor Comments ............................................ 1358
46.6 Adding a Comment ................................................................. 1359
46.7 Adding a Rectangle ................................................................. 1361
47 Function Block Types ............................................... 1363
47.1 Simple Blocks ......................................................................... 1367
47.1.1 Connection Blocks ................................................................ 1367
47.1.2 Signal Source Blocks ............................................................ 1368
47.1.3 Logical Function Blocks ........................................................ 1368
47.1.4 Non-linear Function Blocks ................................................... 1369
47.1.5 Delay Blocks ......................................................................... 1369
47.1.6 Controller and Filter Blocks ................................................... 1370
47.1.7 Accumulator Blocks .............................................................. 1370
47.1.8 System Variable Blocks ......................................................... 1370
47.1.9 Time Schedule and Alarm Blocks .......................................... 1371
47.1.10 Transformation Function Blocks ............................................ 1371
47.2 Adding a Simple Block ............................................................ 1373
47.3 Connection Blocks .................................................................. 1374
47.3.1 BI ......................................................................................... 1374
47.3.2 BO ........................................................................................ 1374
47.3.3 II ........................................................................................... 1374
47.3.4 IO ......................................................................................... 1374
47.3.5 PI .......................................................................................... 1374
47.3.6 PO ........................................................................................ 1374
47.3.7 RI ......................................................................................... 1374
47.3.8 RO ........................................................................................ 1375
47.4 BI – Binary Input ...................................................................... 1376
47.5 BO – Binary Output ................................................................ 1377
47.6 II – Integer Input ...................................................................... 1378
04-16006-04-en, March 2015 Technical
29
47.7 IO – Integer Output ................................................................ 1379
47.8 PI – Pulse-Counter Binary Input ............................................... 1380
47.9 PO – Pulsed Binary Output ..................................................... 1381
47.10 RI – Real Input ........................................................................ 1382
47.11 RO – Real Output .................................................................... 1383
47.12 Time Schedule and Alarm Blocks ............................................ 1384
47.12.1 ALARM ................................................................................. 1384
47.12.2 TSCHI ................................................................................... 1384
47.13 ALARM – Alarm ...................................................................... 1385
47.14 TSCHI – Time Schedule .......................................................... 1387
47.15 Accumulator Blocks ................................................................ 1388
47.15.1 ACCUM ................................................................................ 1388
47.15.2 INTEG ................................................................................... 1388
47.15.3 RT ........................................................................................ 1388
47.16 ACCUM – Accumulator ........................................................... 1389
47.17 INTEG – Integrator .................................................................. 1391
47.18 RT – Run-Time Measurement ................................................. 1393
47.19 Non-linear Function Blocks ..................................................... 1395
47.19.1 AHYST ................................................................................. 1395
47.19.2 HYST .................................................................................... 1395
47.19.3 LIMIT .................................................................................... 1395
47.19.4 MAX ..................................................................................... 1395
47.19.5 MIN ...................................................................................... 1395
47.20 AHYST – Analog Hysteresis .................................................... 1396
47.21 HYST – Binary Hysteresis ........................................................ 1398
47.22 LIMIT – High/Low Signal Limit ................................................. 1400
47.23 MAX – Maximum Signal Selector ............................................. 1401
47.24 MIN – Minimum Signal Selector ............................................... 1402
47.25 Logical Function Blocks .......................................................... 1403
47.25.1 AND ..................................................................................... 1403
47.25.2 NOT ..................................................................................... 1403
47.25.3 OR ........................................................................................ 1403
47.25.4 PULSE .................................................................................. 1403
47.25.5 SR ........................................................................................ 1403
47.25.6 TRIG ..................................................................................... 1403
47.25.7 XOR ...................................................................................... 1404
47.26 AND – Logical AND Gate ........................................................ 1405
47.27 NOT – NOT Gate .................................................................... 1406
47.28 OR – OR Gate ......................................................................... 1407
47.29 PULSE – Pulse Generator ....................................................... 1408
47.30 SR – Set-Reset Flip-Flop ......................................................... 1409
47.31 TRIG – Trigger ........................................................................ 1411
47.32 XOR – Exclusive OR Gate ....................................................... 1412
47.33 Transformation Function Blocks .............................................. 1413
47.33.1 CURVE ................................................................................. 1413
47.33.2 ENTH ................................................................................... 1413
47.33.3 POLY .................................................................................... 1413
Technical 04-16006-04-en, March 2015
30
47.33.4 PRCNT ................................................................................. 1413
47.33.5 VECTOR ............................................................................... 1413
47.34 CURVE – Curve Function ........................................................ 1414
47.35 ENTH – Enthalpy ..................................................................... 1416
47.36 POLY – Polynomial Function ................................................... 1419
47.37 PRCNT – Percentage .............................................................. 1421
47.38 VECTOR – Vectorial Curve Function ........................................ 1422
47.39 Delay Blocks ........................................................................... 1424
47.39.1 DELAY .................................................................................. 1424
47.39.2 DELB .................................................................................... 1424
47.39.3 DELI ..................................................................................... 1424
47.39.4 DELR .................................................................................... 1424
47.39.5 SHB ..................................................................................... 1424
47.39.6 SHI ....................................................................................... 1425
47.39.7 SHR ..................................................................................... 1425
47.40 DELAY – Delayed On/Off ........................................................ 1426
47.41 DELB – Binary Value Delay ...................................................... 1427
47.42 DELI – Integer Value Delay ...................................................... 1428
47.43 DELR – Real Value Delay ......................................................... 1429
47.44 SHB – Sample and Hold Binary Value ..................................... 1430
47.45 SHI – Sample and Hold Integer Value ...................................... 1432
47.46 SHR – Sample and Hold Real Value ........................................ 1434
47.47 System Variable Blocks ........................................................... 1436
47.47.1 DATE .................................................................................... 1436
47.47.2 ERROR ................................................................................. 1436
47.47.3 HOUR ................................................................................... 1436
47.47.4 MINUTE ................................................................................ 1436
47.47.5 MONTH ................................................................................ 1436
47.47.6 RST ...................................................................................... 1436
47.47.7 SECOND .............................................................................. 1437
47.47.8 TCYC ................................................................................... 1437
47.47.9 WDAY .................................................................................. 1437
47.48 DATE – Day ............................................................................ 1438
47.49 ERROR – System Error ........................................................... 1439
47.50 Error Codes for the ERROR Function Block ............................. 1440
47.51 HOUR – Hour ......................................................................... 1441
47.52 MINUTE – Minute .................................................................... 1442
47.53 MONTH – Month .................................................................... 1443
47.54 RST – Restart ......................................................................... 1444
47.55 SECOND – Second ................................................................ 1445
47.56 WDAY – Week Day ................................................................. 1446
47.57 TCYC – Cycle Time ................................................................. 1447
47.58 Controller and Filter Blocks ..................................................... 1448
47.58.1 FILT ...................................................................................... 1448
47.58.2 OPT ...................................................................................... 1448
47.58.3 PIDA ..................................................................................... 1448
47.58.4 PIDI ...................................................................................... 1448
04-16006-04-en, March 2015 Technical
31
47.58.5 PIDP ..................................................................................... 1448
47.58.6 RAMP ................................................................................... 1448
47.58.7 SEQ ...................................................................................... 1449
47.59 FILT – First Order Filter ............................................................ 1450
47.60 OPT – Optimization ................................................................. 1452
47.61 PIDA – PID Controller – Analog Output .................................... 1459
47.62 PIDI – PID Controller – Incremental Output .............................. 1463
47.63 PIDP – PID Controller – Analog Output .................................... 1466
47.64 RAMP – Ramp Filter ................................................................ 1470
47.65 SEQ – Sequencer ................................................................... 1471
47.66 Signal Source Blocks .............................................................. 1473
47.66.1 NCYC ................................................................................... 1473
47.66.2 OSC ..................................................................................... 1473
47.66.3 PVB ...................................................................................... 1473
47.66.4 PVI ....................................................................................... 1473
47.66.5 PVR ...................................................................................... 1473
47.67 NCYC – Program Cycle Counter ............................................. 1474
47.68 OSC – Oscillator ..................................................................... 1475
47.69 PVB – Parameter Value Binary ................................................ 1476
47.70 PVI – Integer Value Parameter ................................................. 1477
47.71 PVR – Real Value Parameter ................................................... 1478
48 Function Block Operators ........................................ 1479
48.1 Operators ............................................................................... 1481
48.1.1 Constant Operators .............................................................. 1481
48.1.2 Logical Operators ................................................................. 1481
48.1.3 Math Operators ..................................................................... 1482
48.1.4 Comparison Operators ......................................................... 1482
48.1.5 Bit Operators ........................................................................ 1482
48.1.6 Other Operators .................................................................... 1483
48.2 Adding an Operator ................................................................ 1484
48.3 Constant Operators ................................................................ 1485
48.3.1 Binary Const ......................................................................... 1485
48.3.2 Integer Const ........................................................................ 1485
48.3.3 Real Const ............................................................................ 1485
48.4 Logical Operators ................................................................... 1486
48.4.1 NOT operator ........................................................................ 1486
48.4.2 AND operator ........................................................................ 1486
48.4.3 OR operator .......................................................................... 1486
48.4.4 XOR operator ........................................................................ 1486
48.5 Math Operators ...................................................................... 1487
48.5.1 Negate ................................................................................. 1487
48.5.2 Addition ................................................................................ 1487
48.5.3 Subtraction ........................................................................... 1487
48.5.4 Product ................................................................................ 1487
48.5.5 Division ................................................................................. 1487
48.5.6 Modulo ................................................................................. 1487
Technical 04-16006-04-en, March 2015
32
48.6 Comparison Operators ........................................................... 1489
48.6.1 Less than .............................................................................. 1489
48.6.2 Greater than .......................................................................... 1489
48.6.3 Equal .................................................................................... 1489
48.6.4 Not Equal .............................................................................. 1489
48.6.5 Greater or Equal .................................................................... 1489
48.6.6 Less or Equal ........................................................................ 1489
48.7 Bit Operators .......................................................................... 1491
48.7.1 bit AND ................................................................................. 1491
48.7.2 bit OR ................................................................................... 1491
48.7.3 bit XOR ................................................................................. 1491
48.7.4 Shift Right ............................................................................. 1491
48.7.5 Shift Left ............................................................................... 1491
48.8 Bit Operator Examples ............................................................ 1492
48.9 Miscellaneous Operators ........................................................ 1494
48.9.1 D/A Converter ....................................................................... 1494
48.9.2 A/D Converter ....................................................................... 1494
48.9.3 Analog Multiplexer ................................................................. 1494
48.9.4 Binary Multiplexer .................................................................. 1494
48.9.5 Conversion AA ...................................................................... 1494
49 Function Block User Interface .................................. 1495
49.1 Function Block Editor (Edit Mode) ............................................ 1497
49.2 Function Block Editor File Menu .............................................. 1498
49.3 Function Block Editor Edit Menu .............................................. 1499
49.4 Preferences Menu ................................................................... 1501
49.5 Options Menu ......................................................................... 1502
49.6 Zoom Menu ............................................................................ 1503
49.7 Commands Menu ................................................................... 1504
49.8 Function Block Editor Tools Menu ........................................... 1505
49.9 Function Block Editor Help Menu ............................................ 1506
49.10 Import Dialog Box ................................................................... 1507
49.11 Export Dialog Box ................................................................... 1508
49.12 Print Dialog Box ...................................................................... 1509
49.13 Page Setup Dialog Box ........................................................... 1512
49.14 Search Dialog Box .................................................................. 1514
49.15 Replace Dialog Box ................................................................. 1515
49.16 NEW Menu ............................................................................. 1517
49.17 BLOCK Menu ......................................................................... 1519
49.18 INPUT Menu ........................................................................... 1520
49.19 OUTPUT Menu ....................................................................... 1521
49.20 CONNECTION Menu .............................................................. 1522
49.21 Select Simple Block Dialog Box ............................................... 1523
49.22 Edit Expression Dialog Box ..................................................... 1524
49.23 Edit Block Dialog Box .............................................................. 1526
49.24 Select Operator Dialog Box ..................................................... 1528
49.25 Edit Operator Dialog Box ......................................................... 1529
04-16006-04-en, March 2015 Technical
33
49.26 Constants Table Dialog Box .................................................... 1530
49.27 New Constant Dialog Box ....................................................... 1531
49.28 Public Signal Table .................................................................. 1532
49.29 Edit Hierarchy Dialog Box ........................................................ 1533
49.30 Edit Comment Dialog Box ....................................................... 1534
49.31 Font Dialog Box ...................................................................... 1535
49.32 Select Hierarchy Connection Dialog Box ................................. 1536
49.33 HFB Navigation Tree .............................................................. 1537
49.34 Function Block Editor (Simulation Mode) ................................. 1538
49.35 File Menu in Simulation Mode .................................................. 1540
49.36 Preferences Menu in Simulation Mode ..................................... 1541
49.37 Options Menu in Simulation Mode ........................................... 1542
49.38 Set Date and Time (Simulation) Dialog Box .............................. 1543
49.39 Analog Input Dialog Box .......................................................... 1544
49.40 Digital Input Dialog Box ........................................................... 1545
49.41 RECORD Menu ....................................................................... 1546
49.42 Edit Break Limit Dialog Box ..................................................... 1547
49.43 TREND Menu .......................................................................... 1548
49.44 SIGNAL Menu ......................................................................... 1549
49.45 Function Block Program Properties – Basic Tab ...................... 1550
49.46 Function Block Program Properties – Inputs Tab ..................... 1552
49.47 Function Block Program Properties – Public Signals Tab ......... 1553
49.48 Function Block Program Properties – Outputs Tab .................. 1554
49.49 Function Block Program Properties – References Tab ............. 1555
50 Script Introduction ................................................... 1557
50.1 Script Overview ....................................................................... 1559
50.1.1 Script Workflow .................................................................... 1559
50.1.2 Script Programs .................................................................... 1559
50.1.3 Script Functions .................................................................... 1559
50.1.4 Script Program Components ................................................ 1559
50.1.5 Script Editor Overview ........................................................... 1560
50.1.6 Script Web Services .............................................................. 1560
50.2 Script Workflow ...................................................................... 1561
50.3 Script Programs ...................................................................... 1565
50.3.1 Script Keywords ................................................................... 1565
50.3.2 Script Program Instructions ................................................... 1565
50.3.3 Script Program Flow ............................................................. 1565
50.3.4 Tasks .................................................................................... 1565
50.3.5 Program Cycles in Building Operation ................................... 1566
50.3.6 Bindings and Script Programs ............................................... 1566
50.4 Creating a Script Program ....................................................... 1567
50.5 Opening a Script Program or Function .................................... 1569
50.6 Script Keywords ..................................................................... 1570
50.6.1 A - D ..................................................................................... 1570
50.6.2 E - H ..................................................................................... 1571
50.6.3 I - N ...................................................................................... 1572
Technical 04-16006-04-en, March 2015
34
50.6.4 O - S ..................................................................................... 1573
50.6.5 T - Y ...................................................................................... 1575
50.7 Script Program Flow ............................................................... 1577
50.7.1 FallThru Program Flow .......................................................... 1577
50.7.2 Looping Program Flow .......................................................... 1577
50.8 FallThru Program Flow ............................................................ 1578
50.9 Looping Program Flow ............................................................ 1580
50.10 Script Program Instructions ..................................................... 1581
50.10.1 Lines and Line Numbers ....................................................... 1581
50.10.2 Verb and Verb Elements ........................................................ 1581
50.10.3 Case Sensitivity ..................................................................... 1582
50.10.4 Reserved Words ................................................................... 1582
50.11 Lines and Line Numbers .......................................................... 1583
50.12 Reserved Words ..................................................................... 1584
50.12.1 Script Constants ................................................................... 1584
50.12.2 Script Reserved Words ......................................................... 1584
50.13 Script Reserved Words ........................................................... 1585
50.14 Bindings and Script Programs ................................................. 1589
50.14.1 Local Variable Declarations ................................................... 1589
50.14.2 Binding Attributes ................................................................. 1589
50.15 Binding Values in Script Editor Using a Binding Template ........ 1590
50.16 Local Variable Declarations ..................................................... 1592
50.17 Binding Attributes ................................................................... 1596
50.17.1 Forced .................................................................................. 1596
50.17.2 Invalid ................................................................................... 1596
50.17.3 Offline ................................................................................... 1596
50.17.4 Overridden ............................................................................ 1596
50.18 Forced .................................................................................... 1597
50.19 Invalid ..................................................................................... 1598
50.20 Offline ..................................................................................... 1599
50.21 Overridden .............................................................................. 1600
50.22 Accessing a Binding Attribute .................................................. 1601
50.23 Tasks ...................................................................................... 1602
50.24 Adding a Task to a Program .................................................... 1603
50.25 Program Cycles in Building Operation .................................... 1604
50.25.1 Example A ........................................................................... 1605
50.25.2 Example B ............................................................................ 1607
50.25.3 Application Scheduler ........................................................... 1607
50.26 Configuring the Execution Precedence for a Program .............. 1610
50.27 Finding Cycles in a Task .......................................................... 1611
51 Script Programming ................................................. 1613
51.1 Script Program Components .................................................. 1619
51.1.1 Program Constants ............................................................... 1619
51.1.2 Program Operators ............................................................... 1619
51.1.3 Program Statements ............................................................. 1619
51.1.4 Expressions .......................................................................... 1619
04-16006-04-en, March 2015 Technical
35
51.1.5 Variables ............................................................................... 1619
51.2 Program Constants ................................................................. 1621
51.2.1 Numeric Constants ............................................................... 1621
51.2.2 String Constants ................................................................... 1621
51.2.3 Script Constants ................................................................... 1621
51.2.4 Constant Keywords .............................................................. 1621
51.3 Numeric Constants ................................................................. 1622
51.4 String Constants ..................................................................... 1623
51.4.1 Rules for String Constants ..................................................... 1623
51.4.2 ASCII Codes ......................................................................... 1623
51.5 ASCII Codes ........................................................................... 1624
51.6 Script Constants ..................................................................... 1627
51.7 Constant Keywords ................................................................ 1629
51.7.1 Failure ................................................................................... 1629
51.7.2 OFF ...................................................................................... 1629
51.7.3 ON ......................................................................................... 1629
51.7.4 -ON ........................................................................................ 1629
51.7.5 Success ............................................................................... 1629
51.8 Failure ..................................................................................... 1630
51.9 OFF ........................................................................................ 1631
51.10 ON .......................................................................................... 1632
51.11 -ON ........................................................................................ 1633
51.12 Success ................................................................................. 1634
51.13 Program Operators ................................................................. 1635
51.13.1 Operator Precedence ............................................................ 1635
51.13.2 Plus Sign, Minus Sign, Negation, BITNOT, and Percentage
Operators ............................................................................. 1636
51.13.3 Fundamental Operators ........................................................ 1636
51.13.4 Comparative Operators ......................................................... 1637
51.13.5 List and Range Operators ..................................................... 1639
51.13.6 Bit Operators ........................................................................ 1640
51.13.7 AND/OR and String Joining Operators .................................. 1643
51.13.8 Operator Keywords ............................................................... 1643
51.14 Operator Keywords ................................................................. 1644
51.14.1 Bitwise Operators ................................................................. 1644
51.14.2 Logical Operators ................................................................. 1644
51.14.3 Mathematical Operators ........................................................ 1644
51.15 Bitwise Operators .................................................................. 1645
51.15.1 BITAND ................................................................................ 1645
51.15.2 BITNOT ................................................................................ 1645
51.15.3 BITOR .................................................................................. 1645
51.15.4 BITXOR ................................................................................ 1645
51.16 BITAND .................................................................................. 1646
51.17 BITNOT .................................................................................. 1647
51.18 BITOR .................................................................................... 1648
51.19 BITXOR .................................................................................. 1649
51.20 Logical Operators .................................................................. 1650
Technical 04-16006-04-en, March 2015
36
51.20.1 AND ..................................................................................... 1650
51.20.2 EQUALS ............................................................................... 1650
51.20.3 IS... ....................................................................................... 1650
51.20.4 NOT ..................................................................................... 1650
51.20.5 OR ........................................................................................ 1650
51.21 AND ....................................................................................... 1651
51.22 EQUALS ................................................................................. 1653
51.23 IS... ......................................................................................... 1654
51.24 NOT ........................................................................................ 1657
51.25 OR .......................................................................................... 1658
51.26 Mathematical Operators .......................................................... 1660
51.26.1 DIVIDED BY .......................................................................... 1660
51.26.2 MINUS .................................................................................. 1660
51.26.3 MOD ..................................................................................... 1660
51.26.4 PLUS .................................................................................... 1660
51.26.5 TIMES .................................................................................. 1660
51.27 DIVIDED BY ............................................................................ 1661
51.28 MINUS .................................................................................... 1662
51.29 MOD ....................................................................................... 1663
51.30 PLUS ...................................................................................... 1664
51.31 TIMES ..................................................................................... 1665
51.32 Program Statements ............................................................... 1666
51.32.1 Statement Keywords ............................................................ 1666
51.33 Statement Keywords .............................................................. 1667
51.33.1 Action Statements ................................................................ 1667
51.33.2 Declaration Statements ........................................................ 1667
51.33.3 Program Control Statements ................................................. 1667
51.33.4 Qualifier Statements .............................................................. 1668
51.34 Action Statements ................................................................. 1669
51.34.1 P .......................................................................................... 1669
51.34.2 PRINT ................................................................................... 1669
51.34.3 SET ...................................................................................... 1669
51.34.4 TURN ................................................................................... 1669
51.35 P ............................................................................................ 1670
51.36 PRINT ..................................................................................... 1671
51.37 SET ........................................................................................ 1677
51.38 TURN ..................................................................................... 1679
51.39 Declaration Statements .......................................................... 1680
51.39.1 ARG ..................................................................................... 1680
51.39.2 DATETIME ............................................................................ 1680
51.39.3 LINE ..................................................................................... 1680
51.39.4 NUMERIC ............................................................................. 1680
51.39.5 STRING ................................................................................ 1680
51.39.6 THE ...................................................................................... 1680
51.39.7 Webservice ........................................................................... 1681
51.40 ARG ....................................................................................... 1682
51.41 DATETIME .............................................................................. 1683
04-16006-04-en, March 2015 Technical
37
51.42 LINE ....................................................................................... 1685
51.43 NUMERIC ............................................................................... 1689
51.44 STRING .................................................................................. 1691
51.45 THE ........................................................................................ 1693
51.46 Webservice ............................................................................. 1694
51.47 Program Control Statements .................................................. 1695
51.47.1 BASEDON...GOTO ............................................................... 1695
51.47.2 BREAK ................................................................................. 1695
51.47.3 CONTINUE ........................................................................... 1695
51.47.4 FOR...NEXT .......................................................................... 1695
51.47.5 GOTO ................................................................................... 1695
51.47.6 IF...THEN...ELSE .................................................................. 1695
51.47.7 MOVE ................................................................................... 1696
51.47.8 Repeat...Until ........................................................................ 1696
51.47.9 RETURN ............................................................................... 1696
51.47.10 SELECT CASE ...................................................................... 1696
51.47.11 STOP ................................................................................... 1696
51.47.12 WAIT .................................................................................... 1696
51.47.13 WHILE .................................................................................. 1696
51.48 BASEDON...GOTO ................................................................. 1697
51.49 BREAK ................................................................................... 1699
51.50 CONTINUE ............................................................................. 1700
51.51 FOR...NEXT ............................................................................ 1701
51.52 GOTO ..................................................................................... 1704
51.53 IF...THEN...ELSE .................................................................... 1707
51.54 MOVE ..................................................................................... 1711
51.55 Repeat...Until .......................................................................... 1712
51.56 RETURN ................................................................................. 1713
51.57 SELECT CASE ........................................................................ 1715
51.58 STOP ...................................................................................... 1717
51.59 WAIT ...................................................................................... 1718
51.60 WHILE .................................................................................... 1719
51.61 Qualifier Statements ................................................................ 1720
51.61.1 INPUT ................................................................................... 1720
51.61.2 Buffered ................................................................................ 1720
51.61.3 OUTPUT ............................................................................... 1720
51.61.4 PUBLIC ................................................................................ 1720
51.62 INPUT ..................................................................................... 1721
51.63 Buffered ................................................................................. 1722
51.64 OUTPUT ................................................................................. 1723
51.65 PUBLIC .................................................................................. 1724
51.66 Expressions ............................................................................ 1725
51.66.1 Numeric Expressions ............................................................ 1725
51.66.2 String Expressions ................................................................ 1725
51.67 Variables ................................................................................. 1726
51.67.1 Program Variables ................................................................. 1726
51.67.2 System Variables .................................................................. 1726
Technical 04-16006-04-en, March 2015
38
51.67.3 System Variable Keywords .................................................... 1726
51.67.4 Script Runtime Variables ....................................................... 1726
51.68 Declaring a Variable ................................................................ 1727
51.69 Program Variables .................................................................. 1728
51.69.1 Local Program Variables ....................................................... 1728
51.69.2 Program Arrays ..................................................................... 1728
51.69.3 Variables Pane Types ............................................................ 1728
51.70 Local Program Variables ......................................................... 1729
51.70.1 Local Program Variable Declaration ....................................... 1729
51.70.2 Local Program Variables and Bindings .................................. 1730
51.71 Variables Pane Types .............................................................. 1732
51.72 Program Arrays ....................................................................... 1733
51.73 System Variables .................................................................... 1734
51.74 Script Runtime Variables ......................................................... 1735
51.74.1 TS ........................................................................................ 1735
51.74.2 TM ........................................................................................ 1735
51.74.3 TH ........................................................................................ 1735
51.74.4 TD ........................................................................................ 1735
51.75 TS .......................................................................................... 1736
51.76 TM .......................................................................................... 1737
51.77 TH .......................................................................................... 1738
51.78 TD .......................................................................................... 1739
51.79 System Variable Keywords ...................................................... 1740
51.79.1 Date and Time System Variables ........................................... 1740
51.79.2 Runtime System Variables ..................................................... 1740
51.80 Date and Time System Variables ............................................ 1741
51.80.1 DATE .................................................................................... 1741
51.80.2 DAYOFMONTH .................................................................... 1741
51.80.3 DAYOFYEAR ........................................................................ 1741
51.80.4 HOD ..................................................................................... 1741
51.80.5 HOUR ................................................................................... 1742
51.80.6 MINUTE ................................................................................ 1742
51.80.7 MONTH ................................................................................ 1742
51.80.8 SECOND .............................................................................. 1742
51.80.9 TOD ...................................................................................... 1742
51.80.10 WEEKDAY ............................................................................ 1742
51.80.11 YEAR .................................................................................... 1743
51.81 DATE ...................................................................................... 1744
51.82 DAYOFMONTH ...................................................................... 1745
51.83 DAYOFYEAR .......................................................................... 1746
51.84 HOD ....................................................................................... 1747
51.85 HOUR ..................................................................................... 1748
51.86 MINUTE .................................................................................. 1749
51.87 MONTH .................................................................................. 1750
51.88 SECOND ................................................................................ 1752
51.89 TOD ........................................................................................ 1753
51.90 WEEKDAY .............................................................................. 1754
04-16006-04-en, March 2015 Technical
39
51.91 YEAR ...................................................................................... 1756
51.92 Runtime System Variables ...................................................... 1757
51.92.1 ERRORS .............................................................................. 1757
51.92.2 FREEMEM ............................................................................ 1757
51.92.3 SCAN ................................................................................... 1757
51.93 ERRORS ................................................................................ 1758
51.94 FREEMEM .............................................................................. 1759
51.95 SCAN ..................................................................................... 1760
51.96 Script Functions ...................................................................... 1761
51.96.1 Script Function Workflow ...................................................... 1761
51.96.2 Script Functions and Programs ............................................. 1761
51.96.3 System Functions ................................................................. 1761
51.97 Script Function Workflow ........................................................ 1762
51.97.1 Script Functions without Arguments ...................................... 1762
51.97.2 Script Functions with Arguments ........................................... 1762
51.97.3 Script Functions that Return a Value ...................................... 1763
51.98 Script Functions without Arguments ........................................ 1764
51.99 Script Functions with Arguments ............................................. 1765
51.100 Script Functions that Return a Value ........................................ 1766
51.101 Script Functions and Programs ............................................... 1767
51.101.1 Function Declarations and Statements .................................. 1767
51.102 Function Declarations and Statements .................................... 1768
51.103 Declaring and Calling a Script Function ................................... 1770
51.104 Creating a Script Function ....................................................... 1771
51.105 Declaring a Script Function Argument ..................................... 1772
51.106 Checking and Saving a Script Function ................................... 1773
51.107 System Functions ................................................................... 1774
51.107.1 System Function Keywords ................................................... 1774
51.108 System Function Keywords ..................................................... 1775
51.108.1 Buffered Variable Functions ................................................... 1775
51.108.2 Conversion Functions ........................................................... 1775
51.108.3 Mathematical Functions ........................................................ 1775
51.108.4 Object Functions ................................................................... 1776
51.108.5 PASSED Function ................................................................. 1776
51.108.6 Rounding Functions .............................................................. 1776
51.108.7 Statistical Functions .............................................................. 1776
51.108.8 String Functions .................................................................... 1777
51.108.9 Time Functions ..................................................................... 1777
51.108.10 Trigonomentric Functions ...................................................... 1777
51.109 Buffered Variable Functions .................................................... 1779
51.109.1 GetBufferSize ....................................................................... 1779
51.109.2 GetBufferedValue ................................................................. 1779
51.110 GetBufferSize ......................................................................... 1780
51.111 GetBufferedValue .................................................................... 1782
51.112 Conversion Functions ............................................................. 1783
51.112.1 NUMTOSTR ......................................................................... 1783
51.112.2 STRTODATE ........................................................................ 1783
Technical 04-16006-04-en, March 2015
40
51.112.3 STRTONUM ......................................................................... 1783
51.113 NUMTOSTR ........................................................................... 1784
51.114 STRTODATE ........................................................................... 1785
51.115 STRTONUM ........................................................................... 1787
51.116 Mathematical Functions .......................................................... 1788
51.116.1 ABS ...................................................................................... 1788
51.116.2 EXPONENTIAL ..................................................................... 1788
51.116.3 FACTORIAL .......................................................................... 1788
51.116.4 LN ........................................................................................ 1788
51.116.5 LOG ..................................................................................... 1788
51.116.6 RANDOM ............................................................................. 1788
51.116.7 SQRT ................................................................................... 1788
51.116.8 SUM ..................................................................................... 1789
51.117 ABS ........................................................................................ 1790
51.118 EXPONENTIAL ....................................................................... 1791
51.119 FACTORIAL ............................................................................ 1792
51.120 LN .......................................................................................... 1793
51.121 LOG ....................................................................................... 1794
51.122 RANDOM ............................................................................... 1795
51.123 SQRT ..................................................................................... 1796
51.124 SUM ....................................................................................... 1797
51.125 Object Functions ..................................................................... 1799
51.125.1 GETNAME ............................................................................ 1799
51.125.2 ReadProperty ....................................................................... 1799
51.125.3 Relinquish ............................................................................. 1799
51.125.4 WriteProperty ....................................................................... 1799
51.126 GETNAME .............................................................................. 1800
51.127 ReadProperty ......................................................................... 1804
51.128 Relinquish ............................................................................... 1805
51.129 WriteProperty .......................................................................... 1806
51.130 PASSED Function ................................................................... 1808
51.131 Rounding Functions ................................................................ 1809
51.131.1 CEILING ............................................................................... 1809
51.131.2 FLOOR ................................................................................. 1809
51.131.3 ROUND ................................................................................ 1809
51.131.4 TRUNCATE .......................................................................... 1809
51.132 CEILING ................................................................................. 1810
51.133 FLOOR ................................................................................... 1811
51.134 ROUND .................................................................................. 1812
51.135 TRUNCATE ............................................................................ 1813
51.136 Statistical Functions ................................................................ 1814
51.136.1 AVERAGE ............................................................................. 1814
51.136.2 MAXIMUM ............................................................................ 1814
51.136.3 MAXITEM ............................................................................. 1814
51.136.4 MINIMUM ............................................................................. 1814
51.136.5 MINITEM .............................................................................. 1814
51.136.6 StandardDeviation ................................................................ 1814
04-16006-04-en, March 2015 Technical
41
51.137 AVERAGE ............................................................................... 1815
51.138 MAXIMUM .............................................................................. 1817
51.139 MAXITEM ............................................................................... 1819
51.140 MINIMUM ............................................................................... 1821
51.141 MINITEM ................................................................................ 1823
51.142 StandardDeviation .................................................................. 1825
51.143 String Functions ...................................................................... 1827
51.143.1 ASC ...................................................................................... 1827
51.143.2 CHR ..................................................................................... 1827
51.143.3 LEFT ..................................................................................... 1827
51.143.4 LENGTH ............................................................................... 1827
51.143.5 MID ...................................................................................... 1827
51.143.6 RIGHT .................................................................................. 1827
51.143.7 SEARCH ............................................................................... 1828
51.143.8 STRINGFILL ......................................................................... 1828
51.143.9 TAB ...................................................................................... 1828
51.144 ASC ........................................................................................ 1829
51.145 CHR ....................................................................................... 1830
51.146 LEFT ....................................................................................... 1831
51.147 LENGTH ................................................................................. 1832
51.148 MID ........................................................................................ 1833
51.149 RIGHT .................................................................................... 1834
51.150 SEARCH ................................................................................. 1835
51.151 STRINGFILL ........................................................................... 1836
51.152 TAB ........................................................................................ 1838
51.153 Time Functions ....................................................................... 1839
51.153.1 DIFFTIME .............................................................................. 1839
51.153.2 TIMEPIECE ........................................................................... 1839
51.154 DIFFTIME ................................................................................ 1840
51.155 TIMEPIECE ............................................................................. 1842
51.156 Trigonometric Functions ......................................................... 1843
51.156.1 ACOS ................................................................................... 1843
51.156.2 ASIN ..................................................................................... 1843
51.156.3 ATAN .................................................................................... 1843
51.156.4 ATAN2 .................................................................................. 1843
51.156.5 COS ..................................................................................... 1843
51.156.6 SIN ....................................................................................... 1843
51.156.7 TAN ...................................................................................... 1843
51.157 ACOS ..................................................................................... 1844
51.158 ASIN ....................................................................................... 1845
51.159 ATAN ...................................................................................... 1846
51.160 ATAN2 .................................................................................... 1847
51.161 COS ....................................................................................... 1848
51.162 SIN ......................................................................................... 1849
51.163 TAN ........................................................................................ 1850
52 Script Editor ............................................................. 1851
Technical 04-16006-04-en, March 2015
42
52.1 Script Editor Overview ............................................................. 1853
52.1.1 Script Editor Program Creation .............................................. 1853
52.1.2 Script Editor Features ............................................................ 1853
52.1.3 Script Compiler Errors ........................................................... 1853
52.1.4 Script Runtime Errors ............................................................ 1853
52.2 Script Editor Program Creation ................................................ 1854
52.3 Script Compiler Errors ............................................................. 1859
52.4 Script Runtime Errors .............................................................. 1862
52.5 Script Editor Features ............................................................. 1864
52.5.1 Script Editor Program Elements and Colors ........................... 1864
52.5.2 Keyboard Shortcuts for Script Editor ..................................... 1864
52.5.3 Collapsible Code Segments .................................................. 1864
52.5.4 Comments in Script Programs .............................................. 1864
52.5.5 Script Auto-Completion ........................................................ 1865
52.5.6 Script Editor Initial Binding Variable Values ............................ 1865
52.6 Script Editor Program Elements and Colors ............................. 1866
52.7 Keyboard Shortcuts for Script Editor ....................................... 1867
52.8 Collapsible Code Segments .................................................... 1868
52.8.1 Clipboard .............................................................................. 1868
52.8.2 Code Library ......................................................................... 1868
52.9 Adding a Line .......................................................................... 1871
52.10 Script Auto-Completion .......................................................... 1872
52.11 Using Script Auto-Completion ................................................ 1873
52.12 Script Editor Initial Binding Variable Values .............................. 1874
52.12.1 Statements in Script Programs .............................................. 1874
52.12.2 Script Editor Variables Pane Initial Value Field ........................ 1874
52.13 Comments in Script Programs ................................................ 1876
52.14 Adding a Comment ................................................................. 1877
52.15 Checking and Saving a Script Program ................................... 1878
52.16 Executing a Script Program ..................................................... 1879
52.17 Importing Script Program Code ............................................... 1881
52.18 Exporting a Script Program ..................................................... 1882
52.19 Converting a Plain English File ................................................. 1883
52.20 Customizing the Script Editor .................................................. 1885
52.21 Using a Collapsible Script Code Block ..................................... 1888
52.22 Adding an Entry to the Code Library ........................................ 1890
52.23 Working with Code Library Folders .......................................... 1893
52.24 Working with Code Library Sample Import Files ....................... 1894
52.25 Working with Code Library Items ............................................. 1899
52.26 Inserting a Code Library Item in a Script Program or Function .. 1900
52.27 Referencing the Code Library File ............................................ 1901
52.28 Finding Text in Script Editor ..................................................... 1902
52.29 Using Undo and Redo in Script Editor ..................................... 1903
52.30 Script Debugger ..................................................................... 1904
52.30.1 Debug Mode Editing ............................................................. 1904
52.30.2 Debug b3 BACnet Script Programs ....................................... 1904
52.31 Script Debugger Function Keys ............................................... 1906
04-16006-04-en, March 2015 Technical
43
52.32 Debugging a Script Program .................................................. 1907
52.33 Controlling the Trace Operation in the Script Debugger .......... 1911
52.34 Changing Values in the Script Debugger Local or Binding Variables
Pane ...................................................................................... 1912
53 Script Web Services ................................................. 1915
53.1 Script Web Services ................................................................ 1917
53.1.1 Script Web Services Workflow .............................................. 1917
53.1.2 Script SOAP Web Services Data Type ................................... 1918
53.1.3 Script RESTFul Web Services ............................................... 1918
53.2 Script Web Services Workflow ................................................ 1919
53.3 Creating a Script Web Service Interface ................................... 1921
53.4 Configuring a Script Web Service Interface .............................. 1922
53.5 Configuring a Script Program to use Web Services .................. 1924
53.6 Script SOAP Web Services Data Type ..................................... 1927
53.6.1 Supported Data Types .......................................................... 1928
53.6.2 Web Service Declarations ..................................................... 1928
53.6.3 Web Service Selection and EndPoints ................................... 1929
53.7 Script RESTful Web Services .................................................. 1931
53.7.1 SendWebRequest ................................................................ 1931
53.7.2 UrlEncode ............................................................................. 1931
53.8 Using Script to Send a Request to a RESTful Web Service ...... 1933
53.9 Using Script to Obtain a Secure Web Page from a RESTful Web
Service ................................................................................... 1936
54 Script User Interface ................................................ 1939
54.1 Script Editor ............................................................................ 1941
54.2 Script Editor Toolbars .............................................................. 1944
54.3 Script Editor – Binding Variables Pane ..................................... 1947
54.4 Script Editor – Local Variables Pane ........................................ 1948
54.5 Script Editor Shortcut Menu .................................................... 1949
54.6 Import Plain English Dialog Box ............................................... 1951
54.7 Script Program Properties – Basic Tab .................................... 1953
54.8 Script Program Properties – Advanced Tab ............................. 1955
54.9 Script Program Properties – Inputs Tab ................................... 1956
54.10 Script Program Properties – Outputs Tab ................................ 1957
54.11 Script Program Properties – Publics Tab ................................. 1958
54.12 Script Program Properties – Functions Tab ............................. 1959
54.13 Script Program Properties – Web Services Tab ....................... 1960
54.14 Script Function Properties – Basic Tab .................................... 1961
54.15 Script Function Properties – Inputs Tab ................................... 1962
54.16 Script Function Properties – Outputs Tab ................................ 1963
54.17 Script Function Properties – Publics Tab ................................. 1964
54.18 Script Function Properties – Functions Tab ............................. 1965
54.19 Script Web Service – Basic Tab .............................................. 1966
54.20 Script Web Service – Methods Tab ......................................... 1967
55 LonWorks Introduction ............................................. 1969
Technical 04-16006-04-en, March 2015
44
55.1 LonWorks Overview ................................................................ 1971
55.1.1 LonWorks Engineering .......................................................... 1971
55.1.2 LonWorks Operating ............................................................. 1971
55.1.3 LonWorks Maintenance ........................................................ 1971
55.2 LonWorks Engineering ............................................................ 1972
55.2.1 LonWorks Interfaces ............................................................. 1973
55.2.2 LonWorks Devices ................................................................ 1973
55.2.3 LonWorks Local Node .......................................................... 1973
55.2.4 LonWorks Bindings ............................................................... 1973
55.3 LonWorks Interfaces ............................................................... 1974
55.3.1 LonWorks in the Automation Server ...................................... 1975
55.3.2 LonWorks in the Enterprise Server ........................................ 1975
55.3.3 Externally Managed LonWorks Network ................................ 1975
55.4 LonWorks in the Automation Server ........................................ 1976
55.5 LonWorks in the Enterprise Server .......................................... 1977
55.5.1 LonWorks NIC709-PCI Interface ........................................... 1977
55.5.2 LonWorks NIC709-USB Interface .......................................... 1978
55.5.3 LonWorks NIC709-IP Interface .............................................. 1978
55.5.4 LonWorks NIC852 Interface .................................................. 1978
55.6 LonWorks NIC709-USB Interface ............................................ 1979
55.7 LonWorks NIC709-PCI Interface ............................................. 1980
55.8 LonWorks NIC709-IP Interface ................................................ 1981
55.9 LonWorks NIC852 Interface .................................................... 1982
55.9.1 L-IP Router Setup ................................................................. 1983
55.10 L-IP Router Setup ................................................................... 1984
55.10.1 Step 1: PC Setup .................................................................. 1984
55.10.2 Step 2: L-IP Device Configuration .......................................... 1986
55.10.3 Step 3: Configuration Server Setup ....................................... 1987
55.10.4 Step 4: Enterprise Server Setup ............................................ 1989
55.10.5 Step 5: Final Test .................................................................. 1990
55.11 Externally Managed LonWorks Network .................................. 1991
55.12 Creating a LonWorks Interface ................................................ 1993
55.13 Discovering a LonWorks Interface ........................................... 1994
55.14 Configuring a LonWorks Interface ........................................... 1995
55.15 Creating a LonWorks Network ................................................ 1996
55.16 Configuring a LonWorks Network ............................................ 1997
55.17 Creating an Externally Managed LonWorks Network ............... 1999
55.18 Changing the Domain ID for a LonWorks Network ................... 2000
56 LonWorks Devices ................................................... 2003
56.1 LonWorks Devices .................................................................. 2005
56.1.1 LonWorks Device Templates ................................................. 2005
56.1.2 Device Resource Files ........................................................... 2005
56.1.3 LonWorks Device Workflow .................................................. 2005
56.1.4 Network Variables and Configuration Parameters .................. 2005
56.1.5 LonWorks Commission and Decommission .......................... 2006
56.1.6 LonWorks Application Upgrade ............................................. 2006
04-16006-04-en, March 2015 Technical
45
56.1.7 LNS Plugins .......................................................................... 2006
56.2 Creating a LonWorks Device ................................................... 2007
56.3 Configuring a LonWorks Device .............................................. 2009
56.4 LonWorks Commission and Decommission ............................ 2011
56.4.1 Commission ......................................................................... 2011
56.4.2 Decommission ...................................................................... 2011
56.5 Discovering a LonWorks Device .............................................. 2012
56.6 Commissioning a LonWorks Device ........................................ 2014
56.7 Decommissioning a LonWorks Device ..................................... 2016
56.8 Downloading the LonWorks Device Configuration .................. 2017
56.9 Uploading the LonWorks Device Configuration ....................... 2018
56.10 LonWorks Application Upgrade ............................................... 2019
56.11 Upgrading the Device Application ............................................ 2020
56.12 LonWorks Device Templates ................................................... 2022
56.13 Importing a Device Template ................................................... 2024
56.14 Device Resource Files ............................................................. 2026
56.15 Importing Device Resource Files ............................................. 2027
56.16 LonWorks Device Workflows ................................................... 2029
56.16.1 Create and then Discover LonWorks Device Workflow .......... 2029
56.16.2 Discover LonWorks Device Workflow .................................... 2029
56.16.3 Create LonWorks Device Workflow ....................................... 2029
56.17 Create and then Discover LonWorks Device Workflow ............ 2030
56.18 Discover LonWorks Device Workflow ...................................... 2032
56.19 Create LonWorks Device Workflow ......................................... 2034
56.20 Network Variables and Configuration Parameters .................... 2039
56.20.1 Network Variables ................................................................. 2039
56.20.2 Configuration Parameters ..................................................... 2039
56.20.3 Variable Members and Structured Variables .......................... 2039
56.20.4 NVTs and CPTs .................................................................... 2040
56.20.5 Network Variable and Configuration Parameter Values .......... 2040
56.20.6 Update Monitor ..................................................................... 2040
56.20.7 Propagation Trigger .............................................................. 2040
56.21 Variable Members and Structured Variables ............................ 2041
56.22 Network Variable and Configuration Parameter Values ............ 2042
56.23 Configuring a Network Variable ............................................... 2043
56.24 Configuring the Value for a Network Variable Member ............. 2045
56.25 Configuring a Configuration Property ....................................... 2046
56.26 LNS Plug-ins ........................................................................... 2047
56.27 Registering LNS Plug-ins ........................................................ 2049
56.28 Unregistering LNS Plug-ins ..................................................... 2051
56.29 Configuring Network Variables and Configuration Parameters using
LNS Plug-in ............................................................................ 2053
56.30 Importing a Device Template in LNS ........................................ 2056
56.31 Winking a Device ..................................................................... 2058
56.32 Adding Missing XIF and DRF Files ........................................... 2059
57 LonWorks Local Node ............................................. 2063
Technical 04-16006-04-en, March 2015
46
57.1 LonWorks Local Node ............................................................ 2065
57.1.1 LonWorks Commission and Decommission .......................... 2066
57.1.2 LonWorks Functional Block ................................................... 2066
57.1.3 Network Variables and Configuration Parameters .................. 2066
57.2 Creating a Local Node ............................................................ 2067
57.3 Configuring a Local Node ....................................................... 2068
57.4 LonWorks Commission and Decommission ............................ 2069
57.4.1 Commission ......................................................................... 2069
57.4.2 Decommission ...................................................................... 2069
57.5 Commissioning a Local Node .................................................. 2070
57.6 Decommissioning a Local Node .............................................. 2071
57.7 LonWorks Functional Block ..................................................... 2072
57.8 Creating a Functional Block ..................................................... 2073
57.9 Network Variables and Configuration Parameters .................... 2074
57.9.1 Network Variables ................................................................. 2074
57.9.2 Configuration Parameters ..................................................... 2074
57.9.3 Variable Members and Structured Variables .......................... 2074
57.9.4 NVTs and CPTs .................................................................... 2075
57.9.5 Network Variable and Configuration Parameter Values .......... 2075
57.9.6 Update Monitor ..................................................................... 2075
57.9.7 Propagation Trigger .............................................................. 2075
57.10 Update Monitor ....................................................................... 2076
57.11 Propagation Trigger ................................................................ 2077
57.12 Creating Network Variables Automatically ............................... 2078
57.13 Creating an Input Network Variable ......................................... 2079
57.14 Creating an Output Network Variable ...................................... 2081
57.15 Configuring a Network Variable ............................................... 2083
57.16 Configuring the Value for a Network Variable Member ............. 2085
57.17 Creating an Update Monitor .................................................... 2086
57.18 Creating a Propagation Trigger ................................................ 2087
57.19 Configuring an Update Monitor ............................................... 2088
57.20 Configuring a Propagation Trigger ........................................... 2089
58 LonWorks Bindings .................................................. 2091
58.1 LonWorks Bindings ................................................................ 2093
58.1.1 LonWorks Bindings in WorkStation ....................................... 2093
58.1.2 Bindable objects in LonWorks ............................................... 2093
58.1.3 LonWorks Binding Profiles .................................................... 2094
58.1.4 LonWorks Binding Types ...................................................... 2094
58.1.5 LonWorks Selectors and Bindings ......................................... 2094
58.2 LonWorks Bindings in WorkStation ......................................... 2095
58.3 LonWorks Binding Profiles ..................................................... 2096
58.4 LonWorks Binding Types ........................................................ 2098
58.4.1 Hubs and Targets in Bindings ............................................... 2098
58.4.2 Point-to-point Bindings ......................................................... 2098
58.4.3 Turnaround Bindings ............................................................. 2099
58.4.4 Fan-out Bindings .................................................................. 2099
04-16006-04-en, March 2015 Technical
47
58.4.5 Fan-in Bindings ..................................................................... 2100
58.5 Bindable Objects in LonWorks ................................................ 2101
58.6 LonWorks Selectors and Bindings ........................................... 2102
58.7 Creating a LonWorks Binding .................................................. 2107
58.8 Replacing a Hub in a LonWorks Binding .................................. 2109
59 LonWorks Maintenance and Operating .................... 2111
59.1 LonWorks Maintenance .......................................................... 2113
59.1.1 LonWorks Device Replacement ............................................ 2113
59.1.2 LonWorks Network Analysis .................................................. 2113
59.1.3 LonWorks Device Diagnostics ............................................... 2113
59.2 LonWorks Device Replacement .............................................. 2114
59.3 Replacing an Online LonWorks Device .................................... 2115
59.4 Replacing an Offline LonWorks Device .................................... 2117
59.5 LonWorks Network Analysis .................................................... 2118
59.5.1 LOYTEC Protocol Analyzer (LPA) .......................................... 2118
59.5.2 LPA in Building Operation ..................................................... 2119
59.5.3 LPA Analysis Overview ......................................................... 2120
59.6 LonWorks Device Diagnostics ................................................. 2122
59.7 Viewing Diagnostic Data .......................................................... 2123
59.8 Clearing Diagnostic Data ......................................................... 2124
59.9 Rebinding a LonWorks Network .............................................. 2125
59.10 Detecting Subnet/Node Conflicts ............................................ 2126
59.11 LonWorks Operating ............................................................... 2127
59.11.1 LonWorks Offline Alarms ....................................................... 2127
59.12 LonWorks Offline Alarms ......................................................... 2128
60 LonWorks User Interface .......................................... 2129
60.1 LonWorks System Tree Icons .................................................. 2133
60.2 File Menu – LonWorks Import Submenu .................................. 2135
60.3 Devices Shortcut Menu ........................................................... 2136
60.4 LonWorks Interface Properties – Basic Tab ............................. 2137
60.5 LonWorks Interface Properties – Advanced Tab ...................... 2138
60.6 LonWorks Network Properties – Basic Tab ............................. 2139
60.7 LonWorks Network Properties – Advanced Tab ...................... 2140
60.8 Local Node Properties – Basic Tab ......................................... 2142
60.9 Local Node Properties – Offline Detection Tab ......................... 2144
60.10 Local Node Properties – Diagnostics Tab ................................ 2145
60.11 LonWorks Device Properties – Basic Tab ................................ 2148
60.12 LonWorks Device Properties – Offline Detection Tab ............... 2150
60.13 LonWorks Device Properties – Diagnostics Tab ...................... 2152
60.14 Update Monitor - Basic Tab .................................................... 2155
60.15 Propagation Trigger - Basic Tab .............................................. 2156
60.16 Device Tables Properties – Basic Tab ...................................... 2157
60.17 Device Tables Properties – Address Table Tab ........................ 2158
60.18 Device Tables Properties – Domain Table Tab ......................... 2160
60.19 Device Tables Properties – Selector Table Tab ........................ 2162
Technical 04-16006-04-en, March 2015
48
60.20 Device Tables Properties – Alias Table Tab .............................. 2164
60.21 Create Network Variable Wizard – Define Network Variable
Page ....................................................................................... 2166
60.22 Create Network Variable Wizard – Input Variable Parameters
Page ....................................................................................... 2167
60.23 Create Network Variable Wizard – Output Variable Parameters Page
............................................................................................... 2168
60.24 Functional Block Properties ..................................................... 2169
60.25 Configuration Parameters and Network Variable Properties – Basic
Tab ......................................................................................... 2170
60.26 Configuration Parameters and Network Variable Properties –
Variable Instance Settings Tab ................................................ 2172
60.27 Configuration Parameters and Network Variable Properties –
Extended Settings Tab ............................................................ 2174
60.28 Variable Member Properties .................................................... 2177
60.29 Import Resource Files Wizard – Select Resource Kit Directory
Page ....................................................................................... 2178
60.30 Import Resource Files Wizard – Importing DRF Kit Page .......... 2179
60.31 Import Resource Files Wizard – Committing the DRF Kit Page . 2180
60.32 Import Device Template Wizard – Import Device Template
Page ....................................................................................... 2181
60.33 Import Device Template Wizard – Device Template Dialog Box 2182
60.34 Import Device Template Wizard – Importing Device Template
Page ....................................................................................... 2183
60.35 Neuron ID and Commission Settings Page ............................. 2184
60.36 Lon Folder Properties .............................................................. 2186
60.37 Add Missing Files Wizard – Searching for Missing Files Page ... 2187
60.38 Add Missing Files Wizard – Select Directory to Search for XIF and
DRF Resources Page .............................................................. 2188
60.39 Add Missing Files Wizard – Searching for Replacement Files
Page ....................................................................................... 2189
60.40 Add Missing Files Wizard – Importing Replacement Files Page 2190
60.41 LNS Plug-in Registration View ................................................. 2191
60.42 Configure Using LNS Plug-ins Wizard - Copying Device
Configuration to LNS Page ...................................................... 2193
60.43 Configure Using LNS Plug-ins Wizard - Select LNS Plug-in
Page ....................................................................................... 2194
60.44 Configure Using LNS Plug-ins Wizard - Confirm LNS Configuration
Page ....................................................................................... 2195
60.45 Configure Using LNS Plug-ins Wizard - Copying Device
Configuration from LNS Page .................................................. 2196
60.46 Lon Binding Properties ............................................................ 2197
60.47 LonWorks Binding Profile Icons ............................................... 2198
60.48 LonWorks Binding Profile Properties – Basic Tab .................... 2199
60.49 LonWorks Binding Profile Properties – Advanced Tab ............ 2200
61 Xenta LonWorks Introduction ................................... 2203
61.1 Xenta LonWorks Device Overview ........................................... 2205
61.1.1 Xenta LonWorks Devices ...................................................... 2205
61.1.2 Xenta LonWorks Engineering ................................................ 2205
04-16006-04-en, March 2015 Technical
49
61.1.3 Xenta LonWorks Device Functions ........................................ 2205
61.2 Xenta LonWorks Engineering .................................................. 2206
61.2.1 Xenta LonWorks Device Workflow ......................................... 2207
61.2.2 LonWorks Interfaces ............................................................. 2208
61.2.3 Xenta LonWorks Groups ....................................................... 2208
61.2.4 Xenta LonWorks Device Commissioning ............................... 2208
61.2.5 Xenta LonWorks Applications ................................................ 2208
61.3 LonWorks Interfaces ............................................................... 2209
61.3.1 LonWorks in the Automation Server ...................................... 2210
61.3.2 LonWorks in the Enterprise Server ........................................ 2210
61.3.3 Externally Managed LonWorks Network ................................ 2210
61.4 Xenta LonWorks Device Workflows ......................................... 2211
61.4.1 Create and then Discover Xenta LonWorks Device Workflow . 2211
61.4.2 Discover Xenta LonWorks Device Workflow .......................... 2211
61.4.3 Create Xenta LonWorks Device Workflow ............................. 2211
61.5 Create and then Discover Xenta LonWorks Device Workflow ... 2212
61.6 Discover Xenta LonWorks Device Workflow ............................ 2214
61.7 Create Xenta LonWorks Device Workflow ................................ 2216
61.8 Configuring a LonWorks Network for Xenta Devices ................ 2221
61.9 Binding Xenta Network Variables ............................................. 2224
61.10 Xenta OP ................................................................................ 2226
62 Xenta LonWorks Devices ......................................... 2227
62.1 Xenta LonWorks Devices ........................................................ 2229
62.1.1 Xenta OP .............................................................................. 2230
62.1.2 Xenta LonWorks Device Restart ............................................ 2230
62.2 Creating a Programmable Xenta Device .................................. 2231
62.3 Discovering a Xenta Device ..................................................... 2233
62.4 Configuring a Xenta LonWorks Device ..................................... 2235
62.5 Xenta LonWorks Device Commissioning ................................. 2236
62.5.1 Xenta LonWorks Device Decommissioning ............................ 2236
62.5.2 Xenta Objects and Device Configuration Parameters ............. 2236
62.6 Commissioning a Xenta Device ............................................... 2237
62.7 Xenta LonWorks Daylight Savings Time Switchover ................. 2238
62.8 Xenta LonWorks Time Synchronization ................................... 2239
62.9 Identifying a Xenta I/O Module ................................................. 2240
62.10 Checking the Neuron ID of a Xenta I/O Device ......................... 2241
62.11 Xenta LonWorks Device Decommissioning .............................. 2242
62.12 Decommissioning a Xenta Device ............................................ 2243
62.13 Replacing an Online Xenta Device ........................................... 2244
62.14 Downloading the Xenta Device Configuration .......................... 2246
62.15 Uploading the Xenta Device Configuration ............................... 2247
62.16 Replacing an Offline Xenta Device ........................................... 2248
62.17 Replacing a Xenta I/O Module ................................................. 2250
62.18 Xenta LonWorks Groups ......................................................... 2252
62.18.1 XentaGroups and Group Indications ...................................... 2252
62.18.2 Xenta Group Master .............................................................. 2252
Technical 04-16006-04-en, March 2015
50
62.19 Xenta LonWorks Device Functions .......................................... 2253
62.19.1 Trend Logs for Xenta LonWorks Devices ............................... 2253
62.19.2 Alarms for Xenta LonWorks Devices ...................................... 2253
62.19.3 Schedules for Xenta LonWorks Devices ................................ 2253
62.19.4 Time Functions for Xenta LonWorks Devices ......................... 2253
62.19.5 Xenta LonWorks Variables Display ........................................ 2253
62.20 Trend Logs for Xenta LonWorks Devices ................................. 2255
62.21 Configuring a Xenta Trend Log ................................................ 2256
62.22 Alarms for Xenta LonWorks Devices ........................................ 2257
62.22.1 Xenta LonWorks System Alarms ........................................... 2257
62.22.2 Xenta LonWorks Offline Alarms ............................................. 2257
62.23 Schedules for Xenta LonWorks Devices .................................. 2258
62.23.1 Number of Scheduled Events for Xenta LonWorks Devices ... 2258
62.23.2 All-day Events for Xenta LonWorks Devices ........................... 2259
62.23.3 Exception Events for Xenta LonWorks Devices ...................... 2259
62.23.4 Weekly Events for Xenta LonWorks Devices .......................... 2259
62.23.5 Overnight Events for Xenta LonWorks Devices ...................... 2259
62.23.6 Xenta Central Schedules ....................................................... 2259
62.24 Time Functions for Xenta LonWorks Devices ........................... 2260
62.24.1 Xenta LonWorks Time Synchronization ................................. 2260
62.24.2 Xenta LonWorks Daylight Savings Time Switchover ............... 2260
62.25 Xenta LonWorks Variables Display .......................................... 2261
62.25.1 Device: Online ....................................................................... 2262
62.25.2 Device: Offline ....................................................................... 2263
62.26 Xenta LonWorks Device Restart .............................................. 2266
63 Xenta LonWorks Applications ................................... 2267
63.1 Xenta LonWorks Applications ................................................. 2269
63.1.1 Building Operation Menta Editor ............................................ 2269
63.1.2 Xenta LonWorks Application Alarms ...................................... 2269
63.1.3 Synchronization of the Xenta LonWorks Device ..................... 2269
63.2 Building Operation Menta Editor .............................................. 2270
63.3 Editing a Menta Application ..................................................... 2271
63.4 Importing a Menta Application to a Xenta Device ..................... 2272
64 Xenta LonWorks Objects ......................................... 2275
64.1 Xenta Objects and Device Configuration Parameters ............... 2277
64.1.1 Xenta Object Parts ................................................................ 2278
64.1.2 Device Configuration Parameters .......................................... 2278
64.1.3 Xenta LonWorks Database Mode .......................................... 2279
64.2 Xenta Object Parts .................................................................. 2280
64.3 Device Configuration Parameters ............................................ 2281
64.4 Synchronization of the Xenta LonWorks Device ...................... 2282
64.4.1 Synchronization of the Application and the Device Configuration
Parameters ........................................................................... 2282
64.4.2 Synchronization of the Network Information .......................... 2284
65 Xenta LonWorks Alarms ........................................... 2287
04-16006-04-en, March 2015 Technical
51
65.1 Xenta LonWorks Application Alarms ........................................ 2289
65.1.1 Alarm Priority Conversion ...................................................... 2289
65.1.2 Alarm Texts in Menta Editor ................................................... 2289
65.1.3 Alarm Application Considerations .......................................... 2290
65.1.4 Xenta OP Acknowledge ........................................................ 2290
65.2 Modifying a Menta Application Alarm Priority ........................... 2291
65.3 Xenta LonWorks System Alarms ............................................. 2292
65.4 Xenta LonWorks Offline Alarms ............................................... 2293
65.4.1 Independent Offline Detection ............................................... 2293
65.4.2 Group Master Guided Offline Detection ................................. 2293
65.5 Modifying the Xenta Offline Detection Parameters .................... 2294
66 Xenta LonWorks Schedules ..................................... 2295
66.1 Number of Scheduled Events for Xenta LonWorks Devices ..... 2297
66.2 All-Day Events for Xenta LonWorks Devices ............................ 2298
66.3 Weekly Events for Xenta LonWorks Devices ............................ 2299
66.4 Exception Events for Xenta LonWorks Devices ........................ 2300
66.5 Creating a Schedule for a Xenta LonWorks Device .................. 2301
66.6 Editing a Schedule for a Xenta LonWorks Device ..................... 2302
66.7 Xenta Central Schedules ......................................................... 2303
66.7.1 Xenta Central Schedule Synchronization ............................... 2305
66.7.2 Xenta Central Schedule Group Editing ................................... 2305
66.8 Creating a Xenta Central Schedule .......................................... 2306
66.9 Adding a Weekly Event to a Xenta Schedule ............................ 2307
66.10 Adding an Exception Event to a Xenta Schedule ...................... 2310
66.11 Editing a Weekly Event in a Xenta Schedule ............................. 2313
66.12 Editing an Exception Event in a Xenta Schedule ....................... 2316
66.13 Deleting a Weekly Event from a Xenta Schedule ...................... 2319
66.14 Deleting an Exception Event from a Xenta Schedule ................ 2320
66.15 Assigning a Xenta Central Schedule ........................................ 2322
66.16 Unassigning a Xenta Central Schedule .................................... 2323
66.17 Assigning a Lead Xenta Central Schedule ................................ 2324
66.18 Unassigning a Lead Xenta Central Schedule ............................ 2325
66.19 Viewing a Xenta Central Schedule Reference ........................... 2326
66.20 Viewing a Lead Xenta Central Schedule Reference .................. 2327
67 Xenta LonWorks Device User Interface ..................... 2329
67.1 Xenta Icons ............................................................................. 2331
67.2 Actions Menu – Advanced Commands Submenu ................... 2333
67.3 LonWorks Network Properties – Advanced Tab ...................... 2334
67.4 ProgrammableXenta Properties – Xenta Tab ........................... 2336
67.5 Menta Program Properties – Basic Tab ................................... 2338
67.6 Menta Program Properties – Public Signals Tab ...................... 2339
67.7 Menta Program Properties – Inputs Tab .................................. 2340
67.8 Menta Program Properties – Outputs Tab ............................... 2341
67.9 Xenta I/O Module Properties – Basic Tab ................................ 2342
67.10 Xenta I/O Module Properties – Advanced Tab ......................... 2343
Technical 04-16006-04-en, March 2015
52
67.11 Xenta Trend Log Properties ..................................................... 2344
67.12 Xenta Schedule Editor ............................................................. 2346
67.13 Xenta Schedule Dialog Box .................................................... 2348
67.14 Xenta Alarm Properties - Basic Tab ......................................... 2349
67.15 Xenta Alarm Properties - Advanced Tab .................................. 2350
68 MNL LonWorks Introduction .................................... 2353
68.1 MNL LonWorks Device Overview ............................................ 2355
68.1.1 MNL LonWorks Devices ........................................................ 2355
68.1.2 MNL LonWorks Engineering .................................................. 2355
68.1.3 MNL LonWorks Device Functions ......................................... 2355
68.2 MNL LonWorks Engineering .................................................... 2356
68.2.1 LonWorks Interfaces ............................................................. 2356
68.2.2 Standard MNL LonWorks Device Workflow ........................... 2356
68.2.3 MNL-800 LonWorks Device Workflow ................................... 2356
68.2.4 Older MNL LonWorks Device Workflow ................................. 2356
68.2.5 Commission MNL-800 LonWorks Devices ............................ 2356
68.2.6 MNL LonWorks Applications ................................................. 2357
68.2.7 Synchronize MNL LonWorks Devices after Server Restore .... 2357
68.2.8 Bindings for MNL LonWorks Devices .................................... 2357
68.3 LonWorks Interfaces ............................................................... 2358
68.3.1 LonWorks in the Automation Server ...................................... 2359
68.3.2 LonWorks in the Enterprise Server ........................................ 2359
68.3.3 Externally Managed LonWorks Network ................................ 2359
68.4 Standard MNL LonWorks Device Workflow ............................. 2360
68.4.1 Create and then Discover ...................................................... 2360
68.4.2 Discover ............................................................................... 2361
68.4.3 Create .................................................................................. 2363
68.5 MNL-800 LonWorks Device Workflow ..................................... 2365
68.5.1 Create and then Discover ...................................................... 2365
68.5.2 Discover ............................................................................... 2366
68.5.3 Create .................................................................................. 2368
68.6 Bindings for MNL LonWorks Devices ...................................... 2370
68.6.1 Bindings Overview ................................................................ 2370
68.6.2 LonWorks Bindings ............................................................... 2370
68.7 Synchronize MNL LonWorks Devices after Server Restore ...... 2371
69 MNL LonWorks Devices ........................................... 2373
69.1 MNL LonWorks Devices .......................................................... 2375
69.1.1 Device Templates ................................................................. 2375
69.1.2 MNL Device Model and Firmware Revision ............................ 2376
69.2 Creating an MNL-800 LonWorks Device ................................. 2377
69.3 Discovering an MNL-800 LonWorks Device ............................. 2378
69.4 Resetting an MNL LonWorks Device ....................................... 2380
69.5 Downloading Configuration Properties to an MNL LonWorks
Device .................................................................................... 2381
69.6 Commission MNL-800 LonWorks Devices .............................. 2382
69.7 Commissioning an MNL-800 LonWorks Device ....................... 2383
04-16006-04-en, March 2015 Technical
53
69.8 MNL LonWorks Device Functions ........................................... 2384
69.8.1 Alarms for MNL LonWorks Devices ....................................... 2384
69.8.2 Trend Logs for MNL LonWorks Devices ................................ 2384
69.8.3 Schedules for MNL LonWorks Devices .................................. 2385
69.8.4 Properties of MNL LonWorks Objects ................................... 2385
69.9 Schedules for MNL LonWorks Devices .................................... 2386
69.10 Trend Logs for MNL LonWorks Devices .................................. 2387
69.10.1 Trend Logs from NVs ............................................................ 2387
69.10.2 Trend Logs from I/O Points ................................................... 2387
69.11 Alarms for MNL LonWorks Devices ......................................... 2388
70 MNL LonWorks Applications .................................... 2389
70.1 MNL LonWorks Applications ................................................... 2391
70.1.1 Changes to Applications ....................................................... 2392
70.1.2 Application Status ................................................................. 2392
70.1.3 WorkPlace Tech Overview .................................................... 2393
70.1.4 Import and Export of MNL LonWorks Applications ................ 2393
70.2 Changes to Applications ......................................................... 2394
70.3 Application Status ................................................................... 2395
70.4 WorkPlace Tech Overview ...................................................... 2396
70.4.1 WorkPlace Tech Editor .......................................................... 2396
70.4.2 MNL LonWorks Objects ........................................................ 2396
70.4.3 WorkPlace Tech Monitor ....................................................... 2396
70.5 WorkPlace Tech Editor ........................................................... 2397
70.5.1 Hardware Configuration ........................................................ 2397
70.5.2 Applications .......................................................................... 2398
70.5.3 I/O Control Objects and Tags ................................................ 2398
70.5.4 Application Import ................................................................. 2398
70.5.5 Application Compile .............................................................. 2398
70.5.6 Application Export ................................................................. 2398
70.6 Viewing an MNL LonWorks Application Type ........................... 2399
70.7 Creating an MNL LonWorks Application Type .......................... 2401
70.8 Importing a Single MNL LonWorks Application Type ................ 2403
70.9 Importing Multiple MNL LonWorks Application Types .............. 2406
70.10 Editing an MNL LonWorks Application Type ............................ 2408
70.11 Removing an MNL LonWorks Application Type ....................... 2410
70.12 Assigning an MNL LonWorks Application ............................... 2412
70.13 Downloading an MNL LonWorks Application Type .................. 2413
70.14 Editing an MNL LonWorks Application Type in a Device ........... 2414
70.15 WorkPlace Tech Monitor ......................................................... 2415
70.15.1 Monitor Tags ......................................................................... 2416
70.15.2 Write to RAM ........................................................................ 2416
70.16 Monitoring an MNL LonWorks Application ............................... 2417
70.17 Import and Export of MNL LonWorks Solutions ....................... 2418
70.17.1 Exporting an MNL LonWorks Solution ................................... 2418
70.17.2 Importing an MNL LonWorks Solution ................................... 2418
Technical 04-16006-04-en, March 2015
54
71 MNL LonWorks Objects ........................................... 2419
71.1 MNL LonWorks Objects .......................................................... 2421
71.1.1 I/O Points .............................................................................. 2421
71.1.2 S-Link Sensors ..................................................................... 2421
71.2 I/O Points ................................................................................ 2422
71.3 S-Link Sensors ....................................................................... 2426
71.4 Calibrating S-Link Sensors ...................................................... 2429
71.5 Backing Up S-Link Sensor Offsets .......................................... 2430
71.6 Restoring S-Link Sensor Offsets .............................................. 2431
71.7 Properties of MNL LonWorks Objects ..................................... 2432
71.7.1 NCI Values ............................................................................ 2432
71.7.2 Forceable I/O Point Properties .............................................. 2432
71.7.3 Not Active (NA) Property Values ............................................ 2432
71.7.4 Not Active (NA) SNVT Values For MNL LonWorks Devices ..... 2432
71.7.5 Point Object Name ................................................................ 2432
71.7.6 Flow Balance Calibration Information ..................................... 2433
71.7.7 Enumerations for FanModes ................................................. 2433
71.7.8 Enumerations for HvacModes ............................................... 2433
71.8 NCI Values .............................................................................. 2434
71.9 Reverting to the Application Value for NCI Downloads ............. 2435
71.10 Forceable MNL I/O Point Properties ........................................ 2436
71.10.1 Forceable MNL I/O Points ..................................................... 2436
71.10.2 Forced and Unforced Value Properties .................................. 2436
71.10.3 Displayed Value of Forced MNL I/O Point .............................. 2437
71.10.4 Pocket I/A Software and Overrides ........................................ 2437
71.11 Displayed Value of Forced MNL I/O Point ................................ 2439
71.11.1 Display of Forced MNL Input Object Value ............................. 2439
71.11.2 Display of Unforced and Forced MNL Output Object Value .... 2441
71.12 Not Active (NA) Property Values .............................................. 2445
71.13 Not Active (NA) SNVT Values For MNL LonWorks Devices ....... 2446
71.14 Point Object Name .................................................................. 2453
71.15 Flow Balance Calibration Information ....................................... 2454
71.15.1 Data Backups and Flow Balance NCIs .................................. 2454
71.15.2 Data Restore ......................................................................... 2454
71.15.3 Flow Balance Data Backups ................................................. 2455
71.15.4 Flow Balance Text Report ..................................................... 2455
71.16 Backing Up Flow Balance Calibration ...................................... 2456
71.17 Restoring Flow Balance Information ........................................ 2457
71.18 Enumerations for FanModes ................................................... 2458
71.19 Enumerations for HvacModes ................................................. 2459
72 MNL LonWorks User Interface ................................. 2461
72.1 Properties of I/O Points, Sensor Object, and S-Link Sensor Points –
Basic Tab ................................................................................ 2465
72.2 Properties of I/O Points, Sensor Object, and S-Link Sensor Points –
Advanced Tab ........................................................................ 2466
72.3 AnalogIn Properties – Basic Tab .............................................. 2467
04-16006-04-en, March 2015 Technical
55
72.4 AnalogInM and AnalogInV Properties – Advanced Tab ............ 2469
72.5 AnalogInR Properties – Advanced Tab .................................... 2471
72.6 AnalogInTC and AnalogInTF Properties – Advanced Tab ......... 2473
72.7 AnalogOut and AnalogOutPri Properties – Basic Tab ............... 2475
72.8 AnalogOut and AnalogOutPri Properties – Advanced Tab ....... 2477
72.9 BinaryIn Properties – Basic Tab ............................................... 2479
72.10 BinaryIn Properties – Advanced Tab ........................................ 2481
72.11 BinaryInPls Properties – Basic Tab .......................................... 2483
72.12 BinaryInPls Properties – Advanced Tab ................................... 2485
72.13 BinaryOut Properties – Basic Tab ............................................ 2487
72.14 BinaryOut Properties – Advanced Tab ..................................... 2488
72.15 DUI Properties – Basic Tab ..................................................... 2489
72.16 DUI Properties – Advanced Tab .............................................. 2491
72.17 EventInd Properties – Basic Tab .............................................. 2493
72.18 EventInd Properties – Advanced Tab ....................................... 2494
72.19 FanSpeed1 Properties – Basic Tab ......................................... 2496
72.20 FanSpeed1 Properties – Advanced Tab .................................. 2497
72.21 FanSpeed2 Properties – Basic Tab ......................................... 2499
72.22 FanSpeed2 and FanSpeed3 Properties – Advanced Tab ......... 2501
72.23 FanSpeed3 Properties – Basic Tab ......................................... 2503
72.24 FloatingAct and FloatingActPri Properties – Basic Tab ............. 2505
72.25 FloatingAct and FloatingActPri Properties – Advanced Tab ...... 2507
72.26 MomenSS Properties – Basic Tab ........................................... 2509
72.27 MomenSS Properties – Advanced Tab .................................... 2511
72.28 PressureTransInH20 and PressureTransPa Properties – Basic
Tab ......................................................................................... 2513
72.29 PressureTransInH20 and PressureTransPa Properties – Advanced
Tab ......................................................................................... 2515
72.30 PWMMin, PWMPriMin, PWMSec, and PWMPriSec Properties –
Basic Tab ................................................................................ 2517
72.31 PWMMin, PWMPriMin, PWMSec, and PWMPriSec Properties –
Advanced Tab ........................................................................ 2519
72.32 VAVActuator Properties – Basic Tab ....................................... 2521
72.33 VAVActuator Properties – Advanced Tab ................................ 2523
72.34 FanMode1 and FanMode2 Properties – Basic Tab .................. 2525
72.35 FanMode1 and FanMode2 Properties – Advanced Tab ........... 2526
72.36 HvacMode1 and HvacMode2 Properties – Basic Tab .............. 2527
72.37 HvacMode1 and HvacMode2 Properties – Advanced Tab ....... 2528
72.38 Setpoint Properties – Basic Tab .............................................. 2529
72.39 Setpoint Properties – Advanced Tab ....................................... 2531
72.40 Display Properties – Basic Tab ................................................ 2533
72.41 Applications View .................................................................... 2535
72.42 Assign Application Wizard - Naming the Object Page .............. 2537
72.43 Sensor Object Properties – Basic Tab ..................................... 2538
72.44 Sensor Object Properties – Advanced Tab .............................. 2540
72.45 MNL Device Application Properties – Basic Tab ...................... 2541
72.46 MNL LonWorks Device Properties – Advanced Tab ................. 2543
Technical 04-16006-04-en, March 2015
56
72.47 Actions Menu – MNL Submenu ............................................... 2545
72.48 MNL LonWorks System Tree Icons ......................................... 2547
73 BACnet Overview ..................................................... 2549
73.1 BACnet Overview .................................................................... 2551
73.1.1 BACnet Interface ................................................................... 2552
73.1.2 BACnet Networks ................................................................. 2552
73.1.3 BACnet Device Management ................................................ 2552
73.1.4 BACnet Objects and Properties ............................................ 2552
73.1.5 BACnet Download and Upload ............................................. 2552
73.1.6 BACnet System Configuration Workflows .............................. 2553
73.2 BACnet Interface .................................................................... 2554
73.2.1 BACnet Communications ...................................................... 2554
73.2.2 BACnet References and System References ......................... 2554
73.2.3 Interface Required Identification Properties ............................ 2555
73.2.4 BACnet Folders in the BACnet Interface ................................ 2555
73.3 Creating a BACnet Interface .................................................... 2556
73.4 BACnet Folders in the BACnet Interface .................................. 2558
73.4.1 BACnet Network Folders ....................................................... 2558
73.4.2 BACnet Device Application Folders ....................................... 2559
73.4.3 Folders within a Folder .......................................................... 2559
73.4.4 Best Practices for Using Folders ............................................ 2559
73.5 Automatically Discovering BACnet Subnetworks ..................... 2560
73.6 BACnet Communications ........................................................ 2561
73.7 BACnet References and System References ........................... 2562
73.8 Interface Required Identification Properties .............................. 2563
73.9 BACnet System Configuration Workflows ................................ 2564
73.9.1 BACnet System Off-site Configuration Workflow ................... 2564
73.9.2 BACnet System On-site Configuration Workflow ................... 2564
73.10 BACnet System Off-site Configuration Workflow ..................... 2565
73.11 BACnet System On-site Configuration Workflow ..................... 2568
74 BACnet Networks .................................................... 2571
74.1 BACnet Networks ................................................................... 2573
74.1.1 IP Network ............................................................................ 2573
74.1.2 MS/TP Network .................................................................... 2573
74.1.3 Remote Network ................................................................... 2573
74.1.4 BACnet Internetwork ............................................................. 2573
74.1.5 Poll Interval ........................................................................... 2573
74.1.6 BACnet Gateway .................................................................. 2574
74.1.7 Summary .............................................................................. 2574
74.2 IP Network .............................................................................. 2576
74.2.1 Multiple BACnet IP Networks ................................................ 2577
74.2.2 Best Practices for Multiple IP Networks and BBMDs ............. 2578
74.3 Creating an Additional BACnet IP Network .............................. 2579
74.4 Configuring a BACnet IP Network ............................................ 2580
74.5 MS/TP Network ...................................................................... 2581
04-16006-04-en, March 2015 Technical
57
74.6 Creating a BACnet MS/TP Network ......................................... 2582
74.7 Configuring a BACnet MS/TP Network .................................... 2584
74.8 Remote Network ..................................................................... 2585
74.9 Creating a BACnet Remote Network ...................................... 2587
74.10 Configuring a BACnet Remote Network ................................. 2589
74.11 BACnet Internetwork ............................................................... 2590
74.12 Best Practices for Multiple IP Networks and BBMDs ............... 2592
74.12.1 Multiple IP Networks ............................................................. 2592
74.12.2 BBMDs and IP Networks ...................................................... 2592
74.13 Diagnosing Polled Variables on a BACnet Network .................. 2594
74.14 Optimizing System Performance Using BACnet Polling
Intervals .................................................................................. 2597
74.15 BACnet Gateway .................................................................... 2598
74.15.1 BACnet Gateway as BACnet Device ..................................... 2598
74.15.2 BACnet Gateway as Router to Virtual BACnet Devices .......... 2599
75 BACnet Device Management ................................... 2601
75.1 BACnet Device Management .................................................. 2603
75.1.1 BACnet Device Discovery ...................................................... 2603
75.1.2 Hosted I/A Series BACnet (MNB) Devices and Properties ...... 2603
75.1.3 BACnet Download and Upload ............................................. 2604
75.1.4 BACnet Time Synchronization ............................................... 2604
75.1.5 Device Cold Start and Warm Start ......................................... 2604
75.1.6 Device Communication and Diagnostics ............................... 2605
75.1.7 BACnet Backup and Restore ................................................ 2605
75.1.8 BBMDs and Foreign Devices ................................................. 2605
75.1.9 Extended Logging for External BACnet Trend Logs Workflow 2605
75.2 BACnet Device Discovery ........................................................ 2606
75.3 Discovering a BACnet Device .................................................. 2607
75.4 Creating a BACnet Device ....................................................... 2608
75.5 Creating an I/A Series (MNB) BACnet Device ........................... 2610
75.6 Associating a BACnet Instance Number with a Device ............ 2611
75.7 BACnet Time Synchronization ................................................. 2612
75.7.1 Local and UTC ...................................................................... 2613
75.7.2 Automatic Time Sync ............................................................ 2613
75.7.3 Manual Time Sync ................................................................. 2613
75.8 Configuring a Server as a Time Sync Master for Local Time ..... 2615
75.9 Configuring a Server as a Time Sync Master for UTC Time ...... 2617
75.10 Configuring a BACnet Device as a Time Sync Master for Local
Time ....................................................................................... 2619
75.11 Editing a Device Recipient ....................................................... 2621
75.12 Manually Triggering the Time Recipients List of a Server .......... 2622
75.13 Manually Synchronizing an IP Network to Local Time .............. 2623
75.14 Manually Synchronizing an IP Network to UTC Time ................ 2624
75.15 Manually Synchronizing an MSTP Network to Local Time ........ 2625
75.16 Manually Synchronizing an MSTP Network to UTC Time ......... 2626
75.17 Manually Synchronizing a Remote Network to Local Time ....... 2627
Technical 04-16006-04-en, March 2015
58
75.18 Manually Synchronizing a Remote Network to UTC Time ......... 2628
75.19 Manually Synchronizing a BACnet Device to Local Time .......... 2629
75.20 Manually Synchronizing a BACnet Device to UTC Time ........... 2630
75.21 Device Communication and Diagnostics ................................. 2631
75.21.1 BACnet Interface ................................................................... 2631
75.21.2 BACnet Device ..................................................................... 2631
75.21.3 COV Subscriptions ............................................................... 2632
75.22 Enabling BACnet Device Communication ................................ 2633
75.23 Disabling BACnet Device Communication ............................... 2634
75.24 Disabling Initiation of BACnet Device Communication .............. 2635
75.25 Enabling BACnet Interface Communication ............................. 2636
75.26 Disabling BACnet Interface Communication ............................ 2637
75.27 Disabling Initiation of BACnet Interface Communication ........... 2638
75.28 Refreshing COV Subscriptions ................................................ 2639
75.29 Extended Logging for External BACnet Trend Logs Workflow .. 2640
75.30 BBMDs and Foreign Devices .................................................. 2642
75.30.1 BBMDs ................................................................................. 2642
75.30.2 Foreign Devices .................................................................... 2642
75.30.3 BBMD Configuration ............................................................. 2643
75.31 Creating a BBMD .................................................................... 2645
75.32 Configuring a BBMD ............................................................. 2646
75.33 Registering a Building Operation Server as a Foreign Device .... 2647
75.34 Teaching a BBMD Configuration to Other BBMDs ................. 2648
75.35 Learning a BBMD Configuration from one BBMD to Another ... 2649
75.36 Device Cold Start and Warm Start ........................................... 2650
75.37 Warm Starting a BACnet Device .............................................. 2651
75.38 Cold Starting a BACnet Device ................................................ 2652
75.39 BACnet Backup and Restore .................................................. 2653
75.39.1 BACnet Backup and Restore Services .................................. 2653
75.39.2 BACnet Backup and Restore Properties ................................ 2654
75.39.3 b3 BACnet Devices ............................................................... 2654
75.40 Backing Up a BACnet Device .................................................. 2655
75.41 Restoring a BACnet Device ..................................................... 2657
76 BACnet Objects and Properties ............................... 2659
76.1 BACnet Objects and Properties .............................................. 2663
76.1.1 Supported BACnet Object Types ......................................... 2663
76.1.2 BACnet Object Properties ..................................................... 2663
76.1.3 BACnet Command Priorities ................................................. 2664
76.1.4 BACnet Device Object Indicator – Executed By ..................... 2664
76.1.5 BACnet String ....................................................................... 2664
76.2 Supported BACnet Object Types ............................................ 2665
76.2.1 Table of Supported Object Types .......................................... 2665
76.2.2 BACnet Notifications ............................................................. 2665
76.2.3 BACnet Alarms ..................................................................... 2665
76.2.4 BACnet Schedules ................................................................ 2665
76.3 Table of Supported Object Types ............................................ 2666
04-16006-04-en, March 2015 Technical
59
76.4 BACnet Object Properties ....................................................... 2667
76.4.1 Required BACnet Identification Properties ............................ 2667
76.4.2 BACnet Reliability Property .................................................... 2667
76.4.3 BACnet Configuration Properties ........................................... 2667
76.4.4 BACnet Command Priorities ................................................. 2667
76.4.5 BACnet Status Flags ............................................................. 2668
76.5 BACnet Reliability Property ...................................................... 2669
76.6 BACnet Device Object Indicator – Executed By ....................... 2670
76.7 BACnet Configuration Properties ............................................ 2671
76.7.1 BACnet Download ................................................................ 2671
76.7.2 BACnet Upload ..................................................................... 2671
76.8 Updating the Object List of a BACnet Device ........................... 2672
76.9 BACnet Status Flags ............................................................... 2673
76.10 Creating a BACnet Point in a Server ........................................ 2675
76.11 Configuring a BACnet Analog Input Point ................................ 2677
76.12 Configuring a BACnet Digital Input Point .................................. 2683
76.13 Configuring a BACnet Multistate Input Point ............................ 2689
76.14 Configuring a BACnet Analog Output Point ............................. 2696
76.15 Configuring a BACnet Digital Output Point ............................... 2703
76.16 Configuring a BACnet Multistate Output Point ......................... 2708
76.17 Creating a BACnet Point (Generic) ........................................... 2712
76.18 Configuring a BACnet Analog Input Point (Generic) .................. 2714
76.19 Configuring a BACnet Digital Input Point (Generic) ................... 2720
76.20 Configuring a BACnet Multistate Input Point (Generic) ............. 2727
76.21 Configuring a BACnet Analog Output Point (Generic) ............... 2734
76.22 Configuring a BACnet Digital Output Point (Generic) ................ 2741
76.23 Configuring a BACnet Multistate Output Point (Generic) ........... 2749
76.24 Creating a BACnet Value ......................................................... 2756
76.25 Configuring a BACnet Analog Value ........................................ 2758
76.26 Configuring a BACnet Digital Value .......................................... 2763
76.27 Configuring a BACnet Multistate Value .................................... 2769
76.28 Creating a BACnet Value (Generic) .......................................... 2777
76.29 Configuring a BACnet Analog Value (Generic) .......................... 2779
76.30 Configuring a BACnet Digital Value (Generic) ........................... 2786
76.31 Configuring a BACnet Multistate Value (Generic) ...................... 2793
76.32 Creating a BACnet Accumulator (Generic) ............................... 2801
76.33 Configuring a BACnet Accumulator (Generic) .......................... 2803
76.34 Creating a BACnet Averaging (Generic) ................................... 2805
76.35 Configuring a BACnet Averaging (Generic) ............................... 2807
76.36 Creating a BACnet Command (Generic) .................................. 2809
76.37 Configuring a BACnet Command (Generic) .............................. 2811
76.38 Creating a BACnet Load Control (Generic) .............................. 2813
76.39 Configuring a BACnet Load Control (Generic) .......................... 2815
76.40 Creating a BACnet Pulse Converter (Generic) .......................... 2818
76.41 Configuring a BACnet Pulse Converter (Generic) ..................... 2820
76.42 Changing a BACnet String ...................................................... 2824
76.43 Creating a BACnet Trend Log ................................................. 2825
Technical 04-16006-04-en, March 2015
60
76.44 Configuring a BACnet Trend Log ............................................. 2827
76.45 Creating a BACnet Trend Log (Generic) ................................... 2831
76.46 Configuring a BACnet Trend Log (Generic) .............................. 2833
76.47 Configuring Extended Logging for a Local BACnet Trend Log . 2837
76.48 Creating a BACnet Loop ......................................................... 2838
76.49 Creating a BACnet Loop (Generic) ........................................... 2840
76.50 Creating a BACnet File (Generic) ............................................. 2842
76.51 Creating a BACnet Program (Generic) ..................................... 2844
77 BACnet Command Priorities .................................... 2847
77.1 BACnet Command Priorities ................................................... 2849
77.1.1 Commandable Properties and Objects .................................. 2850
77.1.2 Active Command Priority ....................................................... 2851
77.1.3 Default Priority Level .............................................................. 2851
77.1.4 Schedule and Loop Priority for Writing Property ..................... 2851
77.1.5 Command Priority Retain Levels for BACnet Objects ............. 2851
77.2 Commandable Properties and Objects .................................... 2852
77.3 Active Command Priority ......................................................... 2853
77.4 Viewing the Command Priority Levels ...................................... 2854
77.5 Default Priority Level ................................................................ 2855
77.6 Configuring the Default Priority Level ....................................... 2856
77.7 Forced Priority Level ................................................................ 2857
77.8 Configuring a Forced Priority Level .......................................... 2858
77.9 Schedule and Loop Priority for Writing Property ....................... 2859
77.10 Command Priority Retain Levels for BACnet Objects ............... 2860
78 BACnet Download and Upload ................................ 2861
78.1 BACnet Download and Upload ............................................... 2863
78.1.1 BACnet Download ................................................................ 2863
78.1.2 BACnet Upload ..................................................................... 2863
78.2 BACnet Download .................................................................. 2864
78.2.1 Download Single Object Properties ....................................... 2864
78.2.2 Download Device Configuration Properties ............................ 2864
78.2.3 Download Device Full Contents ............................................. 2864
78.2.4 Download Network ............................................................... 2865
78.3 Downloading Configuration Properties ................................... 2866
78.4 Downloading the Properties of an Object ................................. 2867
78.5 Downloading the Contents of a BACnet Device ....................... 2868
78.6 Downloading an IP Network .................................................... 2869
78.7 Downloading an MSTP Network .............................................. 2870
78.8 Downloading a Remote Network ............................................. 2871
78.9 BACnet Upload ....................................................................... 2872
78.9.1 Upload Single Object Properties ............................................ 2872
78.9.2 Upload Device Configuration Properties ................................ 2872
78.9.3 Upload Device Full Contents ................................................. 2872
78.10 Uploading Configuration Properties ........................................ 2874
78.11 Uploading the Properties of an Object ..................................... 2875
04-16006-04-en, March 2015 Technical
61
78.12 Uploading the Contents of a BACnet Device ............................ 2876
79 BACnet Notifications and Alarms ............................. 2877
79.1 BACnet Notifications ............................................................... 2879
79.2 Creating a BACnet Notification ................................................ 2880
79.3 Configuring a BACnet Notification ........................................... 2882
79.4 Creating a BACnet Notification (Generic) ................................. 2889
79.5 Configuring a BACnet Notification (Generic) ............................. 2891
79.6 BACnet Alarms ....................................................................... 2898
79.6.1 BACnet Alarm Types and Monitored Variables Table ............. 2898
79.6.2 Intrinsic Alarming ................................................................... 2898
79.6.3 Alarm Status ......................................................................... 2898
79.6.4 Alarm Summary .................................................................... 2898
79.7 BACnet Alarm Types and Monitored Variables Table ............... 2900
79.8 Creating a BACnet Alarm ........................................................ 2902
79.9 Configuring a BACnet Change of State Alarm .......................... 2904
79.10 Configuring a BACnet Change of Value Alarm ......................... 2906
79.11 Configuring a BACnet Floating Limit Alarm .............................. 2909
79.12 Configuring a BACnet Out of Range Alarm .............................. 2912
79.13 Configuring a BACnet Buffer Ready Alarm ............................... 2915
79.14 Creating a BACnet Alarm (Generic) .......................................... 2917
79.15 Configuring a BACnet Change of State Alarm (Generic) ........... 2919
79.16 Configuring a BACnet Change of Value Alarm (Generic) ........... 2921
79.17 Configuring a BACnet Floating Limit Alarm (Generic) ................ 2924
79.18 Configuring a BACnet Out of Range Alarm (Generic) ................ 2927
79.19 Configuring a BACnet Buffer Ready Alarm (Generic) ................ 2930
80 BACnet Schedules and Calendars ........................... 2933
80.1 BACnet Schedules .................................................................. 2935
80.1.1 Schedule Exceptions ............................................................ 2935
80.1.2 Schedule Types .................................................................... 2935
80.1.3 Schedule and Supported Data Type for Binding .................... 2936
80.1.4 Schedule and Loop Priority for Writing Property ..................... 2936
80.2 Schedule and Supported Data Type for Binding ...................... 2937
80.2.1 Supported Data Types for BACnet Schedules ....................... 2937
80.2.2 Binding Examples ................................................................. 2937
80.3 Creating a BACnet Calendar ................................................... 2940
80.4 Creating a BACnet Calendar (Generic) ..................................... 2942
80.5 Configuring a BACnet Calendar ............................................... 2944
80.6 Creating a BACnet Schedule ................................................... 2945
80.7 Creating a BACnet Schedule (Generic) .................................... 2947
80.8 Configuring a BACnet Schedule .............................................. 2949
80.9 Configuring a Time Value Pair for a Schedule ........................... 2952
80.10 Binding an Object Property to a BACnet Schedule .................. 2953
80.11 Modifying a Schedule Using the Text View ............................... 2954
80.12 Modifying a Schedule Using the Graphic View ......................... 2956
81 BACnet Device User Interface .................................. 2957
Technical 04-16006-04-en, March 2015
62
81.1 BACnet System Tree Icons ..................................................... 2965
81.2 Interface Manager for BACnet – Basic Tab .............................. 2967
81.3 BACnet Interface for an Automation Server – Basic Tab .......... 2969
81.4 BACnet Interface for an Automation Server – Advanced Tab ... 2971
81.5 BACnet Interface for an Enterprise Server – Basic Tab ............ 2973
81.6 BACnet Interface for an Enterprise Server – Advanced Tab ..... 2975
81.7 BACnet Interface – Time Synchronization Recipients Tab ........ 2977
81.8 BACnet Time Synchronization Recipient Dialog Box ................ 2979
81.9 BACnet Device Properties – Basic Tab .................................... 2981
81.10 BACnet Device Properties – Advanced Tab ............................. 2982
81.11 BACnet Device – Time Synchronization Recipients Tab ........... 2985
81.12 BACnet Device – Device Address Bindings Tab ...................... 2986
81.13 BACnet Device – Alarm Summary Tab .................................... 2987
81.14 BACnet Device – Enrollment Summary Tab ............................. 2988
81.15 BACnet Device – Event Information Tab .................................. 2989
81.16 BACnet String Properties (Generic) – Basic Tab ...................... 2990
81.17 BACnet String Properties (Generic) – Advanced Tab ............... 2991
81.18 BACnet Gateway Properties – Basic Tab ................................ 2992
81.19 BACnet Diagnostics Properties – Basic Tab ............................ 2993
81.20 BACnet Diagnostics Object Properties – Basic Tab ................. 2994
81.21 Specialized BACnet Device Properties – Basic Tab ................. 2995
81.22 Specialized BACnet Device Properties – Advanced Tab .......... 2996
81.23 Automation Server or Enterprise Server Hardware Folder – Basic
Tab ......................................................................................... 2999
81.24 I/A Series (MNB) BACnet Device Properties – Basic Tab .......... 3000
81.25 I/A Series (MNB) BACnet Device Properties – Advanced Tab .. 3001
81.26 BBMD Properties – Basic Tab ................................................. 3004
81.27 BBMD BDT Entry Properties – Basic Tab ................................ 3005
81.28 BACnet Learn BDT Table Dialog Box ...................................... 3006
81.29 BBMD Foreign Device Table Tab ............................................. 3007
81.30 BACnet IP Network Properties – Basic Tab ............................. 3008
81.31 BACnet MS/TP Network Properties – Basic Tab ..................... 3010
81.32 BACnet Network Properties – Basic Tab ................................. 3012
81.33 Application Folder of a BACnet Interface ................................. 3013
81.34 Application Folder of a BACnet Device .................................... 3014
81.35 Application Folder of an I/A Series (MNB) BACnet Device ........ 3015
81.36 BACnet Unconfigured Devices Folder Properties – Basic Tab .. 3016
81.37 BACnet Unsolicited Alarms – Basic Tab .................................. 3017
81.38 BACnet Analog Input Properties – Basic Tab ........................... 3018
81.39 BACnet Analog Input Properties – Advanced Tab .................... 3020
81.40 BACnet Analog Output Properties – Basic Tab ........................ 3023
81.41 BACnet Analog Output Properties – Advanced Tab ................. 3025
81.42 BACnet Analog Output Properties – Command Tab ................ 3028
81.43 BACnet Analog Value Properties – Basic Tab .......................... 3030
81.44 BACnet Analog Value Properties – Advanced Tab ................... 3032
81.45 BACnet Analog Value Properties – Command Tab .................. 3035
81.46 BACnet Digital Input Properties – Basic Tab ............................ 3037
04-16006-04-en, March 2015 Technical
63
81.47 BACnet Digital Input Properties – Advanced Tab ..................... 3039
81.48 BACnet Digital Output Properties – Basic Tab ......................... 3041
81.49 BACnet Digital Output Properties – Advanced Tab .................. 3043
81.50 BACnet Digital Output Properties – Command Tab ................. 3044
81.51 BACnet Digital Value Properties – Basic Tab ........................... 3046
81.52 BACnet Digital Value Properties – Advanced Tab .................... 3048
81.53 BACnet Digital Value Properties – Command Tab ................... 3050
81.54 BACnet Multistate Input Properties – Basic Tab ...................... 3052
81.55 BACnet Multistate Input Properties – Advanced Tab ............... 3054
81.56 BACnet Multistate Output Properties – Basic Tab .................... 3057
81.57 BACnet Multistate Output Properties – Advanced Tab ............ 3059
81.58 BACnet Multistate Output Properties – Command Tab ............ 3060
81.59 BACnet Multistate Value Properties – Basic Tab ...................... 3062
81.60 BACnet Multistate Value Properties – Advanced Tab ............... 3064
81.61 BACnet Multistate Value Properties – Command Tab .............. 3067
81.62 BACnet Multistate Alarm Properties Dialog Box ....................... 3069
81.63 BACnet Multistate Objects – State Configuration Tab .............. 3070
81.64 BACnet Analog Input Properties (Generic) – Basic Tab ............ 3071
81.65 BACnet Analog Input Properties (Generic) – Advanced Tab ..... 3073
81.66 BACnet Analog Output Properties (Generic) – Basic Tab ......... 3075
81.67 BACnet Analog Output Properties (Generic) – Advanced Tab .. 3077
81.68 BACnet Analog Output Properties (Generic) – Command Tab . 3079
81.69 BACnet Analog Value Properties (Generic) – Basic Tab ........... 3081
81.70 BACnet Analog Value Properties (Generic) – Advanced Tab .... 3083
81.71 BACnet Analog Value Properties (Generic) – Command Tab ... 3086
81.72 BACnet Digital Input Properties (Generic) – Basic Tab ............. 3088
81.73 BACnet Digital Input Properties (Generic) – Advanced Tab ...... 3091
81.74 BACnet Digital Output Properties (Generic) – Basic Tab .......... 3093
81.75 BACnet Digital Output Properties (Generic) – Advanced Tab ... 3096
81.76 BACnet Digital Output Properties (Generic) – Command Tab ... 3098
81.77 BACnet Digital Value Properties (Generic) – Basic Tab ............. 3100
81.78 BACnet Digital Value Properties (Generic) – Advanced Tab ...... 3103
81.79 BACnet Digital Value Properties (Generic) – Command Tab ..... 3105
81.80 BACnet Multistate Input Properties (Generic) – Basic Tab ........ 3107
81.81 BACnet Multistate Input Properties (Generic) – Advanced Tab . 3109
81.82 BACnet Multistate Output Properties (Generic) – Basic Tab ..... 3112
81.83 BACnet Multistate Output Properties (Generic) – Advanced
Tab ......................................................................................... 3114
81.84 BACnet Multistate Output Properties (Generic) – Command
Tab ......................................................................................... 3116
81.85 BACnet Multistate Value Properties (Generic) – Basic Tab ....... 3118
81.86 BACnet Multistate Value Properties (Generic) – Advanced Tab 3120
81.87 BACnet Multistate Value Properties (Generic) – Command
Tab ......................................................................................... 3123
81.88 BACnet Accumulator Properties (Generic) – Basic Tab ............ 3125
81.89 BACnet Accumulator Properties (Generic) – Advanced Tab ..... 3127
81.90 BACnet Averaging Properties (Generic) – Basic Tab ................ 3130
Technical 04-16006-04-en, March 2015
64
81.91 BACnet Averaging Properties (Generic) – Advanced Tab ......... 3132
81.92 BACnet Command Properties (Generic) – Basic Tab ............... 3133
81.93 BACnet Command Properties (Generic) – Advanced Tab ........ 3134
81.94 BACnet Load Control Properties (Generic) – Basic Tab ........... 3135
81.95 BACnet Load Control Properties (Generic) – Advanced Tab .... 3137
81.96 BACnet Pulse Converter Properties (Generic) – Basic Tab ....... 3139
81.97 BACnet Pulse Converter Properties (Generic) – Advanced Tab 3142
81.98 BACnet Notification Properties – Basic Tab ............................. 3145
81.99 BACnet Notification Properties – Advanced Tab ...................... 3146
81.100 BACnet Notification Properties (Generic) – Basic Tab .............. 3147
81.101 BACnet Notification Properties (Generic) – Advanced Tab ....... 3148
81.102 BACnet Notification – Basic Settings Tab ................................ 3149
81.103 BACnet Notification – Presentation Tab ................................... 3150
81.104 BACnet Notification – User Action Tab .................................... 3151
81.105 BACnet Notification – Attachment Tab .................................... 3152
81.106 BACnet Notification – Device Recipient Rules Tab ................... 3153
81.107 BACnet Notification – Device Recipient Rule Dialog Box .......... 3155
81.108 BACnet Alarm Properties – Basic Tab ..................................... 3158
81.109 BACnet Alarm Properties – Advanced Tab .............................. 3161
81.110 BACnet Alarm Properties (Generic) – Basic Tab ....................... 3162
81.111 BACnet Alarm Properties (Generic) – Advanced Tab ............... 3165
81.112 BACnet Buffer Ready Alarm – Alarm Trigger Tab ..................... 3166
81.113 BACnet Change of State Alarm – Alarm Trigger Tab ................ 3168
81.114 BACnet Change of Value Alarm – Alarm Trigger Tab ................ 3170
81.115 BACnet Floating Limit Alarm – Alarm Trigger Tab .................... 3172
81.116 BACnet Out of Range Alarm – Alarm Trigger Tab .................... 3175
81.117 BACnet Calendar Properties – Basic Tab ................................ 3177
81.118 BACnet Calendar Properties – Advanced Tab ......................... 3178
81.119 BACnet Calendar Properties (Generic) – Basic Tab .................. 3179
81.120 BACnet Calendar Properties (Generic) – Advanced Tab .......... 3180
81.121 BACnet Schedule Properties – Basic Tab ................................ 3181
81.122 BACnet Schedule Properties – Advanced Tab ......................... 3184
81.123 BACnet Schedule Properties (Generic) – Basic Tab ................. 3185
81.124 BACnet Schedule Properties (Generic) – Advanced Tab .......... 3188
81.125 Add Reference Dialog Box ...................................................... 3189
81.126 BACnet Prerevision 4 Schedule Properties – Basic Tab ........... 3190
81.127 BACnet Prerevision 4 Schedule Properties – Advanced Tab .... 3191
81.128 BACnet Prerevision 4 Schedule Properties – Configuration
Tab ......................................................................................... 3192
81.129 BACnet Prerevision 4 Schedule Properties - Weekly Schedule 3194
81.130 BACnet Prerevision 4 Schedule Properties - Active Inactive Time
Value Pair ................................................................................ 3195
81.131 BACnet Prerevision 4 Schedule Properties - Boolean Time Value
Pair ......................................................................................... 3196
81.132 BACnet Prerevision 4 Schedule Properties - Enumerated Time Value
Pair ......................................................................................... 3197
81.133 BACnet Prerevision 4 Schedule Properties - Integer Time Value
Pair ......................................................................................... 3198
04-16006-04-en, March 2015 Technical
65
81.134 BACnet Prerevision 4 Schedule Properties - On Off Time Value
Pair ......................................................................................... 3199
81.135 BACnet Prerevision 4 Schedule Properties - Real Time Value
Pair ......................................................................................... 3200
81.136 BACnet Prerevision 4 Schedule Properties - Unsigned Time Value
Pair ......................................................................................... 3201
81.137 BACnet Prerevision 4 Schedule Properties - Exception Event .. 3202
81.138 BACnet Exception Event Wizard – Naming the Object Page .... 3203
81.139 BACnet Trend Log Properties – Basic Tab .............................. 3204
81.140 BACnet Trend Log Properties – Advanced Tab ....................... 3207
81.141 BACnet Trend Log Properties (Generic) – Basic Tab ................ 3209
81.142 BACnet Trend Log Properties (Generic) – Advanced Tab ......... 3213
81.143 BACnet File Object – Basic Tab ............................................... 3216
81.144 BACnet File Object – Advanced Tab ....................................... 3218
81.145 BACnet File Properties (Generic) – Basic Tab .......................... 3219
81.146 BACnet File Properties (Generic) – Advanced Tab ................... 3221
81.147 BACnet Program Properties (Generic) – Basic Tab .................. 3222
81.148 BACnet Program Properties (Generic) – Advanced Tab ........... 3225
81.149 BACnet Loop Properties – Basic Tab ...................................... 3226
81.150 BACnet Loop Properties – Advanced Tab ............................... 3229
81.151 BACnet Loop Properties (Generic) – Basic Tab ....................... 3231
81.152 BACnet Loop Properties (Generic) – Advanced Tab ................ 3234
81.153 Unresolved Device Properties – Basic Tab .............................. 3236
81.154 Unresolved Device Properties – Advanced Tab ....................... 3237
81.155 Unsupported Object Properties – Basic Tab ............................ 3238
81.156 Unsupported Object Properties – Advanced Tab ..................... 3239
81.157 Actions Menu – Device Communication Control Submenu ...... 3240
81.158 Actions Menu – Device Submenu – Restart Submenu ............. 3241
81.159 Actions Menu – Device Submenu – Time Sync Submenu ........ 3242
81.160 Actions Menu – Device Submenu – Communication Submenu
............................................................................................... 3243
81.161 BACnet Associate with Device Dialog Box ............................... 3244
81.162 BACnet Device Communication Dialog Box ............................. 3245
81.163 BACnet Password Dialog Box ................................................. 3246
81.164 Create Object Wizard – BACnet Basic Settings Page .............. 3247
81.165 Create Object Wizard – IP Network Basic Settings Page ......... 3248
81.166 Create Object Wizard – BACnet Network BACnet Basic Settings
Page ....................................................................................... 3249
81.167 BACnet Create Object Wizard – BACnet Basic Settings Page . 3250
81.168 BACnet Create Object (Generic) Wizard – BACnet Basic Settings
Page ....................................................................................... 3251
81.169 BACnet Create Device Wizard – BACnet Basic Settings Page . 3252
82 b3 BACnet Device Introduction ................................ 3253
82.1 b3 BACnet Device Overview ................................................... 3255
82.1.1 b3 BACnet Device Controllers and Networks ........................ 3255
82.1.2 b3 BACnet Device Communication ....................................... 3255
82.1.3 b3 BACnet Device Models and Program Memory .................. 3255
Technical 04-16006-04-en, March 2015
66
82.2 b3 BACnet Device Controllers and Networks .......................... 3256
82.2.1 b3 BACnet Device Controllers .............................................. 3256
82.2.2 b3 BACnet Device Networks ................................................. 3256
82.3 b3 BACnet Device Controllers ................................................. 3257
82.4 b3 BACnet Device Networks ................................................... 3258
82.5 Creating a BACnet Interface .................................................... 3261
83 b3 BACnet Device Communication and
Configuration ........................................................... 3263
83.1 b3 BACnet Device Communication ......................................... 3267
83.1.1 Communication Between the AS and b3 BACnet Device ....... 3267
83.1.2 b3 BACnet Device Workflows ............................................... 3267
83.1.3 Programming Language for b3 BACnet Devices .................... 3267
83.1.4 b3 BACnet Device Merge Copied Device Content ................. 3267
83.1.5 b3 BACnet Device Point and Value Configuration .................. 3268
83.1.6 Schedules for b3 BACnet Devices ......................................... 3268
83.1.7 Trend Logs for b3 BACnet Devices ....................................... 3268
83.1.8 Extended Trend Logs for b3 Point and Value Device Logs ..... 3268
83.1.9 Alarms for b3 BACnet Devices .............................................. 3268
83.2 Communication Between the AS and b3 BACnet Device ......... 3270
83.3 Creating a BACnet MS/TP Network ......................................... 3272
83.4 Configuring the MS/TP Network for b3 Communication ........... 3274
83.5 b3 BACnet Device Workflows ................................................. 3275
83.5.1 Learn b3 BACnet Device Workflow ........................................ 3275
83.5.2 Create b3 BACnet Devices with Factory Settings Workflow ... 3275
83.5.3 Create Previously-Used b3 BACnet Devices Workflow .......... 3275
83.6 Learn b3 BACnet Device Workflow .......................................... 3276
83.7 Create b3 BACnet Devices with Factory Settings Workflow ..... 3278
83.8 Create Previously Used b3 BACnet Devices Workflow ............. 3281
83.9 Programming Language for b3 BACnet Devices ...................... 3284
83.10 Configuring Script FallThru Program Triggers in a b3 BACnet
Device .................................................................................... 3285
83.11 Creating a b3 Script Program .................................................. 3289
83.12 Creating a b3 Script Function .................................................. 3291
83.13 Creating b3 Script Program Bindings ...................................... 3292
83.14 Downloading a b3 Script Program ........................................... 3295
83.15 b3 BACnet Device Merge Copied Device Content ................... 3297
83.16 Merging Copied Device Content in a b3 BACnet Device .......... 3298
83.17 b3 BACnet Device Point and Value Configuration .................... 3300
83.17.1 Analog Point Configuration .................................................... 3300
83.17.2 Multistate Point Configuration ................................................ 3300
83.17.3 Digital Point Configuration ..................................................... 3300
83.17.4 Value Object Configuration .................................................... 3301
83.18 Creating a b3 BACnet Device Analog Input Point ..................... 3302
83.19 Configuring a b3 BACnet Device Analog Input Point ................ 3305
83.20 Configuring the COV Increment and the Unit for a b3 BACnet Device
Analog Input Point ................................................................... 3309
04-16006-04-en, March 2015 Technical
67
83.21 Creating a b3 BACnet Device Analog Output Point .................. 3312
83.22 Configuring a b3 BACnet Device Analog Output Point ............. 3315
83.23 Configuring the COV Increment and the Unit for a b3 BACnet Device
Analog Output Point ................................................................ 3320
83.24 Configuring the Electrical Scale and the Engineering Scale for a b3
BACnet Device Analog Output Point ....................................... 3323
83.25 Creating a b3 BACnet Device Multistate Input Point ................. 3326
83.26 Configuring a b3 BACnet Device Multistate Input Point ............ 3329
83.27 Creating a b3 BACnet Device Multistate Output Point .............. 3333
83.28 Configuring a b3 BACnet Device Multistate Output Point ......... 3336
83.29 Creating a b3 BACnet Device Multistate Pulsed Output Point .. 3340
83.30 Configuring a b3 BACnet Device Multistate Pulsed Output
Point ....................................................................................... 3343
83.31 Creating a b3 BACnet Device Digital Input Point ...................... 3347
83.32 Configuring a b3 BACnet Device Digital Input Point ................. 3350
83.33 Creating a b3 BACnet Device Digital Output Point ................... 3354
83.34 Configuring a b3 BACnet Device Digital Output Point .............. 3357
83.35 Creating a b3 BACnet Device Digital Pulsed Output Point ........ 3362
83.36 Configuring a b3 BACnet Device Digital Pulsed Output Point ... 3365
83.37 Creating a b3 BACnet Device Analog Value ............................. 3370
83.38 Configuring a b3 BACnet Device Analog Value ........................ 3372
83.39 Configuring the COV Increment and the Unit for a b3 BACnet Device
Analog Value ........................................................................... 3376
83.40 Creating a b3 BACnet Device Digital Value .............................. 3379
83.41 Configuring a b3 BACnet Device Digital Value .......................... 3381
83.42 Creating a b3 BACnet Device DateTime Value ......................... 3386
83.43 Configuring a b3 BACnet Device DateTime Value .................... 3388
83.44 Creating a b3 BACnet Device String Value ............................... 3390
83.45 Configuring a b3 BACnet Device String Value .......................... 3392
83.46 Creating a b3 BACnet Device Multistate Value ......................... 3394
83.47 Configuring a b3 BACnet Device Multistate Value .................... 3396
83.48 Renaming b3 BACnet Device Points or Values ........................ 3400
83.49 Learning b3 BACnet Devices ................................................... 3402
83.50 Viewing Attributes and Objects Associated with the b3 BACnet
Device .................................................................................... 3403
83.51 Downloading to a b3 BACnet Device ....................................... 3404
83.52 Commissioning a b3 BACnet Device ....................................... 3405
83.53 Resetting a b3 BACnet Device ................................................ 3406
83.54 Schedules for b3 BACnet Devices ........................................... 3407
83.55 Trend Logs for b3 BACnet Devices ......................................... 3408
83.56 Extended Trend Logs for b3 Point and Value Device Logs ....... 3409
83.57 Creating Extended Trend Logs to Monitor a b3 Point or Value
Device Log .............................................................................. 3411
83.58 Alarms for b3 BACnet Devices ................................................ 3414
83.59 Creating a b3 BACnet Device Alarm ........................................ 3415
83.60 Creating a b3 BACnet Device Notification ................................ 3417
83.61 Configuring b3 BACnet Devices after an Import ....................... 3419
Technical 04-16006-04-en, March 2015
68
84 b3 BACnet Device Models and Memory ................... 3425
84.1 b3 BACnet Device Models and Program Memory .................... 3427
84.1.1 b3 BACnet Device Models .................................................... 3427
84.1.2 b3 BACnet Device Program Memory ..................................... 3427
84.1.3 b3 BACnet Device Restart Modes ......................................... 3427
84.1.4 b3 BACnet Device Supported Object Types .......................... 3427
84.1.5 b3 BACnet Device Device Logs ............................................. 3427
84.1.6 b3 BACnet Device Object Names .......................................... 3428
84.2 b3 BACnet Device Models ...................................................... 3429
84.3 b3 BACnet Device Memory ..................................................... 3431
84.3.1 Application Memory .............................................................. 3431
84.3.2 Back Up Objects to Flash Memory ........................................ 3431
84.3.3 Flash Memory Limitations ...................................................... 3432
84.4 b3 BACnet Device Restart Modes ........................................... 3433
84.5 b3 BACnet Device Supported Object Types ............................ 3434
84.6 b3 BACnet Device Logs .......................................................... 3436
84.7 b3 BACnet Device Object Names ............................................ 3437
84.8 Setting Up and Viewing b3 BACnet Device Logs ..................... 3438
84.9 Creating a b3 BACnet Device .................................................. 3440
84.10 Removing a b3 BACnet Device from the Software
Environment ........................................................................... 3443
84.11 Replacing a b3 BACnet Device ................................................ 3444
84.12 Deleting Objects from a b3 BACnet Device and Automation
Server ..................................................................................... 3445
84.13 Connecting Expansion Modules and Configuring the LCD
Display .................................................................................... 3446
84.14 Backing Up a b3 BACnet Device to Flash Memory .................. 3448
84.15 Selecting a Restart Mode ........................................................ 3450
84.16 Updating Firmware in a b3 BACnet Device .............................. 3451
85 b3 BACnet Device User Interface ............................. 3453
85.1 b3 BACnet Device System Tree Icons ..................................... 3457
85.2 Actions Menu – Device Submenu ............................................ 3458
85.3 b3 BACnet Device Properties – Basic Tab ............................... 3461
85.4 b3 BACnet Device Properties – Advanced Tab ........................ 3463
85.5 Update b3 Controller Firmware Dialog Box .............................. 3466
85.6 New MS/TP Network Wizard – MS/TP Network Basic Settings
Page ....................................................................................... 3467
85.7 New b3 BACnet Device Creation Wizard – Basic Settings
Page ....................................................................................... 3468
85.8 New b3 BACnet Device Object Creation Wizard – Basic Settings
Page ....................................................................................... 3470
85.9 New BACnet Analog Input Point (Continuum) Creation Wizard –
Continuum Basic Settings Page .............................................. 3471
85.10 New BACnet Analog Output Point (Continuum) Creation Wizard –
Continuum Basic Settings Page .............................................. 3472
85.11 New b3 BACnet Device Object Creation Wizard – Continuum Basic
Settings Page ......................................................................... 3473
85.12 b3 BACnet Device Analog Input Properties – Basic Tab .......... 3474
04-16006-04-en, March 2015 Technical
69
85.13 b3 BACnet Device Analog Input Properties – Advanced Tab ... 3476
85.14 b3 BACnet Device Analog Output Properties – Basic Tab ....... 3478
85.15 b3 BACnet Device Analog Output Properties – Advanced Tab 3481
85.16 b3 BACnet Device Analog Output Properties – Command Tab 3483
85.17 b3 BACnet Device Multistate Input Properties – Basic Tab ...... 3485
85.18 b3 BACnet Device Multistate Input Properties – Advanced
Tab ......................................................................................... 3487
85.19 b3 BACnet Device Multistate Output Properties – Basic Tab ... 3489
85.20 b3 BACnet Device Multistate Output Properties – Advanced
Tab ......................................................................................... 3491
85.21 b3 BACnet Device Multistate Output Properties – Command
Tab ......................................................................................... 3493
85.22 b3 BACnet Device Multistate Pulsed Output Properties – Basic
Tab ......................................................................................... 3495
85.23 b3 BACnet Device Multistate Pulsed Output Properties – Advanced
Tab ......................................................................................... 3497
85.24 b3 BACnet Device Multistate Pulsed Output Properties – Command
Tab ......................................................................................... 3499
85.25 b3 BACnet Device Digital Input Properties – Basic Tab ............ 3501
85.26 b3 BACnet Device Digital Input Properties – Advanced Tab ..... 3504
85.27 b3 BACnet Device Digital Output Properties – Basic Tab ......... 3506
85.28 b3 BACnet Device Digital Output Properties – Advanced Tab .. 3509
85.29 b3 BACnet Device Digital Output Properties – Command Tab . 3511
85.30 b3 BACnet Device Digital Pulsed Output Properties – Basic
Tab ......................................................................................... 3513
85.31 b3 BACnet Device Digital Pulsed Output Properties – Advanced
Tab ......................................................................................... 3516
85.32 b3 BACnet Device Digital Pulsed Output Properties – Command
Tab ......................................................................................... 3518
85.33 b3 BACnet Device Analog Value Properties – Basic Tab .......... 3520
85.34 b3 BACnet Device Analog Value Properties – Advanced Tab ... 3523
85.35 b3 BACnet Device Analog Value Properties – Command Tab .. 3525
85.36 b3 BACnet Device Digital Value Properties – Basic Tab ........... 3527
85.37 b3 BACnet Device Digital Value Properties – Advanced Tab .... 3530
85.38 b3 BACnet Device Digital Value Properties – Command Tab ... 3532
85.39 b3 BACnet Device DateTime Value Properties – Basic Tab ...... 3534
85.40 b3 BACnet Device DateTime Value Properties – Advanced
Tab ......................................................................................... 3536
85.41 b3 BACnet Device String Value Properties – Basic Tab ........... 3538
85.42 b3 BACnet Device String Value Properties – Advanced Tab .... 3540
85.43 b3 BACnet Device Multistate Value Properties – Basic Tab ...... 3542
85.44 b3 BACnet Device Multistate Value Properties – Advanced
Tab ......................................................................................... 3544
85.45 b3 BACnet Device Multistate Value Properties – Command
Tab ......................................................................................... 3546
85.46 b3 Script Program Properties – Basic Tab ............................... 3548
85.47 b3 Script Program Properties – Advanced Tab ........................ 3550
85.48 b3 Script Program Properties – Inputs Tab .............................. 3551
85.49 b3 Script Program Properties – Outputs Tab ........................... 3552
Technical 04-16006-04-en, March 2015
70
85.50 b3 Script Program Properties – Functions Tab ........................ 3553
85.51 b3 Script Function Properties – Basic Tab ............................... 3554
85.52 b3 Script Function Properties – Advanced Tab ........................ 3555
85.53 b3 Script Function Properties – Inputs Tab .............................. 3556
85.54 b3 Script Function Properties – Outputs Tab ........................... 3557
85.55 b3 Script Function Properties – Functions Tab ........................ 3558
86 Modbus Introduction ................................................ 3559
86.1 Modbus Overview ................................................................... 3561
86.1.1 Master/Slave Networks ......................................................... 3561
86.1.2 Client/Server Networks ......................................................... 3561
86.1.3 Modbus Interfaces ................................................................ 3561
86.1.4 Network Configuration .......................................................... 3562
86.1.5 Modbus Devices ................................................................... 3562
86.1.6 Modbus Points and Values .................................................... 3562
86.1.7 Modbus Communications ..................................................... 3562
86.1.8 Modbus Connections to the Building Operation Server .......... 3562
86.1.9 Building Operation Server Capacities for Modbus Networks .. 3563
86.2 Modbus Interface Selection Workflow ..................................... 3564
86.3 Master/Slave Networks ........................................................... 3566
86.3.1 Master/Slave Concept .......................................................... 3566
86.3.2 Master and Slave Networks .................................................. 3566
86.3.3 Modbus Serial Networks ....................................................... 3566
86.4 Master/Slave Concept ............................................................ 3567
86.5 Master and Slave Networks ..................................................... 3569
86.6 Client/Server Networks ........................................................... 3571
86.6.1 Client/Server Concept ........................................................... 3571
86.6.2 Client and Server Networks ................................................... 3571
86.6.3 Modbus TCP Networks ......................................................... 3571
86.7 Client/Server Concept ............................................................. 3572
86.8 Client and Server Networks ..................................................... 3573
86.9 Modbus Communications ....................................................... 3575
86.9.1 Modbus Addressing .............................................................. 3576
86.9.2 Function Code Definition and Selection ................................. 3577
86.9.3 Modbus Batch Read Function ............................................... 3577
86.9.4 Device and Register Polling ................................................... 3577
86.9.5 Modbus Message Formats ................................................... 3577
86.9.6 Serial Transmission Modes .................................................... 3578
86.9.7 Error Handling ....................................................................... 3578
86.9.8 Generic RS-485 Network Devices ......................................... 3578
86.10 Modbus Addressing ................................................................ 3579
86.10.1 Modbus Device Addressing .................................................. 3579
86.10.2 Modbus Register Addressing ................................................ 3579
86.11 Function Code Definition and Selection ................................... 3580
86.11.1 Read Function Code Selection .............................................. 3580
86.11.2 Write Function Code Selection .............................................. 3581
86.12 Error Handling ......................................................................... 3582
04-16006-04-en, March 2015 Technical
71
86.12.1 RTU Mode CRC Checking .................................................... 3582
86.12.2 ASCII Mode LRC Checking ................................................... 3582
86.12.3 Device and Network Read and Write Errors ........................... 3583
86.12.4 Point Error Count .................................................................. 3583
86.13 Modbus Connections to the Building Operation Server ............ 3584
86.13.1 Automation Server Connection Options ................................. 3584
86.13.2 Enterprise Server Connection Options ................................... 3584
87 Modbus Serial Networks .......................................... 3587
87.1 Modbus Serial Networks ......................................................... 3589
87.1.1 Modbus Master Network ....................................................... 3590
87.1.2 Modbus Slave Network ......................................................... 3591
87.2 Modbus Master Network Workflow ......................................... 3593
87.3 Modbus Slave Network Workflow ............................................ 3595
87.4 Creating an RS-232 Port ......................................................... 3597
87.5 Configuring a Serial Port .......................................................... 3598
87.6 Port Allocation and Configuration ............................................ 3600
87.7 Creating a Modbus Slave Network .......................................... 3602
87.8 Configuring a Modbus Slave Network ...................................... 3603
87.9 Creating a Modbus Master Network ........................................ 3605
87.10 Configuring a Modbus Master Network ................................... 3606
88 Modbus TCP Networks ............................................ 3611
88.1 Modbus TCP Networks ........................................................... 3613
88.1.1 Modbus TCP Network .......................................................... 3614
88.1.2 Modbus TCP Server .............................................................. 3615
88.1.3 Modbus TCP Gateway .......................................................... 3616
88.2 Modbus TCP Network Workflow ............................................. 3618
88.3 Modbus TCP Gateway Workflow ............................................ 3620
88.4 Modbus TCP Server Workflow ................................................ 3622
88.5 Creating a Modbus TCP Network ............................................ 3623
88.6 Configuring a Modbus TCP Network ....................................... 3624
88.7 Creating a Modbus TCP Gateway ........................................... 3626
88.8 Configuring a Modbus TCP Gateway ...................................... 3627
88.9 Creating a Modbus TCP Server ............................................... 3629
88.10 Configuring a Modbus TCP Server .......................................... 3630
89 Network Configuration ............................................. 3631
89.1 Network Configuration ............................................................ 3633
89.1.1 Framing Mode ...................................................................... 3633
89.1.2 Baud Rate Selection ............................................................. 3633
89.1.3 Port Reference ...................................................................... 3634
89.1.4 Parity Checking ..................................................................... 3634
89.1.5 Stop Bits ............................................................................... 3634
89.1.6 J-Bus Mode Selection ........................................................... 3634
89.1.7 Silence Characters ................................................................ 3634
89.1.8 Receive Timeout ................................................................... 3635
89.1.9 Point Poll Delay ..................................................................... 3635
Technical 04-16006-04-en, March 2015
72
89.1.10 Poll Duty Cycle ...................................................................... 3635
89.1.11 Transmit Guard Bits .............................................................. 3636
90 Modbus Interfaces ................................................... 3637
90.1 Modbus Interfaces .................................................................. 3639
90.1.1 Modbus Interface to Building Operation Server ...................... 3639
90.1.2 Modbus Interface .................................................................. 3639
90.2 Modbus Interface .................................................................... 3640
90.2.1 General Interface Configuration ............................................ 3640
90.2.2 Configuration with HMI Device as Master .............................. 3641
90.3 Creating a Modbus Interface ................................................... 3642
90.4 Configuring a Modbus Interface .............................................. 3643
91 Modbus Devices ...................................................... 3645
91.1 Modbus Devices ..................................................................... 3647
91.1.1 Discrete Output Coils ............................................................ 3648
91.1.2 Discrete Input Status ............................................................. 3648
91.1.3 Input Registers ...................................................................... 3648
91.1.4 Holding Registers .................................................................. 3648
91.1.5 Device Identification .............................................................. 3648
91.1.6 Device Communications Configuration .................................. 3649
91.2 Creating a Modbus TCP Device .............................................. 3650
91.3 Configuring a Modbus TCP Device .......................................... 3651
91.4 Creating a Modbus Device ...................................................... 3654
91.5 Configuring a Modbus Device ................................................. 3655
91.6 Creating Multiple Modbus Devices .......................................... 3657
91.7 Refreshing Modbus Device Identification ................................. 3659
92 Modbus Points and Values ....................................... 3661
92.1 Point and Value Types ............................................................ 3663
92.1.1 Point Types ........................................................................... 3663
92.1.2 Value Types .......................................................................... 3663
92.2 Modbus Points and Values ...................................................... 3664
92.2.1 Point Types ........................................................................... 3664
92.2.2 Value Types .......................................................................... 3664
92.2.3 Point and Value Configuration ............................................... 3665
92.3 Creating a Modbus Point ......................................................... 3666
92.4 Point and Value Configuration ................................................. 3667
92.4.1 Register Number ................................................................... 3667
92.4.2 Register Type ........................................................................ 3667
92.4.3 Read Function Code ............................................................. 3669
92.4.4 Write Function Code ............................................................. 3669
92.4.5 Bitmask ................................................................................ 3669
92.4.6 Gain and Offset .................................................................... 3672
92.5 Configuring a Modbus Point .................................................... 3673
92.6 Creating a Modbus Value ........................................................ 3677
92.7 Configuring a Modbus Value ................................................... 3678
92.8 Creating Multiple Modbus Points ............................................. 3679
04-16006-04-en, March 2015 Technical
73
93 Modbus Batch Read Function .................................. 3681
93.1 Modbus Batch Read Function ................................................. 3683
93.1.1 Modbus Register Groups ...................................................... 3684
93.1.2 Grouping Guidelines ............................................................. 3684
93.1.3 Grouping Methods ................................................................ 3684
93.1.4 Scattered Read ..................................................................... 3685
93.2 Modbus Register Groups ........................................................ 3686
93.3 Grouping Guidelines .............................................................. 3691
93.3.1 Poll Block Operation ............................................................. 3692
93.3.2 Exception Handling .............................................................. 3692
93.3.3 Factorization ......................................................................... 3692
93.3.4 Poll Interval ........................................................................... 3693
93.4 Grouping Methods .................................................................. 3694
93.4.1 Manual Grouping .................................................................. 3695
93.4.2 Semi-Automatic Grouping ..................................................... 3696
93.5 Creating a Modbus Register Group ......................................... 3697
93.6 Configuring a Modbus Register Group .................................... 3698
93.7 Modbus Register Group Properties – Basic Tab ...................... 3699
93.8 Adding Modbus Points to a Modbus Register Group ............... 3701
94 Modbus Device User Interface ................................. 3703
94.1 Modbus Icons ......................................................................... 3705
94.2 Serial Port Properties – Basic Tab ........................................... 3706
94.3 Modbus Master Network Properties – Basic Tab ..................... 3708
94.4 Modbus Master Network Properties – Advanced Tab .............. 3710
94.5 Modbus Device Properties – Basic Tab ................................... 3712
94.6 Modbus Slave Network Properties – Basic Tab ....................... 3714
94.7 Modbus Slave Network Properties – Advanced Tab ................ 3716
94.8 Modbus TCP Network Properties – Basic Tab ......................... 3717
94.9 Modbus TCP Network Properties – Advanced Tab .................. 3719
94.10 Modbus TCP Gateway Properties – Basic Tab ........................ 3721
94.11 Modbus TCP Gateway Properties – Advanced Tab ................. 3723
94.12 Modbus TCP Device Properties – Basic Tab ........................... 3725
94.13 Modbus TCP Server Properties – Basic Tab ............................ 3727
94.14 Modbus Interface Properties – Basic Tab ................................ 3728
94.15 Modbus Analog Value Properties – Basic Tab ......................... 3730
94.16 Modbus Digital Value Properties – Basic Tab ........................... 3732
94.17 Modbus Multistate Value Properties – Basic Tab ..................... 3733
94.18 Modbus Analog Input Point Properties – Basic Tab ................. 3735
94.19 Modbus Analog Output Point Properties – Basic Tab .............. 3737
94.20 Modbus Digital Input Point Properties – Basic Tab .................. 3739
94.21 Modbus Digital Output Point Properties – Basic Tab ................ 3741
94.22 Modbus Multistate Input Point Properties – Basic Tab ............. 3743
94.23 Modbus Multistate Output Point Properties – Basic Tab .......... 3745
95 NETWORK 8000 Introduction .................................. 3747
95.1 NETWORK 8000 Overview .................................................... 3749
Technical 04-16006-04-en, March 2015
74
95.1.1 NETWORK 8000 System Migration ....................................... 3749
95.1.2 GCM Block Migration Synopsis ............................................. 3749
95.1.3 NETWORK 8000 ASD Devices .............................................. 3749
95.1.4 NETWORK 8000 LCMs ......................................................... 3749
95.2 NETWORK 8000 System Migration ......................................... 3750
95.2.1 NETWORK 8000 Interface .................................................... 3751
95.2.2 NETWORK 8000 Workflows .................................................. 3752
95.2.3 GCM Block Migration ............................................................ 3752
95.2.4 NETWORK 8000 Objects ...................................................... 3752
95.2.5 LCMs ................................................................................... 3752
95.2.6 Migration of Engineering Units ............................................... 3752
95.2.7 Schedules for NETWORK 8000 ............................................. 3753
95.2.8 Trends for NETWORK 8000 .................................................. 3753
95.2.9 Alarms for NETWORK 8000 .................................................. 3753
95.3 NETWORK 8000 Workflows ................................................... 3754
95.3.1 GCM Migration ..................................................................... 3754
95.3.2 Signal Migration .................................................................... 3755
95.4 NETWORK 8000 Interface ...................................................... 3758
95.4.1 Application ............................................................................ 3759
95.4.2 ASD Network ........................................................................ 3759
95.4.3 LCM Network ....................................................................... 3759
95.4.4 NETWORK 8000 Statistics .................................................... 3759
95.5 GCM Block Migration .............................................................. 3760
95.5.1 Import Migrated GCM Data .................................................. 3760
95.5.2 NETWORK 8000 and Building Operation Term Comparison .. 3760
95.5.3 GCM Blocks Converted to Standard Building Operation
Objects ................................................................................. 3761
95.5.4 Object Name ........................................................................ 3761
95.5.5 Property Name and Abbreviation ........................................... 3762
95.6 NETWORK 8000 Objects ........................................................ 3763
95.6.1 NETWORK 8000 Block Migration Synopsis ........................... 3763
95.6.2 NETWORK 8000 Object Input Properties .............................. 3763
95.6.3 NETWORK 8000 Forced Value ............................................. 3763
95.7 GCM Block Migration Synopsis ............................................... 3764
95.8 NETWORK 8000 Object Input Properties ................................ 3771
95.9 Learn LCM Blocks .................................................................. 3772
95.10 Learning LCM Blocks .............................................................. 3773
95.11 Migration of Engineering Units ................................................. 3774
95.11.1 Analog Engineering Units ...................................................... 3774
95.11.2 Digital Engineering Units ........................................................ 3774
95.11.3 Digital Units ........................................................................... 3774
95.11.4 NETWORK 8000 Object Value Conversion by Units .............. 3775
95.12 Analog Engineering Units ........................................................ 3776
95.13 Digital Engineering Units .......................................................... 3777
95.14 Digital Units ............................................................................. 3778
95.15 NETWORK 8000 Object Value Conversion by Units ................ 3779
95.16 Schedules for NETWORK 8000 ............................................... 3781
04-16006-04-en, March 2015 Technical
75
95.17 Trends for NETWORK 8000 .................................................... 3783
95.17.1 Conversion to a Variable Triggered Trend Log ....................... 3783
95.17.2 Conversion to an Interval Trend Log ...................................... 3783
95.18 Alarms for NETWORK 8000 .................................................... 3784
95.18.1 Alarm Features ...................................................................... 3784
95.18.2 Alarm Message Text ............................................................. 3785
95.19 Editing OSS Pre-Start and Pre-Stop Values ............................. 3786
95.20 Viewing NETWORK 8000 Interface Statistics ........................... 3788
96 NETWORK 8000 Devices ......................................... 3789
96.1 NETWORK 8000 ASD Devices ................................................ 3791
96.1.1 Supported Devices ............................................................... 3791
96.1.2 Generic RS-485 Network Devices ......................................... 3791
96.1.3 Field Device Alarms ............................................................... 3791
96.1.4 ASD Field Device Alarm Message Text .................................. 3791
96.1.5 ASD and LCM Device Communication Confirmation ............. 3792
96.2 Supported Devices ................................................................. 3793
96.3 Field Device Alarms ................................................................. 3794
96.4 ASD Field Device Alarm Message Text .................................... 3795
96.5 NETWORK 8000 LCMs .......................................................... 3799
96.5.1 Supported Devices ............................................................... 3799
96.5.2 Generic RS-485 Network Devices ......................................... 3799
96.5.3 LCM Device Communication Confirmation ............................ 3799
96.5.4 Alarms for LCMs ................................................................... 3799
96.5.5 Schedules for LCMs .............................................................. 3800
96.5.6 Trends for LCMs ................................................................... 3800
96.5.7 LCM Exception Routing ........................................................ 3800
96.5.8 Learn LCM Blocks ................................................................ 3801
96.5.9 Block Update ........................................................................ 3801
96.6 Configuring ASD Communications .......................................... 3802
96.7 Configuring LCM Communications .......................................... 3804
96.8 Resetting LCM Blocks ............................................................ 3806
96.9 Updating a Block or Object ..................................................... 3807
96.10 Synchronizing LCM Date and Time ......................................... 3808
96.11 LCM Message Routing ............................................................ 3809
96.12 Configuring LCM Message Routing ......................................... 3810
96.13 ASD and LCM Device Communication Confirmation ................ 3811
96.14 Confirming ASD or LCM Communications Using Search ........ 3812
96.15 Confirming ASD and LCM Communications Using Alarm View 3814
96.16 Confirming ASD and LCM Communications Using Event View . 3816
97 NETWORK 8000 User Interface ............................... 3819
97.1 NETWORK 8000 System Tree Icons ....................................... 3833
97.2 NETWORK 8000 ASD Network – List View ............................. 3834
97.3 NETWORK 8000 Interface – Basic Tab ................................... 3835
97.4 NETWORK 8000 Interface – ASD Tab ..................................... 3837
97.5 NETWORK 8000 Interface – LCM Tab .................................... 3839
Technical 04-16006-04-en, March 2015
76
97.6 Lcm Device – Basic Tab .......................................................... 3842
97.7 AI Properties – Basic Tab ........................................................ 3844
97.8 AI Properties – Inputs Tab ....................................................... 3845
97.9 AI Properties – Parameters Tab ............................................... 3847
97.10 Alarm Properties – Basic Tab .................................................. 3850
97.11 Alarm Properties – Inputs Tab ................................................. 3852
97.12 Alarm Properties – Parameters Tab ......................................... 3854
97.13 AO Properties – Basic Tab ...................................................... 3856
97.14 AO Properties – Inputs Tab ..................................................... 3858
97.15 AO Properties – Parameters Tab ............................................. 3860
97.16 Apt Properties – Basic Tab ...................................................... 3862
97.17 Apt Properties – Inputs Tab ..................................................... 3863
97.18 Apt Properties – Parameters Tab ............................................ 3865
97.19 Btuh Properties – Basic Tab .................................................... 3866
97.20 Btuh Properties – Inputs Tab ................................................... 3867
97.21 Btuh Properties – Parameters Tab .......................................... 3869
97.22 Cos Properties – Basic Tab ..................................................... 3870
97.23 Cos Properties – Inputs Tab .................................................... 3872
97.24 Cos Properties – Parameters Tab ............................................ 3874
97.25 Curve Properties – Basic Tab .................................................. 3876
97.26 Curve Properties – Inputs Tab ................................................. 3877
97.27 Curve Properties – Parameters Tab ......................................... 3879
97.28 DccComp Properties – Basic Tab ........................................... 3881
97.29 DccComp Properties – Inputs Tab .......................................... 3882
97.30 DccComp Properties – Parameters Tab .................................. 3884
97.31 DccFix Properties – Basic Tab ................................................. 3885
97.32 DccFix Properties – Inputs Tab ................................................ 3886
97.33 DccFix Properties – Parameters Tab ....................................... 3888
97.34 DegDa Properties – Basic Tab ................................................ 3889
97.35 DegDa Properties – Inputs Tab ............................................... 3891
97.36 DegDa Properties – Parameters Tab ....................................... 3893
97.37 Delay Properties – Basic Tab ................................................... 3895
97.38 Delay Properties – Inputs Tab .................................................. 3897
97.39 Delay Properties – Parameters Tab ......................................... 3899
97.40 DI Properties – Basic Tab ........................................................ 3900
97.41 DI Properties – Inputs Tab ....................................................... 3902
97.42 DI Properties – Parameters Tab ............................................... 3904
97.43 DO Properties – Basic Tab ...................................................... 3906
97.44 DO Properties – Inputs Tab ..................................................... 3908
97.45 DO Properties – Parameters Tab ............................................. 3910
97.46 Dpt Properties – Basic Tab ..................................................... 3912
97.47 Dpt Properties – Inputs Tab .................................................... 3914
97.48 Dpt Properties – Parameters Tab ............................................ 3916
97.49 EDL Properties – Basic Tab ..................................................... 3917
97.50 EDL Properties – Priority Slots Tab .......................................... 3920
97.51 EDL Properties – Inputs Tab .................................................... 3921
97.52 EDL Properties – Load Status Inputs Tab ................................ 3924
04-16006-04-en, March 2015 Technical
77
97.53 EDL Properties – Load Status Inputs 2 Tab ............................. 3926
97.54 EDL Properties – Parameters Tab ........................................... 3928
97.55 EnthlDew Properties – Basic Tab ............................................ 3932
97.56 EnthlDew Properties – Inputs Tab ........................................... 3933
97.57 EnthlDew Properties – Parameters Tab ................................... 3935
97.58 EnthlRh Properties – Basic Tab ............................................... 3936
97.59 EnthlRh Properties – Inputs Tab ............................................. 3937
97.60 EnthlRh Properties – Parameters Tab ...................................... 3939
97.61 Flo2 Properties – Basic Tab .................................................... 3940
97.62 Flo2 Properties – Control Values Tab ....................................... 3942
97.63 Flo2 Properties – Command Inputs Tab .................................. 3944
97.64 Flo2 Properties – EMS Inputs Tab ........................................... 3948
97.65 Flo2 Properties – Parameters Tab ........................................... 3952
97.66 Flo2 Properties – Controller Configuration Tab ........................ 3953
97.67 Flow Properties – Basic Tab .................................................... 3958
97.68 Flow Properties – Inputs Tab ................................................... 3960
97.69 Flow Properties – Parameters Tab ........................................... 3962
97.70 HiLo Properties – Basic Tab .................................................... 3964
97.71 HiLo Properties – Inputs Tab ................................................... 3966
97.72 HiLo Properties – Parameters Tab ........................................... 3968
97.73 Invert Properties – Basic Tab ................................................... 3970
97.74 Invert Properties – Inputs Tab .................................................. 3971
97.75 Invert Properties – Parameters Tab ......................................... 3973
97.76 LcmAI Properties – Basic Tab ................................................. 3974
97.77 LcmAI Properties – Inputs Tab ................................................ 3975
97.78 LcmAI Properties – Parameters Tab ........................................ 3976
97.79 LcmAlarm Properties – Basic Tab ........................................... 3979
97.80 LcmAlarm Properties – Inputs Tab .......................................... 3981
97.81 LcmAlarm Properties – Parameters Tab .................................. 3983
97.82 LcmAO Properties – Basic Tab ............................................... 3985
97.83 LcmAO Properties – Inputs Tab .............................................. 3987
97.84 LcmAO Properties – Parameters Tab ...................................... 3989
97.85 LcmApt Properties – Basic Tab ............................................... 3991
97.86 LcmApt Properties – Inputs Tab .............................................. 3993
97.87 LcmApt Properties – Parameters Tab ...................................... 3995
97.88 LcmBtuh Properties – Basic Tab ............................................. 3997
97.89 LcmBtuh Properties – Inputs Tab ............................................ 3998
97.90 LcmBtuh Properties – Parameters Tab .................................... 4000
97.91 LcmCalen Properties – Basic Tab ........................................... 4002
97.92 LcmCalen Properties – Inputs Tab .......................................... 4004
97.93 LcmCalen Properties – Parameters Tab .................................. 4006
97.94 LcmCos Properties – Basic Tab .............................................. 4008
97.95 LcmCos Properties – Inputs Tab ............................................. 4010
97.96 LcmCos Properties – Parameters Tab ..................................... 4012
97.97 LcmCurve Properties – Basic Tab ........................................... 4014
97.98 LcmCurve Properties – Inputs Tab .......................................... 4015
97.99 LcmCurve Properties – Parameters Tab .................................. 4017
Technical 04-16006-04-en, March 2015
78
97.100 LcmDaily Properties – Basic Tab ............................................. 4019
97.101 LcmDaily Properties – Inputs Tab ............................................ 4021
97.102 LcmDaily Properties – Parameters Tab .................................... 4023
97.103 LcmDcc Properties – Basic Tab .............................................. 4025
97.104 LcmDcc Properties – Inputs Tab ............................................. 4027
97.105 LcmDcc Properties – Parameters Tab ..................................... 4029
97.106 LcmDegDa Properties – Basic Tab .......................................... 4031
97.107 LcmDegDa Properties – Inputs Tab ......................................... 4034
97.108 LcmDegDa Properties – Parameters Tab ................................ 4036
97.109 LcmDelay Properties – Basic Tab ............................................ 4038
97.110 LcmDelay Properties – Inputs Tab ........................................... 4040
97.111 LcmDelay Properties – Parameters Tab .................................. 4042
97.112 LcmDI Properties – Basic Tab ................................................. 4043
97.113 LcmDI Properties – Inputs Tab ................................................ 4045
97.114 LcmDI Properties – Parameters Tab ........................................ 4046
97.115 LcmDO Properties – Basic Tab ............................................... 4048
97.116 LcmDO Properties – Inputs Tab .............................................. 4050
97.117 LcmDO Properties – Parameters Tab ...................................... 4052
97.118 LcmDpt Properties – Basic Tab ............................................... 4054
97.119 LcmDpt Properties – Inputs Tab .............................................. 4056
97.120 LcmDpt Properties – Parameters Tab .................................... 4058
97.121 LcmEDL Properties – Basic Tab .............................................. 4060
97.122 LcmEDL Properties – Priority Slots Tab ................................... 4063
97.123 LcmEDL Properties – Inputs Tab ............................................. 4064
97.124 LcmEDL Properties – Load Status Inputs Tab ......................... 4067
97.125 LcmEDL Properties – Load Status Inputs 2 Tab ...................... 4069
97.126 LcmEDL Properties – Parameters Tab .................................... 4071
97.127 LcmEnthl Properties – Basic Tab ............................................. 4075
97.128 LcmEnthl Properties – Inputs Tab ............................................ 4077
97.129 LcmEnthl Properties – Parameters Tab ................................... 4079
97.130 LcmFlow Properties – Basic Tab ............................................. 4081
97.131 LcmFlow Properties – Inputs Tab ............................................ 4083
97.132 LcmFlow Properties – Parameters Tab .................................... 4085
97.133 LcmHiLo Properties – Basic Tab ............................................. 4087
97.134 LcmHiLo Properties – Inputs Tab ............................................ 4089
97.135 LcmHiLo Properties – Parameters Tab .................................... 4091
97.136 LcmHoli Properties – Basic Tab .............................................. 4093
97.137 LcmHoli Properties – Inputs Tab ............................................. 4094
97.138 LcmHoli Properties – Parameters Tab ..................................... 4096
97.139 LcmLimit Properties – Basic Tab ............................................. 4101
97.140 LcmLimit Properties – Inputs Tab ............................................ 4103
97.141 LcmLimit Properties – Parameters Tab .................................... 4105
97.142 LcmLogic Properties – Basic Tab ............................................ 4107
97.143 LcmLogic Properties – Inputs Tab ........................................... 4109
97.144 LcmLogic Properties – Parameters Tab ................................... 4111
97.145 LcmLoop Properties – Basic Tab ............................................ 4113
97.146 LcmLoop Properties – Inputs Tab ........................................... 4115
04-16006-04-en, March 2015 Technical
79
97.147 LcmLoop Properties – Parameters Tab ................................... 4118
97.148 LcmMath Properties – Basic Tab ............................................ 4122
97.149 LcmMath Properties – Inputs Tab ........................................... 4123
97.150 LcmMath Properties – Parameters Tab ................................... 4125
97.151 LcmMomen Properties – Basic Tab ........................................ 4127
97.152 LcmMomen Properties – Inputs Tab ....................................... 4129
97.153 LcmMomen Properties – Parameters Tab ............................... 4131
97.154 LcmMtr Properties – Basic Tab ............................................... 4133
97.155 LcmMtr Properties – Inputs Tab .............................................. 4135
97.156 LcmMtr Properties – Parameters Tab ...................................... 4137
97.157 LcmOSS Properties – Basic Tab ............................................. 4139
97.158 LcmOSS Properties – Inputs Tab ............................................ 4142
97.159 LcmOSS Properties – Parameters Tab .................................... 4145
97.160 LcmOSS Properties – WeeklySchedule Tab ............................ 4147
97.161 LcmPoll Properties – Basic Tab ............................................... 4150
97.162 LcmPoll Properties – Inputs Tab .............................................. 4152
97.163 LcmPoll Properties – Parameters Tab ..................................... 4153
97.164 LcmPulse Properties – Basic Tab ............................................ 4155
97.165 LcmPulse Properties – Inputs Tab ........................................... 4157
97.166 LcmPulse Properties – Parameters Tab ................................... 4158
97.167 LcmPwm Properties – Basic Tab ............................................ 4160
97.168 LcmPwm Properties – Inputs Tab ........................................... 4162
97.169 LcmPwm Properties – Parameters Tab ................................... 4164
97.170 LcmRamp Properties – Basic Tab ........................................... 4166
97.171 LcmRamp Properties – Inputs Tab .......................................... 4167
97.172 LcmRamp Properties – Parameters Tab .................................. 4169
97.173 LcmReset Properties – Basic Tab ........................................... 4171
97.174 LcmReset Properties – Inputs Tab .......................................... 4172
97.175 LcmReset Properties – Parameters Tab .................................. 4174
97.176 LcmRgcm Properties – Basic Tab ........................................... 4176
97.177 LcmRgcm Properties – Inputs Tab .......................................... 4178
97.178 LcmRgcm Properties – Parameters Tab .................................. 4180
97.179 LcmSeq Properties – Basic Tab .............................................. 4182
97.180 LcmSeq Properties – Inputs Tab ............................................. 4184
97.181 LcmSeq Properties – Parameters Tab ..................................... 4186
97.182 LcmSlcm Properties – Basic Tab ............................................ 4188
97.183 LcmSlcm Properties – Digital Inputs Tab ................................. 4189
97.184 LcmSlcm Properties – Digital Inputs 2 Tab .............................. 4190
97.185 LcmSlcm Properties – Analog Inputs Tab ................................ 4191
97.186 LcmSlcm Properties – Parameters Tab ................................... 4192
97.187 LcmSlect Properties – Basic Tab ............................................. 4193
97.188 LcmSlect Properties – Inputs Tab ............................................ 4195
97.189 LcmSlect Properties – Parameters Tab ................................... 4197
97.190 LcmTotal Properties – Basic Tab ............................................. 4199
97.191 LcmTotal Properties – Inputs Tab ............................................ 4201
97.192 LcmTotal Properties – Parameters Tab ................................... 4203
97.193 LcmTrend Properties – Basic Tab ........................................... 4205
Technical 04-16006-04-en, March 2015
80
97.194 LcmTrend Properties – Inputs Tab .......................................... 4206
97.195 LcmTrend Properties – Parameters Tab .................................. 4208
97.196 LcmTstat Properties – Basic Tab ............................................. 4211
97.197 LcmTstat Properties – Inputs Tab ............................................ 4213
97.198 LcmTstat Properties – Parameters Tab ................................... 4215
97.199 LcmWeek Properties – Basic Tab ........................................... 4217
97.200 LcmWeek Properties – Inputs Tab .......................................... 4219
97.201 LcmWeek Properties – Parameters Tab .................................. 4221
97.202 LIM Properties – Basic Tab ..................................................... 4223
97.203 LIM Properties – Relay Outputs Tab ........................................ 4224
97.204 LIM Properties – Window Values Tab ...................................... 4225
97.205 LIM Properties – Digital Inputs Tab .......................................... 4226
97.206 LIM Properties – Analog Inputs Tab ......................................... 4228
97.207 LIM Properties – Parameters Tab ............................................ 4230
97.208 Limit Properties – Basic Tab .................................................... 4232
97.209 Limit Properties – Inputs Tab ................................................... 4233
97.210 Limit Properties – Parameters Tab .......................................... 4235
97.211 Logic Properties – Basic Tab ................................................... 4236
97.212 Logic Properties – Inputs Tab .................................................. 4237
97.213 Logic Properties – Parameters Tab ......................................... 4239
97.214 Loop Properties – Basic Tab ................................................... 4241
97.215 Loop Properties – Inputs Tab .................................................. 4243
97.216 Loop Properties – Parameters Tab .......................................... 4246
97.217 Math Properties – Basic Tab ................................................... 4249
97.218 Math Properties – Inputs Tab ................................................. 4250
97.219 Math Properties – Parameters Tab .......................................... 4252
97.220 MathFilt Properties – Basic Tab ............................................... 4254
97.221 MathFilt Properties – Inputs Tab ............................................. 4255
97.222 MathFilt Properties – Parameters Tab ...................................... 4257
97.223 MathSqRt Properties – Basic Tab ........................................... 4258
97.224 MathSqRt Properties – Inputs Tab ......................................... 4259
97.225 MathSqRt Properties – Parameters Tab .................................. 4261
97.226 Mn Properties – Basic Tab ...................................................... 4262
97.227 Mn Properties – Digital Outputs Tab ........................................ 4263
97.228 Mn Properties – Analog Outputs Tab ....................................... 4264
97.229 Mn Properties – Digital Inputs Tab ........................................... 4265
97.230 Mn Properties – Analog Inputs Tab ......................................... 4267
97.231 Mn Properties – Parameters Tab ............................................. 4269
97.232 MnFlo Properties – Basic Tab .................................................. 4271
97.233 MnFlo Properties – Setpoints Tab ........................................... 4273
97.234 MnFlo Properties – Command Inputs Tab .............................. 4275
97.235 MnFlo Properties – EMS Inputs Tab ....................................... 4279
97.236 MnFlo Properties – Parameters Tab ........................................ 4282
97.237 MnHpfc Properties – Basic Tab ............................................... 4284
97.238 MnHpfc Properties – Inputs Tab ............................................. 4287
97.239 MnHpfc Properties – Parameters Tab ..................................... 4290
97.240 Momen Properties – Basic Tab ............................................... 4292
04-16006-04-en, March 2015 Technical
81
97.241 Momen Properties – Inputs Tab .............................................. 4293
97.242 Momen Properties – Parameters Tab ...................................... 4295
97.243 MtrCycle Properties – Basic Tab ............................................. 4297
97.244 MtrCycle Properties – Inputs Tab ........................................... 4299
97.245 MtrCycle Properties – Parameters Tab ................................... 4301
97.246 MtrDays Properties – Basic Tab .............................................. 4303
97.247 MtrDays Properties – Inputs Tab ............................................. 4305
97.248 MtrDays Properties – Parameters Tab .................................... 4307
97.249 MtrState Properties – Basic Tab .............................................. 4309
97.250 MtrState Properties – Inputs Tab ............................................ 4310
97.251 MtrState Properties – Parameters Tab .................................... 4312
97.252 MtrTime Properties – Basic Tab .............................................. 4314
97.253 MtrTime Properties – Inputs Tab ............................................. 4316
97.254 MtrTime Properties – Parameters Tab ..................................... 4318
97.255 OSS Properties – Basic Tab .................................................... 4320
97.256 OSS Properties – Schedule Reference Tab ............................. 4323
97.257 OSS Properties – Inputs Tab .................................................. 4325
97.258 OSS Properties – Parameters Tab ........................................... 4328
97.259 Pem1 Properties – Basic Tab .................................................. 4330
97.260 Pem1 Properties – Window Values Tab ................................... 4332
97.261 Pem1 Properties – Digital Inputs Tab ...................................... 4333
97.262 Pem1 Properties – Analog Inputs Tab ..................................... 4335
97.263 Pem1 Properties – Parameters Tab ......................................... 4337
97.264 PollAv Properties – Basic Tab .................................................. 4338
97.265 PollAv Properties – Inputs Tab ................................................. 4339
97.266 PollAv Properties – Parameters Tab ........................................ 4341
97.267 PollDv Properties – Basic Tab ................................................. 4342
97.268 PollDv Properties – Inputs Tab ................................................ 4343
97.269 PollDv Properties – Parameters Tab ........................................ 4345
97.270 Pulse Properties – Basic Tab ................................................... 4346
97.271 Pulse Properties – Inputs Tab .................................................. 4348
97.272 Pulse Properties – Parameters Tab ......................................... 4350
97.273 Pwm Properties – Basic Tab ................................................... 4352
97.274 Pwm Properties – Inputs Tab .................................................. 4353
97.275 Pwm Properties – Parameters Tab .......................................... 4355
97.276 Ramp Properties – Basic Tab .................................................. 4357
97.277 Ramp Properties – Inputs Tab ................................................. 4358
97.278 Ramp Properties – Parameters Tab ........................................ 4360
97.279 Reset Properties – Basic Tab .................................................. 4362
97.280 Reset Properties – Inputs Tab ................................................ 4363
97.281 Reset Properties – Parameters Tab ......................................... 4365
97.282 RlcmAv Properties – Basic Tab ............................................... 4367
97.283 RlcmAv Properties – Inputs Tab .............................................. 4368
97.284 RlcmAv Properties – Parameters Tab ...................................... 4370
97.285 RlcmDv Properties – Basic Tab ............................................... 4371
97.286 RlcmDv Properties – Inputs Tab .............................................. 4372
97.287 RlcmDv Properties – Parameters Tab ...................................... 4374
Technical 04-16006-04-en, March 2015
82
97.288 RnetAv Properties – Basic Tab ................................................ 4375
97.289 RnetAv Properties – Inputs Tab ............................................... 4376
97.290 RnetAv Properties – Parameters Tab ....................................... 4378
97.291 RnetDv Properties – Basic Tab ................................................ 4379
97.292 RnetDv Properties – Inputs Tab ............................................... 4380
97.293 RnetDv Properties – Parameters Tab ...................................... 4382
97.294 SeqBin Properties – Basic Tab ................................................ 4383
97.295 SeqBin Properties – Inputs Tab .............................................. 4385
97.296 SeqBin Properties – Parameters Tab ...................................... 4387
97.297 SeqLin Properties – Basic Tab ................................................ 4389
97.298 SeqLin Properties – Inputs Tab .............................................. 4391
97.299 SeqLin Properties – Parameters Tab ....................................... 4393
97.300 SeqRot Properties – Basic Tab ............................................... 4395
97.301 SeqRot Properties – Inputs Tab ............................................. 4397
97.302 SeqRot Properties – Parameters Tab ..................................... 4399
97.303 Sgcm Properties – Basic Tab .................................................. 4401
97.304 Sgcm Properties – Digital Inputs Tab ....................................... 4402
97.305 Sgcm Properties – Digital Inputs 2 Tab .................................... 4404
97.306 Sgcm Properties – Analog Inputs Tab ..................................... 4405
97.307 Sgcm Properties – Parameters Tab ......................................... 4407
97.308 Sgrp2 Properties – Basic Tab .................................................. 4408
97.309 Sgrp2 Properties – Inputs Tab ................................................. 4409
97.310 Sgrp2 Properties – Parameters Tab ........................................ 4411
97.311 SgrpFlo2 Properties – Basic Tab ............................................. 4412
97.312 SgrpFlo2 Properties – Inputs Tab ........................................... 4413
97.313 SgrpFlo2 Properties – Parameters Tab .................................... 4415
97.314 SlectAv Properties – Basic Tab ............................................... 4416
97.315 SlectAv Properties – Inputs Tab ............................................. 4417
97.316 SlectAv Properties – Parameters Tab ...................................... 4419
97.317 SlectDv Properties – Basic Tab ............................................... 4420
97.318 SlectDv Properties – Inputs Tab .............................................. 4421
97.319 SlectDv Properties – Parameters Tab ...................................... 4423
97.320 Total Properties – Basic Tab ................................................... 4424
97.321 Total Properties – Inputs Tab .................................................. 4426
97.322 Total Properties – Parameters Tab .......................................... 4428
97.323 Tstat Properties – Basic Tab ................................................... 4430
97.324 Tstat Properties – Inputs Tab ................................................. 4432
97.325 Tstat Properties – Parameters Tab .......................................... 4434
97.326 TstatFlt Properties – Basic Tab ................................................ 4436
97.327 TstatFlt Properties – Inputs Tab .............................................. 4438
97.328 TstatFlt Properties – Parameters Tab ...................................... 4440
97.329 VvBox Properties – Basic Tab ................................................. 4442
97.330 VvBox Properties – Inputs Tab ................................................ 4444
97.331 VvBox Properties – Parameters Tab ........................................ 4448
97.332 VvBox Properties – Setpoints Tab ........................................... 4450
97.333 Zone2 Properties – Basic Tab ................................................. 4452
97.334 Zone2 Properties – UI Values Tab ........................................... 4453
04-16006-04-en, March 2015 Technical
83
97.335 Zone2 Properties – Window Values Tab .................................. 4454
97.336 Zone2 Properties – Digital Inputs Tab ...................................... 4455
97.337 Zone2 Properties – Analog Inputs Tab ..................................... 4457
97.338 Zone2 Properties – Parameters Tab ........................................ 4459
97.339 NETWORK 8000 Statistics Dialog Box – Basic Tab ................. 4461
97.340 NETWORK 8000 Statistics Dialog Box – LCM Tab .................. 4464
97.341 NETWORK 8000 Statistics Dialog Box – Block List Sort Tab ... 4466
98 I/NET Introduction .................................................... 4469
98.1 I/NET Overview ....................................................................... 4471
98.1.1 I/NET Integration ................................................................... 4471
98.1.2 I/NET Workflow .................................................................... 4471
98.1.3 INET Interface ....................................................................... 4471
98.1.4 I/NET Devices ....................................................................... 4471
98.1.5 I/NET Points .......................................................................... 4472
98.1.6 I/NET Graphics .................................................................... 4472
98.2 I/NET Integration .................................................................... 4473
98.2.1 Basic Support for Security Applications ................................. 4474
98.2.2 Gateway Support .................................................................. 4475
98.2.3 I/O Server ............................................................................. 4475
98.2.4 I/NET Seven Application ....................................................... 4475
98.2.5 INET Interface ...................................................................... 4475
98.3 I/NET Workflow ....................................................................... 4476
98.4 I/O Server ............................................................................... 4478
98.4.1 I/O Server Clients .................................................................. 4478
98.4.2 I/O Server as a Windows Service ........................................... 4478
98.5 I/NET Seven Application .......................................................... 4479
98.5.1 I/NET Seven Editors .............................................................. 4479
98.5.2 I/NET Message Routing ........................................................ 4479
98.6 I/NET Seven Editors ................................................................ 4480
98.7 I/NET Message Routing .......................................................... 4482
98.8 Launching I/NET Seven as an Application ................................ 4483
98.9 Logging On to the I/NET System ............................................. 4484
99 I/NET Interface ......................................................... 4485
99.1 INET Interface ......................................................................... 4487
99.2 Creating an INET Interface ....................................................... 4489
99.3 Configuring an INET Interface .................................................. 4490
100 I/NET Devices .......................................................... 4491
100.1 I/NET Devices ......................................................................... 4493
100.1.1 Hosts .................................................................................... 4493
100.1.2 Links ..................................................................................... 4493
100.1.3 Sites ..................................................................................... 4493
100.2 Discovering an I/NET Device ................................................... 4494
100.3 I/NET Device Configuration and Point Information .................... 4495
100.4 Uploading an I/NET Device’s Configuration ............................. 4496
100.5 Configuring an I/NET Device .................................................... 4497
Technical 04-16006-04-en, March 2015
84
100.6 Creating an I/NET Host .......................................................... 4498
100.7 Configuring an I/NET Host ...................................................... 4499
100.8 Creating an I/NET Link ........................................................... 4500
100.9 Configuring an I/NET Link ....................................................... 4501
100.10 Creating an I/NET Site ............................................................ 4502
100.11 Configuring an I/NET Site ....................................................... 4503
100.12 Updating an I/NET Device's Firmware ..................................... 4504
100.13 Updating a SubLAN Device's Firmware ................................... 4505
100.14 Creating a Backup of an I/NET Device’s Database .................. 4506
101 I/NET Points ............................................................. 4507
101.1 I/NET Points ........................................................................... 4509
101.1.1 I/NET Point Types and Representation .................................. 4509
101.1.2 I/NET Point Bindings ............................................................. 4509
101.1.3 I/NET Alarms, Schedules and Trends .................................... 4509
101.2 I/NET Point Types and Representation .................................... 4510
101.3 I/NET Point Bindings ............................................................... 4512
101.4 Configuring an I/NET Point ...................................................... 4515
101.5 Editing an I/NET Point ............................................................. 4518
101.6 Commanding an I/NET Point ................................................... 4519
101.7 I/NET Alarms, Schedules, and Trends ..................................... 4520
101.7.1 Alarms for I/NET Devices ....................................................... 4520
101.7.2 Schedules for I/NET Devices ................................................. 4520
101.7.3 Trends for I/NET Devices ....................................................... 4520
101.8 Alarms For I/NET Devices ........................................................ 4521
101.9 Schedules For I/NET Devices .................................................. 4522
101.10 Trends For I/NET Devices ....................................................... 4523
101.10.1 Trend Sampling Extensions ................................................... 4523
101.10.2 Trend Data Routing ............................................................... 4523
101.11 Creating an I/NET Trend .......................................................... 4524
101.12 Configuring an I/NET Trend ..................................................... 4525
102 I/NET Graphics ........................................................ 4527
102.1 I/NET Graphics ....................................................................... 4529
102.1.1 I/NET Graphics Conversion ................................................... 4529
102.1.2 Folder Hierarchy .................................................................... 4529
102.1.3 Graphic Conversion Workflow ............................................... 4530
102.2 I/NET Graphics Conversion ..................................................... 4532
102.3 Converting I/NET Graphics to TGML ....................................... 4538
102.4 Moving Converted I/NET Graphics to WorkStation in a Batch .. 4540
102.5 Moving Converted I/NET Graphics to WorkStation Manually .... 4541
103 I/NET User Interface ................................................. 4543
103.1 INET Interface Properties – Basic Tab ..................................... 4545
103.2 INET Host Properties – Basic Tab ........................................... 4546
103.3 INET Link Properties – Basic Tab ............................................ 4547
103.4 INET Site Properties – Basic Tab ............................................. 4548
103.5 INET Device Properties – Basic Tab ........................................ 4549
04-16006-04-en, March 2015 Technical
85
103.6 INET Point Properties – Basic Tab ........................................... 4551
103.7 INET Point Properties – Extensions Tab .................................. 4553
103.8 INET Trend Properties – Basic Tab .......................................... 4554
103.9 Actions Menu – Commands Submenu .................................... 4555
103.10 Actions Menu – Edit Submenu ................................................ 4556
104 MicroNet Introduction .............................................. 4559
104.1 MicroNet Overview ................................................................. 4561
104.1.1 MicroNet Workflow ............................................................... 4561
104.1.2 MicroNet Interface ................................................................ 4561
104.1.3 MicroNet Networks ............................................................... 4561
104.1.4 MicroNet Devices .................................................................. 4561
104.1.5 MicroNet Objects .................................................................. 4562
104.2 MicroNet Workflow ................................................................. 4563
104.2.1 Integration Flowchart ............................................................ 4564
104.2.2 MicroNet Representation in Building Operation ..................... 4565
104.2.3 MicroNet Interface Creation ................................................... 4565
104.2.4 Port Allocation and Configuration .......................................... 4565
104.2.5 IP Tunneling .......................................................................... 4565
104.2.6 VisiSat Programming ............................................................. 4565
104.2.7 Update Files .......................................................................... 4566
104.2.8 Data Import ........................................................................... 4566
104.3 Integration Flowchart ............................................................... 4567
104.4 MicroNet Representation in Building Operation ........................ 4569
104.5 MicroNet Interface Creation ..................................................... 4571
104.6 Port Allocation and Configuration ............................................ 4572
104.7 Creating an RS-232 Port ......................................................... 4574
104.8 Configuring a Serial Port .......................................................... 4575
104.9 Launching VisiSat from Building Operation .............................. 4577
104.10 IP Tunneling ............................................................................ 4578
104.11 VisiSat Programming ............................................................... 4579
104.12 Update Files ............................................................................ 4581
104.12.1 Update File Export ................................................................ 4581
104.12.2 Update File Path ................................................................... 4582
104.13 Data Import ............................................................................ 4583
104.13.1 Functions Available After Import ............................................ 4583
104.14 Importing MicroNet Network Data into Building Operation ....... 4584
104.15 Functions Available After Import .............................................. 4585
105 MicroNet Networks .................................................. 4587
105.1 MicroNet Interface ................................................................... 4589
105.2 MicroNet Networks ................................................................. 4590
105.2.1 MicroNet Network Protocols ................................................. 4590
105.2.2 MicroNet Network Connectivity ............................................. 4590
105.2.3 MicroNet Network Communications ...................................... 4590
105.3 Configuring a MicroNet Subnet ............................................... 4591
105.4 Creating a MicroNet Interface .................................................. 4592
Technical 04-16006-04-en, March 2015
86
105.5 Configuring a MicroNet Interface ............................................. 4593
105.6 MicroNet Network Protocols ................................................... 4596
105.6.1 NCP Networks ...................................................................... 4596
105.6.2 SNP Networks ...................................................................... 4596
105.6.3 ARCNET Networks ............................................................... 4596
105.7 NCP Networks ........................................................................ 4597
105.8 SNP Networks ........................................................................ 4598
105.9 ARCNET Networks ................................................................. 4599
105.10 MicroNet Network Connectivity ............................................... 4600
105.10.1 Connectivity - Automation Server .......................................... 4600
105.10.2 Connectivity - Enterprise Server ............................................ 4600
105.11 Connectivity – Automation Server ........................................... 4601
105.11.1 NCP or SNP using a Serial Link ............................................. 4601
105.11.2 ARCNET using an MNMI ....................................................... 4601
105.12 NCP or SNP using a Serial Link ............................................... 4602
105.13 ARCNET to Automation Server using an MNMI ....................... 4603
105.14 Connectivity – Enterprise Server .............................................. 4604
105.14.1 NCP or SNP using an RS-232 to RS-485 Converter .............. 4604
105.14.2 NCP or SNP using a USB to RS-485 Converter ..................... 4604
105.14.3 NCP using a Serial Link and MNMI ........................................ 4604
105.14.4 SNP using a Serial Link and MIU ........................................... 4604
105.14.5 ARCNET using an MNMI ....................................................... 4604
105.15 NCP or SNP using an RS-232 to RS-485 Converter ................ 4605
105.16 NCP or SNP using a USB to RS-485 Converter ....................... 4606
105.17 NCP using a Serial Link and MNMI .......................................... 4607
105.18 SNP using a Serial Link and MIU ............................................. 4608
105.19 ARCNET to Enterprise Server using an MNMI .......................... 4609
105.20 MicroNet Network Communications ........................................ 4610
105.20.1 Read or Write Failure ............................................................. 4610
105.20.2 Receive Timeout ................................................................... 4610
105.20.3 Time Synchronization ............................................................ 4610
105.20.4 Online or Offline Monitoring ................................................... 4611
105.20.5 Error Count ........................................................................... 4611
105.20.6 Poll Interval ........................................................................... 4611
105.20.7 Generic RS-485 Network Devices ......................................... 4611
105.21 Read or Write Failure ............................................................... 4612
105.22 Receive Timeout ..................................................................... 4613
105.23 Online or Offline Monitoring ..................................................... 4614
105.24 Error Count ............................................................................. 4615
105.25 Poll Interval ............................................................................. 4616
106 MicroNet Devices ..................................................... 4617
106.1 MicroNet Devices .................................................................... 4619
106.2 Configuring a MicroNet Device ................................................ 4620
107 MicroNet Objects ..................................................... 4621
107.1 MicroNet Objects .................................................................... 4623
04-16006-04-en, March 2015 Technical
87
107.1.1 Standard Objects .................................................................. 4623
107.1.2 Special Objects ..................................................................... 4623
107.1.3 Object Enumerations ............................................................ 4623
107.1.4 MicroNet Alarms, Schedules, Trend Logs .............................. 4623
107.1.5 Data Types ........................................................................... 4624
107.1.6 MicroNet Point Data Storage ................................................. 4624
107.2 Configuring a MicroNet Point ................................................... 4625
107.3 Viewing VisiSat Properties of a Point or Object ........................ 4626
107.4 Standard Objects .................................................................... 4627
107.5 Special Objects ....................................................................... 4629
107.5.1 Lookup Tables ...................................................................... 4629
107.5.2 Holiday Schedules ................................................................ 4629
107.5.3 Time Schedules .................................................................... 4629
107.5.4 Optimiser .............................................................................. 4629
107.5.5 Control Loops ....................................................................... 4629
107.6 Lookup Tables ........................................................................ 4631
107.6.1 MicroNet Lookup Tables ....................................................... 4631
107.6.2 MMC Lookup Tables ............................................................. 4631
107.7 Configuring a Lookup Table .................................................... 4632
107.8 Configuring an MMC Compensator Curve ............................... 4635
107.9 Configuring an MMC Output Reset Lookup Table .................... 4637
107.10 Holiday Schedules .................................................................. 4639
107.11 Configuring a Holiday Schedule ............................................... 4640
107.12 Configuring an IAC Holiday Schedule ...................................... 4642
107.13 Time Schedules ...................................................................... 4644
107.13.1 MicroNet and IAC Time Schedules ........................................ 4644
107.13.2 Optimiser Time Schedule ...................................................... 4644
107.14 Configuring a Time Schedule ................................................... 4645
107.15 Adding an Event to a MicroNet Time Schedule ........................ 4646
107.16 MicroNet and IAC Time Schedules .......................................... 4647
107.17 Optimiser ................................................................................ 4648
107.17.1 Optimiser Parameter Block ................................................... 4648
107.17.2 Optimiser Histogram ............................................................. 4648
107.17.3 Optimiser Time Schedule ...................................................... 4648
107.18 Optimiser Parameter Block ..................................................... 4649
107.18.1 Configuration ........................................................................ 4649
107.18.2 Status ................................................................................... 4649
107.19 Configuring the Optimiser Parameter Block ............................. 4650
107.20 Optimiser Histogram ............................................................... 4654
107.21 Configuring an Optimiser Histogram ........................................ 4655
107.22 Clearing an Optimiser Histogram ............................................. 4659
107.23 Optimiser Time Schedule ........................................................ 4660
107.24 Configuring an Optimiser Time Schedule ................................. 4661
107.25 Control Loops ......................................................................... 4662
107.25.1 PID Control ........................................................................... 4662
107.25.2 Two-Stage PID Control ......................................................... 4662
107.26 PID Control ............................................................................. 4663
Technical 04-16006-04-en, March 2015
88
107.26.1 Control Loop Algorithm ........................................................ 4663
107.26.2 Control Loop Override .......................................................... 4664
107.26.3 PID Control Loop Configuration ............................................. 4664
107.27 PID Control Loop Configuration .............................................. 4665
107.27.1 Loop Action .......................................................................... 4665
107.27.2 Proportional (P) Control ......................................................... 4665
107.27.3 Proportional plus Integral (PI) Control ..................................... 4665
107.27.4 Proportional plus Integral plus Derivative (PID) Control ........... 4666
107.27.5 Auto-tuning ........................................................................... 4666
107.28 Configuring a PID Control Loop ............................................... 4669
107.29 Auto-tuning a PID Control Loop .............................................. 4673
107.30 Two-Stage PID Control ........................................................... 4676
107.30.1 Control Loop Algorithm ......................................................... 4676
107.30.2 Deadzones ........................................................................... 4677
107.30.3 Boost ................................................................................... 4677
107.30.4 Single-Stage Control ............................................................. 4677
107.30.5 Control State Indication ........................................................ 4678
107.31 Configuring a Two-Stage PID Control Loop ............................. 4679
107.32 Object Enumerations .............................................................. 4684
107.32.1 MicroNet Enumerations ......................................................... 4684
107.32.2 IAC Enumerations ................................................................. 4684
107.32.3 Unifact Pro Enumerations ...................................................... 4684
107.32.4 Special Object Enumerations ................................................ 4684
107.33 MicroNet Enumerations ........................................................... 4685
107.34 IAC Enumerations ................................................................... 4692
107.35 Unifact Pro Enumerations ........................................................ 4697
107.36 Special Object Enumerations .................................................. 4699
107.37 Data Types ............................................................................. 4703
107.37.1 Analog Data .......................................................................... 4703
107.37.2 Digital Data ........................................................................... 4703
107.37.3 Not Active ............................................................................. 4703
107.38 Analog Data ............................................................................ 4704
107.39 Not Active ............................................................................... 4705
107.40 MicroNet Alarms, Schedules, Trend Logs ............................... 4706
107.40.1 Alarms for MicroNet Devices ................................................. 4706
107.40.2 Schedules for MicroNet Devices ............................................ 4706
107.40.3 Trend Logs for MicroNet Devices .......................................... 4706
107.41 MicroNet Point Data Storage ................................................... 4708
108 MicroNet User Interface ........................................... 4709
108.1 MicroNet System Tree Icons ................................................... 4713
108.2 MicroNet Interface Properties – Basic Tab ............................... 4714
108.3 MicroNet Interface Properties – Advanced Tab ........................ 4716
108.4 Serial Port Properties – Basic Tab ........................................... 4718
108.5 Data Import Dialog Box ........................................................... 4720
108.6 Subnet Properties – Basic Tab ................................................ 4721
108.7 MicroNet Device Properties – Basic Tab .................................. 4722
04-16006-04-en, March 2015 Technical
89
108.8 Standard Object Properties – Basic Tab .................................. 4724
108.9 Standard Object Properties – Advanced Tab ........................... 4725
108.10 Standard Object Properties – VisiSat Tab ................................ 4727
108.11 Lookup Table Properties – Basic Tab ...................................... 4729
108.12 Lookup Table Properties – Advanced Tab ............................... 4730
108.13 Lookup Table Properties – VisiSat Tab .................................... 4731
108.14 Lookup Table Properties – Inputs Tab ..................................... 4733
108.15 Lookup Table Properties – Outputs Tab .................................. 4735
108.16 MMC Compensator Curve Properties – Basic Tab .................. 4737
108.17 MMC Compensator Curve Properties – Advanced Tab ........... 4738
108.18 MMC Compensator Curve Properties – VisiSat Tab ................. 4739
108.19 MMC Compensator Curve Properties – X Tab ......................... 4741
108.20 MMC Compensator Curve Properties – Y Tab ......................... 4742
108.21 MMC Output Reset Lookup Table Properties – Basic Tab ....... 4743
108.22 MMC Output Reset Lookup Table Properties – Advanced Tab 4744
108.23 MMC Output Reset Lookup Table Properties – VisiSat Tab ..... 4745
108.24 MMC Output Reset Lookup Table Properties – X Tab .............. 4747
108.25 MMC Output Reset Lookup Table Properties – Y Tab ............. 4748
108.26 MicroNet Schedule Editor View ............................................... 4749
108.27 MicroNet Schedule Editor Toolbar ........................................... 4750
108.28 MicroNet Schedule Event Properties Dialog Box ...................... 4751
108.29 Holiday Schedule Properties – Basic Tab ................................ 4752
108.30 Holiday Schedule Properties – Advanced Tab ......................... 4753
108.31 Holiday Schedule Properties – VisiSat Tab .............................. 4754
108.32 MicroNet Calendar Editor View ................................................ 4756
108.33 Time Schedule Properties – Basic Tab .................................... 4758
108.34 Time Schedule Properties – Advanced Tab ............................. 4759
108.35 Time Schedule Properties – VisiSat Tab .................................. 4760
108.36 IAC Holiday Schedule Properties – Basic Tab .......................... 4762
108.37 IAC Holiday Schedule Properties – Advanced Tab ................... 4764
108.38 IAC Holiday Schedule Properties – VisiSat Tab ........................ 4765
108.39 Optimiser Parameter Block Properties – Basic Tab .................. 4767
108.40 Optimiser Parameter Block Properties – Advanced Tab ........... 4769
108.41 Optimiser Parameter Block Properties – VisiSat Tab ................ 4770
108.42 Optimiser Parameter Block Properties – Parameters Tab ........ 4771
108.43 Optimiser Histogram Properties – Basic Tab ........................... 4773
108.44 Optimiser Histogram Properties – Advanced Tab .................... 4774
108.45 Optimiser Histogram Properties – VisiSat Tab ......................... 4775
108.46 Optimiser Histogram Properties – Early Tab ............................ 4777
108.47 Optimiser Histogram Properties – Late Tab ............................. 4779
108.48 Optimiser Time Schedule Properties – Basic Tab .................... 4781
108.49 Optimiser Time Schedule Properties – Advanced Tab ............. 4782
108.50 Optimiser Time Schedule Properties – VisiSat Tab ................... 4783
108.51 PID Control Properties – Basic Tab ......................................... 4785
108.52 PID Control Properties – Advanced Tab .................................. 4786
108.53 PID Control Properties – VisiSat Tab ....................................... 4787
108.54 PID Control Properties – Parameters Tab ................................ 4788
Technical 04-16006-04-en, March 2015
90
108.55 Two-Stage PID Control Properties – Basic Tab ....................... 4791
108.56 Two-Stage PID Control Properties – Advanced Tab ................ 4793
108.57 Two-Stage PID Control Properties – VisiSat Tab ..................... 4794
108.58 Two-Stage PID Control Properties – Parameters Tab .............. 4795
109 Sigma Introduction ................................................... 4799
109.1 Sigma Overview ...................................................................... 4801
109.1.1 Sigma Workflow .................................................................... 4801
109.1.2 Sigma Interface ..................................................................... 4801
109.1.3 Sigma Networks ................................................................... 4801
109.1.4 Sigma Devices ...................................................................... 4802
109.1.5 Sigma Objects ...................................................................... 4802
109.2 Sigma Workflow ...................................................................... 4803
109.2.1 Integration Flowchart ............................................................ 4804
109.2.2 Sigma Interface Creation ....................................................... 4805
109.2.3 Sigma Data Import ................................................................ 4805
109.2.4 Sigma Programming ............................................................. 4805
109.3 Integration Flowchart ............................................................... 4806
109.4 Sigma Interface Creation ......................................................... 4808
109.5 Sigma Data Import .................................................................. 4809
109.5.1 Partial Data Imports .............................................................. 4810
109.5.2 Data Importer Conversion Warning Messages ....................... 4810
109.5.3 Data Importer Conversion Error Messages ............................ 4810
109.5.4 Data Importer Conversion Failed Messages ........................... 4811
109.5.5 Graphics Error Messages in the Trace File ............................. 4811
109.5.6 Functions Available After Import ............................................ 4811
109.6 Partial Data Imports ................................................................. 4812
109.7 Importing Sigma Data into Building Operation ......................... 4813
109.8 Functions Available after Import ............................................... 4814
109.9 Sigma Programming ............................................................... 4816
109.10 Sigma Interface ....................................................................... 4817
109.10.1 Sigma Representation ........................................................... 4817
109.10.2 Object Types ........................................................................ 4817
109.11 Creating a Sigma Interface ...................................................... 4819
109.12 Configuring a Sigma Interface ................................................. 4820
109.13 Sigma Representation ............................................................. 4823
109.13.1 Controllers ............................................................................ 4823
109.13.2 Segments ............................................................................. 4825
109.14 Creating a Segment ................................................................ 4826
109.15 Sigma Networks ..................................................................... 4827
109.15.1 Sigma Network Protocols ..................................................... 4827
109.15.2 Sigma Network Connectivity ................................................. 4828
110 Sigma Devices ......................................................... 4831
110.1 Sigma Devices ........................................................................ 4833
110.1.1 Global Values Device ............................................................. 4833
110.1.2 Controller Diagnostics ........................................................... 4833
04-16006-04-en, March 2015 Technical
91
110.1.3 Device Monitoring ................................................................. 4834
110.2 Configuring a Sigma Device .................................................... 4835
110.3 Controller Diagnostics ............................................................. 4836
110.3.1 Controller Time ..................................................................... 4836
110.3.2 Log Set Statistics .................................................................. 4836
110.3.3 Network Communications Statistics ...................................... 4836
110.3.4 Node Statistics ..................................................................... 4836
110.3.5 Sigma Diagnostics ................................................................ 4837
110.4 Retiming a Controller ............................................................... 4838
110.5 Setting a Controller Online ....................................................... 4839
110.6 Log Set Statistics .................................................................... 4840
110.7 Network Communication Statistics .......................................... 4841
110.8 Resetting Network Communication Statistics .......................... 4842
110.9 Node Statistics ........................................................................ 4843
110.10 Device Monitoring ................................................................... 4844
111 Sigma Objects ......................................................... 4845
111.1 Sigma Objects ........................................................................ 4847
111.1.1 Sigma Hardware Objects ...................................................... 4847
111.1.2 Sigma Software Objects ........................................................ 4847
111.1.3 Graphics ............................................................................... 4847
111.1.4 Log Sets ............................................................................... 4848
111.1.5 Contingency Logs ................................................................. 4848
111.1.6 Sigma Text Reports .............................................................. 4848
111.1.7 Global Values ........................................................................ 4848
111.1.8 Alarms .................................................................................. 4848
111.1.9 Time Extensions .................................................................... 4849
111.1.10 Sigma Values and Reasons for State ..................................... 4849
111.2 Sigma Values and Reasons for State ....................................... 4850
111.3 Configuring a Sigma Object ..................................................... 4853
111.4 Sigma Hardware Objects ........................................................ 4854
111.4.1 Analog Input ......................................................................... 4854
111.4.2 Analog Output ...................................................................... 4854
111.4.3 Digital Input ........................................................................... 4854
111.4.4 Digital Output ........................................................................ 4854
111.4.5 Meter .................................................................................... 4854
111.4.6 Pulse Counter ....................................................................... 4855
111.4.7 Standby Generator ............................................................... 4855
111.5 Analog Output ......................................................................... 4856
111.6 Digital Output .......................................................................... 4857
111.7 Creating a Digital Output Edge Trigger Pulse ........................... 4858
111.8 Sigma Software Objects ......................................................... 4859
111.8.1 Calculation Object ................................................................. 4859
111.8.2 Control Object ...................................................................... 4859
111.8.3 Degree Day ........................................................................... 4859
111.8.4 Holiday Schedule .................................................................. 4860
111.8.5 Optimizer .............................................................................. 4860
Technical 04-16006-04-en, March 2015
92
111.8.6 Programmable Object ........................................................... 4860
111.8.7 Rotation ................................................................................ 4860
111.8.8 Setpoint Adjust ..................................................................... 4861
111.8.9 Time Schedule ...................................................................... 4861
111.9 Control Object ........................................................................ 4862
111.10 Configuring a Control Stage .................................................... 4864
111.11 Holiday Schedule .................................................................... 4865
111.12 Optimizer ................................................................................ 4866
111.13 Configuring an Optimizer ......................................................... 4867
111.14 Setpoint Adjust Object ............................................................ 4869
111.15 Configuring a Setpoint Adjust Object ....................................... 4870
111.16 Rotation Object ....................................................................... 4872
111.17 Configuring a Rotation Object ................................................. 4873
111.18 Programmable Object ............................................................. 4874
111.19 Configuring a Programmable Object ........................................ 4875
111.20 Sigma Time Schedules ............................................................ 4876
111.21 Adding an Event to a Sigma Time Schedule ............................ 4877
111.22 Overriding a Time Schedule ..................................................... 4878
111.23 Time Extensions ...................................................................... 4879
111.24 Editing a Time Extension ......................................................... 4880
112 Graphics .................................................................. 4881
112.1 Graphics ................................................................................. 4883
112.2 Configuring the Graphics Folder .............................................. 4887
113 Sigma Logging ......................................................... 4889
113.1 Log Sets ................................................................................. 4891
113.1.1 Log Set Types and Configuration .......................................... 4892
113.1.2 Logs ..................................................................................... 4892
113.1.3 Log Set Workflow ................................................................. 4892
113.2 Log Set Workflow ................................................................... 4893
113.3 Configuring the Log Sets Folder .............................................. 4895
113.4 Creating a Log Set .................................................................. 4896
113.5 Configuring a Log Set ............................................................. 4897
113.6 Creating a Log ........................................................................ 4899
113.7 Configuring a Log .................................................................... 4900
113.8 Associating a Log with an Extended Trend Log ....................... 4901
113.9 Sending Log Sets and Retrieving Logged Values ..................... 4902
113.10 Contingency Logs ................................................................... 4903
113.11 Viewing a Contingency Log Chart or List ................................. 4904
113.12 Configuring a Contingency Log ............................................... 4905
114 Sigma Text Reports ................................................. 4907
114.1 Sigma Text Reports ................................................................ 4909
114.1.1 Sigma Active Alarms Report .................................................. 4909
114.1.2 Sigma Hours Run Report ...................................................... 4909
114.1.3 Sigma Plant Review Report ................................................... 4909
114.1.4 Sigma Report Text Report ..................................................... 4909
04-16006-04-en, March 2015 Technical
93
114.1.5 Sigma Diagnostics Text Reports ........................................... 4909
114.2 Sigma Active Alarms Report .................................................... 4910
114.3 Sigma Hours Run Report ........................................................ 4911
114.4 Sigma Plant Review Report ..................................................... 4912
114.5 Sigma Report Text Report ....................................................... 4914
114.6 Sigma Diagnostics Text Reports ............................................. 4916
114.6.1 Sigma Diagnostics Controller Time Report ............................ 4916
114.6.2 Sigma Diagnostics Log Set Statistics Report ......................... 4916
114.6.3 Sigma Diagnostics Node Statistics Report ............................ 4917
114.7 Creating a Sigma Diagnostics Text Report .............................. 4919
115 Global Values ........................................................... 4921
115.1 Global Values .......................................................................... 4923
115.1.1 Global Values in Sigma .......................................................... 4923
115.1.2 Global Values from Sigma ..................................................... 4924
115.1.3 Global Values to Sigma ......................................................... 4924
115.1.4 Global Values Workflows ....................................................... 4924
115.2 Global Values from Sigma ....................................................... 4925
115.3 Global Values to Sigma ........................................................... 4927
115.4 Global Values Workflows ......................................................... 4929
115.4.1 Global Values from Sigma ..................................................... 4929
115.4.2 Global Values to Sigma ......................................................... 4930
115.5 Creating a Global Values Device .............................................. 4932
115.6 Configuring a Global Values Device ......................................... 4933
115.7 Creating a Global Value ........................................................... 4934
115.8 Configuring a Global Value ...................................................... 4936
116 Sigma Alarms .......................................................... 4937
116.1 Alarms .................................................................................... 4939
116.1.1 Alarm Types .......................................................................... 4939
116.1.2 Alarm Creation and Acknowledgement ................................. 4940
116.1.3 Routing of Alarms ................................................................. 4940
116.1.4 Alarm Enable, Inhibit, and Edit ............................................... 4940
116.1.5 Audible Alarm Warnings ........................................................ 4940
116.1.6 Precancellation and Cancellation of Hours Limit Alarms ......... 4941
116.1.7 Alarm Status ......................................................................... 4941
116.2 Configuring a Sigma Alarm ...................................................... 4943
116.3 Enabling or Inhibiting an Alarm ................................................ 4945
116.4 Precancelling or Cancelling an Hours Limit Alarm .................... 4946
117 Sigma User Interface ................................................ 4947
117.1 Sigma Interface Properties – Basic Tab ................................... 4951
117.2 Sigma Interface Properties – Advanced Tab ............................ 4953
117.3 Sigma System Tree Icons ........................................................ 4955
117.4 Data Import Dialog Box ........................................................... 4957
117.5 Actions Menu - Sigma Diagnostics Submenu .......................... 4958
117.6 Controllers Folder Properties – Basic Tab ................................ 4959
117.7 Sigma Device Properties – Basic Tab ...................................... 4960
Technical 04-16006-04-en, March 2015
94
117.8 Device Port Properties – Basic Tab ......................................... 4962
117.9 Diagnostics Folder Properties – Basic Tab .............................. 4963
117.10 Controller Time Properties – Basic Tab .................................... 4964
117.11 Log Set Statistics Properties – Basic Tab ................................ 4965
117.12 Network Communication Statistics Properties – Basic Tab ...... 4967
117.13 Network Communication Statistics Properties – Packets Tab .. 4969
117.14 Network Communication Statistics Properties – Subscriptions
Tab ......................................................................................... 4971
117.15 Network Communication Statistics Properties – Alarms Tab .... 4973
117.16 Network Communication Statistics Properties – Logs Tab ....... 4975
117.17 Network Communication Statistics Properties – File Operations
Tab ......................................................................................... 4976
117.18 Network Communication Statistics Properties – Advanced
Tab ......................................................................................... 4978
117.19 Network Communication Statistics Properties – Debug Tab .... 4979
117.20 Node Statistics Properties – Basic Tab .................................... 4981
117.21 Node Statistics Properties – Ports Tab .................................... 4983
117.22 Node Statistics Properties – Entity Buffers Tab ........................ 4985
117.23 Node Statistics Properties – Data Buffers Tab ......................... 4987
117.24 Node Statistics Properties – Message Queues Tab ................. 4989
117.25 Node Statistics Properties – Data Queues Tab ........................ 4991
117.26 x96 Device Slot Properties – Basic Tab ................................... 4992
117.27 Analog Input Properties – Basic Tab ........................................ 4993
117.28 Analog Output Properties – Basic Tab ..................................... 4995
117.29 Digital Input Properties – Basic Tab ......................................... 4996
117.30 Digital Output Properties – Basic Tab ...................................... 4998
117.31 Control Properties – Basic Tab ................................................ 5000
117.32 Control Stage Properties – Basic Tab ...................................... 5001
117.33 Degree Day Properties – Basic Tab ......................................... 5003
117.34 Edge Trigger Pulse Properties – Basic Tab .............................. 5004
117.35 Calculation Object Properties – Basic Tab ............................... 5005
117.36 Time Schedule Properties – Basic Tab .................................... 5007
117.37 Time Extension Properties – Basic Tab .................................... 5008
117.38 Holiday Schedule Properties – Basic Tab ................................ 5009
117.39 Schedule Editor View .............................................................. 5010
117.40 Sigma Schedule Event Properties Dialog Box .......................... 5011
117.41 Meter Properties – Basic Tab .................................................. 5012
117.42 Optimizer Properties – Basic Tab ............................................ 5014
117.43 Optimizer Heating Linear Properties – Basic Tab ..................... 5016
117.44 Optimizer Heating Logarithmic Properties – Basic Tab ............ 5017
117.45 Optimizer Cooling Linear Properties – Basic Tab ..................... 5018
117.46 Optimizer Cooling Logarithmic Properties – Basic Tab ............. 5019
117.47 Pulse Counter Properties – Basic Tab ..................................... 5020
117.48 Rotation Object Properties – Basic Tab ................................... 5022
117.49 Setpoint Adjust Properties – Basic Tab ................................... 5023
117.50 Secondary Input Properties – Basic Tab .................................. 5024
117.51 Standby Generator Properties – Basic Tab .............................. 5026
04-16006-04-en, March 2015 Technical
95
117.52 Programmable Object Properties – Basic Tab ......................... 5027
117.53 Sigma Object Properties – Advanced Tab ............................... 5029
117.54 Alarm Properties – Basic Tab .................................................. 5030
117.55 Alarm Properties – Alarm Tab .................................................. 5032
117.56 Alarm Properties – Advanced Tab ........................................... 5033
117.57 Contingency Log Properties – Basic Tab ................................. 5034
117.58 Global Values Device Properties – Basic Tab ........................... 5035
117.59 Analog Input Global Value Properties – Basic Tab ................... 5036
117.60 Analog Output Global Value Properties – Basic Tab ................ 5037
117.61 Digital Input Global Value Properties – Basic Tab ..................... 5038
117.62 Digital Output Global Value Properties – Basic Tab .................. 5039
117.63 Analog and Digital Input Global Value Properties – Advanced
Tab ......................................................................................... 5040
117.64 Graphics Folder Properties – Basic Tab ................................... 5041
117.65 Graphics Subfolder Properties – Basic Tab ............................. 5042
117.66 Graphics Item Context Menu ................................................... 5043
117.67 Graphics Item Context Menu – Commands Submenu ............. 5044
117.68 Graphics Item Context Menu – View Submenu ........................ 5046
117.69 Log Sets Folder Properties – Basic Tab ................................... 5047
117.70 Change of Value Log Set Folder Properties – Basic Tab .......... 5048
117.71 Change of Value Log Set Folder Properties – Advanced Tab ... 5049
117.72 Interval Log Set Folder Properties – Basic Tab ......................... 5051
117.73 Interval Log Set Folder Properties – Advanced Tab ................. 5052
117.74 Extended Logs Folder Properties – Basic Tab ......................... 5054
117.75 Log Properties – Basic Tab ..................................................... 5055
117.76 Segments Folder Properties – Basic Tab ................................. 5056
117.77 Segments Subfolder Properties – Basic Tab ........................... 5057
117.78 Text Reports Folder Properties – Basic Tab ............................. 5058
117.79 Text Report Properties – Basic Tab ......................................... 5059
118 Web Services ........................................................... 5061
118.1 Web Services Overview .......................................................... 5063
118.1.1 Web Services ........................................................................ 5063
118.1.2 EcoStruxure Web Services .................................................... 5063
118.2 Web Services ......................................................................... 5064
118.2.1 Script Web Services .............................................................. 5065
118.2.2 Simple XML Web Service ...................................................... 5065
118.2.3 SOAP Web Service ............................................................... 5065
118.2.4 Limitations ............................................................................ 5066
118.2.5 Manually Created Values ....................................................... 5066
118.2.6 Time Stamp Values ............................................................... 5067
118.3 Creating a SOAP Web Service Interface .................................. 5068
118.4 Creating a Simple XML Web Service Interface ......................... 5072
118.5 Adding a New Value to the Web Service Interface ................... 5075
118.6 Changing the XPath for a Value .............................................. 5077
119 Web Services User Interface .................................... 5079
119.1 SOAP Web Service – Basic tab .............................................. 5081
Technical 04-16006-04-en, March 2015
96
119.2 SOAP Web Service – Advanced Tab ...................................... 5083
119.3 SOAP Web Service Wizard – Select SOAP Operation Page ..... 5084
119.4 SOAP Web Service Wizard - Connection Information Page ..... 5085
119.5 SOAP Web Service Wizard – Create Web Service Values ........ 5087
119.6 Simple XML Web Service – Basic Tab ..................................... 5088
119.7 Simple XML Web Service – Advanced Tab .............................. 5090
119.8 Simple XML Web Service Wizard – Connection Information ..... 5091
119.9 Simple XML Web Service Wizard – Create Web Service
Values ..................................................................................... 5093
119.10 Web Service Analog Value Properties – Basic Tab ................... 5094
119.11 Web Service Analog Value Properties – Advanced Tab ............ 5095
119.12 Web Service Multistate Value Properties – Basic Tab .............. 5096
119.13 Web Service Multistate Value Properties – Advanced Tab ....... 5097
119.14 Web Service Digital Value Properties – Basic Tab .................... 5098
119.15 Web Service Digital Value Properties – Advanced Tab ............. 5099
119.16 Web Service String Value Properties – Basic Tab .................... 5100
119.17 Web Service String Value Properties – Advanced Tab ............. 5101
119.18 Web Service Time Stamp Value Properties – Basic Tab ........... 5102
119.19 Web Service Time Stamp Value Properties – Advanced Tab .... 5103
119.20 Create Web Service Value Wizard – Select XPath Page ........... 5104
119.21 XPath Editor ............................................................................ 5105
120 Web Services Troubleshooting ................................. 5107
120.1 The Create Web Service Values Page in the Wizard is Empty .. 5109
120.1.1 Solution ................................................................................ 5109
120.1.2 ............................................................................................. 5109
120.2 SOAP Web Service Interface Cannot be Created .................... 5110
120.2.1 Solution ................................................................................ 5110
120.2.2 Solution ................................................................................ 5110
121 Corporate Web Services .......................................... 5111
121.1 EcoStruxure Web Services ...................................................... 5113
121.1.1 EcoStruxure Web Service Server ........................................... 5113
121.1.2 EcoStruxure Web Service Client ............................................ 5113
121.2 EcoStruxure Web Service Server ............................................ 5114
121.2.1 Visibility of Folders and Object Types ..................................... 5114
121.2.2 Client User Access ................................................................ 5114
121.3 Visibility of Folders and Object Types ...................................... 5115
121.3.1 Path Filter ............................................................................. 5115
121.3.2 Object Type Filter ................................................................. 5116
121.4 Configuring the EcoStruxure Web Service Server ................... 5117
121.5 Filtering the Hardware Folder by Path ...................................... 5119
121.6 Filtering the Hardware Folder by Object Type .......................... 5122
121.7 EcoStruxure Web Service Client .............................................. 5126
121.7.1 Filter Alarms Using the Alarm Event Types Object .................. 5129
121.7.2 EcoStruxure Web Service Alarm Item .................................... 5129
121.7.3 History Item .......................................................................... 5129
121.7.4 Common EcoStruxure Web Service Object Properties .......... 5129
04-16006-04-en, March 2015 Technical
97
121.7.5 Forced Values ....................................................................... 5129
121.7.6 Host Values in Graphics and Watch Panes ............................ 5130
121.8 EcoStruxure Web Service Alarm Item ...................................... 5131
121.9 Filter Alarms Using the Alarm Event Types Object .................... 5132
121.10 Common EcoStruxure Web Service Object Properties ............ 5134
121.10.1 EcoStruxure Web Service Identity ......................................... 5134
121.10.2 State ..................................................................................... 5134
121.11 Creating an EcoStruxure Web Service Interface ...................... 5136
121.12 Creating an EcoStruxure Web Service Object .......................... 5138
121.13 Enabling History Polling ........................................................... 5140
121.14 Filtering Alarms by Category .................................................... 5141
122 Corporate Web Services User Interface .................... 5143
122.1 EcoStruxure Web Service Interface Properties – Basic Tab ..... 5145
122.2 EWS Server Properties – Basic Tab ......................................... 5147
122.3 EWS Device Properties – Basic Tab ........................................ 5148
122.4 EWS Structure Properties – Basic Tab .................................... 5149
122.5 EWS Folder Properties – Basic Tab ......................................... 5150
122.6 EWS Integer Value Properties – Basic Tab .............................. 5151
122.7 EWS String Value Properties – Basic Tab ................................ 5153
122.8 EWS Long Value Properties – Basic Tab ................................. 5155
122.9 EWS DateTime Value Properties – Basic Tab .......................... 5157
122.10 EWS Boolean Value Properties – Basic Tab ............................ 5159
122.11 EWS Double Value Properties – Basic Tab .............................. 5161
122.12 EWS History Item Properties – Basic Tab ................................ 5163
122.13 EWS Alarm Item Properties – Basic Tab .................................. 5165
122.14 EWS Alarm Item Properties – Advanced Tab ........................... 5167
122.15 EWS Alarm Item – Configuration Tab ...................................... 5169
122.16 EWS Alarm Item - Presentation Tab ........................................ 5170
122.17 Alarm Event Types Properties ................................................. 5172
122.18 Alarm Event Types Configuration Settings Dialog ..................... 5173
122.19 EWS Server Configuration – Basic Tab .................................... 5174
122.20 EWS Server Configuration – Filter Hardware Folder Tab .......... 5176
122.21 EWS Consume Configuration Properties ................................. 5178
122.22 Create Object EcoStruxure Web Service Wizard – Connection
Information ............................................................................. 5179
123 Security ................................................................... 5181
123.1 Security Overview .................................................................. 5183
123.1.1 Firewall ................................................................................. 5183
123.1.2 Password Policy ................................................................... 5183
123.1.3 Automatic Log Off ................................................................. 5183
123.1.4 Security Banner .................................................................... 5183
123.1.5 Certificates ........................................................................... 5183
123.1.6 Encrypted Communication .................................................... 5183
123.1.7 Web Server Access Logging ................................................. 5184
123.1.8 Automation Server Remote System Logging ......................... 5184
123.1.9 SmartStruxure Connect ........................................................ 5184
Technical 04-16006-04-en, March 2015
98
123.1.10 DIACAP ................................................................................ 5184
123.2 DIACAP .................................................................................. 5185
123.2.1 Files with SGID or SUID Bits Set ............................................ 5185
123.2.2 Accounts .............................................................................. 5185
123.2.3 Disable HTTP ........................................................................ 5185
123.2.4 High Security Encryption ....................................................... 5186
123.2.5 Web Services and EcoStruxure Web Service ......................... 5186
123.2.6 Software Version on the Automation Server ........................... 5186
123.2.7 Authenticated Network Time ................................................. 5186
123.2.8 Disable Dynamic Domain Name Service Updates .................. 5186
123.2.9 Disable Dynamic Host Configuration Protocol ....................... 5186
123.2.10 Domain Name Service Configuration ..................................... 5187
123.2.11 CA Certificate Installation ...................................................... 5187
123.2.12 Web Server Ports .................................................................. 5187
123.2.13 Password Policies ................................................................. 5187
123.2.14 DoD Logon Banner ............................................................... 5187
123.2.15 Disable Error Reporting to Schneider Electric ........................ 5187
123.2.16 Enable Automation Server Remote Logging ......................... 5187
123.2.17 Enable Access Logging for SNMP ......................................... 5188
123.2.18 IP Whitelist Configuration ...................................................... 5188
123.2.19 Disable SNMP ....................................................................... 5188
123.2.20 SSH Lockout Time ................................................................ 5188
123.2.21 Enable Access Logging for HTTP .......................................... 5188
123.2.22 Virus Protection Routines ...................................................... 5188
123.3 Firewall ................................................................................... 5189
123.4 Adding a Device to the Whitelist .............................................. 5190
123.5 Removing a Device from the Whitelist ...................................... 5192
123.6 Password Policy ..................................................................... 5193
123.7 Configuring the Password Policy ............................................. 5194
123.8 Security Banner ..................................................................... 5196
123.9 Adding a Security Banner ....................................................... 5197
123.10 Certificates ............................................................................. 5198
123.10.1 Default Certificates ................................................................ 5198
123.10.2 Self-Signed Certificate ........................................................... 5198
123.10.3 CA Certificates ...................................................................... 5198
123.10.4 Status of Certificate ............................................................... 5198
123.11 Adding a Certificate ................................................................. 5199
123.12 Generating a Certificate ........................................................... 5202
123.13 Activating a Certificate ............................................................. 5206
123.14 Removing a Certificate ............................................................ 5208
123.15 Checking the Status of the Certificate ...................................... 5210
123.16 Encrypted Communication ...................................................... 5211
123.16.1 Disable HTTP Communication .............................................. 5211
123.16.2 Disable MD5 Encryption ........................................................ 5211
123.16.3 Redirect Web Client to HTTPS .............................................. 5211
123.17 Disabling Incoming HTTP Communication ............................... 5212
123.18 Disabling MD5 Encryption ....................................................... 5214
04-16006-04-en, March 2015 Technical
99
123.19 Setting the SSH Console Lockout Time ................................... 5216
123.20 Redirecting Web Clients to HTTPS .......................................... 5217
123.21 Web Server Access Logging ................................................... 5219
123.22 Enabling Web Server Access Logging ..................................... 5220
123.23 Automation Server Remote System Logging ........................... 5222
123.24 Enabling Automation Server Remote System Logging ............. 5223
123.25 Checking the Software Version on the Automation Server Using
Device Administrator ............................................................... 5225
123.26 Checking the Software Version on the Automation Server Using
WorkStation ............................................................................ 5226
123.27 Enabling Access Logging for SNMP ........................................ 5227
123.28 Disabling Dynamic Host Configuration Protocol (DHCP) .......... 5228
123.29 Disable Dynamic Domain Name System (DNS) Updates .......... 5229
123.30 Disabling SNMP for Managing an Automation Server ............... 5230
124 Security User Interface ............................................. 5231
124.1 Password Policy Manager ....................................................... 5233
124.2 Password Rules Dialog Box .................................................... 5235
124.3 Security Certificate Risk Dialog Box ......................................... 5236
124.4 Certificates Tab ....................................................................... 5237
124.5 Manage Certificates Dialog Box ............................................... 5238
124.6 Add Certificate Dialog Box ...................................................... 5239
124.7 Generate Certificate Dialog Box ............................................... 5240
124.8 Edit Banner – Dialog Box ........................................................ 5242
124.9 Security Settings – Control Panel ............................................ 5243
125 TAC Vista Conversion .............................................. 5247
125.1 Vista Conversion Overview ...................................................... 5249
125.1.1 Prepare for Conversion ......................................................... 5251
125.1.2 Vista and Building Operation System Architecture
Differences ........................................................................... 5251
125.1.3 Vista Conversion Workflow .................................................... 5251
125.1.4 Vista Database Analysis ........................................................ 5251
125.1.5 Vista to SBO Conversion ....................................................... 5251
125.1.6 Revision Table ....................................................................... 5251
125.1.7 Manual Vista Conversion Engineering Work ........................... 5252
125.2 Prepare for Conversion ........................................................... 5253
125.3 Vista and Building Operation System Architecture Differences . 5254
125.4 Vista Conversion Workflow ...................................................... 5255
125.5 Vista Database Analysis ......................................................... 5257
125.5.1 Analysis Report ..................................................................... 5257
125.5.2 Key File ................................................................................. 5258
125.6 Key File ................................................................................... 5259
125.7 Analyzing the Vista Database Export File ................................. 5260
125.8 Analyzing the Vista Database File Using a Sub-Project ............ 5264
125.9 Filtering Projects and Sub-Projects ......................................... 5269
125.10 Vista to SBO Conversion ......................................................... 5270
125.10.1 Certificates ........................................................................... 5270
Technical 04-16006-04-en, March 2015
100
125.10.2 Key File ................................................................................. 5270
125.10.3 Conversion Report ................................................................ 5270
125.10.4 Partially Converted Objects ................................................... 5271
125.10.5 Database Export ................................................................... 5271
125.10.6 Revision Table ....................................................................... 5271
125.11 Partially Converted Objects ..................................................... 5272
125.12 Converting the Vista Database Export File ............................... 5273
125.13 Exporting the Database Using TAC Vista to SBO Conversion
Tool ........................................................................................ 5274
125.14 Manual Vista Conversion Engineering Work ............................. 5277
125.15 Revision Table ......................................................................... 5279
125.16 Transition Portal ...................................................................... 5282
125.17 Transition Portal - Project Page ............................................... 5284
125.18 Add Sub-Project to Project Dialog Box ................................... 5286
125.19 Add Upload to Project Dialog Box .......................................... 5287
125.20 Transition Portal - Project Page Uploads ................................. 5288
125.21 Transition Portal - Project Page Sub-Projects .......................... 5290
125.22 Transition Portal - Sub-Project Page Uploads .......................... 5292
125.23 Vista to SBO Analysis Report .................................................. 5293
125.24 TAC Vista to SBO Conversion Tool .......................................... 5296
125.25 Vista to SBO Conversion Report ............................................. 5298
126 Spreadsheet View .................................................... 5303
126.1 Spreadsheet Overview ............................................................ 5305
126.1.1 Configuration Types .............................................................. 5305
126.1.2 Autofill .................................................................................. 5306
126.1.3 Navigation ............................................................................ 5306
126.1.4 Selection .............................................................................. 5307
126.1.5 Editing .................................................................................. 5307
126.1.6 Shortcut Keys ....................................................................... 5307
126.2 Creating Multiple Objects ........................................................ 5309
126.3 Configuring Multiple Objects .................................................... 5311
126.4 Copying from MS Excel to Spreadsheet View .......................... 5312
126.5 Copying from Spreadsheet View to MS Excel .......................... 5314
127 Spreadsheet View User Interface ............................. 5317
127.1 Spreadsheet View ................................................................... 5319
127.2 Failed to Paste Data Dialog Box .............................................. 5321
128 Text Reports ............................................................ 5323
128.1 Text Reports Overview ............................................................ 5325
128.1.1 Text Reports ......................................................................... 5325
128.1.2 Types of Text Reports ........................................................... 5325
128.1.3 Text Report Groups .............................................................. 5325
128.2 Text Reports ........................................................................... 5326
128.3 Types of Text Reports ............................................................. 5328
128.3.1 I/A Series Text Reports ......................................................... 5328
128.3.2 Sigma Text Reports .............................................................. 5328
04-16006-04-en, March 2015 Technical
101
128.4 I/A Series Text Reports ........................................................... 5329
128.4.1 I/A Series Flow Balance Report ............................................. 5329
128.4.2 I/A Series S-Link Calibration Report ....................................... 5329
128.4.3 I/A Series Analog Input Calibration Report ............................. 5329
128.5 I/A Series Flow Balance Report ............................................... 5330
128.6 I/A Series S-Link Calibration Report ......................................... 5331
128.7 I/A Series Analog Input Calibration Report ............................... 5332
128.8 Sigma Text Reports ................................................................ 5335
128.8.1 Sigma Active Alarms Report .................................................. 5335
128.8.2 Sigma Hours Run Report ...................................................... 5335
128.8.3 Sigma Plant Review Report ................................................... 5335
128.8.4 Sigma Report Text Report ..................................................... 5335
128.8.5 Sigma Diagnostics Text Reports ........................................... 5335
128.9 Sigma Active Alarms Report .................................................... 5336
128.10 Sigma Hours Run Report ........................................................ 5337
128.11 Sigma Plant Review Report ..................................................... 5338
128.12 Sigma Report Text Report ....................................................... 5340
128.13 Sigma Diagnostics Text Reports ............................................. 5342
128.13.1 Sigma Diagnostics Controller Time Report ............................ 5342
128.13.2 Sigma Diagnostics Log Set Statistics Report ......................... 5342
128.13.3 Sigma Diagnostics Node Statistics Report ............................ 5343
128.14 Creating a Text Report ............................................................ 5345
128.15 Configuring a Text Report ....................................................... 5346
128.16 Viewing a Text Report ............................................................. 5347
128.17 Clearing a Text Report ............................................................ 5348
128.18 Printing a Text Report ............................................................. 5349
128.19 Exporting a Text Report .......................................................... 5350
129 Text Report Groups ................................................. 5351
129.1 Text Report Groups ................................................................ 5353
129.2 Creating a Text Report Group ................................................. 5354
129.3 Configuring a Text Report Group ............................................. 5355
129.4 Viewing a Text Report from a Text Report Group ..................... 5356
130 Text Reports User Interface ...................................... 5357
130.1 Text Reports Icons .................................................................. 5359
130.2 Text Report Properties – Basic Tab ......................................... 5360
130.3 Text Report Group Properties – Basic Tab .............................. 5361
130.4 Text Report View ..................................................................... 5362
130.5 Text Report View Toolbar ........................................................ 5364
131 Installation Troubleshooting ...................................... 5365
131.1 Enterprise Server does not Start .............................................. 5367
131.1.1 Solutions .............................................................................. 5367
132 Alarms Troubleshooting ........................................... 5369
132.1 Alarm Is Not Displayed in the Alarms Pane and Alarm View ..... 5371
132.1.1 Solutions .............................................................................. 5371
Technical 04-16006-04-en, March 2015
102
132.2 Event Is Not Displayed in the Events Pane and Event View ...... 5372
132.2.1 Solution ................................................................................ 5372
132.3 Notification E-mail Is Not Received .......................................... 5374
132.3.1 Solutions .............................................................................. 5374
132.4 The Alarm Is Disabled and Cannot Be Enabled ....................... 5375
132.4.1 Solutions .............................................................................. 5375
132.5 User Cannot Be Assigned to an Alarm .................................... 5376
132.5.1 Solution ................................................................................ 5376
132.6 A Category Cannot Be Edited ................................................. 5377
132.6.1 Solution ................................................................................ 5377
132.7 Cause Note Cannot Be Edited ................................................ 5378
132.7.1 Solution ................................................................................ 5378
132.8 Action Note Cannot Be Edited ................................................ 5379
132.8.1 Solution ................................................................................ 5379
132.9 Checklist Cannot Be Edited .................................................... 5380
132.9.1 Solution ................................................................................ 5380
133 Alarms Deep Technical Reference ............................ 5381
133.1 Hidden Alarms with Normal State ............................................ 5383
133.2 Basic Evaluation State ............................................................. 5384
134 Trends Troubleshooting ........................................... 5385
134.1 Trend Log Does Not Start Record Due to the Start Condition .. 5387
134.1.1 Solutions .............................................................................. 5387
134.2 Meter Trend Log Calculation Fails ........................................... 5388
134.2.1 Solution ................................................................................ 5388
134.3 Missing Trend Log Records .................................................... 5390
134.3.1 Solutions .............................................................................. 5390
134.4 Illogical or Missing Records in the Trend Log List ..................... 5391
134.4.1 Solutions .............................................................................. 5391
134.5 Trend Chart Does Not Show Trend Log Series ....................... 5392
134.5.1 Solutions .............................................................................. 5392
134.6 Interrupted Series in the Trend Chart ....................................... 5393
134.6.1 Solution ................................................................................ 5393
134.7 Trend Chart Y-Axis has Scale Problems .................................. 5394
134.7.1 Solutions .............................................................................. 5394
134.8 Trend Chart Live Update does not Work ................................. 5395
134.8.1 Solutions .............................................................................. 5395
134.9 Records Are Not Transferred to the Extended Trend Log ........ 5396
134.9.1 Solution ................................................................................ 5396
134.10 Cannot Delete Trend Log or Its Container ................................ 5397
134.10.1 Solution ................................................................................ 5397
135 Trends Deep Technical Reference ............................ 5399
135.1 Trend Log Tick ........................................................................ 5401
135.2 Block Transfer ......................................................................... 5402
135.3 Smart Log ............................................................................... 5403
04-16006-04-en, March 2015 Technical
103
136 Schedules Troubleshooting ...................................... 5405
136.1 Using Schedules to Control BACnet Multistate Objects ........... 5407
136.1.1 Solution ................................................................................ 5407
136.2 Exception Event Does Not Delete ............................................ 5408
136.2.1 Solution ................................................................................ 5408
137 User Management Troubleshooting ......................... 5409
137.1 Wrong Domain, User Name or Password ................................ 5411
137.1.1 Solutions .............................................................................. 5411
137.2 Server is not Available ............................................................. 5412
137.2.1 Solutions .............................................................................. 5412
137.3 Failed to Establish Connection ................................................ 5413
137.3.1 Solutions .............................................................................. 5413
137.4 User Account has been Disabled ............................................ 5414
137.4.1 Solution ................................................................................ 5414
137.5 User Account Has Expired ...................................................... 5417
137.5.1 Solution ................................................................................ 5417
137.6 Your Account Has Insufficient Permissions to Use the System . 5419
137.6.1 Solutions .............................................................................. 5419
137.7 Logon Button Greyed Out ....................................................... 5420
137.7.1 Solution ................................................................................ 5420
137.8 Cannot Close WorkStation ...................................................... 5421
137.8.1 Solution ................................................................................ 5421
137.9 Workspace Layout Changes Have Disappeared ...................... 5423
137.9.1 Solutions .............................................................................. 5423
137.10 Can not Access Servers or Folders that You Earlier had Access
to ............................................................................................ 5424
137.10.1 Solution ................................................................................ 5424
137.11 User Session Has Expired ....................................................... 5425
137.11.1 Solution ................................................................................ 5425
137.12 Windows Group Name List Is Empty ....................................... 5426
137.12.1 Solution ................................................................................ 5426
138 WorkStation Troubleshooting ................................... 5427
138.1 Cannot Mass Create Trend Logs or Alarms ............................. 5429
138.1.1 Solution ................................................................................ 5429
138.2 Main Menu Cannot be Displayed ............................................. 5430
138.2.1 Solution ................................................................................ 5430
139 Licensing Troubleshooting ....................................... 5431
139.1 Unable to Check Out License .................................................. 5433
139.1.1 Solutions .............................................................................. 5433
139.2 Problem with the Licenses on the License Server ................... 5434
139.2.1 Solutions .............................................................................. 5434
139.3 Network Licenses are Broken ................................................. 5435
139.3.1 Solution ................................................................................ 5435
139.4 Unable to Activate or Return a License ................................... 5437
139.4.1 Solutions .............................................................................. 5437
Technical 04-16006-04-en, March 2015
104
139.5 Opening the Transaction Error Dialog Box ............................... 5438
139.6 Cannot Access lmadmin, License Server Manager .................. 5439
139.6.1 Solutions .............................................................................. 5439
139.7 The License Server does not Automatically Restart ................. 5440
139.7.1 Solution ................................................................................ 5440
140 Licensing Deep Technical Reference ........................ 5443
140.1 Trusted Storage ...................................................................... 5445
140.2 License Activation Server Registry Key .................................... 5446
140.3 Stored License Server Addresses ......................................... 5447
141 Localization Troubleshooting .................................... 5449
141.1 WorkStation does not Display Correct Values .......................... 5451
141.1.1 Solution ................................................................................ 5451
141.2 Enterprise Server does not Synchronize its Clock ................... 5452
141.2.1 Solution ................................................................................ 5452
141.3 Incorrect Time Stamps in WorkStation .................................... 5453
141.3.1 Solution ................................................................................ 5453
141.4 Delta Temperature Conversion is Incorrect .............................. 5454
141.4.1 Solution ................................................................................ 5454
142 Connect Agent Troubleshooting ............................... 5459
142.1 System and crash information not available on Connect storage
server ..................................................................................... 5461
142.1.1 Solution ................................................................................ 5461
143 WebReports Troubleshooting .................................. 5463
143.1 WebReports Read Failure ....................................................... 5465
143.1.1 Solution ................................................................................ 5465
143.2 Authentication Failed ............................................................... 5466
143.2.1 Solution ................................................................................ 5466
143.3 Could not Connect to Reports Database ................................. 5467
143.3.1 Solution ................................................................................ 5467
144 Project Configuration Server Troubleshooting ........... 5469
144.1 WorkStation for Projects User Account has been Disabled ...... 5471
144.1.1 Solution ................................................................................ 5471
144.2 WorkStation for Projects User Account Has Expired ................ 5472
144.2.1 Solution ................................................................................ 5472
144.3 Project Configuration Server does not Start ............................. 5473
144.3.1 Solution ................................................................................ 5473
144.4 User Session Has Expired ....................................................... 5474
144.4.1 Solution ................................................................................ 5474
144.5 Server is Starting Up ............................................................... 5475
144.5.1 Solution ................................................................................ 5475
144.6 Failed to Establish Connection ................................................ 5476
144.6.1 Solution ................................................................................ 5476
144.7 Lead-Shadow Reference Server Communication Problems .... 5477
144.7.1 Solution ................................................................................ 5477
04-16006-04-en, March 2015 Technical
105
144.8 Failed Deploy of Server .......................................................... 5478
144.8.1 Solution ................................................................................ 5478
144.9 Project Not Visible ................................................................... 5479
144.9.1 Solution ................................................................................ 5479
145 Project Configuration Server Deep Technical
Reference ................................................................ 5481
145.1 Project Configuration Server System Log ................................ 5483
145.2 Project Configuration Server Validation .................................... 5484
145.2.1 LonWorks and Project Configuration Server Validation .......... 5484
145.2.2 BACnet and Project Configuration Server Validation .............. 5485
146 Device Administrator Deep Technical Reference ...... 5487
146.1 The Device Administrator Console Program ............................ 5489
146.1.1 Log on Using admin .............................................................. 5489
146.1.2 Login Using root .................................................................... 5489
146.1.3 Lockout Time ........................................................................ 5489
147 Automation Server Deep Technical Reference .......... 5491
147.1 Automation Server Principles .................................................. 5493
147.1.1 CPU and Memory ................................................................. 5493
147.1.2 Data Retention ...................................................................... 5494
147.1.3 Device Addressing ................................................................ 5494
147.2 Device Administrator USB Hubs .............................................. 5495
147.3 License Information ................................................................. 5496
148 Bindings Troubleshooting ........................................ 5497
148.1 Binding Does Not Work .......................................................... 5499
148.1.1 Solutions .............................................................................. 5499
149 Import and Export Troubleshooting .......................... 5501
149.1 Non-exportable Objects .......................................................... 5503
149.1.1 Solution ................................................................................ 5503
149.2 Name Conflicts During Import ................................................. 5504
149.2.1 Solutions .............................................................................. 5505
149.3 Container Conflicts During Import ........................................... 5506
149.3.1 Solution ................................................................................ 5507
149.4 Import Button Not Available .................................................... 5508
149.4.1 Solution ................................................................................ 5508
149.5 Import Finished with Warnings ................................................ 5509
149.5.1 Solution ................................................................................ 5509
149.6 Import Failed ........................................................................... 5510
149.6.1 Solution ................................................................................ 5510
149.7 Binding Template Name Is Not Intuitive ................................... 5511
149.7.1 Solution ................................................................................ 5511
149.8 Cannot Export BACnet System Objects .................................. 5512
149.8.1 Solution ................................................................................ 5512
149.9 Cannot Import BACnet Notification References ....................... 5513
149.9.1 Solutions .............................................................................. 5513
Technical 04-16006-04-en, March 2015
106
149.10 Cannot Preserve Trend Object Bindings During Import ............ 5515
149.10.1 Solutions .............................................................................. 5515
149.11 Supporting Objects Already Exist ............................................ 5516
149.11.1 Solution ................................................................................ 5516
149.12 Cannot Import Supporting Objects for Alarms ......................... 5517
149.12.1 Solution ................................................................................ 5517
149.13 Cannot Export User Management System Objects .................. 5518
149.13.1 Solution ................................................................................ 5518
149.14 Cannot Import LonWorks Solution .......................................... 5519
149.14.1 Solution ................................................................................ 5519
150 I/O Troubleshooting ................................................. 5521
150.1 I/O Module Incorrectly Configured ........................................... 5523
150.1.1 Solutions .............................................................................. 5523
150.2 Input Point Not Functioning Correctly ...................................... 5524
150.2.1 Solutions .............................................................................. 5524
150.3 Output Point Not Functioning Correctly ................................... 5525
150.3.1 Solutions .............................................................................. 5525
150.4 Device Address Changed ....................................................... 5526
150.4.1 Solution ................................................................................ 5526
150.5 Blacklisted Device Detected .................................................... 5527
150.5.1 Solution ................................................................................ 5527
150.6 High CPU Usage and Slow System Response Time ............... 5528
150.6.1 Solutions .............................................................................. 5528
151 Graphics Troubleshooting ........................................ 5529
151.1 Units Categories Mismatch when Saving a Graphic ................. 5531
151.1.1 Solution ................................................................................ 5531
152 Function Block Troubleshooting ............................... 5533
152.1 Function Block Displayed in Red Frame .................................. 5535
152.1.1 Solution ................................................................................ 5535
152.2 Unable to Compile or Simulate ................................................ 5536
152.2.1 Solution ................................................................................ 5536
152.3 Constant Already Defined ....................................................... 5537
152.3.1 Solution ................................................................................ 5537
152.4 Faulty Block Centered and Selected ........................................ 5538
152.4.1 Solution ................................................................................ 5538
152.5 Illegal Closed Loop Has Been Detected ................................... 5539
152.5.1 Solution ................................................................................ 5539
152.6 Redefined Identifier ................................................................. 5540
152.6.1 Solution ................................................................................ 5540
152.7 Undefined Constant ................................................................ 5541
152.7.1 Solution ................................................................................ 5541
152.8 Block Must Have a Name ........................................................ 5542
152.8.1 Solution ................................................................................ 5542
152.9 Public Constant Not Supported in Expression Blocks .............. 5543
152.9.1 Solution ................................................................................ 5543
04-16006-04-en, March 2015 Technical
107
152.10 Public Constant Used More Than Once .................................. 5544
152.10.1 Solution ................................................................................ 5544
152.11 Public Constant Identifier Is in Use Already .............................. 5545
152.11.1 Solution ................................................................................ 5545
152.12 Public Constant Not Used ....................................................... 5546
152.12.1 Solution ................................................................................ 5546
152.13 Node Name Too Long ............................................................ 5547
152.13.1 Solution ................................................................................ 5547
152.14 Division by Zero, Numerical Overflow ...................................... 5548
152.14.1 Solution ................................................................................ 5548
152.15 The maximum number of Alarm blocks is exceeded in the function
block program ........................................................................ 5549
152.15.1 Solution ................................................................................ 5549
152.16 Unable to Access the Edit Menu ............................................. 5550
152.16.1 Solution ................................................................................ 5550
153 Script Troubleshooting ............................................. 5551
153.1 Compiler error contains no error text ....................................... 5553
153.1.1 Solution ................................................................................ 5553
153.2 Runtime error contains no error number .................................. 5554
153.2.1 Solution ................................................................................ 5554
154 LonWorks Troubleshooting ...................................... 5555
154.1 Packet Errors .......................................................................... 5557
154.2 LonWorks Device Communication Problems ........................... 5559
154.2.1 Solutions .............................................................................. 5559
154.3 Corrupt LonWorks Bindings .................................................... 5560
154.3.1 Solution ................................................................................ 5560
154.4 LonWorks Device Out of Sync ................................................. 5561
154.4.1 Solutions .............................................................................. 5561
154.5 LonWorks Interface is Offline ................................................... 5562
154.5.1 Solutions .............................................................................. 5562
154.6 Configuring of LonWorks Device using LNS Plug-in Fails Due to
Missing Device Template ........................................................ 5563
154.6.1 Solution ................................................................................ 5563
155 LonWorks Deep Technical Reference ....................... 5565
155.1 LonTalk Addressing Overview ................................................. 5567
155.1.1 Domain, Subnet and Node .................................................... 5569
155.1.2 LonWorks D/S/N Addressing ................................................ 5569
155.1.3 LonWorks Domains in Building Operation .............................. 5571
155.1.4 Addressing over ECS ............................................................ 5571
155.2 Customized DRF kit in Externally Managed LonWorks
Network .................................................................................. 5572
155.3 Configuration Property Flags ................................................... 5573
156 Xenta LonWorks Device Troubleshooting ................. 5577
156.1 Xenta Device Out of Sync ........................................................ 5579
156.1.1 Solution ................................................................................ 5579
Technical 04-16006-04-en, March 2015
108
156.2 Xenta I/O Device Communication Problems ............................ 5581
156.2.1 Solution ................................................................................ 5581
156.3 Xenta Trend Log Problems ...................................................... 5582
156.3.1 Solution ................................................................................ 5582
156.4 Xenta Schedule Synchronization Problems ............................. 5583
156.4.1 Solution ................................................................................ 5583
156.5 Error in Retrieving Xenta LonWorks Device Trend Log Data ..... 5584
156.5.1 Solution ................................................................................ 5584
157 Xenta LonWorks Device Deep Technical Reference .. 5585
157.1 Xenta Progress Error Texts ..................................................... 5587
157.1.1 Commission Errors ............................................................... 5587
157.1.2 Device Type Errors ................................................................ 5587
157.1.3 MTA Parsing Errors ............................................................... 5587
157.2 Xenta SNVT Support ............................................................... 5590
157.3 Xenta Trend Log Online Parameters ........................................ 5593
157.3.1 Editable Online Parameters ................................................... 5593
158 MNL LonWorks Troubleshooting .............................. 5595
158.1 BinaryInPls Object’s Pulse Rate Forced Value Changes to 0
(zero) ...................................................................................... 5597
158.1.1 Solution ................................................................................ 5597
158.2 MNL-800 Sensor Object's Temperature Forced Value Reverts to
32768 ..................................................................................... 5598
158.2.1 Solution ................................................................................ 5598
158.3 Delayed Update of Override Status Icon .................................. 5599
158.3.1 Solution ................................................................................ 5599
158.4 Forced Output Value of Input Object Reverts to Previous
Value ...................................................................................... 5600
158.4.1 Solution ................................................................................ 5600
158.5 ASCII Character SNVT Displays Value of ÿ in Place of NA
Value ...................................................................................... 5601
158.5.1 Solution ................................................................................ 5601
158.6 Cannot Change Configuration Property Value of MNL I/O Point or S-
Link Sensor Point .................................................................... 5602
158.6.1 Solution ................................................................................ 5602
158.7 Cannot Change Limits in Setpoint S-Link Sensor Point ............ 5603
158.7.1 Solution ................................................................................ 5603
158.8 Some MNL-800 I/O Point and S-Link Sensor Point Properties
Indicate Communication Error ................................................. 5604
158.8.1 Solution ................................................................................ 5604
158.9 Commissioning or Communication Faults Occur After Using Service
Pin to Decommission MNL LonWorks Device .......................... 5605
158.9.1 Solution ................................................................................ 5605
158.10 Commissioning Faults Occur After Using Third-Party Tool to
Commission or Decommission MNL LonWorks Device ........... 5606
158.10.1 Solution ................................................................................ 5606
158.11 Commissioning of MNL–800 Device Fails Due to Older Firmware
Revision .................................................................................. 5607
04-16006-04-en, March 2015 Technical
109
158.11.1 Solution ................................................................................ 5607
158.12 Downloading Application to MNL LonWorks Device Fails Due to
Wrong Device Type ................................................................. 5608
158.12.1 Solution ................................................................................ 5608
158.13 Downloading Application to MNL LonWorks Device Fails Due to
Older Firmware Revision ......................................................... 5609
158.13.1 Solution ................................................................................ 5609
158.14 Cannot Assign Application Using New Command ................... 5611
158.14.1 Solution ................................................................................ 5611
158.15 Commissioning or Downloading of MNL LonWorks Device Fails Due
to Communications Error ........................................................ 5612
158.15.1 Solution ................................................................................ 5612
158.16 MNL LonWorks Device Out of Sync with Database After Server
Restore ................................................................................... 5613
158.16.1 Solution ................................................................................ 5613
158.17 Command Inactive for MNL LonWorks Device ........................ 5614
158.17.1 Solution ................................................................................ 5614
158.18 Dragging Discovered MNL LonWorks Device to System Tree Pane
Does Not Acquire Neuron ID ................................................... 5616
158.18.1 Solution ................................................................................ 5616
158.19 Dragging Discovered MNL LonWorks Device to System Tree Pane
Does Not Create New MNL Device ......................................... 5617
158.19.1 Solution ................................................................................ 5617
158.20 MNL LonWorks Device Needs Commissioning Following Deletion of
LonWorks Device .................................................................... 5618
158.20.1 Solution ................................................................................ 5618
158.21 Name Conflicts During MNL LonWorks Solution Import ........... 5619
158.21.1 Solution ................................................................................ 5619
159 MNL LonWorks Deep Technical Reference .............. 5621
159.1 Source File Error ..................................................................... 5623
159.1.1 Solution ................................................................................ 5623
160 BACnet Device Troubleshooting ............................... 5625
160.1 A BACnet Schedule Does Not Change Value or Run at Specified
Time ....................................................................................... 5627
160.1.1 Solution ................................................................................ 5627
160.2 A Copied Object (Generic) Does Not Operate and Shows Property
Errors ..................................................................................... 5628
160.2.1 Solution ................................................................................ 5628
160.3 BACnet Point Value Does Not Change .................................... 5629
160.3.1 Solution ................................................................................ 5629
160.4 Default Priority Level Change .................................................. 5630
160.4.1 Solution ................................................................................ 5630
160.5 Unspecified Device Identifier ................................................... 5631
160.5.1 Solution ................................................................................ 5631
160.6 Duplicate Device Identifier ....................................................... 5632
160.6.1 Solution ................................................................................ 5632
160.7 Routing Loops ........................................................................ 5633
Technical 04-16006-04-en, March 2015
110
160.7.1 Solutions .............................................................................. 5633
160.8 Broadcast Storms ................................................................... 5634
160.8.1 Solution ................................................................................ 5634
161 BACnet Deep Technical Reference .......................... 5635
161.1 System Performance Diagnostics ............................................ 5637
162 b3 BACnet Device Troubleshooting .......................... 5639
162.1 Backup Needed Message Displays ......................................... 5641
162.1.1 Solution ................................................................................ 5641
163 Modbus Troubleshooting ......................................... 5643
163.1 Error Count Not Zero .............................................................. 5645
163.1.1 Solutions .............................................................................. 5645
163.2 Modbus Interface Status Offline .............................................. 5646
163.2.1 Solutions .............................................................................. 5646
163.3 Modbus Point Has Unexpected Value ..................................... 5647
163.3.1 Solutions .............................................................................. 5647
163.4 Modbus Point Value Has Red Indicator ................................... 5648
163.4.1 Solutions .............................................................................. 5648
163.5 Modbus TCP Device Status Offline .......................................... 5649
163.5.1 Solutions .............................................................................. 5649
163.6 Modbus TCP Gateway Status Offline ...................................... 5650
163.6.1 Solutions .............................................................................. 5650
163.7 Modbus TCP Server Status Offline .......................................... 5651
163.7.1 Solution ................................................................................ 5651
163.8 Modbus TCP Network Status Offline ....................................... 5652
163.8.1 Solutions .............................................................................. 5652
163.9 Read or Write Failure ............................................................... 5653
163.9.1 Solutions .............................................................................. 5653
163.10 Serial Device Status Offline ...................................................... 5654
163.10.1 Solutions .............................................................................. 5654
163.11 Serial Network Status Offline ................................................... 5655
163.11.1 Solution ................................................................................ 5655
163.12 Serial Port Status Offline ......................................................... 5656
163.12.1 Solution ................................................................................ 5656
164 Modbus Deep Technical Reference .......................... 5657
164.1 Modbus Message Formats ...................................................... 5659
164.2 Serial Transmission Modes ..................................................... 5661
164.2.1 RTU Transmission Mode Message Data Byte Format ............ 5663
164.2.2 RTU Transmission Mode Message Frame Format ................. 5663
164.2.3 ASCII Transmission Mode Message Data Byte Format .......... 5664
164.2.4 ASCII Transmission Mode Message Frame Format ................ 5665
164.3 Device and Register Polling ..................................................... 5667
164.3.1 Poll Manager ......................................................................... 5667
164.3.2 Poll List ................................................................................. 5667
164.3.3 Poll List Management ............................................................ 5667
04-16006-04-en, March 2015 Technical
111
164.4 Modbus Poll Duty Cycle .......................................................... 5669
165 NETWORK 8000 Troubleshooting ............................ 5671
165.1 Cannot Import a Second GCM Database ................................ 5673
165.1.1 Solution ................................................................................ 5673
165.2 Incorrect Values Displayed Due to Unit Conversion ................. 5674
165.2.1 Solution ................................................................................ 5674
165.3 Cannot Bind a Global Reference Point .................................... 5675
165.3.1 Solution ................................................................................ 5675
165.4 Entered Property Value Exceeds Specified Limits .................... 5676
165.4.1 Solution ................................................................................ 5676
165.5 Duplicate Device Address ....................................................... 5677
165.5.1 Solution ................................................................................ 5677
165.6 ASD and LCM Networks Cannot be Configured to Same
Automation Server Serial Port ................................................. 5678
165.6.1 Solution ................................................................................ 5678
165.7 Automation Server Serial Port Assigned to ASD Network Already
Allocated ................................................................................ 5679
165.7.1 Solution ................................................................................ 5679
165.8 ASD Port Reference is Invalid .................................................. 5680
165.8.1 Solution ................................................................................ 5680
165.9 ASD Port Reference Path is Invalid .......................................... 5681
165.9.1 Solution ................................................................................ 5681
165.10 ASD Port Reference Cannot be Changed ................................ 5682
165.10.1 Solution ................................................................................ 5682
165.11 ASD Port Reference Cannot be Assigned ................................ 5683
165.11.1 Solution ................................................................................ 5683
165.12 Automation Server Serial Port Assigned to LCM Network Already
Allocated ................................................................................ 5684
165.12.1 Solution ................................................................................ 5684
165.13 LCM Port Reference is Invalid ................................................. 5685
165.13.1 Solution ................................................................................ 5685
165.14 LCM Port Reference Path is Invalid ......................................... 5686
165.14.1 Solution ................................................................................ 5686
165.15 LCM Port Reference Cannot be Changed ............................... 5687
165.15.1 Solution ................................................................................ 5687
165.16 LCM Port Reference Cannot be Assigned ............................... 5688
165.16.1 Solution ................................................................................ 5688
165.17 LCM Block or LCM Object Does Not Update .......................... 5689
165.17.1 Solution ................................................................................ 5689
165.18 LCM Properties Do Not Update in Graphic or Watch Pane ...... 5690
165.18.1 Solution ................................................................................ 5690
165.19 Cannot Delete an LCM Device Object or LCM Block ............... 5691
165.19.1 Solution ................................................................................ 5691
165.20 Maximum Number of LCM Device Objects Exceeded ............. 5692
165.20.1 Solution ................................................................................ 5692
166 NETWORK 8000 Deep Technical Reference ............ 5693
Technical 04-16006-04-en, March 2015
112
166.1 Delta Time ............................................................................... 5695
167 I/NET Troubleshooting ............................................. 5697
167.1 I/NET Events are Not Showing Up in WorkStation ................... 5699
167.1.1 Solution ................................................................................ 5699
168 MicroNet Troubleshooting ........................................ 5701
168.1 Data Import dialog displays ‘Unable to read’ message ............ 5703
168.1.1 Solution ................................................................................ 5703
168.2 Data Import dialog displays 'Type not found' message ............ 5704
168.2.1 Solution ................................................................................ 5704
168.3 Data import fails after changing Update file path ...................... 5705
168.3.1 Solution ................................................................................ 5705
168.4 Read or Write Failure ............................................................... 5706
168.4.1 Solution ................................................................................ 5706
168.5 Status Information displays Offline ........................................... 5707
168.5.1 Solution ................................................................................ 5707
168.6 Object Error Count not Zero .................................................... 5708
168.6.1 Solution ................................................................................ 5708
169 MicroNet Deep Technical Reference ........................ 5709
169.1 VisiSat Point Upper and Lower Limits ...................................... 5711
170 Sigma Troubleshooting ............................................ 5717
170.1 Data Import Dialog Box Displays 'Failed to connect to server'
Message ................................................................................. 5719
170.1.1 Solution ................................................................................ 5719
170.2 Data Import Dialog Box Displays 'Failed to create trace file'
Message ................................................................................. 5720
170.2.1 Solution ................................................................................ 5720
170.3 Data Import Dialog Box Displays Conversion Warning
Message ................................................................................. 5721
170.3.1 Solution ................................................................................ 5721
170.4 Data Import Dialog Box Displays Conversion Error Message ... 5722
170.4.1 Solution ................................................................................ 5722
170.5 Data Import Dialog Box Displays Conversion Failed Message .. 5723
170.5.1 Solution ................................................................................ 5723
171 Sigma Deep Technical Reference ............................. 5725
171.1 Data Importer Conversion Warning Messages ......................... 5727
171.1.1 General Warning Messages .................................................. 5727
171.1.2 Programmable Object Warning Messages ............................. 5728
171.2 Data Importer Conversion Error Messages .............................. 5731
171.3 Data Importer Conversion Failed Messages ............................. 5733
171.4 Graphics Error Messages in the Trace File ............................... 5734
172 Backup and Restore Deep Technical Reference ....... 5737
172.1 Backup and Restore Alarms .................................................... 5739
172.2 Copying a Backup Set from One Enterprise Server to Another . 5740
04-16006-04-en, March 2015 Technical
113
173 Backup and Restore Troubleshooting ...................... 5741
173.1 Backup and Restore Issues .................................................... 5743
173.1.1 Controller Output Values ....................................................... 5743
173.1.2 Input Values .......................................................................... 5743
173.1.3 Configuration Data ................................................................ 5743
173.1.4 Trend Logs and Events Data ................................................. 5744
173.1.5 Extended Trend Logs ............................................................ 5744
173.1.6 IP Address Change ............................................................... 5744
173.2 Extended Trend Logs and Automation Server Restore ............ 5745
173.3 Diagnosing Backup or Restore Issues ..................................... 5748
173.4 Restore Incomplete Due to Network Connectivity Loss ........... 5750
173.4.1 Solution ................................................................................ 5750
173.5 Checking the Online Status of an Automation Server ............... 5751
173.6 No Restore Files Display After Backup .................................... 5752
173.6.1 Solutions .............................................................................. 5752
173.7 Renamed Automation Server Makes Backup Sets Unavailable
............................................................................................... 5753
173.7.1 Solution ................................................................................ 5753
173.8 Incorrect Date Stamp on Backup Set ...................................... 5754
173.8.1 Solution ................................................................................ 5754
173.9 Power Failure Occurs During Backup ...................................... 5755
173.9.1 Solution ................................................................................ 5755
173.10 Automation Server Remains Offline After Restore .................... 5756
173.10.1 Solutions .............................................................................. 5756
173.11 Similar Restore Points Display in Restore Options Dialog ......... 5757
173.11.1 Solutions .............................................................................. 5757
173.12 Duplicate Backup Set Names in Multi-server Systems ............. 5759
173.12.1 Solution ................................................................................ 5759
173.13 Backup Set Text is Red ........................................................... 5760
173.13.1 Solution ................................................................................ 5760
173.14 Automation Server Duplication Failed ...................................... 5761
173.14.1 Solution ................................................................................ 5761
173.15 Timeout Reached While Waiting for New Server to Come
Online ..................................................................................... 5762
173.15.1 Solution ................................................................................ 5762
173.16 Wrong User ID or Password .................................................... 5763
173.16.1 Solution ................................................................................ 5763
173.17 Disk Space Problem after Automation Server Upgrade ............ 5764
173.17.1 Solution ................................................................................ 5764
174 Archive Troubleshooting .......................................... 5765
174.1 Archive Directory Does Not Exist ............................................. 5767
174.1.1 Solution ................................................................................ 5767
175 Hardware Troubleshooting ....................................... 5769
175.1 General Hardware Configuration Problem ............................... 5771
175.1.1 Solutions .............................................................................. 5771
175.2 No Communication with Automation Server ............................ 5772
Technical 04-16006-04-en, March 2015
114
175.2.1 Solutions .............................................................................. 5772
175.3 No Communication with I/O Module ........................................ 5773
175.3.1 Solutions .............................................................................. 5773
175.4 Incorrect I/O Values ................................................................ 5774
175.4.1 Solutions .............................................................................. 5774
175.5 Power Supply Overload .......................................................... 5775
175.5.1 Solutions .............................................................................. 5775
04-16006-04-en, March 2015 Technical
115
Introduction
The Introduction part contains information on the purpose
of this guide, how this guide is organized, where to find
more information, and information on regulatory notices.
1 About This Guide
Topics
Purpose of This Guide
How This Guide is Organized
Typographical Conventions
1 About This Guide
1.1 Purpose of This Guide
1.1 Purpose of This Guide
This guide provides information about protocols, devices, external editors, and
servers in Building Operation. This information includes technical information and
troubleshooting information, as well as concepts and procedures.
04-16006-04-en, March 2015 Technical
121
1 About This Guide
1.2 How This Guide is Organized
1.2 How This Guide is Organized
This Building Operation Guide is divided into the following parts:
Introduction
The Introduction part contains information on the purpose of this guide, how this
guide is organized, where to find more information, and information on regulatory
notices.
Reference
The Reference part contains conceptual information, procedures, user interface
descriptions and troubleshooting information. If you want more information, see
WebHelp or the other Building Operation Reference Guides.
Technical 04-16006-04-en, March 2015
122
1 About This Guide
1.3 Typographical Conventions
1.3 Typographical Conventions
Building Operation Guides use the following specially marked texts:
Tip
Helps you understand the benefits and capabilities of the product.
Note
Provides you with supplementary information.
Important
Alerts you to supplementary information that is essential to the completion of a
task.
Caution
Alerts you to a condition that can cause loss of data.
Warning
Alerts you to a condition that can cause product damage or physical harm.
Bold texts:
User interface items, such as property names and buttons, are written in bold, for
example "On the File menu, select New."
04-16006-04-en, March 2015 Technical
123
2 Additional Information
Topics
Where to Find Additional Information
Regulatory Notices
2 Additional Information
2.1 Where to Find Additional Information
2.1 Where to Find Additional Information
All the technical Building Operation information is available online, on WebHelp.
WebHelp is a web-based help system for StruxureWare Building Operation and
Automation Server Family products, the software and hardware that powers
SmartStruxure solution.
By pressing F1 or clicking a Help button in the StruxureWare Building Operation
software your web browser opens WebHelp with the latest, up-to-date, technical
documentation.
Figure: Help in StruxureWare Building Operation
Some StruxureWare Building Operation software products give you context-
sensitive help by opening a WebHelp page that explains the view or dialog box you
have in focus. Some programs open up an overview page. From these pages, you
can follow the links to get more detailed information.
WebHelp contains all the technical information that is in the guides, specification
sheets, and installation instructions.
The WebHelp site
One of the advantages with WebHelp is that you can reach Help without having the
StruxureWare Building Operation software installed on your computer. By entering
the URL address help.sbo.schneider-electric.com you can access WebHelp from
any computer, smartphone, or tablet connected to the internet.
Finding information
The easiest way to find information on WebHelp is to search for it.
Figure: Home page search
All technical information is gathered in one place, so you do not need to know
which guide, specification sheet, or installation instruction the information is in.
Filtering the information
To narrow down the search results, you can use these filters:
• Product
• Functionality
• Information type
04-16006-04-en, March 2015 Technical
127
2 Additional Information
2.1 Where to Find Additional Information
Figure: Search filters
Technical 04-16006-04-en, March 2015
128
2 Additional Information
2.2 Regulatory Notices
2.2 Regulatory Notices
UL 916 Listed products for the Unites States and Canada, Open
Class Energy Management Equipment.
WEEE - Directive of the European Union (EU)
This equipment and its packaging carry the waste of electrical and electronic
equipment (WEEE) label, in compliance with European Union (EU) Directive
2002/96/EC, governing the disposal and recycling of electrical and electronic
equipment in the European community.
CE - Compliance to European Union (EU)
2004/108/EC Electromagnetic Compatibility Directive
This equipment complies with the rules, of the Official Journal of the European
Union, for governing the Self Declaration of the CE Marking for the European Union
as specified in the above directive(s) per the provisions of the following standards:
IEC/EN 61326-1 Product Standard, IEC/EN 61010-1 Safety Standard.
Industry Canada
ICES-003
This is a Class B digital device that meets all requirements of the Canadian
Interference Causing Equipment Regulations.
C-Tick (Australian Communications Authority (ACA))
AS/NZS 3548
This equipment carries the C-Tick label and complies with EMC and radio
communications regulations of the Australian Communications Authority (ACA),
governing the Australian and New Zealand (AS/NZS) communities.
Federal Communications Commission
FCC Rules and Regulations CFR 47, Part 15, Class B
This device complies with part 15 of the FCC Rules. Operation is subject to the
following two conditions: (1) This device may not cause harmful interference. (2) This
device must accept any interference received, including interference that may cause
undesired operation.
04-16006-04-en, March 2015 Technical
129
Reference
The Reference part contains conceptual information,
procedures, user interface descriptions and troubleshooting
information. If you want more information, see WebHelp or
the other Building Operation Reference Guides.
3 Building Operation Servers
Topics
Server Overview
Enterprise Server
Server System
Server Management
Device Discovery
Automation Server
Creating an Automation Server
Creating an Automation Server from a Backup Set
Deleting an Automation Server
Renaming a Server
Connecting to an Automation Server Using the USB Device
Port
Connecting to an Automation Server Using the IP Network
Saving a List of Automation Servers
Restoring a List of Automation Servers
Setting Device Log On Options
Getting Automation Server Debug Information
Identifying the Automation Server IP Address
Setting the Automation Server IP Address
Configuring an Automation Server to Use DHCP
Configuring the Time for an Automation Server with Factory
Settings
Restoring the Software of a Damaged Automation Server
Creating an SNMP User
Automation Server Upgrade
Server Object Properties
Displaying CPU and System Memory Usage
3 Building Operation Servers
3.1 Server Overview
3.1 Server Overview
Building Operation servers are used to engineer and supervise building automation
systems.
There are three types of Building Operation servers:
• Project Configuration Server
• Enterprise Server
• Automation Server
The Project Configuration Server is the engineering platform, whereas the
Enterprise Server and Automation Server are live servers, engineered an
commissioned to supervise live building automation systems.
The Project Configuration Server and Enterprise Servers run on the PC platform,
while Automation Servers run on Building Operation hardware. Servers are
accessed through WorkStation on IP network.
Figure: Server overview
The Project Configuration Server can be installed on a PC laptop for off site
engineering and on site deployment. Alternatively the Project Configuration Server
can be installed both off site, and on site, while moving projects back and fourth on
portable memory.
The Project Configuration Server can perform all engineering tasks, but no live
tasks. The Enterprise Server and the Automation Server can perform different live
tasks and some engineering tasks. The following table shows which Building
Operation server can be used to perform each task:
Table: Distinguishing Tasks Table
Task Project Enterprise Server Automation
Configuration Server
Server
Create Projects X
04-16006-04-en, March 2015 Technical
135
3 Building Operation Servers
3.1 Server Overview
Continued
Task Project Enterprise Server Automation
Configuration Server
Server
Create and configure X X X
objects (programs,
graphics, alarms,
trend logs,
schedules)
Bind values X X X
Use binding X X X
templates
Create Enterprise X
Server
Create Automation X X -
Server
Set up user groups & X X -
domains
Discover and create X X -
Building Operation
servers
Discover and create X X X
field bus devices
Discover and create X X X
I/O modules
Download, X X
commission, and
upload device
configuration
View and access X -
remote servers
Run programs X X
View live data X X
Store logs X X
Store multiserver logs X -
Monitor field bus X X
devices
Control I/O - X
Technical 04-16006-04-en, March 2015
136
3 Building Operation Servers
3.1 Server Overview
Task Project Enterprise Server Automation
Configuration Server
Server
3.1.1 Project Configuration Server
The Project Configuration Server is used for off-site engineering, project
configuration, and deployment of the project configuration to the on-site servers.
You create the project configuration, such as servers, networks, devices, and
schedules. When you connect the Project Configuration Server to the server (either
locally or remotely), you deploy the project to the Enterprise Server or the
Automation Server.
For more information, see section 5.2 “Project Configuration Server” on page 193.
3.1.2 Enterprise Server
The Enterprise Server is a hierarchical top server that is primarily used for system
supervision and engineering. As the dedicated top server, the Enterprise Server
provides you with a system entry point. Through the Enterprise Server, you can
view and access all resources in the system.
For more information, see section 3.2 “Enterprise Server” on page 136.
3.1.3 Automation Server
Automation Servers constitute the server base tier in automation systems, and are
typically supervised through an Enterprise Server. The primary function of the
Automation Server is to control I/O and to monitor field bus devices.
For more information, see section 3.6 “Automation Server” on page 142.
3.1.4 Server System
The server system consists of one top Enterprise Server, and a number of lower tier
Automation Servers.
For more information, see section 3.3 “Server System” on page 138.
3.1.5 Automation Server Web Configuration Page
The Automation Server Web Configuration page can only be accessed through
Webstation. In the Automation Server Web Configuration page, you can change
TCP/IP settings, download logs, and check the version of the Automation Server.
For more information, see section 13.1 “Automation Server Web Configuration
Page” on page 393.
04-16006-04-en, March 2015 Technical
137
3 Building Operation Servers
3.2 Enterprise Server
3.2 Enterprise Server
The Enterprise Server is a hierarchical top server that is primarily used for system
supervision and engineering. As the dedicated top server, the Enterprise Server
provides you with a system entry point. Through the Enterprise Server, you can
view and access all resources in the system.
Important
Ensure that you have a working and available Enterprise Server license. A working
license is required to start the Enterprise Server. For more information, see the
Licenses topic on WebHelp.
3.2.1 Engineering
You can log into the Enterprise Server and engineer the entire system. Through the
Enterprise Server you can access and engineer any resource, any Automation
Server, and any resource that resides under an Automation Server.
You can also log into to an Automation Server directly, and perform engineering
tasks locally. However, the Automation Server has a lesser range of engineering
features, and you can only access the resources of that specific Automation Server.
3.2.2 Features
The Enterprise Server provides features for system supervision, and tools for
engineering.
Live Features
These are the live features of the Enterprise Server:
• Global view and access
• Program runtime environment
• Centralized alarms and data management:
– Manage alarms from multiple servers
– View extended trend logs from multiple server
– View event logs from multiple servers
– Store historical data from multiple servers
• Capable of monitoring field bus:
– Connects to Lon field bus through RNI, L-IP, or NIC network interface
– Connects to BACnet field bus through a BACnet/IP router
Engineering Features
These are the engineering features of the Enterprise Server:
• Automation Server management
• Tools for device discovery and commissioning
Technical 04-16006-04-en, March 2015
138
3 Building Operation Servers
3.2 Enterprise Server
• Programming editors
• Binding tool
• Graphic Editor
• User management
• Domain management
• Windows Active Directory integration
3.2.3 The Enterprise Server in Context
The Enterprise Server provides a global view of the system. If connected directly to
an Automation Server you are only given local view and local access: the server
itself, its I/O, and field bus devices.
You can use the Enterprise Server to gather and view all alarms, trend logs, and
event logs in list and chart viewers, and store it all in a central database. Connected
to the Automation Server, you can only monitor local alarms and local data.
The Enterprise Server facilitates more engineering features than the Automation
Server. For example, you can use the Enterprise Server to set up new Automation
Servers in the system. An Automation Server cannot create another peer. Also, you
can use the Enterprise Server to set up domains, user groups, and permissions,
which is outside the scope of the Automation Server.
04-16006-04-en, March 2015 Technical
139
3 Building Operation Servers
3.3 Server System
3.3 Server System
The server system consists of one top Enterprise Server, and a number of lower tier
Automation Servers.
Figure: The server topology
The Enterprise Server is the top server and is the system entry point from the user
point of view. You log into the Enterprise Server, and from there you can view,
navigate, and access all Automation Servers in the System Tree pane. You can use
the Enterprise Server to manage, supervise, and perform live engineering on the
system in an efficient manner:
• Single sign on
• Global view and access
• Global search
• Global engineering, such as bindings between servers
• Global server management
• Centralized alarms and data management:
– Manage alarms from multiple servers
– View trend logs from multiple server
– View event logs from multiple servers
– Store historical data from multiple servers
• Building Operation management:
– Domains
– User groups
• Windows integration
– Windows domains
– Active Directory user groups
Technical 04-16006-04-en, March 2015
140
3 Building Operation Servers
3.3 Server System
3.3.1 Server Communication
You configure communication parameters when you add a Building Operation
server. The Enterprise Server distributes the communication parameters to the
other servers so that they know how to communicate with the newly added server.
For more information, see section 4.1 “Server Communication” on page 173.
3.3.2 Server Status
The status of a server can be either online or offline. Being online or offline depends
on the operational situation of the server and its connectivity with other servers. A
server can actually be online and communicating with one server, while at the same
time appear to be offline to another server.
Server status has implications on server management. A server needs to be online
to be configured. Another consideration is that configuring a server, while another
server is offline, can cause the offline server to come out of synch when it comes
back online again.
For more information, see section 4.2 “Server Status” on page 177.
3.3.3 Server Management
You can use the Enterprise Server to create new Automation Servers. Automation
Servers are created and accessed in the Server folder. You cannot move servers
from the Server folder.
For more information, see section 3.4 “Server Management” on page 140.
04-16006-04-en, March 2015 Technical
141
3 Building Operation Servers
3.4 Server Management
3.4 Server Management
You use the Enterprise Server to manage Automation Servers, which includes
adding, configuring, and removing Automation Servers.
You create Automation Servers in the Server folder in the System Tree pane. You
can remove Automation Servers from the Server folder, but you cannot move them
from that folder to another location in the System Tree pane.
When you change an address or port of an Automation Server, that information
must be updated in the Communication tab of the Automation Server peers. You
can update this information manually in the Communication tab of the Automation
Server peers. You can also delete the Automation Server that has changed and
then adding it again. The Enterprise Server automatically collects and distributes
information about added servers to the other servers.
Task Automation Automation Automation
Server online, Server online, Server offline
peers online peers offline
Add server Yes Yesa No
Configure server Yes Yes No
Move server No No No
Rename server Nob Nob Nob
Remove server Yes Yesa Yes
a) Not recommended.
b) A server can be renamed if it is a stand-alone server in the system. You can rename the Enterprise
Server as long as you have not yet added any Automation Servers.
Note
When changing the name of a folder or server, you also have to reconfigure users
and user groups path permissions to this server or folder. For more information,
see the Path Permissions topic on WebHelp.
Automation Server Online, Peers Online
You can use the Enterprise Server to add, configure, and remove an Automation
Server that is online without consequence if all of the Automation Server peers are
also online.
Automation Server Online, Peers Offline
You can use the Enterpise Server to add, configure, and remove an automation
Server that is online but has Automation Server peers that are offline.
However, adding or removing an Automation Server while other Automation Servers
are offline can result in broken references or communication when those offline
servers come back online.
Technical 04-16006-04-en, March 2015
142
3 Building Operation Servers
3.5 Device Discovery
3.5 Device Discovery
You use the Device Discovery to discover and create devices in the Building
Operation System Tree pane.
You typically create an object in the System Tree that represents a device, then
discover the physical hardware in the Device Discovery and associate it to the
object representation in the System Tree.
You can also discover a physical hardware in the Device Discovery and create an
object representation automatically as you drag the discovered device to the
System Tree.
There are several scenarios where you use the Device Discovery:
• Discover a LonWorks interface on a Building Operation server.
• Discover LonWorks devices on the field bus of a Building Operation server.
• Discover BACnet devices on the field bus of a Building Operation server.
• Discover I/O modules on an Automation Server.
04-16006-04-en, March 2015 Technical
143
3 Building Operation Servers
3.6 Automation Server
3.6 Automation Server
Automation Servers constitute the server base tier in automation systems, and are
typically supervised through an Enterprise Server. The primary function of the
Automation Server is to control I/O and to monitor field bus devices.
Automation Servers provide distributed intelligence around a building. This is in
contrast to centralizing all control into one building mainframe. Distributing the logic
makes the different automation systems in the building autonomous and fault
tolerant. In the the process, Automation Servers also make the physical installation
and wiring more manageable.
Install Automation Servers and deploy the logic as close as possible to the
apparatus that they monitor and control. This way, most parts of the system
function autonomously and continue to function as a whole, even if communication,
individual servers, or devices fail or go offline.
3.6.1 Central I/O and Field Busses
Automation Servers can have direct control of automation apparatus through its
central I/O modules. Central I/O implies it is connected directly to the Automation
Server backplane, and that relevant logic and programs are deployed and reside
directly in the Automation Server.
An Automation Server can also connect to intelligent, more autonomous devices by
the means of a field bus, such as when integrating Xenta and b3 devices. These
field bus devices run their own programs and control their own subordinate
automation apparatus. The Automation Server assumes more of a monitoring role
towards these field bus devices.
Technical 04-16006-04-en, March 2015
144
3 Building Operation Servers
3.6 Automation Server
Figure: Automation Server system view
3.6.2 Features
The Automation Server facilitates features for automation control, monitoring, and
tools and services that you can use for local engineering.
Live Features
These are the live features of the Automation Server:
• Local view and access
• Program runtime environment
• Alarms and data management:
– Manage local alarms
– View local trend logs
– View local event logs
– Store historical data in local database
• Capable of controlling central I/O
• Capable of monitoring field bus
– Connects to the LonWorks field bus through port
04-16006-04-en, March 2015 Technical
145
3 Building Operation Servers
3.6 Automation Server
– Connects to the BACnet field bus through port
Live Engineering Features
These are the live engineering features of the Automation Server:
• Tools for device discovery and commissioning
• Programming editors
• Binding tool
• Graphic Editor
3.6.3 SNMP
Simple Network Management Protocol (SNMP) is an Internet-standard protocol for
managing devices on IP networks.
SNMP traps enable an agent to notify the management station of significant events
by way of an unsolicited SNMP message.
The Automation Server supports the following SNMP traps:
• ColdStart: The Automation Server is restarted.
• LinkUp: The Automation Server is up and running.
• AuthenticationFailure: Someone has made unsuccessful attempts to log on to
the Automation Server.
To be able to use SNMP for supervising Automation Server, you must use a
management information base (mib) file. The mib-file translates the binary
information from the Automation Server to readable text. The mib-file for Building
Operations is called sboProductMib.mib, and can be found on Download Center.
Technical 04-16006-04-en, March 2015
146
3 Building Operation Servers
3.6 Automation Server
Figure: The SNMP user, the MIB-file and the SNMP manager tool.
To be able to send information from the Automation Server to the SNMP managing
system, you must create a user on the Automation Server that the SNMP manager
system uses to connect to the Automation Server.
You can log all access attempts to the SNMP server in the System log.
3.6.4 Automation Server Upgrade
You upgrade the Automation Server using Device Administrator.
For more information, see section 3.23 “ Automation Server Upgrade ” on page
166.
04-16006-04-en, March 2015 Technical
147
3 Building Operation Servers
3.7 Creating an Automation Server
3.7 Creating an Automation Server
You use this procedure to add an empty Automation Server to the system.
For more information, see section 3.6 “Automation Server” on page 142.
To create an Automation Server
1. In WorkStation, in the System Tree pane, select the Servers folder.
2. On the File menu, point to New and then click Server.
3. In the Name box, type a name for the server.
4. In the Description box, type descriptive information about the server.
5. Click Next.
6. In the Address box, type the IP address or fully qualified domain name of the
Automation Server.
Important
• If the Automation Server has been assigned a dynamic IP
address, use the fully qualified domain name of the server
instead of the IP address.
Continued on next page
Technical 04-16006-04-en, March 2015
148
3 Building Operation Servers
3.7 Creating an Automation Server
7. In the Protocol box, select a protocol for the server. For more information,
see section 4.1 “Server Communication” on page 173.
8. In the Port box, enter a port number.
9. Click Create.
10. In the Password box , type the custom password if required.
11. Click OK.
04-16006-04-en, March 2015 Technical
149
3 Building Operation Servers
3.8 Creating an Automation Server from a Backup Set
3.8 Creating an Automation Server from a
Backup Set
You create an Automation Server from a backup set to reuse configuration data
from an existing Automation Server when adding a new Automation Server to the
system.
Important
You have to backup the Automation Server whose backup set you want to reuse
before starting to create the new Automation Server.
For more information, see section 3.6 “Automation Server” on page 142.
To create an Automation Server from a backup set
1. In WorkStation, in the System Tree pane, select the Servers folder.
2. On the File menu, point to New and then click Server.
3. In the Name box, type a name for the server.
4. In the Description box, type descriptive information about the server.
5. Click Next.
Continued on next page
Technical 04-16006-04-en, March 2015
150
3 Building Operation Servers
3.8 Creating an Automation Server from a Backup Set
6. In the Address box, type the IP address or fully qualified domain name of the
Automation Server.
Important
• If the Automation Server has been assigned a dynamic IP
address, use the fully qualified domain name of the server
instead of the IP address.
7. In the Protocol box, select a protocol for the server. For more information,
see section 4.1 “Server Communication” on page 173.
8. In the Port box, enter a port number.
9. Click Next.
10. In the Password box , type the custom password if required.
11. Click OK.
Continued on next page
04-16006-04-en, March 2015 Technical
151
3 Building Operation Servers
3.8 Creating an Automation Server from a Backup Set
12. In the File box, enter the path to the backup set file.
13. Click Create.
You have created an Automation Server containing the configuration data from the
backed up Automation Server. You can manually customize the configuration data
for the new server to meet your requirements.
Technical 04-16006-04-en, March 2015
152
3 Building Operation Servers
3.9 Deleting an Automation Server
3.9 Deleting an Automation Server
You use this procedure to delete Automation Servers. You can delete both online
and offline servers.
For more information, see section 3.4 “Server Management” on page 140.
To delete an Automation Server
1. In WorkStation, in the System Tree pane, in the Servers folder, select the
server that you want to delete.
2. On the Edit menu, click Delete.
3. In the Confirm Delete dialog box, click Yes.
You would typically update references and repair server communication, if any has
been broken.
04-16006-04-en, March 2015 Technical
153
3 Building Operation Servers
3.10 Renaming a Server
3.10 Renaming a Server
You use this procedure to rename an Enterprise Server or a standalone Automation
Server.
Note
When changing the name of a folder or server, you also have to reconfigure users
and user groups path permissions to this server or folder. For more information,
see the Path Permissions topic on WebHelp.
Important
You can rename a server only if it is the only server in the system.
For more information, see section 3.4 “Server Management” on page 140.
To rename a server
1. In WorkStation, in the System Tree pane, select the server that you want to
rename.
2. On the Edit menu, click Rename.
3. In the Object Name box, type a new name for the server.
4. Click OK.
5. In the Confirm Rename dialog box, click Yes.
6. Click OK.
7. Log on to WorkStation and update references, if any have been broken.
Technical 04-16006-04-en, March 2015
154
3 Building Operation Servers
3.11 Connecting to an Automation Server Using the USB Device Port
3.11 Connecting to an Automation Server
Using the USB Device Port
You connect to an Automation Server using the USB device port to upgrade or
install new software and to assign the IP address of the device. For more
information, see the Automation Server Software topic on WebHelp.
To connect to an Automation Server using the USB device port
1. Start Device Administrator.
2. Connect a USB 2.0 type A /B Male to Male (maximum length 3 m) cable to the
USB device port on the Automation Server and a USB port on the PC.
Important
• If the Found New Hardware Wizard dialog box is displayed,
follow the instructions to install the Automation Server driver.
3. In the Connection column for the Automation Server, ensure that usb is
displayed.
Now you can upgrade or install new software and assign the IP address of the
device.
04-16006-04-en, March 2015 Technical
155
3 Building Operation Servers
3.12 Connecting to an Automation Server Using the IP Network
3.12 Connecting to an Automation Server
Using the IP Network
You connect to an Automation Server using the IP network to upgrade or install
new software and to assign the IP address or host name of the device. For more
information, see the Automation Server Software topic on WebHelp.
To connect to an Automation Server using the IP network
1. In Device Administrator, click the Add network device to list button .
2. In the Connect to Device box, type the IP address or the host name of the
Automation Server. For more information, see section 3.17 “Identifying the
Automation Server IP Address” on page 159.
3. Enter the user name and password in one of the following ways:
• Type the user name and password for this Automation Server.
• Select Use default device log on to log on using the user name and
password specified in the Device log on options dialog box.
4. Click OK.
Now you can upgrade or install new software and assign the IP address of the
device.
Technical 04-16006-04-en, March 2015
156
3 Building Operation Servers
3.13 Saving a List of Automation Servers
3.13 Saving a List of Automation Servers
You save a list of Automation Servers in the Device Administrator so that you can
restore the list.
For more information, see section 3.14 “Restoring a List of Automation Servers” on
page 156.
To save a List of Automation Servers
1. In the Device Administrator, on the File menu, click Save as.
2. Enter a name and location for the list file.
3. Click Save.
Note
The list of Automation Servers does not include anything connected through the
USB device port, only servers that are connected through the IP network.
04-16006-04-en, March 2015 Technical
157
3 Building Operation Servers
3.14 Restoring a List of Automation Servers
3.14 Restoring a List of Automation Servers
You restore and alternate between lists of Automation Servers.
For more information, see section 3.13 “Saving a List of Automation Servers” on
page 155.
To restore a List of Automation Servers
1. In the Device Administrator, on the File menu, click Open.
2. Select the list of servers that you want to restore.
3. Click Open.
Technical 04-16006-04-en, March 2015
158
3 Building Operation Servers
3.15 Setting Device Log On Options
3.15 Setting Device Log On Options
When an Automation Server is upgraded, you have to enter the correct user name
and password. If several Automation Servers have the same user name and
password, it is convenient to set these as default values to be used by Device
Administrator when adding or upgrading devices.
To set the device log on options
1. In Device Administrator, on the Tools menu, click Default Device Log on
Options.
2. In the User name box, type the user name.
3. In the Password box, type the password.
4. In the Verify password box, type the password again.
5. Click OK.
The user name and password appear as default values when you connect to an
Automation Server with the Device Administrator.
04-16006-04-en, March 2015 Technical
159
3 Building Operation Servers
3.16 Getting Automation Server Debug Information
3.16 Getting Automation Server Debug
Information
Debug information is retrieved through the IP network or USB device port. The
debug information contains a lot of different files and detailed information. However,
for the ordinary user this information is too complex so after the debug information
has been retrieved, the files are normally sent to product support. The debug
information is enclosed in a zip file. If you choose to get debug information from
many Automation Server at the same time all information is enclosed in one zip file.
Note
If the Automation Server does not respond to normal communication, you must
reset the Automation Server and connect through the USB device port. For more
information, see the Resetting the Automation Server topic on WebHelp.
To get Automation Server debug information
1. In the Device Administrator, select the Automation Server.
2. On the Tools menu, click Get Debug Information .
3. In the Save as dialog box, select where to save the debug information file.
Technical 04-16006-04-en, March 2015
160
3 Building Operation Servers
3.17 Identifying the Automation Server IP Address
3.17 Identifying the Automation Server IP
Address
In Device Administrator, you can identify the Automation Server IP address in two
different ways:
• Use a configuration drawing to identify the IP address.
• Use the USB connection to determine the IP address and/or the host name
(the name assigned to the Automation Server).
To identify the Automation Server IP address
1. Start the Device Administrator and connect to the USB device port. For more
information, see section 3.11 “Connecting to an Automation Server Using the
USB Device Port” on page 153.
2. Select the Automation Server with the usb connection at the top of the list.
3. Click the Properties button .
4. Note the IP address and/or the Host name. For more information, see
section 11.11 “Device Administrator Properties – General Tab” on page 376.
5. Click Cancel.
6. Disconnect the USB cable from the Automation Server to enable upgrading
through the network.
04-16006-04-en, March 2015 Technical
161
3 Building Operation Servers
3.18 Setting the Automation Server IP Address
3.18 Setting the Automation Server IP
Address
You use Device Administrator to set a static IP address for an Automation Server.
For more information, see section 3.23 “ Automation Server Upgrade ” on page
166.
To set the Automation Server IP address
1. In Device Administrator, select the Automation Server for which you want to
set an IP address.
2. On the View menu, click Network Settings.
3. Clear Enable DHCP.
4. In the Static IP address box, type an IP address for the server.
5. In the Host name box, type a unique host name for the Automation Server.
6. In the Domain box, type the name of the domain.
7. In the Netmask box, type the prefix of the subnet.
8. In the Primary DNS box, type the address to the primary DNS server.
9. In the Secondary DNS box, type the address to the secondary DNS server.
10. In the Tertiary DNS box, type the address to the tertiary DNS server.
Continued on next page
Technical 04-16006-04-en, March 2015
162
3 Building Operation Servers
3.18 Setting the Automation Server IP Address
11. In the Gateway box, type the address to the router.
12. Click OK.
13. In the IP changes dialog box, click OK.
04-16006-04-en, March 2015 Technical
163
3 Building Operation Servers
3.19 Configuring an Automation Server to Use DHCP
3.19 Configuring an Automation Server to
Use DHCP
You use Device Administrator to configure the Automation Server to use DHCP.
For more information, see section 3.23 “ Automation Server Upgrade ” on page
166.
To configure an Automation Server to use DHCP
1. In Device Administrator, select the Automation Server that you want to use
DHCP.
2. On the View menu, click Network Settings.
3. Select Enable DHCP.
4. In the Host name box, type a unique host name for the Automation Server.
5. Click OK.
6. In the IP changes dialog box, click OK.
Technical 04-16006-04-en, March 2015
164
3 Building Operation Servers
3.20 Configuring the Time for an Automation Server with Factory Settings
3.20 Configuring the Time for an Automation
Server with Factory Settings
An Automation Server with factory settings does not have the correct time. To avoid
obsolete time stamps on the events in the event log, use the Set time on device
function to transfer the time from the computer that runs Device Administrator.
For more information, see section 3.23 “ Automation Server Upgrade ” on page
166.
To configure the time for an Automation Server with factory
settings
1. In Device Administrator, select the Automation Server.
2. On the View menu, click Properties.
3. Click Time.
4. Select Set time on device.
5. Click OK.
04-16006-04-en, March 2015 Technical
165
3 Building Operation Servers
3.21 Restoring the Software of a Damaged Automation Server
3.21 Restoring the Software of a Damaged
Automation Server
When you connect the PC to the Automation Server by the USB device port, the
Device Administrator automatically identifies the Automation Server. However, if the
Automation Server software is damaged, you need to reset the Automation Server.
When the Automation Server is reset, you have to upgrade the software using the
USB device port. You cannot use the network to upgrade a damaged Automation
Server that has been reset.
For more information, see section 3.23 “ Automation Server Upgrade ” on page
166.
To restore the software of a damaged Automation Server
1. Start Device Administrator.
2. Connect a USB 2.0 type A /B Male to Male (maximum length 3 m) cable to the
USB device port on the Automation Server and a USB port on the PC.
3. Perform a DFU mode restart by pressing the Reset button three times within
two seconds. For more information, see the Reset Functions topic on
WebHelp.
4. In Device Administrator, wait for the Device Status to show DFU mode.
5. Click the Upgrade Device(s) button .
6. Select the type of database upgrade. For more information, see the Uploading
and Upgrading an Automation Server topic on WebHelp.
7. Wait for the Device Status to show Ready.
Now you can assign the IP address and host name of the Automation Server and
download the software.
Technical 04-16006-04-en, March 2015
166
3 Building Operation Servers
3.22 Creating an SNMP User
3.22 Creating an SNMP User
You create an SNMP user for Automation Server so that an SNMP Manager can
access the SNMP information on the Automation Server.
For more information, see section 3.6 “Automation Server” on page 142.
To create a SNMP user
1. In the Device Administrator, select the Automation Server.
2. On the View menu, click Network Settings.
3. Click the SNMP Configuration tab.
4. Select SNMP queries to receive SNMP queries.
5. Select SNMP traps to receive SNMP traps.
6. In the Destination host for traps box, type the destination host for traps.
7. In the Username box, type the username.
8. In the Authentication password (MD5) box, type the Authentication
password. The password must be at least ten characters long.
9. In the Confirm password box, type the password again.
10. In the Privacy password box, type the privacy password. The password
must be at least ten characters long.
11. In the Confirm password box,type the password again.
12. In the System contact box, type the name of the system contact.
13. In the Location box, type the location.
14. Click OK.
04-16006-04-en, March 2015 Technical
167
3 Building Operation Servers
3.23 Automation Server Upgrade
3.23 Automation Server Upgrade
You can connect the Device Administrator to the Automation Server in two ways:
• USB connection: The Automation Server is immediately displayed in the list of
devices accessible to the Device Administrator.
• TCP/IP network: If you know the IP address of an Automation Server, you can
reach it via the network and add it to the list of accessible devices.
You must upgrade Device Administrator before you upgrade the Automation
Servers.
You use Device Administrator to upgrade the Automation Server. Device
Administrator uploads the backup set from the Automation Server to the computer
that is running Device Administrator. The database in the backup set is converted to
the new version.
You then open the Conversion Logs and determine if you can use the converted
database for download or if you need to fix configuration issues in the Automation
Server. In WorkStation, fix the configuration issues in the Automation Server. In
Device Administrator, upload and convert the database again. Repeat this process
until you are comfortable with the contents of the Conversion Logs.
You download the converted database to the Automation Server. During this
download, the Automation Server is completely offline and not operational from a
controls perspective for up to 25 minutes.
You can choose to download the database immediately or at a later time. However,
if the converted database is older than 24 hours, you are notified that the database
might be out of date because the Automation Server has been online collecting
data while the backup set containing the database was converted.
The timeframe between the database upgrade and the actual download of the
database can cause the database to be out of date because the Automation Server
has been online collecting data, such as configurations and events, while the
backup set containing the database was converted. However, trendlog data is
always retained.
3.23.1 Set Time on Device
The set time on device function helps you with the time settings on the Automation
Server. The Set time on device function transfers the time from the computer that
runs Device Administrator to the Automation Server.
Automation Server with Factory Settings
An Automation Server with factory settings does not have the correct time. To avoid
obsolete time stamps on the events in the event log, use the Set time on device
function to transfer the time from the computer that runs Device Administrator.
Upgrade an Automation Server with a New Database
When you upgrade an Automation Server with a new database, the time setting on
the Automation Server is overwritten with the time from the computer that runs
Device Administrator when you use the Set time on device function.
Technical 04-16006-04-en, March 2015
168
3 Building Operation Servers
3.23 Automation Server Upgrade
3.23.2 Status
After upload and conversion, the color of the progress bar in the Device
Administrator indicates the status of the database conversion:
• Green: The database conversion is complete.
• Yellow: The database conversion is complete. Open the Conversion Logs and
determine if you can use the converted database for download or if you need
to fix configuration issues in the Automation Server.
• Red: The database conversion has failed. Open the Conversion Logs and
determine the configuration issues that you need to fix in the Automation
Server.
For more information, see the Opening the Conversion Log topic on WebHelp.
For more information, see the Opening the High Priority Conversion Log topic
on WebHelp.
3.23.3 Conversion Logs
Two conversion logs keep track of information about the database conversion of
the Automation Server or the Enterprise Server:
• Conversion log: includes information about any errors, warnings, and notices
that occurred during the conversion of the database
For more information, see the Opening the Conversion Log topic on WebHelp.
• High priority conversion log: contains only the warnings that will most often
require some kind of user action
For more information, see the Opening the High Priority Conversion Log topic
on WebHelp.
For more information, see the Conversion Logs topic on WebHelp.
04-16006-04-en, March 2015 Technical
169
3 Building Operation Servers
3.24 Server Object Properties
3.24 Server Object Properties
Use the Server Object Properties view or dialog box to configure and view the
general and object-reference properties. For more information, see the General
Properties – Basic Tab topic on WebHelp.
Figure: Server Object Properties
Technical 04-16006-04-en, March 2015
170
3 Building Operation Servers
3.25 Displaying CPU and System Memory Usage
3.25 Displaying CPU and System Memory
Usage
You view the CPU usage and system memory usage of a server polling large
graphics, or a significant number of objects in the Watch pane.
To display CPU and system memory usage
1. In WorkStation, in the System Tree pane, select the server that you want to
diagnose.
2. On the Actions menu, point to View followed by In Watch pane, and then
click Other properties.
3. Select CPU usage and System memory usage.
4. If the CPU usage and system memory usage is above 50%, adjust the polling
interval settings on the network to optimize system performance.
04-16006-04-en, March 2015 Technical
171
4 Server Communication
Topics
Server Communication
Server Status
Repairing Server Communication
Updating Communication Parameters
Updating References
Selecting the Schneider Electric E-mail Server for E-mail
Notifications
Selecting and Specifying an E-mail Server for E-mail
Notifications
Server Communication in Project Configuration Server
Updating Project Configuration Server Communication
Parameters
Setting Server Logon Credential
4 Server Communication
4.1 Server Communication
4.1 Server Communication
You configure communication parameters when you add a Building Operation
server. The Enterprise Server distributes the communication parameters to the
other servers so that they know how to communicate with the newly added server.
4.1.1 Communication Parameters
Communication parameters include address, protocol, and port. You configure
these parameters in the Server wizard when you add servers.
Address
Every server needs an IP address to communicate in the network. You either use
the installation default IP address, or specify a static address that is unique in the
network. We advise against enabling DHCP.
You can also specify the server's fully qualified domain name, if one is defined and
the DNS service is enabled. A fully qualified domain name for a server consists of
two parts: the host name and the domain name. For example, a server with a host
name “es1” and the domain name “universityx.edu” has the fully qualified domain
name “es1.universityx.edu”. Always use the server's fully qualified domain name,
rather than its host name (without the domain information), to avoid lead-shadow
reference server communication problems. For more information, see section 144.7
“Lead-Shadow Reference Server Communication Problems ” on page 5477.
Protocols
Building Operation servers can use three different communication protocols:
• TCP is fast and you can set up domain authentication which makes for easy,
yet secure access.
• HTTP is slower than TCP but better for accessing resources outside the
LAN/firewalls.
• HTTPS is slower than HTTP but safer for accessing resources outside the
LAN/firewalls.
Ports
Each server listens on three communication ports, one for each communication
protocol:
• TCP on port 4444 (fixed)
• HTTP on port 80 (default)
• HTTPS on port 443 (default)
4.1.2 Server Communication Parameters
The communication parameters of a Building Operation server tell other Building
Operation servers where and how to communicate with that particular server. You
use different tools to specify, view, and change communication parameters.
04-16006-04-en, March 2015 Technical
175
4 Server Communication
4.1 Server Communication
Figure: Different ways of accessing communication parameters
Technical 04-16006-04-en, March 2015
176
4 Server Communication
4.1 Server Communication
To change the communication parameters of an Enterprise Server after it has been
commissioned, you need to open the Software Administrator application. In the
Software Administrator, you must first stop the server before configuring the
parameters.
To change the communication parameters of an Automation Server after it has
been commissioned, you need to access it through the web interface. For more
information, see the Accessing the Automation Server Web Configuration topic on
WebHelp.
4.1.3 Server-to-Server Communication Parameters
Each Building Operation server maintains a list of all the other Building Operation
servers in the system and the communication parameters of those servers.
Figure: Keeping track of the other Building Operation servers
In WorkStation, you can select a server in the System Tree pane and view its
communication parameters in the Network tab of its properties. In the
Communication view, you can view the information the server has about the
communication parameters of other Building Operation servers in the system. Each
server needs to know where and how to address other servers.
04-16006-04-en, March 2015 Technical
177
4 Server Communication
4.1 Server Communication
When an Automation Server is added, its communication parameters are
distributed by the Enterprise Server to all other Building Operation servers in the
system. Every server’s communication parameters ends up in every other servers
Communication view.
However, if you change the IP address or protocol port number in an already
commissioned server, you must manually update this information in the Enterprise
Server Communication view. The Enterprise Server then distributes the new
parameters to the other Building Operation servers.
4.1.4 Server Communication in Project
Configuration Server
You configure the server communication parameters in WorkStation for Projects,
before you deploy an Enterprise Server or an Automation Server.
For more information, see section 4.8 “Server Communication in Project
Configuration Server ” on page 186.
4.1.5 E-mail Server Settings
Some Building Operation features, alarms in particular, can be configured to send
E-mails to notify users about important events. You select and specify the E-mail
server settings in the E-mail tab in the Properties of each Building Operation server.
The easiest and most straight-forward way of setting up the E-mail server is to
select the Schneider Electric E-mail Server, specify a Sender E-mail address, and
use the default settings.
For example, if an alarm goes off, the Building Operation server notifies the E-mail
recipient specified in the alarm. The Building Operation server sends the E-mail
through the Schneider Electric E-mail Server, which is hosted by Schneider Electric
for use by Building Operation customers. The Sender E-mail specified in the E-mail
tab is the receiver of the replies from the E-mail recipient.
However, instead of the default Schneider Electric E-mail Server, you can select
and specify a different E-mail server. You can also specify a secondary E-mail
server in case the connection to your primary choice fails.
The Building Operation server tries to connect to the primary E-mail server, and
then to the secondary if the the primary fails, and then to the primary again, and so
on. If the secondary E-mail server is used, it automatically becomes the primary E-
mail server while the other one assumes secondary status.
Technical 04-16006-04-en, March 2015
178
4 Server Communication
4.2 Server Status
4.2 Server Status
The status of a server can be either online or offline. Being online or offline depends
on the operational situation of the server and its connectivity with other servers. A
server can actually be online and communicating with one server, while at the same
time appear to be offline to another server.
Server status has implications on server management. A server needs to be online
to be configured. Another consideration is that configuring a server, while another
server is offline, can cause the offline server to come out of synch when it comes
back online again.
4.2.1 Offline Server Causes
A server can be offline towards another server or the entire live system for several
reasons:
• Server is stopped
• Host is shut down
• Cable connection is faulty
• Communication parameters are invalid (wrong address or port)
• Firewall blocks port
4.2.2 Offline Server Problems
Engineering a server while another server is offline can cause the offline server to
come out of synch when it comes back online again.
Server Communication
An offline server’s communication parameter about other Building Operation
servers, those in the Communication tab, becomes inconsistent:
• If you add a new server to the live system
• If you remove a server from the live system
Solution: select the Enterprise Server and click the Repair server
communication command on the Actions -> Advanced menu.
Object References
An offline server’s object references becomes broken:
• If you delete the referenced object
• If you move the referenced object
• If you rename the referenced object
Solution: select the object and click the Repair references command on the
Actions -> Advanced menu.
You know which objects are affected by the list that is displayed to you, in the
confirmation dialog box, at the time you remove/move/rename the objects in
question.
04-16006-04-en, March 2015 Technical
179
4 Server Communication
4.3 Repairing Server Communication
4.3 Repairing Server Communication
You use this procedure to repair server communication. Specifically, offline servers,
when they come back online again, need to know if other servers have been added
or removed.
For more information, see section 4.2 “Server Status” on page 177.
To repair server communication
1. In WorkStation, in the System Tree pane, select the Enterprise Server.
2. On the Actions menu, point to Advanced and then click Repair server
communication.
Technical 04-16006-04-en, March 2015
180
4 Server Communication
4.4 Updating Communication Parameters
4.4 Updating Communication Parameters
You use this procedure to update the communication parameters that servers
maintain about other Building Operation servers. You need to do this manually if the
IP address or any of the configurable ports have been changed in another Building
Operation server.
For more information, see section 4.1 “Server Communication” on page 173.
To update communication parameters
1. In WorkStation, in the System Tree pane, select the Enterprise Server.
2. Click the Communication view.
3. In the Server list, select the server that has a new IP address, a new port
number, or a new communication protocol.
4. In the toolbar, click the Show/Hide Communication settings button .
5. In the Address box, type the new IP address or fully qualified domain name of
the server.
Important
• If the Automation Server has been assigned a dynamic IP
address, use the fully qualified domain name of the server
instead of the IP address.
6. In the Protocol box, select a new protocol if you want to change the way this
server communicates with the other server.
7. In the Port box, enter the new port number.
8. On the toolbar, click the Save button .
04-16006-04-en, March 2015 Technical
181
4 Server Communication
4.5 Updating References
4.5 Updating References
You use this procedure to update broken references. Object references can break if
the server or device on which they reside is offline at the time when the referred
object is either deleted, moved, or renamed.
When a change is made to an object that is referred to by offline objects, a confirm
dialog box is displayed with a list of those objects that are affected. Save that list
and use it to find and update the broken references when they come back online
again.
For more information, see section 4.2 “Server Status” on page 177.
To update references
1. In WorkStation, in the System Tree pane, select the object that has a broken
reference.
2. On the Actions menu, point to Advanced and then click Update
References.
Technical 04-16006-04-en, March 2015
182
4 Server Communication
4.6 Selecting the Schneider Electric E-mail Server for E-mail Notifications
4.6 Selecting the Schneider Electric E-mail
Server for E-mail Notifications
You configure an Automation Server or Enterprise Server to connect to and send E-
mail notifications through the Schneider Electric E-mail Server, which is an SMTP
server hosted by Schneider Electric.
Note
• Any available SMTP server can be used to send E-mail notifications. For more
information, see section 4.7 “Selecting and Specifying an E-mail Server for E-
mail Notifications” on page 183.
For more information, see section 4.1 “Server Communication” on page 173.
To select the Schneider Electric E-mail server for E-mail
notifications
1. In WorkStation, in the System Tree pane, select the server that you want to
configure.
2. On the File menu, click Properties.
3. Click the E-mail tab.
Continued on next page
04-16006-04-en, March 2015 Technical
183
4 Server Communication
4.6 Selecting the Schneider Electric E-mail Server for E-mail Notifications
4. In the Select E-mail server box, select Schneider Electric E-mail
Server to use the SMTP server hosted by Schneider Electric.
5. In the Sender E-mail box, type a sender address for the E-mail messages
that are generated by this server. The sender E-mail address is the receiver of
replies.
6. In the Maximum queue size box, enter the maximum number of E-mail
messages that is allowed in the queue.
7. In the Maximum retry count box, enter the number of attempts to send an
E-mail message that are performed before cancelling the E-mail message.
8. In the Retry time box, enter the number of minutes between each attempt.
9. In the Host box, confirm that the Schneider Electric E-mail Server address is
smtpservice.tac.com.
10. In the Port box, confirm that the port number is 25.
11. Click OK.
Technical 04-16006-04-en, March 2015
184
4 Server Communication
4.7 Selecting and Specifying an E-mail Server for E-mail Notifications
4.7 Selecting and Specifying an E-mail
Server for E-mail Notifications
You configure a Building Operation server to connect to and send e-mail
notifications through an E-mail server or SMTP server.
Note
• The Schneider Electric E-mail Server, which is hosted by Schneider Electric,
can also be selected to send e-mail notifications. For more information, see
section 4.6 “Selecting the Schneider Electric E-mail Server for E-mail
Notifications” on page 181.
For more information, see section 4.1 “Server Communication” on page 173.
To select and specify an e-mail server for e-mail notifications
1. In WorkStation, in the System Tree pane, select the Building Operation
server that you want to configure.
2. On the File menu, click Properties.
Continued on next page
04-16006-04-en, March 2015 Technical
185
4 Server Communication
4.7 Selecting and Specifying an E-mail Server for E-mail Notifications
3. Click the E-mail tab.
4. In the Select E-mail Server box, select Primary/Secondary to specify an
e-mail server.
5. In the Sender E-mail box, type a sender address for the e-mails that are
generated by this Building Operation server. The sender e-mail address is the
receiver of replies.
6. In the Maximum queue size box, enter the maximum number of e-mails
that is allowed in queue.
7. In the Maximum retry count box, enter the number of attempts to send an
e-mail that are performed before abandoning the e-mail.
8. In the Retry time box, enter the number of minutes between each attempt.
9. In the Primary host box, type the primary e-mail server web address.
10. In the Primary user name box, type the user name for the e-mail user
account on the primary e-mail server.
Continued on next page
Technical 04-16006-04-en, March 2015
186
4 Server Communication
4.7 Selecting and Specifying an E-mail Server for E-mail Notifications
11. In the primary Password box, type the password for the e-mail user account
on the primary e-mail server.
12. In the primary Confirm Password box, type the password again for the e-
mail user account on the primary e-mail server.
13. In the Primary port box, enter the port that is designated for incoming SMTP
traffic on the primary e-mail server.
14. In the Secondary host box, type the secondary e-mail server web address.
15. In the Secondary user name box, type the user name that authenticates
the usage of the secondary e-mail server.
16. In the secondary Password box, type the password for the e-mail user
account on the primary e-mail server.
17. In the secondary Confirm Password box, type the password again for the
e-mail user account on the primary e-mail server.
18. In the Secondary port box, enter the port that is designated for incoming
SMTP traffic on the primary e-mail server.
19. Click OK.
04-16006-04-en, March 2015 Technical
187
4 Server Communication
4.8 Server Communication in Project Configuration Server
4.8 Server Communication in Project
Configuration Server
You configure the server communication parameters in WorkStation for Projects,
before you deploy an Enterprise Server or an Automation Server.
For more information, see section 4.1 “Server Communication” on page 173.
Figure: Project Configuration Server communication
It is best practice to configure the server communication parameters before a
deploy of an Automation Server or an Enterprise Server. However, you can
configure the server communication parameters after a deploy by logging on with
WorkStation to the on-site server and setting the DNS/IP address. For more
information, see section 4.4 “Updating Communication Parameters” on page 179.
Logon credentials
You can set the logon credential for the communication between the Project
Configuration Server and the Enterprise Server and Automation Servers. For
example, the default user admin and the password admin, which can be useful
when you are setting up new servers.
For more information, see section 4.9 “Updating Project Configuration Server
Communication Parameters” on page 187.
Technical 04-16006-04-en, March 2015
188
4 Server Communication
4.9 Updating Project Configuration Server Communication Parameters
4.9 Updating Project Configuration Server
Communication Parameters
You update the Project Configuration Server communication parameters to set the
correct DNS/IP address, HTTP/HTTPS/TCP ports, and logon credentials for
communication with the Enterprise Server or Automation Server.
For more information, see section 4.8 “Server Communication in Project
Configuration Server ” on page 186.
To update Project Configuration Server communication
parameters
1. In WorkStation for Projects, in the System Tree pane, select the project
folder and click the Servers tab.
2. In the Protocol box, select the protocol.
3. In the Server Information view, select a server and click the Show/Hide
Communication Settings button .
4. In the Communication tab, in the DNS/IP address box, type the IP
address or fully qualified domain name of the server.
5. In the HTTP port box, select the server HTTP port.
6. In the HTTPS port box, select the server HTTPS port.
7. In the TCP port box, select the server TCP port.
8. In the User name box, type the server logon user name.
9. In the Password box, type the server logon password.
10. In the Confirm Password box, retype the server logon password.
11. Click Save.
04-16006-04-en, March 2015 Technical
189
4 Server Communication
4.10 Setting Server Logon Credential
4.10 Setting Server Logon Credential
You set the logon credential for any server in the project, to be deployed to the
specific server and used in the communication with a server by the Project
Configuration Server.
For more information, see section 4.8 “Server Communication in Project
Configuration Server ” on page 186.
To set a server logon credential
1. In WorkStation for Projects, in the System Tree pane, select the project
folder and click the Servers tab.
2. In the Server Information view, select a server and click the Show/Hide
Communication Settings button .
3. In the Communication tab, in the User name box, type the logon user
name.
Note
The default custom user name is admin, and the default password is
also admin.
4. In the Password box, type the logon password.
5. In the Confirm Password box, retype the logon password.
6. Click Save.
Technical 04-16006-04-en, March 2015
190
5 WorkStation for Projects
Introduction
Topics
WorkStation for Projects Overview
Project Configuration Server
Compatibility Notes
Installing the Project Configuration Server
Upgrading the Project Configuration Server
Configuring Server Port Settings
Stopping the Project Configuration Server Windows Service
Starting the Project Configuration Server Windows Service
Restarting the Server Windows Service
Uninstalling the Project Configuration Server
Reinstalling the Project Configuration Server
WorkStation for Projects
Log on to WorkStation for Projects
Logging on to WorkStation for Projects
Logging off WorkStation for Projects
WorkStation for Projects User Account Management
Creating a WorkStation for Projects User Account
Deleting a WorkStation for Projects User Account
Changing the WorkStation for Projects User Password
Changing other WorkStation for Projects Users Password
Disabling a WorkStation for Projects User Account
Enabling a WorkStation for Projects User Account
Setting an Expiration Date for a WorkStation for Projects
User Account
Removing the Expiration Date for a WorkStation for Projects
User Account
Forcing WorkStation for Projects User to Change Password
5 WorkStation for Projects Introduction
5.1 WorkStation for Projects Overview
5.1 WorkStation for Projects Overview
Project Configuration Server with WorkStation for Projects is an offline engineering
platform that is used for project configuration and deployment.
A dedicated engineering platform separate from the target system facilitates
flexibility. You do not need to spend as much time at the customer site. Much of the
analyzing, designing, modelling, and programming can be done at your office at
your convenience, in a similar way as in WorkStation.
5.1.1 Project Configuration Server
The Project Configuration Server is used for off-site engineering, project
configuration, and deployment of the project configuration to the on-site servers.
You create the project configuration, such as servers, networks, devices, and
schedules. When you connect the Project Configuration Server to the server (either
locally or remotely), you deploy the project to the Enterprise Server or the
Automation Server.
For more information, see section 5.2 “Project Configuration Server” on page 193.
5.1.2 Compatibility Notes
Working with projects in WorkStation for Projects and the Project Configuration
Server is very similar to working in WorkStation in an online system. However, some
features and functionalities are not supported in Project Configuration Server.
For more information, see section 5.3 “Compatibility Notes” on page 196.
5.1.3 WorkStation for Projects
WorkStation for Projects is the user interface that you use to create and configure
projects on the Project Configuration Server so you can work on the projects off
site.
For more information, see section 5.12 “WorkStation for Projects ” on page 220.
5.1.4 Projects
You use the Project Configuration Server to create and configure projects. The
project can be an almost full logical blueprint of the target system, complete with
servers, programs, domains, user groups, networks, devices, and applications.
However, without any historical data.
For more information, see section 6.1 “Projects” on page 239.
04-16006-04-en, March 2015 Technical
193
5 WorkStation for Projects Introduction
5.1 WorkStation for Projects Overview
5.1.5 Project Configuration Server Backup and
Restore
Backup and Restore assures that a project database can be restored after damage
or loss due to hardware or software failures, security threats, or application testing.
Project Configuration Server provides backup and restore capabilities that preserve
the configuration data of a project. Features are the same as for Building Operation
Backup and Restore with a few exceptions:
• You cannot schedule backups.
• You cannot perform multi-server backups.
• You cannot backup alarms.
• You cannot automatically purge backup sets.
For more information, see section 8.2 “Project Backup and Restore” on page 281.
5.1.6 Server Communication in Project
Configuration Server
You configure the server communication parameters in WorkStation for Projects,
before you deploy an Enterprise Server or an Automation Server.
For more information, see section 4.8 “Server Communication in Project
Configuration Server ” on page 186.
5.1.7 Time Zone Configuration in Project
Configuration Server
To adjust the Project Configuration Server time zone and DST, you have to access
the Project Configuration Server through WorkStation for Projects.
For more information, see section 7.2 “Time Zone Configuration in Project
Configuration Server” on page 272.
Technical 04-16006-04-en, March 2015
194
5 WorkStation for Projects Introduction
5.2 Project Configuration Server
5.2 Project Configuration Server
The Project Configuration Server is used for off-site engineering, project
configuration, and deployment of the project configuration to the on-site servers.
You create the project configuration, such as servers, networks, devices, and
schedules. When you connect the Project Configuration Server to the server (either
locally or remotely), you deploy the project to the Enterprise Server or the
Automation Server.
Figure: Project Configuration Server concept
While you are creating a project, you can write, validate, and simulate a program in
a programming editor. However, the Projects Configuration Server does not
communicate with the physical field control devices. Therefore, you cannot
discover, learn, or commission devices when you are working in a project.
04-16006-04-en, March 2015 Technical
195
5 WorkStation for Projects Introduction
5.2 Project Configuration Server
Figure: Project Configuration Server communication concept
WorkStation for Projects is the user interface you use to create objects, create user
accounts for Project Configuration Server, back up the projects, and deploy
projects to an Enterprise Server or Automation Server. For more information, see
section 5.12 “WorkStation for Projects ” on page 220.
5.2.1 Engineering
You can install and run multiple versions of Project Configuration Server on the
same computer as an Enterprise Server.
When connected to the system IP network, the Project Configuration Server can
deploy projects, with domain set-ups, to servers. When working in a project, only
one pre-configured workspace is available.
5.2.2 Features
The Project Configuration Server provides features for project management, and
tools for engineering:
• Project management
• Enterprise Server setup
• Automation Server setup
Technical 04-16006-04-en, March 2015
196
5 WorkStation for Projects Introduction
5.2 Project Configuration Server
• Programming editors
• Binding tool
• Graphics editor
• Domain setup
• Project deployment
5.2.3 License
Project Configuration Server requires no license. However, WorkStation for Projects
used for project configuration requires a WorkStation license since they are installed
with the same installation package.
For more information, see the Licenses topic on WebHelp.
04-16006-04-en, March 2015 Technical
197
5 WorkStation for Projects Introduction
5.3 Compatibility Notes
5.3 Compatibility Notes
Working with projects in WorkStation for Projects and the Project Configuration
Server is very similar to working in WorkStation in an online system. However, some
features and functionalities are not supported in Project Configuration Server.
5.3.1 INET Interface
I/NET is not supported in the Project Configuration Server. In WorkStation for
Projects, you cannot discover devices, learn devices, or retrieve an I/NET device’s
configuration from the I/NET Seven system.
5.3.2 MNL LonWorks
When using the Project Configuration Server, you cannot create MNL LonWorks
devices and applications. Accordingly, the WorkPlace Tech Editor option does not
display in the Control Panel. However, you can engineer MNL LonWorks devices in
an Enterprise Server or Automation Server after you deploy a project to one of these
servers.
5.3.3 Reports
You cannot create reports in the Project Configuration Server. The reports pack
(exported from WebReports) can be uploaded in the Project Configuration Server,
but you cannot view or manage reports in WorkStation for Projects.
5.3.4 Sigma
Sigma is not supported in the Project Configuration Server.
5.3.5 Script Debugger
The Script Debugger is not supported in the Project Configuration Server.
Technical 04-16006-04-en, March 2015
198
5 WorkStation for Projects Introduction
5.4 Installing the Project Configuration Server
5.4 Installing the Project Configuration
Server
You install the Project Configuration Server to configure and deploy projects.
For more information, see the Installation Overview topic on WebHelp.
To install the Project Configuration Server
1. In Windows, disable any anti-virus program.
2. Double-click the Project Configuration Server installation file to start the
installation wizard.
3. Click Yes.
4. Click Next.
Continued on next page
04-16006-04-en, March 2015 Technical
199
5 WorkStation for Projects Introduction
5.4 Installing the Project Configuration Server
5. Click I Agree.
6. Select installation folder and then click Next.
Continued on next page
Technical 04-16006-04-en, March 2015
200
5 WorkStation for Projects Introduction
5.4 Installing the Project Configuration Server
7. Select Project Configuration Server and then click Next.
8. In the Projects Folder box, enter the path to the location where you want to
save the Project Configuration Server projects.
Important
• If a Project Configuration Server is already installed, the project
location of the Project Configuration Server with the highest
version number is default.
• When installing a Project Configuration Server with a different
version number from the currently installed, the new Project
Configuration Server version is installed in parallel to the current
version.
• The user database is copied and upgraded from the current
installation if the current installation has a lower version number.
• The database for a project is located in the project folder.
• The folder path can contain up to 107 characters.
• The folder path can only contain ASCII and Unicode characters.
Continued on next page
04-16006-04-en, March 2015 Technical
201
5 WorkStation for Projects Introduction
5.4 Installing the Project Configuration Server
9. Click Next.
10. Click Next.
Continued on next page
Technical 04-16006-04-en, March 2015
202
5 WorkStation for Projects Introduction
5.4 Installing the Project Configuration Server
11. In the HTTP Port box, type the port number the Project Configuration Server
listens to when communicating through the Hypertext Transfer Protocol.
12. In the HTTPS Port box, type the port number the Project Configuration
Server listens to when communicating through the Hypertext Transfer Protocol
Secure.
13. In the TCP Port box, type the port number the Project Configuration Server
listens to when communicating through the Transmission Control Protocol.
14. Click Install.
Continued on next page
04-16006-04-en, March 2015 Technical
203
5 WorkStation for Projects Introduction
5.4 Installing the Project Configuration Server
15. Click Next.
Note
Click Show details to follow the progress of the installation.
16. Click Finish.
17. In Windows, enable any anti-virus program.
Technical 04-16006-04-en, March 2015
204
5 WorkStation for Projects Introduction
5.5 Upgrading the Project Configuration Server
5.5 Upgrading the Project Configuration
Server
You upgrade the Project Configuration Server to access new features or improve
the performance of the product.
Important
To upgrade Project Configuration Server, you must have access to an installation
package with a higher number than currently installed version.
For more information, see the System Upgrade Overview topic on WebHelp.
To upgrade a Project Configuration Server
1. In Windows, disable any anti-virus program.
2. Double-click on the Project Configuration Server installation file to start the
installation wizard.
3. Click Next, to confirm that you want to run the Project Configuration Server
installation package.
Continued on next page
04-16006-04-en, March 2015 Technical
205
5 WorkStation for Projects Introduction
5.5 Upgrading the Project Configuration Server
4. Click I Agree.
5. Click Next.
Caution
If you previously selected a custom folder for your installation, select
a different installation folder to aviod data loss.
Continued on next page
Technical 04-16006-04-en, March 2015
206
5 WorkStation for Projects Introduction
5.5 Upgrading the Project Configuration Server
6. In the Projects Folder box, enter the path to the location where you want to
save the Project Configuration Server projects.
Important
If a Project Configuration Server is already installed, the set project
location of the installed Project Configuration Server with the highest
version number is default.
When installing a Project Configuration Server with a different version
number as the currently installed Project Configuration Server, the
user database is upgraded. For more information, see the Version
Numbers and Parallel Installations topic on WebHelp.
When installing a Project Configuration Server with a different version
number from the currently installed, the new Project Configuration
Server version is installed in parallel to the current version.
The user database is copied and upgraded from the current
installation with the highest version.
The folder path can contain up to 107 characters.
The folder path can only contain ASCII and Unicode characters.
Important
Projects created in a previous Project Configuration Server version is
not automatically upgraded and have to be upgraded manually in the
new version of WorkStation for Projects. For more information, see
section 6.17 “Upgrading a Project” on page 268.
Continued on next page
04-16006-04-en, March 2015 Technical
207
5 WorkStation for Projects Introduction
5.5 Upgrading the Project Configuration Server
7. Click Next.
8. In the HTTP Port box, type the port number the Project Configuration Server
listens to when communicating through the Hypertext Transfer Protocol.
Important
If you configure the ports manually, make sure not to set the same
HTTP, HTTPS, and TCP ports used in a parallel Project Configuration
Server installation.
9. In the HTTPS Port box, type the port number the Project Configuration
Server listens to when communicating through the Hypertext Transfer Protocol
Secure.
Continued on next page
Technical 04-16006-04-en, March 2015
208
5 WorkStation for Projects Introduction
5.5 Upgrading the Project Configuration Server
10. In the TCP Port box, type the port number the Project Configuration Server
listens to when communicating through the Transmission Control Protocol.
11. Click Install.
12. Click Next.
Note
Click Show details to follow the progress of the installation.
13. Click Finish.
14. In Windows, enable any anti-virus program.
04-16006-04-en, March 2015 Technical
209
5 WorkStation for Projects Introduction
5.6 Configuring Server Port Settings
5.6 Configuring Server Port Settings
You configure server HTTP, HTTPS, and TCP ports to define the communication of
the different protocols. In Software Administrator, you can configure either the ports
of the Enterprise Server or the Project Configuration Server.
For more information, see the Software Administrator topic on WebHelp.
To configure server ports
1. In Software Administrator, click the tab of the Enterprise Server or the
Project Configuration Server.
2. Click Stop Service.
3. In the HTTP Port box, type the port number that the server listens to when
communicating through the Hypertext Transfer Protocol.
4. In the HTTPS Port box, type the port number that the server listens to when
communicating through the Hypertext Transfer Secure Protocol.
5. In the TCP Port box, type the port number that the server listens to when
communicating through the Transmission Control Protocol.
6. Click Apply.
7. Click Start Service.
Technical 04-16006-04-en, March 2015
210
5 WorkStation for Projects Introduction
5.7 Stopping the Project Configuration Server Windows Service
5.7 Stopping the Project Configuration
Server Windows Service
You stop the Project Configuration Server Windows service to configure the port
settings or to repair, upgrade (in future releases), or reinstall the Project
Configuration Server.
For more information, see the Software Administrator topic on WebHelp.
To stop the Project Configuration Server Windows service
1. In Software Administrator, click Stop Service.
04-16006-04-en, March 2015 Technical
211
5 WorkStation for Projects Introduction
5.8 Starting the Project Configuration Server Windows Service
5.8 Starting the Project Configuration
Server Windows Service
You start the Project Configuration Server Windows service manually in case you
previously have stopped it.
Note
The Project Configuration Server Windows service automatically starts when the
server is installed or the computer it is installed on is started.
For more information, see the Software Administrator topic on WebHelp.
To start the Project Configuration Server Windows service
1. In Software Administrator, click Start Service.
Technical 04-16006-04-en, March 2015
212
5 WorkStation for Projects Introduction
5.9 Restarting the Server Windows Service
5.9 Restarting the Server Windows Service
You restart the Enterprise Server or the Project Configuration Server Windows
service to reset or apply new settings.
Important
Ensure that you have a working and available Enterprise Server license. A working
license is required to start the Enterprise Server. For more information, see the
Licenses topic on WebHelp.
For more information, see the Software Administrator topic on WebHelp.
To restart the server Windows service
1. In the Software Administrator, click the tab of the server that you want to
restart.
2. Click Stop Service.
3. Click Start Service.
04-16006-04-en, March 2015 Technical
213
5 WorkStation for Projects Introduction
5.10 Uninstalling the Project Configuration Server
5.10 Uninstalling the Project Configuration
Server
You uninstall a Project Configuration Server to permanently remove the application
from your computer or server.
Note
You do not need to back up the Project Configuration Server before uninstalling
the product. All projects created on the Project Configuration Server are saved on
the computer and remain unaffected by the uninstallation.
For more information, see the Uninstallation topic on WebHelp.
To uninstall the Project Configuration Server
1. On the Windows toolbar, select Start and then click Control Panel.
2. Click Programs and Features.
Continued on next page
Technical 04-16006-04-en, March 2015
214
5 WorkStation for Projects Introduction
5.10 Uninstalling the Project Configuration Server
3. Click Schneider Electric StruxureWare Building Operation Project
Configuration Server x.x and then click Uninstall.
Continued on next page
04-16006-04-en, March 2015 Technical
215
5 WorkStation for Projects Introduction
5.10 Uninstalling the Project Configuration Server
4. When the uninstallation process is completed, click Close.
Technical 04-16006-04-en, March 2015
216
5 WorkStation for Projects Introduction
5.11 Reinstalling the Project Configuration Server
5.11 Reinstalling the Project Configuration
Server
You reinstall the Project Configuration Server to replace your current installation with
a fresh copy.
For more information, see the Installation Overview topic on WebHelp.
To reinstall the Project Configuration Server
1. In Windows, disable any anti-virus program.
2. In Windows, double-click the Project Configuration Server installation file to
start the installation wizard.
3. Click Yes.
4. Click Next.
Continued on next page
04-16006-04-en, March 2015 Technical
217
5 WorkStation for Projects Introduction
5.11 Reinstalling the Project Configuration Server
5. Click I Agree.
6. Click Next.
Continued on next page
Technical 04-16006-04-en, March 2015
218
5 WorkStation for Projects Introduction
5.11 Reinstalling the Project Configuration Server
7. Click Next.
8. Click Next.
Continued on next page
04-16006-04-en, March 2015 Technical
219
5 WorkStation for Projects Introduction
5.11 Reinstalling the Project Configuration Server
9. In the HTTP Port box, type the port number the Project Configuration Server
listens to when communicating through the Hypertext Transfer Protocol.
10. In the HTTPS Port box, type the port number the Project Configuration
Server listens to when communicating through the Hypertext Transfer Protocol
Secure.
11. In the TCP Port box, type the port number the Project Configuration Server
listens to when communicating through the Transmission Control Protocol.
12. Click Install.
Continued on next page
Technical 04-16006-04-en, March 2015
220
5 WorkStation for Projects Introduction
5.11 Reinstalling the Project Configuration Server
13. Click Next.
Note
Click Show details to follow the progress of the installation.
14. Click Finish.
15. In Windows, enable any anti-virus program.
04-16006-04-en, March 2015 Technical
221
5 WorkStation for Projects Introduction
5.12 WorkStation for Projects
5.12 WorkStation for Projects
WorkStation for Projects is the user interface that you use to create and configure
projects on the Project Configuration Server so you can work on the projects off
site. In WorkStation for Projects, you can create user accounts for WorkStation for
Projects, back up the Project Configuration Server, and deploy projects to an
Enterprise Server or Automation Server.
Working with projects in WorkStation for Projects is similar to working with an online
system in WorkStation. However, the Projects Configuration Server does not
communicate with the physical field control devices. Therefore, you cannot
discover, learn, or commission devices when you are working in a project.
Only one pre-configured workspace is available. WorkStation for Projects has
different color schemes on the File menu, the toolbar, and the status bar than
WorkStation to make it easier to tell the difference. For more information, see the
WorkStation topic on WebHelp.
WorkStation for Projects is installed in parallel with WorkStation when installing the
WorkStation installation package.
5.12.1 Log on to WorkStation for Projects
You log on to Project Configuration Server through WorkStation for Projects to
securely access the functions in Project Configuration Server.
For more information, see section 5.13 “Log on to WorkStation for Projects” on
page 221.
5.12.2 License
WorkStation for Projects is installed with the same installation package as
WorkStation, and therefore requires a WorkStation license.
For more information, see the Licenses topic on WebHelp.
5.12.3 WorkStation for Projects User Account
Management
When logging on to WorkStation for Projects, you have to authenticate yourself by
using a valid user account. The first time you log on, you need to use the
administrator user account to create a project user account. You use the project
user account to log on and manage projects (create, delete, or configure).
For more information, see section 5.16 “WorkStation for Projects User Account
Management” on page 224.
Technical 04-16006-04-en, March 2015
222
5 WorkStation for Projects Introduction
5.13 Log on to WorkStation for Projects
5.13 Log on to WorkStation for Projects
You log on to Project Configuration Server through WorkStation for Projects to
securely access the functions in Project Configuration Server.
In WorkStation for Projects, you log on with your project user account. Your system
administrator decides which type of user you log on as.
To log on to WorkStation for Projects using a project account, you need to know
the following account information:
• User name
• Password
• Server
The account information for the project account is provided by the system
administrator.
For a faster log on, use the Remember me feature to automatically fill in your user
name, password, and server in WorkStation for Projects.
04-16006-04-en, March 2015 Technical
223
5 WorkStation for Projects Introduction
5.14 Logging on to WorkStation for Projects
5.14 Logging on to WorkStation for Projects
You use WorkStation for Projects to access the Project Configuration Server.
For more information, see section 5.13 “Log on to WorkStation for Projects” on
page 221.
To log on to WorkStation for Projects
1. In the Building Operation WorkStation for Projects window, in the User
name box, type the user name.
Note
The first time you log on to WorkStation for Projects you need to use
the administrator user account to create a project user account. For
more information, see section 5.17 “Creating a WorkStation for
Projects User Account” on page 225.
2. In the Password box, type the password.
3. In the Server box, select the hypertext transfer protocol you want to use and
then enter a server name or an IP address.
4. Select Remember me to have WorkStation for Projects remember your
settings.
5. Click Log on.
Technical 04-16006-04-en, March 2015
224
5 WorkStation for Projects Introduction
5.15 Logging off WorkStation for Projects
5.15 Logging off WorkStation for Projects
You log off WorkStation for Projects so that unauthorized personnel cannot tamper
with your project. Logging off closes WorkStation for Projects.
For more information, see section 5.13 “Log on to WorkStation for Projects” on
page 221.
To log off WorkStation for Projects
1. In WorkStation for Projects, in the WorkStation for Projects Manager
toolbar, click the Log off button .
04-16006-04-en, March 2015 Technical
225
5 WorkStation for Projects Introduction
5.16 WorkStation for Projects User Account Management
5.16 WorkStation for Projects User Account
Management
When logging on to WorkStation for Projects, you have to authenticate yourself by
using a valid user account. The first time you log on, you need to use the
administrator user account to create a project user account. You use the project
user account to log on and manage projects (create, delete, or configure).
5.16.1 Administrator Account
As a WorkStation for Projects administrator, you can set up users, validate
accounts, and change passwords.
Important
You can configure expiration rules for a WorkStation for Projects user account.
The administrator can also force users to change their passwords in WorkStation
for Projects.
Important
When a password is changed while the user is logged on, the user needs to log
off and log on again before opening a project.
5.16.2 User Account
As a WorkStation for Projects user, you can create projects, deploy projects, and
back up projects.
Up to 10 users are able to work simultaneously in the same project, with the
following limitations:
• Only one user can save configuration changes at a time. The other users save
operations are queued.
• Only one project command (Deploy) can be executed at a time. The other
commands are queued.
• During a deploy of a server from a project, a save of configuration changes to
the server will be queued.
Technical 04-16006-04-en, March 2015
226
5 WorkStation for Projects Introduction
5.17 Creating a WorkStation for Projects User Account
5.17 Creating a WorkStation for Projects
User Account
You create user accounts for specific use in WorkStation for Projects.
For more information, see section 5.16 “WorkStation for Projects User Account
Management” on page 224.
To create a WorkStation for Projects user account
1. In WorkStation for Projects, click the Users tab.
2. In the list, right-click, point to New and then click User Account.
Continued on next page
04-16006-04-en, March 2015 Technical
227
5 WorkStation for Projects Introduction
5.17 Creating a WorkStation for Projects User Account
3. In the Name box, type a user name.
4. In the Description box, type a description.
5. Click Next.
6. In the First name box, type the first name of the person that is going to use
the account.
7. In the Middle name box, type the middle name of the person that is going to
use the account.
Continued on next page
Technical 04-16006-04-en, March 2015
228
5 WorkStation for Projects Introduction
5.17 Creating a WorkStation for Projects User Account
8. In the Last name box, type the last name of the person that is going to use
the account.
9. In the Home E-mail address box, type the home e-mail address of the
person that is going to use the account.
10. In the Work E-mail address box, type the work e-mail address of the
person that is going to use the account.
11. In the Expires on box, enter an expiration date of the user account.
12. In the Password box, type a password for the user account.
13. In the Confirm Password box, retype the password.
14. Click Create.
This user account will be able to work in WorkStation for Projects.
04-16006-04-en, March 2015 Technical
229
5 WorkStation for Projects Introduction
5.18 Deleting a WorkStation for Projects User Account
5.18 Deleting a WorkStation for Projects
User Account
You delete a WorkStation for Projects user account when it is no longer of use.
For more information, see section 5.16 “WorkStation for Projects User Account
Management” on page 224.
To delete a WorkStation for Projects user account
1. In WorkStation for Projects, in the Users tab, right-click on the user to be
deleted and click Delete.
2. Click Yes.
Technical 04-16006-04-en, March 2015
230
5 WorkStation for Projects Introduction
5.19 Changing the WorkStation for Projects User Password
5.19 Changing the WorkStation for Projects
User Password
You use this procedure to change your WorkStation for Projects user account
password for increased system security.
For more information, see section 5.16 “WorkStation for Projects User Account
Management” on page 224.
To change the WorkStation for Projects user password
1. In WorkStation for Projects, in the WorkStation for Projects toolbar, click
the Change Password button.
2. In the Present password box, type the old password.
3. In the New password box, type the new password.
4. In the Confirm new password box, type the new password again.
5. Click OK.
6. Click OK.
Important
You have to log off and then log on again before being able to create
and open projects.
04-16006-04-en, March 2015 Technical
231
5 WorkStation for Projects Introduction
5.20 Changing other WorkStation for Projects Users Password
5.20 Changing other WorkStation for
Projects Users Password
As an administrator, you use this procedure to change any WorkStation for Projects
user account password.
For more information, see section 5.16 “WorkStation for Projects User Account
Management” on page 224.
To change other WorkStation for Projects users password
1. In WorkStation for Projects, on the WorkStation for Projects toolbar, click
the Project Configuration Server Users Domain button.
2. In the Users tab, right-click the user account and then select Open.
3. In the Password box, type the new password.
4. In the Confirm Password box, retype the new password.
5. Click Save.
Technical 04-16006-04-en, March 2015
232
5 WorkStation for Projects Introduction
5.21 Disabling a WorkStation for Projects User Account
5.21 Disabling a WorkStation for Projects
User Account
You disable a user account to prevent the user from accessing WorkStation for
Projects.
For more information, see section 5.16 “WorkStation for Projects User Account
Management” on page 224.
To disable a WorkStation for Projects user account
1. In WorkStation for Projects, on the WorkStation for Projects toolbar, click
the Project Configuration Server Users Domain button.
2. In the Users tab, right-click the user account and select Open.
3. In the Disabled box, select True.
4. Click Save.
The user is now disabled from logging in to WorkStation for Projects.
04-16006-04-en, March 2015 Technical
233
5 WorkStation for Projects Introduction
5.22 Enabling a WorkStation for Projects User Account
5.22 Enabling a WorkStation for Projects
User Account
You enable a user account to give the user access to WorkStation for Projects.
For more information, see section 5.16 “WorkStation for Projects User Account
Management” on page 224.
To enable a WorkStation for Projects user account
1. In WorkStation for Projects, on the WorkStation for Projects toolbar, click
the Project Configuration Server Users Domain button.
2. In the Users tab, right-click the user account and select Open.
3. In the Disabled box, select False.
4. Click Save.
The user is now enabled to log on to WorkStation for Projects.
Technical 04-16006-04-en, March 2015
234
5 WorkStation for Projects Introduction
5.23 Setting an Expiration Date for a WorkStation for Projects User Account
5.23 Setting an Expiration Date for a
WorkStation for Projects User Account
You set an expiration date for an account to limit the time period a user has access
to WorkStation for Projects.
For more information, see section 5.16 “WorkStation for Projects User Account
Management” on page 224.
To set an expiration date for a WorkStation for Projects user
account
1. In WorkStation for Projects, on the WorkStation for Projects toolbar, click
the Project Configuration Server Users Domain button.
2. In the Users tab, right-click the user account and select Open.
3. In the Expires on boxes, select the date and the time for expiration.
4. Click Save.
04-16006-04-en, March 2015 Technical
235
5 WorkStation for Projects Introduction
5.24 Removing the Expiration Date for a WorkStation for Projects User Account
5.24 Removing the Expiration Date for a
WorkStation for Projects User Account
You remove the expiration date for a user account so that there is no time limit for
how long a user can access WorkStation for Projects.
For more information, see section 5.16 “WorkStation for Projects User Account
Management” on page 224.
To remove the expiration date for a WorkStation for Projects
user account
1. In WorkStation for Projects, on the WorkStation for Projects toolbar, click
the Project Configuration Server Users Domain button.
2. In the Users tab, right-click the user account and select Open.
3. In the Expires on boxes, remove the date and time settings for the account.
4. Click Save.
Technical 04-16006-04-en, March 2015
236
5 WorkStation for Projects Introduction
5.25 Forcing WorkStation for Projects User to Change Password
5.25 Forcing WorkStation for Projects User
to Change Password
As an administrator, you use this procedure to force any user of WorkStation for
Projects to change their password at the next log on.
For more information, see section 5.16 “WorkStation for Projects User Account
Management” on page 224.
To force a WorkStation for Projects user to change password
1. In WorkStation for Projects, on the WorkStation for Projects toolbar, click
the Project Configuration Server Users Domain button.
2. In the Users tab, right-click the user account and select Open.
3. In the Force password change box, select True.
4. Click Save.
The user are now forced to change the password, at the next log on to WorkStation
for Projects.
04-16006-04-en, March 2015 Technical
237
6 WorkStation for Projects
Projects
Topics
Projects
Creating a Project
Opening a Project
Closing a Project
Deleting a Project
Creating an Enterprise Server in a Project
Creating an Automation Server in a Project
Deploy
Deploy Workflow
Alternative Deploy Workflow
Variables in Project Configuration Server
Deploying a Server
Moving a Project Database
Synchronization Events
Viewing Synchronization Events
Project Upgrade
Upgrading a Project
6 WorkStation for Projects Projects
6.1 Projects
6.1 Projects
You use the Project Configuration Server to create and configure projects. The
project can be an almost full logical blueprint of the target system, complete with
servers, programs, domains, user groups, networks, devices, and applications.
However, without any historical data.
In a project, you can create either one Enterprise Server or one Automation Server
on the root level. You can configure an Enterprise Server with up to 64 child
Automation Servers.
The following types of objects can be created directly under a project, but they are
not deployed:
• Folder
• Document
• Event View
• Search
Projects are stored in a separate folder specified at the installation of Project
Configuration Server.
You move a project database from an off-site computer to a customer site
computer, when a project cannot be deployed from an off-site computer.
For more information, see section 6.13 “Moving a Project Database” on page 261.
After a project is created, you cannot change the name of the project.
6.1.1 Deploy
You deploy a project to an Enterprise Server or an Automation Server when you are
done with your project engineering off site.
For more information, see section 6.8 “Deploy” on page 248.
6.1.2 Synchronization Events
The synchronization events show the deploy history, such as the time when a
deploy started and who started the deploy.
For more information, see section 6.14 “Synchronization Events” on page 265.
6.1.3 Project Upgrade
Upgrading a project is possible after a new version of the Project Configuration
Server has been installed in parallel to the old version.
When a new version of Project Configuration Server is installed, the database
schemas might have changed, making the old projects incompatible with the new
version of the Project Configuration Server. The projects are not upgraded
automatically when upgrading the Project Configuration Server, but they are visible
for an individual upgrade in the new version.
For more information, see section 6.16 “Project Upgrade” on page 267.
04-16006-04-en, March 2015 Technical
241
6 WorkStation for Projects Projects
6.2 Creating a Project
6.2 Creating a Project
You create a project so that you can configure a Building Operation system off site.
Note
Project names are not case sensitive. For example, you cannot have a project
called “Project1” and another called “project1”.
Note
After a project is created, you cannot change the name of the project.
For more information, see section 6.1 “Projects” on page 239.
To create a project
1. In WorkStation for Projects, in the WorkStation for Projects - Projects
view, click the New Project button .
2. In the Name box, type a name for the project.
3. In the Description box, type a description for the project.
4. Click Create.
Technical 04-16006-04-en, March 2015
242
6 WorkStation for Projects Projects
6.3 Opening a Project
6.3 Opening a Project
You open a project to configure a project or to deploy a project to a server.
For more information, see section 6.1 “Projects” on page 239.
To open a project
1. In WorkStation for Projects, in the WorkStation for Projects - Projects
view, select the project that you want to open.
2. On the toolbar, click the Open Project button .
The project opens in WorkStation for Projects.
04-16006-04-en, March 2015 Technical
243
6 WorkStation for Projects Projects
6.4 Closing a Project
6.4 Closing a Project
You close a project when you are done with your project engineering.
For more information, see section 6.1 “Projects” on page 239.
To close a project
1. In WorkStation for Projects, with a project open, click File menu.
2. Click Close project.
The project is closed and you are redirected to the projects view.
Technical 04-16006-04-en, March 2015
244
6 WorkStation for Projects Projects
6.5 Deleting a Project
6.5 Deleting a Project
You delete a project when you no longer need it.
For more information, see section 6.1 “Projects” on page 239.
To delete a project
1. In WorkStation for Projects, in the WorkStation for Projects - Projects
view, select the project that you want to delete.
2. On the WorkStation for Projects toolbar, click the Delete button .
3. Click Yes.
04-16006-04-en, March 2015 Technical
245
6 WorkStation for Projects Projects
6.6 Creating an Enterprise Server in a Project
6.6 Creating an Enterprise Server in a
Project
You create an Enterprise Server in a project in order to be able to configure it offline.
Note
After a server is created, you cannot change the name of the server.
For more information, see section 6.1 “Projects” on page 239.
To create an Enterprise Server in a project
1. In WorkStation for Projects, in the System Tree pane, in the project folder,
select the Servers folder.
2. On the File menu, point to New and then click Server.
3. In the object type list, select Enterprise Server.
4. In the Name box, type a name for the server.
5. In the Description box, type descriptive information about the server.
6. Click Next.
Continued on next page
Technical 04-16006-04-en, March 2015
246
6 WorkStation for Projects Projects
6.6 Creating an Enterprise Server in a Project
7. In the DNS/IP address box, type the IP address or fully qualified domain
name of the server.
Important
Ensure that you use either an IP address or a fully qualified domain
name to avoid lead-shadow communication problems after deploy.
For more information, see section 144.7 “Lead-Shadow Reference
Server Communication Problems ” on page 5477.
8. In the HTTP port box, select the appropriate HTTP port.
9. In the HTTPS port box, select the appropriate HTTPS port.
10. In the TCP port box, select the appropriate TCP port.
11. In the User name box, type the user name.
12. In the Password box, type the password.
13. In the Confirm Password box, retype the password.
14. Click Create.
04-16006-04-en, March 2015 Technical
247
6 WorkStation for Projects Projects
6.7 Creating an Automation Server in a Project
6.7 Creating an Automation Server in a
Project
You create an Automation Server in a project in order to be able to configure it
offline.
For more information, see section 6.1 “Projects” on page 239.
Important
When you create a new Automation Server under the Enterprise Server after an
Enterprise Server deploy, the Enterprise Server will not recognize the Automation
Server. This has to be done on the on-line server.
To create an Automation Server in a project
1. In WorkStation for Projects, in the System Tree pane, in the project folder,
select the Servers folder where you want to create the Automation Server.
2. On the File menu, point to New and then click Server.
3. In the Name box, type a name for the server.
4. In the Description box, type descriptive information about the server.
5. Click Next.
Continued on next page
Technical 04-16006-04-en, March 2015
248
6 WorkStation for Projects Projects
6.7 Creating an Automation Server in a Project
6. In the DNS/IP address box, type the IP address or fully qualified domain
name of the server.
7. In the HTTP port box, select the appropriate HTTP port.
8. In the HTTPS port box, select the appropriate HTTPS port.
9. In the TCP port box, select the appropriate TCP port.
10. In the User name box, type the user name.
11. In the Password box, type the password.
12. In the Confirm Password box, retype the password.
13. In the Communication Protocol box, select the server communication
protocol.
14. Click Create.
04-16006-04-en, March 2015 Technical
249
6 WorkStation for Projects Projects
6.8 Deploy
6.8 Deploy
You deploy the project when you want to download the project configuration to an
Enterprise Server or Automation Servers.
A deploy downloads configurations to one specific server. Objects in a child server
are not deployed when the parent server is deployed. For example, you deploy ES1
with child Automation Server AS1. In WorkStation, only the AS1 object under ES1 is
displayed in the System Tree pane, as an offline server. The objects under the AS1
are not displayed because they have not been deployed yet.
Figure: Deploy of Enterprise Server
Important
• You can only deploy a project to a server when the server has an empty
database and not have been part of a multi-server system. A server is
considered empty when it does not contain any user-created objects, such
as programs and graphics.
The server database can be emptied in different ways depending on if it is an
Automation Server or an Enterprise Server:
• Reinstall the Enterprise Server. For more information, see the Reinstalling the
Enterprise Server topic on WebHelp.
• Upgrade the Automation Server with a new database. For more information,
see the Uploading and Upgrading an Automation Server topic on WebHelp.
You move the project database from an off-site computer to an on-site computer
when you cannot deploy to the on-site computer. For example, there is no network
connection between the off-site computer and the on-site computer. When the
project database has been moved to the on-site computer, you deploy the project
configuration to the Automation Server or Enterprise Server with WorkStation for
Projects.
Technical 04-16006-04-en, March 2015
250
6 WorkStation for Projects Projects
6.8 Deploy
Figure: Deploy of project configuration to server
For more information, see section 6.12 “Deploying a Server” on page 260.
For more information, see section 6.13 “Moving a Project Database” on page 261.
You configure the server communication parameters in WorkStation for Projects,
before you deploy an Enterprise Server or an Automation Server.
For more information, see section 4.8 “Server Communication in Project
Configuration Server ” on page 186.
6.8.1 Deploy Workflow
Setting up a project and synchronize it with servers at the customer site can be
done with different workflows depending on the type of devices used in the project.
You use the generic Deploy Workflow to start setting up the project and the servers.
For more information, see section 6.9 “Deploy Workflow” on page 251.
6.8.2 Alternative Deploy Workflow
Use the Alternative Deploy Workflow to engineer and deploy a project to a Building
Operation server when you cannot set the server communication settings. For
example, the site network is not configured, IP addresses are missing, or the IP
address on the Enterprise Server has changed since the Automation Server deploy.
04-16006-04-en, March 2015 Technical
251
6 WorkStation for Projects Projects
6.8 Deploy
For more information, see section 6.10 “Alternative Deploy Workflow” on page 254.
6.8.3 Variables in Project Configuration Server
Non-retained variables cannot be edited in WorkStation for Projects, and are not
deployed.
For more information, see section 6.11 “Variables in Project Configuration Server ”
on page 259.
Technical 04-16006-04-en, March 2015
252
6 WorkStation for Projects Projects
6.9 Deploy Workflow
6.9 Deploy Workflow
Use the Deploy Workflow to deploy a project to a Building Operation server. This
workflow describes a generic workflow and then refer to each protocols device
workflow as the next step to complete a project deploy.
Figure: Deploy LonWorks project workflow
Create a project
In WorkStation for Projects, create a project for the LonWorks system. For more
information, see section 6.2 “Creating a Project” on page 240.
Create an Enterprise Server
In WorkStation for Projects, create an Enterprise Server in project.
04-16006-04-en, March 2015 Technical
253
6 WorkStation for Projects Projects
6.9 Deploy Workflow
For more information, see section 6.6 “Creating an Enterprise Server in a Project”
on page 244.
Create Automation Servers
In WorkStation for Projects, create all Automation Servers in the project.
For more information, see section 6.7 “Creating an Automation Server in a Project”
on page 246.
Create devices
In WorkStation for Projects, continue with the appropriate protocol device
workflows to create devices offline and to deploy the Automation Servers and the
Enterprise Server to the on-site server, with specific domain device procedures.
For more information, see section 56.19 “Create LonWorks Device Workflow” on
page 2034.
For more information, see section 61.7 “Create Xenta LonWorks Device Workflow”
on page 2216.
For more information, see section 73.9 “BACnet System Configuration Workflows”
on page 2564.
For more information, see section 83.7 “Create b3 BACnet Devices with Factory
Settings Workflow” on page 3278.
For more information, see section 83.8 “Create Previously Used b3 BACnet Devices
Workflow” on page 3281.
Update server communication parameters
In WorkStation for Projects, update the server communication parameters for all
servers.
For more information, see section 4.9 “Updating Project Configuration Server
Communication Parameters” on page 187.
Important
It is recommended that you update the Enterprise Server communication
parameters before the deploy of the first Automation Server.
Deploy the Automation Servers
In WorkStation for Projects, deploy the Automation Servers.
Important
Ensure that you have created all domain devices and objects before the deploy of
an Automation Server. If you add devices and objects to the Automation Server
and deploy the server again, you first have to clear the database of the physical
Automation Server.
For more information, see section 6.8 “Deploy” on page 248.
Deploy the Enterprise Server
In WorkStation for Projects, deploy the Enterprise Server.
Technical 04-16006-04-en, March 2015
254
6 WorkStation for Projects Projects
6.9 Deploy Workflow
Important
Ensure that you have created all Automation Servers in the project before the
deploy of the Enterprise Server. You can only deploy to an empty Enterprise
Server. Any additional Automation Servers have to be created on the on-site
server.
For more information, see section 6.8 “Deploy” on page 248.
04-16006-04-en, March 2015 Technical
255
6 WorkStation for Projects Projects
6.10 Alternative Deploy Workflow
6.10 Alternative Deploy Workflow
Use the Alternative Deploy Workflow to engineer and deploy a project to a Building
Operation server when you cannot set the server communication settings. For
example, the site network is not configured, IP addresses are missing, or the IP
address on the Enterprise Server has changed since the Automation Server deploy.
If you have all the server communication settings beforehand, use the Deploy
workflow. For more information, see section 6.9 “Deploy Workflow” on page 251.
Technical 04-16006-04-en, March 2015
256
6 WorkStation for Projects Projects
6.10 Alternative Deploy Workflow
Figure: Server Engineering flowchart
04-16006-04-en, March 2015 Technical
257
6 WorkStation for Projects Projects
6.10 Alternative Deploy Workflow
Create a project and all servers
In WorkStation for Projects, create a project and all servers necessary.
For more information, see the Creating a Project topic on WebHelp.
For more information, see section 6.6 “Creating an Enterprise Server in a Project”
on page 244.
For more information, see section 6.7 “Creating an Automation Server in a Project”
on page 246.
Configure the first batch of Automation Servers and devices
In WorkStation for Projects, configure the first batch of Automation Servers,
creating all necessary devices, objects, alarms, trends, and references.
For more information, see section 56.19 “Create LonWorks Device Workflow” on
page 2034.
For more information, see section 61.7 “Create Xenta LonWorks Device Workflow”
on page 2216.
For more information, see section 73.9 “BACnet System Configuration Workflows”
on page 2564.
For more information, see section 83.7 “Create b3 BACnet Devices with Factory
Settings Workflow” on page 3278.
For more information, see section 83.8 “Create Previously Used b3 BACnet Devices
Workflow” on page 3281.
Configure temporary communication parameters
In WorkStation for Projects, configure temporary communication parameters for the
servers because the final communication parameters are not known or available at
this point for any servers.
For more information, see section 4.9 “Updating Project Configuration Server
Communication Parameters” on page 187.
Deploy first batch of Automation Servers
In WorkStation for Projects, deploy the first batch of Automation Servers.
For more information, see section 6.12 “Deploying a Server” on page 260.
Important
Ensure that you have created all domain devices and objects before the deploy of
an Automation Server. If you add devices and objects to the Automation Server
and deploy the server again, you first have to clear the database of the physical
Automation Server.
For more information, see section 6.8 “Deploy” on page 248.
Configure second batch of Automation Servers
In WorkStation for Projects, continue project configuration of the second batch of
Automation Servers, creating all necessary devices, objects, alarms, trends, and
references.
For more information, see section 56.19 “Create LonWorks Device Workflow” on
page 2034.
Technical 04-16006-04-en, March 2015
258
6 WorkStation for Projects Projects
6.10 Alternative Deploy Workflow
For more information, see section 61.7 “Create Xenta LonWorks Device Workflow”
on page 2216.
For more information, see section 73.9 “BACnet System Configuration Workflows”
on page 2564.
For more information, see section 83.7 “Create b3 BACnet Devices with Factory
Settings Workflow” on page 3278.
For more information, see section 83.8 “Create Previously Used b3 BACnet Devices
Workflow” on page 3281.
Update server communication parameters
In WorkStation for Projects, configure the final communications parameters for all
servers, including the Enterprise Server.
For more information, see section 4.4 “Updating Communication Parameters” on
page 179.
Deploy second batch of Automation Servers
In WorkStation for Projects, deploy the second batch of Automation Servers.
For more information, see section 6.12 “Deploying a Server” on page 260.
Deploy the Enterprise Server
In WorkStation for Projects, deploy the Enterprise Server.
For more information, see section 6.12 “Deploying a Server” on page 260.
Important
Ensure that you have created all Automation Servers before the deploy of the
Enterprise Server. You can only deploy to an empty Enterprise Server. Any
additional Automation Servers have to be created on the on-site server.
For more information, see section 6.8 “Deploy” on page 248.
Repair Communication Settings
Because the first batch of Automation Servers have incorrect communication
settings at this point, you need to manually repair the communication settings in the
on-site Enterprise Server.
For more information, see section 4.3 “Repairing Server Communication ” on page
178.
Note
All bindings will be synchronized as soon as all server communication are
resolved by the Enterprise Server which can take a couple of minutes.
Configure the third batch of Automation Servers
In WorkStation for Projects, continue project configuration with the last batch of
Automation Servers, creating all necessary devices, objects, alarms, trends, and
references.
For more information, see section 56.19 “Create LonWorks Device Workflow” on
page 2034.
04-16006-04-en, March 2015 Technical
259
6 WorkStation for Projects Projects
6.10 Alternative Deploy Workflow
For more information, see section 61.7 “Create Xenta LonWorks Device Workflow”
on page 2216.
For more information, see section 73.9 “BACnet System Configuration Workflows”
on page 2564.
For more information, see section 83.7 “Create b3 BACnet Devices with Factory
Settings Workflow” on page 3278.
For more information, see section 83.8 “Create Previously Used b3 BACnet Devices
Workflow” on page 3281.
Deploy the third batch of Automation Servers
In WorkStation for Projects, deploy the third batch of Automation Servers.
For more information, see section 6.12 “Deploying a Server” on page 260.
Technical 04-16006-04-en, March 2015
260
6 WorkStation for Projects Projects
6.11 Variables in Project Configuration Server
6.11 Variables in Project Configuration
Server
Non-retained variables cannot be edited in WorkStation for Projects, and are not
deployed.
Retained variables can be edited and are always deployed.
For more information, see section 51.67 “Variables” on page 1726.
04-16006-04-en, March 2015 Technical
261
6 WorkStation for Projects Projects
6.12 Deploying a Server
6.12 Deploying a Server
You deploy a server configuration to an Enterprise Server or Automation Server to
add the configuration that you have created off site.
For more information, see section 6.8 “Deploy” on page 248.
Important
It is recommended that you update the Enterprise Server communication
parameters before the deploy of the of the first Automation server, and all
Automation Server communication parameters before the deploy of the
Enterprise Server.
Caution
Ensure that you have created all domain devices and objects before the deploy of
an Automation Server. If you add devices and objects to the Automation Server
and deploy the server again, you first have to clear the database of the physical
Automation Server.
Ensure that you have created all objects and servers, with devices and objects, in
the project and deployed all Automation Servers before the deploy of the
Enterprise Server. Any additional servers, devices, and objects have to be created
on the on-site server.
For more information, see section 6.8 “Deploy” on page 248.
To deploy a server
1. In WorkStation for Projects, in the System Tree pane, select the server that
you want to deploy.
2. On the Actions menu, click Deploy.
3. Click Yes.
4. Click Close.
You can now commission or associate the devices to bring them online with the
Enterprise Server or Automation Server.
Technical 04-16006-04-en, March 2015
262
6 WorkStation for Projects Projects
6.13 Moving a Project Database
6.13 Moving a Project Database
You move a project database from an off-site computer to a customer site
computer, when a project cannot be deployed from an off-site computer.
For more information, see section 6.8 “Deploy” on page 248.
To move a project database
1. On the source computer, in WorkStation for Projects, ensure that the project is
backed up. For more information, see the Checking the Backup Status of a
Server topic on WebHelp.
2. Close WorkStation for Projects.
3. Wait 5 minutes to ensure that the project is closed.
Note
A project closes 5 minutes after the last user has logged off or when
the Project Configuration Server Windows service is stopped in
Software Administrator.
Note
When multiple users are working with the Project Configuration
Server, make sure a stop of the Project Configuration Server
Windows service does not negatively affect your projects before
closing.
Continued on next page
04-16006-04-en, March 2015 Technical
263
6 WorkStation for Projects Projects
6.13 Moving a Project Database
4. In Software Administrator, in the Project Configuration Server tab, copy
the path of the Projects folder.
5. In Windows Explorer, in the Address box, paste the path of the Projects
folder.
6. Move the individual project folder to a USB drive or to another appropriate
media.
Continued on next page
Technical 04-16006-04-en, March 2015
264
6 WorkStation for Projects Projects
6.13 Moving a Project Database
7. On the target computer, in Software Administrator, in the Project
Configuration Server tab, copy the path of the Projects folder.
8. In Windows Explorer, in the Address box, paste the path of the Projects
folder.
9. Move the individual project folder from the USB drive to the Projects folder.
The project can now be opened in WorkStation for Projects on the target computer.
04-16006-04-en, March 2015 Technical
265
6 WorkStation for Projects Projects
6.13 Moving a Project Database
Important
To see the recently moved project in WorkStation for Projects - Projects view on
the target computer, refresh the view or restart the Project Configuration Server.
For more information, see section 144.9 “Project Not Visible” on page 5479.
Technical 04-16006-04-en, March 2015
266
6 WorkStation for Projects Projects
6.14 Synchronization Events
6.14 Synchronization Events
The synchronization events show the deploy history, such as the time when a
deploy started and who started the deploy.
Synchronization events are generated when the following actions occurs:
• deploy command is queued
• deploy is actually started
• deploy is successful
• deploy has failed
For more information, see section 9.10 “Synchronization Event View” on page 321.
04-16006-04-en, March 2015 Technical
267
6 WorkStation for Projects Projects
6.15 Viewing Synchronization Events
6.15 Viewing Synchronization Events
You use the Synchronization Events view to show the WorkStation for Projects
synchronization event history and details, such as deploy.
For more information, see section 6.14 “Synchronization Events” on page 265.
To view synchronization events
1. In WorkStation for Projects, in the System Tree pane, click the
Synchronization Events View.
2. Click the Detail view button to see details of the selected event in a new
pane.
Technical 04-16006-04-en, March 2015
268
6 WorkStation for Projects Projects
6.16 Project Upgrade
6.16 Project Upgrade
Upgrading a project is possible after a new version of the Project Configuration
Server has been installed in parallel to the old version.
When a new version of Project Configuration Server is installed, the database
schemas might have changed, making the old projects incompatible with the new
version of the Project Configuration Server. The projects are not upgraded
automatically when upgrading the Project Configuration Server, but they are visible
for an individual upgrade in the new version.
Important
When manually upgrading the projects, the old version of the projects will be
deleted. It is advisable to make backups or copies of the old versions before
upgrading, such as storing them in version folders on the off-site computer.
All servers that are to be synchronized with an upgraded project must also be
upgraded to the same version.
For more information, see section 6.17 “Upgrading a Project” on page 268.
6.16.1 Parallel installation of new version of Project
Configuration Server
You install the new version of Project Configuration Server parallel to the old version
in order to make the old projects visible, and to upgrade these in the new version of
Project Configuration Server. The old projects will only be visible with an overlay,
and cannot be opened.
The installation folder path can contain up to 107 characters, and only ASCII and
Unicode characters can be used.
For more information, see section 5.5 “Upgrading the Project Configuration Server”
on page 203.
For more information, see the Version Numbers and Parallel Installations topic on
WebHelp.
6.16.2 Upgrade of Project Configuration Server
The user database is copied and upgraded automatically when installing the new
version of Project Configuration Server.
For more information, see the Project Configuration Server Upgrade Workflow topic
on WebHelp.
04-16006-04-en, March 2015 Technical
269
6 WorkStation for Projects Projects
6.17 Upgrading a Project
6.17 Upgrading a Project
Upgrading a project is possible after a new version of the Project Configuration
Server has been installed in parallel to the old version. You use this procedure to
upgrade a project.
For more information, see section 6.16 “Project Upgrade” on page 267.
To upgrade a project
1. Install the new version of Project Configuration Server. For more information,
see section 5.5 “Upgrading the Project Configuration Server” on page 203.
2. In the newest version of WorkStation for Projects, in the WorkStation for
Projects - Projects view, select the project and click the Upgrade Project
button .
3. Click Yes.
You can now open the project and make configurations. The project will also no
longer be visible in the older version of WorkStation for Projects.
Technical 04-16006-04-en, March 2015
270
7 Project Configuration Server
Time Zone
Topics
Time and Time Zone
Time Zone Configuration in Project Configuration Server
Changing the Time Zone of a Project
Creating a Custom Time Zone for a Project
7 Project Configuration Server Time Zone
7.1 Time and Time Zone
7.1 Time and Time Zone
A time zone is a region on the earth that has a uniform standard time, usually
referred to as the local time. Local time is the UTC time plus the current time zone
offset for the considered location. Some time zones also have an offset called DST
added during the summer period. The DST offset is typically +1 hour.
7.1.1 Network Time
Consistent date and timestamping across a network is critical for system wide
access control, security, communications, scheduling, alarms, and events. Network
time uses the NTP protocol that provides the correct current UTC time.
For more information, see the Network Time topic on WebHelp.
7.1.2 Time and Time Zone Configuration in
WorkStation
In WorkStation, all times are by default displayed in local time. This means that a
time, independent of its source, is displayed in the same time zone as the operating
system on which WorkStation is installed. By configuring the operating system time
and time zone settings, you configure how times are displayed in WorkStation. For
more information, please refer to the manufacturer’s manual for the operating
system.
For more information, see the Time and Time Zone Configuration in WorkStation
topic on WebHelp.
7.1.3 Time and Time Zone Configuration in
Enterprise Server
The Enterprise Server time and date settings are configured through the operating
system settings on which the Enterprise Server is installed. The time zone offset,
configured through the Enterprise Server, is added by Building Operation to the
UTC time. The Enterprise Server time zone settings are therefore independent of
the operating system time zone settings.
For more information, see the Time and Time Zone Configuration in Enterprise
Server topic on WebHelp.
7.1.4 Time and Time Zone Configuration in
Automation Server
To adjust the Automation Server time, time zone, and DST, you have to access the
Automation Server through a WorkStation.
For more information, see the Time and Time Zone Configuration in Automation
Server topic on WebHelp.
04-16006-04-en, March 2015 Technical
273
7 Project Configuration Server Time Zone
7.2 Time Zone Configuration in Project Configuration Server
7.2 Time Zone Configuration in Project
Configuration Server
To adjust the Project Configuration Server time zone and DST, you have to access
the Project Configuration Server through WorkStation for Projects.
Figure: Project Configuration Server time zone
Technical 04-16006-04-en, March 2015
274
7 Project Configuration Server Time Zone
7.3 Changing the Time Zone of a Project
7.3 Changing the Time Zone of a Project
You change the time zone of a project to adjust the UTC offset.
For more information, see section 7.2 “Time Zone Configuration in Project
Configuration Server” on page 272.
To change the time zone of a project
1. In WorkStation for Projects, on the Tools menu, click Control Panel.
2. On the Control Panel toolbar, select the project.
3. Click Network time and time zones.
Continued on next page
04-16006-04-en, March 2015 Technical
275
7 Project Configuration Server Time Zone
7.3 Changing the Time Zone of a Project
4. In the Project Date & Time view, select Predefined time zone and then
select the time zone the Project Configuration Server is located in.
5. Click Save.
If your time zone not is listed, you can create and configure a custom time zone.
Technical 04-16006-04-en, March 2015
276
7 Project Configuration Server Time Zone
7.4 Creating a Custom Time Zone for a Project
7.4 Creating a Custom Time Zone for a
Project
You use this procedure to set a custom time zone for a project.
For more information, see section 7.2 “Time Zone Configuration in Project
Configuration Server” on page 272.
To create a custom time zone for a project
1. In WorkStation for Projects, on the Tools menu, select Control Panel.
2. On the Control Panel toolbar, select the project.
3. In the Project Date & Time view, click Network time and time zones.
Continued on next page
04-16006-04-en, March 2015 Technical
277
7 Project Configuration Server Time Zone
7.4 Creating a Custom Time Zone for a Project
4. Select Custom time zone.
5. In the Description box, type a descriptive text for the time zone.
6. In the UTC Offset boxes, select the UTC offset in hours and minutes.
7. Select This custom time zone uses daylight saving time.
8. In the Time adjustment box, select the saving time in minutes.
9. Under the Start column, select the Month, Week, Date, and Time to start
using daylight saving time.
10. Under the End column, select the Month, Week, Date, and Time to start
using daylight saving time.
11. Click Save.
Technical 04-16006-04-en, March 2015
278
8 Project Configuration Server
Backup and Restore Overview
Topics
Backup and Restore Overview
Project Backup and Restore
Project Backup
Project Configuration Server Backup Sets
Backup Set Storage and Protection
Project Configuration Backup Status
Checking the Backup Status of a Project
Backing Up a Project
Locating the Local Backup Path on the Project Configuration
Server
Deleting a Backup Set from a Project
Project Restore
Restored Data
Restoring a Project
8 Project Configuration Server Backup and Restore Overview
8.1 Backup and Restore Overview
8.1 Backup and Restore Overview
Backup and Restore assures that Building Operation server data can be restored
after damage or loss due to hardware or software failures, security threats, or
application testing.
Building Operation provides backup and restore capabilities that preserve both
configuration and historical data on an as-needed or periodic basis.
8.1.1 Backup
Backup is the process of copying and storing data so that the copy can be used to
restore the primary source if a data loss occurs as well as to revert to an older
version. Ideally, server backups should take place during non-business hours. In
Building Operation, you can perform backups on an individual server and its devices
or a group of servers and their devices.
Building Operation provides two backup options:
• Configuration only: Useful for new installations, Building Operation backs up
the configuration database, which preserves a snapshot of the configuration
data for a particular date and time.
• All data: Useful for existing systems, Building Operation backs up the
configuration data and historical data, which preserves a snapshot of the
configuration data for a particular date and includes a copy of the trend logs
and event logs.
For more information, see the Backup topic on WebHelp.
8.1.2 Restore
Restore is the process of restoring data to an original or former state. Using
Restore, you can revert to a previous snapshot of the server data despite any
configuration changes made since the last backup. In Building Operation, Restore is
a manual process designed to avoid the accidental overwriting of current server
data.
For more information, see the Restore topic on WebHelp.
8.1.3 BACnet Backup and Restore
BACnet Backup uses a binary file format to back up an entire device. Specifically,
BACnet Backups comprise the entire contents of the selected device, such as
associated objects, properties, bindings, historical data, and related proprietary
configuration data.
For more information, see section 75.39 “BACnet Backup and Restore” on page
2653.
04-16006-04-en, March 2015 Technical
281
8 Project Configuration Server Backup and Restore Overview
8.1 Backup and Restore Overview
8.1.4 Archiving Overview
Archiving is the process of preserving historical data, which is comprised of
selected events and extended trend logs. For example, some facilities are required
to maintain archives to comply with government regulations. Another example is in
secure facilities where they must maintain records of who logged in or who
changed setpoints. Archiving is not a backup function because archive data cannot
be imported back into the system.
For more information, see the Archiving Overview topic on WebHelp.
8.1.5 Comparison of Backup and Restore Methods
There are two Backup and Restore methods: Building Operation and BACnet. You
can select the backup and restore method that suits your server data storage and
retrieval requirements.
For more information, see the Comparison of Backup and Restore Methods topic
on WebHelp.
Technical 04-16006-04-en, March 2015
282
8 Project Configuration Server Backup and Restore Overview
8.2 Project Backup and Restore
8.2 Project Backup and Restore
Backup and Restore assures that a project database can be restored after damage
or loss due to hardware or software failures, security threats, or application testing.
Project Configuration Server provides backup and restore capabilities that preserve
the configuration data of a project. Features are the same as for Building Operation
Backup and Restore with a few exceptions:
• You cannot schedule backups.
• You cannot perform multi-server backups.
• You cannot backup alarms.
• You cannot automatically purge backup sets.
8.2.1 Project Backup
Backup is the process of copying and storing data so that the copy can be used to
restore the primary source if a data loss occurs as well as to revert to an older
version. Ideally, server backups should take place during non-business hours.
For more information, see section 8.3 “Project Backup” on page 282.
8.2.2 Project Restore
Restore is the process of restoring data to an original or former state. Using
Restore, you can revert back to a previous snapshot of the project data despite any
configuration changes made since the last backup. In Project Configuration Server,
restore is designed to be a manual rather than an automatic process to avoid the
accidental overwriting of current server data. For convenience, only the backup files
that apply to the selected server are displayed.
For more information, see section 8.11 “Project Restore” on page 292.
04-16006-04-en, March 2015 Technical
283
8 Project Configuration Server Backup and Restore Overview
8.3 Project Backup
8.3 Project Backup
Backup is the process of copying and storing data so that the copy can be used to
restore the primary source if a data loss occurs as well as to revert to an older
version. Ideally, server backups should take place during non-business hours.
You can select the type of data to back up:
• Configuration only: Project Configuration Server backs up the project
configuration database, which includes points, values, alarm objects, trend
objects, programs, graphics, and custom object type data.
• All data: Project Configuration Server backs up the project configuration
database and the historical database, which include synchronization events.
Note
The system generates default backup names that are a combination of the
project name and the server date, and time. For ease of use, manual backups
include the local time of the Project Configuration Server, such as University X
Project_20130823-020127. The server date stamp that is recorded within the
backup set is based on the local time zone of Project Configuration Server.
Backup Set Renaming
When you create a backup, the system initially names the backup set by combining
the server name with the localized date and time of the computer running
WorkStation for Projects. However, you can change this initial (default) name prior
to generating the backup. If some backup sets are given identical names by
mistake, the duplicate backup sets (restore points) display in the Restore Options
dialog box.
Backup Comments
When you create a manual backup, you can also add a comment up to 255
characters to identify a particular backup set. Once the backup completes, the
system displays these comments as ToolTips in the Restore Options dialog box.
For example, you can add a comment, After Deploy, to backups of deployed
projects. For more information, see the Backup Options Dialog Box topic on
WebHelp.
8.3.1 Project Configuration Server Backup Sets
Backup sets are compressed backup files used for restoring data. Building
Operation stores the local backup set for a Project Configuration Server, Enterprise
Server or Automation Server under a Local folder in the Backup sets folder.
For more information, see section 8.4 “Project Configuration Server Backup Sets”
on page 284.
8.3.2 Project Configuration Server Backup Status
You can check the current backup status of a server from the Backup and Restore
Manager. Backup Status displays the statuses of a server: Ready, Backing up, or
Backup succeeded.
Technical 04-16006-04-en, March 2015
284
8 Project Configuration Server Backup and Restore Overview
8.3 Project Backup
For more information, see section 8.6 “Project Configuration Backup Status” on
page 286.
04-16006-04-en, March 2015 Technical
285
8 Project Configuration Server Backup and Restore Overview
8.4 Project Configuration Server Backup Sets
8.4 Project Configuration Server Backup
Sets
Backup sets are compressed backup files used for restoring data. Building
Operation stores the local backup set for a Project Configuration Server, Enterprise
Server or Automation Server under a Local folder in the Backup sets folder.
Figure: Backup sets in the Local folder
Server Rename
Building Operation associates each backup set with a particular server name.
Therefore, you should not rename a Building Operation server unless absolutely
necessary. If you do rename a server, the previous backup sets do not display in
the Restore Options dialog box. You can view all the backup sets that are stored
locally on a Project Configuration Server. For more information, see Locating the
Local Backup Path on the Project Configuration Server
Tip
Going forward, you must create new backups for the renamed server.
8.4.1 Backup Set Storage and Protection
The Project Configuration Server stores backup sets in the local directory. By
design, the average user may not easily locate these backup directories using a
Windows-based file system. After saving a backup set, you can also copy the file to
another backup storage location.
For more information, see section 8.5 “Backup Set Storage and Protection” on
page 285.
Technical 04-16006-04-en, March 2015
286
8 Project Configuration Server Backup and Restore Overview
8.5 Backup Set Storage and Protection
8.5 Backup Set Storage and Protection
The Project Configuration Server stores backup sets in the local directory. By
design, the average user may not easily locate these backup directories using a
Windows-based file system. After saving a backup set, you can also copy the file to
another backup storage location.
Saving a backup set to a storage location is a two-step process: saving the backup
set and then relocating the file to another location. First, you save the backup set to
the Project Configuration Server. Second, you copy the backup set from Project
Configuration Server to another storage location on your network, such as a USB
drive.
Figure: Copy backup set from a Project Configuration Server to a network drive
Backup Set Removal
You can remove backup sets in WorkStation for Projects. For more information, see
section 8.10 “Deleting a Backup Set from a Project” on page 291.
04-16006-04-en, March 2015 Technical
287
8 Project Configuration Server Backup and Restore Overview
8.6 Project Configuration Backup Status
8.6 Project Configuration Backup Status
You can check the current backup status of a server from the Backup and Restore
Manager. Backup Status displays the statuses of a server: Ready, Backing up, or
Backup succeeded.
For more information, see section 9.18 “Backup and Restore Manager on the
Project Configuration Server” on page 330.
Figure: Backup sets in the Local folder
Technical 04-16006-04-en, March 2015
288
8 Project Configuration Server Backup and Restore Overview
8.7 Checking the Backup Status of a Project
8.7 Checking the Backup Status of a Project
You check the backup status of a project to verify that a backup is complete and to
note the date and time of the last backup.
For more information, see section 8.6 “Project Configuration Backup Status” on
page 286.
To check the backup status of a project
1. In WorkStation for Projects, on the Tools menu, select Control Panel.
2. On the Control Panel toolbar, select the project.
3. Click Backup and Restore Manager.
4. View the current project status or date and time of the last successful backup.
04-16006-04-en, March 2015 Technical
289
8 Project Configuration Server Backup and Restore Overview
8.8 Backing Up a Project
8.8 Backing Up a Project
You back up a project to easily restore project data if something unexpected
happens.
For more information, see section 8.3 “Project Backup” on page 282.
To back up a project
1. In WorkStation for Projects, in the System Tree pane, right-click the project
and then click Backup.
2. In the Backup set name prefix box, type some text at the beginning of the
file name that helps identify the backup set, such as Daily.
3. In the Backup set name suffix box, type some text at the end of the file
name that helps identify the backup set. Date and Time are inserted by
default.
4. In the Include column, manually select the projects that you want to include
in the backup, or click the Select All button to include all the listed
projects in the backup.
5. In the Backup content column, select the type of data you want to back up for
each server:
• Configuration only: Project Configuration Server backs up the project
configuration database, which includes points, values, alarm objects,
trend objects, programs, graphics, and custom object type data.
• All data: Project Configuration Server backs up the project configuration
database and the historical database, which include synchronization
events.
Continued on next page
Technical 04-16006-04-en, March 2015
290
8 Project Configuration Server Backup and Restore Overview
8.8 Backing Up a Project
6. In the Backup set description column, type a brief description up to 255
characters to help identify the content of the backup.
Note
The Synchronize Comment button, Synchronize Content
button, and the Synchronize All button are not activated for
WorkStation for Projects.
7. Click Backup.
8. Verify that each backup succeeded and click Close.
After you backed up a project, you can restore the project data at any time.
04-16006-04-en, March 2015 Technical
291
8 Project Configuration Server Backup and Restore Overview
8.9 Locating the Local Backup Path on the Project Configuration Server
8.9 Locating the Local Backup Path on the
Project Configuration Server
You locate the local backup folder on the Project Configuration Server to view the
stored backup sets. The system displays the valid backup sets stored in this folder
in the Restore Options dialog box.
For more information, see section 8.5 “Backup Set Storage and Protection” on
page 285.
To locate a local backup path on the Project Configuration
Server
1. In WorkStation for Projects, open the project.
2. On the Tools menu, select Control Panel.
3. In the Control Panel toolbar, select the project.
4. In the Backup and archiving area, select Backup and Restore
Manager.
5. In the Backup sets path box, view the local backup path on the server.
Technical 04-16006-04-en, March 2015
292
8 Project Configuration Server Backup and Restore Overview
8.10 Deleting a Backup Set from a Project
8.10 Deleting a Backup Set from a Project
You delete a backup set from the Local folder of a project when you no longer need
the backup set.
For more information, see section 8.4 “Project Configuration Server Backup Sets”
on page 284.
To delete a backup set from a project
1. In WorkStation for Projects, open the project.
2. On the Tools menu, click Control Panel.
3. In the Control Panel, click Backup Sets.
4. Open the Local folder.
5. In the Local folder view, right-click on the backup set and click Delete.
6. Click Yes.
04-16006-04-en, March 2015 Technical
293
8 Project Configuration Server Backup and Restore Overview
8.11 Project Restore
8.11 Project Restore
Restore is the process of restoring data to an original or former state. Using
Restore, you can revert back to a previous snapshot of the project data despite any
configuration changes made since the last backup. In Project Configuration Server,
restore is designed to be a manual rather than an automatic process to avoid the
accidental overwriting of current server data. For convenience, only the backup files
that apply to the selected server are displayed.
8.11.1 Restored Data
Depending on what is contained in the backup file, you can restore different types
of data.
• Configuration only: Project Configuration Server restores the project
configuration database, which includes points, values, alarm objects, trend
objects, programs, graphics, and custom object type data.
• All data: Project Configuration Server restores the project configuration
database and the historical database, which include synchronization events.
For more information, see section 8.12 “Restored Data” on page 293.
Technical 04-16006-04-en, March 2015
294
8 Project Configuration Server Backup and Restore Overview
8.12 Restored Data
8.12 Restored Data
Depending on what is contained in the backup file, you can restore different types
of data.
• Configuration only: Project Configuration Server restores the project
configuration database, which includes points, values, alarm objects, trend
objects, programs, graphics, and custom object type data.
• All data: Project Configuration Server restores the project configuration
database and the historical database, which include synchronization events.
Table: Types of Data and Content
Types of Data Content
Historical Event logs are not stored in Project Configuration Server.
Configuration Includes points, values, alarm objects, trend objects, programs,
graphics, and custom object type data stored on a server.
Includes the configuration properties of variables, such as Unit.
Depending on the retain level of the variable; some configuration
properties like Value are also restored.
The server name is part of the restore data. Therefore, if you rename a server after a
backup, a restore process will revert back to the previous server name.
Impact on Configuration Values and Variables
When you back up a server specifying either Configuration only or All data, Project
Configuration Server includes all the configuration values that are specified for the
server’s objects. If you restore the server, Project Configuration Server restores
these configuration values, which can overwrite any changes made since the last
backup.
Project Configuration Server does not include most variable settings in a backup.
Consequently, Project Configuration Server cannot restore these variable settings.
However, the system does back up the cold-start retained variables.
04-16006-04-en, March 2015 Technical
295
8 Project Configuration Server Backup and Restore Overview
8.13 Restoring a Project
8.13 Restoring a Project
You restore a project to recover project data from a backup set.
For more information, see section 8.11 “Project Restore” on page 292.
To restore a project
1. In WorkStation for Projects, open the project.
2. In the System Tree pane, right-click the project and then select Restore.
3. In the Available restore points list, select a backup set and click Restore.
4. Click Yes.
5. Click Close.
Continued on next page
Technical 04-16006-04-en, March 2015
296
8 Project Configuration Server Backup and Restore Overview
8.13 Restoring a Project
6. Click Close.
7. Log on to Project Configuration Server through WorkStation for Projects and
open the project.
The project is restored to the condition of the backup set.
04-16006-04-en, March 2015 Technical
297
9 WorkStation for Projects User
Interface
Topics
Software Administrator – Project Configuration Server View
Building Operation WorkStation for Projects Window
WorkStation for Projects View
WorkStation for Projects – Projects View
WorkStation for Projects – Users View
WorkStation for Projects Manager Toolbar
WorkStation for Projects Toolbar
File Menu
Actions Menu
Synchronization Event View
Create Object Wizard – Naming the Object Page
Create Object Wizard – Server Information Page
Create Report Wizard – Select Report Pack Page
Confirm Deploy Dialog Box
Progress View – Advanced
Operation Details Dialog Box
Project Control Panel View
Backup and Restore Manager on the Project Configuration
Server
WorkStation for Projects - Servers View
Project Server – Date & Time View
Enterprise Server – Date & Time View
Automation Server – Date & Time View
Communication View
User Account Properties
9 WorkStation for Projects User Interface
9.1 Software Administrator – Project Configuration Server View
9.1 Software Administrator – Project
Configuration Server View
Use the Project Configuration Server view to start and stop the Project
Configuration Server service and configure the ports of the Project
Configuration Server.
Figure: Project Configuration Server view
Table: Project Configuration Server View
Component Description
Status Displays the current status of the Project
Configuration Server Windows service.
Start Service Click to start the Project Configuration
Server.
Stop Service Click to stop the Project Configuration
Server. Check in Windows Task Manager to
ensure all projects have shut down.
HTTP Port Type the port number that the Project
Configuration Server listens to when
communicating through the Hypertext
Transfer Protocol.
HTTPS Port Type the port number that the Project
Configuration Server listens to when
communicating through the Hypertext
Transfer Protocol Secure.
04-16006-04-en, March 2015 Technical
301
9 WorkStation for Projects User Interface
9.1 Software Administrator – Project Configuration Server View
Continued
Component Description
TCP Port Type the port number that the Project
Configuration Server listens to when
communicating through the Transmitting
Control Protocol.
Path Displays the path to the folder where the
Project Configuration Server projects are
stored.
Technical 04-16006-04-en, March 2015
302
9 WorkStation for Projects User Interface
9.2 Building Operation WorkStation for Projects Window
9.2 Building Operation WorkStation for
Projects Window
Use the Building Operation WorkStation for Projects window to log on to
WorkStation for Projects.
Figure: Building Operation WorkStation for projects window
Table: Building Operation WorkStation for Projects Window
Component Description
User name Type the Project Configuration Server
user account name. For more information,
see section 5.16 “WorkStation for Projects
User Account Management” on page 224.
Password Type the password.
Server Select the hypertext transfer protocol you
want to use and enter the IP address or DNS
name of Project Configuration Server.
Remember me on this computer Select to save the entered information. The
information is automatically filled in the next
time you log on. For more information, see
the Turning off Remember Me On This
Computer topic on WebHelp.
04-16006-04-en, March 2015 Technical
303
9 WorkStation for Projects User Interface
9.2 Building Operation WorkStation for Projects Window
Continued
Component Description
Log on Click to log on to WorkStation for Projects.
Technical 04-16006-04-en, March 2015
304
9 WorkStation for Projects User Interface
9.3 WorkStation for Projects View
9.3 WorkStation for Projects View
Use WorkStation for Projects view to manage your Building Operation projects
and WorkStation for Projects domain users.
Figure: WorkStation for Projects view
Table: WorkStation for Projects view
Component Description
WorkStation for Projects toolbar. Use
the toolbar to log off, change password, and
open the Projects and Users views. For
more information, see section 9.6
“WorkStation for Projects Manager Toolbar”
on page 307.
Projects view. Use the Projects view to
manage the projects. For more information,
see section 9.4 “WorkStation for Projects –
Projects View” on page 305.
04-16006-04-en, March 2015 Technical
305
9 WorkStation for Projects User Interface
9.3 WorkStation for Projects View
Continued
Component Description
Users view. Use the Users view to manage
the WorkStation for Projects domain users.
For more information, see section 9.5
“WorkStation for Projects – Users View” on
page 306.
Status bar. Displays the server, user
account, and domain you are connected to.
For more information, see the Status Bar
topic on WebHelp.
Technical 04-16006-04-en, March 2015
306
9 WorkStation for Projects User Interface
9.4 WorkStation for Projects – Projects View
9.4 WorkStation for Projects – Projects
View
Use the WorkStation for Projects - Projects view to manage your off-site
Building Operation projects.
Figure: Project Configuration Server Projects view
Table: Projects view
Component Description
Open. Click to open a selected project.
New. Click to create a new project.
Delete. Click to delete a selected project.
Upgrade Project. Click to upgrade a
selected upgradable project.
04-16006-04-en, March 2015 Technical
307
9 WorkStation for Projects User Interface
9.5 WorkStation for Projects – Users View
9.5 WorkStation for Projects – Users View
Use the WorkStation for Projects - Users view to manage user accounts.
Figure: Project Configuration Server Users view
Table: WorkStation for Projects - Users View
Component Description
Quick filter Use the Quick filter to filter user accounts in
the Users list and the Show/hide property
grid button to show the properties for a
selected user account.
Name Displays the name of the user account.
Description Displays the description of the user account.
Technical 04-16006-04-en, March 2015
308
9 WorkStation for Projects User Interface
9.6 WorkStation for Projects Manager Toolbar
9.6 WorkStation for Projects Manager
Toolbar
Use the WorkStation for Projects toolbar to log off, change password, and to
open the WorkStation for Projects - Projects and WorkStation for
Projects -Users views.
Table: WorkStation for Projects Toolbar
Button Description
Log off
Click to log off the WorkStation for Projects.
Project Configuration Manager...
Click to open the WorkStation for
Projects - Projects view. For more
information, see section 9.4 “WorkStation for
Projects – Projects View” on page 305.
Project Configuration Server Domain
Users...
Click to open the WorkStation for
Projects - Users view. For more
information, see section 9.5 “WorkStation for
Projects – Users View” on page 306.
Change password
Click to change the password of the user
account that you are currently using. For
more information, see the Change Password
Dialog Box topic on WebHelp.
04-16006-04-en, March 2015 Technical
309
9 WorkStation for Projects User Interface
9.7 WorkStation for Projects Toolbar
9.7 WorkStation for Projects Toolbar
Use the buttons on the WorkStation for Projects toolbar for easy access to
commands you use frequently.
Figure: WorkSation for Projects toolbar
Button Description
Close Project
Click to close an open project.
Workspace
Click to open the Workspace menu where
you can view the workspace used. For more
information, see the List View topic on
WebHelp.
Control Panel
Click to open the Control Panel where you
get access to some of the most used
administration functions in Building
Operation, such as alarms, domains, user
accounts, backup and archiving, and
engineering. For more information, see the
Control Panel View topic on WebHelp.
New
Click to open the New submenu where you
create new objects. For more information,
see the File Menu - New Submenu topic on
WebHelp.
Open in New
Click to open the selected object in a new
window in the work area.
Save
Click to save changes.
Cut
Click to cut the selected objects. The objects
are placed on the clipboard.
Copy
Click to copy the selected objects. The
objects are placed on the clipboard.
Paste
Click to paste a copied or cut object.
Technical 04-16006-04-en, March 2015
310
9 WorkStation for Projects User Interface
9.7 WorkStation for Projects Toolbar
Continued
Button Description
Delete
Click to open the Confirm delete dialog
box where you delete the selected object.
For more information, see the Confirm Delete
Dialog topic on WebHelp.
Cancel
Click to cancel the latest command.
Refresh
Click to refresh the selected object or
workspace.
Print
Click to print the selected object.
Help
Click to open Building Operation help.
04-16006-04-en, March 2015 Technical
311
9 WorkStation for Projects User Interface
9.8 File Menu
9.8 File Menu
Use the File menu to log off from the system, import and export information, print,
and create new objects.
Figure: The File menu
Command Description
New Click to open the New submenu where you
create new objects. For more information,
see the File Menu - New Submenu topic on
WebHelp.
Open Click to open an object.
Open in new window Click to open the selected object in a new
window in the work area.
Save Click to save changes.
Log Off Click to log off WorkStation. Your session
ends and you are sent to the Welcome
Window where you can log in to Building
Operation with the same or another user
account. For more information, see the
Building Operation WorkStation Window
topic on WebHelp.
Change Password Click to open the Change Password
dialog box where you change your
password. For more information, see the
Change Password Dialog Box topic on
WebHelp.
Close Project Click to close an open project in
WorkStation for Projects.
Technical 04-16006-04-en, March 2015
312
9 WorkStation for Projects User Interface
9.8 File Menu
Continued
Command Description
Export Click to open the Save As dialog box where
you export a solution to a file location on the
WorkStation file system.
The Export preview dialog box displays
when there are objects in the solution that
Building Operation cannot export from the
server. Use this dialog box to view multiple
objects that the system can and cannot
export from the server. For more information,
see section 19.2 “Export Preview Dialog
Box” on page 606.
Import Click to open the Open dialog box where
you select a previously exported solution
that you want to import. After you select a
file, the Import dialog box displays.
The Import dialog box provides a summary
of information about the imported file and a
preview of the names and file structure of the
objects to be imported. For more
information, see section 19.4 “Import Dialog
Box” on page 608.
LonWorks import Click to open the Import - LonWorks
submenu where you import resource files
(DRF kits) or device templates (XIF files).
Print Preview Click to preview a printout before printing.
Print Click to print the selected object.
Print Setup Click to adjust the print settings.
Properties Click to open the Properties dialog box
where you inspect or change properties for
the selected object. For more information,
see the General Properties – Basic Tab topic
on WebHelp.
Shortcut Properties Displays the Properties dialog box for the
currently selected shortcut.
Exit Click to quit WorkStation.
04-16006-04-en, March 2015 Technical
313
9 WorkStation for Projects User Interface
9.9 Actions Menu
9.9 Actions Menu
Use the Actions menu to carry out commands for objects selected in the System
Tree pane or a List View.
Figure: Action menu when a Function Block program is selected.
Table: Actions Menu
Command Description
Actions Use the Actions submenu to create manual
archives on an Enterprise Server. For more
information, see the Actions Menu – Actions
Submenu topic on WebHelp.
Activation Use the Activation submenu to enable,
disable, force transfer, or clear a trend log.
For more information, see the Actions
Menu – Activation Submenu topic on
WebHelp.
Advanced Use the Advanced submenu to repair
references or communication after a server
has been offline. For more information, see
the Actions Menu – Advanced Submenu
topic on WebHelp.
Advanced commands Use the Advanced commands submenu
to execute commands for a device. For
more information, see section 67.2 “Actions
Menu – Advanced Commands Submenu”
on page 2333.
Alarm enable Click to enable the Sigma Alarm.
Alarm inhibit Click to inhibit the Sigma Alarm.
Alarm Refresh Transfers all alarms buffered in the Xenta
device to the server. For more information,
see section 62.22 “Alarms for Xenta
LonWorks Devices” on page 2257.
b3 devices Use the b3 devices submenu to
automatically assign the node IDs and initiate
communication with devices on the MS/TP
network, or to update the firmware. For
more information, see section 85.4 “b3
BACnet Device Properties – Advanced Tab”
on page 3463.
Technical 04-16006-04-en, March 2015
314
9 WorkStation for Projects User Interface
9.9 Actions Menu
Continued
Command Description
Backup Click to open the Backup Options dialog
box where you back up the selected server.
For more information, see the Backup
Options Dialog Box topic on WebHelp.
Clear Status Clears the diagnostic data for the device or
local node. For more information, see
section 60.13 “LonWorks Device
Properties – Diagnostics Tab” on page
2152.
Cold start Restarts the device and clears the RAM
memory. For more information, see section
62.26 “Xenta LonWorks Device Restart” on
page 2266.
Cold start device Cold starts a hosted BACnet device. For
more information, see section 75.36 “Device
Cold Start and Warm Start” on page 2650.
Commission Opens the Commission Device wizard,
where you download settings and
parameters to the device.
For more information, see section 60.35
“Neuron ID and Commission Settings Page ”
on page 2184.
For more information, see section 85.2
“Actions Menu – Device Submenu” on page
3458.
Create Reports From WebReports Click to restore the Reports folder in the
System Tree. For more information, see the
Reports in WorkStation and the WebReports
Web Site topic on WebHelp.
Data Import Click to import the MicroNet import file. For
more information, see section 104.13 “Data
Import” on page 4583.
Data import Click to import Sigma data from the Sigma
server PC. For more information, see section
109.5 “Sigma Data Import” on page 4809.
Decommission Deactivates the device in the network.
Deploy Starts a deploy of a server configuration to a
server from Project Configuration Server. For
more information, see section 6.8 “Deploy”
on page 248.
Device Use the Device submenu where you
manage your devices. For more information,
see section 85.2 “Actions Menu – Device
Submenu” on page 3458.
04-16006-04-en, March 2015 Technical
315
9 WorkStation for Projects User Interface
9.9 Actions Menu
Continued
Command Description
Device communication control Controls the device communications for
BACnet devices and the BACnet Interface,
and is primarily used for diagnostic
purposes.
For more information, see section 75.21
“Device Communication and Diagnostics” on
page 2631.
Discover Devices Identifies the devices and objects on a
particular BACnet network, or an entire
BACnet internetwork. For more information,
see section 75.2 “BACnet Device Discovery”
on page 2606.
Download Downloads applications or BACnet networks
from the Building Operation server database.
For more information, see section 121.8
“EcoStruxure Web Service Alarm Item” on
page 5131.
Download device configuration Downloads the parameters from the Building
Operation server database to the device.
Edit Opens the object for editing in the
appropriate editor.
Edit Alarm Click to display the properties for a Sigma
Alarm.
Edit Alarm 1 Click to display the properties for Sigma
Alarm 1.
Edit Alarm 2 Click to display the properties for Sigma
Alarm 2.
Edit Assignment Condition Click to open the Select conditions dialog
box, where you define when to send the
assignment. For more information, see the
Select Conditions Dialog Box – Alarm Filter
Properties topic on WebHelp.
Edit bindings Click to open the Edit Bindings dialog box.
For more information, see section 17.1
“Bindings View” on page 523.
Edit cooling linear Click to display the properties for a Sigma
linear cooling optimizer.
Edit cooling logarithmic Click to display the properties for a Sigma
logarithmic cooling optimizer.
Edit heating linear Click to display the properties for a Sigma
linear heating optimizer.
Edit heating logarithmic Click to display the properties for a Sigma
logarithmic heating optimizer.
Technical 04-16006-04-en, March 2015
316
9 WorkStation for Projects User Interface
9.9 Actions Menu
Continued
Command Description
Edit Event Filter Click to open the Select conditions dialog
box, where you edit an event filter to an
object. For more information, see the Select
Conditions Dialog Box – Events Filter
Properties topic on WebHelp.
Edit in spreadsheet Click to open Edit in spreadsheet where
you can quickly build and reuse a database
of I/O modules on the I/O bus. For more
information, see section 126.4 “Copying
from MS Excel to Spreadsheet View” on
page 5312.
Edit Notification Condition Click to open the Select conditions dialog
box, where you define when to send the
alarm notification. For more information, see
the Select Conditions Dialog Box – Alarm
Filter Properties topic on WebHelp.
Edit secondary input Click to display the properties for a
secondary input to a Sigma Setpoint Adjust
object.
Edit schedule Click to display the schedule editor or
calendar editor (as relevant).
Edit Standard Alarm View filter Click to open the Select conditions dialog
box, where you sort the information in an
Alarms pane. For more information, see the
Select Conditions Dialog Box – Alarm Filter
Properties topic on WebHelp.
Edit Sum Alarm Condition Click to open the Select conditions dialog
box, where you configure the conditions that
determine which alarms the sum alarm
surveys. For more information, see the
Select Conditions Dialog Box – Alarm Filter
Properties topic on WebHelp.
Edit the style of associated events Click to open the Event styles dialog box
where you style the appearance of a specific
event in the Events pane. For more
information, see the Event Styles Dialog Box
topic on WebHelp.
Edit time extension Click to display the properties for a Sigma
Time Extension.
Host EWS Objects Click to host a remote EcoStruxure Web
Service object. For more information, see
section 121.7 “EcoStruxure Web Service
Client” on page 5126.
Hours cancel limit 1 Click to prevent the generation of the next
totalization alarm for Limit 1 (like precancel,
except that you cannot later reinstate the
generation of the next Limit 1 totalization
alarm).
04-16006-04-en, March 2015 Technical
317
9 WorkStation for Projects User Interface
9.9 Actions Menu
Continued
Command Description
Hours cancel limit 2 Click to prevent the generation of the next
totalization alarm for Limit 2 (like precancel,
except that you cannot later reinstate the
generation of the next Limit 2 totalization
alarm).
Hours cancel limit 3 Click to prevent the generation of the next
totalization alarm for Limit 3 (like precancel,
except that you cannot later reinstate the
generation of the next Limit 3 totalization
alarm).
Hours precancel limit 1 Click to prevent the generation of the next
totalization alarm for Limit 1.
Hours precancel limit 2 Click to prevent the generation of the next
totalization alarm for Limit 2.
Hours precancel limit 3 Click to prevent the generation of the next
totalization alarm for Limit 3.
Hours reinstate limit 1 Click to reverse the effects of clicking Hours
precancel limit 1.
Hours reinstate limit 2 Click to reverse the effects of clicking Hours
precancel limit 2.
Hours reinstate limit 3 Click to reverse the effects of clicking Hours
precancel limit 3.
IO wiring list Click to open the IO Wiring List dialog box
where you print an I/O wiring list for the I/O
bus that describes which I/O points are
associated with each I/O module. For more
information, see section 22.22 “Print I/O
Wiring List Dialog Box” on page 757.
Launch VisiSat Click to start VisiSat. For more information,
see section 104.11 “VisiSat Programming”
on page 4579.
Learn BDT Table Click to open the Learn BDT Table dialog
box where you learn the BACnet Broadcast
Device Table from one BBMD to another
BBMD. For more information, see section
75.35 “Learning a BBMD Configuration from
one BBMD to Another” on page 2649.
Learn LCM Learns the blocks in the LCM. For more
information, see section 95.9 “Learn LCM
Blocks” on page 3772.
LCM sync date time Sends the server's date and time to each
LCM device on the LCM network. For more
information, see section 96.5 “NETWORK
8000 LCMs” on page 3799.
Technical 04-16006-04-en, March 2015
318
9 WorkStation for Projects User Interface
9.9 Actions Menu
Continued
Command Description
Manage IO bus Click to open the I/O Module
Management Tool dialog box where you
assign and unassign logical I/O modules,
correct the position of a module type, or
correct a module mismatch. For more
information, see section 22.2 “I/O Module
Management Tool Dialog Box” on page 718.
Manage Meter Click to open the Manage Meter dialog
box where you manage the settings of a new
meter. For more information, see the
Manage Replacement of Meter Dialog Box
topic on WebHelp.
MNL Use the MNL submenu to open WorkPlace
Tech Monitor, to monitor or perform a task
on an MNL LonWorks device. For more
information, see section 72.47 “Actions
Menu – MNL Submenu” on page 2545.
Modification Use the Modification submenu to modify a
trend log. For more information, see the
Actions Menu – Modification Submenu topic
on WebHelp.
Print IO module labels Click to open the Print IO Module Labels
dialog box where you print the placard of the
I/O module. For more information, see
section 22.39 “Print I/O Module Labels
Dialog Box” on page 785.
Proxy Update Reads the configuration properties of the
block in the LCM. For more information, see
section 96.5 “NETWORK 8000 LCMs” on
page 3799.
Pulse start Click to generate a Digital Output pulse
lasting for the duration of the rising edge
setting in Sigma.
Pulse stop Click to generate a Digital Output pulse
lasting for the duration of the falling edge
setting in Sigma.
Refresh device identification Click to refresh the basic device identification
displayed in the properties of a Modbus
device. For more information, see section
91.1 “Modbus Devices” on page 3647.
Removed from Network Removes an offline device object for a
physical device that was previously removed
from the network.
Reset Resets the block in the LCM. For more
information, see section 96.5 “NETWORK
8000 LCMs” on page 3799.
04-16006-04-en, March 2015 Technical
319
9 WorkStation for Projects User Interface
9.9 Actions Menu
Continued
Command Description
Reset IO module Resets the I/O module with its old
configuration. For more information, see the
I/O Modules topic on WebHelp.
Restore Click to open the Restore Options dialog
box where you restore the selected server,
or upload the configurations properties of an
external BACnet device to a device proxy.
Retrieve logged values Click to retrieve logged values from the
relevant Sigma controllers.
Revert to application value Click to use an NCI value from the device
application when downloading the device
configuration (NCI values) to an MNL
LonWorks device. For more information, see
section 71.8 “NCI Values” on page 2434.
Save To Save the selected backup to another
location in the Building Operation server
database. For more information, see the
Backup Sets View topic on WebHelp.
Send log set Click to send the selected log set to the
relevant Sigma controller.
Send log sets Click to send all log sets to the relevant
Sigma controllers.
Send ServicePin Sends service pin for the local node, so
other devices can identify the local node on
the network. For more information, see
section 62.3 “Discovering a Xenta Device”
on page 2233.
Send time sync now Manually forces the server to send out time
synch notifications to all the configured
recipients. For more information, see section
75.12 “Manually Triggering the Time
Recipients List of a Server” on page 2622.
Sigma diagnostics Click to open the Sigma diagnostics
submenu, where you can retime a controller,
set a controller online, or select diagnostics
text reports. For more information, see
section 110.3 “Controller Diagnostics” on
page 4836.
Teach Sends a selected BBMD configuration to all
other BBMDs in the system. For more
information, see section 75.34 “Teaching a
BBMD Configuration to Other BBMDs ” on
page 2648.
Temporary off Click to override a Sigma Time Schedule
object until the next scheduled ON time.
Technical 04-16006-04-en, March 2015
320
9 WorkStation for Projects User Interface
9.9 Actions Menu
Continued
Command Description
Temporary on Click to override a Sigma Time Schedule
object until the next scheduled OFF time.
Time sync Synchronizes the time between a hosted
device and the local server. For more
information, see section 81.11 “BACnet
Device – Time Synchronization Recipients
Tab” on page 2985.
Update IO module firmware Click to open the Update IO Module
Firmware dialog box where you upgrade
the firmware for I/O modules. For more
information, see section 22.40 “Update I/O
Module Firmware Dialog Box” on page 786.
Upload Uploads the application from the device to
the Building Operation server database.
Upload device configuration Uploads the parameters from the device to
the Building Operation server database.
Update Object list Updates the list of BACnet device objects.
Warm start Restarts a device without clearing the RAM
memory. For more information, see section
62.26 “Xenta LonWorks Device Restart” on
page 2266.
Warm start device Restarts a BACnet hosted device without
clearing all configuration data, run-time data,
and the values of objects. For more
information, see section 75.36 “Device Cold
Start and Warm Start” on page 2650.
View Use the View menu to open a report, trend
chart, trend log list, or add a value to the
Watch pane. For more information, see the
Actions Menu – View Submenu topic on
WebHelp.
View Action Notes Click to open an Events pane that displays
all events where an action note has been
added to the alarm. For more information,
see the Events Pane and Event View topic
on WebHelp.
View Cause Notes Click to open an Events pane that displays
all events where a cause note has been
added to the alarm. For more information,
see the Events Pane and Event View topic
on WebHelp.
View Checklists Click to open an Events pane that displays
all events where a check list has been added
to the alarm. For more information, see the
Events Pane and Event View topic on
WebHelp.
04-16006-04-en, March 2015 Technical
321
9 WorkStation for Projects User Interface
9.9 Actions Menu
Continued
Command Description
View Comments Click to open an Events pane that displays
all events where a comment has been added
to the alarm. For more information, see the
Events Pane and Event View topic on
WebHelp.
View History Click to open an Events pane where all
history events of an alarm are displayed. For
more information, see the Events Pane and
Event View topic on WebHelp.
Wink Generates a response from the device, such
as flashing the power LED, so you can
identify the physical device. The device must
be connected, have its ID set, and support
the Wink function.
Technical 04-16006-04-en, March 2015
322
9 WorkStation for Projects User Interface
9.10 Synchronization Event View
9.10 Synchronization Event View
Use the Synchronization Event view to view any deploy carried out between
Project Configuration Server and an Enterprise Server or Automation Server.
Figure: Synchronization Event View
Table: Synchronization Event View
Number Description
Use the Synchronization Event View toolbar
to stop or resume showing new
synchronization events. For more
information, see the Events Pane and Event
View Toolbar topic on WebHelp.
Use the Synchronization Event View
columns to sort, hide, or show information
about the synchronization events. For more
information, see the Add/Remove Columns
Dialog Box topic on WebHelp.
Use the Detail view to display all information
about a selected synchronization event.
04-16006-04-en, March 2015 Technical
323
9 WorkStation for Projects User Interface
9.11 Create Object Wizard – Naming the Object Page
9.11 Create Object Wizard – Naming the
Object Page
Use the Naming the object page to set the basic properties for the object. For
objects with several types, you also select the object type.
Figure: Naming the object page
Table: Naming the Object Page
Component Description
(Object type list) Select the type of object you want to create.
For more information, see the Object Types
topic on WebHelp.
Name Type the name of the object. For more
information, see the Object Names topic on
WebHelp.
Prefix Type a label that is added in front of the
object name. For more information, see the
Suffix and Prefix topic on WebHelp.
Suffix Type a label that is added after the object
name. For more information, see the Suffix
and Prefix topic on WebHelp.
Location Enter the path to the location in the System
Tree where you want to create the object. By
default, the path to the selected folder or
object in the System Tree is displayed.
Description Type a description that explains what the
object is used for.
Technical 04-16006-04-en, March 2015
324
9 WorkStation for Projects User Interface
9.12 Create Object Wizard – Server Information Page
9.12 Create Object Wizard – Server
Information Page
Use the Server Information page to configure the server communication
parameters in a project.
Figure: Server Information page
Table: Server Information Page
Property Description
Server Displays the name of the server.
DNS/IP address Type the IP address or fully qualified domain
name of the server.
HTTP port Enter the HTTP port number.
HTTPS port Enter the HTTPS port number.
TCP port Enter the TCP port number.
User name Type the User name that is to be used as
custom logon (authentication) when
deploying or learning the server. For more
information, see the Compare and
Synchronize View topic on WebHelp.
Password Type the Password.
Confirm Password Type the password again.
Communication Protocol Select which protocol to use for
communication in the target system.
04-16006-04-en, March 2015 Technical
325
9 WorkStation for Projects User Interface
9.13 Create Report Wizard – Select Report Pack Page
9.13 Create Report Wizard – Select Report
Pack Page
Use the Select Report Pack page to select a report pack that you want to create in
WorkStation for Projects.
Figure: Select Report Pack page
Component Description
Select Report Pack Select the report pack of reports that you
want to create in WorkStation for Projects.
Technical 04-16006-04-en, March 2015
326
9 WorkStation for Projects User Interface
9.14 Confirm Deploy Dialog Box
9.14 Confirm Deploy Dialog Box
Use the Confirm Deploy dialog box to commit to the deploy or not.
Figure: Confirm Deploy dialog box
Component Description
Yes Click to deploy. For more information, see
section 6.8 “Deploy” on page 248.
No Click to cancel.
04-16006-04-en, March 2015 Technical
327
9 WorkStation for Projects User Interface
9.15 Progress View – Advanced
9.15 Progress View – Advanced
The Advanced Progress View is displayed when you download and commission
objects in field devices in, for example LonWorks and BACnet, or when you deploy
a server in Project Configuration Server.
The Progress view displays information about time-consuming operations between
WorkStation, WorkStation for Projects and a Building Operation server. You can
also see detailed information about what went wrong if the operation fails.
Figure: Advanced Progress view when an operation failed.
9.15.1 Detail View
The detailed information in the Progress view helps you to identify problems during
any operation.
Technical 04-16006-04-en, March 2015
328
9 WorkStation for Projects User Interface
9.15 Progress View – Advanced
Figure: Detailed information is displayed in the Error dialog.
04-16006-04-en, March 2015 Technical
329
9 WorkStation for Projects User Interface
9.16 Operation Details Dialog Box
9.16 Operation Details Dialog Box
The Operating details dialog box displays more detailed information on what
went wrong during the operation.
Figure: Failing Progress - Progress Manager dialog box
Table: Failing Progress - Progress Manager dialog box
Component Description
Path Displays the path to the object the operation
is performed on.
Type Displays the object type.
Operation details Dislays the time and text for the operation.
Error details Click to open the Error dialog box to get
more error details. For more information, see
the Error Details – Progress View topic on
WebHelp.
Copy to clipboard Click to copy the information to the
clipboard.
Technical 04-16006-04-en, March 2015
330
9 WorkStation for Projects User Interface
9.17 Project Control Panel View
9.17 Project Control Panel View
Use the Project Control Panel view to manage time zone settings and view the
backup sets and backup statuses of your project.
Figure: Project Control Panel view
Table: Project Control Panel view
Component Description
Network time and time zones Click to configure the time zone for your
project. For more information, see section
7.2 “Time Zone Configuration in Project
Configuration Server” on page 272.
Backup Sets Click to view the backup sets for your
project.
Backup and Restore Manager Click to open the Backup and Restore
manager, where you can view backup status
and time of last backup. For more
information, see section 9.18 “Backup and
Restore Manager on the Project
Configuration Server” on page 330.
LNS Plug-in Registration Click to open LNS Plug-in Registration. For
more information, see section 56.26 “LNS
Plug-ins” on page 2047.
04-16006-04-en, March 2015 Technical
331
9 WorkStation for Projects User Interface
9.18 Backup and Restore Manager on the Project Configuration Server
9.18 Backup and Restore Manager on the
Project Configuration Server
Use the Backup and Restore Manager to supervise the backup settings in
Project Configuration Server. You can also open this view in any server to view
current and past backup information.
Figure: Backup and Restore Manager on Project Configuration Server
Table: Project Configuration Server Backup and Restore Manager
Component Description
Status Displays the current backup status, such as
backing up.
Last backup Displays the date and time of the last
successful backup.
Backup sets path Displays the path to where the Project
Configuration Server stores Project
Configuration Server backups.
Technical 04-16006-04-en, March 2015
332
9 WorkStation for Projects User Interface
9.19 WorkStation for Projects - Servers View
9.19 WorkStation for Projects - Servers View
Use the WorkStation for Projects - Servers view to edit the communication
parameters of a server in your project.
Figure: Servers view
Table: Servers View
Component Description
Protocol Select the protocol to use when deploy of
project to server. For more information, see
section 6.8 “Deploy” on page 248.
Server Displays a list of servers in the project.
Show/Hide property grid
Click to open the communications properties
for the server.
DNS/IP address Type the IP address or fully qualified domain
name of the server.
HTTP port Enter the HTTP port number.
HTTPS port Enter the HTTPS port number.
TCP port Enter the TCP port number.
User name Type the User name that is to be used
when synchronizing project with server.
Password Type the password.
Confirm password Type the password again.
04-16006-04-en, March 2015 Technical
333
9 WorkStation for Projects User Interface
9.20 Project Server – Date & Time View
9.20 Project Server – Date & Time View
Use the Project Server – Date & Time view to configure the Project
Configuration Server time zone.
Figure: Project date & time view
Table: Project Date & Time View
Component Description
Predefined time zone Select the time zone the server belongs to.
Custom time zone Select to manually define the server time
zone.
Description Type a description or name for the
customized time zone DST settings.
UTC offset Select the time difference the time zone has
from UTC in the hours and minutes boxes.
This custom time zone uses daylight Select to enable the daylight saving time
saving time settings for the custom time zone.
Time adjustment Select the time adjustment, in minutes, for
the daylight saving time.
Month - Start Select the month that daylight saving time
starts.
Technical 04-16006-04-en, March 2015
334
9 WorkStation for Projects User Interface
9.20 Project Server – Date & Time View
Continued
Component Description
Week - Start Select the week of the month that daylight
saving time starts.
Day - Start Select the day of the week that daylight
saving time starts.
Time - Start Select the time that daylight saving time
starts.
Month - End Select the month that daylight saving time
ends.
Week - End Select the week that daylight saving time
ends.
Day - End Select the day of the week that daylight
saving time ends.
Time- End Select the time that daylight saving time
ends.
04-16006-04-en, March 2015 Technical
335
9 WorkStation for Projects User Interface
9.21 Enterprise Server – Date & Time View
9.21 Enterprise Server – Date & Time View
Use the Date & Time view to configure shadow Automation Servers network time
settings, and the time zone of the Enterprise Server.
Figure: Date & time view
Table: Date & Time View
Component Description
Network time synchronization Select to define the primary and secondary
network time server addresses for
connected shadow Automation Servers.
Enable Select to define the primary and secondary
network time server addresses for
connected shadow Automation Servers.
Authenticate Network time Select if you want to use authenticated
synchronization network time synchronizing.
Primary time server Type the address to the primary time server
to which the shadow Automation Servers
date and time object synchronizes its clock.
Technical 04-16006-04-en, March 2015
336
9 WorkStation for Projects User Interface
9.21 Enterprise Server – Date & Time View
Continued
Component Description
Secondary time server Type the address to the secondary time
server to which the shadow Automation
Servers date and time object synchronizes
its clock.
Key id Type the ID of the authentication key for the
primary time server.
Key id Type the ID of the authentication key for the
secondary time server.
Key value Type the password for the primary time
server.
Key value Type the password for the secondary time
server.
Manually adjust date & time Select to use manual date and time
configuration for connected shadow
Automation Servers.
Disable Select to disable all Automation Server date
and time shadow relationships and use the
Automation Servers own date and time
configurations.
Predefined time zone Select the time zone the server belongs to.
Custom time zone Select to manually define the server time
zone.
Description Type a description or name for the
customized time zone DST settings.
UTC offset Select the time difference the time zone has
from UTC in the hours and minutes boxes.
This custom time zone uses daylight Select to enable the daylight saving time
saving time settings for the custom time zone.
Time adjustment Select the time adjustment, in minutes, for
the daylight saving time.
Month - Start Select the month that daylight saving time
starts.
Week - Start Select the week of the month that daylight
saving time starts.
Day - Start Select the day of the week that daylight
saving time starts.
Time - Start Select the time that daylight saving time
starts.
Month - End Select the month that daylight saving time
ends.
04-16006-04-en, March 2015 Technical
337
9 WorkStation for Projects User Interface
9.21 Enterprise Server – Date & Time View
Continued
Component Description
Week - End Select the week that daylight saving time
ends.
Day - End Select the day of the week that daylight
saving time ends.
Time - End Select the time that daylight saving time
ends.
Technical 04-16006-04-en, March 2015
338
9 WorkStation for Projects User Interface
9.22 Automation Server – Date & Time View
9.22 Automation Server – Date & Time View
Use the Automation Server - Date & Time view to configure the Automation
Server time and time zone.
Figure: Date & Time view
Table: Date & Time View
Component Description
Network time synchronization Select to synchronize the server clock with a
network time server.
Authenticate Network time Select if you want to use authenticated
synchronization network time synchronizing.
Primary time server Type the address to the primary time server
to which the shadow Automation Servers
date and time object synchronizes its clock.
Secondary time server Type the address to the secondary time
server to which the shadow Automation
Servers date and time object synchronizes
its clock.
04-16006-04-en, March 2015 Technical
339
9 WorkStation for Projects User Interface
9.22 Automation Server – Date & Time View
Continued
Component Description
Key id Type the ID of the authentication key for the
primary time server.
Key id Type the ID of the authentication key for the
secondary time server.
Key value Type the password for the primary time
server.
Key value Type the password for the secondary time
server.
Manually adjust date & time Select to manually set the server clock.
Local date & time Enter the date and time you want to set the
server clock to. This time is displayed in
server local time.
Predefined time zone Select the time zone the server belongs to.
Custom time zone Select to manually define the server time
zone.
Description Type a description or name for the
customized time zone DST settings.
UTC offset Select the time difference the time zone has
from UTC in the hours and minutes boxes.
This custom time zone uses daylight Select to enable the daylight saving time
saving time settings for the custom time zone.
Time adjustment Select the time adjustment, in minutes, for
the daylight saving time.
Month - Start Select the month that daylight saving time
starts.
Week - Start Select the week of the month that daylight
saving time starts.
Day - Start Select the day of the week that daylight
saving time starts.
Time - Start Select the time that daylight saving time
starts.
Month - End Select the month that daylight saving time
ends.
Week - End Select the week that daylight saving time
ends.
Day - End Select the day of the week that daylight
saving time ends.
Technical 04-16006-04-en, March 2015
340
9 WorkStation for Projects User Interface
9.22 Automation Server – Date & Time View
Continued
Component Description
Time- End Select the time that daylight saving time
ends.
04-16006-04-en, March 2015 Technical
341
9 WorkStation for Projects User Interface
9.23 Communication View
9.23 Communication View
Use the Communication view to edit the communication parameters that a
Building Operation server maintains about other Building Operation servers.
Figure: Communication view
Table: Communication View
Component Description
Server Displays all Building Operation servers that
this server knows of.
DNS/IP Address Displays the DNS/IP addresses of the
servers.
Communication Displays the protocols that are used to
communicate with the servers.
Port Displays the ports that are used for the
protocols.
Server Displays the name of the server that is
selected in the list.
Address Type the new IP address or fully qualified
domain name if the address has changed in
the selected server.
Protocol Select a new communication protocol to use
with the selected server.
Port Enter the new port number if it has changed
in the selected server.
Technical 04-16006-04-en, March 2015
342
9 WorkStation for Projects User Interface
9.24 User Account Properties
9.24 User Account Properties
Use the User Account properties dialog box to configure the properties of a user
account.
Figure: User account properties
Table: User Account Properties
Component Description
Click to create a new user profile. For more
information, see section 9.11 “Create Object
Wizard – Naming the Object Page” on page
322.
Click to edit a user profile. For more
information, see the Profile Properties topic
on WebHelp.
Click to remove a user profile.
Disabled Select True to disable the user account.
Force password change Select True to force the user to change
password after the initial logon.
04-16006-04-en, March 2015 Technical
343
9 WorkStation for Projects User Interface
9.24 User Account Properties
Continued
Component Description
Password Type the password again.
Confirm Password Type the password again.
Expires on Enter an expiration date and time for the
user account. By default, there is no
expiration date for the account.
System of measurement Displays the system of measurement for the
user account.
Technical 04-16006-04-en, March 2015
344
10 Building Operation Servers
User Interface
Topics
Server Wizard – Configure IP/DNS Address and Port Page
Log On Dialog Box
Enterprise Server Properties – Basic Tab
Enterprise Server Properties – Network Tab
Enterprise Server Properties – E-mail Tab
Automation Server Properties – Basic Tab
Automation Server Properties – E-mail Tab
Automation Server Properties – Network Tab
Communication View
Device Discovery View
Variables View
10 Building Operation Servers User Interface
10.1 Server Wizard – Configure IP/DNS Address and Port Page
10.1 Server Wizard – Configure IP/DNS
Address and Port Page
Use the Configure IP/DNS Address and Port page to configure server
communication parameters.
Figure: Server Wizard - Configure IP/DNS address and port page
Table: Server Wizard - Configure IP/DNS Address and Port Page
Component Description
Server Displays the name of the server.
Address Type the IP address or fully qualified domain
name of the Automation Server.
Protocol Select a communication protocol for the
server. Other servers use this protocol by
default when they communicate with this
server.
Port Enter a port for the selected protocol.
04-16006-04-en, March 2015 Technical
347
10 Building Operation Servers User Interface
10.2 Log On Dialog Box
10.2 Log On Dialog Box
Use the Log On dialog box to log on to an Automation Server with an existing
custom logon password to add the server to an Enterprise Server.
Figure: Log on dialog box
Table: Log On Dialog Box
Component Description
Protocol Displays the protocol used by the server.
Port Displays the communication port used by
the server.
Name Displays the administrator user name.
Password Type the custom administrator password.
Technical 04-16006-04-en, March 2015
348
10 Building Operation Servers User Interface
10.3 Enterprise Server Properties – Basic Tab
10.3 Enterprise Server Properties – Basic
Tab
Use the Basic tab to view basic properties of the Enterprise Server.
Figure: Enterprise Server properties – basic tab
Table: Enterprise Server Properties – Basic Tab
Component Description
Server time Displays the date and time adjusted to the
client time zone.
Hour (h) Displays the hours according to the server
time zone.
Minute (m) Displays the minutes according to the server
time zone.
Second (s) Displays the seconds according to the
server time zone.
04-16006-04-en, March 2015 Technical
349
10 Building Operation Servers User Interface
10.3 Enterprise Server Properties – Basic Tab
Continued
Component Description
Configuration database size Displays the current size (Mb) of the
configuration database.
Server directory size Displays the current size (Mb) of the types
stored in the server file system.
Thread pool size Displays the present size of the thread pool.
Thread pool usage Displays the present usage of the thread
pool.
Request-specific thread pool size Displays the capacity of the request-specific
thread pool.
Request-specific thread pool usage Displays the current number of threads in the
request-specific thread pool.
Vendor Displays the vendor of the Building
Operation technology.
Operating system Displays the operating system on which the
Enterprise Server is running.
Hardware version Displays the hardware platform on which the
Enterprise Server is running.
Software version Displays the Enterprise Server software
version.
Restored Displays whether or not the server database
has been restored.
Technical 04-16006-04-en, March 2015
350
10 Building Operation Servers User Interface
10.4 Enterprise Server Properties – Network Tab
10.4 Enterprise Server Properties – Network
Tab
Use the Network tab to view the IP settings of the Enterprise Server.
Figure: Enterprise Server properties - Network tab
Table: Network Tab
Component Description
IP/DNS address Displays the IP address of the host computer
on which the server resides.
Host name Displays the host name of the computer on
which the server resides.
TCP port Displays the port number on this server for
incoming TCP communication.
HTTP port Displays the port number on this server for
incoming HTTP communication.
HTTPS port Displays the port number on this server for
incoming HTTPS communication.
04-16006-04-en, March 2015 Technical
351
10 Building Operation Servers User Interface
10.5 Enterprise Server Properties – E-mail Tab
10.5 Enterprise Server Properties – E-mail
Tab
Use the E-mail tab to select and specify the E-mail server that can be used to send
E-mail notifications.
Figure: Enterprise Server properties - E-mail tab
Table: E-mail Tab
Component Description
Select E-mail server Select to use the Schneider Electric E-mail
server or to set up a primary and possibly a
secondary E-mail server.
Technical 04-16006-04-en, March 2015
352
10 Building Operation Servers User Interface
10.5 Enterprise Server Properties – E-mail Tab
Continued
Component Description
Sender E-mail Type a sender address for the notification E-
mails that are generated by this Enterprise
Server. The sender E-mail is the receiver of
replies.
Maximum queue size Enter the maximum number of E-mails that
are allowed in a queue.
Maximum retry count Enter the number of attempts to send an E-
mail that are performed before abandoning
the E-mail.
Retry time Enter the number of minutes between
retries.
Host Displays the web address to the Schneider
Electric E-mail server.
Port Displays the port number that is designated
for incoming SMTP traffic on the Schneider
Electric E-mail server.
Primary host Type a primary E-mail server web address.
Primary user name Type the user name for the E-mail account
on the primary E-mail server.
Primary Password Type the password for the E-mail account
on the primary E-mail server.
Primary Confirm Password Type the password again for the E-mail
account on the primary E-mail server.
Primary port Enter the port that is designated for
incoming SMTP traffic on the primary E-mail
server.
Secondary host Type a secondary E-mail server web
address.
Secondary user name Type the user name for the E-mail account
on the secondary E-mail server.
Secondary Password Type the password for the E-mail account
on the secondary E-mail server.
Secondary Confirm Password Type the password again for the E-mail
account on the secondary E-mail server.
Secondary port Enter the port that is designated for
incoming SMTP traffic on the secondary E-
mail server.
04-16006-04-en, March 2015 Technical
353
10 Building Operation Servers User Interface
10.6 Automation Server Properties – Basic Tab
10.6 Automation Server Properties – Basic
Tab
Use the Basic tab to view basic properties of the Automation Server.
Figure: . Automation Server properties – Basic tab
Technical 04-16006-04-en, March 2015
354
10 Building Operation Servers User Interface
10.6 Automation Server Properties – Basic Tab
Table: Automation Server Properties – Basic Tab
Component Description
Server time Displays the date and time adjusted to the
client time zone.
Hour (h) Displays the hours according to the server
time zone.
Minute (m) Displays the minutes according to the server
time zone.
Second (s) Displays the seconds according to the
server time zone.
Configuration database size Displays the current size (Mb) of the
configuration database.
Server directory size Displays the current size (Mb) of the types
stored in the server file system.
Thread pool size Displays the present size of the thread pool.
Thread pool usage Displays the present usage of the thread
pool.
Request-specific thread pool size Displays the capacity of the request-specific
thread pool.
Request-specific thread pool usage Displays the current number of threads in the
request-specific thread pool.
Memory usage (%) Displays the percentage of the system
memory currently being used by the server
process when including heap manager free
lists to calculate the amount of free memory.
System memory usage (%) Displays the percentage of the system
memory currently being used by all server
processes.
CPU usage (%) Displays the level of CPU performance
presently used by the Automation Server.
Vendor Displays the issuer of the Building Operation
technology.
Operating system Displays the operating system on which the
Automation Server is running.
Software version Displays the Automation Server software
revision.
Serial number Displays the serial number of the Automation
Server hardware.
Product ID Displays a classification code that represents
the type of Automation Server.
04-16006-04-en, March 2015 Technical
355
10 Building Operation Servers User Interface
10.6 Automation Server Properties – Basic Tab
Continued
Component Description
Part number Displays the part number, which is what
identifies the product in the context of
purchase.
Hardware platform Displays a code that represents the
Automation Server CPU.
Hardware version Displays a code that represents the CPU
revision number of the Automation Server.
MAC address Displays the hardware address of the
Automation Server, which is a unique
identifier that is allocated to every hardware
network interface.
Restored Displays whether or not the server database
has been restored.
Technical 04-16006-04-en, March 2015
356
10 Building Operation Servers User Interface
10.7 Automation Server Properties – E-mail Tab
10.7 Automation Server Properties – E-mail
Tab
Use the E-mail tab to select and specify the E-mail server that can be used to send
E-mail notifications.
Figure: Automations Server properties - E-mail tab
Table: E-mail Tab
Component Description
Select E-mail server Select to use the Schneider Electric E-mail
server or to set up a primary and possibly a
secondary E-mail server.
04-16006-04-en, March 2015 Technical
357
10 Building Operation Servers User Interface
10.7 Automation Server Properties – E-mail Tab
Continued
Component Description
Sender E-mail Type a sender address for the notification E-
mails that are generated by this Automation
Server. The sender E-mail is the receiver of
replies.
Maximum queue size Enter the maximum number of E-mails that
are allowed in a queue.
Maximum retry count Enter the number of attempts to send an E-
mail that are performed before abandoning
the E-mail.
Retry time Enter the number of minutes between
retries.
Host Displays the web address to the Schneider
Electric E-mail Server.
Port Displays the port number that is designated
for incoming SMTP traffic on the Schneider
Electric E-mail Server.
Primary host Type a primary E-mail server web address.
Primary user name Type the user name for the E-mail account
on the primary E-mail server.
Primary Password Type the password for the E-mail account
on the primary E-mail server.
Primary Confirm Password Type the password again for the E-mail
account on the primary E-mail server.
Primary port Enter the port for incoming SMTP traffic on
the primary E-mail server.
Secondary host Type a secondary E-mail server web
address.
Secondary user name Type the user name for the E-mail account
on the secondary E-mail server.
Secondary Password Type the password for the E-mail account
on the secondary E-mail server.
Secondary Confirm Password Type the password again for the E-mail
account on the secondary E-mail server.
Secondary port Enter the port for incoming SMTP traffic on
the secondary E-mail server.
Technical 04-16006-04-en, March 2015
358
10 Building Operation Servers User Interface
10.8 Automation Server Properties – Network Tab
10.8 Automation Server Properties –
Network Tab
Use the Network tab to view communication settings of the Automation Server.
Figure: Automation Server properties - Network tab
Table: Network Tab
Component Description
DHCP Displays if Dynamic Host Configuration
Protocol is enabled. If enabled, the server
obtains TCP/IP configurations from the
DHCP server.
IP/DNS address Displays the server IP address, which is
assigned by the DHCP server or specified by
you.
Subnet mask Displays the prefix of the subnet to which the
server belongs, which is assigned by the
DHCP server or specified by you.
04-16006-04-en, March 2015 Technical
359
10 Building Operation Servers User Interface
10.8 Automation Server Properties – Network Tab
Continued
Component Description
Default gateway Displays the address to the router, which is
assigned by the DHCP server or specified by
you.
DNS server Displays the address to the DNS server,
which is assigned by the DHCP server or
specified by you.
Domain name Displays the name of the domain to which
the server belongs.
Host name Displays the IP host name of the server. This
host name can be associated to the IP
address, depending on the DNS server.
TCP port Displays the port number on this server for
incoming TCP communication.
HTTP port Displays the port number on this server for
incoming HTTP communication.
HTTPS port Displays the port number on this server for
incoming HTTPS communication.
Neuron ID 0 Displays the Neuron ID 0 which is used to
identify LonWorks nodes or other
functionality in the LonWorks network.
Neuron ID 1 Displays the Neuron ID 1 which is used to
identify LonWorks nodes or other
functionality in the LonWorks network.
Neuron ID 2 Displays the Neuron ID 2 which is used to
identify LonWorks nodes or other
functionality in the LonWorks network.
Neuron ID 3 Displays the Neuron ID 3 which is used to
identify LonWorks nodes or other
functionality in the LonWorks network.
Neuron ID 4 Displays the Neuron ID 4 which is used to
identify LonWorks nodes or other
functionality in the LonWorks network.
Neuron ID 5 Displays the Neuron ID 5 which is used to
identify LonWorks nodes or other
functionality in the LonWorks network.
Technical 04-16006-04-en, March 2015
360
10 Building Operation Servers User Interface
10.9 Communication View
10.9 Communication View
Use the Communication view to edit the communication parameters that a
Building Operation server maintains about other Building Operation servers.
Figure: Communication view
Table: Communication View
Component Description
Server Displays all Building Operation servers that
this server knows of.
DNS/IP Address Displays the DNS/IP addresses of the
servers.
Communication Displays the protocols that are used to
communicate with the servers.
Port Displays the ports that are used for the
protocols.
Server Displays the name of the server that is
selected in the list.
Address Type the new IP address or fully qualified
domain name if the address has changed in
the selected server.
Protocol Select a new communication protocol to use
with the selected server.
Port Enter the new port number if it has changed
in the selected server.
04-16006-04-en, March 2015 Technical
361
10 Building Operation Servers User Interface
10.10 Device Discovery View
10.10 Device Discovery View
Use the Device Discovery view to discover installed Building Operation server
hardware, Lon devices, and BACnet devices including I/O modules for an
Automation Server.
Figure: Device Discovery view
Table: Device Discovery View
Number Descriptions
System Tree
Select where to search in the System Tree.
Select device type
Select what to search for in the Select device
type box.
Device result area
Displays search results, filtered according to
device type and System Tree scope. You
can add or map devices to the Building
Operation system by dragging them to the
System Tree.
Technical 04-16006-04-en, March 2015
362
10 Building Operation Servers User Interface
10.11 Variables View
10.11 Variables View
Use the Variables view to view values, create trend logs, force values, and to edit
parameters in a structured and manageable way.
Figure: Variables view
Table: Variables View
Number Description
Use the Variables view toolbar expand or
collapse all folders and property categories
in the Variables list. You can also hide or
show the Property grid.
Use the Quick Filter box to filter categories
or properties in the Variables list.
Use the Variables list to view properties and
values in a structured and manageable way.
You can also create trend logs and edit a
multiple selection of properties.
Use the Property grid to view and edit
parameters and to force values. For more
information, see the Object Properties topic
on WebHelp.
Note
The Variables view is continuously updated. If all categories are expanded, it puts
a heavy load on the system. Avoid having too many values on display.
04-16006-04-en, March 2015 Technical
363
11 Device Administrator User
Interface
Topics
Device Administrator
Device Administrator Toolbar
Device Administrator List
Upgrade Device Dialog Box
Connect to Device Dialog Box
Detailed Progress Dialog Box
Device Log On Options Dialog Box
Enter User Name and Password Dialog Box
Edit Connection Dialog Box
Confirm Download Dialog Box
Device Administrator Properties – General Tab
Device Administrator Properties – Network Tab
Device Administrator Properties – SNMP Configuration Tab
Device Administrator Properties – Firewall Tab
Device Administrator Properties – Time Tab
11 Device Administrator User Interface
11.1 Device Administrator
11.1 Device Administrator
Use the Device Administrator to manage and upgrade the software in Automation
Servers.
Figure: Device administrator
Table: Device Administrator Components
Number Description
Device Administrator toolbar
Use the Device Administrator toolbar to
perform operations on the Automation
Servers in the list. For more information, see
section 11.2 “Device Administrator Toolbar”
on page 366.
Device list
Use the Device list to collect and inspect the
software status of the Automation Servers.
For more information, see section 11.3
“Device Administrator List” on page 368.
device(s)
Displays the number of devices in the list.
Software version
Displays the software version on the
Automation Server.
Firmware version
Displays the current software version that is
used for the upgrade.
04-16006-04-en, March 2015 Technical
367
11 Device Administrator User Interface
11.2 Device Administrator Toolbar
11.2 Device Administrator Toolbar
Use the Device Administrator toolbar to list and select Automation Servers for
upgrade of the software via the USB port or the IP network.
Figure: Device Administrator toolbar
Table: Device Administrator Toolbar
Button Description
Upgrade Device(s)
Click to open the Upgrade Device dialog
box, where you select the type of upgrade.
For more information, see section 11.4
“Upgrade Device Dialog Box” on page 369.
Download converted database to
device(s)
Click to download the converted database
to the Automation Server.
Cancel action
Click to stop the extraction of debug
information.
Add network device to list
Click to open the Connect to Automation
Server dialog box, where you add an
Automation Server to the list. For more
information, see section 11.5 “Connect to
Device Dialog Box” on page 370.
Remove network device(s) from list
Click to remove the selected Automation
Server from the list. The server itself is not
affected in any way.
Edit network device connection
Click to open the Edit connection dialog
box, where you can change the way an
Automation Server is addressed. For more
information, see section 11.9 “Edit
Connection Dialog Box” on page 374.
Open detailed progress
Click to open the Detailed Progress
dialog box after a software upgrade has
been started. For more information, see
section 11.6 “Detailed Progress Dialog Box”
on page 371.
Technical 04-16006-04-en, March 2015
368
11 Device Administrator User Interface
11.2 Device Administrator Toolbar
Continued
Button Description
Open upgrade Log
Click to open the most recent log text file for
the selected Automation Server. For more
information, see section 3.23 “ Automation
Server Upgrade ” on page 166.
Open conversion log
Click to open the conversion log.
Properties
Click to open the Properties pane listing
important information about the selected
Automation Server. For more information,
see section 11.11 “Device Administrator
Properties – General Tab” on page 376.
04-16006-04-en, March 2015 Technical
369
11 Device Administrator User Interface
11.3 Device Administrator List
11.3 Device Administrator List
Use the Device Administrator List to collect and inspect the software status of the
Automation Server.
Figure: Device Administrator List
Table: Device List Columns
Columns Description
Connection Displays the current connection with the
Automation Server: USB, Network with IP
address or host name.
Software version Displays the version of the current software
and the build number.
S/N Displays the serial number of the Automation
Server hardware.
Device status Displays the status of the device: Ready,
Upgrading, Offline, or DFU mode.
Upgrade status Displays the dynamic upgrade status of the
device.
Progress Displays a progress bar, indicating the
degree of upgrade procedure completion.
Technical 04-16006-04-en, March 2015
370
11 Device Administrator User Interface
11.4 Upgrade Device Dialog Box
11.4 Upgrade Device Dialog Box
Use the Upgrade Device dialog box to preserve or delete the Automation Server
database.
Figure: Upgrade device dialog box
Table: Upgrade Device Dialog Box
Component Description
Software version Displays the version the Automation Server
will be upgraded to.
Type of upgrade Select Upgrade database to upgrade the
software and preserve the database. Select
New database to upgrade the software
and delete the database.
Upgrade information Informs you about what happens when you
upgrade. For more information, see section
3.23 “ Automation Server Upgrade ” on page
166.
Set time on device Select to transfer the date and time on the
computer that runs Device Administrator to
the Automation Server. For more
information, see section 3.23 “ Automation
Server Upgrade ” on page 166.
04-16006-04-en, March 2015 Technical
371
11 Device Administrator User Interface
11.5 Connect to Device Dialog Box
11.5 Connect to Device Dialog Box
Use the Connect to Device dialog box to create an Automation Server network
connection.
Figure: Connect to device dialog box
Table: Connect to Device Dialog Box
Component Description
Device address Type the IP address or the host name for an
existing device.
User name Type the user name.
Password Type the password.
Port Type a port number.
SSH Select to enable the type of communication.
Use default device log on Select to use default device log on.
Connection string Displays the selected type of communication
and the specified device address, that is, IP
address or host name, and port number.
Technical 04-16006-04-en, March 2015
372
11 Device Administrator User Interface
11.6 Detailed Progress Dialog Box
11.6 Detailed Progress Dialog Box
Use the Detailed Progress dialog box to monitor the progress of the installation
procedure.
Figure: Detailed progress dialog box
Table: Detailed Progress Dialog Box
Component Description
Device S/N Displays the unique serial number of the
device.
Device address Displays the Automation Server IP address.
04-16006-04-en, March 2015 Technical
373
11 Device Administrator User Interface
11.7 Device Log On Options Dialog Box
11.7 Device Log On Options Dialog Box
Use the Default Device Log on Options dialog box to set default parameters to
be used by the Device Administrator when you add or upgrade Automation Servers.
Figure: Device log on options
Table: Device Log On Options
Component Description
User name Type the user name.
Password Type the password.
Verify password Type the password again.
Technical 04-16006-04-en, March 2015
374
11 Device Administrator User Interface
11.8 Enter User Name and Password Dialog Box
11.8 Enter User Name and Password Dialog
Box
Use the Enter user name and password dialog box if the default log on option
fails.
Figure: Enter user name and password
Table: Enter User Name And Password
Component Description
Device name Displays the name of the device.
Device address Displays the address to the device.
User name Type the user name.
Password Type the password.
04-16006-04-en, March 2015 Technical
375
11 Device Administrator User Interface
11.9 Edit Connection Dialog Box
11.9 Edit Connection Dialog Box
Use the Edit connection dialog box to set parameters for the Automation Server
network connection.
Figure: Edit connection dialog box
Table: Edit Connection Dialog Box
Component Description
Device address Type the IP address or the host name for an
existing device.
User name Type the user name.
Password Type the password.
Port Type a port number.
SSH Select to enable the type of communication.
Use default device log on Select to use default device log on.
Connection string Displays the selected type of communication
and the specified device address, that is, IP
address or host name, and port number.
Technical 04-16006-04-en, March 2015
376
11 Device Administrator User Interface
11.10 Confirm Download Dialog Box
11.10 Confirm Download Dialog Box
Use the Confirm Download dialog box to download the converted database to
the Automation Server.
Figure: Confirm Download dialog box
Table: Confirm Download Dialog Box
Property Description
Status Displays the status of the backup.
Green indicates a backup less than 24
hours old.
Yellow indicate a backup more than 24
hours old.
For more information, see section 3.23 “
Automation Server Upgrade ” on page 166.
S/N Serial numbers of the Automation Servers to
which the converted database is
downloaded.
Time Displays the time the backup was made.
04-16006-04-en, March 2015 Technical
377
11 Device Administrator User Interface
11.11 Device Administrator Properties – General Tab
11.11 Device Administrator Properties –
General Tab
Use the General tab to display software and hardware information about the
selected device.
Figure: General tab
Table: General Tab
Component Description
Port Displays the port on the Automation Server
that is used for Device Administrator
communication.
Software version Displays the software version currently
installed on the device. This can be changed
with a software upgrade from the Device
Administrator.
Serial number Displays the unique serial number of the
circuit board in the device.
Connection Displays the current type of connection: USB
or network.
Product ID Displays the type of device.
Part no Displays the Schneider Electric part number
of the device.
Neuron ID Displays the four Neuron identities of the
device in hexadecimal form.
Technical 04-16006-04-en, March 2015
378
11 Device Administrator User Interface
11.11 Device Administrator Properties – General Tab
Continued
Component Description
Hardware version Displays the general hardware version of the
device.
Hardware Displays the hardware platform type, that is,
the current version of the basic hardware
platform.
Product SN Displays the unique serial number of the
device.
Slot Displays the I/O bus address, 1-32, for the
device. (Appears only in normal mode, if
USB connection.)
04-16006-04-en, March 2015 Technical
379
11 Device Administrator User Interface
11.12 Device Administrator Properties – Network Tab
11.12 Device Administrator Properties –
Network Tab
Use the Network tab to edit communication settings for the selected Automation
Server.
Figure: Network tab
Table: Network Tab
Component Description
Static IP address Type a static IP address for the server.
MAC address Displays the Media Access Control address
of the processor in the device, a hardware
address that uniquely identifies each node of
a network.
Host name Type a unique host name of the Automation
Server.
Domain Type the name of the domain to which the
server belongs.
Netmask Type the prefix of the subnet to which the
server belongs.
Primary DNS Type the address to the primary DNS server.
Secondary DNS Type the address to the secondary DNS
server.
Technical 04-16006-04-en, March 2015
380
11 Device Administrator User Interface
11.12 Device Administrator Properties – Network Tab
Continued
Component Description
Tertiary DNS Type the address to the tertiary DNS server.
Gateway Type the address to the router.
Current IP address Displays the server IP address, which is
assigned by the DHCP server.
Enable DHCP Select to enable DHCP. If selected, the
server obtains TCP/IP configurations from
the DHCP server.
04-16006-04-en, March 2015 Technical
381
11 Device Administrator User Interface
11.13 Device Administrator Properties – SNMP Configuration Tab
11.13 Device Administrator Properties – SNMP
Configuration Tab
Use the SNMP Configuration tab to configure a user that the SNMP manager
uses to log on to the Automation Server.
Figure: SNMP Configuration tab
Table: SNMP Configuration Tab
Component Description
SNMP queries Select to enable SNMP queries.
SNMP traps Select if you want the SNMP Manager to
collect information regarding SNMP traps.
Traps destination host address Type the host name or address to the SNMP
Manager.
Username Type the username for the SNMP user.
Authentication password (MD5) Type the password for the SNMP user. The
password must be at least ten characters
long.
Confirm password Type the password again.
Privacy password Type the privacy password used to encrypt
the information sent to the SNMP Manager.
The password must be at least ten
characters long.
Technical 04-16006-04-en, March 2015
382
11 Device Administrator User Interface
11.13 Device Administrator Properties – SNMP Configuration Tab
Continued
Component Description
Confirm password Type the privacy password again.
System contact Type the name or e-mail address to the
person responsible for the Automation
Server.
Location Type the physical location of the Automation
Server.
Enable logging Select to log all access attempts to the
SNMP server in the System log.
04-16006-04-en, March 2015 Technical
383
11 Device Administrator User Interface
11.14 Device Administrator Properties – Firewall Tab
11.14 Device Administrator Properties –
Firewall Tab
Use the Firewall tab to to determine the devices that can communicate with
Automation Server.
Figure: Device Administrator properties – Firewall tab
Table: Device Administrator Properties – Firewall Tab
Component Description
Whitelist Add the IP addresses to the devices that are
allowed to communicate with the server to
the whitelist. For more information, see
section 123.3 “Firewall” on page 5189.
Reset whitelist Click to clear the whitelist.
Technical 04-16006-04-en, March 2015
384
11 Device Administrator User Interface
11.15 Device Administrator Properties – Time Tab
11.15 Device Administrator Properties – Time
Tab
Use the Time tab to display and modify time settings on the Automation Server.
Figure: Device Administrator properties – Time tab
Table: Device Administrator Properties – Time Tab
Component Description
Date Displays the time on the Automation Server.
Read-only. For more information, see the
Time and Time Zone Configuration in
Automation Server topic on WebHelp.
Time Displays the date on the Automation Server.
Read-only. For more information, see the
Time and Time Zone Configuration in
Automation Server topic on WebHelp.
Set time on device Select to transfer the date and time on the
computer that runs Device Administrator to
the Automation Server. For more
information, see section 3.23 “ Automation
Server Upgrade ” on page 166.
04-16006-04-en, March 2015 Technical
385
12 Building Operation Servers
Troubleshooting
Topics
Cannot Connect to the Automation Server
Enterprise Server Service Disabled
Error – Upgrade Using DFU Mode
Lead-Shadow Reference Server Communication Problems
12 Building Operation Servers Troubleshooting
12.1 Cannot Connect to the Automation Server
12.1 Cannot Connect to the Automation
Server
If the Automation Server's name, address, serial number and upgrade status are
displayed in grey italic, red, or orange in the Device Administrator, you cannot
connect to the Automation Server. The Automation server is offline.
12.1.1 Solution
• If the Automation Server's name is in red, the password has been changed.
Contact the administrator to get the new, correct password.
• If the Automation Server's name is in grey italic, the connection is broken.
Make sure that the Automation Server is connected using the network or USB.
Make sure that you use the correct address.
• If the Automation Server's name is in orange, the USB program that handles
the connection with the Automation Server has malfunctioned.
• If the Automation Server is offline, make sure that the computer you are using is
on the whitelist:
– Connect the computer to the Automation Server using the USB
connection. For more information, see section 3.11 “Connecting to an
Automation Server Using the USB Device Port” on page 153.
– Add your computer to the whitelist. For more information, see section
123.4 “Adding a Device to the Whitelist” on page 5190.
04-16006-04-en, March 2015 Technical
389
12 Building Operation Servers Troubleshooting
12.2 Enterprise Server Service Disabled
12.2 Enterprise Server Service Disabled
The Enterprise Server fails to start and the Enterprise Server Windows service
status is disabled after upgrade.
12.2.1 Solution
Restart the computer.
Technical 04-16006-04-en, March 2015
390
12 Building Operation Servers Troubleshooting
12.3 Error – Upgrade Using DFU Mode
12.3 Error – Upgrade Using DFU Mode
The system alarm "Error - Upgrade Using DFU Mode" is triggered when the
Automation Servers file system has been corrupted due to a power failure. If you
receive this alarm you have to restore the Automation Server software and
database to the latest backup.
The alarm is not triggered after every power failure, only when files have been
corrupted due to the power failure.
12.3.1 Solution
Connect to the Automation Server in DFU mode. For more information, see section
3.11 “Connecting to an Automation Server Using the USB Device Port” on page
153.
Restore the software on the Automation Server. For more information, see section
3.21 “Restoring the Software of a Damaged Automation Server” on page 164.
Restore the Automation Server from the latest backup. For more information, see
the Restoring a Server topic on WebHelp.
04-16006-04-en, March 2015 Technical
391
12 Building Operation Servers Troubleshooting
12.4 Lead-Shadow Reference Server Communication Problems
12.4 Lead-Shadow Reference Server
Communication Problems
Lead-shadow reference communication does not work between an Automation
Server and the Enterprise Server.
12.4.1 Solution
The solutions are listed in order: the solution most likely to fix the problem is listed
first. Work through each solution until the problem is resolved.
• Ensure that the communication address to the Enterprise Server is correct. The
address should be either an IP address or a fully qualified domain name (host
name plus domain name) such as es1.universityx.edu.
For more information, see section 4.4 “Updating Communication Parameters”
on page 179.
For more information, see section 4.9 “Updating Project Configuration Server
Communication Parameters” on page 187.
• If you have deployed both the Enterprise Server and the Automation Server,
and changed the server communication setting on the Automation Server
afterwards, you may have to reset the Automation Server with a warm start.
For more information, see the Reset Functions topic on WebHelp.
Technical 04-16006-04-en, March 2015
392
13 Automation Server Web
Configuration
Topics
Automation Server Web Configuration Page
Configuring the Automation Server TCP/IP Settings and
Ports
Displaying the Automation Server System Information
Exporting Automation Server Log Files
Refreshing the Automation Server System Log
13 Automation Server Web Configuration
13.1 Automation Server Web Configuration Page
13.1 Automation Server Web Configuration
Page
The Automation Server Web Configuration page can only be accessed through
Webstation. In the Automation Server Web Configuration page, you can change
TCP/IP settings, download logs, and check the version of the Automation Server.
You must have permission to be able to access the Automation Server Log Web
Configuration Page.
13.1.1 TCP/IP Settings and System Info
You can change TCP/IP settings, change ports, and change host name using the
Automation Server Web Configuration page. You can also view Automation
Server's serial number, MAC address, hardware version using the System Info tab
on the Automation Server Web Configuration page.
The TCP/IP settings can also be changed using Device Administrator. For more
information, see section 3.18 “Setting the Automation Server IP Address” on page
160.
13.1.2 Automation Server Log Files
The Automation Server stores its log files to the onboard flash memory. Some of the
log files store the events according to the circular storing principle: when a log file
exceeds its maximum size the oldest event is overwritten.
Through the Automation Server Web Configuration page, you can export the
Automation Server log files. When exporting log files, the Automation Server
compresses the files with ZIP.
The information in the logs is essential for the product support service or when
troubleshooting. To forward the information to a troubleshooter who does not have
access to your system, download the log files and attach them to an e-mail.
04-16006-04-en, March 2015 Technical
395
13 Automation Server Web Configuration
13.2 Configuring the Automation Server TCP/IP Settings and Ports
13.2 Configuring the Automation Server
TCP/IP Settings and Ports
You configure the TCP/IP settings of the Automation Server through the Automation
Server Web Configuration to define the network communication of the server.
For more information, see section 13.1 “Automation Server Web Configuration
Page” on page 393.
To configure the Automation Server TCP/IP settings and ports
1. In WebStation, in the Settings menu, click Device Configuration.
2. Click TCP/IP.
3. In the DHCP box, select Enable to obtain TCP/IP configuration information
from a DHCP server.
4. In the IP address box, type the IP address of the Automation Server.
5. In the Subnet mask box, type the address of the subnet that the server
belongs to.
6. In the Default gateway box, type the address of the node that serves as an
access point to another network.
7. In the DNS server box, type the address to the DNS server where the
Automation Server address is listed.
8. In the Domain name box, type the IP domain name that the server belongs
to.
9. In the Host name box, type the IP host name of the server.
10. In the HTTP port box, type the HTTP port.
11. In the HTTPS port box, type the HTTPS port.
Continued on next page
Technical 04-16006-04-en, March 2015
396
13 Automation Server Web Configuration
13.2 Configuring the Automation Server TCP/IP Settings and Ports
12. Click Save.
04-16006-04-en, March 2015 Technical
397
13 Automation Server Web Configuration
13.3 Displaying the Automation Server System Information
13.3 Displaying the Automation Server
System Information
You view the Automation Server settings and manufacturing data to get a an
overview of the current configuration of the Automations Server.
For more information, see section 13.1 “Automation Server Web Configuration
Page” on page 393.
To display the Automation Server system information
1. In WebStation, in the Settings menu, click Device Configuration.
2. Click the System Info tab.
You cannot configure all the settings in the system information using the Web
Configuration. For example, Automation Server time and time zone settings are
configured through WorkStation.
Technical 04-16006-04-en, March 2015
398
13 Automation Server Web Configuration
13.4 Exporting Automation Server Log Files
13.4 Exporting Automation Server Log Files
You export the log files on the Automation Server to an external storage device to
view the log information.
For more information, see section 13.1 “Automation Server Web Configuration
Page” on page 393.
To export Automation Server log files
1. In WebStation, in the Settings menu, click Device Configuration.
2. Click Server Log.
3. Click Get all log files.
4. Click Save.
Continued on next page
04-16006-04-en, March 2015 Technical
399
13 Automation Server Web Configuration
13.4 Exporting Automation Server Log Files
5. Select the location where you want to save the compressed log files and click
Save.
6. Click Close.
The log files, when downloaded, are compressed to a ZIP file. To open the log files,
extract the compressed file and open the .log-files with any text editor.
Technical 04-16006-04-en, March 2015
400
13 Automation Server Web Configuration
13.5 Refreshing the Automation Server System Log
13.5 Refreshing the Automation Server
System Log
You refresh the server log page to display the latest system log events. The
Automation Server Web Configuration page does not automatically update with the
log file.
For more information, see section 13.1 “Automation Server Web Configuration
Page” on page 393.
To refresh the current Automation Server log
1. In WebStation, in the Settings menu, click Device Configuration.
2. Click Server Log to view the Automation Server log.
3. Click Server Log tab to refresh the web page to display the latest log events.
04-16006-04-en, March 2015 Technical
401
14 Automation Server Web
Configuration User Interface
Topics
Automation Server Web Configuration – TCP/IP Page
Automation Server Web Configuration – System Information
Page
Automation Server Web Configuration – Server Log Page
14 Automation Server Web Configuration User Interface
14.1 Automation Server Web Configuration – TCP/IP Page
14.1 Automation Server Web
Configuration – TCP/IP Page
Use the TCP/IP page to configure Automation Server TCP/IP settings.
Figure: TCP/IP page
Table: TCP/IP Page
Component Description
DHCP Select Enabled to obtain configuration
information from a DHCP server.
IP address Type the IP address of the server.
Subnet mask Type the address of the subnet that the
server belongs to.
Default gateway Type the address to the node that serves as
an access point to another network.
DNS server Type the address to a DNS server where the
server is listed.
Domain name Type the IP domain name that the server
belongs to.
04-16006-04-en, March 2015 Technical
405
14 Automation Server Web Configuration User Interface
14.1 Automation Server Web Configuration – TCP/IP Page
Continued
Component Description
Host name Type the IP host name of the server. This
host name can be connected to the IP
address, depending of the DNS server.
HTTP Port Type the port number that the server listens
to when communicating through the
Hypertext Transfer Protocol.
Technical 04-16006-04-en, March 2015
406
14 Automation Server Web Configuration User Interface
14.2 Automation Server Web Configuration – System Information Page
14.2 Automation Server Web
Configuration – System Information
Page
Use the System Information page to display server settings and manufacturing
data. All the information on this page is read only.
Figure: System Information page
Table: System Information Page
Component Description
Product S/N Displays the serial number of the server
Product ID Displays the product ID of the server.
Part number Displays the part number of the server.
Hardware platform Displays the hardware platform of the server.
Hardware version Displays the hardware version of the server.
MAC address Displays the MAC address of the Automation
Server.
04-16006-04-en, March 2015 Technical
407
14 Automation Server Web Configuration User Interface
14.2 Automation Server Web Configuration – System Information Page
Continued
Component Description
Neuron ID 0 Displays the Neuron ID 0 which is used to
identify LonWorks nodes or other
functionality in the LonWorks network.
Neuron ID 1 Displays the Neuron ID 1 which is used to
identify LonWorks nodes or other
functionality in the LonWorks network.
Neuron ID 2 Displays the Neuron ID 2 which is used to
identify LonWorks nodes or other
functionality in the LonWorks network.
Neuron ID 3 Displays the Neuron ID 3 which is used to
identify LonWorks nodes or other
functionality in the LonWorks network.
Neuron ID 4 Displays the Neuron ID 4 which is used to
identify LonWorks nodes or other
functionality in the LonWorks network.
Neuron ID 5 Displays the Neuron ID 5 which is used to
identify LonWorks nodes or other
functionality in the LonWorks network.
TAC Software version Displays the version of the Automation
Server software.
Use external NTP server Dispalys if the server synchronizes its time
and date with an network time protocol
server
NTP server 1 Displays the address to the primary network
time protocol server to which the server
synchronizes its time with.
NTP server 2 Displays the address to the secondary
network time protocol server to which the
server synchronizes its time with.
Time zone (UTC Offset) Displays the server time zone settings.
Daylight saving time Displays if the time zone has a DST offset.
DHCP Displays if the Dynamic Host Configuration
Protocol is enabled. If enabled, the server
obtains TCP/IP configurations from the
DHCP server.
IP address Displays the IP address of the server.
Subnet mask Displays the address of the subnet that the
server belongs to.
Default gateway Displays the address to the node that serves
as an access point to another network.
DNS server Displays the address to the DNS server.
Technical 04-16006-04-en, March 2015
408
14 Automation Server Web Configuration User Interface
14.2 Automation Server Web Configuration – System Information Page
Continued
Component Description
Domain name Displays the IP domain name of the server.
Host name Displays the IP host name of the server. This
host name can be connected to the IP
address, depending of the DNS server.
HTTP port Displays the port number that the server
listens to when communicating through the
Hypertext Transfer Protocol.
HTTPS port Displays the port number that the server
listens to when communicating through the
Hypertext Transfer Protocol Secure.
04-16006-04-en, March 2015 Technical
409
14 Automation Server Web Configuration User Interface
14.3 Automation Server Web Configuration – Server Log Page
14.3 Automation Server Web
Configuration – Server Log Page
Use the Server Log page to display the current server system log and to export all
Automation Server log files.
Figure: Server Log page
Table: Server Log Page
Component Description
Get all log files Click to export all log files stored on the
Automation Server. The log files are
compressed into a zip file.
Technical 04-16006-04-en, March 2015
410
15 Bindings
Topics
Bindings Overview
Methods of Binding
Binding Values Manually
Binding Rules
Direction of Bindings
Value Transfer Settings
Value Transfer
Configuring the Value Transfer Interval
Locked and Unlocked Binding Paths
Locking or Unlocking a Path
Bindings Management
Checking the Status of Bindings
LonWorks Bindings
Server Values
Creating a Server Value
Creating a Server Analog Value
Configuring the Value and the Unit for a Server Analog
Value
Creating a Server Digital Value
15 Bindings
15.1 Bindings Overview
15.1 Bindings Overview
A binding is a connection between two or more variables for data exchange. In its
simplest form, a binding consists of a source and a destination. The source supplies
the value to the destination.
Figure: A binding with a source and destination
In Building Operation, you typically bind source values to destination properties in
objects such as programs, alarms, trend logs, and graphics. These objects
frequently need to use values that exist elsewhere in the system.
For example, you create a program that evaluates temperatures and controls a
heating system. You create the temperature properties in the program, open the
Binding view, browse for the source temperature sensors in the system, and drag
their temperature output values to their corresponding temperature input properties
in the program. The values of the temperature properties in the program will then
mirror those of the live sensor values.
Figure: Binding example
With many programming editors, you define, declare, and bind remote values
directly in your program. In Building Operation, you create the destination properties
in the program, but you create the bindings externally, separate from the program.
This separation of program and bindings is due to the object-oriented approach in
Building Operation. Objects, such as programs, can be reused, mass created, and
mass changed. The separation between objects and bindings also enables the use
of binding templates, which enables you to automate as many repetitive binding
tasks as possible.
04-16006-04-en, March 2015 Technical
413
15 Bindings
15.1 Bindings Overview
15.1.1 Methods of Binding
You can bind values manually or automatically.
For more information, see section 15.2 “ Methods of Binding” on page 414.
15.1.2 Binding Rules
The value that you bind can be one of five property types: real, multistate, digital,
alphabetic, or a date.
For more information, see section 15.4 “Binding Rules ” on page 417.
15.1.3 Direction of Bindings
All bindings have a sense of direction. In its simplest form, a binding consists of a
source and a destination. The source supplies the value to the destination.
For more information, see section 15.5 “Direction of Bindings” on page 418.
15.1.4 Value Transfer Interval
When you connect one point to another point, the values are transferred at the
default rate of 10 seconds. However, you can change this setting if you want the
values to be transferred faster or with longer intervals to reduce the workload in the
system.
For more information, see section 15.6 “Value Transfer Settings ” on page 420.
15.1.5 Binding Path Format
A binding can have one of two path formats:
• Locked
• Unlocked
For more information, see section 15.9 “Locked and Unlocked Binding Paths” on
page 429.
15.1.6 Bindings Management
You manage bindings so that information is not lost and the system works
efficiently. You can check the bindings in your database using Bindings Diagnostics.
For more information, see section 15.11 “Bindings Management” on page 434.
Technical 04-16006-04-en, March 2015
414
15 Bindings
15.1 Bindings Overview
15.1.7 LonWorks Bindings
LonWorks bindings differ from other Building Operation bindings because you can
set LonWorks specific properties, such as LonWorks binding profiles.
For more information, see section 58.1 “LonWorks Bindings ” on page 2093.
15.1.8 Server Values
Server values are values created on an Automation Server. Server values are used
to control network traffic or to provide value configurations that are not available in a
program. Server values work as an interface or connector between an Automation
Server and another:
• A program on one Automation Server and a value on another Automation
Server, for example, a function block program on one Automation Server and a
value on another Automation Server.
• A field device value and an Automation Server, for example, an value from a
sensor and an alarm on an Automation Server.
For more information, see section 15.14 “Server Values” on page 438.
04-16006-04-en, March 2015 Technical
415
15 Bindings
15.2 Methods of Binding
15.2 Methods of Binding
You can bind values manually or automatically.
15.2.1 Manual
You can bind a value by dragging it to a property's Bindings box in the Binding list.
You use manual binding for a binding task unless you have prepared a binding
template for that particular task.
Figure: Drag-and-drop
You can type a path to a value in the property's Binding box to create a binding.
Technical 04-16006-04-en, March 2015
416
15 Bindings
15.2 Methods of Binding
Figure: Path writing
When you drag a value to the Binding point list or write a path, you are specifying
the other end of the binding, which is either a source or a destination. You can bind
both ways in the Binding point list.
Binding paths can be unlocked or locked. For more information, see section 15.9
“Locked and Unlocked Binding Paths” on page 429.
15.2.2 Binding Templates
You can bind values automatically by using binding templates, that is, predefined
templates.
For more information, see section 16.1 “Binding Templates” on page 449.
04-16006-04-en, March 2015 Technical
417
15 Bindings
15.3 Binding Values Manually
15.3 Binding Values Manually
You bind values to exchange data between objects.
For more information, see section 15.1 “Bindings Overview” on page 411.
To bind values manually
1. In WorkStation, in the System Tree pane, select the object to which you
want to bind values.
2. On the Actions menu, click Edit bindings.
3. In the binding Browser, drag a value to a property in the binding list to create
a binding.
You can also drag objects from the System Tree pane, or values from the
Search pane, or you can type the binding path in the Binding box.
4. On the toolbar, click the Save button .
Technical 04-16006-04-en, March 2015
418
15 Bindings
15.4 Binding Rules
15.4 Binding Rules
The value that you bind can be one of five property types: real, multistate, digital,
alphabetic, or a date.
The destination property that you create for the binding must be compatible with
the source value. The destination property and the source value must be of the
same type and descend from the same engineering unit class.
For example, you cannot bind a real (numeric) value to an alphabetic value because
they are not of the same value type. You cannot bind a temperature engineering
unit to a time engineering unit because they are not of the same engineering unit
class. You can, however, bind values of the same engineering unit class, such as
centimeters to meters, or Celsius to Fahrenheit. Conversion of values within the
same engineering unit class is handled by Building Operation.
Other binding rules concern program properties. In general, trying to bind an input
to an input, or an output to an output, is never practical and therefore not possible.
Building Operation neither proposes or allows it. There are also program specific
binding rules, also rather evident to those concerned. A good way to look at it, is
that if you are trying to bind something, and Building Operation does not allow it,
you are doing something wrong.
04-16006-04-en, March 2015 Technical
419
15 Bindings
15.5 Direction of Bindings
15.5 Direction of Bindings
All bindings have a sense of direction. In its simplest form, a binding consists of a
source and a destination. The source supplies the value to the destination.
One-to-One
A one-to-one binding is a binding between two variables of compatible types.
Figure: Bindning direction
For example, an I/O point is bound to a script program.
One-to-Many (Group or Fan-out in LonWorks)
A one to many binding is a binding between one source and many destinations.
Figure: One-to-many binding
For example, a zone controller sends out a setpoint for many HVAC controllers.
The Direction of Bindings in the Binding View
In Building Operation, in the Binding view, you can bind in any direction.
Technical 04-16006-04-en, March 2015
420
15 Bindings
15.5 Direction of Bindings
Figure: Two-way binding
You can select an object in the System Tree pane, open the Binding tab, and then
bind applicable properties. Some become destination properties and some become
source values to destination properties in other objects. If you drag an output to an
input property in the object, Building Operation determines that the property in the
Binding point list is the destination. If you drag an input to an output property in the
Binding point list, Building Operation determines that the output property is the
source and that the remote value is the destination.
If two properties can bind both ways, the Building Operation prompts you to decide
the direction of the binding.
04-16006-04-en, March 2015 Technical
421
15 Bindings
15.6 Value Transfer Settings
15.6 Value Transfer Settings
When you connect one point to another point, you can make a number of settings
on the receiving object (consumer) to control the value transfer rate.
You can make the following settings:
• Requested transfer rate
• Value transfer preferences
• Guaranteed transfer even if value has not changed
Figure: The transfer interval rate is set in the Values setting transfer dialog box
15.6.1 Requested Transfer Rate
The requested value transfer rate is how often you would like the transfers to take
place. You can choose between predefined intervals or manually define the interval.
If you enter a manual interval identical to one of the pre-defined intervals, the dialog
box displays the pre-defined interval the next time you open the dialog box. For
example, if you use the manual interval and set it to 1 minute, the pre-defined
interval 1 minute is displayed the next time you open the dialog box.
Note
• The actual transfer rate can differ from the requested transfer rate depending
on, for example:
– Whether or not the value is transferred to more than one recipient.
Continued on next page
Technical 04-16006-04-en, March 2015
422
15 Bindings
15.6 Value Transfer Settings
– Whether or not the transfer takes place within an Enterprise Server or
Automation Server or between an Enterprise Server and an Automation
Server or one Automation Server and another Automation Server.
– The speed of the field bus.
– The general load on the system.
If a value is transferred within a server, the transfer takes place as fast as possible.
Figure: The requested transfer rate (1) is the rate at which the value is transferred if
possible.
15.6.2 Delta Value Transfer
Delta lets you define the transfer rate based on a delta value. The Delta value is
checked at every interval but only values that exceed the Delta value (2) are
transferred.
Note
If you set the Delta to zero, the program reacts on any relative change above or
below zero. For example, if the Delta is set to 1, value changes above 1 or below -
1 relative to the previous recorded value are transferred.
You can also set the value transfer rate to transfer the value at each requested
interval even if the value has not changed. In this case, the value is transferred at
every interval. Selecting this option makes the Delta setting unavailable since it has
no use if the transfer is accomplished based on the rate
04-16006-04-en, March 2015 Technical
423
15 Bindings
15.6 Value Transfer Settings
Figure: The Delta is checked each time but only values that exceed the Delta (2) are
transferred..
15.6.3 Guaranteed Transfer
Guaranteed transfer even if value has not changed (3) lets you make sure that the
value is transferred at the specified time interval, even if the value has not changed.
You can disable this feature.
Figure: The guaranteed transfer interval (3) makes sure that you get at least one transfer
per interval.
15.6.4 Combined Methods
You can combine the value transfer settings. For example, you want a value to be
transferred when it exceeds the Delta 0.5. However, even if the change of the value
does not exceed the Delta, you still want the value to be transferred once every
hour. Therefore, you set the guaranteed transfer interval to one hour.
Technical 04-16006-04-en, March 2015
424
15 Bindings
15.6 Value Transfer Settings
Value changes are checked at a minimum of every interval. Depending on the
circumstances, they could be checked more often.
Figure: You can combine methods, for example, to make sure that the value is transferred
at a minimum rate.
04-16006-04-en, March 2015 Technical
425
15 Bindings
15.7 Value Transfer
15.7 Value Transfer
When you connect one point to another point, the rate at which values are
transferred from the sending object of the value (producer) to the receiving object of
the value (consumer) depends on the cause of the transfer and the devices that are
involved.
In some cases the Value transfer settings determine the value transfer rate, in some
they do not. There are three types of references that impact the value transfer rate:
• Application
• Central
• Field bus
15.7.1 Application Value Transfer
In application value transfer, the value transfer rate is determined by the application.
The value transfer rate depends on the elements of the application.
• Watch Window – a 500 millisecond value transfer rate, which is not adjustable.
To remove the value subscription, you have to remove the object from the
Watch Window.
• Graphics – By default, a 500 millisecond value transfer rate. To remove the
value subscription, you have to close the graphic.
• Trends – interval trend log. If the interval is greater than one minute, the
minimum value transfer rate (never) is used until just before the time the interval
trend log needs data, and then the transfer rate is increased to maximum. If the
value transfer rate of the interval is a minute or less, then the desired value
transfer rate is set to one half of the interval. The value subscription cannot be
removed as long as the trend log exists.
• Alarms –The desired value transfer rate is set to 100 milliseconds for polled
alarms, including all alarms on field bus points. The subscription cannot be
removed as long as the alarm exists.
• Programs – Script or Function Block Programs read all of their bound inputs at
a value transfer rate corresponding to the task set for the program. The object
reading from the program’s local output reads at a value transfer rate that is
consistent with the transfer type. If another object property is reading from the
output, the Value transfer settings are involved. The value subscription cannot
be removed as long as the connection between the object property and the
program exists.
Note
Delays can happen when several applications try to execute at the same time.
15.7.2 Central Value Transfer
The central value transfer is controlled by the value transfer rate specified by the
user unless the value transfer is entirely within one server and no server-to-server
communication is involved. In this case, the value transfer is immediate. For more
information, see section 15.6 “Value Transfer Settings ” on page 420.
Technical 04-16006-04-en, March 2015
426
15 Bindings
15.7 Value Transfer
Examples:
• A value object within AS1 reads from a value object within AS2. In this case,
the value object read is controlled by the Value transfer settings. By default, the
poll rate is set to 10 seconds. You can change the value transfer interval. If you
set a Delta value no value transfer occurs even after the polling interval has
passed unless the change since the previous reading exceeds the Delta value
setting. If you set a Guaranteed value transfer rate, the value transfer is forced
after the elapsed time regardless of whether the value has changed.
• A value object within AS1 reads from a value object also within AS1. In this
case, the value object read is not controlled by the Requested transfer rate
setting. The reason is that there is no cost for immediate value transfer since
there is no server-to-server or field bus communication. However, the Delta
and the Guaranteed transfer settings are still in force.
15.7.3 Field Bus Value Transfer
When the value transfer involves a field bus, the communication plug-in, the field
bus protocol and the direction in which the value transfer takes place control when
the value is transferred.
Examples:
• An SBO object connected to an I/NET object.
– If the I/NET object is reading from the SBO object, the transfer mechanism
considers the cost to communicate down the field bus and it regards the
delta and intervals in the Variable transfer settings.
– If the SBO object is reading from the I/NET object, the Variable transfer
settings are delivered to the I/NET plug-in, but the requested value transfer
rate is not regarded because the I/NET plug-in only supports certain
update rates. The I/NET plug-in uses the point scan rate defined for the
point's associated DCU.
• A BACnet object connected to an SBO object.
– If the BACnet object is reading from the SBO object, the transfer
mechanism considers that there is a cost to communicate down the field
bus and it uses the delta and intervals that are entered in the Variable
transfer settings. The SBO BACnet plug-in issues a write property to the
other BACnet device based upon the delta that is entered into the Variable
transfer settings. If the setting is “0”, a write property occurs upon any
change. If the setting is not “0” but, for example, “1”, then a write property
occurs when the value has changed by more than 1. The write property
does not occur again after the “pre-defined interval” in the Variable transfer
settings. The “pre-defined interval” only has meaning in a polled scenario,
not in a BACnet write property scenario. However, the write property
occurs again after the guaranteed transfer interval provided that it is set.
Consequently, it is important to use that parameter to protect against loss
of setting if the external BACnet device resets and restores default values.
If the guaranteed transfer interval is not used and the BACnet device that
is the recipient of the write property restores default values upon reset, the
SBO does not resend the value after the device reset. It may not even be
aware that it has reset.
04-16006-04-en, March 2015 Technical
427
15 Bindings
15.7 Value Transfer
– If the SBO object is reading from the BACnet object, the Variable transfer
settings are delivered to the BACnet plug-in. The plug-in determines if the
device producing the value supports COV for the object property
requested.
– If it does, it requests a subscription between SBO and that device.
The device transfers values based on its own services and the COV
increment for the requested object. It does not use the delta in the
Variable transfer settings. The communication plug-in knows the most
efficient way to get values from the field bus and it uses that method
to satisfy the read request from the consuming object. In the case of
BACnet, COV is most efficient; so it transfers the values at the COV
increment of the object that is being read. The values are then
delivered to the Variable Transfer Manager, which decides if the
values are to be read by the consuming object based on the Delta set
in the Value transfer settings. This can cause unexpected behavior
depending on the relative sizes of the referenced object COV
increment and the Delta set in the Value transfer settings. If the COV
increment in the object is, for example, 0.4 and the Delta in the Value
transfer settings is 0.5, the actual read takes place in 0.8 because the
first 0.4 increment does not satisfy the Value transfer setting so it
waits for the next change actually to read the new value.
– If the object being referenced does not support COV, the BACnet
plug-in issues a read property request at the rate specified in the
shorter of the requested value transfer rate or guaranteed value
transfer rate.
• A Script or Function Block Program using a BACnet object as an input.
– The program’s task rate drives the reading frequency, regardless of the
Value transfer settings.
• A Modbus object connected to an SBO object.
– If the Modbus register is reading from the SBO object, the transfer
mechanism considers the cost to communicate down the field bus and it
regards the delta and intervals in the Variable transfer settings
– If the SBO object is reading from the Modbus register, the Variable transfer
settings are delivered to the Modbus plug-in. Since Modbus is a polled
communication bus, the requested transfer, delta, and guaranteed
transfer rates are regarded. As soon as a subscription is established
between a Modbus register and an SBO object, that subscription cancels
the Modbus device polling regardless of whether the subscription rate is
longer than the device polling rate.
– Since Modbus is a polling protocol, it is possible that so many requests
can be made that none of them can be satisfied in the time requested. In
this case, the value transfer occurs as fast as possible
• A LON device connected to an SBO object.
– If the SBO object requires a value from the LON device, it is recommended
to mirror the LON value to the Local Node, and then bind the SBO object
to the copy on the Local Node. In this way, LON send-on-delta updates
the Local Node copy, and then application data transfer dictates how the
SBO object receives updates from the Local Node’s copy of the value. For
graphics bindings that only generate traffic when the associated graphic is
open, it is acceptable to either bind to a Local Node copy of the value
when available, or otherwise to bind directly to the value on the LON
device. Binding the graphic directly to the value on the LON device
generates polling requests only when the graphic page is open.
Technical 04-16006-04-en, March 2015
428
15 Bindings
15.7 Value Transfer
– If the LON device requires a value from the SBO object, this value can be
sent in one of two ways:
– The SBO object’s value can be bound to an object on the Local
Node, and then a LON binding from the Local Node to the LON
device will allow a conventional LON binding (with heartbeat). The
requested transfer rate is not significant between the SBO object and
the Local Node object, but both the delta and the guaranteed transfer
rate are very significant. If either results in an update to the Local
Node object, the LON plug-in will generate an update message and
send it to the LON device. The guaranteed transfer rate can force this
message to be generated even if there is no change in the
value—whenever the Local Node object is updated, a message is
sent. The Local Node object can also be configured with a "send
rate", which can also cause the value to be routinely pushed to the
LON device.
– The SBO object’s value can also be bound directly to the input on a
LON device, and this does make use of the retransmit interval, delta,
and guaranteed transfer rate. It is not a true LON binding, however,
so controllers like the MNL with a configurable heartbeat requirement
may not accept the writes as valid heartbeats and may revert the
objects to default values between writes.
15.7.4 Cautions
The value is transferred as fast as possible considering the value transfer rate
limitations in field bus and network communication. The value transfer rate also
depends on the direction. If an SBO object is reading from a BACnet object, the
value transfer rate can differ from the scenario when the BACnet object is reading
from the SBO object, even if the Variable transfer settings are identical.
If your implementation requires that a certain delta be imposed before doing
something else, a Guaranteed value transfer rate setting can cause unexpected
behavior. The Guaranteed transfer even if value has not changed setting, means
that the value is transferred even if it has not changed in relation to the previous
value by an amount greater than the delta.
When attempting to confirm the actual value transfer rate, it is important to be
certain that all of the value transfers are known because one value transfer can
easily affect another. When the producer is told to update two entities on the same
server at different rates, it updates both at the faster of those two rates.
04-16006-04-en, March 2015 Technical
429
15 Bindings
15.8 Configuring the Value Transfer Interval
15.8 Configuring the Value Transfer Interval
You adapt the value transfer interval between objects in the database to better suit
the transfer workload in the system.
For more information, see section 15.6 “Value Transfer Settings ” on page 420.
To configure the value transfer interval
1. In WorkStation, in the System Tree pane, select the object.
2. On the Actions menu, click Edit bindings.
3. In the Bindings view, click the Edit button .
4. In the Value transfer settings dialog box, select the value transfer interval.
5. Click OK.
6. On the File menu, click Save.
Technical 04-16006-04-en, March 2015
430
15 Bindings
15.9 Locked and Unlocked Binding Paths
15.9 Locked and Unlocked Binding Paths
A binding can have one of two path formats:
• Locked
• Unlocked
You need to consider the binding path format when you copy and paste or export
and import objects that have bindings. Typically, bindings are included when you
copy objects that have bindings.
When you import or paste a locked path, it keeps its original path and mirrors the
original source value. When you import or paste an unlocked path, it generates a
new path and binds the object to a new source value relative to its new location.
You decide what external binding paths to include in an export: locked, locked and
unlocked, or none. For more information, see section 18.2 “Export” on page 559.
Note
The lock feature is disabled for LonWorks bindings, because a locked LonWorks
binding may result in scenarios where a binding contains several hubs pointing to
one target, or different binding profiles are mixed.
15.9.1 Locked
There are two types of locked binding paths:
• System absolute
• Server absolute
System Absolute
System absolute binding paths to objects on another server are always locked and
cannot be unlocked. The path is displayed as, for example,
/Server2/System/Folder/Value.
04-16006-04-en, March 2015 Technical
431
15 Bindings
15.9 Locked and Unlocked Binding Paths
Figure: Locked system absolute binding paths
Server Absolute
Server absolute binding paths to objects in the System folder are always locked and
cannot be unlocked. The path is displayed as, for example, ~/System/Folder/Value.
Technical 04-16006-04-en, March 2015
432
15 Bindings
15.9 Locked and Unlocked Binding Paths
Figure: Locked server absolute binding paths
15.9.2 Unlocked
Unlocked binding paths are always relative. All binding paths that are not server
absolute or system absolute are relative and, by default, unlocked. The path starts
with elipses (..),is displayed as, for example, ../Folder/Value.
04-16006-04-en, March 2015 Technical
433
15 Bindings
15.9 Locked and Unlocked Binding Paths
Figure: Unlocked relative binding paths
You can manually lock a relative binding path that you want to keep when you copy
and paste or export and import. When you lock a relative binding path it becomes
server absolute. In contrast to server absolute binding paths that point to objects in
the System folder, you can unlock the manually locked binding paths.
Technical 04-16006-04-en, March 2015
434
15 Bindings
15.10 Locking or Unlocking a Path
15.10 Locking or Unlocking a Path
You lock a path to make it server absolute, that is, it will always refer to the same
server.
For more information, see section 15.9 “Locked and Unlocked Binding Paths” on
page 429.
To lock or unlock a path
1. In the Actions menu, click Edit bindings.
2. Right-click in the value path field.
3. Select or clear Lock path.
04-16006-04-en, March 2015 Technical
435
15 Bindings
15.11 Bindings Management
15.11 Bindings Management
You manage bindings so that information is not lost and the system works
efficiently. You can check the bindings in your database using Bindings Diagnostics.
Faulty bindings can have two types of status:
• Invalid: The binding points to something that cannot be bound together, such
as an out of range alarm that is monitored by a digital value.
• Unresolved: The binding points to an object that is not in the database, such
as an object that you deleted.
If you delete an object and keep the bindings to the deleted object, you get an
unresolved binding. If you later replace the object in the same location and with the
same name, the binding is resolved. For more information, see section 17.13
“Bindings Status Icons” on page 540.
You can resolve invalid or unresolved bindings by editing the binding. For more
information, see section 15.3 “Binding Values Manually” on page 416.
Technical 04-16006-04-en, March 2015
436
15 Bindings
15.12 Checking the Status of Bindings
15.12 Checking the Status of Bindings
You check the status of bindings to identify any unresolved or invalid bindings.
For more information, see section 15.11 “Bindings Management” on page 434.
To check the status of bindings
1. In WorkStation, on the Tools menu, click Control Panel.
2. On the Control Panel toolbar, select the server.
3. Click Bindings Diagnostics.
4. In the Status column, view the status of the bindings.
04-16006-04-en, March 2015 Technical
437
15 Bindings
15.13 LonWorks Bindings
15.13 LonWorks Bindings
A LonWorks binding is a connection between two or more network variables or
configuration properties for data exchange. In its simplest form, one variable is
bound to another in a Point-to-point binding. You can also bind one variable to
several (Fan-out), or several to one (Fan-in).
LonWorks bindings differ from other Building Operation bindings because you can
set LonWorks specific properties, such as LonWorks binding profiles.
Figure: Point-to-point binding
A binding consists of one hub and one or more targets. The hub is a unique node
that connects to one or more targets.
Note
• To create a LonWorks binding, you need to bind on the variable level. If you
bind two members of network variables, a Building Operation binding is
created rather than a LonWorks binding. For more information, see section
57.9 “Network Variables and Configuration Parameters” on page 2074.
Note
The lock feature is disabled for LonWorks bindings, because a locked LonWorks
binding may result in scenarios where a binding contains several hubs pointing to
one target, or different binding profiles are mixed.
15.13.1 LonWorks Bindings in WorkStation
Use the Bindings View in WorkStation to create your LonWorks bindings. You can
drag and drop NVs to create bindings.
For more information, see section 58.2 “LonWorks Bindings in WorkStation” on
page 2095.
15.13.2 Bindable objects in LonWorks
LonWorks network variables and configuration parameters can be bound to each
other in LonWorks bindings. They can also be bound to most points in Building
Operation, such as programs, graphics, alarms, and trend logs, but then Building
Operation bindings is used, not LonWorks bindings.
Technical 04-16006-04-en, March 2015
438
15 Bindings
15.13 LonWorks Bindings
For more information, see section 58.5 “Bindable Objects in LonWorks” on page
2101.
15.13.3 LonWorks Binding Profiles
When you create a binding in LonWorks, you decide its behavior by selecting a
binding profile. You either select a binding profile, or you use the default profile.
For more information, see section 58.3 “LonWorks Binding Profiles ” on page 2096.
15.13.4 LonWorks Binding Types
Building Operation supports different types of LonWorks bindings, such as point-to-
point, turnaround, fan-in, and fan-out.
For more information, see section 58.4 “LonWorks Binding Types” on page 2098.
15.13.5 LonWorks Selectors and Bindings
LonWorks uses selectors to create bindings between network variables. A selector
is a unique index that is assigned to a network variable and points to the target
device, where the bound network variable is assigned the same selector index.
For more information, see section 58.6 “LonWorks Selectors and Bindings” on
page 2102.
04-16006-04-en, March 2015 Technical
439
15 Bindings
15.14 Server Values
15.14 Server Values
Server values are values created on an Automation Server. Server values are used
to control network traffic or to provide value configurations that are not available in a
program. Server values work as an interface or connector between an Automation
Server and another:
• A program on one Automation Server and a value on another Automation
Server, for example, a function block program on one Automation Server and a
value on another Automation Server.
• A field device value and an Automation Server, for example, an value from a
sensor and an alarm on an Automation Server.
Server values can provide value configurations that are not available in a program,
such as forcing a value in a function block program. In the server value, you can set
how often the value should be forced.
15.14.1 Minimizing the Transfer Interval Intensity
Server values help to control network traffic. By default, a subscription to a value
from one Automation Server to another or from a field device value to an
Automation Server occurs at the intensity defined by the consumer object. For
example, a program with a cycle time of 1000 ms subscribes every 1000 ms. To
control the intensity, you set a different transfer value interval in the binding
properties of the server value.
You can take a number of steps to minimize the transfer interval intensity and
thereby the network traffic:
• Avoid using alarms and change of value trend logs to monitor values outside of
the Automation Server where the alarm or trend log resides.
• Set the transfer interval for an Automation Server to Automation Server value to
the longest possible time. If possible, avoid intervals of 10 seconds or less.
• Create a server value object so that you can change the transfer interval
manually for a consuming object like a program.
If short update intervals are required, you need to monitor the CPU and memory
usage of the Automation Server where the value resides. If the CPU and memory
usage are high, limit the number of receivers of the value transfer. If you need to
transfer the value to many receivers, consider a cascading structure where the
Automation Server transfers the value to a few receivers and the few receivers, in
turn, transfer the value to a few receivers.
15.14.2 Server Value Workflow
Using a server value is a four-part process:
• Create a server value object on the Automation Server where the program
resides. For more information, see section 15.15 “Creating a Server Value” on
page 440.
• Bind the server value object to read the value from the other Automation
Server. For more information, see section 15.3 “Binding Values Manually” on
page 416.
Technical 04-16006-04-en, March 2015
440
15 Bindings
15.14 Server Values
• Configure the transfer interval. For more information, see section 15.8
“Configuring the Value Transfer Interval” on page 428.
• Bind the server value object to the program input. For more information, see
section 15.3 “Binding Values Manually” on page 416.
04-16006-04-en, March 2015 Technical
441
15 Bindings
15.15 Creating a Server Value
15.15 Creating a Server Value
You create server value when you want a value that is not part of a device. For more
information, see section 15.14 “Server Values” on page 438.
To create a server value
1. In WorkStation, on the File menu, point to New, and then click Value.
2. In the object type list, select value you want to create.
3. In the Name box, type a name for the value.
4. In the Description box, type a description for the value.
5. Click Create.
Technical 04-16006-04-en, March 2015
442
15 Bindings
15.16 Creating a Server Analog Value
15.16 Creating a Server Analog Value
You create analog values in the Automation Server or Enterprise Server for the
following reasons:
• A variable needs to be bound to multiple programs.
• A calibrated analog input variable needs to be forced.
For more information, see section 15.1 “Bindings Overview” on page 411.
To create a server analog value
1. In WorkStation, in the System Tree pane, select the server or folder where
you want to add an analog value.
2. On the File menu, point to New and then click Value.
3. In the object type list, select Analog Value.
4. In the Name box, type a name for the analog value.
5. In the Description box, type a description for the analog value.
6. Click Create.
04-16006-04-en, March 2015 Technical
443
15 Bindings
15.17 Configuring the Value and the Unit for a Server Analog Value
15.17 Configuring the Value and the Unit for a
Server Analog Value
You configure the value and the unit for a server analog value to ensure that the
server analog value holds the value and the unit as required by the project.
For more information, see section 15.1 “Bindings Overview” on page 411.
To configure the value and the unit for a server analog value
1. In WorkStation, in the System Tree pane, select the server analog value you
want to configure.
2. On the File menu, click Properties.
3. Under Status Information, click the Configure button .
Continued on next page
Technical 04-16006-04-en, March 2015
444
15 Bindings
15.17 Configuring the Value and the Unit for a Server Analog Value
4. Select the Configured box that is in front of the Unit box.
5. In the Unit box, enter the unit.
6. Click OK.
Continued on next page
04-16006-04-en, March 2015 Technical
445
15 Bindings
15.17 Configuring the Value and the Unit for a Server Analog Value
7. In the Value box, enter the value.
8. Click OK.
Technical 04-16006-04-en, March 2015
446
15 Bindings
15.18 Creating a Server Digital Value
15.18 Creating a Server Digital Value
You create digital values in the Automation Server or Enterprise Server for the
following reasons:
• A variable needs to be bound to multiple programs.
• A digital schedule or an alarm needs to send information to a program.
For more information, see section 15.1 “Bindings Overview” on page 411.
To create a server digital value
1. In WorkStation, in the System Tree pane, select the server or folder where
you want to add a digital value.
2. On the File menu, point to New and then click Value.
3. In the object type list, select Digital Value.
4. In the Name box, type a name for the digital value.
5. In the Description box, type a description for the digital value.
6. Click Create.
04-16006-04-en, March 2015 Technical
447
16 Binding Templates
Topics
Binding Templates
Binding Template Types
Type Binding Templates
Type Binding Template Examples
Fan Coil - Bind to Zone Controller
Fan Coil - Bind to Occupancy Sensor
Fan Coil - Bind to Temperature Sensor
Path Matching Binding Templates and Syntax
Path Matching
Path Syntax
Path Matching Binding Template Examples
Path Matching Binding Template Example 1
Path Matching Binding Template Example 2
Path Matching Binding Template Example 3
Path Matching Binding Template Example 4
Path Matching Binding Template Example 5
Binding Values Using a Binding Template
Binding Values in Script Editor Using a Binding Template
Creating a Type Binding Template from Instance
Creating a Type Binding Template
Creating a Path Matching Binding Template
16 Binding Templates
16.1 Binding Templates
16.1 Binding Templates
You can bind values automatically by using binding templates, that is, predefined
templates.
Figure: Binding a value by using a binding template
16.1.1 Purpose of Binding Templates
The purpose of binding templates is to automate repetetive tasks. Biding templates
are typically used for objects and binding patterns that are frequently reused. To
use a binding template for a binding task, you need to have a binding template
prepared for that particular task.
16.1.2 Binding Template Location
Binding templates are listed in the Binding Templates folder of the server you are
logged on to. The Binding Templates folder is a system folder under each server.
When you are logged on to an Enterprise Server, only binding templates located on
the Enterprise Server are accessible. The binding templates located on the
Enterprise Server can be used to bind objects on the Automation Servers that are
connected to the Enterprise Server.
When you are logged on to an Automation Server, only binding templates located
on the Automation Server are accessible.
04-16006-04-en, March 2015 Technical
451
16 Binding Templates
16.1 Binding Templates
16.1.3 How to Use Binding Templates
Binding values between objects using a template works similarly to binding
manually. Instead of dragging individual values to properties in the Binding list, you
drag objects to one of the templates in the Binding templates list. The binding
template automatically pairs up all relevant matches and suggests a list of bindings
for you to confirm.
For example, in the System Tree pane, you select the object to which you want to
bind values, such as a control program. In the binding browser, you browse to the
source object, such as a central heater. You drag the heater object to the template
that you want to apply, presumably a predefined binding template that you saved
the last time you carried out the same task. If you confirm the proposed bindings, all
destination property fields in the control program are populated with the binding
paths that you confirmed.
16.1.4 Binding Template Types
Building Operation comes with a general purpose, ready-to-use, binding template
that is called the Name matching template. The Name matching binding template is
accessible in the Binding template list in the Bindings view. The Name matching
binding template binds values between objects that have identical property names.
Building Operation also provides the means for you to define your own binding
templates.
For more information, see section 16.2 “Binding Template Types” on page 451.
Technical 04-16006-04-en, March 2015
452
16 Binding Templates
16.2 Binding Template Types
16.2 Binding Template Types
Building Operation comes with a general purpose, ready-to-use, binding template
that is called the Name matching template. The Name matching binding template is
accessible in the Binding template list in the Bindings view. The Name matching
binding template binds values between objects that have identical property names.
Building Operation also provides the means for you to define your own binding
templates.
There are two binding templates typs that you can define:
• Type Binding Templates
• Path Matching Binding Templates
16.2.1 Type Binding Templates
You define and create a Type binding template to automate a binding task between
two LonWorks devices. When you define a Type binding template, you associate
specific properties in a LonWorks device with specific properties in another
LonWorks device.
For more information, see section 16.3 “Type Binding Templates” on page 452.
16.2.2 Type Binding Template Examples
You define and create a Type binding template to automate a binding task between
two LonWorks devices. When you define a Type binding template, you associate
specific properties in a LonWorks device with specific properties in another
LonWorks device.
For more information, see section 16.4 “Type Binding Template Examples” on page
453.
16.2.3 Path Matching Binding Templates and Syntax
You define and create a Path matching template, to automate a binding task for an
object type, which binds values from one or several objects based on path
matching rules.
For more information, see section 16.8 “Path Matching Binding Templates and
Syntax” on page 469.
16.2.4 Path Matching Binding Template Examples
This is an example system with five path matching binding templates. If new rooms
with LonWorks devices (Xenta controllers) are added to the system, or new air
handling units are added to the system, the binding templates are used to
autogenerate the bindings that are involved in the system expansion.
For more information, see section 16.11 “Path Matching Binding Template
Examples” on page 473.
04-16006-04-en, March 2015 Technical
453
16 Binding Templates
16.3 Type Binding Templates
16.3 Type Binding Templates
You define and create a Type binding template to automate a binding task between
two LonWorks devices. When you define a Type binding template, you associate
specific properties in a LonWorks device with specific properties in another
LonWorks device.
Where as the predefined Name matching binding template binds values that have
identical property names, you can define Type binding templates to associate any
properties between two LonWorks devices, as long as the destination and source
values are compatible.
Figure: Type binding template workflow
You can also create a Type binding template from instance, making the existing
bindings between two LonWorks devices reusable.
Technical 04-16006-04-en, March 2015
454
16 Binding Templates
16.4 Type Binding Template Examples
16.4 Type Binding Template Examples
This is an example system with three binding templates, in this case Type binding
templates. If a new room with LonWorks devices (Fan Coil and Temperature
Sensor) is added to the system, the binding templates are used to autogenerate the
bindings that are involved in the system expansion.
The example system is depicted in the illustration below:
Figure: Example system
The example system has four LonWorks devices. There is a main Zone Controller
and a main Occupancy Sensor. There is also a Fan Coil and a Temperatur Sensor in
a room (1). The devices communicate through the LonWorks bus.
The example system is set up in Building Operation as depicted in the
screenshot/illustration below:
04-16006-04-en, March 2015 Technical
455
16 Binding Templates
16.4 Type Binding Template Examples
Figure: Example System Tree pane
The screenshot/illustration above shows how the example System Tree pane
relates to the example system model. The screenshot/illustration below shows how
the example System Tree pane is expanded with another room (2):
Technical 04-16006-04-en, March 2015
456
16 Binding Templates
16.4 Type Binding Template Examples
Figure: Example System Tree expansion
The example system has three type binding templates that you can use to
autogenerate bindings if you add more rooms.
Figure: Example binding list
All binding templates are based on the Fan Coil because when you add a new
room, the new Fan Coil in that room is either the destination or the source for all the
new bindings that can be created.
04-16006-04-en, March 2015 Technical
457
16 Binding Templates
16.4 Type Binding Template Examples
16.4.1 Fan Coil – Bind to Zone Controller
In this example a new room (2) is added. You use the template described in this
example to autogenerate one of the two bindings between the new room 2 Fan Coil
and the main Zone Controller. The other binding must be created manually.
For more information, see section 16.5 “Fan Coil - Bind to Zone Controller” on page
457.
16.4.2 Fan Coil – Bind to Occupancy Sensor
In this example a new room (2) has been added and the bindings between the new
Fan Coil and the Zone Controller have already been created. You use the template
described in this example to autogenerate the binding between the new room 2 Fan
Coil and the main Occupancy Sensor.
For more information, see section 16.6 “Fan Coil - Bind to Occupancy Sensor” on
page 461.
16.4.3 Fan Coil – Bind to Temperature Sensor
In this example a new room (2) has been added and the bindings between the new
Fan Coil, the Zone Controller, and the Occupancy Sensor have already been
created. You use the template described in this example to autogenerate the
bindings between the new room 2 Fan Coil and the new room 2 Temperature
Sensor.
For more information, see section 16.7 “Fan Coil - Bind to Temperature Sensor ” on
page 465.
Technical 04-16006-04-en, March 2015
458
16 Binding Templates
16.5 Fan Coil - Bind to Zone Controller
16.5 Fan Coil - Bind to Zone Controller
In this example a new room (2) is added. You use the template described in this
example to autogenerate one of the two bindings between the new room 2 Fan Coil
and the main Zone Controller. The other binding must be created manually.
The example system on which this binding template example is based on, is
described in an introductory section. For more information, see section 16.4 “Type
Binding Template Examples” on page 453.
The illustration below shows the expansion of the example system:
Figure: System expansion
The new room 2 Fan Coil can have the same bindings to the Zone Controller as the
room 1 Fan Coil.
The properties and values that can be bound between the Fan Coil and the Zone
Controller are shown in the screenshot/illustration below:
04-16006-04-en, March 2015 Technical
459
16 Binding Templates
16.5 Fan Coil - Bind to Zone Controller
Figure: The values that can be bound
The new Fan Coil nvoTerminalLoad property that can be bound to the Zone
Controller nviTerminalLoad2 SNVT value, must be bound manually because each
new Fan Coil will bind to a new unique (the next available) SNVT in the list. Fan Coil
3 will bind to nviTerminalLoad3, Fan Coil 4 will bind to nviTerminalLoad4, and so on.
This binding cannot be defined in the template.
However, the other binding can be defined in a template because it binds the same
Zone Controller value to the same property in every new room Fan Coil that is
added. To define a type binding template that takes care of this binding, you create
one based on the Fan Coil LonWorks device type (120FC), and associate it with the
Zone Controller LonWorks device type (ZoneController), and associate the values
that can be bound:
Technical 04-16006-04-en, March 2015
460
16 Binding Templates
16.5 Fan Coil - Bind to Zone Controller
Figure: Associating type properties
The screenshot below shows how you apply this template. You select the new Fan
Coil in the System Tree pan, open the Binding view, and drag the Zone Controller to
the binding template:
Figure: Dragging the Zone Controller to the binding template
The template will match the property of the Fan Coil with the value in the Zone
Controller and display a binding confirmation dialog box:
04-16006-04-en, March 2015 Technical
461
16 Binding Templates
16.5 Fan Coil - Bind to Zone Controller
Figure: Found matches
When you confirm the binding suggested in the dialog box, it will appear in the
Binding point list of the Fan Coil. Now you must also create the other binding
manually that was mentioned earlier:
Figure: Dragging the Zone Controller value manually to the Fan Coil property
At this point you can choose to save the bindings and the task will be complete.
Technical 04-16006-04-en, March 2015
462
16 Binding Templates
16.6 Fan Coil - Bind to Occupancy Sensor
16.6 Fan Coil - Bind to Occupancy Sensor
In this example a new room (2) has been added and the bindings between the new
Fan Coil and the Zone Controller have already been created. You use the template
described in this example to autogenerate the binding between the new room 2 Fan
Coil and the main Occupancy Sensor.
The example system on which this binding template example is based on, is
described in an introductionary section. For more information, see section 16.4
“Type Binding Template Examples” on page 453.
The illustration below shows the expansion of the example system:
Figure: System expansion
The new room 2 Fan Coil can have the same bindings to the Occupancy Sensor as
the room 1 Fan Coil.
The properties and values that can be bound between the Fan Coil and the
Occupancy Sensor are shown in the screenshot/illustration below:
04-16006-04-en, March 2015 Technical
463
16 Binding Templates
16.6 Fan Coil - Bind to Occupancy Sensor
Figure: The values that can be bound
To define a type binding template that takes care of this binding, you create one
based on the Fan Coil LonWorks device type (120FC), and associate it with the
Occupancy Sensor LonWorks device type (occupSensor), and associate the values
that can be bound:
Technical 04-16006-04-en, March 2015
464
16 Binding Templates
16.6 Fan Coil - Bind to Occupancy Sensor
Figure: Associating type properties
The screenshot below shows how you apply this template. You select the new Fan
Coil in the System Tree pane, open the Binding view, and drag the Occupancy
Sensor to the binding template:
Figure: Dragging the Occupancy Sensor to the binding template
The template will match the property of the Fan Coil with the value in the
Occupancy Sensor and display a binding confirmation dialog box:
04-16006-04-en, March 2015 Technical
465
16 Binding Templates
16.6 Fan Coil - Bind to Occupancy Sensor
Figure: Found matches
When you confirm the binding suggested in the dialog box, it will appear in the
Bindning list of the Fan Coil. At this point you can choose to save the bindings and
the task will be complete.
Technical 04-16006-04-en, March 2015
466
16 Binding Templates
16.7 Fan Coil - Bind to Temperature Sensor
16.7 Fan Coil - Bind to Temperature Sensor
In this example a new room (2) has been added and the bindings between the new
Fan Coil, the Zone Controller, and the Occupancy Sensor have already been
created. You use the template described in this example to autogenerate the
bindings between the new room 2 Fan Coil and the new room 2 Temperature
Sensor.
The example system on which this binding template example is based on, is
described in an introductionary section. For more information, see section 16.4
“Type Binding Template Examples” on page 453.
The illustration below shows the expansion of the example system:
Figure: System expansion
The new room 2 Fan Coil can have the same bindings to the new room 2
Temperature Sensor as the room 1 Fan Coil has to its room 1 Temperature Sensor.
The properties and values that can be bound between the Fan Coil and the
Temperature Sensor are shown in the screenshot/illustration below:
04-16006-04-en, March 2015 Technical
467
16 Binding Templates
16.7 Fan Coil - Bind to Temperature Sensor
Figure: The values that can be bound
To define a Type binding template that takes care of these bindings, you create one
based on the Fan Coil LonWorks device type (120FC), and associate it with the
Temperature Sensor LonWorks device type (STR350), and associate the values
that can be bound:
Technical 04-16006-04-en, March 2015
468
16 Binding Templates
16.7 Fan Coil - Bind to Temperature Sensor
Figure: Associating type properties
The screenshot below shows how you apply this template. You select the new Fan
Coil in the System Tree pane, open the Binding view, and drag the Temperature
Sensor to the binding template:
04-16006-04-en, March 2015 Technical
469
16 Binding Templates
16.7 Fan Coil - Bind to Temperature Sensor
Figure: Dragging the Temperature Sensor to the binding template
The template will match the properties of the Fan Coil with the values in the
Temperature Sensor and display a binding confirmation dialog box:
Figure: Found matches
When you confirm the bindings suggested in the dialog box, they will appear in the
Binding point list of the Fan Coil. At this point you can choose to save the bindings
and the task will be complete.
Technical 04-16006-04-en, March 2015
470
16 Binding Templates
16.8 Path Matching Binding Templates and Syntax
16.8 Path Matching Binding Templates and
Syntax
You define and create a Path matching template, to automate a binding task for an
object type, which binds values from one or several objects based on path
matching rules.
You can define Path matching binding templates for just about any type and for
general use, whereas Type binding templates are defined to associate specific
properties between LonWorks devices.
16.8.1 Path Matching
A Path matching binding template examines and binds values according to a list of
path matching rules. The list can have one or more path matching rules.
For more information, see section 16.9 “Path Matching” on page 470.
16.8.2 Path Syntax
Normally a path is comprised of text elements and path separators:
/ServerName/ObjectName/PropertyName
In the path matching list, you can also use identifier elements and wildcards.
Identifiers and wildcards however, cannot be directly adjacent, but must be
separated by text elements or path separators:
/{ServerName}/*/Temp*
For more information, see section 16.10 “Path Syntax” on page 471.
04-16006-04-en, March 2015 Technical
471
16 Binding Templates
16.9 Path Matching
16.9 Path Matching
A Path matching binding template examines and binds values according to a list of
path matching rules. The list can have one or more path matching rules.
Figure: List of path matching rules
When you create a Path matching binding template, you base it on an object type,
for example a Function block program. You probably create the template for a
specific Function block program, setting up rules for binding values to other specific
objects, but not necessarily. You can also define a template for a more general use.
When you use the template, the Selected object is, for example, a Function block
program that you have selected in the System Tree pane. The Candidate object is
any object or folder that you drag to this template and that has values that can bind
to the Selected object.
Each rule specifies a property or the path to a property in the Selected object. Each
rule also specifies a value or the path of a value in the Binding candidate. If a value is
found in the Binding candidate, as specified, it is bound to the property that is
specified for the Selected object.
The template examines each rule until the end of the list. If the Candidate object is
actually an entire folder with many objects, all values of each object are tried one
after the other. Theoretically, you can drag the entire system to the template but it
will take a long time to process.
One rule can bind many values. However, the order in which rules are stated can
affect which values are bound. A property in the Selected object that has been
bound once is not bound again.
Technical 04-16006-04-en, March 2015
472
16 Binding Templates
16.10 Path Syntax
16.10 Path Syntax
Normally a path is comprised of text elements and path separators:
/ServerName/ObjectName/PropertyName
In the path matching list, you can also use identifier elements and wildcards.
Identifiers and wildcards however, cannot be directly adjacent, but must be
separated by text elements or path separators:
/{ServerName}/*/Temp*
Table: Syntax Description
Syntax in Paths Description
PlainText Text element
You use plain text to specify values,
properties, objects, folders, devices, and
servers in the paths.
{MyID} Identifier element
You use identifiers, enclosed in curly
brackets, to state where elements must be
equal in both the paths of a rule.
/ Path separator
You use path separators to further specify a
path. The more you specify a path, the more
conditions you impose on possible
candidates, and the more you narrow down
the search.
* Wildcard
You use wildcards to substitute any
character or any sequence of characters.
However, a wildcard does not substitute
path separators.
Sometimes, the path is only the property name:
PropertyName
In this case, the template looks for a property called PropertyName in the
Selected/Candidate object.
Sometimes the path is only the property name and the name of its value:
PropertyName.Value
Somtimes there is a path separator involved that further specifies the
property/value:
ObjectName/PropertyName
In this case, the template looks for a property called PropertyName that has a
parent object called ObjectName.
04-16006-04-en, March 2015 Technical
473
16 Binding Templates
16.10 Path Syntax
If you impose many conditions, that is specifying a long path, you will be narrowing
down the search. You can also widen the search with wildcards, but then again
impose conditions on both paths in the rule by using identifiers. Identifiers state
which elements must be identical in the two paths of a rule.
Technical 04-16006-04-en, March 2015
474
16 Binding Templates
16.11 Path Matching Binding Template Examples
16.11 Path Matching Binding Template
Examples
This is an example system with five path matching binding templates. If new rooms
with LonWorks devices (Xenta controllers) are added to the system, or new air
handling units are added to the system, the binding templates are used to
autogenerate the bindings that are involved in the system expansion.
The example system has one air handling unit. The Automation Server has one
application folder with required logic and I/O to control and monitor these air
handling units. The application folder also holds a Graphic (UI) that an operator can
use to supervise and manage the air controller unit.
Figure: Example system
The example system also has three Lonwork devices (Xenta controllers), in three
rooms, on one floor. The Automation Server has one Graphic (UI) for each room,
and one Graphic (UI) for the entire floor so that an operator can supervise the
rooms. The Automation Server is connected to the Xenta controllers through a
LonWorks bus.
04-16006-04-en, March 2015 Technical
475
16 Binding Templates
16.11 Path Matching Binding Template Examples
Figure: Example System Tree pane
The example system has five path matching binding templates that you can use to
autogenerate bindings when you expand the system.
Technical 04-16006-04-en, March 2015
476
16 Binding Templates
16.11 Path Matching Binding Template Examples
Figure: Example Binding list
16.11.1 Path Matching Binding Template Example 1
In this example, a new room with a LonWorks device (Xenta controller) has been
added. When you add a Xenta controller, a new room Graphic (UI) is added as well
so that the operator can supervise the room.
For more information, see section 16.12 “Path Matching Binding Template Example
1” on page 477.
16.11.2 Path Matching Binding Template Example 2
In this example, a floor Graphic (UI) has been created. The floor Graphic (UI) collects
information from the LonWorks devices (Xenta controllers) in all rooms and serves
as an overview for the operator that supervises the rooms on that floor.
For more information, see section 16.13 “Path Matching Binding Template Example
2” on page 482.
16.11.3 Path Matching Binding Template Example 3
In this example, a new Air Handling Unit (AHU) has been added. When you add an
air handling unit, a new Application folder is created in the Automation Server. The
Application folder holds the Program, Alarms, Logs, and Schedules (MODE)
configuration that is needed to control and monitor the air handling unit. The
Application folder also holds a Graphic (UI) so that the operator can supervise the
air handling unit.
For more information, see section 16.14 “Path Matching Binding Template Example
3” on page 488.
16.11.4 Path Matching Binding Template Example 4
In this example, a new Air Handling Unit (AHU) has been added. When you add an
air handling unit, a new Application folder is created in the Automation Server. The
Application folder holds the Program, Alarms, Logs, and Schedules (MODE)
configuration that is needed to control and monitor the air handling unit. The
Application folder also holds a Graphic (UI) so that the operator can supervise the
air handling unit.
For more information, see section 16.15 “Path Matching Binding Template Example
4” on page 493.
04-16006-04-en, March 2015 Technical
477
16 Binding Templates
16.11 Path Matching Binding Template Examples
16.11.5 Path Matching Binding Template Example 5
In this example, a new Air Handling Unit (AHU) has been added. When you add an
air handling unit, a new Application folder is created in the Automation Server. The
Application folder holds the Program, Alarms, Logs, and Schedules (MODE)
configuration that is needed to control and monitor the air handling unit. The
Application folder also holds a Graphic (UI) so that the operator can supervise the
air handling unit.
For more information, see section 16.16 “Path Matching Binding Template Example
5” on page 500.
Technical 04-16006-04-en, March 2015
478
16 Binding Templates
16.12 Path Matching Binding Template Example 1
16.12 Path Matching Binding Template
Example 1
In this example, a new room with a LonWorks device (Xenta controller) has been
added. When you add a Xenta controller, a new room Graphic (UI) is added as well
so that the operator can supervise the room.
Figure: System expansion
The example system on which this binding template example is based on, is
described in an introductionary section. For more information, see section 16.11
“Path Matching Binding Template Examples” on page 473.
You use the template described in this example to autogenerate all the bindings
between the room Graphic (UI) and the Xenta controller.
The room Graphic (UI) will have the same bindings to the Xenta controller as the
other room Graphics (UI) have to their Xenta controllers. When you define a path
matching binding template and reuse bindings, the naming of folders, objects, and
properties must be consistent.
When you create the room Graphic (UI), the properties that can bind to values in the
Xenta device must incorporate the name of the SNVT, the member, and the value
that they bind to.
04-16006-04-en, March 2015 Technical
479
16 Binding Templates
16.12 Path Matching Binding Template Example 1
For example, naming a property in the room Graphic (UI)
nciSetpoints.Occupied cooling setpoint.Value makes it possible to
define a path matching rule that will bind it to the "Value" of the "Occupied cooling
setpoint" member, of the "nciSetpoints" SNVT in a Xenta device.
Properties and values are bound between the room Graphic (UI) and the Xenta
controller:
Figure: The values that can be bound.
To define a path matching binding template that binds these properties and values,
you create a template based on the Graphic type and define the path matching
rules:
Technical 04-16006-04-en, March 2015
480
16 Binding Templates
16.12 Path Matching Binding Template Example 1
Figure: Path matching rules
There are two rules in this template. Each rule has a property specified for the
Selected object, in this case the room Graphic (UI). The Binding candidate, for
example, the room Xenta controller or the entire LonWorks bus, also has a
value/path specified. When you drag the Xenta controller to this template, the
template searches for any value in that collection that corresponds to the Binding
candidate value/path that is specified in this rule. If a match is found, the property of
the room Graphic (UI) is bound with the matching value in the Xenta controller. Each
rule is examined in sequence. For more information, see section 16.8 “Path
Matching Binding Templates and Syntax” on page 469.
In WorkStation, you can drag the Xenta controller, the entire LonWorks bus, or the
entire system to the template. The bigger the collection you drag to the template,
the longer it takes for the template to search for matching values.
04-16006-04-en, March 2015 Technical
481
16 Binding Templates
16.12 Path Matching Binding Template Example 1
Figure: Dragging the Xenta controller to the Graphic binding template
The template matches the properties of the Graphic (UI) with the values in the Xenta
controller and displays a binding confirmation dialog box:
Figure: Found matches
When you click OK, the bindings are displayed in the Binding list of the Graphic (UI).
Technical 04-16006-04-en, March 2015
482
16 Binding Templates
16.12 Path Matching Binding Template Example 1
Figure: Graphic (UI) Binding list
Instead of searching and manually binding 11 values, you have reduced the
procedure into a one-step-task with less chance of making mistakes. It takes some
effort to define a template but it is well worth the effort for configurations that you
frequently reuse.
04-16006-04-en, March 2015 Technical
483
16 Binding Templates
16.13 Path Matching Binding Template Example 2
16.13 Path Matching Binding Template
Example 2
In this example, a floor Graphic (UI) has been created. The floor Graphic (UI) collects
information from the LonWorks devices (Xenta controllers) in all rooms and serves
as an overview for the operator that supervises the rooms on that floor.
Figure: System expansion
The example system on which this binding template example is based on, is
described in an introductionary section. For more information, see section 16.11
“Path Matching Binding Template Examples” on page 473.
You use the template described in this example to autogenerate all the bindings
between the floor Graphic (UI) and the Xenta controllers on that floor.
Technical 04-16006-04-en, March 2015
484
16 Binding Templates
16.13 Path Matching Binding Template Example 2
The floor 1 Graphic (UI) binds to all Xenta controllers on floor 1. The floor Graphic
(UI) can also be reused if more floors with identical room configurations are added.
The binding template in this example autogenerates the bindings between the floor
Graphic (UI) and the Xenta controllers and can also be reused if more floors with
identical room configurations are added. When you define a path matching binding
template and reuse bindings, the naming of folders, objects, and properties must
be consistent.
When you create the floor Graphic (UI), the properties that bind to values in the
Xenta devices must incorporate the name of the device, the SNVT, the member,
and the value that they can bind to.
For example, naming a property in the floor Graphic (UI)
Room0101.nvoOccSensor.Value makes it possible to define a path matching
rule that binds it to the "Value" of the "nvoOccSensor" SNVT in the "Room0101"
Xenta device.
Properties and values are bound between the floor Graphic (UI) and the Xenta
controllers:
04-16006-04-en, March 2015 Technical
485
16 Binding Templates
16.13 Path Matching Binding Template Example 2
Figure: The values that can be bound
To define a Path matching binding template that binds these properties and values,
you create a template based on the Graphic type and define the Path matching
rule:
Technical 04-16006-04-en, March 2015
486
16 Binding Templates
16.13 Path Matching Binding Template Example 2
Figure: Path matching rule
There is one rule in this template. The rule has a property specified for the Selected
object, in this case the floor Graphic (UI). The Binding candidate, for example the
Floor01 folder on the LonWorks bus or the entire LonWorks bus, also has a
value/path specified. When you drag the Floor01 folder to this template, the
template searches for any value in that collection that corresponds to the Binding
candidate value/path that is specified in this rule. If a match is found, the property of
the floor Graphic (UI) is bound with the matching value in the Xenta controller. For
more information, see section 16.8 “Path Matching Binding Templates and Syntax”
on page 469.
In WorkStation, you can drag the Floor01 folder, the entire LonWorks bus, or the
entire system to the template. The bigger the collection you drag to the template,
the longer it takes for the template to search for matching values.
04-16006-04-en, March 2015 Technical
487
16 Binding Templates
16.13 Path Matching Binding Template Example 2
Figure: Dragging the Floor01 folder to the Bind to Multiple Xentas binding template
The template matches the properties of the floor Graphic (UI) with the values in the
Xenta controllers and displays a binding confirmation dialog box:
Figure: Found matches
When you click OK, bindings are displayed in the Binding list of the floor Graphic
(UI).
Technical 04-16006-04-en, March 2015
488
16 Binding Templates
16.13 Path Matching Binding Template Example 2
Figure: Floor Graphic (UI) Binding list
Instead of searching and manually binding 12 values, you have reduced the
procedure into a one-step-task with less chance of making mistakes. It takes some
effort to define a template but it is well worth the effort for configurations that you
frequently reuse.
04-16006-04-en, March 2015 Technical
489
16 Binding Templates
16.14 Path Matching Binding Template Example 3
16.14 Path Matching Binding Template
Example 3
In this example, a new Air Handling Unit (AHU) has been added. When you add an
air handling unit, a new Application folder is created in the Automation Server. The
Application folder holds the Program, Alarms, Logs, and Schedules (MODE)
configuration that is needed to control and monitor the air handling unit. The
Application folder also holds a Graphic (UI) so that the operator can supervise the
air handling unit.
Figure: System expansion
The example system on which this binding template example is based on, is
described in an introductory section. For more information, see section 16.11 “Path
Matching Binding Template Examples” on page 473.
You use the template described in this example to autogenerate all the bindings
between the Application folder Program and the Air Handling Unit I/O.
Technical 04-16006-04-en, March 2015
490
16 Binding Templates
16.14 Path Matching Binding Template Example 3
The new AHU 2 Application folder Program will have the same bindings to its Air
Handling Unit I/O as the AHU 1 Program has to its Air Handling Unit I/O. The
Program, the IO, and the naming of folders, objects and properties, is identical in
the two Application folders. Therefore, we can use the same binding template that
was defined for AHU 1, to bind the AHU 2 Program to its air handling unit.
The application folder, in which the application Program resides, must incorporate
the name of the air handling unit that it will control. Also, the air handling unit I/O
binding points must incorporate both the name of its air handling unit and the name
of the program properties that they bind to.
For example, naming an I/O binding point of the AHU02 air handling unit 06-
AHU02-DAT makes it possible to define a Path matching rule that binds it to the
"DAT" property in the application Program of the "AHU02" application folder.
Properties and values are bound between the application Program and its Air
Handling Unit I/O:
Figure: The values that can be bound
To define a Path matching binding template that binds these properties and values,
you create a template based on the Function block program type and define the
Path matching rules:
04-16006-04-en, March 2015 Technical
491
16 Binding Templates
16.14 Path Matching Binding Template Example 3
Figure: Path matching rules
There are three rules in this template. Each rule has a property specified for the
Selected object, in this case the application Program. The Binding candidate, in this
case the I/O bus, also has a value/path specified. When you drag the I/O bus to this
template, the template searches for any value in that collection that corresponds to
the Binding candidate value/path that is specified in this rule. If a match is found, the
property of the Program is bound with the matching value in the I/O bus. Each rule
is examined in sequence. For more information, see section 16.8 “Path Matching
Binding Templates and Syntax” on page 469.
In WorkStation, you drag the I/O bus to the Bind to I/O Binding template.
Technical 04-16006-04-en, March 2015
492
16 Binding Templates
16.14 Path Matching Binding Template Example 3
Figure: Dragging the I/O bus to the Bind to I/O Binding template
The template matches the properties of the AHU 2 application Program with the
values in the I/O bus and displays a binding confirmation dialog box:
Figure: Matching values
When you click OK, the bindings are displayed in the Binding point list of the
application program:
04-16006-04-en, March 2015 Technical
493
16 Binding Templates
16.14 Path Matching Binding Template Example 3
Figure: Application Program Binding list
Instead of searching and manually binding 10 values, you have reduced the
procedure into a one-step-task with less chance of making mistakes. It takes some
effort to define a template but it is well worth the effort for configurations that you
frequently reuse.
Technical 04-16006-04-en, March 2015
494
16 Binding Templates
16.15 Path Matching Binding Template Example 4
16.15 Path Matching Binding Template
Example 4
In this example, a new Air Handling Unit (AHU) has been added. When you add an
air handling unit, a new Application folder is created in the Automation Server. The
Application folder holds the Program, Alarms, Logs, and Schedules (MODE)
configuration that is needed to control and monitor the air handling unit. The
Application folder also holds a Graphic (UI) so that the operator can supervise the
air handling unit.
Figure: System expansion
The example system on which this binding template example is based on, is
described in an introductionary section. For more information, see section 16.11
“Path Matching Binding Template Examples” on page 473.
You use the template described in this example to autogenerate all the bindings
between the Application folder Program and the Alarms, Logs, and Schedules
(MODE) configuration.
04-16006-04-en, March 2015 Technical
495
16 Binding Templates
16.15 Path Matching Binding Template Example 4
The new AHU 2 application Program will have the same bindings to its application
configuration as the application Program in AHU 1 has to its application
configuration. The configuration and the naming of folders, objects and properties,
is identical in the two Application folders. Therefore, we can use the same binding
template that was defined for AHU 1, to bind the AHU 2 application Program to its
application configuration.
When you create the Alarms, Trend logs, and Schedules, the name of the object
that bind to the application Program must incorporate the name of the program
properties that they bind to.
For example, naming an Alarm RF Alarm makes it possible to define a Path
matching rule that binds it to the "RF_A" property in the application Program.
Properties and values are bound between the Program and the application
configuration:
Technical 04-16006-04-en, March 2015
496
16 Binding Templates
16.15 Path Matching Binding Template Example 4
Figure: The values that can be bound
As can be seen in this instance, the binding direction of most bindings is from the
Program to the application configuration. The direction of a binding is not
necessarily from the binding candidate to the selected object. The direction can be
defined either way.
To define a Path matching binding template based on this example, you create a
template based on the Function block program type and define the Path matching
rules:
04-16006-04-en, March 2015 Technical
497
16 Binding Templates
16.15 Path Matching Binding Template Example 4
Figure: Path matching rules
There are six rules in this template. Each rule has a property specified for the
Selected object, in this case the application Program. The Binding candidate, for
example the application AHU02 folder or the parent Application folder, also has a
value/path specified. When you drag the AHU02 folder to this template, the
template searches for any value in that collection that corresponds to the Binding
candidate value/path that is specified in this rule. If a match is found, the property of
the Program is bound with the matching value in the AHU02 folder. Each rule is
examined in sequence. For more information, see section 16.8 “Path Matching
Binding Templates and Syntax” on page 469.
In WorkStation, you can drag the application AHU02 folder, the parent Application
folder, or the entire system to the template. The bigger the collection you drag to
the template, the longer it takes for the template to search for matching values.
Technical 04-16006-04-en, March 2015
498
16 Binding Templates
16.15 Path Matching Binding Template Example 4
Figure: Dragging the AHU02 folder to the Bind to Unit binding template
The template matches the properties of the application Program with the values in
the application AHU02 folder and displays a binding confirmation dialog box:
04-16006-04-en, March 2015 Technical
499
16 Binding Templates
16.15 Path Matching Binding Template Example 4
Figure: Matching values
When you click OK, the bindings are displayed in the Binding list of the application
Program:
Technical 04-16006-04-en, March 2015
500
16 Binding Templates
16.15 Path Matching Binding Template Example 4
Figure: Application Program Binding list
Instead of searching and manually binding 11 values, you have reduced the
procedure into a one-step-task with less chance of making mistakes. It takes some
effort to define a template but it is well worth the effort for configurations that you
frequently reuse.
04-16006-04-en, March 2015 Technical
501
16 Binding Templates
16.16 Path Matching Binding Template Example 5
16.16 Path Matching Binding Template
Example 5
In this example, a new Air Handling Unit (AHU) has been added. When you add an
air handling unit, a new Application folder is created in the Automation Server. The
Application folder holds the Program, Alarms, Logs, and Schedules (MODE)
configuration that is needed to control and monitor the air handling unit. The
Application folder also holds a Graphic (UI) so that the operator can supervise the
air handling unit.
Figure: System expansion
The illustration below shows the new Application folder, the red marked and
underlined application Graphic (UI) and the red marked application configuration
that have values that can be bound to the application Graphic (UI).
You use the template described in this example to autogenerate all the bindings
between the Application folder Graphic (UI) and the Program, Alarms, Logs, and
Schedules (MODE) configuration.
Technical 04-16006-04-en, March 2015
502
16 Binding Templates
16.16 Path Matching Binding Template Example 5
The new AHU 2 application Graphic (UI) have the same bindings to its application
configuration as the application Graphic (UI) in AHU 1 has to its application
configuration. The configuration and the naming of folders, objects and properties,
is identical in the two Application folders. Therefore we can use the same binding
template that was defined for AHU 1, to bind the AHU 2 application Graphic (UI) to
its application configuration.
When you create the application Graphic (UI), the properties that bind to values in
the application Program, the Alarms, the Trend logs, and the Schedules, must
incorporate the name of the object or property value that they bind to.
For example, naming a property in the application Graphic (UI) CWV.Value makes
it possible to define a Path matching rule that binds it to the "Value" of the "CWV"
property in the application.
Properties and values are bound between the application Graphic (UI) and its
application configuration:
04-16006-04-en, March 2015 Technical
503
16 Binding Templates
16.16 Path Matching Binding Template Example 5
Figure: The values that can be bound
To define a Path matching binding template that binds these properties and values,
you create a template based on the Graphic type and define the Path matching
rules:
Technical 04-16006-04-en, March 2015
504
16 Binding Templates
16.16 Path Matching Binding Template Example 5
Figure: Path matching rules
There are three rules in this template. Each rule has a property specified for the
Selected object, in this case the application Graphic (UI). The Binding candidate, for
example the AHU02 folder or the entire Application folder, also has a value/path
specified. When you drag the AHU02 folder to this template, the template searches
for any value in that collection that corresponds to the Binding candidate value/path
that is specified in this rule. If a match is found, the property of the application
Graphric (UI) is bound with the matching value in the AHU02 folder. Each rule is
examined in sequence. For more information, see section 16.8 “Path Matching
Binding Templates and Syntax” on page 469.
In WorkStation, you can drag the AHU02 folder, the entire Application folder, or the
entire system to the template. The bigger the collection you drag to the template,
the longer it takes for the template to search for matching values.
04-16006-04-en, March 2015 Technical
505
16 Binding Templates
16.16 Path Matching Binding Template Example 5
Figure: Dragging the AHU02 folder to the Bind to Unit binding template
The template matches the properties of the application Graphic (UI) with the values
in the AHU02 folder and displays a binding confirmation dialog box:
Technical 04-16006-04-en, March 2015
506
16 Binding Templates
16.16 Path Matching Binding Template Example 5
Figure: Found matches
When you click OK, the bindings are displayed in the Binding list of the application
Graphic (UI):
Figure: Application Graphic (UI) Binding list
04-16006-04-en, March 2015 Technical
507
16 Binding Templates
16.16 Path Matching Binding Template Example 5
Instead of searching and manually binding 16 values, you have reduced the
procedure into a one-step-task with less chance of making mistakes. It takes some
effort to define a template but it is well worth the effort for configurations that you
frequently reuse.
Technical 04-16006-04-en, March 2015
508
16 Binding Templates
16.17 Binding Values Using a Binding Template
16.17 Binding Values Using a Binding
Template
You use binding templates to reduce engineering time when creating bindings.
Binding templates are defined and created for binding patterns that are frequently
reused.
Using binding templates, you create bindings between the Automation Server
program variables, internal values, and I/O points using the following recommended
process:
• First, bind the Automation Server IO Bus to each of the Programs in the
Automation Server that requires data flow with the I/O points.
• Next, bind the Internal Variables to each of the Programs in the Automation
Server that requires data flow with Internal Variables.
• Then, bind each of the individual Programs to all other Programs that require
data flow with other Programs.
• Finally, bind any time schedules and alarms that are required as part of the
programmed control logic.
Tip
• When creating bindings, follow the recommended general guidelines: create
bindings between Inputs and Outputs only and do not create bindings to
Public Signals.
For more information, see section 16.1 “Binding Templates” on page 449.
To bind values using a binding template
1. In WorkStation, in the System Tree pane, select the object that you want to
bind values to.
2. On the Actions menu, click Edit bindings.
Continued on next page
04-16006-04-en, March 2015 Technical
509
16 Binding Templates
16.17 Binding Values Using a Binding Template
3. In the binding point browser, drag the object or folder to the binding template
that you want to apply.
4. Select the bindings that you want to create.
5. Click OK.
Continued on next page
Technical 04-16006-04-en, March 2015
510
16 Binding Templates
16.17 Binding Values Using a Binding Template
6. Verify that all bindings are correctly bound.
7. On the File menu, click Save.
Tip
• To ensure data flow is occurring as intended, use the Watch pane to view
values and monitor changes.
04-16006-04-en, March 2015 Technical
511
16 Binding Templates
16.18 Binding Values in Script Editor Using a Binding Template
16.18 Binding Values in Script Editor Using a
Binding Template
You use binding templates to reduce engineering time when creating bindings for
variables and functions within a Script program. Binding templates are defined and
created for binding patterns that are frequently reused. You can access the
Bindings view without leaving Script Editor.
For more information, see section 16.1 “Binding Templates” on page 449.
To bind values in Script Editor using a binding template
1. In Script Editor, click Bindings to display the Bindings view for the Script
program.
2. In the binding point browser, drag the object or folder to the binding template
that you want to apply.
Continued on next page
Technical 04-16006-04-en, March 2015
512
16 Binding Templates
16.18 Binding Values in Script Editor Using a Binding Template
3. Select the bindings that you want to create.
4. Click OK.
5. Verify that all bindings are correctly bound.
6. On the toolbar, click Save.
04-16006-04-en, March 2015 Technical
513
16 Binding Templates
16.19 Creating a Type Binding Template from Instance
16.19 Creating a Type Binding Template from
Instance
You create a type binding template from instance, to automate a binding task, by
reusing the existing bindings between two LonWorks devices.
Note
• The type binding template is only applicable between two LonWorks devices.
For more information, see section 16.1 “Binding Templates” on page 449.
To create a Type binding template from instance
1. In WorkStation, in the System Tree pane, right-click the object that holds the
binding pattern that you want to save and reuse, and click Edit bindings.
2. On the toolbar, click the Create a Type binding template from instance
button .
Continued on next page
Technical 04-16006-04-en, March 2015
514
16 Binding Templates
16.19 Creating a Type Binding Template from Instance
3. In the Name box, type a name for the template.
4. In the Description box, type a description for the template.
5. In the Type list, select the type on which you will base this template.
6. Click OK.
04-16006-04-en, March 2015 Technical
515
16 Binding Templates
16.20 Creating a Type Binding Template
16.20 Creating a Type Binding Template
You define and create a Type binding template to automate a binding task between
two LonWorks devices. When you define a Type binding template, you associate
specific properties in a LonWorks device with specific properties in another
LonWorks device.
Note
• The Type binding template is only applicable on LonWorks devices.
For more information, see section 16.3 “Type Binding Templates” on page 452.
To create a Type binding template
1. In WorkStation, in the System Tree pane, in the System folder, select
Binding templates.
2. On the File menu, point to New and then click Binding template.
3. In the object list, select Type Binding Template.
4. In the Name box, type a name for the template.
5. In the Description box, type a description for the template.
6. Click Next.
Continued on next page
Technical 04-16006-04-en, March 2015
516
16 Binding Templates
16.20 Creating a Type Binding Template
7. Select the LonWorks device, on which this template will be based.
8. Click Next.
9. Select the LonWorks devices that hold values, which will be bound to the type
on which this template is based, and then click the Add button .
10. Click Next.
Continued on next page
04-16006-04-en, March 2015 Technical
517
16 Binding Templates
16.20 Creating a Type Binding Template
11. Drag values to the Binds to property boxes.
12. Click Create.
Technical 04-16006-04-en, March 2015
518
16 Binding Templates
16.21 Creating a Path Matching Binding Template
16.21 Creating a Path Matching Binding
Template
You define and create a Path matching template, to automate a binding task for an
object type, which binds values from one or several objects based on path
matching rules.
For more information, see section 16.8 “Path Matching Binding Templates and
Syntax” on page 469.
To create a path matching binding template
1. In WorkStation, in the System Tree pane, in the System folder, select
Binding templates.
2. On the File menu, point to New and then click Binding template.
3. In the object type list, select Path Matching Binding Template.
4. In the Name box, type a name for the template.
5. In the Description box, type a description for the template.
6. Click Next.
Continued on next page
04-16006-04-en, March 2015 Technical
519
16 Binding Templates
16.21 Creating a Path Matching Binding Template
7. Select the type, on which this template will be based.
8. Click Next.
9. In the Selected object box, type the property or the path to the property
that you want to bind.
Note
• Paths can be full or partial. Values, properties, and paths can
also contain identifiers and wildcards.
Continued on next page
Technical 04-16006-04-en, March 2015
520
16 Binding Templates
16.21 Creating a Path Matching Binding Template
10. In the Binding candidate box, type a value or the path to a value that you
want to find and bind.
Note
• If a value is found in the Binding candidate, as specified, it is
bound to the property that is specified for the Selected object.
Paths can be full or partial. Values, properties, and paths can
also contain identifiers and wildcards.
Continued on next page
04-16006-04-en, March 2015 Technical
521
16 Binding Templates
16.21 Creating a Path Matching Binding Template
11. In the Property box, select if the rule is to match values by their Name,
Description, Note 1, or Note 2 property.
12. Click the Add rule button to add more path matching rules.
13. Click Create.
Technical 04-16006-04-en, March 2015
522
17 Bindings User Interface
Topics
Bindings View
Bindings Diagnostics
Binding Point List Toolbar
Binding Templates List
Browser Toolbar
Browser
Bind Dialog Box – Select Direction
Bind Dialog Box – Replace or Keep
Bind Dialog Box – Replace or Add
Value Transfer Settings Dialog Box
Variables View Features
Confirm Bindings Dialog Box
Bindings Status Icons
Binding Templates View
Binding Template Wizard – Choosing the Type and Naming
the Object Page
Binding Template Wizard – What Type Do You Want to Bind
in the Template Page
Binding Template Wizard – What Type(s) Do You Want to
Bind to with the Template Page
Binding Template Wizard – Specify the Bindings in The
Template Page
Binding Template Wizard – Specify the Path Matching
Patterns in the Template Page
Binding Template Properties
Edit Binding Template Dialog Box – Type Binding Template
Edit Binding Template Dialog Box – Path Matching Binding
Template
Time Stamp Value Properties
17 Bindings User Interface
17.1 Bindings View
17.1 Bindings View
Use the Bindings view to bind values between objects in the system.
Figure:
Table: Bindings View
Number Description
Use the toolbar to delete bindings, filter
properties, and create a binding template
from instance. For more information, see
section 17.3 “Binding Point List Toolbar” on
page 526..
Use the Binding templates list to view and
apply Binding templates. For more
information, see section 17.4 “Binding
Templates List” on page 527..
Use the toolbar to lock the Browser and to
filter items in the Browser. For more
information, see section 17.5 “Browser
Toolbar” on page 528.
04-16006-04-en, March 2015 Technical
525
17 Bindings User Interface
17.1 Bindings View
Continued
Number Description
Use the Browser to select and drag a value
to the Binding points list or to the Binding
templates list to create bindings. For more
information, see section 17.6 “Browser” on
page 529.
Use the Binding list to enter the path to the
value that you want to bind. Right-click to
lock or unlock the path. For more
information, see section 15.9 “Locked and
Unlocked Binding Paths” on page 429.
Use the Unit list to view the engineering unit
associated with each property (if any).
Use the Binding point list to view and bind
the values of the object that is selected in the
System Tree pane.
Use the navigation bar to switch the visible
binding point page.
Technical 04-16006-04-en, March 2015
526
17 Bindings User Interface
17.2 Bindings Diagnostics
17.2 Bindings Diagnostics
Use Bindings Diagnostics to check the database for unresolved or invalid
references.
Figure: Bindings Diagnostics
Table: Bindings Diagnostics
Component Description
Location Displays the location of the object.
Name Displays the name of the object.
Property Displays the property of the object.
Status Displays the status of the binding. For more
information, see section 17.13 “Bindings
Status Icons” on page 540.
Reference Displays the path.
04-16006-04-en, March 2015 Technical
527
17 Bindings User Interface
17.3 Binding Point List Toolbar
17.3 Binding Point List Toolbar
Use the toolbar to manage bindings and filter properties in the Binding points list.
Table: Binding Points List Toolbar
Button Description
Delete all bindings
Click to delete all bindings in the Bindings
points list.
Filter Binding list
Click to filter the Binding points list. You
can hide variables that are already bound.
You can also show the parameters.
Create binding template from
instance
Click to create a binding template based on
the object and the bindings that are
displayed in the Binding points list.
Technical 04-16006-04-en, March 2015
528
17 Bindings User Interface
17.4 Binding Templates List
17.4 Binding Templates List
Use the Binding templates list to apply binding templates.
Figure: Binding template list
Table: Binding Templates List
Column Description
Binding templates Displays your binding templates, which you
can define and use to automate binding
tasks. Building Operation has one
predefined binding template, which is the
Default name matching template.
Description Displays descriptive text about the binding
template.
[Drop here to apply] Drag a folder, object, or a value to the box of
the template that you want to apply.
04-16006-04-en, March 2015 Technical
529
17 Bindings User Interface
17.5 Browser Toolbar
17.5 Browser Toolbar
Use the Browser toolbar to navigate the bindable values of objects and properties
in the system.
Table: Browser Toolbar
Button Description
Parent folder
Click to open the parent folder in the
Browser.
Lock/Unlock path
Click to lock the Browser so it stays locked
onto the present folder when you navigate
the System Tree pane.
Lock/Unlock path
Click to unlock the Browser so it displays
what you select in the System Tree pane.
Filter binding browser
Click to filter the properties in the Browser.
You can exclude properties in the Browser
that do not match any of the properties in
the Binding point list, in terms of
engineering unit and data type. You can also
exclude parameters.
Technical 04-16006-04-en, March 2015
530
17 Bindings User Interface
17.6 Browser
17.6 Browser
Use the Browser to find and drag bindable values to the Binding points list, or
entire folders to the Binding templates list.
Figure: Browser
Table: Browser
Component Description
Browser Select and drag values to the Binding
points list to bind them to the properties of
the selected object. You can also drag
objects and entire folders to applicable
templates in the Binding templates list.
04-16006-04-en, March 2015 Technical
531
17 Bindings User Interface
17.7 Bind Dialog Box – Select Direction
17.7 Bind Dialog Box – Select Direction
Use this Bind dialog box to select the direction of the binding, when bound values
represent property categories that can be bound either way. With most property
categories, direction is inherent and evident, such as output to input.
Figure: Select direction
Table: Select Direction
Choice Description
Choice 1 Select to make the Binding list property the
destination property.
Choice 2 Select to make the dragged property value,
or the typed property path, the destination
property.
Technical 04-16006-04-en, March 2015
532
17 Bindings User Interface
17.8 Bind Dialog Box – Replace or Keep
17.8 Bind Dialog Box – Replace or Keep
Use this Bind dialog box to replace or keep the source value of an already bound
destination property.
Figure: Replace or Keep
Table: Replace or Keep
Choice Description
Choice 1 Select to replace the bound source value.
Choice 2 Select to keep the bound source value.
04-16006-04-en, March 2015 Technical
533
17 Bindings User Interface
17.9 Bind Dialog Box – Replace or Add
17.9 Bind Dialog Box – Replace or Add
Use this Bind dialog box to replace the destination of a bound source value, or to
add another bindings with the same source value.
Figure: Replace or add
Table: Replace or Add
Choice Description
Choice 1 Select to replace the destination property of
the already bound source value.
Choice 2 Select to add the destination property as
another binding that share the same source
value.
Technical 04-16006-04-en, March 2015
534
17 Bindings User Interface
17.10 Value Transfer Settings Dialog Box
17.10 Value Transfer Settings Dialog Box
Use the Value transfer settings dialog box to set the transfer interval for values
between objects in the database.
Figure: Value transfer dialog
Table: Value Transfer Dialog
Property Description
Pre-defined interval Click to select a predefined interval. For
more information, see section 15.6 “Value
Transfer Settings ” on page 420.
Manual interval Select if you want to use a manual interval.
For more information, see section 15.6
“Value Transfer Settings ” on page 420.
Transfer value each time, even if the Select if you want to transfer the value even if
value has not changed it has not changed since the last time it was
sent. For more information, see section 15.6
“Value Transfer Settings ” on page 420.
04-16006-04-en, March 2015 Technical
535
17 Bindings User Interface
17.10 Value Transfer Settings Dialog Box
Continued
Property Description
Transfer only if value change exceeds Enter a delta interval. For more information,
'Delta value' see section 15.6 “Value Transfer Settings ”
on page 420.
Transfer interval Select to use a transfer interval. For more
information, see section 15.6 “Value Transfer
Settings ” on page 420.
Turn off this feature Select if you do not want to use transfer
interval. For more information, see section
15.6 “Value Transfer Settings ” on page 420.
Technical 04-16006-04-en, March 2015
536
17 Bindings User Interface
17.11 Variables View Features
17.11 Variables View Features
You use the Variables view to view live values, create trend logs, force values, and
to edit parameters in a structured and manageble way.
The Variables view is available in the work area of WorkStation when one of the
following types are selected in the System Tree pane:
• LonWorks device
• Program
• I/O module
The Variables view reflects the content of and object, which is structured in
categories, properties and live values.
Figure: Variables view with expandable categories
04-16006-04-en, March 2015 Technical
537
17 Bindings User Interface
17.11 Variables View Features
The categories can be expanded or collapsed so that you can set up a manageable
overview of properties and live values.
You can also use the Quick Filter box to filter the Variables list. With LonWorks
devices, your typing in the Quick Filter box filters category such as outputs, inputs,
and public signals.
Figure: Filtering categories in the Quick Filter box
With Programs and I/O modules, you type in the Quick Filter box the filter's property
name.
Technical 04-16006-04-en, March 2015
538
17 Bindings User Interface
17.11 Variables View Features
Figure: Filtering properties in the Quick Filter box
You can also use the toolbar buttons to expand all categories or collapse all
categories. There is also the Property grid that you can show or hide.
If you open the Property grid and multiselect different properties in the Variables list,
their values are displayed together in the Property grid.
Figure: Multiselecting properties
04-16006-04-en, March 2015 Technical
539
17 Bindings User Interface
17.11 Variables View Features
Multiselecting properties, that are of special interest, in a coherent way makes it
easy for you to view, edit, and force values. The Variable view gives you the ability to
work with live values and parameters alike, in a structured way.
Technical 04-16006-04-en, March 2015
540
17 Bindings User Interface
17.12 Confirm Bindings Dialog Box
17.12 Confirm Bindings Dialog Box
Use the Confirm Bindings dialog box to view and confirm applicable bindings.
This dialog box only displays when you apply a binding template.
Figure: Confirm Bindings dialog box
Table: Confirm Bindings Dialog Box
Column Description
Binding point Displays the path to the match. A warning
icon indicates that the value is already
bound. For more information, see section
17.13 “Bindings Status Icons” on page 540.
Binding Displays the properties in the selected object
that have a match. A warning icon indicates
that the property is already bound. For more
information, see section 17.13 “Bindings
Status Icons” on page 540.
Action Select to confirm the binding.
04-16006-04-en, March 2015 Technical
541
17 Bindings User Interface
17.13 Bindings Status Icons
17.13 Bindings Status Icons
This table describes the Bindings status icons.
Table: Bindings Status Icons
Icon Description
Unresolved
Indicates an unresolved binding due to a number of reasons, for example:
• A binding points to an object or property that does not exist. This may
occur after a copy and paste operation when a new object includes a
property with the same name as a property deleted from the database,
but is incompatible.
• A binding points to an object located on another server. For instance,
the system has not resolved the binding yet so the target object may (or
may not) exist.
• A binding points to an object located on another server that is being
engineered, and server communication is not yet fully synched between
the two servers. Generally, the bindings are automatically resolved.
Warning
Indicates an invalid reference in binding functions, which occurs during an
import of bindings or applying a binding template. For more information, see
section 17.12 “Confirm Bindings Dialog Box” on page 539.
Invalid
Indicates that the system resolved the binding and the object exists.
However, the reference is invalid for some reason. In most cases, the target
property is no longer supported, does not exist in the target object, or the
engineering units are incompatible.
Hover over the icon to view the cause of the invalid status.
Technical 04-16006-04-en, March 2015
542
17 Bindings User Interface
17.14 Binding Templates View
17.14 Binding Templates View
Use the Binding Templates view to manage binding templates. This is where you
create, import, edit, and remove templates.
Figure: Binding templates view
Table: Binding Templates View
Column Description
TypeReference Displays the object type for each binding
template.
Name Displays the name of each binding template.
Description Displays descriptive text about each binding
template.
04-16006-04-en, March 2015 Technical
543
17 Bindings User Interface
17.15 Binding Template Wizard – Choosing the Type and Naming the Object Page
17.15 Binding Template Wizard – Choosing
the Type and Naming the Object Page
Use the Choosing the Type and Naming the Object page to choose the type
of binding template you want to create and configure it.
Figure: Choosing the Type and Naming the Object page
Table: Choosing the Type and Naming the Object page
Property Description
Quick Filter Enter a word or a character to filter on. For
more information, see the Quick Filter topic
on WebHelp.
Name Type a name for the binding template.
Location Enter the location of the binding template in
the System Tree pane.
Description Type the description of the binding template.
Technical 04-16006-04-en, March 2015
544
17 Bindings User Interface
17.16 Binding Template Wizard – What Type Do You Want to Bind in the Template Page
17.16 Binding Template Wizard – What Type
Do You Want to Bind in the Template
Page
Use the What type do you want to bind in the template page to select the
type of this template.
Figure: What type do you want to bind in the template page
Table: What Type Do You Want to Bind in the Template Page
Component Description
Type list Select the LonWorks device that will be
selected when applying this template.
Find type Type to find a type.
04-16006-04-en, March 2015 Technical
545
17 Bindings User Interface
17.17 Binding Template Wizard – What Type(s) Do You Want to Bind to with the Template Page
17.17 Binding Template Wizard – What
Type(s) Do You Want to Bind to with
the Template Page
Use the What type(s) do you want to bind to with the template page to
select the types of this binding template.
Figure: What type(s) do you want to bind to with the template page
Table: What Type(s) Do You Want to Bind to with the Template Page
Component Description
Type list Select the LonWorks devices that hold
values that can be bound to the LonWorks
device that was selected on the previous
page.
Add
Click to add LonWorks devices.
Selected object types Displays the LonWorks devices that have
been selected.
Find type Type to find a type.
Technical 04-16006-04-en, March 2015
546
17 Bindings User Interface
17.18 Binding Template Wizard – Specify the Bindings in The Template Page
17.18 Binding Template Wizard – Specify the
Bindings in The Template Page
Use the Specify the bindings in the template page to drag/type applicable
values to the properties of the selected type.
Figure: Specify the bindings in this template page
Table: Specify the Bindings in This Template Page
Column Description
[Destination object properties] Displays properties of the selected
LonWorks device.
Unit Displays the engineering unit associated with
each property (if any).
Binds to Drag/type values to these property boxes.
[Browser] Find and drag values to the selected
LonWorks device.
04-16006-04-en, March 2015 Technical
547
17 Bindings User Interface
17.19 Binding Template Wizard – Specify the Path Matching Patterns in the Template Page
17.19 Binding Template Wizard – Specify the
Path Matching Patterns in the Template
Page
Use the Specify the path matching patterns in the template page to define
rules on how values will bind when using this template.
Figure: Specify the path matching patterns in the template page
Table: Specify the Path Matching Patterns in the Template Page
Component Description
Add rule
Click to add a new rule entry. Within a rule
entry, you specify a value or the path to the
value in the Selected object. You also
specify a value or the path of a value in the
Binding candidate. If a value is found in
the Binding candidate, as specified, it is
bound to the specified value in the
Selected object.
Remove rule
Click to remove a rule entry.
Move up
Click to move the selected rule entry up in
the list. The order in which rules are stated
can affect which values are bound.
Technical 04-16006-04-en, March 2015
548
17 Bindings User Interface
17.19 Binding Template Wizard – Specify the Path Matching Patterns in the Template Page
Continued
Component Description
Move down
Click to move the selected rule entry down in
the list. The order in which rules are stated
can affect which values are bound.
Move to top
Click to move the selected rule entry to the
top in the list. The order in which rules are
stated can affect which values are bound.
Move to bottom
Click to move the selected rule entry to the
bottom in the list. The order in which rules
are stated can affect which values are
bound.
Selected object Type the value or the path of the value that
you want to bind in the Selected object.
Binding candidate Type the value or the path of the value that
you want to bind in the Binding
candidate.
When the template is used and the rule is
executed, if a value is found in the Binding
candidate as specified, it is bound to the
specified value in the Selected object.
Property Select if the rule is to match values by their
Name, Description, Note 1, or Note 2
property,
04-16006-04-en, March 2015 Technical
549
17 Bindings User Interface
17.20 Binding Template Properties
17.20 Binding Template Properties
Use the Binding Templates properties dialog box to view and edit the properties
of the binding template.
Figure: Binding template properties
Table: Binding Template Properties
Component Description
Description Type a description that explains what the
object is used for.
Type Displays the object type that defines the
properties of the object.
Foreign Address Displays the address to a non-Building
Operation device, for example a BACnet
device.
Modified Displays the date and time when the object
was last modified.
Note 1 Type text that you display in a graphic or use
when searching for the object.
Technical 04-16006-04-en, March 2015
550
17 Bindings User Interface
17.20 Binding Template Properties
Continued
Component Description
Note 2 Type text that you display in a graphic or use
when searching for the object.
Validation Select the validation status of the object to
keep track of which objects have passed or
failed the validation.
Template name Type a name for the template.
Owning type Displays the type on which this template is
applicable.
04-16006-04-en, March 2015 Technical
551
17 Bindings User Interface
17.21 Edit Binding Template Dialog Box – Type Binding Template
17.21 Edit Binding Template Dialog Box –
Type Binding Template
Use the Edit binding template dialog box to configure the type binding template.
Figure: Edit binding template dialog box
Table: Edit Binding Template Dialog Box - Binding Template Tab
Component Description
Hide bound
Hides bound rows.
Hide parameters
Hides parameter rows.
Technical 04-16006-04-en, March 2015
552
17 Bindings User Interface
17.21 Edit Binding Template Dialog Box – Type Binding Template
Continued
Component Description
Match units
Displays points that match at least one row
that has the same unit.
Match data types
Displays points that match at least one row
that has the same type.
Hide parameters
Hides parameter rows.
[Destination object properties] Displays properties of the selected
LonWorks device.
Unit Displays the engineering unit associated with
each property (if any).
Binds to Drag/type values to these property boxes.
[Browser] Find and drag values to the selected
LonWorks device.
Table: Edit Binding Template Dialog Box - Default Settings Tab
Component Description
Template Name Type a name for the binding template.
Template Description Type a description for the binding template.
04-16006-04-en, March 2015 Technical
553
17 Bindings User Interface
17.22 Edit Binding Template Dialog Box – Path Matching Binding Template
17.22 Edit Binding Template Dialog Box –
Path Matching Binding Template
Use the Edit binding template dialog box to configure the path matching binding
template.
Figure: Edit binding template dialog box
Table: Edit Binding Template Dialog Box - Binding Template Tab
Component Description
Add rule
Click to add a new rule entry. Within a rule
entry, you specify a value or the path to the
value in the Selected object. You also
specify a value or the path of a value in the
Binding candidate. If a value is found in
the Binding candidate, as specified, it is
bound to the specified value in the
Selected object.
Remove rule
Click to remove a rule entry.
Move up
Click to move the selected rule entry up in
the list. The order in which rules are stated
can affect which values are bound.
Move down
Click to move the selected rule entry down in
the list. The order in which rules are stated
can affect which values are bound.
Technical 04-16006-04-en, March 2015
554
17 Bindings User Interface
17.22 Edit Binding Template Dialog Box – Path Matching Binding Template
Continued
Component Description
Move to top
Click to move the selected rule entry to the
top in the list. The order in which rules are
stated can affect which values are bound.
Move to bottom
Click to move the selected rule entry to the
bottom in the list. The order in which rules
are stated can affect which values are
bound.
Selected object Type the value or the path of the value that
you want to bind in the Selected object.
Binding candidate Type the value or the path of the value that
you want to bind in the Binding
candidate.
When the template is used and the rule is
executed, if a value is found in the Binding
candidate as specified, it is bound to the
specified value in the Selected object.
Property Select if the rule is to match values by their
Name, Description, Note 1, or Note 2
property.
Table: Edit Binding Template Dialog Box - Default Settings Tab
Component Description
Template Name Type a name for the binding template.
Template Description Type a description for the binding template.
04-16006-04-en, March 2015 Technical
555
17 Bindings User Interface
17.23 Time Stamp Value Properties
17.23 Time Stamp Value Properties
Use the Time Stamp Value properties dialog box to view or configure a time
stamp value.
Figure: Time stamp value
Table: Time Stamp Value
Property Description
Value Enter a date and time
Technical 04-16006-04-en, March 2015
556
18 Import and Export
Topics
Import and Export Overview
Export
Exporting a Solution
Selecting Multiple Solutions for Export
Export of Networks, Devices, and Protocols
Import and Export of I/O Solutions
Import and Export of b3 Solutions
Import and Export of BACnet Solutions
Import and Export of GCM Solutions
Import and Export of LonWorks Solutions
Import and Export of MNL LonWorks Solutions
Import and Export of MicroNet Solutions
Import and Export of Modbus Solutions
Import and Export of Sigma Solutions
Import and Export of Xenta Solutions
Export of Programs, Functions, and Applications
Import and Export of Script Solutions
Import and Export of User Management Solutions
Import and Export of Alarm Solutions
Import and Export of Trend Solutions
Import and Export of Schedule Solutions
Import and Export of Report Solutions
Custom Object Type
Export Library Mode
Exportable and Non-exportable Objects
Import
Importing a Solution
Import of Networks, Devices, and Protocols
Import of Programs, Functions, and Applications
Import and Export of Supporting Objects
Import and Export of Bindings and Binding Templates
18 Import and Export
18.1 Import and Export Overview
18.1 Import and Export Overview
A solution or application is a user-created object or group of objects that perform a
control process. Examples of creatable objects in Building Operation include
networks, devices, programs, binding templates, graphics, trends, and alarms.
Control processes can manage simple systems like air volume units, switches, and
lighting relays as well as complex systems like air handlers, chillers, and boilers.
Figure: Import and Export
Sharing Solutions Between Building Operation Servers and Projects
When designing Building Operation solutions, you can avoid duplication of effort by
exporting and importing files from one Building Operation server to another. For
example, you can export an alarm solution configured on one server, and then
import this alarm solution to one or more other servers. Take time to organize each
solution within a top folder so that all the interrelated folders and objects are
grouped together, which will simplify the export and import process later.
Import and Export is also version independent, which means that you can share
solutions regardless of the software revision. Specifically, you can import a solution
that was exported from one Building Operation server or WorkStation version with
servers or projects of any Building Operation server or WorkStation version.
In addition, you can create libraries that can be made available to other engineers.
To reduce programming time, you can share these libraries between Building
Operation servers and projects. In turn, libraries and Building Operation solutions
can be shared with other engineers through WorkStation. Solutions from libraries
can be assembled in various combinations to suit the needs of a job.
04-16006-04-en, March 2015 Technical
559
18 Import and Export
18.1 Import and Export Overview
18.1.1 Export
Export involves writing a solution configuration into a file, which is saved to another
location. To export a solution in Building Operation, select an existing solution
container and then click the Export command. Building Operation generates an
export file comprised of the objects and their configurations.
For more information, see section 18.2 “Export” on page 559.
18.1.2 Exportable and Non-exportable Objects
Most objects and data can be exported, with a few exceptions.
For more information, see section 18.25 “Exportable and Non-exportable Objects”
on page 590.
18.1.3 Import
Import involves reading a previously exported file and then recreating objects based
on the configuration of the file. To import a solution in Building Operation, select a
target location on the server and then click the Import command.
For more information, see section 18.26 “Import” on page 591.
18.1.4 Import and Export of Supporting Objects
Supporting objects, configured by users, are an integral part of a ported solution.
The export process can automatically include supporting objects in an export file.
For more information, see section 18.30 “Import and Export of Supporting Objects”
on page 599.
18.1.5 Import and Export of Bindings and Binding
Templates
Building Operation imports and exports bindings and binding templates with a few
exceptions.
For more information, see section 18.31 “Import and Export of Bindings and
Binding Templates” on page 601.
Technical 04-16006-04-en, March 2015
560
18 Import and Export
18.2 Export
18.2 Export
Export involves writing a solution configuration into a file, which is saved to another
location. To export a solution in Building Operation, select an existing solution
container and then click the Export command. Building Operation generates an
export file comprised of the objects and their configurations.
Building Operation does not export some system objects and properties. For
example, you cannot export the System folder, or object properties like device IDs.
If a system object or folder is mistakenly included in an export, the export process
provides an Export Preview area, which lists the non-exportable objects. The export
proceeds but the system object or folder is not included in the export file. For more
information, see section 18.25 “Exportable and Non-exportable Objects” on page
590.
If you create your own objects and folders within a system folder, you can export
them separately to the corresponding system folder on the targeted server, for
example, System – Alarms.
When exporting a solution, an internal binding path is one that refers to an object
that is also included in the export. An external binding path is one that refers to an
object that is not included in the export. Internal unlocked binding paths are always
kept.
You decide what external binding paths to include in an export: locked, locked and
unlocked, or none.
• Export Special: Keeps all external binding paths (locked and unlocked). After
an import, some binding paths may be unresolved.
• Export Library mode: Removes all external binding paths (locked and
unlocked). Generates an export file that you can use anywhere and know that,
upon import, every reference has been resolved to what you expect. Use one
of the other export reference filter types when you know how the export will be
used.
• Export: Removes all external unlocked binding paths. After an import, some
binding paths may be unresolved.
Tip
From the List View, you can select multiple solutions for export, which are
exported as a single file. For more information, see section 18.4 “Selecting
Multiple Solutions for Export” on page 562.
18.2.1 Export of Networks, Devices, and Protocols
You can export networks, devices, and communication protocols in Building
Operation.
For more information, see section 18.5 “Export of Networks, Devices, and
Protocols” on page 563.
04-16006-04-en, March 2015 Technical
561
18 Import and Export
18.2 Export
18.2.2 Export of Programs, Functions, and
Applications
You can export programs, functions, and applications in Building Operation.
For more information, see section 18.16 “Export of Programs, Functions, and
Applications” on page 576.
Technical 04-16006-04-en, March 2015
562
18 Import and Export
18.3 Exporting a Solution
18.3 Exporting a Solution
You export a solution to another Building Operation server. You can also use the
standard copy and paste method to copy solutions to other file locations on the
same server.
For more information, see section 18.1 “Import and Export Overview” on page 557.
To export a solution
1. In WorkStation, in the System Tree pane or the List View, select the
solution that you want to export.
2. On the File menu, click Export.
3. In the Select an Export Reference Filter option, select the filter type to be
used for the export.
4. Click Export.
5. In the Save As dialog box, enter the location and file name.
6. Click Save.
7. Click Close when the export is complete.
04-16006-04-en, March 2015 Technical
563
18 Import and Export
18.4 Selecting Multiple Solutions for Export
18.4 Selecting Multiple Solutions for Export
You use the List View to select multiple objects or solutions that can be grouped
into a single export.
For more information, see section 18.1 “Import and Export Overview” on page 557.
To select multiple solutions for export
1. In WorkStation, in the System Tree pane, select the location where the
solutions are stored.
2. In the List View, press the CTRL key and click the objects or solutions that
you want to export.
3. On the File menu, select Export.
Technical 04-16006-04-en, March 2015
564
18 Import and Export
18.5 Export of Networks, Devices, and Protocols
18.5 Export of Networks, Devices, and
Protocols
You can export networks, devices, and communication protocols in Building
Operation.
18.5.1 Import and Export of I/O Solutions
You can import and export I/O points, devices, and solutions from one Automation
Server to another. Building Operation preserves all the properties of modules and
their points. However, bindings are not included.
For more information, see section 18.6 “Import and Export of I/O Solutions” on
page 565.
18.5.2 Import and Export of b3 Solutions
You can import and export b3 BACnet devices, objects, and solutions in Building
Operation.
For more information, see section 18.7 “Import and Export of b3 Solutions” on page
566.
18.5.3 Import and Export of BACnet Solutions
You can export and import BACnet objects, devices, and solutions from one
Building Operation server to another.
For more information, see section 18.8 “Import and Export of BACnet Solutions” on
page 567.
18.5.4 Import and Export of GCM Solutions
You use WorkStation to import the migrated GCM database into the Automation
Server. The Automation Server uses the export file created by the TAC I/A Series
Migrator for the import process, which then creates a NETWORK 8000 Interface
with all the migrated objects in sub-folders under the NETWORK 8000 Interface
folder.
For more information, see section 18.9 “Import and Export of GCM Solutions” on
page 569.
18.5.5 Import and Export of LonWorks Solutions
You can import and export the contents of an entire LonWorks network.
For more information, see section 18.10 “Import and Export of LonWorks Solutions”
on page 570.
04-16006-04-en, March 2015 Technical
565
18 Import and Export
18.5 Export of Networks, Devices, and Protocols
18.5.6 Import and Export of MNL LonWorks Solutions
In Building Operation, you can use WorkStation to export MNL LonWorks devices
and Application objects as solutions. A solution can be imported any number of
times in other Building Operation servers where needed, thus reducing duplication
of effort.
For more information, see section 70.17 “Import and Export of MNL LonWorks
Solutions” on page 2418.
18.5.7 Import and Export of MicroNet Solutions
You can import and export MicroNet networks in Building Operation. However, you
cannot import and export network components (subnets, devices and objects).
For more information, see section 18.12 “Import and Export of MicroNet Solutions”
on page 572.
18.5.8 Import and Export of Modbus Solutions
You can import and export Modbus objects, networks, devices, and solutions in
Building Operation, with a few exceptions.
For more information, see section 18.13 “Import and Export of Modbus Solutions”
on page 573.
18.5.9 Import and Export of Sigma Solutions
You can import and export certain parts of a Sigma interface in Building Operation.
For more information, see section 18.14 “Import and Export of Sigma Solutions” on
page 574.
18.5.10 Import and Export of Xenta Solutions
You can import and export most Xenta objects and solutions.
For more information, see section 18.15 “ Import and Export of Xenta Solutions” on
page 575.
Technical 04-16006-04-en, March 2015
566
18 Import and Export
18.6 Import and Export of I/O Solutions
18.6 Import and Export of I/O Solutions
You can import and export I/O points, devices, and solutions from one Automation
Server to another. Building Operation preserves all the properties of modules and
their points, as well as their bindings.
Generally, you can export the following module and point properties:
• Module IDs.
• Channel numbers
• All other configuration parameters
• Requested values
For more information, see the I/O Bus Overview topic on WebHelp.
Import
In most cases, you can import the following module and point properties:
• Module IDs. When you import a module, if the module has been used by
another module, the module is still imported. However, the module ID is set to
Null and an import warning is reported.
• Channel numbers. When you import a point, if the channel number has been
used by another point, the point is still imported. However, the channel number
is set to Null and an import warning is reported.
• All other configuration parameters
• Requested values
If an I/O module or point already exists on the targeted server during an import, the
import process creates a copy of the object and generates an alternate name to
prevent accidental overwriting. For example, a module named Slot03:UI16 is
renamed Slot03:UI16_2.
04-16006-04-en, March 2015 Technical
567
18 Import and Export
18.7 Import and Export of b3 Solutions
18.7 Import and Export of b3 Solutions
You can import and export b3 BACnet devices, objects, and solutions in Building
Operation.
Export
Generally, you can:
• Export a b3 BACnet device and its contents to a file.
• Export one or more objects from a b3 BACnet device to a file.
For more information, see section 82.3 “b3 BACnet Device Controllers” on page
3257.
Import
Generally, you can:
• Import a file containing objects, solutions, or the entire contents of a b3
BACnet device to an MS/TP Network.
• Import one or more objects from a b3 BACnet device to a b3 BACnet device
Application folder.
Tip
After you import a file containing objects, solutions, or the entire contents of a b3
BACnet device, you need to associate the device object with a live b3 BACnet
device in the Hardware folder, or the Automation Server's Device Discovery tab.
You then download the device. If you fail to do so, the b3 BACnet device is
unusable.
Technical 04-16006-04-en, March 2015
568
18 Import and Export
18.8 Import and Export of BACnet Solutions
18.8 Import and Export of BACnet Solutions
You can export and import BACnet objects, devices, and solutions from one
Building Operation server to another.
Using Building Operation Export, you select multiple user-created objects for
export. After an export takes place, you can import the BACnet solution to an
Application folder on another Building Operation server. However, some objects
that you select may not be exportable, such as an entire Application folder, which is
a system object. For more information, see section 149.8 “Cannot Export BACnet
System Objects” on page 5512.
Export of BACnet object proxies and BACnet devices
Keep in mind the following information:
• Object IDs are preserved during export.
• The enabled state of Trend logs is preserved during an export and import of a
Trend solution.
• The enabled state of Alarms is preserved during an export and import of an
Alarms solution. Intrinsic (built-in) alarms are also included.
• A device instance number is not preserved in an export. An imported BACnet
device must be associated with a device. For more information, see section
75.6 “Associating a BACnet Instance Number with a Device ” on page 2611.
For more information, see section 73.1 “BACnet Overview” on page 2551.
Import of BACnet object proxies and BACnet devices
Note the following information:
• The Services supported property in the Advanced tab of a device lists the
supported services, such as create-object. If an import contains any BACnet
objects for a device that does not support the create-object service, then these
objects must be created in the device by some proprietary means provided by
the device vendor. Consequently, you need to configure these objects with
object identifiers matching those in the import. In this case, an upload of the
device is recommended.
• By default, the BACnet Notification includes a reference to the BACnet
Interface object. If any references are invalid, the import process warns you
that the references were not imported. You must manually reset these
references after the import takes place before or after downloading. To avoid
this problem, set the BACnet Interface object on the source and destination
servers with the same Building Operation server name. For more information,
see section 149.9 “Cannot Import BACnet Notification References” on page
5513.
• Import does not include the current status flag, such as enabled, on any device
or object in the export file. As a result, these statuses may not be in synch with
the actual device or object because they are not automatically downloaded
after the import takes place. The import process may also indicate that a
manual download is necessary. If so, you need to manually download to the
device or object after an import.
• During an import, Building Operation cannot create references to BACnet
devices or objects that do not exist on the destination server. Therefore, you
need to recreate these references manually after the import takes place.
04-16006-04-en, March 2015 Technical
569
18 Import and Export
18.8 Import and Export of BACnet Solutions
Export of Building Operation Server BACnet objects
Keep in mind the following information:
• During an export, Building Operation preserves the object IDs but does not
preserve the device IDs.
• Building Operation preserves the enabled state on Trends during an export or
import.
• Building Operation preserves the enabled state on Schedules during an export
or import.
• Building Operation preserves the enabled state on Alarms during an export or
import. Intrinsic (built-in) alarms are also included.
• A BACnet Interface can only be imported to the same type of server (Enterprise
Server or Automation Server) from which it was exported. It is not possible to
assign the device ID of the BACnet interface manually when importing, only
automatically assigned IDs are possible. To import an entire BACnet interface,
complete the following tasks:
– Assign a unique network ID in the Properties of any imported MSTP
network.
– Associate any imported BACnet devices with a device from the Hardware
folder or Device Discovery manager.
• An imported MSTP network will be created on the same COM port on the
server to which it is imported and the server from which it was exported. The
network ID must be assigned a unique value in the Properties of the MSTP
network.
Import of Building Operation Server BACnet objects
Note the following information:
• Import only preserves object IDs if there are no conflicts.
• By default, BACnet Notifications reference the BACnet Interface. If any
reference is invalid, the import continues with a warning message, but the
reference will not be created. To avoid this problem, make sure that the
Building Operation name for the BACnet Interface object is the same on the
source and destination servers. For more information, see section 149.9
“Cannot Import BACnet Notification References” on page 5513.
• Schedules with Calendar references import successfully if the Calendar is
included in the export file or already exists on the destination server. If this does
not occur, you must manually recreate these references after the import takes
place.
• During an import, Building Operation cannot create references to BACnet
devices or objects that do not exist on the destination server. Therefore, you
must manually recreate these references after the import takes place.
Technical 04-16006-04-en, March 2015
570
18 Import and Export
18.9 Import and Export of GCM Solutions
18.9 Import and Export of GCM Solutions
You use WorkStation to import the migrated GCM database into the Automation
Server. The Automation Server uses the export file created by the TAC I/A Series
Migrator for the import process, which then creates a NETWORK 8000 Interface
with all the migrated objects in sub-folders under the NETWORK 8000 Interface
folder.
You can export any group of NETWORK 8000 objects and import them into other
Automation Servers that have a NETWORK 8000 Interface.
Note
There can be only one NETWORK 8000 Interface in a server. If you attempt to
import another interface, the system identifies import conflicts during the import
process and prevents the import from taking place. However, you can export any
group of NETWORK 8000 objects and import them into another Automation
Server with a NETWORK 8000 Interface.
04-16006-04-en, March 2015 Technical
571
18 Import and Export
18.10 Import and Export of LonWorks Solutions
18.10 Import and Export of LonWorks
Solutions
You can export and import a LonWorks solution in parts or in its entirety, such as a
particular device, or the configuration of an entire network.
When you export a LonWorks solution, bindings are included if both sender and
receiver devices are part of the exported solution, and if either is missing Building
Operation still creates a binding if a corresponding sender or receiver is detected in
the new system without causing a binding conflict.
When the exported solution is imported, if either a sender or a receiver is missing
and no corresponding server or receiver is detected in the new system, bindings to
and from devices outside the exported solution are cleared.
Tip
There is a workaround that allows you to import solutions and at the same time
resolve binding conflicts. For more information, see section 18.24 “Export Library
Mode” on page 589.
Technical 04-16006-04-en, March 2015
572
18 Import and Export
18.11 Import and Export of MNL LonWorks Solutions
18.11 Import and Export of MNL LonWorks
Solutions
In Building Operation, you can use WorkStation to export MNL LonWorks devices
and Application objects as solutions. A solution can be imported any number of
times in other Building Operation servers where needed, thus reducing duplication
of effort.
For more information, see section 18.1 “Import and Export Overview” on page 557.
18.11.1 Exporting an MNL LonWorks Solution
You use WorkStation to export an MNL LonWorks device or Application object as
an MNL LonWorks solution so that it can be reused in other Building Operation
servers. When you export an MNL LonWorks Application object, the corresponding
MNL LonWorks application type is automatically included in the solution file.
For more information, see section 18.3 “Exporting a Solution” on page 561.
18.11.2 Importing an MNL LonWorks Solution
You use WorkStation to import an MNL LonWorks solution that was created or
modified on another Building Operation server.
For more information, see section 18.27 “Importing a Solution” on page 594.
Caution
If a name conflict occurs during the import process, proceed with caution. It is
possible that the existing application type and the application type in the solution
file are not identical. In such a case, the Application objects that are created
during import may not contain all the attributes of the original Application
objects on the source server.
For more information, see section 158.21 “Name Conflicts During MNL LonWorks
Solution Import” on page 5619.
Caution
If a name conflict occurs during the import process, and the MNL device model
number is different between the existing application type and the application type
in the solution file, do not proceed with the import. Instead, use WorkPlace Tech
Editor to import the original application type from which the solution was created
and then save it with a different name.
For more information, see section 70.8 “Importing a Single MNL LonWorks
Application Type” on page 2403.
WorkPlace Tech Editor and Monitor Engineering Guide Supplement (F-27745)
04-16006-04-en, March 2015 Technical
573
18 Import and Export
18.12 Import and Export of MicroNet Solutions
18.12 Import and Export of MicroNet
Solutions
You can import and export MicroNet networks in Building Operation. However, you
cannot import and export network components (subnets, devices and objects).
Keep the following points in mind when importing MicroNet networks:
• You can only import a maximum of two MicroNet networks to an Automation
Server (one for each of the two serial ports).
• You can only import one MicroNet network to an Enterprise Server, which
usually has only one serial port (unless you physically increase the number of
ports).
Technical 04-16006-04-en, March 2015
574
18 Import and Export
18.13 Import and Export of Modbus Solutions
18.13 Import and Export of Modbus Solutions
You can import and export Modbus objects, networks, devices, and solutions in
Building Operation, with a few exceptions.
Keep the following points in mind when exporting or importing Modbus objects or
solutions:
• Modbus TCP Server. There can be only one Modbus TCP Server per
Automation Server or Enterprise Server. If one is found, the import will not
succeed.
• Modbus Interface. There can be only one Modbus Interface with the same
instance number per server. If one is found, the import will not succeed.
• Modbus TCP Network. There can be only one Modbus TCP Network with the
same instance number per server. If one is found, the import will not succeed.
For more information, see section 86.1 “Modbus Overview” on page 3561.
04-16006-04-en, March 2015 Technical
575
18 Import and Export
18.14 Import and Export of Sigma Solutions
18.14 Import and Export of Sigma Solutions
You can import and export certain parts of a Sigma interface in Building Operation.
You can import and export the following objects within a Sigma interface:
• Global values virtual controller and its global values
• Graphics
• Log sets
• Segments created in the Sigma interface, and their shortcuts
• Text report groups
Technical 04-16006-04-en, March 2015
576
18 Import and Export
18.15 Import and Export of Xenta Solutions
18.15 Import and Export of Xenta Solutions
You can import and export most Xenta objects and solutions.
There are limitations to retaining LonWorks bindings and to where you can import
solutions. For more information, see section 18.10 “Import and Export of LonWorks
Solutions” on page 570.
04-16006-04-en, March 2015 Technical
577
18 Import and Export
18.16 Export of Programs, Functions, and Applications
18.16 Export of Programs, Functions, and
Applications
You can export programs, functions, and applications in Building Operation.
18.16.1 Import and Export of Script Solutions
You can import or export Script programs, functions, and solutions from one
Building Operation server to another.
For more information, see section 18.17 “Import and Export of Script Solutions” on
page 578.
18.16.2 Import and Export of User Management
Solutions
You can export and then import most domains, user accounts, user account
groups, and workspaces.
For more information, see section 18.18 “Import and Export of User Management
Solutions” on page 579.
18.16.3 Import and Export of Alarm Solutions
You can export and then import most Building Operation Alarm objects and
solutions.
For more information, see section 18.19 “Import and Export of Alarm Solutions” on
page 583.
18.16.4 Import and Export of Trend Solutions
You can export and import most Building Operation Trend logs, viewers, and
solutions, with the following exceptions.
For more information, see section 18.20 “Import and Export of Trend Solutions” on
page 584.
18.16.5 Import and Export of Schedule Solutions
You can export and import Schedules and Calendars from one Building Operation
server to another.
For more information, see section 18.21 “Import and Export of Schedule Solutions”
on page 585.
Technical 04-16006-04-en, March 2015
578
18 Import and Export
18.16 Export of Programs, Functions, and Applications
18.16.6 Import and Export of Report Solutions
You can import and export energy related objects. Otherwise, Import and Export of
report objects and solutions is not recommended.
For more information, see section 18.22 “Import and Export of Report Solutions” on
page 587.
18.16.7 Custom Object Type
Custom object types are object definitions that extend the standard Building
Operation object set. These object definitions are included with the object during
the import and export processes.
For more information, see section 18.23 “Custom Object Type” on page 588.
18.16.8 Export Library Mode
You use Export Library mode reference filter type during an export to generate a
file that you can use anywhere and know that every reference has been resolved to
what you expect. On Import, it is expected that all references will be resolved. For
example, if you place the export into a library to be used by someone else, all
references should be resolved based on objects in the exported file’s solution.
For more information, see section 18.24 “Export Library Mode” on page 589.
04-16006-04-en, March 2015 Technical
579
18 Import and Export
18.17 Import and Export of Script Solutions
18.17 Import and Export of Script Solutions
You can import or export Script programs, functions, and solutions from one
Building Operation server to another.
Export
You can export one or more Script programs or functions from an Enterprise
Server, Automation Server, or b3 device.
Import
Keep the following points in mind to preserve bindings during an import:
• Import the referenced objects to the targeted server or device prior to
importing the actual Script programs and functions that reference these
objects. For example, import any referenced I/O points before importing the
programs that read and write the I/O points.
• Import a previously exported file that contains one or more Script programs or
functions to an appropriate destination, such as an Enterprise Server.
For more information, see section 52.2 “Script Editor Program Creation” on page
1854.
Note
In multi-server configurations, you may have to manually recreate some bindings
after an import takes place.
Technical 04-16006-04-en, March 2015
580
18 Import and Export
18.18 Import and Export of User Management Solutions
18.18 Import and Export of User Management
Solutions
You can export and then import most domains, user accounts, user account
groups, and workspaces.
Keep in mind the following information regarding the export and import of User
Management objects and solutions.
Export
Within the Domains folder, you can export one domain at a time by choosing either
the full or partial contents. The Domains folder contains the following exportable
folders:
• Building Operation Domains. These domains are preinstalled on Enterprise
Servers as well as Automation Servers that are part of a multi-server
configuration.
– On the Enterprise Server, this domain contains user accounts, user
account groups, software permissions, policies, and workspaces. In a
multi-server scenario, this domain also supports the functionality to add or
remove member servers from the domain.
– On an Automation Server, this domain only supports communication with
the top level server.
• User-created Domains. These domains are created by an administrator or
engineer for a particular purpose. You can create and then export user-created
domains and their contents.
• User-created Accounts and Account Groups. In contrast to other domain
objects, user accounts and groups are unique to the domain to which they
belong. Therefore, you cannot export them individually. They can only be
exported as part of an export of an entire user-created domain.
• Workspaces. Workspaces can be created by the user in any of the domains, or
exported individually. An export of an entire domain includes all the
workspaces within it.
Building Operation cannot export local workspaces.
For more information, see the User Account Management Overview topic on
WebHelp.
Note
In Building Operation, software permissions are set at the path and/or command
level, rather than at the object or folder level. Therefore, do not change the names
of the exported objects or folders. For example, if you change the name of an
exported folder, users with previously granted path permissions will be denied
access to this folder and its subfolders after the import takes place. You will have
to reset these permissions.
Some objects that you select for export may not be exportable because they are
used internally by Building Operation, specifically:
• Domains/Local. Preinstalled on all Building Operation servers, Local is a
system object designed primarily for local server log-on activities.
04-16006-04-en, March 2015 Technical
581
18 Import and Export
18.18 Import and Export of User Management Solutions
• System objects. In addition, there are system objects within the Domains/Local
folder that cannot be exported, for example, groups, users, and workspaces
(except workspaces that are created by users).
Important
Building Operation encrypts account passwords whenever user accounts are
exported from an Enterprise Server.
For more information, see section 149.13 “Cannot Export User Management
System Objects” on page 5518.
Import
You can import the following objects:
• An 'out-of-the-box' domain. For example, the Users Domain contains user
accounts, user account groups, and group-related workspaces and software
permissions.
• A user-defined domain.
Technical 04-16006-04-en, March 2015
582
18 Import and Export
18.18 Import and Export of User Management Solutions
• The full contents of any exported workspaces within the Workspaces folder of
a domain.
04-16006-04-en, March 2015 Technical
583
18 Import and Export
18.18 Import and Export of User Management Solutions
Note
Software permissions are set at the path and/or command level, rather than at
the object or folder level. Therefore, when you import a solution, software
permissions apply only to any identically named objects and folders found on the
targeted location. For example, if you change the name of a folder, users with
previously granted path permissions will be denied access to this folder and its
subfolders. You will have to reset these permissions.
Technical 04-16006-04-en, March 2015
584
18 Import and Export
18.19 Import and Export of Alarm Solutions
18.19 Import and Export of Alarm Solutions
You can export and then import most Building Operation Alarm objects and
solutions.
Export
Building Operation exports the following Alarm objects:
• Alarms. Building Operation preserves Alarm references during export.
• Alarm Views. Building Operation preserves Alarm View references during
export.
• Event Views. Building Operation preserves Event View references during
export.
• Automatic assignment. Building Operation preserves the references of
automatically assigned objects during export.
• Notifications. Building Operation preserves Notification references during
export.
• User Action (supporting objects). Building Operation preserves the references
to the following supporting objects: categories, cause notes, action notes, and
checklists during export. For more information, see section 18.30 “Import and
Export of Supporting Objects” on page 599.
Building Operation cannot export the following:
• Alarm styles.
• Default Alarm panes.
• Default Event panes.
• Customized Alarm and Event View Columns
For more information, see the Alarm Functions topic on WebHelp.
Import
When an exported file is imported, Building Operation preserves the references
among the imported Alarm objects, with a few exceptions:
• User Action (supporting objects). The import process handles categories,
cause notes, action notes, and checklists in the following ways:
– If User Actions with conflicting names are found on the targeted server,
Import reestablishes the references among the objects with the identical
name. The import process does not create the imported object under a
new name.
– If User Actions are imported to an Enterprise Server in a multi-server
configuration, the supporting objects have to be recreated on the top
server. After creation, they are automatically copied to the connected tier
level servers. For more information, see section 149.12 “Cannot Import
Supporting Objects for Alarms” on page 5517.
04-16006-04-en, March 2015 Technical
585
18 Import and Export
18.20 Import and Export of Trend Solutions
18.20 Import and Export of Trend Solutions
You can export and import most Building Operation Trend logs, viewers, and
solutions, with the following exceptions.
Export
Keep the following points in mind when exporting Trend objects or solutions:
• Export cannot export historical log data from a Building Operation server.
• When exporting Trend objects, you need to follow some guidelines for porting
Trend solutions from one Building Operation server to another. For more
information, see section 149.10 “Cannot Preserve Trend Object Bindings
During Import” on page 5515.
• An exported extended trend log does not retain the references to the
monitored trend log.
For more information, see the Trend Overview topic on WebHelp.
Import
To preserve bindings during an import:
• Import the referenced points, devices, or programs to the targeted server prior
to importing the Trend logs or solutions. For example, import any referenced
I/O points and programs first. Then, import the Trend logs that reference them.
• Import all the Trend objects in a particular order. For more information, see
section 149.10 “Cannot Preserve Trend Object Bindings During Import” on
page 5515.
Technical 04-16006-04-en, March 2015
586
18 Import and Export
18.21 Import and Export of Schedule Solutions
18.21 Import and Export of Schedule
Solutions
You can export and import Schedules and Calendars from one Building Operation
server to another.
Export and Import of Calendars
Generally, you can export and then import:
• Standalone Calendars. For more information, see the Calendars in WorkStation
topic on WebHelp.
• Lead and Shadow Calendars. Building Operation preserves references in
different ways depending on what you include in the export file:
– Export both the Lead and Shadow Calendars together in the same file:
Building Operation preserves the references when you import the file.
– Export only Shadow Calendars without the Lead Calendars: During the
import, Building Operation tries to resolve to the Lead Calendars using the
reference path specified in the import file. If a Lead Calendar is missing,
Building Operation marks the reference unresolved so you need to
manually fix this reference later.
Export and Import of Schedules
In most cases, you can export and then import:
• Standalone Schedules. For more information, see the Building Operation
Schedules topic on WebHelp.
• Lead and Shadow Schedules: Building Operation preserves references in
different ways depending on what you include in the export file:
– Export both the Lead and Shadow Schedules together in the same file:
Building Operation preserves the references when you import the file.
– Export only Shadow Schedules without the Lead Schedule: During the
import, Building Operation tries to resolve to the Lead Schedules using the
server absolute reference paths specified in the import file. If a Lead
Calendar is missing, Building Operation marks the reference unresolved so
you need to manually fix this reference later.
• Schedules with Calendar references. Building Operation preserves references
in different ways depending on what you include in the export file:
– Export both the Schedule and Calendars together in the same file: Building
Operation preserves the references when you import the file.
– Export only the Schedule without the Calendars: During the import,
Building Operation tries to resolve to the Calendars using the server
absolute reference paths specified in the import file. If a Lead Calendar is
missing, Building Operation marks the reference unresolved so you need
to manually fix this reference later.
Building Operation preserves the reference paths for Schedules and Calendars
contained in an imported solution.
To ensure that the reference paths are resolved properly, keep related items in the
same export file:
• Include all the referenced Schedules and Calendars.
• Include both the Lead and Shadow Calendars.
04-16006-04-en, March 2015 Technical
587
18 Import and Export
18.21 Import and Export of Schedule Solutions
• Include both the Lead and Shadow Schedules.
When you import objects joined by a reference in separate export files, import the
objects in the following order:
• Import the Calendars before the Schedules.
• Import the Lead objects before the Shadow objects.
Multi-server Configuration
If you import Shadow Schedules or Calendars to a Building Operation server and
the references to the Lead are broken, you need to manually recreate references:
• In the Shadow Calendars that point to the Lead Calendar
• In the Shadow Schedules that point to the Lead Schedule
For more information, see the Schedule and Calendar Synchronization topic on
WebHelp.
Technical 04-16006-04-en, March 2015
588
18 Import and Export
18.22 Import and Export of Report Solutions
18.22 Import and Export of Report Solutions
You can import and export energy related objects. Otherwise, Import and Export of
report objects and solutions is not recommended.
All energy related objects, (sites and meters) are contained in the Energy folder. For
more information, see the Energy Monitoring Reports topic on WebHelp.
You can import/export the Energy folder complete with sites and meters and their
configurations, or you can import/export a site or sub-site.
You can also use WebReports to complete the following tasks:
• Create a report pack of any custom reports that were created on the source
Reports Server. For more information, see the Report Packs topic on
WebHelp.
• Upload the custom reports pack to the targeted Reports Server for
deployment. For more information, see the About Custom Reports topic on
WebHelp.
After uploading the reports packs from WebReports, the new reports are
automatically created in the default Reports folder of the Enterprise Server.
04-16006-04-en, March 2015 Technical
589
18 Import and Export
18.23 Custom Object Type
18.23 Custom Object Type
Custom object types are object definitions that extend the standard Building
Operation object set. These object definitions are included with the object during
the import and export processes.
Technical 04-16006-04-en, March 2015
590
18 Import and Export
18.24 Export Library Mode
18.24 Export Library Mode
You use Export Library mode reference filter type during an export to generate a
file that you can use anywhere and know that every reference has been resolved to
what you expect. On Import, it is expected that all references will be resolved. For
example, if you place the export into a library to be used by someone else, all
references should be resolved based on objects in the exported file’s solution.
The following references are exported in the Library Mode:
• Unlocked references to objects or properties within the solution being exported
• Task references behave as if task objects are within the solution being
exported
• References to supporting objects (considered to be within the solution being
exported)
The following references are not included in Library Mode exports:
• References to objects or properties outside the current Building Operation
server
• References to objects or properties outside the solution being exported
• Locked references to objects or properties inside the solution being exported
04-16006-04-en, March 2015 Technical
591
18 Import and Export
18.25 Exportable and Non-exportable Objects
18.25 Exportable and Non-exportable Objects
Most objects and data can be exported, with a few exceptions.
Exportable Objects
The following table lists the types of data that can be exported.
Table: Exportable Data
Types of Data Examples
Object Properties Name, Description, or Engineering Unit
Top level objects and lower tier BACnet devices, LonWorks devices, folders,
objects nested within a top level programs, graphics, alarms, and trends
object
References and bindings Values and type of references (including bindings)
that are part of the object:
• Absolute
• Relative
Supporting objects Depending on the selected object, the following
objects are included:
• Alarm objects, such as Categories, Cause
Notes, Action Notes, and Checklists
For more information, see section 18.30
“Import and Export of Supporting Objects” on
page 599.
Non-exportable Objects
The following table lists the types of data that cannot be exported.
Table: Non-exportable Data
Types of Data Example
Runtime values BACnet Device ID or LonWorks Neuron ID
Runtime properties Variables
Default (System) objects Building Operation default and system objects, for
example, System folder of Local Domain
Note
Building Operation does not export some object properties like output values,
forced values, and device IDs.
Technical 04-16006-04-en, March 2015
592
18 Import and Export
18.26 Import
18.26 Import
Import involves reading a previously exported file and then recreating objects based
on the configuration of the file. To import a solution in Building Operation, select a
target location on the server and then click the Import command. For convenience,
the Import dialog box displays a summary and preview of the solution you want to
import. Summary displays information about the file to be imported while Import
Preview displays the names and file structure of the objects to be imported. Custom
Type preview displays the names of the custom types that will be imported. For
more information, see section 18.27 “Importing a Solution” on page 594.
Building Operation detects a name conflict if any objects in the targeted destination
have the same name as any of the top level objects in the imported solution. In
addition, the import process generates an alternate name to prevent accidental
overwriting. For more information, see section 149.2 “Name Conflicts During
Import” on page 5504.
Figure: Import dialog box with preview of the solution
04-16006-04-en, March 2015 Technical
593
18 Import and Export
18.26 Import
If there are container conflicts, Building Operation prevents the import from taking
place and makes the Import button unavailable. The reason for why the container
cannot be imported is shown in the error(s) tab.
For more information, see section 149.3 “Container Conflicts During Import” on
page 5506.
Figure: Container conflict in Import dialog box
18.26.1 Import of Networks, Devices, and Protocols
You can import networks, devices, and communication protocols in Building
Operation.
For more information, see section 18.28 “Import of Networks, Devices, and
Protocols” on page 595.
Technical 04-16006-04-en, March 2015
594
18 Import and Export
18.26 Import
18.26.2 Import of Programs, Functions, and
Applications
You can import programs, functions, and applications in Building Operation.
For more information, see section 18.29 “Import of Programs, Functions, and
Applications” on page 597.
04-16006-04-en, March 2015 Technical
595
18 Import and Export
18.27 Importing a Solution
18.27 Importing a Solution
You import a solution that was created or modified on another Building Operation
server. You can also use the standard copy and paste method to copy solutions to
other file locations on the same server.
For more information, see section 18.1 “Import and Export Overview” on page 557.
To import a solution
1. In WorkStation, in the System Tree pane or List View, select a location
where you want to import a solution.
2. On the File menu, click Import.
3. In the Open dialog box, select the file and click Open.
4. Click Import.
Technical 04-16006-04-en, March 2015
596
18 Import and Export
18.28 Import of Networks, Devices, and Protocols
18.28 Import of Networks, Devices, and
Protocols
You can import networks, devices, and communication protocols in Building
Operation.
18.28.1 Import and Export of I/O Solutions
You can import and export I/O points, devices, and solutions from one Automation
Server to another. Building Operation preserves all the properties of modules and
their points. However, bindings are not included.
For more information, see section 18.6 “Import and Export of I/O Solutions” on
page 565.
18.28.2 Import and Export of b3 Solutions
You can import and export b3 BACnet devices, objects, and solutions in Building
Operation.
For more information, see section 18.7 “Import and Export of b3 Solutions” on page
566.
18.28.3 Import and Export of BACnet Solutions
You can export and import BACnet objects, devices, and solutions from one
Building Operation server to another.
For more information, see section 18.8 “Import and Export of BACnet Solutions” on
page 567.
18.28.4 Import and Export of GCM Solutions
For more information, see section 18.9 “Import and Export of GCM Solutions” on
page 569.
18.28.5 Import and Export of LonWorks Solutions
You can import and export the contents of an entire LonWorks network.
For more information, see section 18.10 “Import and Export of LonWorks Solutions”
on page 570.
04-16006-04-en, March 2015 Technical
597
18 Import and Export
18.28 Import of Networks, Devices, and Protocols
18.28.6 Import and Export of MNL LonWorks Solutions
In Building Operation, you can use WorkStation to export MNL LonWorks devices
and Application objects as solutions. A solution can be imported any number of
times in other Building Operation servers where needed, thus reducing duplication
of effort.
For more information, see section 70.17 “Import and Export of MNL LonWorks
Solutions” on page 2418.
18.28.7 Import and Export of MicroNet Solutions
You can import and export MicroNet networks in Building Operation. However, you
cannot import and export network components (subnets, devices and objects).
For more information, see section 18.12 “Import and Export of MicroNet Solutions”
on page 572.
18.28.8 Import and Export of Modbus Solutions
You can import and export Modbus objects, networks, devices, and solutions in
Building Operation, with a few exceptions.
For more information, see section 18.13 “Import and Export of Modbus Solutions”
on page 573.
18.28.9 Import and Export of Sigma Solutions
You can import and export certain parts of a Sigma interface in Building Operation.
For more information, see section 18.14 “Import and Export of Sigma Solutions” on
page 574.
18.28.10 Import and Export of Xenta Solutions
You can import and export most Xenta objects and solutions.
For more information, see section 18.15 “ Import and Export of Xenta Solutions” on
page 575.
Technical 04-16006-04-en, March 2015
598
18 Import and Export
18.29 Import of Programs, Functions, and Applications
18.29 Import of Programs, Functions, and
Applications
You can import programs, functions, and applications in Building Operation.
18.29.1 Import and Export of Script Solutions
You can import or export Script programs, functions, and solutions from one
Building Operation server to another.
For more information, see section 18.17 “Import and Export of Script Solutions” on
page 578.
18.29.2 Import and Export of User Management
Solutions
You can export and then import most domains, user accounts, user account
groups, and workspaces.
For more information, see section 18.18 “Import and Export of User Management
Solutions” on page 579.
18.29.3 Import and Export of Alarm Solutions
You can export and then import most Building Operation Alarm objects and
solutions.
For more information, see section 18.19 “Import and Export of Alarm Solutions” on
page 583.
18.29.4 Import and Export of Trend Solutions
You can export and import most Building Operation Trend logs, viewers, and
solutions, with the following exceptions.
For more information, see section 18.20 “Import and Export of Trend Solutions” on
page 584.
18.29.5 Import and Export of Schedule Solutions
You can export and import Schedules and Calendars from one Building Operation
server to another.
For more information, see section 18.21 “Import and Export of Schedule Solutions”
on page 585.
04-16006-04-en, March 2015 Technical
599
18 Import and Export
18.29 Import of Programs, Functions, and Applications
18.29.6 Import and Export of Report Solutions
You can import and export energy related objects. Otherwise, Import and Export of
report objects and solutions is not recommended.
For more information, see section 18.22 “Import and Export of Report Solutions” on
page 587.
Technical 04-16006-04-en, March 2015
600
18 Import and Export
18.30 Import and Export of Supporting Objects
18.30 Import and Export of Supporting
Objects
Supporting objects, configured by users, are an integral part of a ported solution.
The export process can automatically include supporting objects in an export file.
When you export a container it automatically includes the necessary supporting
objects in the export file. When the exported file is imported, the supporting objects
are listed but are not included in the actual total number of objects. For more
information, see section 18.2 “Export” on page 559.
Figure: Import preview with supporting objects
Keep the following points in mind when importing a solution that contains
supporting objects:
• Import recreates any supporting objects included in the original export that do
not exist on the targeted server. For more information, see section 149.11
“Supporting Objects Already Exist” on page 5516.
04-16006-04-en, March 2015 Technical
601
18 Import and Export
18.30 Import and Export of Supporting Objects
• Import does not recreate or modify any existing objects on the server. For more
information, see section 149.2 “Name Conflicts During Import” on page 5504.
Technical 04-16006-04-en, March 2015
602
18 Import and Export
18.31 Import and Export of Bindings and Binding Templates
18.31 Import and Export of Bindings and
Binding Templates
Building Operation imports and exports bindings and binding templates with a few
exceptions.
Export of Bindings and Binding Objects
Keep the following points in mind:
• Variable connectors. When an object that is the destination of a variable
connector is selected for export, the information for the variable connector
object is included in the export file automatically. For more information, see
section 15.1 “Bindings Overview” on page 411.
• Objects or properties with bindings. It is recommended that you combine all
objects or properties that are bound to each other in the same export file. For
example, combine two programs that reference each other in the same export
file. If exported together, they will be bound when imported. If exported
separately, see the import information below.
• Binding templates. Located in the System folder, the Binding Templates folder
is a system object and, therefore, cannot be exported. However, you can
select one or more templates within this folder for export.
Import of Bindings and Binding Objects
Note the following information:
• Objects or properties with bindings where the bound objects are in separate
import files. To preserve bindings during an import, import the referenced
objects to the targeted server prior to importing the actual objects or programs
that refer to these objects. For example, import any referenced I/O points
before importing the programs that read and write the I/O points. No matter
what order of import is used, the import process will restore the bindings if they
are valid at the time of import.
• Binding templates. Binding templates that were exported from a server version
earlier than 1.2 will have names that are not intuitive. After an import of these
binding templates, you can rename the binding template. For more information,
see section 149.7 “Binding Template Name Is Not Intuitive” on page 5511.
04-16006-04-en, March 2015 Technical
603
19 Import and Export User
Interface
Topics
Export Status Dialog Box
Export Preview Dialog Box
Import and Export Toolbar
Import Dialog Box
Import Status Dialog Box
19 Import and Export User Interface
19.1 Export Status Dialog Box
19.1 Export Status Dialog Box
The Export Status dialog box displays the progress and destination of the
exported file.
Figure: Export Status dialog box
04-16006-04-en, March 2015 Technical
607
19 Import and Export User Interface
19.2 Export Preview Dialog Box
19.2 Export Preview Dialog Box
Use this dialog box to view multiple objects that the system can and cannot export
from the server.
Figure: Export preview dialog box
Table: Export Preview Dialog Box
Component Description
Objects that Displays the objects that can be exported as part of the solution.
can be
exported
Objects that Displays the objects that cannot be exported as part of the solution. For
cannot be more information, see section 149.1 “Non-exportable Objects” on page
exported 5503.
Export Select to keep all external binding paths.
special
Export library Select to remove all external binding paths.
mode
Export Select to remove all external unlocked binding paths. For more
information, see section 15.9 “Locked and Unlocked Binding Paths” on
page 429.
Technical 04-16006-04-en, March 2015
608
19 Import and Export User Interface
19.3 Import and Export Toolbar
19.3 Import and Export Toolbar
Use the Import and Export toolbar to import and export solutions.
Table: Import and Export Toolbar
Button Description
Import
Click to import a solution to the selected location.
Export
Click to export a selected solution.
04-16006-04-en, March 2015 Technical
609
19 Import and Export User Interface
19.4 Import Dialog Box
19.4 Import Dialog Box
Use the Import dialog box to preview the contents of the solution that you want to
import. This dialog box provides a summary of information about the imported file
and a preview of the names and file structure of the objects to be imported.
Figure: Import dialog box
Table: Import Dialog Box
Component Description
Import file Displays the location and name of the file selected for import.
Destination Displays the selected server location where the file will be imported.
Number of Displays the total number of the objects selected for import to the server,
objects not including any supporting objects that may be present. For more
information, see section 18.30 “Import and Export of Supporting Objects”
on page 599.
Technical 04-16006-04-en, March 2015
610
19 Import and Export User Interface
19.4 Import Dialog Box
Continued
Component Description
Import Displays the names and the file structure of the objects in the solution to
preview be imported to the server.
Custom Displays the Custom object types that will be part of the solution. If a
types to Custom object type in the import already exists on the server, the preview
import will contain a message that the Custom object type will not be imported.
For more information, see section 18.23 “Custom Object Type” on page
588.
error(s) Displays errors.
warnings(s) Displays warnings.
Copy to Click to copy error and warning messages to the clipboard.
clipboard
04-16006-04-en, March 2015 Technical
611
19 Import and Export User Interface
19.5 Import Status Dialog Box
19.5 Import Status Dialog Box
The Import Status dialog box displays the progress and destination of the
imported file.
Figure: Import Status dialog box
Technical 04-16006-04-en, March 2015
612
20 I/O Modules
Topics
I/O Modules Overview
I/O Module Workflows
Physical Devices and I/O Module Objects
Creating an I/O Module
Configuring an I/O Module
Discovering an I/O Module
Creating Multiple I/O Modules
Updating I/O Module Firmware
Moving an I/O Module
Recovering from an I/O Module Failure
Assigning and Unassigning Logical I/O Modules
I/O Points
Creating Multiple Objects
Configuring Multiple Objects
Copying from MS Excel to Spreadsheet View
Copying from Spreadsheet View to MS Excel
I/O Module Low Power Mode
Setting and Recovering an I/O Module from Low Power
Printing a Label to Identify I/O Channels
Correcting a Module Type Mismatch
Output Override Status
Overriding a Digital Output
Overriding an Analog Output
Associating an Engineering Unit with Property Values
Inserting a New Module in the Middle of an Existing I/O Bus
Resolving I/O Module Device Address Changed and
Blacklisted Device Detection Errors
20 I/O Modules
20.1 I/O Modules Overview
20.1 I/O Modules Overview
In WorkStation, you create or discover an I/O module in the Automation Server I/O
bus folder. When you create an I/O module, you specify the I/O module type and
I/O module name. You can then create I/O points on that I/O module.
20.1.1 I/O Modules
By adding a variety of I/O and power supply modules, you can use the Automation
Server to tailor the Intelligent Building Management System to your unique
requirements.
For more information, see the I/O Modules topic on WebHelp.
20.1.2 I/O Module Workflows
When a physical I/O module is connected to an Automation Server, there are two
ways to create an I/O module and its points.
For more information, see section 20.2 “I/O Module Workflows” on page 615.
20.1.3 Physical Devices and I/O Module Objects
You add an I/O module by installing the module on the terminal base. If there is an
I/O module object in the I/O bus folder with the same module ID, the system
automatically associates its I/O points with the newly installed module.
For more information, see section 20.3 “Physical Devices and I/O Module Objects”
on page 617.
20.1.4 I/O Points
After creating an I/O module in the I/O Bus folder, you can create I/O points in the
I/O module. You can create only the I/O point types that are supported by the I/O
module.
For more information, see section 20.12 “I/O Points” on page 631.
20.1.5 Output Override Status
Using an override switch, you can override analog and digital output channels on
I/O modules with the -H option. Program control or manual control can direct the
output of a channel. Graphics, schedules, variable connectors, and other objects
can also control outputs. You can disable the output as well.
For more information, see section 20.21 “Output Override Status” on page 647.
04-16006-04-en, March 2015 Technical
615
20 I/O Modules
20.1 I/O Modules Overview
20.1.6 I/O Module Low Power Mode
In order to save energy, you can place an I/O module in low power. When an I/O
module is in low power, the following conditions apply:
• The I/O module does not report input signals and all physical outputs are
turned off.
• The Module status reports low power.
• The I/O module's LED pattern indicates low power (the slowest green LED
blink pattern, approximately once every 3 seconds)
For more information, see section 20.17 “I/O Module Low Power Mode” on page
641.
Technical 04-16006-04-en, March 2015
616
20 I/O Modules
20.2 I/O Module Workflows
20.2 I/O Module Workflows
When a physical I/O module is connected to an Automation Server, there are two
ways to create an I/O module and its points.
20.2.1 Discover and Create
In WorkStation, follow this sequence to discover a physical I/O module, and then
create the logical module and its points. Use this method to configure an online I/O
module. (Recommended)
Figure: Discover and create workflow
Discover I/O module
Use Device Discovery to identify the I/O modules on the Automation Server. For
more information, see section 20.6 “Discovering an I/O Module” on page 623.
Create I/O module and I/O points
Drag a physical I/O module to the IO bus folder in the System Tree pane to create
the logical module. Then, create the I/O points for the module. For more
information, see section 21.15 “Creating Multiple I/O Points” on page 690.
20.2.2 Create and Discover
In WorkStation, follow this sequence to create a logical I/O module and its points in
the System Tree, and then associate the module with the physical I/O modules
later. Finally, associate each physical I/O module to its logical equivalent in the
System Tree.
04-16006-04-en, March 2015 Technical
617
20 I/O Modules
20.2 I/O Module Workflows
Figure: Create and discover workflow
Create I/O module and I/O points
In the System Tree pane, create logical I/O modules and I/O points.
For more information, see section 20.4 “Creating an I/O Module” on page 618.
For more information, see section 126.2 “Creating Multiple Objects” on page 5309.
Discover and associate I/O module
Use Device Discovery to identify the I/O modules on the Automation Server. Drag a
physical I/O module to an equivalent logical module in the System Tree pane to
assign the module ID, which brings the module online. Then, use the IO Module
Management Tool to view, assign, or unassign the modules.
For more information, see section 20.6 “Discovering an I/O Module” on page 623.
For more information, see section 20.11 “Assigning and Unassigning Logical I/O
Modules” on page 630.
Note
If there is an I/O module object in the I/O bus folder with the same module ID, the
system automatically associates its I/O points with the newly discovered module.
Technical 04-16006-04-en, March 2015
618
20 I/O Modules
20.3 Physical Devices and I/O Module Objects
20.3 Physical Devices and I/O Module
Objects
You add an I/O module by installing the module on the terminal base. If there is an
I/O module object in the I/O bus folder with the same module ID, the system
automatically associates its I/O points with the newly installed module.
There are three possible scenarios here:
• The physical I/O module is the same type as a logical I/O module configured
with the same Module ID.
• The physical I/O module is a different type than a logical I/O module configured
with the same Module ID. For more information, see section 20.20 “Correcting
a Module Type Mismatch” on page 646.
• There is no logical I/O module configured for the position in which the physical
module is inserted. For more information, see section 20.11 “Assigning and
Unassigning Logical I/O Modules” on page 630.
Note
• A logical I/O module is one that was added to the I/O Bus folder.
04-16006-04-en, March 2015 Technical
619
20 I/O Modules
20.4 Creating an I/O Module
20.4 Creating an I/O Module
You create I/O modules so that you can create physical inputs and outputs in the
database even though the I/O module is not physically connected to the system.
For more information, see the I/O Bus Overview topic on WebHelp.
To create an I/O module
1. In WorkStation, in the System Tree pane, select the IO Bus object under the
Automation Server.
2. On the File menu, point to New and then click IO module.
3. In the object types list, select the type of I/O module you want to create.
Continued on next page
Technical 04-16006-04-en, March 2015
620
20 I/O Modules
20.4 Creating an I/O Module
4. In the Name box, type a name for the I/O module.
5. In the Description box, type a description for the I/O module.
6. Click Next.
7. In the Module ID box, select a module ID of Null or 1 to 32 to specify the
position on the I/O bus where the I/O module is to be located. Selecting a
value of Null specifies that the Module ID is non-operational and can be used
as a placeholder to be configured when you wish to assign it to a physical slot.
You can place multiple modules on the Null slot.
Continued on next page
04-16006-04-en, March 2015 Technical
621
20 I/O Modules
20.4 Creating an I/O Module
8. Select Override capability expected if you would like the module to be
override capable.
9. Click Create.
Technical 04-16006-04-en, March 2015
622
20 I/O Modules
20.5 Configuring an I/O Module
20.5 Configuring an I/O Module
You configure an I/O module by modifying the properties on Properties pane.
Because an I/O module is a software object, you configure an I/O point for an I/O
module whether or not the physical I/O module is present.
Tip
An I/O module with a configured status indicates that an I/O point has been
created. This differs from the process of configuring or changing the properties of
the I/O module as described in this procedure. Even if you configure or change
the I/O properties, that does not mean that the I/O module itself is in the
configured state.
For more information, see the I/O Bus Parts topic on WebHelp.
To configure an I/O module
1. In WorkStation, in the System Tree pane, select the IO Bus folder.
2. When the I/O modules display in the System Tree pane, click a selected
module.
Continued on next page
04-16006-04-en, March 2015 Technical
623
20 I/O Modules
20.5 Configuring an I/O Module
3. Click File and then Properties.
Once you create I/O modules and I/O points, you can view the status
attributes for that I/O module in the Properties pane. For example, for every
module associated with an Automation Server, you can see the Online/Offline,
Configured/Unconfigured, and Module type mismatch status.
4. Edit the basic I/O module properties as necessary (for example, set the
module to low power to save energy).
For more information, see section 20.18 “Setting and Recovering an I/O
Module from Low Power” on page 642.
5. Click OK.
Technical 04-16006-04-en, March 2015
624
20 I/O Modules
20.6 Discovering an I/O Module
20.6 Discovering an I/O Module
You discover an I/O module when the I/O module is connected. If physical I/O
modules display in the Hardware subfolder (under the System folder) in the System
Tree pane, you create an I/O module object representing these I/O modules in the
I/O bus.
For more information, see the IO Bus Overview topic on WebHelp.
To discover an I/O module
1. In WorkStation, in the System Tree pane, select the Automation Server
where you want to discover the I/O module.
2. Click the Device Discovery view.
3. In the Select device type box, select Automation Server IO bus.
4. Select the I/O module you want in the Device results pane.
5. Drag the I/O module to the IO Bus folder in order to create logical modules
and points that you can bind to from other system components.
The physical I/O modules are converted into I/O module objects in the I/O Bus
folder.
04-16006-04-en, March 2015 Technical
625
20 I/O Modules
20.7 Creating Multiple I/O Modules
20.7 Creating Multiple I/O Modules
Using the Spreadsheet view, you can quickly create multiple I/O modules, which
you otherwise would create one at a time in the wizard.
For more information, see section 126.1 “Spreadsheet Overview” on page 5305.
To create multiple I/O modules
1. In WorkStation, in the System Tree pane, select the I/O bus where you want
to create the I/O modules.
2. On the Actions menu, click Edit in spreadsheet.
3. In the Spreadsheet view, select the first row.
4. In the Type column, select the type of I/O module.
5. Enter the rest of the properties, as you would do in the corresponding wizard.
6. Create additional I/O modules using Steps 4-5.
Tip
• You can also copy and paste cells, rows, and entire blocks.
7. On the File menu, click Save.
Technical 04-16006-04-en, March 2015
626
20 I/O Modules
20.8 Updating I/O Module Firmware
20.8 Updating I/O Module Firmware
You upgrade the firmware for an I/O module, or multiple I/O modules of the same
type, if the following conditions are met:
• The Automation Server and the I/O module(s) are online.
• A valid update file is available.
• The I/O module application, or the boot loader (in the event of a prior update
failure) is loaded and running.
• The Module type mismatch property for the I/O module(s) is FALSE.
While I/O modules are being updated, other I/O modules remain operational.
To update I/O modules firmware
1. In WorkStation, in the System Tree pane, right-click the selected I/O
module.
2. Click Update IO module firmware.
3. For multiple I/O modules of the same type, right-click on the IO Bus folder
and then click Update IO module firmware.
Tip
If you right-click on the I/O Bus and perform an upward revision, that
also updates all modules of the same type on the I/O bus.
4. In the Update IO Module File dialog box, locate and select the valid I/O
module firmware file.
5. Click Open to open the I/O module firmware file.
Continued on next page
04-16006-04-en, March 2015 Technical
627
20 I/O Modules
20.8 Updating I/O Module Firmware
6. Click Update Firmware to update the I/O module firmware.
7. Click Save Results to File to save the results to a text file (optional).
8. Click Exit.
Technical 04-16006-04-en, March 2015
628
20 I/O Modules
20.9 Moving an I/O Module
20.9 Moving an I/O Module
You change the Module ID of an I/O module object in the I/O Bus folder that does
not match the physical location of the I/O module on the backplane. You use this
procedure to correct the position of an I/O module object, or use the Spreadsheet
view or Property grid instead. For example, you replace one logical module with
another logical module. The module that is replaced returns to a module ID of Null.
Null specifies that the Module ID is non-operational and can be used as a
placeholder to be configured when you wish to assign it to a physical slot.
To move an I/O module
1. In WorkStation, in the System Tree pane, expand the IO Bus.
2. On the Actions menu, click IO module management tool.
3. In the IO Module Management Tool dialog box, drag and drop the desired
I/O module from the Unassigned Modules pane into the row that contains
the matching physical device.
The I/O Module Management Tool application assigns the Module ID to the
I/O module.
You can also drag and drop a physical device, such as an I/O module
hardware device, from the Unassigned Modules pane to an empty position
in the backplane.
4. Unplug the I/O module from the I/O bus.
5. Plug the I/O module into the new location.
Continued on next page
04-16006-04-en, March 2015 Technical
629
20 I/O Modules
20.9 Moving an I/O Module
6. In the IO Module Management Tool window, click Refresh.
The I/O Module Management Tool shows the physical device located at the
new Module ID number.
Note
• After you change the position of an I/O module, the I/O module
object and its I/O points in the Automation Server are bound to
the new physical position. The I/O module ID has been changed
and the I/O module is online. Applications bound to moved
points are still operational and running with as little interruption as
possible.
7. Click Exit.
Technical 04-16006-04-en, March 2015
630
20 I/O Modules
20.10 Recovering from an I/O Module Failure
20.10 Recovering from an I/O Module Failure
If a physical I/O device fails, you should be able to remove and replace that device
with a physical I/O device of the same type without powering down the I/O bus. The
replacement physical I/O device is automatically configured with the same I/O
points as the original physical I/O device.
For more information, see section 20.3 “Physical Devices and I/O Module Objects”
on page 617.
To recover from an I/O module failure
1. Remove the physical I/O device from the IO Bus and replace it with a physical
I/O device of the same type.
You can do this with the I/O Bus power on.
2. In the IO Module Management Tool, verify that the physical device
displays in the proper location.
3. When finished, click Exit.
04-16006-04-en, March 2015 Technical
631
20 I/O Modules
20.11 Assigning and Unassigning Logical I/O Modules
20.11 Assigning and Unassigning Logical I/O
Modules
You use the I/O Module Management Tool to assign and unassign logical I/O
modules to a physical device.
For more information, see section 20.3 “Physical Devices and I/O Module Objects”
on page 617.
To assign and unassign Logical I/O modules
1. In the System Tree pane, expand the IO Bus.
2. On the Actions menu, click IO module management tool.
3. In the IO Module Management Tool dialog box, observe the Physical
device type and IO module name columns.
The Physical device type column lists the physical devices connected to
the Automation Server, while the I/O module name column lists the logical
modules located in the IO Bus folder.
4. In the Unassigned Modules pane, drag and drop unassigned modules to
assign them to a physical device.
5. Drag and drop logical modules into the Unassigned Modules pane to
unassign them (module ID of Null).
6. Click Refresh to update the IO Module Management Tool.
7. Click Exit.
You can visualize physical devices, Module ID positions and the status of the I/O
modules assigned to them using the IO Module Management Tool window.
Technical 04-16006-04-en, March 2015
632
20 I/O Modules
20.12 I/O Points
20.12 I/O Points
After creating an I/O module in the I/O Bus folder, you can create I/O points in the
I/O module. You can create only the I/O point types that are supported by the I/O
module.
20.12.1 I/O Point Types
An I/O module input point can be one of the following types:
• Counter Input
• Current Input
• Digital Input
• Resistive Input
• 2-Wire RTD Resistive Input
• 3-Wire RTD Resisitive Input
• Supervised Input
• Temperature Input
• 2-Wire RTD Temperature Input
• 3-Wire RTD Temperature Input
• Voltage Input
An I/O module output point can be one of the following types:
• Current Output
• Voltage Output
• Digital Output
• Digital Pulsed Output
• Tristate Output
• Tristate Pulsed Output
For more information, see section 21.1 “I/O Point Types” on page 663.
20.12.2 2-Wire RTD-DI-16 Temperature Input Wiring
Resistance
In the 2-wire RTD temperature input point, you determine the wiring resistance by
direct calculation, or by measuring it instead.
For more information, see section 21.8 “2-Wire RTD-DI-16 Temperature Input
Wiring Resistance” on page 678.
04-16006-04-en, March 2015 Technical
633
20 I/O Modules
20.12 I/O Points
20.12.3 2-Wire or 3-Wire RTD-DI-16 Temperature
Input Values and Reliability Levels
In the 2-wire or 3-wire RTD temperature input point, the raw resistance value is
used to help determine the temperature input value.
For more information, see section 21.9 “2-Wire or 3-Wire RTD-DI-16 Temperature
Input Value and Reliability Levels” on page 679.
20.12.4 Reliability of I/O Points
All I/O points have a property which describes the reliability or quality of the value.
This property is displayed in the Status Information group of the Properties pane for
the I/O point.
For more information, see section 21.16 “Reliability of I/O Points” on page 692.
20.12.5 Forced I/O Point Values
You can force the value of an input point or the requested value of an output point.
Forcing a value disables the input or output point from receiving values from either a
hardware device or software program.
For more information, see section 21.18 “Forced I/O Point Values” on page 694.
20.12.6 I/O Point Scaling
Scaling applies a mathematical factor that compares the internal values in the
system to and from the physical input and output points on an I/O module. The
scaling is linear and can include both positive and negative slopes.
For more information, see section 21.21 “I/O Point Scaling” on page 698.
20.12.7 Implicit Trend Logs for I/O Points
When you create an I/O point on an I/O module, the system automatically creates
an implicit trend log for that I/O point. The implicit trend log logs the Value of the I/O
point in a Change of Value type trend log.
For more information, see section 21.23 “Implicit Trend Logs for I/O Points” on
page 705.
20.12.8 Input Point Offsets
An offset is a value added to or subtracted from the engineering value before it
impacts the input point's Value property. For example, assume that a Thermistor
input is housed in a wiring closet. If you know the temperature in that closet is 2 °C
higher than the temperature outside the closet, you enter -2,0 as the offset value.
For more information, see section 21.24 “Input Point Offsets” on page 706.
Technical 04-16006-04-en, March 2015
634
20 I/O Modules
20.12 I/O Points
20.12.9 Threshold Settings for I/O Points
The threshold is the minimum change of value before the I/O module reports the
value to the Automation Server. Properly setting the threshold value reduces
unnecessary communication between the I/O module and the Automation Server.
For more information, see section 21.27 “Threshold Settings for I/O Points” on page
712.
04-16006-04-en, March 2015 Technical
635
20 I/O Modules
20.13 Creating Multiple Objects
20.13 Creating Multiple Objects
Using the Spreadsheet view, you can quickly create multiple objects, such as I/O
modules, I/O points, values, alarms, and trend logs.
For more information, see section 126.1 “Spreadsheet Overview” on page 5305.
To create multiple objects
1. In WorkStation, in the System Tree pane, select where you want to create
the objects.
2. On the Actions menu, click Edit in spreadsheet.
3. In the Spreadsheet view, click the button and select which type of
objects you want to set up.
Note
• The content of an I/O bus, I/O module, a Modbus interface, or a
Modbus device opens up directly in the Spreadsheet view.
4. In the first row of the Type column, select the object type.
Continued on next page
Technical 04-16006-04-en, March 2015
636
20 I/O Modules
20.13 Creating Multiple Objects
5. Enter the rest of the properties, as you would do in the corresponding wizard.
Tip
You can use the shortcut key Ctrl + U to change the engineering unit
of a value in the Spreadsheet view.
6. Create additional objects using Steps 4-5.
Tip
• You can also copy and paste cells, rows, and entire blocks.
7. On the File menu, click Save.
04-16006-04-en, March 2015 Technical
637
20 I/O Modules
20.14 Configuring Multiple Objects
20.14 Configuring Multiple Objects
Using the Spreadsheet view, you can quickly configure collections of objects,
such as I/O modules, I/O points, values, alarms, and trend logs, objects that you
otherwise would configure one at a time in their respective property dialog boxes.
For more information, see section 126.1 “Spreadsheet Overview” on page 5305.
Configuring Multiple Objects
1. In WorkStation, in the System Tree pane, select the collection of objects that
you want to configure.
2. On the Actions menu, click Edit in spreadsheet.
3. In the Spreadsheet view, edit the objects.
Tip
You can use the shortcut key Ctrl + U to change the engineering unit
of a value in the Spreadsheet view.
4. On the File menu, click Save.
A progress view indicates that Building Operation is saving your changes. If a
problem occurs, the save is cancelled and an error message is displayed.
Technical 04-16006-04-en, March 2015
638
20 I/O Modules
20.15 Copying from MS Excel to Spreadsheet View
20.15 Copying from MS Excel to Spreadsheet
View
You can copy cells, rows, or an entire worksheet from Microsoft Excel and then
paste the data into the Spreadsheet view in WorkStation.
For more information, see section 126.1 “Spreadsheet Overview” on page 5305.
Tip
• The columns and the format of the cells, such as enumerations (date, time,
and so on) and language, must match the setup in the Spreadsheet view.
To copy from MS Excel to Spreadsheet view
1. In WorkStation, in the System Tree pane, select the server, the I/O bus, the
I/O module, or the folder where you want to paste data.
2. On the Actions menu, click Edit in spreadsheet.
3. Open the MS Excel spreadsheet from where you want to copy data.
4. Select the data that you want to paste to the WorkStation Spreadsheet
view.
5. Press CTRL-C.
Continued on next page
04-16006-04-en, March 2015 Technical
639
20 I/O Modules
20.15 Copying from MS Excel to Spreadsheet View
6. In WorkStation, in the Spreadsheet view, select the cell or the rows where
you want to paste the data.
7. Press CTRL-V.
8. On the File menu, click Save.
The pasted data is saved in the WorkStation Spreadsheet view. If any of the data
would have been invalid according to cell formatting, column order, or just missing
data, a dialog box would have notified you about it. For example, the paste included
an invalid value in the Type column because of an empty input type.
In case of invalid data, you can either go back to MS Excel, correct the data, copy
and paste it again, or you could insert it anyways and correct the data in the
Spreadsheet view.
Technical 04-16006-04-en, March 2015
640
20 I/O Modules
20.16 Copying from Spreadsheet View to MS Excel
20.16 Copying from Spreadsheet View to MS
Excel
You can copy column headers, cells, and rows from the Spreadsheet view in
WorkStation and then paste the data into an MS Excel spreadsheet.
For more information, see section 126.1 “Spreadsheet Overview” on page 5305.
To copy from Spreadsheet view to MS Excel
1. In WorkStation, in the System Tree pane, select the server, the I/O bus, the
I/O module, or the folder where you want to copy data.
2. On the Actions menu, click Edit in spreadsheet.
3. Right-click anywhere in the Spreadsheet view, and then select Copy
column headers.
4. Open a new MS Excel spreadsheet.
Continued on next page
04-16006-04-en, March 2015 Technical
641
20 I/O Modules
20.16 Copying from Spreadsheet View to MS Excel
5. Press CTRL-V.
6. In WorkStation, in the Spreadsheet view, select the cells or the rows that
you want to paste into the MS Excel spreadsheet.
7. Press CTRL-C.
8. In the MS Excel spreadsheet, select where you want to paste the data, and
then press CTRL-V.
9. Save the MS Excel spreadsheet.
Technical 04-16006-04-en, March 2015
642
20 I/O Modules
20.17 I/O Module Low Power Mode
20.17 I/O Module Low Power Mode
In order to save energy, you can place an I/O module in low power. When an I/O
module is in low power, the following conditions apply:
• The I/O module does not report input signals and all physical outputs are
turned off.
• The Module status reports low power.
• The I/O module's LED pattern indicates low power (the slowest green LED
blink pattern, approximately once every 3 seconds)
When you set an I/O module to low power, the software turns off all outputs.
When you want to recover an I/O module from low power, there are several points
you should consider:
• Make sure you set all I/O module Output values to a safe level before you return
to normal power conditions. This prevents "power surge" conditions.
• After normal power resumes, the Output values you set are reached
immediately after any timing delay occurs.
04-16006-04-en, March 2015 Technical
643
20 I/O Modules
20.18 Setting and Recovering an I/O Module from Low Power
20.18 Setting and Recovering an I/O Module
from Low Power
You place an I/O module in low power mode in order to save energy and then
recover that module later.
For more information, see section 20.17 “I/O Module Low Power Mode” on page
641.
To set and recover an I/O module from low power
1. In WorkStation, in the System Tree pane, expand the IO Bus.
2. Click the I/O module that you want to put in Low power mode.
3. Click File and then Properties.
4. Under Configuration Settings, in the Low power box, select True.
5. Click OK to change the value and close the Properties tab.
Continued on next page
Technical 04-16006-04-en, March 2015
644
20 I/O Modules
20.18 Setting and Recovering an I/O Module from Low Power
If the physical I/O module, shown in the System Hardware folder, matches the
logical I/O module defined in the I/O Bus, the I/O module goes into Low
power.
After the physical module enters low power, the Module status attribute in the
Status Information area displays Low power.
6. In the System Tree pane, expand the IO Bus to recover from low power
mode.
7. Click the I/O module you wish to recover.
8. Click File and then Properties.
9. Under Configuration Settings, in the Low power box, select False.
10. Click OK to change the value and close the Properties pane.
If the physical I/O module, shown in the System Hardware folder, matches the
logical I/O module defined in the I/O Bus folder, the I/O module exits from low
power. After the module resumes operation from low power, the Module
status returns to the status it had before it went into Low power.
04-16006-04-en, March 2015 Technical
645
20 I/O Modules
20.19 Printing a Label to Identify I/O Channels
20.19 Printing a Label to Identify I/O Channels
You print labels to identify I/O channels on the placard of the I/O module much the
same way you label circuits on an electrical panel. You accept the default names for
the I/O point’s label text property or customize the I/O point’s names for your own
application.
Note
• You cannot print a label for an I/O module with a Module ID of Null.
• I/O points with a channel of Null do not show up in the label.
To print labels to identify I/O channels
1. In WorkStation, in the System Tree pane, expand the IO Bus.
2. In the List View, right-click the selected I/O module, the entire IO Bus folder,
or multiple I/O modules.
3. Click Print IO module labels.
Note
• The label text prints in red if the text is too long to fit on the label.
Continued on next page
Technical 04-16006-04-en, March 2015
646
20 I/O Modules
20.19 Printing a Label to Identify I/O Channels
4. In the Print IO Module Labels dialog box, select Blank Label Text to print
labels with only the channel number with no additional label text.
5. Use the Paper Type drop-down list to select a paper type.
6. Click Print to print the I/O module label or Save to save any changes to the
point’s label text property.
The I/O module label is properly sized to fit on the placard of the I/O module.
04-16006-04-en, March 2015 Technical
647
20 I/O Modules
20.20 Correcting a Module Type Mismatch
20.20 Correcting a Module Type Mismatch
You correct a module type mismatch using the I/O Module Management Tool.
For more information, see section 20.3 “Physical Devices and I/O Module Objects”
on page 617.
To correct a module type mismatch
1. In WorkStation, in the System Tree pane, expand the IO Bus.
2. On the Actions menu, click IO module management tool.
3. In the IO Module Management Tool dialog box, observe whether the
logical I/O Module type matches the type of physical device.
If not, the Module type mismatch property of the logical I/O module object
is TRUE, the table row displays in red, and an error message displays when
you hold the cursor over the row.
4. Fix this mismatch by physically replacing the mismatched I/O module with a
module of the correct type, or by dragging the logical I/O module out of the
row.
Tip
Moving the logical I/O module into the Unassigned Modules list removes any
association of the I/O module with the physical device.
Technical 04-16006-04-en, March 2015
648
20 I/O Modules
20.21 Output Override Status
20.21 Output Override Status
Using an override switch, you can override analog and digital output channels on
I/O modules with the -H option. Program control or manual control can direct the
output of a channel. Graphics, schedules, variable connectors, and other objects
can also control outputs. You can disable the output as well.
You can set the output Override switch to one of three possible positions.
Table: Output Override Switch Positions
Switch Position Action
Hand Analog – Use the potentiometer to manually
adjust the voltage or current output.
Programs have no effect on the Output in
this position.
Hand Digital – Output relay is energized to an “ON”
state manually. Programs have no effect on
the Output in this position.
Auto Programs control the output.
Off Analog – The voltage or current is set to
zero. Programs have no effect on the Output
in this position.
Off Digital – The output relay is de-energized to
an “OFF” state manually. Programs have no
effect on the Output in this position.
The Override state is displayed in the Properties tab for the Output point. If the
Override State is True, the Output is overridden. The Override value takes
precedence over other values.
Figure: Output Override State
04-16006-04-en, March 2015 Technical
649
20 I/O Modules
20.22 Overriding a Digital Output
20.22 Overriding a Digital Output
You take manual control of an output on an I/O module with an override switch (-H
models). Module names with an -H indicate the presence of Hand-Off-Auto override
switches.
For more information, see section 20.21 “Output Override Status” on page 647.
To override a digital output
1. On the I/O hardware module, manually set the override switch from AUTO to
HAND, or OFF for a digital I/O point.
For example, observe the position of the override switches on a DO-FC-8-H
(digital output, form C relay, 8 channel) I/O module.
Tip
There is a separate override switch for each I/O point.
2. View the results of a digital output override by expanding the IO Bus folder
and clicking the selected I/O module.
3. In the List View, click the I/O point.
Continued on next page
Technical 04-16006-04-en, March 2015
650
20 I/O Modules
20.22 Overriding a Digital Output
4. Click File and Properties.
5. Under Status Information, verify the Override status and Value.
Tip
You can also add the value to the Watch pane to view a dynamic
updating of the value.
04-16006-04-en, March 2015 Technical
651
20 I/O Modules
20.23 Overriding an Analog Output
20.23 Overriding an Analog Output
You take manual control of an output on an I/O module with an override switch (-H
models). Analog outputs have a potentiometer and an override switch. The output
channel follows the state of the override switch and/or potentiometer.
For more information, see section 20.21 “Output Override Status” on page 647.
To override an analog output
1. Manually set the override switch from AUTO to HAND or OFF for an analog I/O
point.
For example, observe the position of the potentiometers and override switches
on a AO-8-H (analog output, 8 channel) I/O module.
2. On the I/O hardware module, adjust the potentiometer to set the current or
voltage level.
3. Override a voltage or current output by setting the override switch to HAND
and then adjusting the output level using the potentiometer.
4. Override an output to 0 by setting the override switch to OFF.
There is a separate potentiometer and override switch for each I/O point.
5. View the results of an analog output override by expanding the IO Bus folder.
6. Click the selected I/O module and then click the I/O point in the List View.
Continued on next page
Technical 04-16006-04-en, March 2015
652
20 I/O Modules
20.23 Overriding an Analog Output
7. Click File and then Properties.
8. Under Status Information, verify the Override status and Value.
Tip
You can also add the value to the Watch pane to view a dynamic
updating of the value.
04-16006-04-en, March 2015 Technical
653
20 I/O Modules
20.24 Associating an Engineering Unit with Property Values
20.24 Associating an Engineering Unit with
Property Values
You associate an engineering unit, such as current, voltage, temperature and so on,
with certain property values in the Properties pane.
Note
• Engineering units are also used for conversions to/from other applications
such as Script and Function Block programs.
For more information, see section 21.1 “I/O Point Types” on page 663.
To associate an engineering unit with property values
1. In WorkStation, in the System Tree pane, expand the IO Bus.
2. Right-click the I/O module that you want.
3. In the List View, click the I/O point and then File and Properties.
4. In the Basic tab, click the Configure Settings icon next to the Value.
5. For Value, ensure that the checkbox to the left of the Unit field is checked
and then click the browse ( ) button.
6. In the Unit selection dialog box, select and expand a Units category (for
example, Current). Then, select a unit (for example, A for Amps).
Continued on next page
Technical 04-16006-04-en, March 2015
654
20 I/O Modules
20.24 Associating an Engineering Unit with Property Values
7. Select a Prefix (for example, m for milli-). In this example, the Selected unit
is mA (milli amps).
8. Click Select to select the engineering unit.
9. Click OK to save the point.
The engineering unit becomes associated with the numeric value and is displayed
with the value when the user interface is refreshed. Also, any other values on this
I/O point that have configurable engineering units are also changed to the new
value.
04-16006-04-en, March 2015 Technical
655
20 I/O Modules
20.25 Inserting a New Module in the Middle of an Existing I/O Bus
20.25 Inserting a New Module in the Middle of
an Existing I/O Bus
You insert a new module in the middle of an existing I/O bus by:
• Unassigning the module IDs of any modules after the insertion address
• Physically installing the new I/O module
For more information, see the I/O Bus Overview topic on WebHelp.
To insert a new module in the middle of an existing I/O bus
1. In WorkStation, in the System Tree pane, expand the I/O bus.
2. On the Actions menu, click IO module management tool.
3. Unassign the module IDs of any modules after the address where you are
inserting the new module by dragging and dropping the modules to the
Unassigned Modules pane.
Continued on next page
Technical 04-16006-04-en, March 2015
656
20 I/O Modules
20.25 Inserting a New Module in the Middle of an Existing I/O Bus
4. Physically insert the new I/O module.
Continued on next page
04-16006-04-en, March 2015 Technical
657
20 I/O Modules
20.25 Inserting a New Module in the Middle of an Existing I/O Bus
5. Set the new module IDs from Unassigned to their new address by dragging
the module IDs from the Unassigned Modules pane to the row with the
physical device.
Technical 04-16006-04-en, March 2015
658
20 I/O Modules
20.26 Resolving I/O Module Device Address Changed and Blacklisted Device Detection Errors
20.26 Resolving I/O Module Device Address
Changed and Blacklisted Device
Detection Errors
You resolve I/O module device address changed and blacklisted device detection
errors to remove any related alarms, and return module control and communication
to normal.
For more information, see section 150.4 “Device Address Changed” on page 5526.
For more information, see section 150.5 “Blacklisted Device Detected” on page
5527.
To resolve I/O module device address changed and blacklisted
device detected errors
1. In WorkStation, in the System Tree pane, expand the I/O bus.
2. On the Actions menu, click IO module management tool.
Note
The Device ProductSN and Blacklisted ProductSN columns
only display when the system detects an IO module device address
change or blacklisted device error on an Automation Server.
Continued on next page
04-16006-04-en, March 2015 Technical
659
20 I/O Modules
20.26 Resolving I/O Module Device Address Changed and Blacklisted Device Detection Errors
3. Find the first highlighted address in the Blacklisted ProductsSN field.
Notice that the first serial number in the Blacklisted ProductSN column is
at module ID 4. The terminal base has likely been damaged.
4. Replace the lowest slot ID terminal base reporting the error as well as the
terminal base preceding this slot ID. Here, the terminal base at both ID 3 and 4
should be replaced.
5. Click Refresh.
If the highlighted addresses display in yellow, the serial numbers now match
the devices in order.
6. Verify that the I/O modules match the physical device configuration.
Continued on next page
Technical 04-16006-04-en, March 2015
660
20 I/O Modules
20.26 Resolving I/O Module Device Address Changed and Blacklisted Device Detection Errors
7. Click Accept Blacklisted Devices to resolve the error and resume normal
operation.
8. Click Yes to reset the I/O modules and use the new address.
Continued on next page
04-16006-04-en, March 2015 Technical
661
20 I/O Modules
20.26 Resolving I/O Module Device Address Changed and Blacklisted Device Detection Errors
9. Click Refresh to verify that the blacklist is no longer displayed and the
modules have returned to their normal state.
10. Click Exit.
Technical 04-16006-04-en, March 2015
662
21 I/O Points
Topics
I/O Point Types
Creating an I/O Module Input Point
Creating an I/O Module Output Point
Creating an I/O Module Digital Input
Creating an I/O Module Counter Input
Creating an I/O Module Temperature Input
Creating an I/O Module 2-Wire or 3-Wire RTD Temperature
Input
2-Wire RTD-DI-16 Temperature Input Wiring Resistance
2-Wire or 3-Wire RTD-DI-16 Temperature Input Value and
Reliability Levels
Creating an I/O Module 2-Wire or 3-Wire RTD Resistive
Input
Creating an I/O Module Voltage Input
Creating an I/O Module Digital Output
Creating an I/O Module Voltage Output
Configuring I/O Module Input or Output Points
Creating Multiple I/O Points
Reliability of I/O Points
Reviewing the Reliability of I/O Point Values
Forced I/O Point Values
Forcing Input Values
Forcing Output Values
I/O Point Scaling
Scaling an Input or Output I/O Point
Implicit Trend Logs for I/O Points
Input Point Offsets
Configuring Offsets for Input Points
Printing a Wiring List for the I/O Bus
Threshold Settings for I/O Points
21 I/O Points
21.1 I/O Point Types
21.1 I/O Point Types
After creating an I/O module in the I/O Bus folder, you can create I/O points in the
I/O module.
An I/O module input point can be one of the following types:
• Counter Input
• Current Input
• Digital Input
• Resistive Input
• 2-Wire RTD Resistive Input
• 3-Wire RTD Resisitive Input
• Supervised Input
• Temperature Input
• 2-Wire RTD Temperature Input
• 3-Wire RTD Temperature Input
• Voltage Input
An I/O module output point can be one of the following types:
• Current Output
• Voltage Output
• Digital Output
• Digital Pulsed Output
• Tristate Output
• Tristate Pulsed Output
21.1.1 Valid Point Types for I/O Modules
You can create only the I/O point types that are supported by the I/O module. The
following table displays the valid point types for each of the I/O modules.
Table: I/O Points Associated with Various I/O Modules
I/O Module Module Type I/O Point Types
AO-8 Output Current Output, Voltage
Output
AO-V-8 Output Voltage Output
DI-16 Input Counter Input, Digital Input
DO-FA-12 Output Digital Output, Digital Pulsed
Output, Tristate Output,
Tristate Pulsed Output
04-16006-04-en, March 2015 Technical
665
21 I/O Points
21.1 I/O Point Types
Continued
I/O Module Module Type I/O Point Types
DO-FC-8 Output Digital Output, Digital Pulsed
Output, Tristate Output,
Tristate Pulsed Output
RTD-DI-16 Input 2-Wire RTD Resistive Input,
2-Wire RTD Temperature
Input, 3-Wire RTD Resistive
Input, 3-Wire RTD
Temperature Input, Counter
Input, Digital Input, Resistive
Input
UI-8/AO-4 Mixed (Input and Output) Counter Input, Current Input,
Digital Input, Resistive Input,
Supervised Input,
Temperature Input, Voltage
Input
Current Output, Voltage
Output
UI-8/AO-V-4 Mixed (Input and Output) Counter Input, Current Input,
Digital Input, Resistive Input,
Supervised Input,
Temperature Input, Voltage
Input
Voltage Output
UI-8/DO-FC-4 Mixed (Input and Output) Counter Input, Current Input,
Digital Input, Resistive Input,
Supervised Input,
Temperature Input, Voltage
Input
Digital Output, Digital Pulsed
Output, Tristate Output,
Tristate Pulsed Output
UI-16 Input Counter Input, Current Input,
Digital Input, Resisitive Input,
Supervised Input,
Temperature Input, Voltage
Input
You assign each I/O point a channel in the I/O module as part of the configuration
process. The channel represents where the point is physically wired to the I/O
module.
21.1.2 Null Value Selection
By selecting the Null value as the physical input or output channel on the I/O
module, you specify that the input or output point is non-operational and can be
used as a placeholder to be configured when you wish to assign it to a physical
channel. You can place multiple input or output points on the Null channel.
Technical 04-16006-04-en, March 2015
666
21 I/O Points
21.1 I/O Point Types
The input or output channel number is unique to logical input or output points. For
example, a UI-8/DO-FC-4 module can have a Digital Output point on output
channel 1 and a Temperature Input point on input channel 1. The input and output
are different physical slots.
21.1.3 I/O Point Binding
A binding is an association between an I/O point and another object. Script and
Function Block programs, Graphics, and Trends are some examples of these
objects. You access the Bindings view to select the object that you want to bind to
the I/O point.
Figure: I/O Point Binding
For more information, see section 38.10 “Binding Values Using a Binding Template”
on page 1220.
04-16006-04-en, March 2015 Technical
667
21 I/O Points
21.2 Creating an I/O Module Input Point
21.2 Creating an I/O Module Input Point
You create an I/O module input point by selecting the I/O module and then the type
of point you want to create from the list of available points.
For more information, see section 21.1 “I/O Point Types” on page 663.
To create an I/O module input point
1. In WorkStation, in the System Tree pane, select an I/O module.
2. On the File menu, point to New and then click Input point.
3. In the object type list, select the type of point, for example, a Current Input
point.
4. In the Name box, enter a name for the I/O point.
5. In the Description box, enter the description of the I/O point.
6. Click Next.
Continued on next page
Technical 04-16006-04-en, March 2015
668
21 I/O Points
21.2 Creating an I/O Module Input Point
7. In the Input channel box, select the channel that corresponds to the
terminal connection on the I/O module where the point will be wired.
8. In the Label text box, enter text to identify the I/O point on the I/O module
label.
The other parameters that appear on the Basic Settings page are specific to
the type of I/O point you create.
For more information, see the New Input Point Configuration Wizard – Basic
Settings Page topic on WebHelp.
Tip
Choosing a channel number of Null creates a non-operational I/O
point on the I/O module that you can use as a placeholder until an
actual Channel number is established for the point. Also, if you
choose to click Create before going to the Basic Settings page,
you can set the I/O point properties at a later time. For more
information, see section 21.14 “Configuring I/O Module Input or
Output Points” on page 689.
9. Enter the I/O point properties that you want and then click Create.
A Progress view displays indicating that the configuration changes are being
saved to the database.
04-16006-04-en, March 2015 Technical
669
21 I/O Points
21.3 Creating an I/O Module Output Point
21.3 Creating an I/O Module Output Point
You create an I/O module output point by selecting the I/O module and then the
type of point you want to create from the list of available points.
For more information, see section 21.1 “I/O Point Types” on page 663.
To create an I/O module output point
1. In WorkStation, in the System Tree pane, select an I/O module.
2. On the File menu, point to New and then click Output point.
3. In the object type list, select the type of point, for example, a Digital Pulsed
Output point.
4. In the Name box, enter a name for the I/O point.
5. In the Description box, enter the description of the I/O point.
6. Click Next.
Continued on next page
Technical 04-16006-04-en, March 2015
670
21 I/O Points
21.3 Creating an I/O Module Output Point
7. In the Output channel box, select the channel that corresponds to the
terminal connection on the I/O module where the output point is wired.
8. In the Label text box, enter text to identify the I/O point on the I/O module
label.
The other parameters that appear on the Basic Settings page are specific to
the type of I/O point you create.
For more information, see the New Output Point Configuration Wizard – Basic
Settings Page topic on WebHelp..
9. Enter the I/O point properties that you want and then click Create.
A Progress view displays indicating that the configuration changes are being
saved to the database.
04-16006-04-en, March 2015 Technical
671
21 I/O Points
21.4 Creating an I/O Module Digital Input
21.4 Creating an I/O Module Digital Input
You create digital inputs to represent where the points are physically wired to the
I/O module.
For more information, see section 21.1 “I/O Point Types” on page 663.
To create an I/O module digital input
1. In WorkStation, in the System Tree pane, select the I/O module you want to
add a digital input for.
2. On the File menu, point to New and then click Input point.
3. In the object type list, select Digital Input.
4. In the Name box, type a name for the digital input.
5. In the Description box, type a description for the digital input.
6. Click Next.
Continued on next page
Technical 04-16006-04-en, March 2015
672
21 I/O Points
21.4 Creating an I/O Module Digital Input
7. In the Input channel box, select the channel that corresponds to the
terminal connection on the I/O module where the digital input is wired.
8. In the Label text box, type a label text to identify the digital input on the I/O
module label.
9. In the Invert box, select True to invert the value logically.
10. In the LED color box, select Green to make the LED green when it is lit.
11. In the LED invert box, select True to make the LED lit when the digital input
is off.
12. Click Create.
04-16006-04-en, March 2015 Technical
673
21 I/O Points
21.5 Creating an I/O Module Counter Input
21.5 Creating an I/O Module Counter Input
You create counter inputs to represent where the points are physically wired to the
I/O module.
For more information, see section 21.1 “I/O Point Types” on page 663.
To create an I/O module counter input
1. In WorkStation, in the System Tree pane, select the I/O module you want to
add a digital input for.
2. On the File menu, point to New and then click Input point.
3. In the object type list, select Counter Input.
4. In the Name box, type a name for the counter input.
5. In the Description box, type the description for the counter input.
6. Click Next.
Continued on next page
Technical 04-16006-04-en, March 2015
674
21 I/O Points
21.5 Creating an I/O Module Counter Input
7. In the Input channel box, select the channel that corresponds to the
terminal connection on the I/O module where the counter input will be wired.
8. In the Label text box, type label text to identify the counter input on the I/O
module label.
9. In the Invert box, select True to invert the value logically.
10. In the LED color box, select Green to make the light green when it is lit.
11. In the LED invert box, select True to make the LED lit when the counter
input is off.
12. Click Create.
04-16006-04-en, March 2015 Technical
675
21 I/O Points
21.6 Creating an I/O Module Temperature Input
21.6 Creating an I/O Module Temperature
Input
You create temperature inputs to represent where the sensors are physically wired
to the I/O module.
For more information, see section 21.1 “I/O Point Types” on page 663.
To create an I/O module temperature input
1. In WorkStation, in the System Tree pane, select the I/O module you want to
add a temperature input for.
2. On the File menu, point to New and then click Input point.
3. In the object type list, select Temperature Input.
4. In the Name box, type a name for the temperature input.
5. In the Description box, type a description for the temperature input.
6. Click Next.
Continued on next page
Technical 04-16006-04-en, March 2015
676
21 I/O Points
21.6 Creating an I/O Module Temperature Input
7. In the Input channel box, select the channel that corresponds to the
terminal connection on the I/O module where the temperature input is wired.
8. In the Label text box, type a label text to identify the temperature input on the
I/O module label.
9. In the Digital filter box, select True to filter out noise and prevent false
readings.
10. In the Threshold box, enter the minimum change of value before it is sent to
the Automation Server.
11. In the Thermistor type box, select the connected thermistor type.
12. In the Offset box, enter the offset value you want added to or subtracted
from the engineering value before it affects the point's value property.
13. In the Upper reliability level box, enter the upper value that indicates an
inaccurate sensor reading.
14. In the Lower reliability level box, enter the lower value that indicates an
inaccurate sensor reading.
15. Click Create.
04-16006-04-en, March 2015 Technical
677
21 I/O Points
21.7 Creating an I/O Module 2-Wire or 3-Wire RTD Temperature Input
21.7 Creating an I/O Module 2-Wire or 3-
Wire RTD Temperature Input
You create 2-wire or 3-wire RTD temperature inputs to represent where the sensors
are physically wired to the RTD DI-16 I/O module.
Tip
The 3-wire RTD temperature input point is a 3-channel input that requires you to
connect the 2 RTD leads to the 2 inputs and the other lead to the RETurn. For
more information, see the RTD-DI-16 I/O Module topic on WebHelp.
For more information, see section 21.1 “I/O Point Types” on page 663.
To create an I/O module 2-wire or 3-wire RTD temperature
input
1. In WorkStation, in the System Tree pane, select the RTD DI-16 I/O module
to which you want to add a 2-wire or 3-wire RTD temperature input.
2. On the File menu, point to New and then click Input point.
3. In the object type list, select 2-Wire RTD Temperature Input or 3-Wire
RTD Temperature Input.
4. In the Name box, type a name for the 2-wire or 3-wire RTD temperature input.
5. In the Description box, type a description for the 2-wire or 3-wire RTD
temperature input.
6. Click Next.
Continued on next page
Technical 04-16006-04-en, March 2015
678
21 I/O Points
21.7 Creating an I/O Module 2-Wire or 3-Wire RTD Temperature Input
7. In the Input channel box, select the channel that corresponds to the
terminal connection on the I/O module where the 2-wire or 3-wire RTD
temperature input is wired.
8. In the Label text box, type a label text to identify the 2-wire or 3-wire RTD
temperature input on the I/O module label.
9. In the Digital filter box, select True to filter out noise and prevent false
readings.
10. In the Threshold box, enter the minimum change of value before it is sent to
the Automation Server.
11. In the Sensor type box, select the specified sensor type to determine how
the resistance value is converted to temperature.
12. In the Offset box, enter the offset in degrees to the converted temperature
value.
13. In the Upper reliability level box, enter the upper value that indicates an
inaccurate sensor reading.
For more information, see section 21.9 “2-Wire or 3-Wire RTD-DI-16
Temperature Input Value and Reliability Levels” on page 679.
14. In the Lower reliability level box, enter the lower value that indicates an
inaccurate sensor reading.
15. In the Wiring resistance box, enter the wiring resistance.
For more information, see section 21.8 “2-Wire RTD-DI-16 Temperature Input
Wiring Resistance” on page 678.
16. Click Create.
04-16006-04-en, March 2015 Technical
679
21 I/O Points
21.8 2-Wire RTD-DI-16 Temperature Input Wiring Resistance
21.8 2-Wire RTD-DI-16 Temperature Input
Wiring Resistance
In the 2-wire RTD temperature input point, you determine the wiring resistance by
direct calculation, or by measuring it instead.
To calculate the wiring resistance directly, use the following formula:
Resistance per unit length x length x 2 = Wiring resistance
To measure the wiring resistance, attach a 100 or 1000 ohm "reference resistor" to
the end of the wire connected to the sensor. Use the reference resistor to measure
the known resistance. Then, use the following formula to determine the wiring
resistance:
Raw resistance - reference resistance = Wiring resistance
After you determine the wiring resistance, disconnect the reference resistor and
connect the sensor.
Note
Wiring resistance is only available for the 2-wire RTD temperature input point.
Technical 04-16006-04-en, March 2015
680
21 I/O Points
21.9 2-Wire or 3-Wire RTD-DI-16 Temperature Input Value and Reliability Levels
21.9 2-Wire or 3-Wire RTD-DI-16
Temperature Input Value and Reliability
Levels
In the 2-wire or 3-wire RTD temperature input point, the raw resistance value is
used to help determine the temperature input value.
When determining the value, the following equation is used:
Value = ConvertResistanceToTemperature(RawResistance -
WiringResistance) + Offset
where:
ConvertResistanceToTemperature is a function that depends on the Sensor
type property you select.
The raw resistance displays the measured resistance from the RTD without
applying the wiring resistance or offset properties. It represents the unconverted
value before temperature conversion occurs.
The raw resistance to temperature conversion tables for each sensor type, such as
Pt100, Pt1000, Ni1000, and LG_Ni1000, are valid for a range of -50°C to +150°C.
If the raw resistance value is above the resistance value corresponding to +150°C
for that sensor type, the value is reported as Over range. If the raw resistance value
is below the resistance value corresponding to -50°C, the value is reported as
under range.
04-16006-04-en, March 2015 Technical
681
21 I/O Points
21.10 Creating an I/O Module 2-Wire or 3-Wire RTD Resistive Input
21.10 Creating an I/O Module 2-Wire or 3-
Wire RTD Resistive Input
You create 2-wire or 3-wire RTD resistive inputs to represent where the sensors are
physically wired to the RTD DI-16 I/O module.
Tip
The 3-wire RTD temperature input point is a 3-channel input that requires you to
connect the 2 RTD leads to the 2 inputs and the other lead to the RETurn. For
more information, see the RTD-DI-16 I/O Module topic on WebHelp.
For more information, see section 21.1 “I/O Point Types” on page 663.
To create an I/O module 2-wire or 3-wire RTD resistive input
1. In WorkStation, in the System Tree pane, select the RTD DI-16 I/O module
you want to add a 2-wire or 3-wire RTD resistive input for.
2. On the File menu, point to New and then click Input point.
3. In the object type list, select 2-Wire RTD Resistive Input or 3-Wire RTD
Resistive Input.
4. In the Name box, type a name for the 2-wire or 3-wire RTD resistive input.
5. In the Description box, type a description for the 2-wire or 3-wire RTD
resistive input.
6. Click Next.
Continued on next page
Technical 04-16006-04-en, March 2015
682
21 I/O Points
21.10 Creating an I/O Module 2-Wire or 3-Wire RTD Resistive Input
7. In the Input channel box, select the channel that corresponds to the
terminal connection on the I/O module where the 2-wire or 3-wire RTD
resistive input is wired.
8. In the Label text box, type a label text to identify the 2-wire or 3-wire RTD
resistive input on the I/O module label.
9. In the Digital filter box, select True to filter out noise and prevent false
readings.
10. In the Threshold box, enter the minimum change of value before it is sent to
the Automation Server.
11. In the Top of scale engineering value box, enter the top of the range for
the sensor.
12. In the Top of scale electrical value box, enter the top of the range
resistance value for the input point scale.
13. In the Bottom of scale engineering value box, enter the bottom of the
range for the sensor.
14. In the Bottom of scale electrical value box, enter the bottom of the range
resistance value for the input point scale.
15. In the Offset box, enter the offset value you want added to or subtracted
from the engineering value before it affects the point's value property.
16. In the Upper reliability level box, enter the upper value that indicates an
inaccurate sensor reading.
17. In the Lower reliability level box, enter the lower value that indicates an
inaccurate sensor reading.
Continued on next page
04-16006-04-en, March 2015 Technical
683
21 I/O Points
21.10 Creating an I/O Module 2-Wire or 3-Wire RTD Resistive Input
18. In the Sensor class box, select the sensor class to configure the RTD
resistive input for the approximate range it will measure:
• 100 ohm based: measures a range from 50 to 220 ohm
• 1000 ohm based: measures a range from 500 to 2200 ohm
19. Click Create.
Technical 04-16006-04-en, March 2015
684
21 I/O Points
21.11 Creating an I/O Module Voltage Input
21.11 Creating an I/O Module Voltage Input
You create voltage inputs to represent where the points are physically wired to the
I/O module.
For more information, see section 21.1 “I/O Point Types” on page 663.
To create an I/O module voltage input
1. In WorkStation, in the System Tree pane, select the I/O module you want to
add a digital input for.
2. On the File menu, point to New and then click Input point.
3. In the object type list, select Voltage Input.
4. In the Name box, type a name for the voltage input.
5. In the Description box, type the description for the voltage input.
6. Click Next.
Continued on next page
04-16006-04-en, March 2015 Technical
685
21 I/O Points
21.11 Creating an I/O Module Voltage Input
7. In the Input channel box, select the channel that corresponds to the
terminal connection on the I/O module where the voltage input will be wired.
8. In the Label text box, type label text to identify the voltage input on the I/O
module label.
9. In the Digital filter box, select True to filter out noise and prevent false
readings.
10. In the Threshold box, enter the minimum change of value before it is sent to
the Automation Server.
11. In the Top of scale engineering value box, enter the top of the range for
the sensor.
12. In the Top of scale electrical value box, enter the top of the range for the
sensor.
13. In the Bottom of scale engineering value box, enter the top of the range
for the voltage input.
14. In the Bottom of scale electrical value box, enter the top of the range for
the voltage input.
15. In the Unit box, enter the engineering unit for the voltage input.
16. In the Offset box, enter the offset value you want added to or subtracted
from the engineering value before it affects the point's value property.
17. In the Upper reliability level box, enter the upper value that indicates an
inaccurate sensor reading.
18. In the Lower reliability level box, enter the lower value that indicates an
inaccurate sensor reading.
19. Click Create.
Technical 04-16006-04-en, March 2015
686
21 I/O Points
21.12 Creating an I/O Module Digital Output
21.12 Creating an I/O Module Digital Output
You create digital outputs to represent where the points are physically wired to the
I/O module.
For more information, see section 21.1 “I/O Point Types” on page 663.
To create an I/O module digital output
1. In WorkStation, in the System Tree pane, select the I/O module you want to
add a digital output for.
2. On the File menu, point to New and then click Output point.
3. In the object type list, select Digital Output.
4. In the Name box, type a name for the digital output.
5. In the Description box, type a description for the digital output.
6. Click Next.
Continued on next page
04-16006-04-en, March 2015 Technical
687
21 I/O Points
21.12 Creating an I/O Module Digital Output
7. In the Output channel box, select the channel that corresponds to the
terminal connection on the I/O module where the digital output is wired.
8. In the Label text box, type a label text to identify the digital output on the I/O
module label.
9. In the Requested value box, select Off to make the initial value of the first
program cycle off.
10. In the Default output value box, select Off to make the value revert to off if
the I/O module loses communication with the Automation Server for more
than 255 seconds.
11. In the Invert box, select True to invert the value logically.
12. Click Create.
Technical 04-16006-04-en, March 2015
688
21 I/O Points
21.13 Creating an I/O Module Voltage Output
21.13 Creating an I/O Module Voltage Output
You create voltage outputs to represent where the points are physically wired to the
I/O module.
For more information, see section 21.1 “I/O Point Types” on page 663.
To create an I/O module voltage output
1. In WorkStation, in the System Tree pane, select the I/O module you want to
add a voltage output for.
2. On the File menu, point to New and then click Output point.
3. In the object type list, select Voltage Output.
4. In the Name box, type a name for the voltage output.
5. In the Description box, type a description for the voltage output.
6. Click Next.
Continued on next page
04-16006-04-en, March 2015 Technical
689
21 I/O Points
21.13 Creating an I/O Module Voltage Output
7. In the Output channel box, select the channel that corresponds to the
terminal connection on the I/O module where the voltage output is wired.
8. In the Label text box, type a label text to identify the voltage output on the
I/O module label.
9. In the Requested value box, enter a value to make the initial value of the first
program cycle this value.
10. In the Default output value box, enter a value to make the value revert to
this value if the I/O module loses communication with the Automation Server
for more than 255 seconds.
11. In the Threshold box, enter the minimum change of value before it is sent to
the Automation Server.
12. In the Top of scale engineering value box, enter the top of the range
engineering value for the voltage output.
13. In the Top of scale electrical value box, enter the top of the range voltage
value for the voltage output.
14. In the Bottom of scale engineering value box, enter the bottom of the
range engineering value for the voltage output.
15. In the Bottom of scale electrical value box, enter the bottom of the range
voltage value for the voltage output.
16. In the Unit box, enter the engineering unit for the voltage output.
17. Click Create.
Technical 04-16006-04-en, March 2015
690
21 I/O Points
21.14 Configuring I/O Module Input or Output Points
21.14 Configuring I/O Module Input or Output
Points
When you configure input or output points for Automation Server I/O modules, the
data fields that display depend on the type of I/O point you create.
For more information, see section 21.1 “I/O Point Types” on page 663.
To configure I/O module input or output points
1. In WorkStation, in the System Tree pane, select an I/O module that contains
input or output points.
2. In the List View, click the input or output point that you want to configure.
3. Click File and Properties to display the I/O point properties (for example, for
a Digital Output point).
4. Edit the Basic input or output point properties as necessary (for example,
change the Default output value in a Digital Output point).
For more information, see the New Input Point Configuration Wizard – Basic
Settings Page topic on WebHelp.
For more information, see the New Output Point Configuration Wizard – Basic
Settings Page topic on WebHelp.
5. Click OK.
04-16006-04-en, March 2015 Technical
691
21 I/O Points
21.15 Creating Multiple I/O Points
21.15 Creating Multiple I/O Points
Using the Spreadsheet view, you can quickly create multiple I/O points, which you
otherwise would create one at a time in the wizard.
For more information, see section 126.1 “Spreadsheet Overview” on page 5305.
To create multiple I/O points
1. In WorkStation, in the System Tree pane, select the I/O module where you
want to create the I/O points.
2. On the Actions menu, click Edit in spreadsheet.
3. In the Spreadsheet view, select the row with the channel that corresponds
to the terminal connection on the I/O module where the input or output is
wired.
4. In the Type column, select the type of I/O point.
5. Enter the rest of the properties, as you would do in the corresponding wizard.
Tip
You can use the shortcut key Ctrl + U to change the engineering unit
of a value in the Spreadsheet view.
Continued on next page
Technical 04-16006-04-en, March 2015
692
21 I/O Points
21.15 Creating Multiple I/O Points
6. Create additional I/O points using Steps 3-5.
Tip
• You can also copy and paste cells, rows, and entire blocks.
7. On the File menu, click Save.
04-16006-04-en, March 2015 Technical
693
21 I/O Points
21.16 Reliability of I/O Points
21.16 Reliability of I/O Points
All I/O points have a property which describes the reliability or quality of the value.
This property is displayed in the Status Information group of the Properties pane for
the I/O point.
Figure: Reliability of an I/O point
The Reliability property can have one of the following values:
• Reliable – The point and module are online and the input is operating properly.
• Over range – The value is above the Upper reliability level field.
Only current, resistive, supervised, temperature, and voltage inputs can be
over range since they are the only points that contain the Upper reliability level
field.
• Under range – The value is below the Lower reliability level field.
Only current, resistive, supervised, temperature, and voltage inputs can be
under range since they are the only points that contain the Lower reliability level
field.
• Open Circuit – A supervised input is in a TROUBLE state and the measured
input resistance is >60KΩ
• Short Circuit – A supervised input is in a TROUBLE state and the measured
input resistance is <300Ω
• Unreliable – The point is not assigned a channel number, the module
containing this point does not have an online status, or its module type
mismatch is true.
Technical 04-16006-04-en, March 2015
694
21 I/O Points
21.17 Reviewing the Reliability of I/O Point Values
21.17 Reviewing the Reliability of I/O Point
Values
You review the reliability of I/O point values since the system displays the reliability
or quality of data for input/output points.
For more information, see section 21.16 “Reliability of I/O Points” on page 692.
To review the reliability of I/O point values
1. In WorkStation, in the System Tree pane, expand the IO Bus.
2. Click the I/O module that contains the selected I/O points. The I/O points
appear in the List View.
3. Click an I/O point.
4. Click File and then Properties.
5. Review the Reliability property.
The Reliability value contains one of the six possible values listed in a read-only
format.
04-16006-04-en, March 2015 Technical
695
21 I/O Points
21.18 Forced I/O Point Values
21.18 Forced I/O Point Values
You can force the value of an input point or the requested value of an output point.
Forcing a value disables the input or output point from receiving values from either a
hardware device or software program. You can force an input or output point for
some of the following reasons:
• Force an input point to test a software program. For example, if a program was
supposed to branch at a temperature of 27 °C (80.6 °F), you could enter that
value for the selected input point and test the branch.
• Force an output point to turn a device on or off. For example, you could turn off
a chiller for servicing.
Input
For an input I/O point, you can force the Value.
Figure: Force input I/O value
You must select Force in order to force a value. The forced status of an I/O point is
available to graphics and trend logs as part of the Present value.
Output
For an output I/O point, you can force the Requested value.
Technical 04-16006-04-en, March 2015
696
21 I/O Points
21.18 Forced I/O Point Values
Figure: Force output I/O value
When you force an output point, the forced value controls the output, and the
Requested value toggles to Unforce. After you remove the forced condition, the
output returns to the unforced value and the Requested value toggles to Force.
Note
• A manual override takes precedence over a forced value.
04-16006-04-en, March 2015 Technical
697
21 I/O Points
21.19 Forcing Input Values
21.19 Forcing Input Values
You force the value of an input point to disable the input point from receiving values
from either a hardware device or software program. This is useful when you want to
test a software program.
For more information, see section 21.18 “Forced I/O Point Values” on page 694.
To force an input value
1. In WorkStation, in the System Tree pane, expand the IO Bus.
2. Right-click the I/O input point that you want to force.
3. Click File and select Properties.
4. In the Value box, click Force.
5. When the Unforce toggle displays, enter the forced value.
6. Click OK.
The input point is driven to the specificied value.
Technical 04-16006-04-en, March 2015
698
21 I/O Points
21.20 Forcing Output Values
21.20 Forcing Output Values
You force the requested value of an output point to disable the output point from
receiving values from either a hardware device or software program. This is useful
when you want to force an output point to turn a device on or off.
For more information, see section 21.18 “Forced I/O Point Values” on page 694.
To force an output value
1. In WorkStation, in the System Tree pane, expand the IO Bus.
2. Right-click the I/O point you want.
3. Click File and then select Properties.
4. In the Requested value box, click the Force button.
5. When the Unforce toggle displays, enter the requested value.
6. Click OK.
The output point is driven to the Requested value.
04-16006-04-en, March 2015 Technical
699
21 I/O Points
21.21 I/O Point Scaling
21.21 I/O Point Scaling
Scaling applies a mathematical factor that compares the internal values in the
system to and from the physical input and output points on an I/O module. The
scaling is linear and can include both positive and negative slopes.
Example
The Input Voltage range of 0 to 10 VDC measures a light level that ranges from 0 to
1400 Lux. At an input voltage of 1 VDC, the input object would expose 140 Lux.
Scaling applies to both input and output points.
21.21.1 Input Scaling
You can configure the physical inputs of all types, except for Digital, Counter, and
Supervised inputs, to expose the following attributes:
• Calculated value
• Engineering Unit and category
The resulting Engineering Value is the linear interpolation of the configured scale.
The value is not clipped when you configure scaling on an input point. The linear
conversion is applied to the full measureable range of the electrical input.
Scaling parameters appear in the Properties pane of the input point.
Figure: Voltage Input Point Scaling Fields
Input scaling applies to different types of input points.
Table: Input Scaling for Different Input Types
Input Type Electrical Top/Bottom of Engineering Unit Types
Scale (Inputs Converted To)
Voltage 0 to 10 VDC Power, Flow, Acceleration,
Percentage, and so forth
Current 0 to 20 mA Power, Flow, Acceleration,
Percentage and so forth
Resistance 0 to 60 kΩ Resistance input scaling is
expressed in % or fractions
Temperature -50 °C to +150 °C Degrees C, F, and Kelvin
Technical 04-16006-04-en, March 2015
700
21 I/O Points
21.21 I/O Point Scaling
Input Type Electrical Top/Bottom of Engineering Unit Types
Scale (Inputs Converted To)
Table: Thermistor Types
Thermistor Type Resistance
None N/A
10k Type I (Continuum) 10 kΩ
10k Type II (I/NET) 10 kΩ
10k Type III (Satchwell) 10 kΩ
10k Linearized (Satchwell D?T) 10 kΩ
10k Type IV (FD) 10 kΩ
10k Type V (FD w/ 11k shunt) 10 kΩ
1.8k (Xenta) 1.8 kΩ
1k (Balco) 1 kΩ
20k (Honeywell) 20 kΩ
2.2k (Johnson Controls) 2.2 kΩ
21.21.2 Output Scaling
You can configure the physical analog output to receive the following attributes:
• Present (application) value
• Another Engineering Unit (in the same category) and covert it to Electrical Units
Example
A Voltage Output has a range of 0 to 10 VDC which is scaled to equal 0 to 100 %. If
the application value equals 20 %, the Output should be 2 VDC.
The Requested Value and Scaling parameters display in the Properties pane of
the Output point.
04-16006-04-en, March 2015 Technical
701
21 I/O Points
21.21 I/O Point Scaling
Figure: Output Point Requested Value
For Requested value, click the Configure Settings icon to display the
Requested value dialog box. Then, click the checkbox to the left of the Unit field
and the browse ( ) button to display the Unit selection parameter you want.
Technical 04-16006-04-en, March 2015
702
21 I/O Points
21.21 I/O Point Scaling
Figure: Unit Selection Parameters
If the Requested Value is outside of the scaled range, the Voltage or Current
should be limited to the Top of Scale and Bottom of Scale boundaries.
Output scaling is limited to Voltage or Current output types. Scaling can be
configured for either a positive or negative slope.
Table: Output Scaling for Different Input Types
Output Type Electrical Top/Bottom of Engineering Unit Types
Scale (Outputs Converted To)
Voltage 0 to 10 VDC Power, Flow, Acceleration,
Percentage, and so forth
Current 0 to 20 mA Power, Flow, Acceleration,
Percentage and so forth
21.21.3 Pulse Width Modulation Scaling
For digital and tristate pulsed outputs you can configure pulse width modulation
(PWM). Pulse width modulation provides a conditioning algorithm that produces a
pulse train with a specific period and duty cycle. When a digital or tristate pulsed
output is scaled, the output produces a repetitive pulse as configured in the scaling.
04-16006-04-en, March 2015 Technical
703
21 I/O Points
21.21 I/O Point Scaling
Examples
Pulse width modulation scaling can be performed in two ways:
• Using PWM scale parameters of Pulse duration (s) and Period (s), a pulse
duration of 5 seconds and a Period of 20 seconds produces a 5 second pulse
every 20 seconds.
• Using PWM scale parameters of Duty cycle (%) and Period (s), a duty cycle
of 25 % and a Period of 20 seconds produces a 5 second pulse every 20
seconds (25 % of 20 seconds = 5 seconds)
You set these parameters in the Pulse Width Modulation group of the Properties
Pane.
Figure: Pulse Width Modulation Parameters
Technical 04-16006-04-en, March 2015
704
21 I/O Points
21.22 Scaling an Input or Output I/O Point
21.22 Scaling an Input or Output I/O Point
You configure scaling on the physical inputs of all input point types, or on the analog
outputs of output point types. Scaling applies a linear conversion to the value of the
input and output points on an I/O module and can include both positive and
negative slopes.
For more information, see section 21.21 “I/O Point Scaling” on page 698.
To scale an input or output I/O point
1. In the System Tree pane, click the I/O module that contains the desired input
or output I/O point. The I/O points appear in the List View.
2. Click an input or output I/O point (for example, a Current Output point for an
AO-8 module).
3. Click File and Properties.
4. In the Basic tab, enter a value for the Electrical scale top (20mA in this
example) and Electrical scale bottom (4mA in this example).
5. In the Engineering scale top and Engineering scale bottom boxes,
enter values for the top and bottom of the engineering scale range of the
output point.
6. Click OK to insert the scaling factor.
A Progress view displays indicating that the configuration changes are being
saved to the database.
7. In the List View, click on another output I/O point (for example, a Voltage
Output point for an AO-8 module).
8. Click File and Properties.
9. In the Basic tab Engineering scale top and Engineering scale bottom
boxes, enter values that indicate the top (9V in this example) and bottom (1V in
this example) of the engineering scale for the output point.
10. In the Electrical scale top and Electrical scale bottom boxes, enter
values for the top and bottom of the electrical scale range of the output point.
Continued on next page
04-16006-04-en, March 2015 Technical
705
21 I/O Points
21.22 Scaling an Input or Output I/O Point
11. Click OK to insert the scaling factor.
A Progress view displays indicating that the configuration changes are being
saved to the database.
Configuring scaling on analog outputs converts the Requested value in
engineering units (application) to a physical value in electrical units (voltage or
current).
Technical 04-16006-04-en, March 2015
706
21 I/O Points
21.23 Implicit Trend Logs for I/O Points
21.23 Implicit Trend Logs for I/O Points
When you create an I/O point on an I/O module, the system automatically creates
an implicit trend log for that I/O point. The implicit trend log logs the Value of the I/O
point in a Change of Value type trend log.
The values must change by the following amounts before the logs show new
values:
• Current Outputs and Inputs: 0.2 mA
• Voltage Outputs and Inputs: 0.1 V
• Resistive Inputs: 200Ω
• Temperature Inputs: 0.2 oC (32.3 oF)
• All others: Any change of value
If scaling is set on an I/O point, the implicit log’s delta is also scaled and the implicit
trend logs the scaled value. The implicit log also logs forced values along with an
indication that a particular value is forced.
04-16006-04-en, March 2015 Technical
707
21 I/O Points
21.24 Input Point Offsets
21.24 Input Point Offsets
An offset is a value added to or subtracted from the engineering value before it
impacts the input point's Value property. For example, assume that a Thermistor
input is housed in a wiring closet. If you know the temperature in that closet is 2 °C
higher than the temperature outside the closet, you enter -2,0 as the offset value.
The object then measures 25 °C from the point, uses the offset to calibrate that
value, and displays 23 °C in the Value property. Using the offset value helps to
compensate for the temperature differences between the closet and the ambient
temperature.
Technical 04-16006-04-en, March 2015
708
21 I/O Points
21.25 Configuring Offsets for Input Points
21.25 Configuring Offsets for Input Points
You enter an offset to specify the value that you want added to or subtracted from
the engineering value before it affects the point's value property. For example, using
an offset helps to compensate for the temperature differences between a
Thermistor output housed in a wiring closet and the temperature outside that
closet.
For more information, see section 21.24 “Input Point Offsets” on page 706.
To configure offsets for input points
1. In WorkStation, in the System tree pane, select an I/O module.
2. On the File menu, point to New and then click Input Point.
3. In the object type list, select one of the following input types: Current,
Temperature, Resistive, or Voltage.
4. In the Name box, enter a name for the input point.
5. In the Description box, type a description of the input point.
6. Click Next.
Continued on next page
04-16006-04-en, March 2015 Technical
709
21 I/O Points
21.25 Configuring Offsets for Input Points
7. In the Input channel box, select the channel that corresponds to the
terminal connection on the I/O module where the input will be wired.
8. In the Label text box, enter text to identify the input point on the I/O module
label.
9. Enter the remaining values you want in the boxes on the Basic Settings page.
For more information, see the New Input Point Configuration Wizard – Basic
Settings Page topic on WebHelp.
10. In the Offset box, enter the offset value that you want added to or subtracted
from the engineering value before it affects the point's value property.
11. Click Create.
Technical 04-16006-04-en, March 2015
710
21 I/O Points
21.26 Printing a Wiring List for the I/O Bus
21.26 Printing a Wiring List for the I/O Bus
You print an I/O wiring list for the I/O bus that describes which I/O points are
associated with each I/O module. You use the printed copy of this list to help wire
the I/O bus network.
Note
• You cannot print a wiring list for an I/O module with a Module ID of Null
(unconfigured).
• I/O points with a channel of Null do not display on the wiring list.
For more information, see the I/O Bus Overview topic on WebHelp.
To print an I/O wiring list for the I/O bus
1. In WorkStation, in the System Tree pane, expand the IO Bus.
Continued on next page
04-16006-04-en, March 2015 Technical
711
21 I/O Points
21.26 Printing a Wiring List for the I/O Bus
2. Right-click IO Bus and then click Print IO wiring list to print a wiring list for
the entire I/O bus.
3. In the Print IO Wiring List dialog box, click the Printer icon to print the
I/O wiring list.
4. To print a wiring list for a single I/O module, right-click the selected I/O module
(AO-8 in this example).
Continued on next page
Technical 04-16006-04-en, March 2015
712
21 I/O Points
21.26 Printing a Wiring List for the I/O Bus
5. Click Print IO wiring list.
You can also select multiple I/O modules in the List View.
6. Click the Printer icon to print the wiring list.
Observe that the complete path to the I/O module is displayed on the title bar for
the I/O wiring list.
04-16006-04-en, March 2015 Technical
713
21 I/O Points
21.27 Threshold Settings for I/O Points
21.27 Threshold Settings for I/O Points
The threshold is the minimum change of value before the I/O module reports the
value to the Automation Server. Properly setting the threshold value reduces
unnecessary communication between the I/O module and the Automation Server.
When both the Automation Server and the I/O modules are online and operating
normally, an I/O module reports the value of a point to the Automation Server if and
only if the change since the last report is larger than the threshold. This is true for
the value property in both input and output points.
Threshold uses the engineering unit. However, WorkStation does not present the
threshold unit. The Automation Server uses a unit related to the Value property
before WorkStation applies localization. The unit of value before localization is
shown in the Settings page of the Value property.
Figure: Value Unit Before Localization
The relationship between the Value's unit and the threshold is as follows:
• If the unit is not a temperature unit, the server uses the same unit for threshold.
• If the unit is a temperature unit, the server uses the version of the unit. For
example, if the Value's unit is °C, the threshold unit is °C.
With a default threshold value of 0, the I/O module reports the Value with its
maximum resolution. The maximum resolution values for each of the I/O points are
listed here.
Table: I/O Point Resolution Values
Points Maximum Minimum Value Maximum Value
Resolution
Voltage Input 2.7 mV 0V 10 V
Technical 04-16006-04-en, March 2015
714
21 I/O Points
21.27 Threshold Settings for I/O Points
Continued
Points Maximum Minimum Value Maximum Value
Resolution
Current Input 5.6 µA 0 mA 20 mA
Digital Input 120 ms n/a n/a
Counter Input 20 ms n/a n/a
Voltage Output 42 mV 0V 10 V
Current Output 0.1 mA 0 mA 20 mA
2- or 3-Wire RTD 0.03 °C -50 °C +150 °C
Temperature Inputs
2- or 3-Wire RTD 0.01 ohms 50 ohms 220 ohms
Resistive Input, 100
ohm type
2- or 3-Wire RTD 0.1 ohms 500 ohms 2200 ohms
Resistive Input, 1000
ohm type
Resistive Input, RTD 1 ohm 0 ohms 15000 ohms
module
Resistive Input, UI- 4 ohms 10 ohms 60000 ohms
series module*
Temperature Input, 0.08 °C -50 °C +150 °C
Satchwell 10k
Temperature Input, 0.05 °C -50 °C +150 °C
1.8k*
Temperature Input, 0.05 °C -50 °C +150 °C
10k series*
Temperature Input, 0.6 °C -50 °C +150 °C
1k Balco*
Temperature Input, 0.05 °C -50 °C +150 °C
20k*
Temperature Input, 0.05 °C -50 °C +150 °C
2.2k
* For UI-series modules, such as the UI-16, AO-4, UI-8, and DO-4, the temperature and
resistive input maximum resolution varies non-linearly depending on the temperature or
resistance range being measured. The maximum resolution listed here is the maximum
across the entire range.
04-16006-04-en, March 2015 Technical
715
21 I/O Points
21.27 Threshold Settings for I/O Points
Points Maximum Minimum Value Maximum Value
Resolution
Reporting the Value with its maximum resolution requires the system to process
every single fluctuation every time the Value changes. When a large number of
inputs and outputs are involved, the Automation Server may need a significant
amount of CPU bandwidth to process them. As a result, you may observe high
system CPU usage and slow response time. For more information, see section
150.6 “High CPU Usage and Slow System Response Time ” on page 5528.
Technical 04-16006-04-en, March 2015
716
22 I/O User Interface
Topics
Central I/O System Tree Pane Icons
I/O Module Management Tool Dialog Box
I/O Bus Properties – Basic Tab
I/O Module Properties – Basic Tab
I/O Modules in the Work Area
Counter Input Properties – Basic Tab
Current Input Properties – Basic Tab
Digital Input Properties – Basic Tab
Resistive Input Properties – Basic Tab
2-Wire or 3-Wire RTD Resistive Input Properties – Basic Tab
Supervised Input Properties – Basic Tab
Temperature Input Properties – Basic Tab
2-Wire or 3-Wire RTD Temperature Input Properties – Basic
Tab
Voltage Input Properties – Basic Tab
Current Output Properties – Basic Tab
Voltage Output Properties – Basic Tab
Digital Output Properties – Basic Tab
Digital Pulsed Output Properties – Basic Tab
Tristate Output Properties – Basic Tab
Tristate Pulsed Output Properties – Basic Tab
I/O Points in the Work Area
Print I/O Wiring List Dialog Box
Counter Input – Basic Settings Page
Current Input – Basic Settings Page
Digital Input – Basic Settings Page
Resistive Input – Basic Settings Page
2-Wire or 3-Wire RTD Resistive Input – Basic Settings Page
Supervised Input – Basic Settings Page
Temperature Input – Basic Settings Page
2-Wire or 3-Wire RTD Temperature Input – Basic Settings
Page
Voltage Input – Basic Settings Page
New I/O Module Wizard – Basic Settings Page
Current Output – Basic Settings Page
Voltage Output – Basic Settings Page
Digital Output – Basic Settings Page
Digital Pulsed Output – Basic Settings Page
Tristate Output – Basic Settings Page
Tristate Pulsed Output – Basic Settings Page
Print I/O Module Labels Dialog Box
Update I/O Module Firmware Dialog Box
22 I/O User Interface
22.1 Central I/O System Tree Pane Icons
22.1 Central I/O System Tree Pane Icons
Use the System Tree pane icons to identify the I/O bus, I/O channels, and I/O
modules and points.
Table: Central I/O System Tree Pane Icons
Icon Description
I/O Bus
Indicates the I/O bus.
I/O Module
Indicates the I/O module.
I/O Point
Indicates an I/O point.
Output I/O Channel
Indicates the output I/O channel in the Hardware folder.
Input I/O Channel
Indicates the input I/O channel in the Hardware folder.
Output I/O Point
Indicates the output I/O point.
Input I/O Point
Indicates the input I/O point.
04-16006-04-en, March 2015 Technical
719
22 I/O User Interface
22.2 I/O Module Management Tool Dialog Box
22.2 I/O Module Management Tool Dialog
Box
Use the IO Module Management Tool dialog box to assign and unassign logical
I/O modules, to correct the position of a module type, or to correct a module
mismatch.
Figure: IO Module Management Tool dialog box
Table: IO Module Management Tool Dialog Box
Component Description
Module ID Displays the position of the I/O module on the I/O Bus. Null and 1
to 32 are valid positions. Null specifies that the Module ID is non-
operational and can be used as a placeholder to be configured
when you wish to assign it to a physical slot.
Physical device Displays the physical device type connected to the Automation
type Server.
IO module status Displays the status of the I/O module:
• Configured– There is at least one I/O point created on the
module.
• Unconfigured- There are no I/O points created on the
module.
• Bootloader– The module's firmware is being updated.
• Low power– The module has been placed in low power
mode to save energy.
• 24V Out of tolerance– The module is not receiving the
required power from the bus.
IO module name Displays the logical module located in the IO Bus folder.
IO module type Displays the type of logical I/O module.
Technical 04-16006-04-en, March 2015
720
22 I/O User Interface
22.2 I/O Module Management Tool Dialog Box
Continued
Component Description
Unssigned Modules Displays unassigned I/O modules. You drag and drop unassigned
modules to assign them to a physical device. For more
information, see section 20.11 “Assigning and Unassigning
Logical I/O Modules” on page 630.
04-16006-04-en, March 2015 Technical
721
22 I/O User Interface
22.3 I/O Bus Properties – Basic Tab
22.3 I/O Bus Properties – Basic Tab
Use the Basic tab to view and edit the basic properties of the I/O bus.
Figure: I/O bus properties - basic tab
Table: Basic Tab
Component Description
Automation Server backplane address Displays the slot where the Automation
Server is currently located.
Technical 04-16006-04-en, March 2015
722
22 I/O User Interface
22.4 I/O Module Properties – Basic Tab
22.4 I/O Module Properties – Basic Tab
Use the Basic tab to view and edit the basic properties of I/O modules.
Figure: I/O module properties - basic tab
Table: Basic Tab
Component Description
Status Displays whether the I/O module is online or
offline. WorkStation displays an alarm when
the I/O module's status changes
unexpectedly, for example, when the
module is online and then goes offline with
respect to the Automation Server.
04-16006-04-en, March 2015 Technical
723
22 I/O User Interface
22.4 I/O Module Properties – Basic Tab
Continued
Component Description
Module status Displays the status of the I/O module:
• Configured– There is at least one I/O
point created on the module.
• Unconfigured- There are no I/O points
created on the module.
• Bootloader– The module's firmware is
being updated.
• Low power– The module has been
placed in low power mode to save
energy.
• 24V Out of tolerance– The module is
not receiving the required power from
the bus.
Module type mismatch Displays True when the user has created a
different type of module at a specific location
in the I/O Bus than is physically installed at
that location. When this occurs, a Module
type mismatch alarm is also triggered.
Model name Displays the I/O module model name.
Product serial number Displays the I/O module serial number.
Firmware version Displays the firmware version of the I/O
module.
Hardware version Displays the hardware version of the I/O
module.
Update status Displays the update status of the I/O
module:
• Idle– No module firmware update is
occurring.
• In progress- Module firmware is being
updated.
• Bad file– Module firmware update failed
because the uploaded file was
corrupted.
• Complete– Module firmware update
completed successfully.
Module ID Displays the position of the I/O module on
the I/O Bus. Null and 1 to 32 are valid
positions. Null specifies that the Module ID is
non-operational and can be used as a
placeholder to be configured when you wish
to assign it to a physical slot.
Low power Displays True when the I/O module has
been placed in low power mode. You place
an I/O module in low power mode to save
energy. The default here is False.
Technical 04-16006-04-en, March 2015
724
22 I/O User Interface
22.4 I/O Module Properties – Basic Tab
Continued
Component Description
Override capability expected Select Yes to connect a module with an
override switch. The field specifies whether
you would like the module to be override
capable. It does mean that the module is
actually override capable.
To determine whether the module is override
capable, view the Module name property. If it
ends with an -H, the module is override
capable.
04-16006-04-en, March 2015 Technical
725
22 I/O User Interface
22.5 I/O Modules in the Work Area
22.5 I/O Modules in the Work Area
Use the Work Area to access details about the I/O modules in the IO Bus.
Figure: Detailed view of the I/O modules on the I/O bus
Tip
If you do not see all of the fields displayed here, right-click on the column header
to display more.
Table: I/O Modules in the Work Area
Component Description
Name Displays the I/O module name that you
assign. When creating the I/O module, the
default value is the I/O module type, for
example AO-8 (analog output, 8-channel).
Description Displays the user defined description of the
I/O module.
Status Displays the status of the I/O module: either
online or offline with respect to the
Automation Server.
Module status Displays the status of the I/O module:
Configured, Unconfigured, Bootloader, Low
power, or 24V Out of tolerance. The module
status is set to configured when there is at
least one I/O point created on the module.
Model name Displays the type of I/O module.
Technical 04-16006-04-en, March 2015
726
22 I/O User Interface
22.5 I/O Modules in the Work Area
Continued
Component Description
Module ID Displays the position of the I/O module on
the I/O Bus. Null and 1 to 32 are valid
positions. Null specifies that the Module ID is
non-operational and can be used as a
placeholder to be configured when you wish
to assign it to a physical slot.
04-16006-04-en, March 2015 Technical
727
22 I/O User Interface
22.6 Counter Input Properties – Basic Tab
22.6 Counter Input Properties – Basic Tab
Use the Basic tab to view and edit the basic properties of a counter input point.
Figure: Counter Input Properties – Basic tab
Table: Counter Input Properties - Basic Tab
Component Description
Value Displays the present value. The maximum
value of a counter input is 4294967295.
Once passed, that value wraps to 0. The
maximum supported rate for a counter input
is 25Hz.
Reset counter Select True to set the counter value to 0.
The reset counter turns back to False after
being set to True.
Communications status Displays online when the module is
communicating with the server and the point
is on a valid, unassigned channel.
Reliability Displays the integrity of the value of a point.
For more information, see section 21.16
“Reliability of I/O Points” on page 692.
Channel Select an input channel number, such as
In1.
Technical 04-16006-04-en, March 2015
728
22 I/O User Interface
22.6 Counter Input Properties – Basic Tab
Continued
Component Description
Invert Select True (inverted) to increment the
counter when the counter input is
disconnected, rather than when it is
connected.
LED color Select either Red or Green.
LED invert Select True to turn the LED off when the
counter is connected and on when the
counter is disconnected.
Label text Type the text that is printed on an I/O
module label. For more information, see
section 22.39 “Print I/O Module Labels
Dialog Box” on page 785.
04-16006-04-en, March 2015 Technical
729
22 I/O User Interface
22.7 Current Input Properties – Basic Tab
22.7 Current Input Properties – Basic Tab
Use the Basic tab to view and edit the basic properties of a current input point.
Figure: Current Input Properties – Basic tab
Table: Current Input Properties - Basic Tab
Component Description
Value Displays the present value as measured from
0 to 20mA.
Communications status Displays online when the module is
communicating with the server and the point
is on a valid, unassigned channel.
Reliability Displays the integrity of the value of a point.
For more information, see section 21.16
“Reliability of I/O Points” on page 692.
Channel Select an input channel number, such as
In1.
Technical 04-16006-04-en, March 2015
730
22 I/O User Interface
22.7 Current Input Properties – Basic Tab
Continued
Component Description
Threshold Type a value for the minimum amount of
change of value before the I/O module
reports the value to the Automation Server.
Properly setting the threshold value reduces
unnecessary communication between the
I/O module and the Automation Server. For
more information, see section 21.27
“Threshold Settings for I/O Points” on page
712.
Digital filter Select True to filter out noise and prevent
false readings.
Label text Type the text that is printed on an I/O
module label. For more information, see
section 22.39 “Print I/O Module Labels
Dialog Box” on page 785.
Upper reliability level Type a value for the upper reliability level in
electrical units. When the electrical value is
above the upper reliability level, the Reliability
is Value over range.
Lower reliability level Type a value for the lower reliability level in
electrical units. When the electrical value is
below the lower reliability level, the Reliability
is Value under range.
Electrical scale top Type a top of the range voltage (VDC),
current (mA), or resistance (kohm) value for
the input point scale. (Example: 10 VDC, 20
mA, or 60 kohm).
Electrical scale bottom Type a bottom of the range voltage, (VDC),
current (mA), or resistance (kohm) value for
the input point scale. (Example: 0 VDC, 0
mA, or 0 kohm)
Engineering scale top Type a top of the range engineering value for
the input point. (Example: 100%)
Engineering scale bottom Type a bottom of the range engineering
value for the input point scale. (Example:
0%).
Offset Type an offset value to be added to or
subtracted from the engineering value before
it impacts the Value property.
04-16006-04-en, March 2015 Technical
731
22 I/O User Interface
22.8 Digital Input Properties – Basic Tab
22.8 Digital Input Properties – Basic Tab
Use the Basic tab to view and edit the basic properties of a digital input point.
Figure: Digital Input Properties – Basic tab
Table: Digital Input Properties - Basic Tab
Component Description
Value Displays the present value, On or Off.
Communications status Displays online when the module is
communicating with the server and the point
is on a valid, unassigned channel.
Reliability Displays the integrity of the value of a point.
For more information, see section 21.16
“Reliability of I/O Points” on page 692.
Channel Select an input channel number, such as
In1.
Invert Select True (inverted) to turn the LED off
when the current is closed.
LED color Select either Red or Green.
LED invert Select True to turn the LED off when the
current is closed.
Label text Type the text that is printed on an I/O
module label. For more information, see
section 22.39 “Print I/O Module Labels
Dialog Box” on page 785.
Technical 04-16006-04-en, March 2015
732
22 I/O User Interface
22.9 Resistive Input Properties – Basic Tab
22.9 Resistive Input Properties – Basic Tab
Use the Basic tab to view and edit the basic properties of a resistive input point.
Figure: Resistive Input Properties – Basic tab
Table: Resistive Input Properties - Basic Tab
Component Description
Value Displays the resistance measured between 0
and 65535 ohms. The RTD module resistive
input range is from 0 to 15000 ohms.
Communications status Displays online when the module is
communicating with the server and the point
is on a valid, unassigned channel.
Reliability Displays the integrity of the value of a point.
For more information, see section 21.16
“Reliability of I/O Points” on page 692.
Channel Select an input channel number, such as
In1.
04-16006-04-en, March 2015 Technical
733
22 I/O User Interface
22.9 Resistive Input Properties – Basic Tab
Continued
Component Description
Threshold Type a value for the minimum amount of
change of value before the I/O module
reports the value to the Automation Server.
Properly setting the threshold value reduces
unnecessary communication between the
I/O module and the Automation Server. For
more information, see section 21.27
“Threshold Settings for I/O Points” on page
712.
Digital filter Select True to filter out noise and prevent
false readings.
Label text Type the text that is printed on an I/O
module label. For more information, see
section 22.39 “Print I/O Module Labels
Dialog Box” on page 785.
Upper reliability level Type a value for the upper reliability level in
electrical units. When the electrical value is
above the upper reliability level, the Reliability
is Value over range.
Lower reliability level Type a value for the lower reliability level in
electrical units. When the electrical value is
below the lower reliability level, the Reliability
is Value under range.
Electrical scale top Type a top of the range voltage (VDC),
current (mA), or resistance (kohm) value for
the input point scale. (Example: 10 VDC, 20
mA, or 60 kohm).
Electrical scale bottom Type a bottom of the range voltage, (VDC),
current (mA), or resistance (kohm) value for
the input point scale. (Example: 0 VDC, 0
mA, or 0 kohm)
Engineering scale top Type a top of the range engineering value for
the input point. (Example: 100%)
Engineering scale bottom Type a bottom of the range engineering
value for the input point scale. (Example:
0%).
Offset Type an offset value to be added to or
subtracted from the engineering value before
it impacts the Value property.
Technical 04-16006-04-en, March 2015
734
22 I/O User Interface
22.10 2-Wire or 3-Wire RTD Resistive Input Properties – Basic Tab
22.10 2-Wire or 3-Wire RTD Resistive Input
Properties – Basic Tab
Use the Basic tab to view and edit the basic properties of a 2-wire or 3-wire RTD
resistive input point.
Figure: 2– or 3–Wire Resistive Input Properties – Basic tab
Table: 2-Wire or 3-Wire Resistive Input Properties - Basic Tab
Component Description
Value Displays the measured value.
See the Sensor class property for more
information.
Communications status Displays online when the module is
communicating with the server and the point
is on a valid, unassigned channel.
04-16006-04-en, March 2015 Technical
735
22 I/O User Interface
22.10 2-Wire or 3-Wire RTD Resistive Input Properties – Basic Tab
Continued
Component Description
Reliability Displays the integrity of the value of a point.
For more information, see section 21.16
“Reliability of I/O Points” on page 692.
Channel Select an input channel number, such as
In1.
Sensor class Select the sensor class to configure the RTD
resisitive input for the approximate range it
will measure:
• 100 ohm based: measures a range
from 50 to 220 ohm
• 1000 ohm based: measures a range
from 500 to 2200 ohm
Threshold Type a value for the minimum amount of
change of value before the I/O module
reports the value to the Automation Server.
Properly setting the threshold value reduces
unnecessary communication between the
I/O module and the Automation Server. For
more information, see section 21.27
“Threshold Settings for I/O Points” on page
712.
Digital filter Select True to filter out noise and prevent
false readings.
Label text Type the text that is printed on an I/O
module label. For more information, see
section 22.39 “Print I/O Module Labels
Dialog Box” on page 785.
Upper reliability level Type a value for the upper reliability level in
electrical units. When the electrical value is
above the upper reliability level, the Reliability
is Value over range.
Lower reliability level Type a value for the lower reliability level in
electrical units. When the electrical value is
below the lower reliability level, the Reliability
is Value under range.
Electrical scale top Type a top of the range voltage (VDC),
current (mA), or resistance (kohm) value for
the input point scale. (Example: 10 VDC, 20
mA, or 60 kohm).
Electrical scale bottom Type a bottom of the range voltage, (VDC),
current (mA), or resistance (kohm) value for
the input point scale. (Example: 0 VDC, 0
mA, or 0 kohm)
Engineering scale top Type a top of the range engineering value for
the input point. (Example: 100%)
Technical 04-16006-04-en, March 2015
736
22 I/O User Interface
22.10 2-Wire or 3-Wire RTD Resistive Input Properties – Basic Tab
Continued
Component Description
Engineering scale bottom Type a bottom of the range engineering
value for the input point scale. (Example:
0%).
Offset Type an offset value to be added to or
subtracted from the engineering value before
it impacts the Value property.
04-16006-04-en, March 2015 Technical
737
22 I/O User Interface
22.11 Supervised Input Properties – Basic Tab
22.11 Supervised Input Properties – Basic Tab
Use the Basic tab to view and edit the basic properties of a supervised input point.
Figure: Supervised Input Properties – Basic tab
Table: Supervised Input Properties - Basic Tab
Component Description
Value Displays the present value: On, Off, Trouble,
or Not set.
Communications status Displays online when the module is
communicating with the server and the point
is on a valid, unassigned channel.
Reliability Displays the integrity of the value of a point.
For more information, see section 21.16
“Reliability of I/O Points” on page 692.
Channel Select an input channel number, such as
In1.
Supervised circuit type Select one of the following: Not set, None,
NO Series, NC Series, NO Parallel, NC
Parallel. NO Series/Parallel, or NC
Series/Parallel (NO= normally open, NC=
normally closed). The default value is NO
Series.
Supervised resistor value Type the resistance value of the resistors in
the supervised circuit.
Label text Type the text that is printed on an I/O
module label. For more information, see
section 22.39 “Print I/O Module Labels
Dialog Box” on page 785.
Technical 04-16006-04-en, March 2015
738
22 I/O User Interface
22.12 Temperature Input Properties – Basic Tab
22.12 Temperature Input Properties – Basic
Tab
Use the Basic tab to view and edit the basic properties of a temperature input
point.
Figure: Temperature Input Properties – Basic tab
Table: Temperature Input Properties - Basic Tab
Component Description
Value Displays the temperature value. The
module's maximum precision is 0.01C.
Communications status Displays online when the module is
communicating with the server and the point
is on a valid, unassigned channel.
Reliability Displays the integrity of the value of a point.
For more information, see section 21.16
“Reliability of I/O Points” on page 692.
Channel Select an input channel number, such as
In1.
Thermistor type Select the appropriate thermistor type from
the list. For more information, see section
21.21 “I/O Point Scaling” on page 698.list.
04-16006-04-en, March 2015 Technical
739
22 I/O User Interface
22.12 Temperature Input Properties – Basic Tab
Continued
Component Description
Threshold Type a value for the minimum amount of
change of value before the I/O module
reports the value to the Automation Server.
Properly setting the threshold value reduces
unnecessary communication between the
I/O module and the Automation Server. For
more information, see section 21.27
“Threshold Settings for I/O Points” on page
712.
In this sample Temperature Input - Basic Tab
graphic, the threshold has a unit of
temperature and is displayed here
localized to the region as C.
Digital filter Select True to filter out noise and prevent
false readings.
Label text Type the text that is printed on an I/O
module label. For more information, see
section 22.39 “Print I/O Module Labels
Dialog Box” on page 785.
Upper reliability level Type a temperature value for the upper
reliability level. When the value is above the
upper reliability level, the Reliability is Value
over range. For more information, see
section 21.9 “2-Wire or 3-Wire RTD-DI-16
Temperature Input Value and Reliability
Levels” on page 679.
Lower reliability level Type a temperature value for the lower
reliability level. When the value is below the
lower reliability level, the Reliability is Value
under range. For more information, see
section 21.9 “2-Wire or 3-Wire RTD-DI-16
Temperature Input Value and Reliability
Levels” on page 679.
Offset Type an offset value to be added to or
subtracted from the engineering value before
it impacts the Value property.
Technical 04-16006-04-en, March 2015
740
22 I/O User Interface
22.13 2-Wire or 3-Wire RTD Temperature Input Properties – Basic Tab
22.13 2-Wire or 3-Wire RTD Temperature
Input Properties – Basic Tab
Use the Basic tab to view and edit the basic properties of a 2-wire or 3-wire RTD
temperature input point.
Figure: 2– or 3–Wire RTD Temperature Input Properties – Basic tab
Table: 2- or 3-Wire RTD Temperature Input Properties - Basic Tab
Component Description
Value Displays the converted temperature value in
degrees including the user-specified wiring
resistance and offset. Has a range of -50 to
150°C. For more information, see section
21.9 “2-Wire or 3-Wire RTD-DI-16
Temperature Input Value and Reliability
Levels” on page 679.
Raw resistance Displays the measured resistance from the
RTD without applying the wiring resistance
or offset properties.
04-16006-04-en, March 2015 Technical
741
22 I/O User Interface
22.13 2-Wire or 3-Wire RTD Temperature Input Properties – Basic Tab
Continued
Component Description
Communications status Displays online when the module is
communicating with the server and the point
is on a valid, unassigned channel.
Reliability Displays the integrity of the value of a point.
For more information, see section 21.16
“Reliability of I/O Points” on page 692.
Channel Select an input channel number, such as
In1.
Sensor type Select a sensor type to determine how the
resistance value is converted to
temperature.
Threshold Type a value for the minimum amount of
change of value before the I/O module
reports the value to the Automation Server.
Properly setting the threshold value reduces
unnecessary communication between the
I/O module and the Automation Server. For
more information, see section 21.27
“Threshold Settings for I/O Points” on page
712.
In this sample Temperature Input - Basic Tab
graphic, the threshold has a unit of
temperature and is displayed here
localized to the region as C.
Digital filter Select True to filter out noise and prevent
false readings.
Label text Type the text that is printed on an I/O
module label. For more information, see
section 22.39 “Print I/O Module Labels
Dialog Box” on page 785.
Upper reliability level Type a temperature value for the upper
reliability level. When the value is above the
upper reliability level, the Reliability is Value
over range. For more information, see
section 21.9 “2-Wire or 3-Wire RTD-DI-16
Temperature Input Value and Reliability
Levels” on page 679.
Lower reliability level Type a temperature value for the lower
reliability level. When the value is below the
lower reliability level, the Reliability is Value
under range. For more information, see
section 21.9 “2-Wire or 3-Wire RTD-DI-16
Temperature Input Value and Reliability
Levels” on page 679.
Offset Type an offset value in degrees to the
converted temperature value. For
instructions on how the value is calculated,
see the Value property.
Technical 04-16006-04-en, March 2015
742
22 I/O User Interface
22.13 2-Wire or 3-Wire RTD Temperature Input Properties – Basic Tab
Continued
Component Description
Wiring resistance Type a wiring resistance value. For more
information, see section 21.8 “2-Wire RTD-
DI-16 Temperature Input Wiring Resistance”
on page 678.
04-16006-04-en, March 2015 Technical
743
22 I/O User Interface
22.14 Voltage Input Properties – Basic Tab
22.14 Voltage Input Properties – Basic Tab
Use the Basic tab to view and edit the basic properties of a voltage input point.
Figure: Voltage Input Properties – Basic tab
Table: Voltage Input Properties - Basic Tab
Component Description
Value Displays the voltage input value.
Communications status Displays online when the module is
communicating with the server and the point
is on a valid, unassigned channel.
Reliability Displays the integrity of the value of a point.
For more information, see section 21.16
“Reliability of I/O Points” on page 692.
Channel Select an input channel number, such as
In1.
Technical 04-16006-04-en, March 2015
744
22 I/O User Interface
22.14 Voltage Input Properties – Basic Tab
Continued
Component Description
Threshold Type a value for the minimum amount of
change of value before the I/O module
reports the value to the Automation Server.
Properly setting the threshold value reduces
unnecessary communication between the
I/O module and the Automation Server. For
more information, see section 21.27
“Threshold Settings for I/O Points” on page
712.
Digital filter Select True to filter out noise and prevent
false readings.
Label text Type the text that is printed on an I/O
module label. For more information, see
section 22.39 “Print I/O Module Labels
Dialog Box” on page 785.
Upper reliability level Type a value for the upper reliability level in
electrical units. When the electrical value is
above the upper reliability level, the Reliability
is Value over range.
Lower reliability level Type a value for the lower reliability level in
electrical units. When the electrical value is
below the lower reliability level, the Reliability
is Value under range.
Electrical scale top Type a top of the range voltage (VDC),
current (mA), or resistance (kohm) value for
the input point scale. (Example: 10 VDC, 20
mA, or 60 kohm).
Electrical scale bottom Type a bottom of the range voltage, (VDC),
current (mA), or resistance (kohm) value for
the input point scale. (Example: 0 VDC, 0
mA, or 0 kohm)
Engineering scale top Type a top of the range engineering value for
the input point. (Example: 100%)
Engineering scale bottom Type a bottom of the range engineering
value for the input point scale. (Example:
0%).
Offset Type an offset value to be added to or
subtracted from the engineering value before
it impacts the Value property.
04-16006-04-en, March 2015 Technical
745
22 I/O User Interface
22.15 Current Output Properties – Basic Tab
22.15 Current Output Properties – Basic Tab
Use the Basic tab to view and edit the basic properties of a current output point.
Figure: Current Output Properties – Basic tab
Table: Current Output Properties - Basic Tab
Component Description
Value Displays the value, up to a maximum of
20mA. This is the measured value of the
output from the I/O module.
Requested value Enter a value that you want to assign to the
output. This property drives the output to a
specific value. If the I/O module loses
communication with the Automation Server
for 255 seconds, the default output value is
used instead of the requested value.
Communications status Displays online when the module is
communicating with the server and the point
is on a valid, unassigned channel.
Technical 04-16006-04-en, March 2015
746
22 I/O User Interface
22.15 Current Output Properties – Basic Tab
Continued
Component Description
Reliability Displays the integrity of the value of a point.
For more information, see section 21.16
“Reliability of I/O Points” on page 692.
Override status Displays whether the override switch is being
used. If the status is True, the physical
override switch has been set to Hand (value
= 10mA) or Off (value = 0mA).
Channel Select an output channel number, such as
Out1.
Threshold Type a value for the minimum amount of
change of value before the I/O module
reports the value to the Automation Server.
Properly setting the threshold value reduces
unnecessary communication between the
I/O module and the Automation Server. For
more information, see section 21.27
“Threshold Settings for I/O Points” on page
712.
The threshold is applied to the value
measured from the I/O module, not the
output value. For example, suppose that a
current output has a requested value of
2mA, a value of 2mA, and a threshold of
2mA. If the requested value is set to 3mA,
the value will remain at 2mA, but the output
value from the module will be 3mA.
Default output value Enter the value that you want to revert to if
the I/O module loses communication with
the Automation Server for more than 255
seconds.
Label text Type the text that is printed on an I/O
module label. For more information, see
section 22.39 “Print I/O Module Labels
Dialog Box” on page 785.
Electrical scale top Type a top of the range voltage (VDC),
current (mA), or resistance (kohm) value for
the input point scale. (Example: 10 VDC, 20
mA, or 60 kohm).
Electrical scale bottom Type a bottom of the range voltage, (VDC),
current (mA), or resistance (kohm) value for
the input point scale. (Example: 0 VDC, 0
mA, or 0 kohm)
Engineering scale top Type a top of the range engineering value for
the input point. (Example: 100%)
Engineering scale bottom Type a bottom of the range engineering
value for the input point scale. (Example:
0%).
04-16006-04-en, March 2015 Technical
747
22 I/O User Interface
22.16 Voltage Output Properties – Basic Tab
22.16 Voltage Output Properties – Basic Tab
Use the Basic tab to view and edit the basic properties of a voltage output point.
Figure: Voltage Output Properties – Basic tab
Table: Voltage Output Properties - Basic Tab
Component Description
Value Displays the value, up to a maximum output
of 10V. This is the measured value of the
output from the I/O module.
Requested value Enter a value that you want to assign to the
output. This property drives the output to a
specific value. If the I/O module loses
communication with the Automation Server
for 255 seconds, the default output value is
used instead of the requested value.
Communications status Displays online when the module is
communicating with the server and the point
is on a valid, unassigned channel.
Technical 04-16006-04-en, March 2015
748
22 I/O User Interface
22.16 Voltage Output Properties – Basic Tab
Continued
Component Description
Reliability Displays the integrity of the value of a point.
For more information, see section 21.16
“Reliability of I/O Points” on page 692.
Override status Displays whether the override switch is being
used. If the status is True, the physical
override switch has been set to Hand (value
= 5V) or Off (value = 0V).
Channel Select an output channel number, such as
Out1.
Threshold Type a value for the minimum amount of
change of value before the I/O module
reports the value to the Automation Server.
Properly setting the threshold value reduces
unnecessary communication between the
I/O module and the Automation Server. For
more information, see section 21.27
“Threshold Settings for I/O Points” on page
712.
Default output value Enter the value that you want to revert to if
the I/O module loses communication with
the Automation Server for more than 255
seconds.
Label text Type the text that is printed on an I/O
module label. For more information, see
section 22.39 “Print I/O Module Labels
Dialog Box” on page 785.
Electrical scale top Type a top of the range voltage (VDC),
current (mA), or resistance (kohm) value for
the input point scale. (Example: 10 VDC, 20
mA, or 60 kohm).
Electrical scale bottom Type a bottom of the range voltage, (VDC),
current (mA), or resistance (kohm) value for
the input point scale. (Example: 0 VDC, 0
mA, or 0 kohm)
Engineering scale top Type a top of the range engineering value for
the input point. (Example: 100%)
Engineering scale bottom Type a bottom of the range engineering
value for the input point scale. (Example:
0%).
04-16006-04-en, March 2015 Technical
749
22 I/O User Interface
22.17 Digital Output Properties – Basic Tab
22.17 Digital Output Properties – Basic Tab
Use the Basic tab to view and edit the basic properties of a digital output point.
Figure: Digital Output Properties – Basic tab
Table: Digital Output Properties - Basic Tab
Component Description
Value Displays the value of a digital output, either
On or Off.
Communications status Displays online when the module is
communicating with the server and the point
is on a valid, unassigned channel.
Reliability Displays the integrity of the value of a point.
For more information, see section 21.16
“Reliability of I/O Points” on page 692.
Requested value Select either On or Off to set the Requested
value. Off is the default value.
When the Requested value is set, the output
turns on and off and remains there unless
the I/O module loses communication with
the Automation Server. If the I/O module
loses communication with the Automation
Server for 255 seconds, the default output
value is used instead of the requested value.
Technical 04-16006-04-en, March 2015
750
22 I/O User Interface
22.17 Digital Output Properties – Basic Tab
Continued
Component Description
Override status Displays whether the override switch is being
used. If the status is True, the physical
override switch Hand value is On and the
override off value is Off.
Channel Select an output channel number, such as
Out1.
Invert Select either False (not inverted) or True
(inverted).
Default output value Select either On or -On to set the default
output value. Off is the default value.
The default output value is the value that the
output reverts to if the I/O module loses
communication with the Automation Server
for more than 255 seconds.
Label text Type the text that is printed on an I/O
module label. For more information, see
section 22.39 “Print I/O Module Labels
Dialog Box” on page 785.
04-16006-04-en, March 2015 Technical
751
22 I/O User Interface
22.18 Digital Pulsed Output Properties – Basic Tab
22.18 Digital Pulsed Output Properties – Basic
Tab
Use the Basic tab to view and edit the basic properties of a digital pulsed output
point.
Figure: Digital Pulsed Output – Basic tab
Table: Digital Pulsed Output Properties - Basic Tab
Component Description
Value Displays the value of a digital pulsed output,
either On or Off.
Requested value Enter a value that you want to assign to the
output. This value depends on the PWM
settings. If the PWM scale is Duty cycle,
the requested value is a percentage from 0-
100. If the PWM scale is Pulse duration,
the requested value turns on for the
requested value seconds.
Communications status Displays online when the module is
communicating with the server and the point
is on a valid, unassigned channel.
Technical 04-16006-04-en, March 2015
752
22 I/O User Interface
22.18 Digital Pulsed Output Properties – Basic Tab
Continued
Component Description
Reliability Displays the integrity of the value of a point.
For more information, see section 21.16
“Reliability of I/O Points” on page 692.
Override status Displays whether the override switch is being
used. If the status is True, the physical
override switch Hand value is On and the
override off value is Off.
Channel Select an output channel number, such as
Out1.
Invert Turns a digital pulsed output to the opposite
or contrary value. Select either False (not
inverted) or True (inverted). False is the
default value.
Default output value Enter the value that you want to revert to if
the I/O module loses communication with
the Automation Server for more than 255
seconds.
Label text Type the text that is printed on an I/O
module label. For more information, see
section 22.39 “Print I/O Module Labels
Dialog Box” on page 785.
PWM scale Select the PWM scale parameter Duration (s)
or Duty cycle (%). For more information, see
section 21.21 “I/O Point Scaling” on page
698.
Period Type a period value. For example, a duty
cycle of 25% and a Period of 20 seconds
produces a 5 second pulse every 20
seconds (25% of 20 seconds = 5 seconds).
PWM minimum pulse Type a PWM minimum pulse. If the value is
On for less than the minimum pulse, the
value remains Off.
04-16006-04-en, March 2015 Technical
753
22 I/O User Interface
22.19 Tristate Output Properties – Basic Tab
22.19 Tristate Output Properties – Basic Tab
Use the Basic tab to view and edit the basic properties of a tristate output point.
Figure: Tristate Output Properties – Basic tab
Table: Tristate Output Properties - Basic Tab
Component Description
Value Displays the value of a tristate output, either
On, Off, -On or Invalid. On turns the first
channel on. Off turns both channels off and -
On turns the second channel on. If you use
the override switch to turn both channels on,
the value is invalid.
Requested value Select either On, Off, or -On to set the
requested value. Off is the default value.
When the requested value is set, the output
turns on or off and remains there unless the
I/O module loses communication with the
Automation Server. If the I/O module loses
communication with the Automation Server
for 255 seconds, the default output value is
used instead of the requested value.
Reliabilty Displays the integrity of the value of a point.
For more information, see section 21.16
“Reliability of I/O Points” on page 692.
Communications status Displays online when the module is
communicating with the server and the point
is on a valid, unassigned channel.
Technical 04-16006-04-en, March 2015
754
22 I/O User Interface
22.19 Tristate Output Properties – Basic Tab
Continued
Component Description
Override status Displays whether the override switch is being
used. If the status is True, the physical
override switch Hand value is On and the
override off value is Off.
Channel Select an output channel number. Tristate
and tristate pulsed outputs take up two
channels. The first one is displayed here. For
example, a tristate pulsed output occupies
channels Out1 and Out2.
Default output value Select either On, Off, or -On to set the
default output value. Off is the default value.
The default output value is the value that the
output reverts to if the I/O module loses
communication with the Automation Server
for more than 255 seconds.
Label text Type the text that is printed on an I/O
module label. For more information, see
section 22.39 “Print I/O Module Labels
Dialog Box” on page 785.
04-16006-04-en, March 2015 Technical
755
22 I/O User Interface
22.20 Tristate Pulsed Output Properties – Basic Tab
22.20 Tristate Pulsed Output Properties –
Basic Tab
Use the Basic tab to view and edit the basic properties of a tristate pulsed output
point.
Figure: Tristate Pulsed Output Properties – Basic tab
Table: Tristate Pulsed Output Properties - Basic Tab
Component Description
Value Displays the value of a tristate pulsed output,
either On, Off, or -On. For a tristate pulsed
output at channel 1, On means the first
channel is on and the second is off, while -
On means that the second channel is on and
the first channel is off. Off means that both
channels are off.
Requested value Enter a value that you want to assign to the
output. This value depends on the PWM
settings. If the PWM scale is Duty cycle,
the requested value is a percentage from 0-
100. If the PWM scale is Pulse duration,
the requested value turns on for the
requested value seconds.
Technical 04-16006-04-en, March 2015
756
22 I/O User Interface
22.20 Tristate Pulsed Output Properties – Basic Tab
Continued
Component Description
Communications status Displays online when the module is
communicating with the server and the point
is on a valid, unassigned channel.
Reliability Displays the integrity of the value of a point.
For more information, see section 21.16
“Reliability of I/O Points” on page 692.
Override status Displays whether the override switch is being
used. If the status is True, the physical
override switch Hand value is On and the
override off value is Off.
Channel Select an output channel number. Tristate
and tristate pulsed outputs take up two
channels. The first one is displayed here. For
example, a tristate pulsed output occupies
channels Out1 and Out2.
Default output value Enter the value that you want to revert to if
the I/O module loses communication with
the Automation Server for more than 255
seconds.
Label text Type the text that is printed on an I/O
module label. For more information, see
section 22.39 “Print I/O Module Labels
Dialog Box” on page 785.
PWM scale Select the PWM scale parameter Duration (s)
or Duty cycle (%). For more information, see
section 21.21 “I/O Point Scaling” on page
698.
Period Type a period value. For example, a duty
cycle of 25% and a Period of 20 seconds
produces a 5 second pulse every 20
seconds (25% of 20 seconds = 5 seconds).
PWM minimum pulse Type a PWM minimum pulse. If the value is
On for less than the minimum pulse, the
value remains Off.
04-16006-04-en, March 2015 Technical
757
22 I/O User Interface
22.21 I/O Points in the Work Area
22.21 I/O Points in the Work Area
Use the work area to access details about the I/O points that have been created in
an I/O module.
Figure: I/O points in the work area
Tip
If you do not see all of the fields displayed here, right-click on the column header
to display more.
Table: I/O Points in the Work Area
Component Description
Name Displays the point name that was assigned.
The default value is the input or output type,
for example, Counter Input.
Description Displays the user defined description of the
I/O point
Technical 04-16006-04-en, March 2015
758
22 I/O User Interface
22.22 Print I/O Wiring List Dialog Box
22.22 Print I/O Wiring List Dialog Box
Use the Print IO Wiring List dialog box to print an I/O wiring list for the I/O bus
that describes which I/O points are associated with each I/O module.
Figure: Print IO wiring list dialog box
Table: Print IO Wiring List Dialog Box
Component Description
IO module Displays the I/O module.
Channel Displays the electrical channel of the I/O
module.
Point name Displays the I/O point name.
04-16006-04-en, March 2015 Technical
759
22 I/O User Interface
22.22 Print I/O Wiring List Dialog Box
Continued
Component Description
Type Displays the I/O point type.
Description Displays a description for the I/O module.
Label text Displays the text that is printed on an I/O
module label using the Print IO module labels
command.
Click to print a wiring list for the I/O bus. For
more information, see section 21.26
“Printing a Wiring List for the I/O Bus” on
page 709..
Technical 04-16006-04-en, March 2015
760
22 I/O User Interface
22.23 Counter Input – Basic Settings Page
22.23 Counter Input – Basic Settings Page
Use the Basic Settings page to specify the the basic properties for the counter
input I/O point you create.
Figure: Counter Input - Basic Settings page
Table: Counter Input - Basic Settings Page
Component Description
Input channel Select the physical input channel on the I/O module. Selecting a
value of Null specifies that the input point is non-operational and can
be used as a placeholder. For more information, see section 21.1
“I/O Point Types” on page 663.
Label text Type the text that is printed on an I/O module label. For more
information, see section 22.39 “Print I/O Module Labels Dialog Box”
on page 785.
Invert Select either True or False. Selecting True inverts the value of a
digital input and configures a counter input to increment when the
contact opens.
LED color Select either Red or Green.
LED invert Select either True or False. Selecting True lights the LED when the
digital input is on and turns it off when the digital input is off.
Selecting False turns off the LED when the digital input is on and
turns on the LED when the digital input is off.
04-16006-04-en, March 2015 Technical
761
22 I/O User Interface
22.24 Current Input – Basic Settings Page
22.24 Current Input – Basic Settings Page
Use the Basic Settings page to specify the the basic properties for the current
input I/O point you create.
Figure: Current Input - Basic Settings page
Table: Current Input - Basic Settings Page
Component Description
Input channel Select the physical input channel on the I/O module. Selecting a
value of Null specifies that the input point is non-operational and can
be used as a placeholder. For more information, see section 21.1
“I/O Point Types” on page 663.
Label text Type the text that is printed on an I/O module label. For more
information, see section 22.39 “Print I/O Module Labels Dialog Box”
on page 785.
Digital filter Select True (On) or False (Off) to filter out noise and prevent false
readings.
Threshold Type a value for minimum change of value before the I/O module
reports the value to the Automation Server. Properly setting the
threshold value reduces unnecessary communication between the
I/O module and the Automation Server. For more information, see
section 21.27 “Threshold Settings for I/O Points” on page 712.
Top of scale Type a value to enter the top of the range engineering value for the
engineering input point.
value
Top of scale Type a value to enter the top of the range voltage (VDC), current
electrical value (mA), or resistance (kohm) value for the input point scale.
Technical 04-16006-04-en, March 2015
762
22 I/O User Interface
22.24 Current Input – Basic Settings Page
Continued
Component Description
Bottom of scale Type a value for the bottom of the range engineering value for the
engineering input point scale.
value
Bottom of scale Type a bottom of the range voltage, (VDC), current (mA), or
electrical value resistance (kohm) value for the input point scale.
Unit Select the engineering unit in use, such as current, voltage, or
temperature.
Offset Type an offset value to be added to or subtracted from the
engineering value before it impacts the Value property.
Upper reliability Type a value for the upper reliability level in electrical units. When the
level electrical value is above the upper reliability level, the Reliability is
Value over range.
Lower reliability Type a value for the lower reliability level in electrical units. When the
level electrical value is below the lower reliability level, the Reliability is
Value under range.
04-16006-04-en, March 2015 Technical
763
22 I/O User Interface
22.25 Digital Input – Basic Settings Page
22.25 Digital Input – Basic Settings Page
Use the Basic Settings page to specify the the basic properties for the digital
input I/O point you create.
Figure: Digital Input - Basic Settings page
Table: Digital Input - Basic Settings Page
Component Description
Input channel Select the physical input channel on the I/O module. Selecting a
value of Null specifies that the input point is non-operational and can
be used as a placeholder. For more information, see section 21.1
“I/O Point Types” on page 663.
Label text Type the text that is printed on an I/O module label. For more
information, see section 22.39 “Print I/O Module Labels Dialog Box”
on page 785.
Invert Select either True or False. Selecting True inverts the value of a
digital input and configures a counter input to increment when the
contact opens.
LED color Select either Red or Green.
LED invert Select either True or False. Selecting True lights the LED when the
digital input is on and turns it off when the digital input is off.
Selecting False turns off the LED when the digital input is on and
turns on the LED when the digital input is off.
Technical 04-16006-04-en, March 2015
764
22 I/O User Interface
22.26 Resistive Input – Basic Settings Page
22.26 Resistive Input – Basic Settings Page
Use the Basic Settings page to specify the the basic properties for the resistive
input I/O point you create.
Figure: Resistive Input - Basic Settings page
Table: Resistive Input - Basic Settings Page
Component Description
Input channel Select the physical input channel on the I/O module. Selecting a
value of Null specifies that the input point is non-operational and can
be used as a placeholder. For more information, see section 21.1
“I/O Point Types” on page 663.
Label text Type the text that is printed on an I/O module label. For more
information, see section 22.39 “Print I/O Module Labels Dialog Box”
on page 785.
Digital filter Select True (On) or False (Off) to filter out noise and prevent false
readings.
Threshold Type a value for minimum change of value before the I/O module
reports the value to the Automation Server. Properly setting the
threshold value reduces unnecessary communication between the
I/O module and the Automation Server. For more information, see
section 21.27 “Threshold Settings for I/O Points” on page 712.
Top of scale Type a value to enter the top of the range engineering value for the
enginering value input point.
Top of scale Type a value to enter the top of the range voltage (VDC), current
electrical value (mA), or resistance (kohm) value for the input point scale.
04-16006-04-en, March 2015 Technical
765
22 I/O User Interface
22.26 Resistive Input – Basic Settings Page
Continued
Component Description
Bottom of scale Type a value for the bottom of the range engineering value for the
engineering input point scale.
value
Bottom of scale Type a bottom of the range voltage, (VDC), current (mA), or
electrical value resistance (kohm) value for the input point scale.
Unit Select the engineering unit in use, such as current, voltage, or
temperature.
Offset Type an offset value to be added to or subtracted from the
engineering value before it impacts the Value property.
Upper reliability Type a value for the upper reliability level in electrical units. When the
level electrical value is above the upper reliability level, the Reliability is
Value over range.
Lower reliability Type a value for the lower reliability level in electrical units. When the
level electrical value is below the lower reliability level, the Reliability is
Value under range.
Technical 04-16006-04-en, March 2015
766
22 I/O User Interface
22.27 2-Wire or 3-Wire RTD Resistive Input – Basic Settings Page
22.27 2-Wire or 3-Wire RTD Resistive Input –
Basic Settings Page
Use the Basic Settings page to specify the basic properties for the 2-wire or 3-
wire RTD resistive input point you create.
Figure: 2-Wire or 3-Wire RTD Resistive Input - Basic Settings page
Table: 2-Wire or 3-Wire RTD Resistive Input - Basic Settings Page
Component Description
Input channel Select the physical input channel on the I/O module. Selecting a
value of Null specifies that the input point is non-operational and can
be used as a placeholder. For more information, see section 21.1
“I/O Point Types” on page 663.
Label text Type the text that is printed on an I/O module label. For more
information, see section 22.39 “Print I/O Module Labels Dialog Box”
on page 785.
Digital filter Select True (On) or False (Off) to filter out noise and prevent false
readings.
Threshold Type a value for minimum change of value before the I/O module
reports the value to the Automation Server. Properly setting the
threshold value reduces unnecessary communication between the
I/O module and the Automation Server. For more information, see
section 21.27 “Threshold Settings for I/O Points” on page 712.
Top of scale Type a value to enter the top of the range engineering value for the
enginering value input point.
Top of scale Type a value to enter the top of the range voltage (VDC), current
electrical value (mA), or resistance (kohm) value for the input point scale.
04-16006-04-en, March 2015 Technical
767
22 I/O User Interface
22.27 2-Wire or 3-Wire RTD Resistive Input – Basic Settings Page
Continued
Component Description
Bottom of scale Type a value for the bottom of the range engineering value for the
engineering input point scale.
value
Bottom of scale Type a bottom of the range voltage, (VDC), current (mA), or
electrical value resistance (kohm) value for the input point scale.
Offset Type an offset value to be added to or subtracted from the
engineering value before it impacts the Value property.
Upper reliability Type a value for the upper reliability level in electrical units. When the
level electrical value is above the upper reliability level, the Reliability is
Value over range.
Lower reliability Type a value for the lower reliability level in electrical units. When the
level electrical value is below the lower reliability level, the Reliability is
Value under range.
Sensor class Select the sensor class to configure the RTD resisitive input for the
approximate range it will measure:
• 100 ohm based: measures a range from 50 to 220 ohm
• 1000 ohm based: measures a range from 500 to 2200 ohm
Technical 04-16006-04-en, March 2015
768
22 I/O User Interface
22.28 Supervised Input – Basic Settings Page
22.28 Supervised Input – Basic Settings Page
Use the Basic Settings page to specify the the basic properties for the supervised
input I/O point you create.
Figure: Supervised Input - Basic Settings page
Table: Supervised Input - Basic Settings Page
Component Description
Input channel Select the physical input channel on the I/O module. Selecting a
value of Null specifies that the input point is non-operational and can
be used as a placeholder. For more information, see section 21.1
“I/O Point Types” on page 663.
Label text Type the text that is printed on an I/O module label. For more
information, see section 22.39 “Print I/O Module Labels Dialog Box”
on page 785.
Supervised Select one of the following: Not set, None, NO Series, NC
circuit type Series, NO Parallel, NC Parallel. NO Series/Parallel, or NC
Series/Parallel (NO= normally open, NC= normally closed).
Supervised Type the value or use the up and down arrow keys to enter the
resistor value resistance value of the resistors in the supervised circuit.
04-16006-04-en, March 2015 Technical
769
22 I/O User Interface
22.29 Temperature Input – Basic Settings Page
22.29 Temperature Input – Basic Settings
Page
Use the Basic Settings page to specify the the basic properties for the
temperature input I/O point you create.
Figure: Temperature Input - Basic Settings page
Table: Temperature Input - Basic Settings Page
Component Description
Input channel Select the physical input channel on the I/O module. Selecting a
value of Null specifies that the input point is non-operational and can
be used as a placeholder. For more information, see section 21.1
“I/O Point Types” on page 663.
Label text Type the text that is printed on an I/O module label. For more
information, see section 22.39 “Print I/O Module Labels Dialog Box”
on page 785.
Digital filter Select True (On) or False (Off) to filter out noise and prevent false
readings.
Threshold Type a value for minimum change of value before the I/O module
reports the value to the Automation Server. Properly setting the
threshold value reduces unnecessary communication between the
I/O module and the Automation Server. For more information, see
section 21.27 “Threshold Settings for I/O Points” on page 712.
Thermistor type Select the appropriate thermistor type from the list.
Offset Type an offset value to be added to or subtracted from the
engineering value before it impacts the Value property.
Technical 04-16006-04-en, March 2015
770
22 I/O User Interface
22.29 Temperature Input – Basic Settings Page
Continued
Component Description
Upper reliability Type a temperature value for the upper reliability level. When the
level value is above the upper reliability level, the Reliability is Value over
range. For more information, see section 21.9 “2-Wire or 3-Wire
RTD-DI-16 Temperature Input Value and Reliability Levels” on page
679.
Lower reliability Type a temperature value for the lower reliability level. When the value
level is below the lower reliability level, the Reliability is Value under range.
For more information, see section 21.9 “2-Wire or 3-Wire RTD-DI-16
Temperature Input Value and Reliability Levels” on page 679.
04-16006-04-en, March 2015 Technical
771
22 I/O User Interface
22.30 2-Wire or 3-Wire RTD Temperature Input – Basic Settings Page
22.30 2-Wire or 3-Wire RTD Temperature
Input – Basic Settings Page
Use the Basic Settings page to specify the the basic properties for the 2-wire or
3-wire RTD temperature input point you create.
Figure: 2-Wire or 3-Wire Temperature Input - Basic Settings page
Table: 2-Wire or 3-Wire Temperature Input - Basic Settings Page
Component Description
Input channel Select the physical input channel on the I/O module. Selecting a
value of Null specifies that the input point is non-operational and can
be used as a placeholder. For more information, see section 21.1
“I/O Point Types” on page 663.
Label text Type the text that is printed on an I/O module label. For more
information, see section 22.39 “Print I/O Module Labels Dialog Box”
on page 785.
Digital filter Select True (On) or False (Off) to filter out noise and prevent false
readings.
Threshold Type a value for minimum change of value before the I/O module
reports the value to the Automation Server. Properly setting the
threshold value reduces unnecessary communication between the
I/O module and the Automation Server. For more information, see
section 21.27 “Threshold Settings for I/O Points” on page 712.
Sensor type Select a sensor type to determine how the resistance value is
converted to temperature.
Offset Type an offset in degrees to the converted temperature value.
Technical 04-16006-04-en, March 2015
772
22 I/O User Interface
22.30 2-Wire or 3-Wire RTD Temperature Input – Basic Settings Page
Continued
Component Description
Upper reliability Type a temperature value for the upper reliability level. When the
level value is above the upper reliability level, the Reliability is Value over
range. For more information, see section 21.9 “2-Wire or 3-Wire
RTD-DI-16 Temperature Input Value and Reliability Levels” on page
679.
Lower reliability Type a temperature value for the lower reliability level. When the value
level is below the lower reliability level, the Reliability is Value under range.
For more information, see section 21.9 “2-Wire or 3-Wire RTD-DI-16
Temperature Input Value and Reliability Levels” on page 679.
Wiring resistance Type a wiring resistance value. For more information, see section
21.8 “2-Wire RTD-DI-16 Temperature Input Wiring Resistance” on
page 678.
04-16006-04-en, March 2015 Technical
773
22 I/O User Interface
22.31 Voltage Input – Basic Settings Page
22.31 Voltage Input – Basic Settings Page
Use the Basic Settings page to specify the the basic properties for the voltage
input I/O point you create.
Figure: Voltage Input - Basic Settings page
Table: Voltage Input - Basic Settings Page
Component Description
Input channel Select the physical input channel on the I/O module. Selecting a
value of Null specifies that the input point is non-operational and can
be used as a placeholder. For more information, see section 21.1
“I/O Point Types” on page 663.
Label text Type the text that is printed on an I/O module label. For more
information, see section 22.39 “Print I/O Module Labels Dialog Box”
on page 785.
Digital filter Select True (On) or False (Off) to filter out noise and prevent false
readings.
Threshold Type a value for minimum change of value before the I/O module
reports the value to the Automation Server. Properly setting the
threshold value reduces unnecessary communication between the
I/O module and the Automation Server. For more information, see
section 21.27 “Threshold Settings for I/O Points” on page 712.
Top of scale Type a value to enter the top of the range engineering value for the
engineering input point.
value
Top of scale Type a value to enter the top of the range voltage (VDC), current
electrical value (mA), or resistance (kohm) value for the input point scale.
Technical 04-16006-04-en, March 2015
774
22 I/O User Interface
22.31 Voltage Input – Basic Settings Page
Continued
Component Description
Bottom of scale Type a value for the bottom of the range engineering value for the
engineering input point scale.
value
Bottom of scale Type a bottom of the range voltage, (VDC), current (mA), or
electrical value resistance (kohm) value for the input point scale.
Unit Select the engineering unit in use, such as current, voltage, or
temperature.
Offset Type an offset value to be added to or subtracted from the
engineering value before it impacts the Value property.
Upper reliability Type a value for the upper reliability level in electrical units. When the
level electrical value is above the upper reliability level, the Reliability is
Value over range.
Lower reliability Type a value for the lower reliability level in electrical units. When the
level electrical value is below the lower reliability level, the Reliability is
Value under range.
04-16006-04-en, March 2015 Technical
775
22 I/O User Interface
22.32 New I/O Module Wizard – Basic Settings Page
22.32 New I/O Module Wizard – Basic Settings
Page
Use the Basic Settings page to select a module ID for the I/O module you create.
Figure: Basic settings page
Table: Basic Settings Page
Component Description
Module ID Select Null or 1 to 32 for valid positions on
the I/O bus. Selecting a value of Null
specifies that the Module ID is non-
operational and can be used as a
placeholder to be configured when you wish
to assign it to a physical slot. You can place
multiple modules on the Null slot.
The Module ID is unique for logical modules.
For example, a UI8/DO-FC-4 module can
have a Digital Output point on output
channel 1 and a Temperature Input point on
input channel 1. The input and output are
different physical slots.
Override capability expected Check or uncheck this field depending upon
which modules you plan to connect. The
field indicates whether you would like the
module to be override capable. By default, it
is always checked.
Technical 04-16006-04-en, March 2015
776
22 I/O User Interface
22.33 Current Output – Basic Settings Page
22.33 Current Output – Basic Settings Page
Use the Basic Settings page to specify the basic properties for the current output
I/O point you create.
Figure: Current Output - Basic Settings page
Table: Current Output - Basic Settings Page
Component Description
Output channel Select the physical output channel on the I/O module. Selecting a
value of Null specifies that the output point is non-operational and
can be used as a placeholder. For more information, see section
21.1 “I/O Point Types” on page 663.
Label text Type the text that is printed on an I/O module label. For more
information, see section 22.39 “Print I/O Module Labels Dialog Box”
on page 785.
Requested value Enter a value that you want to assign to the output. This property
drives the output to a specific value. When the Requested value is
set, the output turns on and off and remains in that state unless the
I/O module loses communication with the Automation Server. 255
seconds later the default output value is used instead of the
requested value.
Default output Enter a default output value. The default output value is the value that
value the output reverts to if the I/O module loses communication with the
Automation Server for 255 seconds.
Threshold Type a value for minimum change of value before the I/O module
reports the value to the Automation Server. Properly setting the
threshold value reduces unnecessary communication between the
I/O module and the Automation Server. For more information, see
section 21.27 “Threshold Settings for I/O Points” on page 712.
04-16006-04-en, March 2015 Technical
777
22 I/O User Interface
22.33 Current Output – Basic Settings Page
Continued
Component Description
Top of scale Type a top of the range engineering value for the output point.
engineering Scaling applies a linear conversion to the value of the output points
value on an I/O module. For more information, see section 21.22 “Scaling
an Input or Output I/O Point” on page 703.
Top of scale Type a top of the range voltage (VDC) or current (mA) value for the
electrical value output point scale.
Bottom of scale Type a bottom of the range engineering value for the output point.
engineering
value
Bottom of scale Type a bottom of the range voltage (VDC) or current (mA) value for
electrical value the output point.
Unit Select the engineering unit in use, such as current, voltage, or
temperature.
Technical 04-16006-04-en, March 2015
778
22 I/O User Interface
22.34 Voltage Output – Basic Settings Page
22.34 Voltage Output – Basic Settings Page
Use the Basic Settings page to specify the basic properties for the voltage output
I/O point you create.
Figure: Voltage Output - Basic Settings page
Table: Basic Settings Page- Voltage Output
Component Description
Output channel Select the physical output channel on the I/O module. Selecting a
value of Null specifies that the output point is non-operational and
can be used as a placeholder. For more information, see section
21.1 “I/O Point Types” on page 663.
Label text Type the text that is printed on an I/O module label. For more
information, see section 22.39 “Print I/O Module Labels Dialog Box”
on page 785.
Requested value Enter a value that you want to assign to the output. This property
drives the output to a specific value. When the Requested value is
set, the output turns on and off and remains in that state unless the
I/O module loses communication with the Automation Server. 255
seconds later the default output value is used instead of the
requested value.
Default output Enter a default output value. The default output value is the value that
value the output reverts to if the I/O module loses communication with the
Automation Server for 255 seconds.
Threshold Type a value for minimum change of value before the I/O module
reports the value to the Automation Server. Properly setting the
threshold value reduces unnecessary communication between the
I/O module and the Automation Server. For more information, see
section 21.27 “Threshold Settings for I/O Points” on page 712.
04-16006-04-en, March 2015 Technical
779
22 I/O User Interface
22.34 Voltage Output – Basic Settings Page
Continued
Component Description
Top of scale Type a top of the range engineering value for the output point.
engineering Scaling applies a linear conversion to the value of the output points
value on an I/O module. For more information, see section 21.22 “Scaling
an Input or Output I/O Point” on page 703.
Top of scale Type a top of the range voltage (VDC) or current (mA) value for the
electrical value output point scale.
Bottom of scale Type a bottom of the range engineering value for the output point.
engineering
value
Bottom of scale Type a bottom of the range voltage (VDC) or current (mA) value for
electrical value the output point.
Unit Select the engineering unit in use, such as current, voltage, or
temperature.
Technical 04-16006-04-en, March 2015
780
22 I/O User Interface
22.35 Digital Output – Basic Settings Page
22.35 Digital Output – Basic Settings Page
Use the Basic Settings page to specify the basic properties for the digital output
I/O point you create.
Figure: Digital Output - Basic Settings page
Table: Digital Output - Basic Settings Page
Component Description
Output channel Select the physical output channel on the I/O module. Selecting a
value of Null specifies that the output point is non-operational and
can be used as a placeholder. For more information, see section
21.1 “I/O Point Types” on page 663.
Label text Type the text that is printed on an I/O module label. For more
information, see section 22.39 “Print I/O Module Labels Dialog Box”
on page 785.
Requested value Select either On or Off to set the Requested value. When the
Requested value is set, the output turns on or off and remains in that
state unless the I/O module loses communication with the
Automation Server. 255 seconds later the default output value is
used instead of the requested value.
Default output Select either On or Off to set the Default output value. The Default
value output value is the value that the output reverts to if the I/O module
loses communication with the Automation Server for 255 seconds.
Invert Select either False (not inverted) or True (inverted).
04-16006-04-en, March 2015 Technical
781
22 I/O User Interface
22.36 Digital Pulsed Output – Basic Settings Page
22.36 Digital Pulsed Output – Basic Settings
Page
Use the Basic Settings page to specify the basic properties for the digital pulsed
output I/O point you create.
Figure: Digital Pulsed Output - Basic Settings page
Table: Digital Pulsed Output - Basic Settings Page
Component Description
Output channel Select the physical output channel on the I/O module. Selecting a
value of Null specifies that the output point is non-operational and
can be used as a placeholder. For more information, see section
21.1 “I/O Point Types” on page 663.
Label text Type the text that is printed on an I/O module label. For more
information, see section 22.39 “Print I/O Module Labels Dialog Box”
on page 785.
Requested value Enter a value that you want to assign to the output. This property
drives the output to a specific value. When the Requested value is
set, the output turns on and off and remains in that state unless the
I/O module loses communication with the Automation Server. 255
seconds later the default output value is used instead of the
requested value.
The value of a digital pulsed output is On or Off since the output is
either On or Off at a given point in time.
Default output Enter a default output value. The default output value is the value that
value the output reverts to if the I/O module loses communication with the
Automation Server for 255 seconds.
Technical 04-16006-04-en, March 2015
782
22 I/O User Interface
22.36 Digital Pulsed Output – Basic Settings Page
Continued
Component Description
Unit Select the engineering unit in use, such as current, voltage, or
temperature.
Invert Select either False (not inverted) or True (inverted).
04-16006-04-en, March 2015 Technical
783
22 I/O User Interface
22.37 Tristate Output – Basic Settings Page
22.37 Tristate Output – Basic Settings Page
Use the Basic Settings page to specify the basic properties for the tristate output
I/O point you create.
Figure: Tristate Output - Basic Settings page
Table: Tristate Output - Basic Settings Page
Component Description
Output channel Select the physical output channel on the I/O module. Selecting a
value of Null specifies that the output point is non-operational and
can be used as a placeholder. For more information, see section
21.1 “I/O Point Types” on page 663.
Label text Type the text that is printed on an I/O module label. For more
information, see section 22.39 “Print I/O Module Labels Dialog Box”
on page 785.
Requested value Select either On, Off, or -On to set the Requested value. When the
Requested value is set, the output turns on or off and remains in that
state unless the I/O module loses communication with the
Automation Server. 255 seconds later the default output value is
used instead of the requested value.
Default output Select either On, Off, or -On to set the Default output value. The
value Default output value is the value that the output reverts to if the I/O
module loses communication with the Automation Server for 255
seconds.
Technical 04-16006-04-en, March 2015
784
22 I/O User Interface
22.38 Tristate Pulsed Output – Basic Settings Page
22.38 Tristate Pulsed Output – Basic Settings
Page
Use the Basic Settings page to specify the basic properties for the tristate pulsed
output I/O point you create.
Figure: Tristate Pulsed Output - Basic Settings page
Table: Tristate Pulsed Output - Basic Settings Page
Component Description
Output channel Select the physical output channel on the I/O module. Selecting a
value of Null specifies that the output point is non-operational and
can be used as a placeholder. For more information, see section
21.1 “I/O Point Types” on page 663.
Label text Type the text that is printed on an I/O module label. For more
information, see section 22.39 “Print I/O Module Labels Dialog Box”
on page 785.
Requested value Enter a value that you want to assign to the output. This property
drives the output to a specific value. When the Requested value is
set, the output turns on and off and remains in that state unless the
I/O module loses communication with the Automation Server. 255
seconds later the default output value is used instead of the
requested value.
For Tristate pulsed outputs, the Requested value is a value in
seconds + or -.
Default output Enter a default output value. The default output value is the value that
value the output reverts to if the I/O module loses communication with the
Automation Server for 255 seconds.
04-16006-04-en, March 2015 Technical
785
22 I/O User Interface
22.38 Tristate Pulsed Output – Basic Settings Page
Continued
Component Description
Unit Select the engineering unit in use, such as current, voltage, or
temperature.
Technical 04-16006-04-en, March 2015
786
22 I/O User Interface
22.39 Print I/O Module Labels Dialog Box
22.39 Print I/O Module Labels Dialog Box
Use the Print IO Module Labels dialog box to print labels to identify I/O channels
on the placard of the I/O module.
Figure: Print IO module labels dialog box
Table: Print IO Module Labels Dialog Box
Component Description
Blank Label Text Select to print labels with only the channel
number with no additional label text.
Paper Type Select the paper type for the label - letter or
A4.
Save Saves any changes to the point's label text
property.
Print Prints the I/O module label.
Exit Exits the Print IO Module Labels dialog
box.
04-16006-04-en, March 2015 Technical
787
22 I/O User Interface
22.40 Update I/O Module Firmware Dialog Box
22.40 Update I/O Module Firmware Dialog Box
Use the Update IO Module Firmware dialog box to update I/O module firmware.
Figure: Update IO module firmware dialog box
Table: Update IO Module Firmware Dialog Box
Button Description
Update Firmware Click to update the firmware in the selected
I/O module or modules. For more
information, see section 20.8 “Updating I/O
Module Firmware” on page 625..
Save Results to File Click to save the results of the update to a
text file.
Cancel Update Click to cancel the I/O module firmware
update.
Exit Click to exit the Update IO Module
Firmware dialog box.
Technical 04-16006-04-en, March 2015
788
23 Graphics Introduction
Topics
Graphics Editor Overview
Graphics Editor Libraries
Graphics in WorkStation
Creating a Graphic
Adjusting the Graphic Work Area
Saving a Graphic
Drawing Tools
Keyboard Shortcuts for Graphics Editor
Testing
Testing a Graphic in Preview Mode
23 Graphics Introduction
23.1 Graphics Editor Overview
23.1 Graphics Editor Overview
You can use Graphics Editor to create and edit graphics representing a site and the
devices that make up the site.
Important
You have to have a valid Graphics Editor license to start the Graphics Editor. For
more information, see the Licenses topic on WebHelp.
In Graphics Editor you can create advanced graphics. Graphics Editor contains
tools to make geometrical figures, symbols, texts, flexible data conversions,
animations, dynamics and interactivity. You can transform, move, align, arrange,
and distribute graphics objects in a work area in several ways.
Often used functionality, standard symbols and components representing common
functions are available in libraries delivered with Graphics Editor. You can add to
these libraries.
You can open and import graphics or photographs into Graphics Editor, paste
graphics into other graphics, and export from Graphics Editor.
You can link figures, for example, illustrations, symbols, and text, to database
objects in the Building Operation database. When the system is running, the
graphic objects can be displayed in WorkStation and automatically updated as
values at the site change.
You can print the graphics on any printer supported by Microsoft Windows.
A graphic component is a predefined graphic that contains one or several other
parts. Components are meant for reuse and typically represent a feature or a device
in a live system. Components can be designed as symbols which can be used as
building blocks and reused in several graphics. Components reside in dedicated
libraries and are displayed in the Components pane. The analog watch is an
example of a component.
When you design components, it is recommended that you set Graphics Editor
Component mode to Graphics.
04-16006-04-en, March 2015 Technical
791
23 Graphics Introduction
23.1 Graphics Editor Overview
Figure: Graphics Editor
When you create a new component, the default work area is 200x200 pixels (where
a pixel is the smallest possible drawing unit). A standard graphic work area is
600x800. This smaller work area is usually sufficient to draw a fairly detailed
component. When you use the component in the TGML graphic, however, the
component is automatically scaled to one fifth of the graphic size. This default size
of 40x40 pixels makes the component comparable in size to the ISO and DIN
standard components.
For more information, see section 34.5 “TGML File Format” on page 1022.
When you create a component, the root element, ComponentContent, is used
(instead of TGML for a graphic object). When the component is stored in a library
and used in a graphic, the ComponentContent element is replaced with the
Component element.
The root element of a component always includes at least two metadata elements
describing the component: Name and Description. These metadata elements
automatically get their values when you save the component.
The ComponentContent has the following properties:
• Opacity
• Visibility
• Height
• Width
Technical 04-16006-04-en, March 2015
792
23 Graphics Introduction
23.1 Graphics Editor Overview
The height and width values are copied to the ComponentHeight and
ComponentWidth properties of the Component element when you store the
component. When you use the component in a TGML graphic, however, the height
and width values are scaled to 20%, as mentioned above.
Thus, the component has one size when you use it in a graphic and another size
(usually larger) when you create or edit the component.
Components are stored as separate files in subfolders of the Components folder.
Typically, you would save different categories of components in different subfolders.
The subfolder names are displayed as separate bars in the Components pane.
Figure: Example of component categories
You can create and import components in several ways:
• Create a new component in Component mode of Graphics Editor
• Group and save as a component in Graphic mode of Graphics Editor
• Import components from an external source
In WorkStation, you can create graphics that you edit in Graphics Editor. Graphics
consist of one or several graphic objects. You can set properties for the graphic
objects to define their appearance and behavior.
You can create the graphic objects by using the drawing tools, by copying objects
from the work area, or by using instances of objects from the libraries delivered with
Graphics Editor.
All drawn objects belong to one of the following two groups:
• Graphics, that is, free-form drawings
• Components, that is, standardized graphics for defined reuse
04-16006-04-en, March 2015 Technical
793
23 Graphics Introduction
23.1 Graphics Editor Overview
23.1.1 Graphics
Graphics are representations of a site or parts of a site. Graphics can be made up
of figures, text and imported pictures. They can also contain components and
functions.
For more information, see section 23.3 “Graphics in WorkStation” on page 794.
23.1.2 Figures
A figure is the smallest independent element of a graphic, for example, a circle.
For more information, see section 33.1 “Figures” on page 967.
23.1.3 Components
Components are standardized, predefined graphics for defined use.
For more information, see section 24.1 “Components” on page 809.
23.1.4 Layers
When creating complex graphics, it can be a challenge to keep track of all the
graphic figures in the work area. Graphic figures get hidden under one another and
selecting becomes difficult. Layers provide a way to manage the graphic figures
that make up your graphic. Layers can be regarded as folders that contain graphic
figures.
For more information, see section 31.1 “Layers” on page 945.
Technical 04-16006-04-en, March 2015
794
23 Graphics Introduction
23.2 Graphics Editor Libraries
23.2 Graphics Editor Libraries
When Graphics Editor is installed, the following folders are normally used.
23.2.1 Folder for Brushes, Components and Snippets
At the installation of the graphics editor, or delivered as a separate package, a
number of symbols and other tgml components are stored in:
C:\Program Data\Schneider Electric StruxureWare\Building Operation [X.X version
number]\Graphics Editor
Frequently used objects, animations, and behaviors are collected in the following
subfolders.
Folder Usage
\Brushes The Colors and Gradients palettes are
stored here.
\Components Standard symbols with specific meaning, as
well as some other common symbols, are
stored as components in the Components
library, available in one of the window panes.
A component can be dragged and dropped
directly into the Design pane. New
components can be added to the library.
\Snippets A snippet is a piece of TGML code whose
purpose is to store a “behavior” for reuse. A
number of common behaviors are stored in
the Snippets pane.
A snippet can be dragged and dropped on
an object in the Objects pane.
Objects can be copied and modified, even
created, and then saved as new snippets in
the library.
All subfolders in the Components library are displayed as clickable bars in the
Components pane. All *.tgmlcomponent files in such a subfolder are displayed as
selectable components under the corresponding bar.
Similarly, all subfolders in the Snippets library are displayed as clickable bars in the
Snippets pane. All *.tgmlsnippet files in such a subfolder are displayed as selectable
snippets under the corresponding bar.
04-16006-04-en, March 2015 Technical
795
23 Graphics Introduction
23.3 Graphics in WorkStation
23.3 Graphics in WorkStation
Graphics are representations of a site or parts of a site. Graphics can be made up
of figures, text and imported pictures. They can also contain components and
functions.
In WorkStation, graphics are represented by a graphics icon.
Figure: Graphics in WorkStation
You can view graphics in the graphics viewer.
Technical 04-16006-04-en, March 2015
796
23 Graphics Introduction
23.3 Graphics in WorkStation
Figure: Graphics viewer in WorkStation
04-16006-04-en, March 2015 Technical
797
23 Graphics Introduction
23.4 Creating a Graphic
23.4 Creating a Graphic
You create a graphic object in WorkStation to make a container for the graphic that
you create in Graphics Editor.
For more information, see section 23.3 “Graphics in WorkStation” on page 794.
To create a graphic
1. In WorkStation, in the System Tree pane, select the folder or server where
you want to create the graphic.
2. On the File menu, point to New and then click Graphic.
3. In the Name box, type a name for the graphic.
4. In the Description box, type a description for the graphic.
5. Click Next.
Continued on next page
Technical 04-16006-04-en, March 2015
798
23 Graphics Introduction
23.4 Creating a Graphic
6. In the File box, enter a .tgml file if the graphic has already been created using
Graphics Editor.
7. Click Create.
04-16006-04-en, March 2015 Technical
799
23 Graphics Introduction
23.5 Adjusting the Graphic Work Area
23.5 Adjusting the Graphic Work Area
You adjust the graphic work area when you initially edit the graphic in order to
ensure the work area settings, such as graphic size and background color, are
appropriately defined for display in WorkStation.
For more information, see section 24.1 “Components” on page 809.
To adjust the graphic work area
1. In WorkStation, in the System Tree pane, select the graphic you want to
edit.
2. On the Actions menu, click Edit.
3. In Graphics Editor, in the Objects pane, select the Tgml element.
4. In the Properties pane, in the Background box, select the background
color.
5. In the Stretch box, select the the behavior of the graphic when displayed in
WorkStation.
6. In the Height box, type the value for the height of the work area.
Continued on next page
Technical 04-16006-04-en, March 2015
800
23 Graphics Introduction
23.5 Adjusting the Graphic Work Area
7. In the Width box, type the value for the width of the work area.
8. On the File menu, click Save.
04-16006-04-en, March 2015 Technical
801
23 Graphics Introduction
23.6 Saving a Graphic
23.6 Saving a Graphic
When you have created a graphic you can save it to the database.
To save a graphic
1. In Graphics Editor, on the File menu, click Save.
Important
• You can only save a graphic in Preview mode.
• If you choose to save by using the Save As command the link to
the database is broken and you have to define the location
where you want to save the .Tgml graphics file in the file system.
Technical 04-16006-04-en, March 2015
802
23 Graphics Introduction
23.7 Drawing Tools
23.7 Drawing Tools
Use the Graphics Editor drawing tools to add lines, polylines, curves, polygons,
rectangles, ellipses, arcs, pies, texts, and textboxes to a graphic.
23.7.1 Lines
Use the Graphics Editor Line tool to draw a straight line, that is, a line between two
points.
For more information, see section 33.2 “Lines” on page 969.
23.7.2 Polylines
Use the Graphics Editor Polyline tool to draw a line with several nodes, that is, a
line with angles.
For more information, see section 33.9 “Polygons” on page 976.
23.7.3 Curves
Use the Graphics Editor Curve tool to draw a curve, that is, a line that is not
straight.
For more information, see section 33.6 “Curves” on page 973.
23.7.4 Polygons
Use the Graphics Editor Polygon tool to draw a polygon, that is, a plane figure that
is bounded by a closed path, composed of a finite sequence of straight line
segments.
For more information, see section 33.9 “Polygons” on page 976.
23.7.5 Rectangle
Use the Graphics Editor Rectangle tool to draw a simple rectangle, that is, a
quadrilateral with four right angles.
For more information, see section 33.11 “Rectangles” on page 979.
23.7.6 Ellipses
Use the Graphics Editor Ellipse tool to draw an ellipse, that is, a plane curve that
results from the intersection of a cone by a plane in a way that produces a closed
curve.
For more information, see section 33.14 “Ellipses” on page 982.
04-16006-04-en, March 2015 Technical
803
23 Graphics Introduction
23.7 Drawing Tools
23.7.7 Arcs
Use the Graphcis Editor Arc tool to draw an arc, that is, a part of the periphery of
an ellipse, or a circle.
For more information, see section 33.18 “Arcs” on page 987.
23.7.8 Pies
Use the Graphics Editor Pie tool to draw a pie, that is, an area enclosed by two
radii of a circle and their intercepted arc.
For more information, see section 33.19 “Pies” on page 988.
23.7.9 Texts and Textboxes
Use the Graphics Editor Text tool to write a single line of text with no wrapping.
Use the Graphics Editor Textbox tool to write one or several lines of text that are
wrapped within the specified box.
For more information, see section 33.22 “Texts and Textboxes” on page 991.
23.7.10 Pictures
Use the Graphics Editor Insert Pictures tool to insert supported image files into
your graphic.
For more information, see section 33.30 “Pictures” on page 1001.
Technical 04-16006-04-en, March 2015
804
23 Graphics Introduction
23.8 Keyboard Shortcuts for Graphics Editor
23.8 Keyboard Shortcuts for Graphics Editor
You can acces most of the Graphics Editor commands by using keyboard
shortcuts.
Table: Graphics Editor Keyboard Shortcuts
Press To
CTRL+N Start a new graphic
CTRL+O Open an existing graphic
CTRL+S Save the current graphic
CTRL+SHIFT+S Save the current graphic in a specified
location and with a specified file name
CTRL+SHIFT+P Preview a print
CTRL+P Print graphic
CTRL+F4 Close the current graphic
ALT+F4 Close the current graphic and exit the
program
CTRL+Z Undo the latest change
CTRL+Y Revert the latest Undo command
F6 Set Design mode
F7 Set Source mode
F8 Set Preview mode
F11 Toggle between hiding and showing all
panes
F12 Toggle between hiding and showing the
Objects and Properties panes
F1 Access Help
F2 Rename
F5 Refresh
CTRL+SHIFT+F6 Go to a previous graphic
CTRL+F6 Go to a later graphic
CTRL+0 Zoom
CTRL+1 Select
CTRL+2 Use the Line tool
04-16006-04-en, March 2015 Technical
805
23 Graphics Introduction
23.8 Keyboard Shortcuts for Graphics Editor
Continued
Press To
CTRL+3 Use the Polyline tool
CTRL+4 Use the Curve tool
CTRL+5 Use the Polygon tool
CTRL+6 Use the Rectangle tool
CTRL+7 Use the Ellipse tool
CTRL+8 Use the Arc tool
CTRL+9 Use the Pie tool
CTRL+T Use the Text tool
CTRL+SHIFT+T Use the Textbox tool
CTRL+X Cut
CTRL+C Copy
CTRL+V Paste
DEL Delete
CTRL+F Find
CTRL+H Find and replace
CTRL+A Select all
CTRL+D Clear all
CTRL+SHIFT+Space Toggle to show or hide the grid
CTRL+Space Toggle to snap or unsnap to the grid
CTRL+G Group figures
CTRL+SHIFT+G Ungroup figures
CTRL+Mouse wheel up Zoom in
CTRL+Mouse wheel down Zoom out
+ (on numeric keyboard) Zoom in
– (on numeric keyboard) Zoom out
CTRL+* (on num. keyboard) Restore to original size
Arrow keys Move the selected figure to next grid point if
Snap to Grid is activated
ALT+ Arrow keys Move the selected figure one pixel
Technical 04-16006-04-en, March 2015
806
23 Graphics Introduction
23.9 Testing
23.9 Testing
You can test the behavior of graphics and components offline in Preview mode by
setting test values in the Test pane.
Any graphic or component with an associated name and a Bind object, is displayed
in the Test pane.
You enter test values in the Value column, and set an optional Unit.
You can also test the behavior for certain signal status values. The Status column
contains a drop-down menu where you can select four kinds of status:
• Error
• Database value
• Value from devide
• Forced value
By default, Error status is handled by the graphic (the figure is crossed over in red).
Other status types can be modified by user-written Java scripts.
Figure: An example on testing values in Preview mode
04-16006-04-en, March 2015 Technical
807
23 Graphics Introduction
23.10 Testing a Graphic in Preview Mode
23.10 Testing a Graphic in Preview Mode
You test the animation, snippets, and other parts of a graphic to ensure it works the
way it is intended to.
For more information, see section 23.9 “Testing” on page 805.
To test a graphic in Preview mode
1. In Graphics Editor, on the menu bar, click Preview to open the graphic in
preview mode.
2. On the menu bar, click View and then click Test.
3. In the Test pane, in the Value column, type the value for the drawing object
for which you want to test the behavior.
4. In the Status column select Forced value.
5. In the work area, check the behavior.
Technical 04-16006-04-en, March 2015
808
24 Components and Snippets
Topics
Components
Component Design
Documenting and Saving a Component
Inhibiting Clipping
Controlling the Appearance of the Component
Grouping Drawing Objects as a Component
Adding a Component
Creating a New Component
Editing a Component
Saving as a Component
Snippets
Adding a Snippet
Saving as a Snippet
24 Components and Snippets
24.1 Components
24.1 Components
Components are standardized, predefined graphics for defined use.
All drawn objects are either graphics, that is, free-form drawings or components. A
component contains one or several graphic figures. It can also have predefined
functionality. Components typically represent a feature or a component in a live
system. Components can be designed as symbols, which can be used as building
blocks in graphics. Components are located in dedicated libraries and are displayed
in the Components pane. An analog gauge is an example of a component.
24.1.1 Component Design
You create a component to make, for example, a symbol or a well-defined function
available for future reuse.
For more information, see section 24.2 “Component Design” on page 811.
24.1.2 Categories
Standard components and functions are categorized in logical groups.
For more information, see section 26.1 “Categories” on page 839.
24.1.3 Snippets
Snippets are standardized, predefined functions for defined use.
For more information, see section 24.11 “Snippets” on page 828.
24.1.4 Properties
Each element in the Objects pane has a number of properties. The Graphics Editor
object properties are referred to as attributes, in compliance with XML standards.
The attributes are displayed in the Properties pane, where they can be edited.
Attributes are used to give a complete description of a graphic object. Most of the
attributes are automatically defined when the graphic object is created. By
changing the attributes, you can change, for example, the appearance and
behavior of a graphic object.
For more information, see section 27.1 “Attributes” on page 851.
24.1.5 Binds and Links
A dynamic graphic object can be bound to, and thus controlled by, server variables
(signals). When the signal changes the behavior or appearance of the object
changes dynamically.
For more information, see section 28.1 “Binds and Links” on page 871.
04-16006-04-en, March 2015 Technical
811
24 Components and Snippets
24.1 Components
24.1.6 Editing Tools
You can edit all graphic objects, that is, modify their properties. For example,
shape, size, and color.
For more information, see section 30.2 “Graphics Editing Tools” on page 896.
Technical 04-16006-04-en, March 2015
812
24 Components and Snippets
24.2 Component Design
24.2 Component Design
You create a component to make, for example, a symbol or a well-defined function
available for future reuse.
24.2.1 The Design Process
You can create a component in two ways:
• Compose your graphics and group the elements as a Component. You then
save the component in a category in the Components pane, or
• Open the component editor, draw your component and save it in a
components category.
Note
• When a component is edited in the components editor, the root element is
called ComponentContent. The element has two metadata elements that
contain the name of the component and the description. These elements are
not present when the component is used in a graphic.
24.2.2 Component Documentation and Saving
To make a component easy to understand and use, you add a description including
all or parts of the following:
• A descriptive name
• A short, comprehensive description of the function
• Notes on the usage
• Exposed properties
• Links or Bindings, if any
You type the information in the Properties dialog box when saving the component.
04-16006-04-en, March 2015 Technical
813
24 Components and Snippets
24.2 Component Design
Figure: Component properties
You can edit the name and description of a component in the Component library by
editing the properties of the component.
Tip
To get a new line in the description, press CTRL+ENTER. Pressing ENTER alone
has the same effect as clicking OK.
Technical 04-16006-04-en, March 2015
814
24 Components and Snippets
24.3 Documenting and Saving a Component
24.3 Documenting and Saving a Component
You enter a description to document a component.
Note
• To make your components useful to others, you can document and save
them in a standardized way.
For more information, see section 24.2 “Component Design” on page 811.
To document and save a component
1. In Graphics Editor, on the File menu, point to Save As and then click
Component.
2. Select the category in which you want to save the component.
3. Click OK.
4. In the Name box, type the name of the component.
Continued on next page
04-16006-04-en, March 2015 Technical
815
24 Components and Snippets
24.3 Documenting and Saving a Component
5. In the Description box, type a description using this structure:
Short description of the function.
Special notes, if any
==Bindings==, or ==Links==
Name of Binding/Link: Explanation of signal
==Exposed Properties==
Name of Property: Explanation of property
6. Click OK.
The component is now saved in the selected category and can be used in other
graphics.
Technical 04-16006-04-en, March 2015
816
24 Components and Snippets
24.4 Inhibiting Clipping
24.4 Inhibiting Clipping
You inhibit clipping to prevent borders of a component from partly disappearing
when the component is used in a larger graphic.
For more information, see section 24.2 “Component Design” on page 811.
To inhibit clipping
1. In Graphics Editor, in the Objects pane, select ComponentContent.
2. In the Properties pane, right-click in any input field, and then click Add.
3. In the Add a Custom Attribute dialog box, in the Attribute box, type 'Clip.
In the Value box, type 'False'.
4. Click OK.
In the Properties pane, the Content attribute has been added and its Clip
property is set to False.
04-16006-04-en, March 2015 Technical
817
24 Components and Snippets
24.5 Controlling the Appearance of the Component
24.5 Controlling the Appearance of the
Component
You use the Bind object to control the appearance of a component.
Note
• You only bind an exposed property.
• You can also use the Control element to control the appearance of a
component.
For more information, see section 27.6 “Exposed Properties” on page 863.
To control the appearance of a component
1. In Graphics Editor, in the Objects pane, right-click the element you want the
Bind element to control, point to New, and then click Bind.
Continued on next page
Technical 04-16006-04-en, March 2015
818
24 Components and Snippets
24.5 Controlling the Appearance of the Component
2. In the Objects pane, right-click the bind element, point to New, and then
click the required number of Convert elements.
3. In the Properties pane, set the behavior for the Convert element.
4. On the View menu, click Test to open the Test pane.
Continued on next page
04-16006-04-en, March 2015 Technical
819
24 Components and Snippets
24.5 Controlling the Appearance of the Component
5. Click Preview.
6. In the Test pane, test the behavior by entering test values.
By using Inherit, Expose and Bind, you can design a standardized component
whose appearance is easily controlled by an external signal.
Technical 04-16006-04-en, March 2015
820
24 Components and Snippets
24.6 Grouping Drawing Objects as a Component
24.6 Grouping Drawing Objects as a
Component
You group multiple drawing objects within a graphic as a component for bind
naming and graphics design efficiency. In order to save your work to a components
library for reuse, the drawing elements must be grouped as a component.
To group drawing objects as a component
1. In Graphics Editor, in the Layers pane, select the layer that contains the
drawing objects you want to group.
2. On the work area, select all drawing objects that you want to group as a
component.
3. Right-click the selected objects, point to Group as, and then click
Component.
4. On the File menu, click Save.
04-16006-04-en, March 2015 Technical
821
24 Components and Snippets
24.7 Adding a Component
24.7 Adding a Component
You add components to the graphic instead of drawing all the drawing objects
yourself to simplify the graphics creation process.
For more information, see section 24.1 “Components” on page 809.
To add a component
1. In Graphics Editor, in the Layers pane, select the layer where you want to add
the component.
2. In the Components pane, click the component category tab that contains
the component you want to use.
3. Select the component you want to add.
4. Drag the component to the work area.
5. In the Properties pane, in the Name box, type the name of the component.
Note
You only need to name the drawing object if you will be binding the
object. Naming the object now will help you identify the object later.
Continued on next page
Technical 04-16006-04-en, March 2015
822
24 Components and Snippets
24.7 Adding a Component
6. On the Options toolbar or in the Properties pane, adjust the appearance of
the component.
7. On the File menu, click Save.
04-16006-04-en, March 2015 Technical
823
24 Components and Snippets
24.8 Creating a New Component
24.8 Creating a New Component
You create a new component when you want to create a design that represents a
feature or a component in a live system and want this design to be available for
reuse. The component can be, for example, a button or a representation of a fan.
For more information, see section 24.1 “Components” on page 809.
To create a new component
1. In Graphics Editor, on the File menu, point to New, and then click
Component.
2. In the work area, design the appearance of the component.
3. On the File menu, point to Save As and then click Component.
4. In the Components tree, select the category where you want to save the
component.
5. Click OK.
6. In the Name box, type the name of the component.
7. In the Description box, type a description for the component. The
description is displayed as a ToolTip for the component in the Components
pane.
Continued on next page
Technical 04-16006-04-en, March 2015
824
24 Components and Snippets
24.8 Creating a New Component
8. In the Height and Width boxes, enter the size the component gets when
used in a drawing.
9. Click OK.
Note
• When you create a new component, a work area opens and a
ComponentContent root element appears in the Objects pane.
The name you give the component is also the file name the component gets when
saved (with the suffix .tgmlcomponent). The new component is now displayed in the
selected category in the Components pane, and is ready to use in other graphics.
04-16006-04-en, March 2015 Technical
825
24 Components and Snippets
24.9 Editing a Component
24.9 Editing a Component
You edit a component when you have an original component and want to reuse a
number of its properties. You then save the edited version under a different name or
in a different category.
For more information, see section 24.2 “Component Design” on page 811.
To edit a component
1. In Graphics Editor, in the Components pane, select the category containing
the component you want to edit.
2. Right-click the component and click Edit.
3. In the Components work area, edit the component.
4. On the File menu, point to Save As and click Component.
Continued on next page
Technical 04-16006-04-en, March 2015
826
24 Components and Snippets
24.9 Editing a Component
5. Select the category where you want to save the edited component.
6. Click OK.
7. In the Name box, type the name of the component.
8. In the Description box, type a description to make the component easier to
identify.
9. In the Height and Width boxes, specify the size of the component.
10. Click OK.
The edited component is saved in the selected category and under the specified
name.
04-16006-04-en, March 2015 Technical
827
24 Components and Snippets
24.10 Saving as a Component
24.10 Saving as a Component
You save your components in the Components library so that they are available for
future use.
For more information, see section 24.1 “Components” on page 809.
To save as a component
1. In Graphics Editor, on the work area, select the component you want to save
to highlight it in the Objects pane.
2. From the Objects pane, drag the component to the components category
that you want to add the component to.
Important
You have to drag the component from the Objects pane. You can
not drag the component from the work area.
3. In the Properties dialog box, in the Name box, type the name you want to
display in the components category.
4. In the Description box, type the description you want to display as the
tooltip in the components category.
Continued on next page
Technical 04-16006-04-en, March 2015
828
24 Components and Snippets
24.10 Saving as a Component
5. In the Height box, type the height you want the component to have when it is
added to the work area.
6. In the Width box, type the width you want the component to have when it is
added to the work area.
7. Select Use default scale (0x0) to give the component the default size when
it is added to the work area.
8. Click OK.
The component is now saved in the Components library for use in the current
graphic and future graphics.
04-16006-04-en, March 2015 Technical
829
24 Components and Snippets
24.11 Snippets
24.11 Snippets
Snippets are standardized, predefined functions for defined use.
Snippets typically represents a feature in a live system. Snippets are located in
dedicated libraries and are displayed in the Snippets pane. Blink, which starts and
stops a blink animation, is an example of a snippet.
By default, Graphics Editor uses two dedicated folders, containing subfolders, for
Components and Snippets. The folders are installed with the software. If your
computer runs on Windows 7 or Windows 8.1 the components and snippets
folders have the following paths:
C:\Users\[User name]\Documents\StruxureWare\Graphics Editor\Components or
Snippets\
The subfolders are displayed as categories in the Components and Snippets
panes.
Libraries can be located anywhere on the local disk.
You can show and hide categories from a selected library. You can add categories.
Technical 04-16006-04-en, March 2015
830
24 Components and Snippets
24.12 Adding a Snippet
24.12 Adding a Snippet
You add snippets to a graphic to add pre-programmed behaviors, such as colors
changing according to the state of a point or numerically displayed values.
To add a Snippet
1. In Graphics Editor, in the Layers pane, select the layer where you want to add
the snippet.
2. In the Snippet pane, select the snippet category tab that contains the snippet
you want to use.
3. Select the snippet you want to add to the graphic.
4. Drag the snippet to the work area or to a drawing object.
5. On the Drawing toolbar, click Select.
6. On the Options toolbar or in the Properties pane, adjust the appearance of
the snippet.
7. On the File menu, click Save.
04-16006-04-en, March 2015 Technical
831
24 Components and Snippets
24.13 Saving as a Snippet
24.13 Saving as a Snippet
You save your bind objects as snippets in the Snippets library so that they are
available for future use.
To save as a snippet
1. In Graphics Editor, in the Objects Pane, select the Bind object that you want
to save to the Snippets library.
2. Drag the Bind object to the snippet category that you want to add the snippet
to.
3. In the Properties dialog box, in the Name box, type the name you want to
display in the snippets category.
4. In the Description box, type the description that you want to display as the
ToolTip in the Snippets category.
5. Click Ok.
The snippet is now saved in the Snippets library for use in the current graphic and
future graphics.
Technical 04-16006-04-en, March 2015
832
25 Printing and Testing
Topics
Printing Graphics
Setting Up a Page for Printing
Previewing a Print
25 Printing and Testing
25.1 Printing Graphics
25.1 Printing Graphics
You print a graphic, for example, to present it to a customer or to get an overview.
To print graphics
1. In Graphics Editor, on the File menu, point to Print, and then click Print.
2. In the Print dialog box, select the printer you want to use and set other print
options.
3. Click Print.
04-16006-04-en, March 2015 Technical
835
25 Printing and Testing
25.2 Setting Up a Page for Printing
25.2 Setting Up a Page for Printing
You set up a page for printing to print a graphic in a specified way.
To set up a page for printing
1. In Graphics Editor, on the File menu, point to Print, and then click Page
settings.
2. In the Page Setup dialog box, enter paper size, orientation, margins and
other properties.
3. Click OK.
Note
• The print settings apply for all printouts until you change them.
Technical 04-16006-04-en, March 2015
836
25 Printing and Testing
25.3 Previewing a Print
25.3 Previewing a Print
You preview a print to make sure the printed page will turn out the way you
intended.
To preview a print
1. In Graphics Editor, on the File menu, point to Print, and then click Print
preview.
2. In the Print preview dialog box, set the amount of pages you want the
graphic to print on.
3. Click Close when finished.
04-16006-04-en, March 2015 Technical
837
26 Categories
Topics
Categories
Creating a Category
Selecting a Category
Renaming a Category
Hiding a Category
Displaying a Hidden Category
Importing a Components Category
Importing a Snippets Category
Exporting a Category
Deleting a Category
26 Categories
26.1 Categories
26.1 Categories
Standard components and functions are categorized in logical groups.
The following groups are delivered with Graphics Editor:
• Basic Controls
Control and sensor devices and buttons of different kinds.
• DIN Symbols (EN)
English standard ISO symbols
• ISO Symbols
Standard ISO symbols
• My Components
An empty folder where you can save components you want to make available
for reuse.
• Basic Functions
Functions of different kinds.
• My Snippets
An empty folder where you can save functions you want to make available for
reuse.
For more information, see section 36.13 “Components Pane” on page 1165.
Note
• The categories listed above are read-only, and cannot be deleted.
The different categories are displayed as bars in the Components and Snippets
panes. You can hide unused categories.
You can display hidden categories, or categories that reside in other libraries, in the
Components pane.
You can store categories of components in other libraries. To make new libraries
accessible from the Components pane, you have to add them to the list of available
libraries.
When you import or export categories of components, or create new categories,
the default library is used. You can set any components library folder as the default
library.
04-16006-04-en, March 2015 Technical
841
26 Categories
26.2 Creating a Category
26.2 Creating a Category
You create a category when you want to organize your components in the
Components pane or snippets in the Snippets pane.
For more information, see section 26.1 “Categories” on page 839.
To create a category
1. In the Components pane or in the Snippets pane, right-click and then click
New Category.
2. In the box, type a name for the category.
3. Click OK.
The new category is displayed as a tab in the Components pane or Snippets
pane.
Technical 04-16006-04-en, March 2015
842
26 Categories
26.3 Selecting a Category
26.3 Selecting a Category
You select a components or snippets category to display its content in the Graphics
Editor, or before performing an operation on the category.
For more information, see section 26.1 “Categories” on page 839.
To select a category
1. In Graphics Editor, in the Components pane or in the Snippets pane, click
the tab of the category you want to select.
The content of the selected category is displayed in the pane.
04-16006-04-en, March 2015 Technical
843
26 Categories
26.4 Renaming a Category
26.4 Renaming a Category
You rename a components or snippets category to better reflect the contents.
For more information, see section 26.1 “Categories” on page 839.
To rename a category
1. In the Components pane or Snippets pane, select the category you want to
rename.
2. Right-click an empty space in the selected category and then click Rename
Category.
3. In the box, type a new name for the category.
4. Click OK.
The selected category is displayed with its new name in the Components pane or
Snippets pane.
Technical 04-16006-04-en, March 2015
844
26 Categories
26.5 Hiding a Category
26.5 Hiding a Category
Hide a components or snippets category when you do not want to display it in the
Components pane or Snippets pane.
For more information, see section 26.1 “Categories” on page 839.
To hide a category
1. In the Components pane or Snippets pane, click the X to the right on the
specific tab of the category you want to hide.
The selected category disappears from the Components pane or Snippets
pane.
04-16006-04-en, March 2015 Technical
845
26 Categories
26.6 Displaying a Hidden Category
26.6 Displaying a Hidden Category
You display component or snippet categories that are hidden to make them
available in the component or snippet library for use in Graphics Editor.
For more information, see section 26.1 “Categories” on page 839.
To display a hidden category
1. In Graphics Editor, in the Components pane or Snippets pane, right-click
and then click Categories. in the Components pane, right-click and then
click Categories.
2. On the Components tab, select the category that you want to display.
3. Click Close.
Technical 04-16006-04-en, March 2015
846
26 Categories
26.7 Importing a Components Category
26.7 Importing a Components Category
You import a components category into the components library to be able to reuse
the components between different Building Operation projects.
For more information, see section 26.1 “Categories” on page 839.
To import a components category
1. In Graphics Editor, in the Components pane, right-click and then click
Import.
2. Select the .tgmlcomponentArchive file that contains the components you want
to import.
3. Click OK.
04-16006-04-en, March 2015 Technical
847
26 Categories
26.8 Importing a Snippets Category
26.8 Importing a Snippets Category
You import a snippets category into the snippets library to be able to reuse the
snippets between different Building Operation projects.
For more information, see section 26.1 “Categories” on page 839.
To import a snippets category
1. In Graphics Editor, in the Snippets pane, right-click and then click Import.
2. Select the .tgmlsnippetArchive file that contains the snippets you want to
import.
3. Click OK.
The ímported snippets category is displayed as a tab in the Snippets pane.
Technical 04-16006-04-en, March 2015
848
26 Categories
26.9 Exporting a Category
26.9 Exporting a Category
You export component or snippets categories to create a component archive file or
a snippet archive file, which in turn can be imported into the component or snippet
library of Graphics Editor on other computers.
For more information, see section 24.2 “Component Design” on page 811.
To export a category
1. In Graphics Editor, right-click anywhere in the Components pane or
Snippets pane and then click Export.
2. Browse to the location where you want to save the export file.
3. In the File name box, verify or type a new name for the export file.
4. Click Save.
04-16006-04-en, March 2015 Technical
849
26 Categories
26.10 Deleting a Category
26.10 Deleting a Category
You delete a components or snippets category when you no longer need it.
For more information, see section 26.1 “Categories” on page 839.
To delete a category
1. In the Components pane or Snippets pane, select the category you want to
delete.
2. Right-click an empty space in the category and then click Delete Category.
3. Click OK.
The selected category is deleted from the database.
Technical 04-16006-04-en, March 2015
850
27 Attributes
Topics
Attributes
Graphic Object Attributes
Inherited Attributes
Defining Inheritance
Setting Up Inherited Properties
Exposed Properties
Adding an Expose Element
Exposing a Property
Modifying the Behavior of a Component
27 Attributes
27.1 Attributes
27.1 Attributes
Each element in the Objects pane has a number of properties. The Graphics Editor
object properties are referred to as attributes, in compliance with XML standards.
The attributes are displayed in the Properties pane, where they can be edited.
Attributes are used to give a complete description of a graphic object. Most of the
attributes are automatically defined when the graphic object is created. By
changing the attributes, you can change, for example, the appearance and
behavior of a graphic object.
The Properties pane has two modes, where you can define which level of detail you
want displayed.
• Normal
• Detailed
Normal mode displays the most commonly edited attributes. Detailed mode
displays all attributes.
You can add attribute values, for example, Name. Some attributes describe a
dynamic behavior and the attributes become apparent only when the graphic is
used in a dynamic environment, for example, as an online graphic accessible in
WorkStation Graphics viewer.
For some of the attributes in the Properties pane, a label is displayed at the bottom
of the pane when you select the attribute.
Figure: Attribute label in the Properties pane
Often an information text, with information on how the specific attribute gets its
value, is displayed below the label:
(blank)
The value has been chosen when the object was created and applies to this object.
Default value
The value was set by default when the object was created and applies to this
object.
04-16006-04-en, March 2015 Technical
853
27 Attributes
27.1 Attributes
Inherited value
The object is a part of a parent object and has inherited its value from the parent.
This information can be useful when you create more complex objects, where
attribute inheritance is used. For more information, see section 27.3 “Inherited
Attributes” on page 854.
Different objects and items have different attributes, which are described with each
item, but some general rules apply.
There are different categories of graphic object attributes
• Generic attributes
• Appearance, Position and Size attributes
• Behavior, Boundary and Target attributes
27.1.1 Graphic Object Attributes
All graphic objects that you use in a graphic have attributes, that is properties, that
describe the object. For example, shape, position, appearance, and dynamic
behavior.
For more information, see section 27.2 “Graphic Object Attributes” on page 853.
27.1.2 Inherited Attributes
You can define inheritance to enable child objects to inherit attributes from a parent
or any other ancestor object. A parent object can be, for example, a Group object.
A child object can be, for example, a graphic object in a group.
For more information, see section 27.3 “Inherited Attributes” on page 854.
27.1.3 Exposed Properties
You can make certain attributes of a component accessible from outside the
component. For example, you can use the Fill attribute to let an external signal
change the color of a component. You add Expose as a separate element to an
object that has an attribute you want to make accessible in your component.
For more information, see section 27.6 “Exposed Properties” on page 863.
Technical 04-16006-04-en, March 2015
854
27 Attributes
27.2 Graphic Object Attributes
27.2 Graphic Object Attributes
All graphic objects that you use in a graphic have attributes, that is properties, that
describe the object. For example, shape, position, appearance, and dynamic
behavior.
When you select a graphic object, all its object properties are displayed in the
Properties pane.
You can change most object properties from the options bar and the associated
menus. However, sometimes it is more convenient—or gives more precision—to
enter the property values directly in the Properties pane.
27.2.1 Generic Properties
All items have two generic properties.
Table: Generic Properties
Property Type Description
ID String The identity of the element.
Reserved for scripts and
other entities that need to
use unique element
identifiers to access specific
elements.
Name String The name of the element.
The primary use is to identify
exposed elements such as
Bind.
For Bind elements, the Name is displayed in the Binds and Links pane. From there
the Bind element cannot be connected to external signals. The actual binding is
performed from WorkStation.
04-16006-04-en, March 2015 Technical
855
27 Attributes
27.3 Inherited Attributes
27.3 Inherited Attributes
You can define inheritance to enable child objects to inherit attributes from a parent
or any other ancestor object. A parent object can be, for example, a Group object.
A child object can be, for example, a graphic object in a group.
If you have defined an attribute for a Group object, for example, Fill color, the fill
color is applied on all the individual graphic objects in the group.
Inheritance only applies if you remove the corresponding attribute on the child
object. Conversely, if you keep the attribute on the child object it overrides the
attribute of the parent object.
You use the Properties pane to define inheritance. If an attribute is left undefined
both in the child object and all its parents, a default attribute is used.
If you want to determine the origin of an attribute, you can click the attribute in the
Properties pane and then check the text in the gray box beneath, see For more
information, see section 27.1 “Attributes” on page 851.
Create a rectangle and a circle (ellipse). Each gets the same Fill and Stroke attribute
values from the values in the Options toolbar.
Figure: Graphic objects that can be grouped
Group the objects.
Technical 04-16006-04-en, March 2015
856
27 Attributes
27.3 Inherited Attributes
Figure: Grouped graphic objects
The group only has two Appearance attributes: Opacity and Visibility, and both get
default values.
To define inheritance of Fill and Stroke from the Group object to the two constituting
objects, two things have to be done:
• Create (or Add) the missing attributes in the Group object.
• Remove the Fill and Stroke attributes from the rectangle and ellipse.
Right-click the Group object in the Properties pane, select Add and enter the
attributes; first Fill and then Stroke, and some suitable values (these can be
changed later on).
04-16006-04-en, March 2015 Technical
857
27 Attributes
27.3 Inherited Attributes
Figure: Attributes added to Group object
In the tree structure in the Objects pane, select the Rectangle, right-click the Fill
attribute and select Remove. The rectangle immediately inherits the Fill attribute
from the Group object.
Technical 04-16006-04-en, March 2015
858
27 Attributes
27.3 Inherited Attributes
Figure: The graphic figures own attribute is removed
Repeat the procedure for the ellipse.
Now, you can select the Group and change its Fill attribute. The Fill value of its two
objects is also changed.
04-16006-04-en, March 2015 Technical
859
27 Attributes
27.3 Inherited Attributes
Figure: The graphic figure in the group inherits the Fill attribute from the Group object.
Tip
If you do not know the value (for example, a color code), you can leave the value
box blank. In this case, when you add the property, the value box in the
Properties pane indicates an invalid (empty) value. Use the drop-down menu to
select a valid value.
Technical 04-16006-04-en, March 2015
860
27 Attributes
27.4 Defining Inheritance
27.4 Defining Inheritance
You define inheritance to enable property inheritance from an object containing
other objects, for example, to control a specific property of an entire group of
objects.
To define inheritance
1. In Graphics Editor, in the Objects pane, select the parent object from which
you want to use a property, for example, Group.
2. In the Properties pane, right-click anywhere and then click Add.
3. In the Add a Custom Attribute dialog box, type a name for the property
that you want child objects to inherit, for example, "Fill".
4. In the Objects pane, select the objects that are to inherit properties from the
container object to which they belong.
5. In the Properties pane, delete the property that you want the container
object to control.
6. Click Remove.
Important
• Make sure that the property that you add on the container object
has a corresponding property on the inheriting objects. For
example, Fill.
• Corresponding properties have to have identical names.
Continued on next page
04-16006-04-en, March 2015 Technical
861
27 Attributes
27.4 Defining Inheritance
Note
• You can override the inheritance from a container object by
keeping the property on an object that belongs to the container
object. This is useful when you want a group of objects in the
same container object to inherit a property, but have one or a
few objects in that container object, which should keep their
individual properties.
Technical 04-16006-04-en, March 2015
862
27 Attributes
27.5 Setting Up Inherited Properties
27.5 Setting Up Inherited Properties
You set up inherited properties to make sure that a component gets the same
properties as lead or ancestor components.
Note
• If a property for a shadow object is removed, the object inherits the
corresponding property from its lead object.
For more information, see section 24.2 “Component Design” on page 811.
To set up inherited properties
1. In Graphics Editor, in the Objects pane, select ComponentContent.
2. In the Properties pane, right-click the property field, and then click Add.
3. In the Add a Custom Attribute dialog box, enter the name of the property
that is to be inherited and then enter its initial value.
Note
• If you do not know the value (for example, a color code), you can
leave the Value field blank. In this case, when you add the
property, the Value field in the Properties pane indicates an
invalid (empty) value. Use the drop-down menu to select a valid
value.
4. In the Objects pane, select the object whose property should be inherited.
Continued on next page
04-16006-04-en, March 2015 Technical
863
27 Attributes
27.5 Setting Up Inherited Properties
5. In the Properties pane, right-click the property or properties that are to be
inherited and then click Remove. The property does not disappear, but the
text at the bottom of the Properties pane, changes to Inherited value.
6. On the File menu, click Save.
Inherent objects get a uniform appearance.
Technical 04-16006-04-en, March 2015
864
27 Attributes
27.6 Exposed Properties
27.6 Exposed Properties
You can make certain attributes of a component accessible from outside the
component. For example, you can use the Fill attribute to let an external signal
change the color of a component. You add Expose as a separate element to an
object that has an attribute you want to make accessible in your component.
An exposed attribute is displayed among the attributes of its parent figure and all
ancestors all the way up to the root figure (Tgml) of a graphic, in the Exposed
Properties part of the Properties pane.
The Expose element has two attributes:
• Name
This is the name the exposed attribute gets
• ExposedAttribute
This refers to the attribute (attribute) that is exposed
Note
• When naming exposed attributes, note that if two or more exposed elements
have the same name this is considered to be intentional. It means that the
named element is displayed only once in the Exposed Properties part of the
Properties pane.
04-16006-04-en, March 2015 Technical
865
27 Attributes
27.7 Adding an Expose Element
27.7 Adding an Expose Element
Use exposed properties to make certain properties of a component accessible from
outside Graphics Editor.
For more information, see section 27.6 “Exposed Properties” on page 863.
To add an Expose object
1. In Graphics Editor, in the Properties pane, right-click the object with the
property you want to expose, point to New, and then click Expose.
2. In the Objects pane, in the component tree structure, select the new Expose
element and change the name from My___ to a more descriptive name.
3. In the Properties pane, click the ExposedAttribute box, and select the
property you want to expose from the drop-down list.
If you select the object containing the exposed property in the Objects pane, the
exposed property is displayed in the Properties pane
Technical 04-16006-04-en, March 2015
866
27 Attributes
27.8 Exposing a Property
27.8 Exposing a Property
Use exposed properties to make certain properties of a component accessible from
outside Graphics Editor.
Note
• If a property for a low-level object is removed, the object inherits the
corresponding property from its parent object.
For more information, see section 24.2 “Component Design” on page 811.
To expose a property
1. In Graphics Editor, in the Objects pane, select the component containing the
property you want to expose
2. In the Properties pane, right-click the property you want to expose and then
click Expose.
Note
An Exposed Properties element is added in the Properties pane.
3. In the Objects pane, select the new Expose element and change the name
from My___ to a more descriptive name.
Note
• You can expose several properties at a time.
04-16006-04-en, March 2015 Technical
867
27 Attributes
27.8 Exposing a Property
If you select the object containing the exposed property in the Objects pane, the
exposed property is displayed in the Properties pane.
Technical 04-16006-04-en, March 2015
868
27 Attributes
27.9 Modifying the Behavior of a Component
27.9 Modifying the Behavior of a Component
You expose the properties of a component to modify its behavior.
For more information, see section 27.6 “Exposed Properties” on page 863.
To modify the behavior of a component
1. In Graphics Editor, on the File menu, point to New and then click
Component.
2. In the Components pane, click the My Components category.
3. Select the required component, and drag it to the work area.
4. In the Properties pane, in the Name box, type the name of the modified
component.
Note
You only need to name the drawing object if you will be binding the
object. Naming the object now will help you identify the object later.
Continued on next page
04-16006-04-en, March 2015 Technical
869
27 Attributes
27.9 Modifying the Behavior of a Component
5. In the Properties pane, type values for the Exposed Properties object.
6. Select Preview.
7. In the Binds and Links pane, enter values to test the modified behavior.
Note
• The bindings name consists of the component name, a dot, and
the bind name 'Value'.
8. On the File menu, click Save to save the modified component.
By modifying exposed properties of a component, you can customize it when
reusing the component in different applications.
Technical 04-16006-04-en, March 2015
870
28 Binds and Links
Topics
Binds and Links
Adding a Link
Adding a Bind
Binding a Graphic to a Variable
Dynamic Updates
Activating a binding with a dynamic update attribute
28 Binds and Links
28.1 Binds and Links
28.1 Binds and Links
A dynamic graphic object can be bound to, and thus controlled by, server variables
(signals). When the signal changes the behavior or appearance of the object
changes dynamically.
Similarly, you can link a graphic object to other database objects or Server pages by
using a Link property to define a target.
Binds and links are created by using the Bind or Link elements of the graphic
object. Binds and links defined for a graphic, are displayed in the Binds and Links
pane. Although you have to do the physical binding and linking in WorkStation, the
Binds and Links pane gives you a useful overview.
When you select binds or links, the different panes highlight the selected elements
which makes them easy to locate. The binds and links remain selected even if you
toggle between panes.
You can test bindings in Graphics Editor in Preview mode, by manually entering test
values for the binding to test the effect of the rules for a binding. For more
information, see section 23.9 “Testing” on page 805.
28.1.1 Object Binding
A dynamic graphic object is an object whose appearance or behavior is controlled
by variables from the server. This is done by binding elements of the graphic object
to the variable.
A binding can simply reflect the variable value, for example, a symbol toggles
between green when a status signal is 0 and red when the signal is 1.
Figure: The desired dynamic behavior of a graphic object
A binding can also contain converters (rules) that declare how the appearance or
behavior of the graphic object should be affected if the variable value changes.
You can add bindings to, for example, lines, curves, and rectangles. You can also
add bindings to transformations of objects, for example, rotate, scale, or translate
elements.
04-16006-04-en, March 2015 Technical
873
28 Binds and Links
28.1 Binds and Links
Bindings are made by adding a Bind element to the graphic object. The Bind
element has a Target attribute that is changed as the incoming value from the
Server changes.
Figure: Graphics object proerties bound to singals in the system
You select the Target attribute from the Attribute drop-down list, which only shows
the bindable properties of the parent object.
Examples:
When you add a Bind element to an arc, a certain number of arc attributes can be
bound.
Technical 04-16006-04-en, March 2015
874
28 Binds and Links
28.1 Binds and Links
Figure: Arc attributes that can be bound
When you add a Bind element to a Rotate element, only the rotation angle and
center attributes can be bound.
Figure: Rotate attributes that can be bound
When you add a Bind element to an Animate element, only the animation attributes
can be bound.
04-16006-04-en, March 2015 Technical
875
28 Binds and Links
28.1 Binds and Links
Figure: Animate attributes that can be bound
The remaining Bind property is Format. You can set it to None (deliver value as is) or
Presentation. If you select Presentation, the value is converted to and presented as
a text according to an enumeration table in WorkStation.
28.1.2 Object Linking
If you want to dynamically link a graphic object to, for example, other graphic
objects, trend log views, notes, and online plots in WorkStation, you add a Link
element to the graphic object.
Linking is done by using the Link element of the graphic object. You have to set the
Target property of the Link element to define the target that is to be displayed when
the user clicks the link in the graphic object. You do the physical linking to another
object from WorkStation.
Technical 04-16006-04-en, March 2015
876
28 Binds and Links
28.2 Adding a Link
28.2 Adding a Link
You add links to a graphic to open Web sites, applications, or documents from
within WorkStation.
For more information, see section 28.1 “Binds and Links” on page 871.
To add a link
1. In Graphics Editor, click the Snippets tab.
2. Select the Basic Functions category.
3. Drag the Link snippet to the drawing object that will be linked to a Web site,
application, or document.
4. In the Objects pane, click the Link object.
5. In the Properties pane, in the LinkName box, type the name of the Link
object.
6. Click Save.
The link is now added to the graphic and is available for binding in WorkStation.
04-16006-04-en, March 2015 Technical
877
28 Binds and Links
28.3 Adding a Bind
28.3 Adding a Bind
You add a bind when you want to bind an attribute of a dynamic graphic object to,
and thus let it be controlled by, server variables (signals). When the signal changes
the behavior or appearance of the object changes dynamically.
For more information, see section 28.1 “Binds and Links” on page 871.
To add a bind
1. In Graphics Editor, in the Objects pane, right-click the object to which you
want to add the bind.
2. Point to New and then click Bind.
3. In the Properties pane, in the Attribute box, enter the object attribute you
want to be affected by the server signal.
Before you can bind the graphic object attribute to a signal in WorkStation you have
to add, for example, a value converter to the bind.
Technical 04-16006-04-en, March 2015
878
28 Binds and Links
28.4 Binding a Graphic to a Variable
28.4 Binding a Graphic to a Variable
You bind the graphic to variables to show variable values in the graphic either as
digital values or as dynamic components. You also bind a graphic to objects to
activate the links in the graphic.
For more information, see section 15.1 “Bindings Overview” on page 411.
To bind a graphic to a variable
1. In WorkStation, in the System Tree pane, select the graphic that you want to
bind a variable or an object to.
2. On the Action menu, click Edit bindings.
3. In the Browser pane, select the variable or object that you want bind to the
graphic.
Continued on next page
04-16006-04-en, March 2015 Technical
879
28 Binds and Links
28.4 Binding a Graphic to a Variable
4. Drag the variable or object to the box in the Binding column for the binding
point you want to bind.
5. On the File menu, click Save.
6. Click the Graphics view and verify that the bindings correspond to
dynamically changing values in the graphic or working links to objects.
Technical 04-16006-04-en, March 2015
880
28 Binds and Links
28.5 Dynamic Updates
28.5 Dynamic Updates
A graphic can contain numerous bindings to values that you want to be able to
display in the graphic. When there are numerous bindings, reading the values can
be time-consuming and can slow down the performance of the graphic. By setting
the DynamicUpdates attributes in the Bind elements of the graphic to either
disabled or enabled, you can control which values that are updated. That is, which
values the graphic subscribes to when the graphic is opened. Disabling the updates
can improve the performance when loading the graphic. By default, the dynamic
updates are enabled, that is, the value connected to a Bind element in the graphic
is updated when the graphic is opened.
To control how and when the values of bindings that are not dynamically updated
are to be updated, you can add a script to the Script element of the Bind element.
04-16006-04-en, March 2015 Technical
881
28 Binds and Links
28.6 Activating a binding with a dynamic update attribute
28.6 Activating a binding with a dynamic
update attribute
You edit the DynamicUpdate attribute to improve the performance when loading a
graphic. By default, the dynamic updates are enabled, that is, the value connected
to the Bind element of the graphic is updated when the graphic is opened.
For more information, see section 28.5 “Dynamic Updates” on page 879.
To activate a binding with a dynamic update attribute
1. In Graphics Editor, in the Objects pane, select the Bind element for which
you want to edit the DynamicUpdates attribute.
2. In the Properties pane, in the Behavior area, select the DynamicUpdates
attribute and select Enable or Disable depending on whether or not you
want the graphic to subscribe to the value connected to the Bind element
when the graphic is opened.
Technical 04-16006-04-en, March 2015
882
29 Groups
Topics
Groups
Grouping Multiple Objects
Ungrouping Objects
Selecting an Object
Selecting Multiple Objects
Selecting All Objects
Clearing the Selection of Multiple Objects
Selecting a Group
29 Groups
29.1 Groups
29.1 Groups
A group is when two or more objects or components are joined together as one
entity. Groups can have nested groups, that is, groups within the group.
The purpose of grouping objects is to make it possible to perform an operation on
them all simultaneously. When you have selected a group, you can move, copy,
and zoom in on the objects of the group in one single command.
Once you have grouped objects, you cannot select individual objects within the
group from the work area. You can still select one or several objects of the group
from the Objects pane. The objects are then indicated as selected members of the
group.
This can be useful, for example, if you want to see on which objects a specific
element operates. The selected object is then indicated as a selected member of
the group in the work area as well.
When you select one or more individual objects of a group, the selected object or
objects are displayed with inverted text in the Objects pane, and are selected as
Group member in the work area.
Note
• A Group member selection is displayed in the work area as green dashed
rectangle(s), enclosing the object(s).
Figure: An individual member of a group has been selected. The group member selection
is indicated with a green rectangle in the work area
You can add objects that do not belong to the group to a selection by pressing
CTRL and clicking in the Objects pane.
04-16006-04-en, March 2015 Technical
885
29 Groups
29.1 Groups
Figure: A single curve is added to the selection. The ellipse is still surrounded by the green
rectangle, but now the group, which is the primary selection, is surrounded by a blue
rectangle
The usage of selection indicators in the work area, when you have selected one or
several objects, can be summarized as follows.
• Primary selection is indicated with a dashed blue rectangle enclosing the object
(which can also be a group)
• Group member selection is indicated with a dashed green rectangle enclosing
the individual object
You have to select an object before editing it. There are several ways to select an
object. You can select objects individually or simultaneously by clicking them or by
drawing a marquee around them.
When you select two or more objects, one of them is regarded as the primary
selection. The primary selection is displayed surrounded with a blue, dashed
rectangle in the work area.
You can select two or more objects to align them. All the selected objects are
aligned with the “primary selection” object. For more information, see section 30.5
“Aligning Objects” on page 902.
Table: Summary of Selection Methods
Selection method Primary Selection Group Member Selection
Press CTRL and click in the Last selected object (group is N/A
work area also an object)
Selection box in the work Of the selected objects: the N/A
area topmost (z-order) in the tree
(group is also an object)
Press CTRL and click non- First selected object (group is N/A
grouped objects or groups in also an object)
the Objects pane
Press CTRL and click N/A Each individually selected
members of a group in the object in the group
Objects pane
Technical 04-16006-04-en, March 2015
886
29 Groups
29.1 Groups
Continued
Selection method Primary Selection Group Member Selection
Press CTRL and click child N/A Parent object
elements of members of a
group in the Objects pane
Press CTRL and click non- First selected (group is also Each individually selected
grouped objects and an object) object in the group
members of a group in the
Objects pane (‘Mixed
selection’)
04-16006-04-en, March 2015 Technical
887
29 Groups
29.2 Grouping Multiple Objects
29.2 Grouping Multiple Objects
You group objects to be able to perform an operation on them all simultaneously.
To group multiple objects
1. In Graphics Editor, in the work area, select the objects you want to include in
the group.
2. On the Options toobar, click Group.
The selected objects are now grouped and enclosed by the selection rectangle.
Technical 04-16006-04-en, March 2015
888
29 Groups
29.3 Ungrouping Objects
29.3 Ungrouping Objects
You ungroup objects to be able to perform operations on them individually. Nested
groups are unfolded in the reverse order.
To ungroup objects
1. In Graphics Editor, in the work area, select the group you want to ungroup.
2. On the Options toolbar, click Ungroup.
The selected objects are now ungrouped. The selection rectangle still encloses all
the objects, but the objects also have separate selection indicators. All selections
are cleared when you click outside the objects.
04-16006-04-en, March 2015 Technical
889
29 Groups
29.4 Selecting an Object
29.4 Selecting an Object
You can select a single object to perform an operation only on that object.
For more information, see section 29.1 “Groups” on page 883.
To select an object
1. In Graphics Editor, in the work area, click the border or fill of the object you
want to select.
Note
• When an object is selected in the work area, it is highlighted in the Objects
pane tree structure.The opposite also applies: when you click an object in the
Objects pane, the corresponding object is selected in the work area.
Technical 04-16006-04-en, March 2015
890
29 Groups
29.5 Selecting Multiple Objects
29.5 Selecting Multiple Objects
You select multiple objects to perform an operation on them all simultaneously.
For more information, see section 29.1 “Groups” on page 883.
To select multiple objects
1. In Graphics Editor, on the Drawing toolbar, click Select.
2. Press CTRL while clicking the border or fill of all the objects you want to
include in the selection.
The last selected object is the primary selection.
Note
• You can add or remove objects by pressing CTRL while clicking the objects.
Clicking the same object toggles between select and clear.
04-16006-04-en, March 2015 Technical
891
29 Groups
29.6 Selecting All Objects
29.6 Selecting All Objects
You select all objects to perform an operation on them all simultaneously. This
command selects all objects including invisible objects.
For more information, see section 29.1 “Groups” on page 883.
To select all objects
1. In Graphics Editor, click anywhere in the work area and press CTRL+A.
The last selected object is the primary selection.
Technical 04-16006-04-en, March 2015
892
29 Groups
29.7 Clearing the Selection of Multiple Objects
29.7 Clearing the Selection of Multiple
Objects
You clear the selection of objects when you have completed an operation on them.
For more information, see section 29.1 “Groups” on page 883.
To clear the selection of multiple objects
1. In Graphics Editor, in the work area, press CTRL+D.
The selection of all objects in the drawing are cleared.
04-16006-04-en, March 2015 Technical
893
29 Groups
29.8 Selecting a Group
29.8 Selecting a Group
You select an entire group of objects to perform an operation on the group and all
objects within the group simultaneously.
For more information, see section 29.1 “Groups” on page 883.
To select a group
1. In Graphics Editor, in the work area, click the border, or any filled part, of any
of the objects in the group.
Technical 04-16006-04-en, March 2015
894
30 Editing Tools
Topics
Selecting an Object Within a Group
Graphics Editing Tools
Object Organization
Moving Objects
Aligning Objects
Arranging Objects
Distributing Objects
Arranging a Table-like Layout
Duplicating an Object to the Same Position
Duplicating an Object with a Controlled Offset
Resizing an Object
Resizing an Object to the Same Size
Rotating a Single Object
Rotating Multiple Objects
Skewing Horizontally
Skewing Vertically
Flipping an Object
Copying an Object
Editing a Point of an Object
Editing Object Properties
Editing Multiple Objects
Deleting an Object
Colors
Adding a Custom Color
Using a Custom Color
Gradients
Gradient Properties
Adding a Linear Gradient
Adjusting a Linear Gradient
Adding a Radial Gradient
Adjusting a Radial Gradient
Animations
Adding an Animation
30 Editing Tools
30.1 Selecting an Object Within a Group
30.1 Selecting an Object Within a Group
You select individual members within a group to perform an operation only on the
selected objects.
For more information, see section 29.1 “Groups” on page 883.
To select an object within a group
1. In Graphics Editor, in the Objects pane, click the object you want to select
within the group.
The entire group as well as each individually selected object are selected in the
work area. Any operation you perform only affects the individually selected objects,
not the entire group.
04-16006-04-en, March 2015 Technical
897
30 Editing Tools
30.2 Graphics Editing Tools
30.2 Graphics Editing Tools
You can edit all graphic objects, that is, modify their properties. For example,
shape, size, and color.
You can edit all graphic objects individually. You can also edit some graphic objects
simultaneously. You can edit the following properties of two or more graphic
objects simultaneously:
• Fill color
• Stroke color
• Stroke style
• Stroke width
• Flip
• Rotate
• Skew
For text boxes, you can also edit the following properties for several text boxes
simultaneously:
• Font
• Font size
• Font style
• Stroke width
• Horizontal text alignment in text box
• Vertical text alignment in text box
If you want a graphic object to be available for future use, you can save it as a
component in the My Components library.
30.2.1 Selection Within a Group
You cannot select individual objects within a group in the work area. However, in
the Objects pane you can select one or several objects within a group. The objects
are then indicated as selected members of the group.
Tip
To include additional elements in the selection, press CTRL while clicking the
additional elements in the Objects pane.
For more information, see section 29.1 “Groups” on page 883.
30.2.2 Object Organization
When organizing objects in a graphic there are many options. You can move, align,
arrange, and distribute objects in the work area. You can use the tools on the
toolbar or any of the features available from the panes.
For more information, see section 30.3 “Object Organization ” on page 898.
Technical 04-16006-04-en, March 2015
898
30 Editing Tools
30.2 Graphics Editing Tools
30.2.3 Colors
You can apply color to most objects. Graphics Editor has a range of colors but you
can also customize colors and save for future use. Objects with both stroke and fill
can have different colors on stroke and fill.
For more information, see section 30.23 “Colors” on page 922.
30.2.4 Gradients
In addition to the Color palette, Fill and Stroke have a Gradient palette. Gradients
consist of smooth color transitions along a specified direction from one color to
another. There are two types of gradients: linear and radial.
For more information, see section 30.26 “Gradients” on page 925.
30.2.5 Animations
You can add animations to a graphic object to create an illusion of movement. You
can add animations to, for example, lines curves and rectangles. You can also add
animations to transformations of objects, for example rotate, scale, translate and
others. You can add the Animate property by adding it to the object you want to
animate in the Objects pane.
For more information, see section 30.32 “Animations” on page 937.
30.2.6 Paths
When you create a path of one or several objects, you create a copy in the form of a
path, where the original objects have been dissolved and replaced with
corresponding lines and fills. For example, a rectangle dissolves into a path of four
connected strokes.
For more information, see section 33.27 “Paths” on page 998.
04-16006-04-en, March 2015 Technical
899
30 Editing Tools
30.3 Object Organization
30.3 Object Organization
When organizing objects in a graphic there are many options. You can move, align,
arrange, and distribute objects in the work area. You can use the tools on the
toolbar or any of the features available from the panes.
30.3.1 Object Moving
You can move drawn objects individually, or collected in arbitrary groups.
30.3.2 Object Aligment
You can align two or more selected objects in seven different ways:
• Left
Horizontally along the left edge of the objects
• Center
Horizontally along the center of the objects
• Right
Horizontally along the right edge of the objects
• Top
Vertically along the top edge of the objects
• Middle
Vertically along the middle of the objects
• Bottom
Vertically along the bottom edge of the objects
• Center Middle
Horizontally along the center of the objects, and vertically along the top edge of
the objects
Note
• All alignments refer to the object considered to be the primary selection.
Which object is regarded as the primary selection depends on how the
objects are selected. For more information, see section 29.1 “Groups” on
page 883.
Tip
The Align drop-down menu options indicate how the objects can be positioned
relative to the primary selection.
Technical 04-16006-04-en, March 2015
900
30 Editing Tools
30.3 Object Organization
30.3.3 Object Arrangement
If an object more or less overlaps another object, you may want to arrange them.
You can move an object so that it appears behind or in front of other objects. You
can also move a graphic object to the very back or the very front of the stack.
You can arrange one or more selected objects in four different ways:
• Bring to Front
Bring the object(s) to the top position
• Bring Forward
Bring the object(s) one position up
• Bring Backward
Bring the object(s) one position down
• Bring to Back
Bring the object(s) to the bottom position
Note
• When you select more than one object, the selected objects keep their
internal order during the arrangement procedure.
Tip
The Arrange menu options list shows how the objects can be arranged.
30.3.4 Object Distribution
You can distribute three or more selected objects in two directions:
• Horizontal
Evenly distributed between the leftmost and the rightmost of the selected
objects
• Vertical
Evenly distributed between the selected top object and bottom object
Tip
The Distribute menu options list how the objects can be distributed.
30.3.5 Object Rotation
You can rotate objects in different ways, by using the rotation tool or the two
rotation commands. Rotating multiple objects is somewhat different from rotating a
single object. When you rotate multiple objects they are rotated as if they were
grouped. That is, with an common center point around which the objects are
rotated.
04-16006-04-en, March 2015 Technical
901
30 Editing Tools
30.3 Object Organization
Tip
• You can rotate an object by using the Rotate Selection tool on the Options
toolbar and drag the rotation handle.
• You can drag out the angle handle to increase the angle precision. This does
not affect the rotation in other ways.
• The aspect ratio is automatically used when rotated objects are resized.
• When you use the Rotate Selection tool, you can also change the center of
rotation by clicking it and moving the entire rotation handle. Before changing
the center of rotation, consider that the effect of future rotations can be
difficult to anticipate.
• If you move the center point of an object that has already been rotated, an
additional rotation is added to the object and the moved center point applies
to the new rotation that was added.
30.3.6 Object Skewing
Skewing an object means that you distort the shape in a horizontal or vertical
direction by a number of degrees. You skew by selecting one or several objects and
then applying a value from the horizontal or vertical skewing menu.
30.3.7 Object Flipping
Flipping an object means that you replace the object with a reflection of the original
object on a horizontal or vertical axis.
30.3.8 Object Resizing
You can resize graphics objects, components and groups in the work area.
There are two resizing methods:
• General resizing
Whatever is enclosed by a selection rectangle is resized
• Resizing to same value
The selected graphics object, component, or group is resized to the same size
as another grahics object, component or group. The size can be compared in
three different ways:
– Same width
Resize the width of the graphics object, component, or group to the width
of another graphics object, component, or group.
– Same height
Resize the height of the graphics object, component, or group to the
height of another graphics object, component, or group.
– Same width and height
This action resizes the width and height of the graphics object,
component, or group to the width and height of another graphics object,
component, or group.
Technical 04-16006-04-en, March 2015
902
30 Editing Tools
30.4 Moving Objects
30.4 Moving Objects
You move objects to place them at a new position in a design.
To move objects
1. In Graphics Editor, in the work area, select the object you want to move.
2. Drag the object to its new position.
Note
• You can move multiple objects by selecting them all.
• You can also move the selected object(s) by using the arrow
keys.
04-16006-04-en, March 2015 Technical
903
30 Editing Tools
30.5 Aligning Objects
30.5 Aligning Objects
You align two or more objects to position them evenly.
For more information, see section 30.3 “Object Organization ” on page 898.
To align objects
1. In Graphics Editor, in the work area, select the objects you want to align.
Note
• Make sure the object that controls the alignment is the primary
selection. The primary selection is enclosed within a blue,
dashed rectangle.
2. On the Options toolbar, click the Align button and select the required
alignment from the drop-down menu.
Technical 04-16006-04-en, March 2015
904
30 Editing Tools
30.6 Arranging Objects
30.6 Arranging Objects
You arrange objects that more or less overlap each other to put certain objects in
front of or behind other objects.
For more information, see section 30.3 “Object Organization ” on page 898.
To arrange objects
1. In Graphics Editor, in the work area, select the object you want to move
backward or forward.
2. On the Options toolbar, click the Arrange button and then click the
required option.
04-16006-04-en, March 2015 Technical
905
30 Editing Tools
30.7 Distributing Objects
30.7 Distributing Objects
You distribute three or more objects to position them evenly in a design, based on
the center points of the objects.
For more information, see section 30.3 “Object Organization ” on page 898.
To distribute objects
1. In Graphics Editor, in the work area, select the objects you want to distribute.
2. On the Options toolbar, click the Distribute button and then click
Horizontal or Vertical distribution.
Note
• When the objects are distributed, the objects’ center points, that
is, the vertical or horizontal middle, are used. The result becomes
most apparent when objects of different sizes are distributed.
Technical 04-16006-04-en, March 2015
906
30 Editing Tools
30.8 Arranging a Table-like Layout
30.8 Arranging a Table-like Layout
You position objects in a table-like layout to get evenly spaced rows and columns.
For more information, see section 30.3 “Object Organization ” on page 898.
To arrange a table-like layout
1. In Graphics Editor, in the work area, select the objects for the top row, in order
from left to right.
2. On the Options toolbar, click Align and then click Top. The selected
objects align to the same horizontal height.
3. Select the objects that belong to the leftmost column, in order from top to
bottom.
Continued on next page
04-16006-04-en, March 2015 Technical
907
30 Editing Tools
30.8 Arranging a Table-like Layout
4. On the Options toolbar, click the Align button and then click Left. The
selected objects align to the same left, vertical line.
5. Depending on the pattern and row/column distance you want, group the
objects, row-by-row or column-by-column.
6. Position the top/bottom rows, or the leftmost/rightmost columns.
7. Select all groups, comprising either rows or columns.
Continued on next page
Technical 04-16006-04-en, March 2015
908
30 Editing Tools
30.8 Arranging a Table-like Layout
8. On the Options toolbar, click Distribute and then click Vertical if the
rows have been grouped, and Horizontal if the columns have been grouped.
The rows, or columns are distributed evenly between the outermost rows/columns.
If necessary, you continue to do adjustments by using the Align and Distribute
commands on individual objects or groups.
04-16006-04-en, March 2015 Technical
909
30 Editing Tools
30.9 Duplicating an Object to the Same Position
30.9 Duplicating an Object to the Same
Position
You copy any object or component to the same position as the original by working
with the original object from Objects pane tree structure.
To duplicate an object to the same position
1. In Graphics Editor, in the Objects pane, select the object.
2. Press CTRL and drag the object to a new position in the tree structure.
A copy of the object is created directly on top of the original object in the drawing.
Technical 04-16006-04-en, March 2015
910
30 Editing Tools
30.10 Duplicating an Object with a Controlled Offset
30.10 Duplicating an Object with a Controlled
Offset
You make equidistant copies of an object or component to get a certain conformity
in a design. You specify the position of the first copy and use a special copy
command to distribute the remaining copies as ‘extensions’ of the first copy
operation.
To duplicate an object with a controlled offset
1. In Graphics Editor, in the Objects pane, select the object you want to copy.
2. On the Drawing toolbar, click Copy.
3. Press CTRL+V to paste a copy.
4. Press CTRL+SHFT and move the copy to its correct position, relative to the
original.
5. Press CTRL+SHFT+V to paste another copy at the same distance relative to
the previous copy.
6. Repeat for as many copies as you need.
A number of copies are created and they are all placed with the same offset from
the previous object.
04-16006-04-en, March 2015 Technical
911
30 Editing Tools
30.11 Resizing an Object
30.11 Resizing an Object
You resize an object to modify the size of the object.
For more information, see section 30.3 “Object Organization ” on page 898.
To resize an object
1. In Graphics Editor, in the work area, select the object you want to resize.
2. Click the border of the selection rectangle and drag until the object has the
size you want.
Note
• Pulling the “handles” at any of the corners of the rectangle
affects the scaling both horizontally and vertically.
• Pressing SHIFT while resizing makes the scaling proportional,
that is, resizes the object horizontally and vertically.
Technical 04-16006-04-en, March 2015
912
30 Editing Tools
30.12 Resizing an Object to the Same Size
30.12 Resizing an Object to the Same Size
You resize an object to the same value to transform the object to the same size as
another object.
For more information, see section 30.3 “Object Organization ” on page 898.
To resize an object to the same size
1. In Graphics Editor, in the work area, select the object you want to resize.
2. Press CTRL while selecting the object you want to use as a size template.
Note
• The last selected object is used as a size template. The size
template is enclosed in a blue rectangle.
3. On the Options toolbar, click Resize and then click the resize option you
want: Same width, Same height, or Same width and height.
04-16006-04-en, March 2015 Technical
913
30 Editing Tools
30.13 Rotating a Single Object
30.13 Rotating a Single Object
You rotate an object to change its orientation. The rotate command performs a 90°
rotation when the command is executed.
For more information, see section 30.3 “Object Organization ” on page 898.
To rotate a single object
1. In Graphics Editor, in the work area, select the object you want to rotate.
2. On the Options toolbar, click Rotate Left or Rotate Right .
Technical 04-16006-04-en, March 2015
914
30 Editing Tools
30.14 Rotating Multiple Objects
30.14 Rotating Multiple Objects
You rotate multiple objects to change their orientation simultaneously. The rotate
commands performs a 90° rotation each time the command is executed.
For more information, see section 30.3 “Object Organization ” on page 898.
To rotate multiple objects
1. In Graphics Editor, in the work area, select the objects you want to rotate.
2. On the Options toolbar, click Rotate Left or Rotate Right .
04-16006-04-en, March 2015 Technical
915
30 Editing Tools
30.15 Skewing Horizontally
30.15 Skewing Horizontally
You skew horizontally to transform an object along the x-axis. The skew angle is
measured in degrees from the y-axis.
For more information, see section 30.3 “Object Organization ” on page 898.
To skew horizontally
1. In Graphics Editor, in the work area, select the object you want to skew.
2. On the Options toolbar, click Skew Horizontal to open the degree
selection menu.
3. Click the required amount of degrees, –60° to +60°.
Note
• A positive value implies counter-clockwise skew.
• A negative value implies clockwise skew.
Technical 04-16006-04-en, March 2015
916
30 Editing Tools
30.16 Skewing Vertically
30.16 Skewing Vertically
You skew vertically to transform an object along the y-axis. The skew angle is
measured in degrees from the y-axis.
For more information, see section 30.3 “Object Organization ” on page 898.
To skew vertically
1. In Graphics Editor, in the work area, select the object you want to skew.
2. On the Options toolbar, click the Skew Vertical button to open the
degree selection menu.
3. Click the required amount of degrees, –60° to +60°.
Note
• A positive value implies counter-clockwise skew.
• A negative value implies clockwise skew.
04-16006-04-en, March 2015 Technical
917
30 Editing Tools
30.17 Flipping an Object
30.17 Flipping an Object
You flip one or more objects to reflect them in a horizontal or vertical direction.
For more information, see section 30.3 “Object Organization ” on page 898.
To flip an object
1. In Graphics Editor, in the work area, select the object you want to flip.
2. On the Options toolbar, click Flip to open the flip axis menu.
3. Click Horizontal to reflect in a horizontal direction and Vertical to
reflect in a vertical direction.
Technical 04-16006-04-en, March 2015
918
30 Editing Tools
30.18 Copying an Object
30.18 Copying an Object
You copy an object in the work area to reuse it.
To copy an object
1. In Graphics Editor, in the work area, select the object you want to copy.
2. On the Drawing toolbar, click Copy.
3. On the Drawing toolbar, click Paste.
4. Move the copy to a new position.
04-16006-04-en, March 2015 Technical
919
30 Editing Tools
30.19 Editing a Point of an Object
30.19 Editing a Point of an Object
You edit a point of an object to transform its appearance. You can edit the points of
lines, polylines, curves, polygons, arcs, pies, or paths.
For more information, see section 30.2 “Graphics Editing Tools” on page 896.
To edit a point of an object
1. In Graphics Editor, in the work area, select the object whose point you want to
edit.
2. Double-click the point you want to move.
3. Drag the selected point to a new position.
Note
• When small objects are edited at an extreme zoom level, it can
be difficult to select the points. This is due to unavoidable
rounding errors, but the problem can be avoided if you draw and
edit the object in a larger size and then down-scale it.
• You can also use Show Grid (1 px) and Snap to Grid when
you create and edit the object. Grid points are not numerically
rounded.
Technical 04-16006-04-en, March 2015
920
30 Editing Tools
30.20 Editing Object Properties
30.20 Editing Object Properties
You edit object properties to change the object.
For more information, see section 33.1 “Figures” on page 967.
To edit object properties
1. In Graphics Editor, in the work area, select the object whose properties you
want to edit.
2. In the Properties pane, change, for example, the position properties of the
object.
3. In the work area, click anywhere outside the object you have edited to clear
the selection.
4. On the File menu, click Save.
You can edit a number of properties from the Properties pane.
04-16006-04-en, March 2015 Technical
921
30 Editing Tools
30.21 Editing Multiple Objects
30.21 Editing Multiple Objects
You edit multiple objects to simultaneously modify, for example, their shape, size,
and appearance.
For more information, see section 30.2 “Graphics Editing Tools” on page 896.
To edit multiple objects
1. In Graphics Editor, in the work area, select the objects you want to edit.
2. On the Options toolbar, click any of the Fill, Stroke (border) color, Style, or
Width buttons and select appearance from the corresponding menu.
Technical 04-16006-04-en, March 2015
922
30 Editing Tools
30.22 Deleting an Object
30.22 Deleting an Object
You delete objects in the work area that you do not want in your design.
To delete an object
1. In Graphics Editor, in the work area, select the object you want to delete.
2. On the Drawing toolbar, click Delete.
The selected object is deleted but you can undo the command by clicking Undo on
the menu bar before you have edited any other objects.
04-16006-04-en, March 2015 Technical
923
30 Editing Tools
30.23 Colors
30.23 Colors
You can apply color to most objects. Graphics Editor has a range of colors but you
can also customize colors and save for future use. Objects with both stroke and fill
can have different colors on stroke and fill.
You can define color hue from the Gradient palette.
Table: Overview of Color, Style, and Gradient Applicability
Object Stroke Stroke Stroke Fill Color Fill
Color Style Gradient Gradient
Line Yes Yes Yes – –
Shape Yes Yes Yes Yes Yes
Text Yes – Yes Yesa –
Textbox Yes – Yes Yesb Yes
a) Background behind text (default area)
b) Background behind text (textbox area)
Technical 04-16006-04-en, March 2015
924
30 Editing Tools
30.24 Adding a Custom Color
30.24 Adding a Custom Color
You add a custom color the color palette to save it for quick access in the future.
For more information, see section 30.26 “Gradients” on page 925.
To add a custom color
1. In Graphics Editor, on the Options toolbar, click Fill (or Stroke) to open the
color palette.
2. Select Custom Color.
3. In the Color dialog box, in the colored square, move the pointer to the color
you want to add. If required, you can adjust the color by adjusting the
numerical values for Hue, Saturation, Red, Green, Blue, and
Luminosity.
4. Click Add to Custom Colors.
Note
• Fill and Stroke use the same color palette and also the same
custom colors.
5. Click OK.
The color is displayed in one of the Custom Color boxes.
04-16006-04-en, March 2015 Technical
925
30 Editing Tools
30.25 Using a Custom Color
30.25 Using a Custom Color
You use custom colors when you want to use a specific color in your design.
For more information, see section 30.26 “Gradients” on page 925.
To use a custom color
1. In Graphics Editor, in the work area, select the object on which you want to
use the custom color.
2. On the Options toolbar, expand Stroke (or Fill) to open the color palette.
3. Click Custom Color.
4. Select the color in the Custom colors area.
5. Click OK.
Technical 04-16006-04-en, March 2015
926
30 Editing Tools
30.26 Gradients
30.26 Gradients
In addition to the Color palette, Fill and Stroke have a Gradient palette. Gradients
consist of smooth color transitions along a specified direction from one color to
another. There are two types of gradients: linear and radial.
Gradients work with gradient stops where the two colors are specified and
indicating where they start and stop.
The Gradients and Gradient stops are properties, added to the object in the Objects
pane. For more information, see section 33.1 “Figures” on page 967.
30.26.1 Linear Gradient Adjustment
When you use the Fill – Gradient palette, you may need to adjust the color or some
other aspect of the appearance.
Adjusting a linear gradient involves finding the specific object in the Objects pane
and then changing the gradient parameters of the LinearGradient or the
GradientStop elements.
30.26.2 Radial Gradient Adjustment
When you use the Fill – Gradient palette, you may need to adjust the color or some
other aspect of the appearance.
Adjusting a radial gradient involves first finding the specific object in the Objects
pane and then changing the gradient parameters of the RadialGradient or the
GradientStop elements.
30.26.3 Gradient Properties
It is not difficult to change the gradient properties, but you have to have some
understanding of the parameters involved. In most cases, it is sufficient to use the
standard Gradient palette.
For more information, see section 30.27 “Gradient Properties” on page 926.
04-16006-04-en, March 2015 Technical
927
30 Editing Tools
30.27 Gradient Properties
30.27 Gradient Properties
It is not difficult to change the gradient properties, but you have to have some
understanding of the parameters involved. In most cases, it is sufficient to use the
standard Gradient palette.
There are two types of gradients, linear and radial, each with somewhat different
properties. These properties are displayed in objects under the corresponding
shape object in the Objects tree. For more information, see section 33.1 “Figures”
on page 967.
A linear gradient has a StartPoint and an EndPoint, local coordinates for the
direction of the gradient.
Figure: A linear gradient, with a diagonal direction from 0, 0 to 1, 1; and a horizontal
gradient from 0.3, 0 to 0.7, 0 (with SpreadMethod “Pad”)
A linear gradient also has a SpreadMethod, which tells how the areas outside the
StartPoint and the EndPoint are to be treated. There are three methods:
• Pad (default)
Extends the gradient end colors to the respective ends of the object.
• Reflect
Reflects the gradient like a mirror placed at the StartPoints and EndPoints.
• Repeat
Repeats the gradient pattern, as far as the “outside” areas stretches.
Technical 04-16006-04-en, March 2015
928
30 Editing Tools
30.27 Gradient Properties
Figure: The three different SpredMethods used with the same StartPoints and EndPoints
A radial gradient has the following properties:
• Focus
Point that defines where the radial gradient starts.
• Center
Center point for the circle (ellipse) that defines where the radial gradient ends.
• RadiusX
One of the two axes for the circle (ellipse) that define where the radial gradient
ends.
• RadiusY
One of the two axes for the circle (ellipse) that define where the radial gradient
ends.
Example: An ellipse, created with one of the standard circular gradient patterns
from the Fill Gradient palette:
04-16006-04-en, March 2015 Technical
929
30 Editing Tools
30.27 Gradient Properties
Figure: A radial gradient with an off-center focus, suggesting light from upper-left
The SpreadMethod for a radial gradient is always “Pad”.
The colors at the StartPoint and EndPoint of a gradient (linear or radial) are specified
in two GradientStop objects, belonging to the “parent” LinearGradient or
RadialGradient object.
The GradientStop objects also have an Offset, which modifies where the gradient
starts and stops. If the values are 0 and 1, the StartPoint and EndPoint are not
modified.
Example: A rectangle with two different pairs of settings for the GradientStop:
Technical 04-16006-04-en, March 2015
930
30 Editing Tools
30.27 Gradient Properties
Figure: A linear gradient, in the lower case modified by the GradientStop Offsets
Gradients and gradient stops can be used in more complex ways.
For example, you can add more GradientStops to a Linear/RadialGradient to make
the color change at each Offset distance. Below is an example with three
GradientStops.
We use a square, 400x400, in which we want the gradients to run roughly in a
diagonal direction, but described only within the inner part of the square. By setting
the StartPoint to (0.2, 0.4) and the EndPoint to (0.7, 0.9), the gradients will run from
the coordinates (180, 260) to (380, 460).
04-16006-04-en, March 2015 Technical
931
30 Editing Tools
30.27 Gradient Properties
Figure: A square with a limited linear gradient, three gradient stops, and two
"preadMethod" areas outside the linear gradient definition.
The three GradientStops have the following properties:
• Color 1 (green), Offset=0.1
• Color 2 (none), Offset=0.3
• Color 3 (blue), Offset=0.7
The area between Offset=0 and Offset=0.1 is padded with Color 1 (green).
The area between Offset=0.1 and Offset=0.3 gradually changes from Color 1
(green) to Color 2 (transparent).
The area between Offset=0.3 and Offset=0.7 gradually changes from Color 2
(transparent) to Color 3 (blue).
The area between Offset=0.7 and Offset=1 is padded with Color 3 (blue).
The two areas outside the LinearGradient definition use the same SpreadMethod, in
this case Repeat, but Pad or Reflect could also have been used. With Repeat, the
pattern is repeated according to the defined gradient. With Reflect, the pattern
would have been mirrored, and with Pad the outermost colors (here 1 and 3) would
have been extended.
Note
• You have to add the GradientStops to the Objects pane in a strictly
ascending Offset order (0 to 1), otherwise the result is undefined.
• When you add a GradientStop to the list, its Color and Offset are undefined,
which means that the associated object are transparent until the parameters
have been set.
Technical 04-16006-04-en, March 2015
932
30 Editing Tools
30.28 Adding a Linear Gradient
30.28 Adding a Linear Gradient
You add a linear gradient to give an object a smooth, varying hue from one point to
another.
For more information, see section 30.26 “Gradients” on page 925.
To add a linear gradient
1. In Graphics Editor, in the work area, select the object on which to apply the
gradient.
2. On the Options toolbar, expand Fill to open the Color/Gradient palette.
3. Click the Gradient tab.
4. Click the box with the gradient you want to use.
In the Objects pane, a LinearGradient element and two or more GradientStop
elements are added to the object.
04-16006-04-en, March 2015 Technical
933
30 Editing Tools
30.29 Adjusting a Linear Gradient
30.29 Adjusting a Linear Gradient
You adjust a linear gradient to customize it.
For more information, see section 30.26 “Gradients” on page 925.
To adjust a linear gradient
1. In Graphics Editor, in the work area, select the object with the linear gradient
you want to adjust.
2. In the Objects pane, locate the object.
3. Expand the object elements to display the LinearGradient element with its
GradientStops.
4. Select the LinearGradient element.
5. To change the gradient target (the area or the stroke), in the Target area, in
the Attribute box, switch between Fill and Stroke.
6. To change the gradient start and end points (also indicating the gradient
direction), in the Position area, in the StartPoint or EndPoint box, type x
and y-coordinates between (0,0), (0,1), (1,0) and (1,1). If the gradient is
positioned well within the square outlined above, the areas “outside” the start
and end points can be filled by one of three spread methods.
7. To change the gradient spread method, in the Behavior area, in the
SpreadMethod box, switch between Pad (extending the end colors),
Reflect (mirroring the gradient in the Start/End points), and Repeat
(repeating the gradient as far as the “outside” area stretches).
Continued on next page
Technical 04-16006-04-en, March 2015
934
30 Editing Tools
30.29 Adjusting a Linear Gradient
8. To change any of the gradient colors (the “start” and “stop” colors), in the
Appearance area, in the Color box, click a color in the Color palette, or
type a hexadecimal color code.
9. To change the offset (where the “start” and “stop” colors will be positioned,
relative to the LinearGradient Start/End points), in the Position area, in the
Offset box, type a value between 0 and 1.
04-16006-04-en, March 2015 Technical
935
30 Editing Tools
30.30 Adding a Radial Gradient
30.30 Adding a Radial Gradient
You add a radial gradient to give an object a smooth, varying hue from a center
point to the periphery.
For more information, see section 30.26 “Gradients” on page 925.
To add a radial gradient
1. In Graphics Editor, in the work area, select the object to which you want to
add the radial gradient.
2. On the Options toolbar, expand Fill to open the Color/Gradient palette.
3. Click the Gradient tab.
4. Click the radial gradient you want to use.
In the Objects pane, a RadialGradient element with two or more GradientStops are
added to the object.
Technical 04-16006-04-en, March 2015
936
30 Editing Tools
30.31 Adjusting a Radial Gradient
30.31 Adjusting a Radial Gradient
You adjust a radial gradient to suit current requirements.
For more information, see section 30.26 “Gradients” on page 925.
To adjust a radial gradient
1. In Grahics Editor, in the work area, select the object with the radial gradient
that has to be adjusted.
2. In the Objects pane, locate the object.
3. Expand the object elements to display the RadialGradient element with its
GradientStops.
4. Select the RadialGradient element.
5. To change the gradient target (the area or the stroke), in the Target area, in
the Attribute box, switch between Fill and Stroke.
6. To change the gradient focus (the beginning of the radial gradient), in the
Position area, in the Focus box, type x and y-coordinates between (0,0) and
(1,1). To change how far the gradient will reach (a kind of gradient end point
periphery), a circle or ellipse is used.
7. In the Position area, click the periphery ellipse Center, and type x and y-
coordinates between (0,0) and (1,1).
8. In the Position area, complete the circle/ellipse by selecting RadiusX or
RadiusY, and type values between 0 and 1 to define the reach of the
periphery.
Continued on next page
04-16006-04-en, March 2015 Technical
937
30 Editing Tools
30.31 Adjusting a Radial Gradient
9. To change any of the gradient colors (the “start” and “stop” colors), in the
Appearance area, in the Color box, click a color in the Color palette, or
type the a hexadecimal color code.
10. To change the offset (where the “start” and “stop” colors will be positioned,
relative to the RadialGradient focal point), in the Position area, in the Offset
box, type a value between 0 and 1.
Technical 04-16006-04-en, March 2015
938
30 Editing Tools
30.32 Animations
30.32 Animations
You can add animations to a graphic object to create an illusion of movement. You
can add animations to, for example, lines curves and rectangles. You can also add
animations to transformations of objects, for example rotate, scale, translate and
others. You can add the Animate property by adding it to the object you want to
animate in the Objects pane.
The Animate element has a Target attribute, that is, the property in the parent object
that you want the animation to change. For example, the Target attribute can be
Visibility. The Boundary attribute of the Animate element decides how the Target
attribute is affected. For example, a visible element can be hidden. The Behavior
attribute of the Animate element decides how the parent element of the Animate
element will go from visible to hidden. For example, Linear, in which case the parent
element softly goes from visible to hidden. You select attribute from a drop-down
list in the attribute box. Only relevant attributes are available in the list.
Two examples:
When you add an Animate element to a rectangle, you can animate a whole
number of rectangle properties:
Figure: Rectangle properties
When you add an Animate element to a Rotate element, you can only animate the
rotation angle and center properties:
04-16006-04-en, March 2015 Technical
939
30 Editing Tools
30.32 Animations
Figure: Rotation properties
The remaining Animate properties are used as follows:
• Animation
Start or Stop the dynamic behavior.
• AutoReverse
If True, the animation runs backwards at the end of the forward motion. If
False, there is no backwards run at the end of the forward motion.
• CalcMode
If Discrete, the animation switches between the From and To Boundaries. If
Linear, the animation progresses smoothly between the same Boundaries.
Use discrete animations for:
– Binary values (for example true/false, hidden/visible)
– Enumerations (0, 1, 2)
– Switching between two colors
– Changing properties for a text (for example, Font, Size, Bold, or Italic)
– Changing the size (height and width) of a shape
– Options (for example, alignment and visibility)
Use linear animations to:
– Change properties that are numbers (double, analog values) to smoothly
change the size
– Position a shape
– Set the angle of a rotated shape
– Create a smooth blink, using the Visibility properties
– Create smooth rotation animations
• Duration
The time in seconds for one forward animation.
• Freeze
Technical 04-16006-04-en, March 2015
940
30 Editing Tools
30.32 Animations
If True, the current animation value is saved when the dynamic mode is exited.
If False, the value is reset.
• Repeat
Either an entered number of runs or Forever, that is, endless repetition.
• Boundary, From and To
The end values for the animated property.
04-16006-04-en, March 2015 Technical
941
30 Editing Tools
30.33 Adding an Animation
30.33 Adding an Animation
You make an object dynamic by adding an animate element to it.
For more information, see section 30.32 “Animations” on page 937.
To add an animation
1. In Graphics Editor, in the work area, select the object you want to animate.
2. In the Objects pane, right-click the object, click New, and then click
Animate.
3. In the Properties pane, under Target, in the Attribute box, enter the
property that you want the animation to affect.
4. In the Behavior field, in the Animation box, click Start to be able to specify
what is to start the animation.
5. In the Properties pane, add other attributes to control how the attribute is to
behave.
Continued on next page
Technical 04-16006-04-en, March 2015
942
30 Editing Tools
30.33 Adding an Animation
6. In the Objects pane, right-click the Animate element, point to New, and
then click Bind.
7. In the Objects pane, right-click the Bind element, point to New, and then
click a converter or another property that controls what the animation is to
change.
You can now bind the animation to an actual signal in WorkStation.
04-16006-04-en, March 2015 Technical
943
31 Layers
Topics
Layers
Adding a Layer
Copying a Layer
Deleting a Layer
Renaming a Layer
Selecting a Layer
Hiding a Layer
Controlling the Visibility of a Layer
31 Layers
31.1 Layers
31.1 Layers
When creating complex graphics, it can be a challenge to keep track of all the
graphic figures in the work area. Graphic figures get hidden under one another and
selecting becomes difficult. Layers provide a way to manage the graphic figures
that make up your graphic. Layers can be regarded as folders that contain graphic
figures.
The structure of layers in your document can be as simple or complex as you want
it to be. By default, all graphic figures are organized in a single, root layer. This layer
is named Tgml and you cannot rename it. The Tgml layer is always visible.
Layers have the same properties as Group elements: Opacity and Visibility. You can
control these layer properties from the Properties pane.
04-16006-04-en, March 2015 Technical
947
31 Layers
31.1 Layers
Figure: Tgml layer and two additional layers
Technical 04-16006-04-en, March 2015
948
31 Layers
31.1 Layers
Layers are located on the TGML root level. New layers are added at the top of the
work area (z-order, corresponding to the top of the tree), which means that the
figures in the layer are displayed above (and possibly on top of) figures in previous
layers. For more information, see section 33.1 “Figures” on page 967.
Tip
• To rearrange the order of the layers, you can select a layer in the Layers pane
and click the Move up and Move down buttons to move the layer
upward or downward in the tree.
You manage layers in the Layers pane. From the Layers pane you can create, select
and merge layers. You can also show, hide, duplicate, move, rename and delete all
layers except the Tgml layer. You can copy graphic figures from one layer to
another. To edit a layer and access all its contents, you have to make sure that the
layer is selected. When you select one layer, all other layers become inaccessible. If
you move the layers up or down, you change the stacking order of the graphic
figures in the work area.
Figure: Tgml and two additional layers, the last (Layer 2; topmost) active
The display area of the Layers pane has the following columns:
• Buttons to select the active layer
• Thumbnail, showing the contents of a layer. For Tgml the merged contents are
displayed.
• The name of the layer, which can be edited (except for Tgml)
• Check box to show/hide a layer
Tip
• You can edit the name in the Name box in the Properties pane.
• You can also edit the name in the tree structure in the Objects pane.
Continued on next page
04-16006-04-en, March 2015 Technical
949
31 Layers
31.1 Layers
• You can show/hide layers during the design process, but also in run time, for
example, through a signal bound to the Visibility property.
You typically use layers to create a background image, which lies inert during the
remaining design work, or to create layers with information that is to be displayed
only under certain conditions.
Technical 04-16006-04-en, March 2015
950
31 Layers
31.2 Adding a Layer
31.2 Adding a Layer
You add layers to make it easier to select an individual element or groups of
elements in the work area when you edit the graphic. Layers are especially useful
when you use a background graphic in your work area.
For more information, see section 31.1 “Layers” on page 945.
To add a layer
1. In Graphics Editor, on the View menu, click Layers.
2. In the Layers pane, on the Layers toolbar, click the New Layer button .
3. In the layer list, double click the layer name and type the name of the layer.
4. Press Enter.
5. On the File menu, click Save.
04-16006-04-en, March 2015 Technical
951
31 Layers
31.3 Copying a Layer
31.3 Copying a Layer
You copy a layer to reuse it.
For more information, see section 31.1 “Layers” on page 945.
To copy a layer
1. In Graphics Editor, on the View menu, click Layers.
2. In the Layers pane, right click the layer you want to copy and then click
Duplicate.
Note
• The Tgml layer cannot be copied.
In the Layers pane, the new layer is displayed at the bottom of the list with content
identical to the content of the original layer. The new layer is automatically named
Copy of [name of the original layer]. For example, Copy of Text layer.
Technical 04-16006-04-en, March 2015
952
31 Layers
31.4 Deleting a Layer
31.4 Deleting a Layer
You delete a layer and all its contents if you no longer need it.
For more information, see section 31.1 “Layers” on page 945.
To delete a layer
1. In Graphics Editor, on the View menu, click Layers.
2. In the Layers pane, right-click the layer you want to delete and then click
Delete.
Note
• The inherent Tgml layer cannot be removed. Objects,
components and groups in this layer are contents of the root
level of the Tgml object.
The selected layer is deleted from the layers list, and all its contents is removed from
the work area.
04-16006-04-en, March 2015 Technical
953
31 Layers
31.5 Renaming a Layer
31.5 Renaming a Layer
You can rename layers to make them easier to identify.
For more information, see section 31.1 “Layers” on page 945.
To rename a layer
1. In Graphics Editor, on the View menu, click Layers.
2. In the Layers pane, click the layer name and then type a new name.
Technical 04-16006-04-en, March 2015
954
31 Layers
31.6 Selecting a Layer
31.6 Selecting a Layer
You select a layer to perform an operation on it. You can only select and edit one
layer at a time.
For more information, see section 31.1 “Layers” on page 945.
To select a layer
1. In Graphics Editor, on the View menu, click Layers.
2. In the Layers pane, select the option button for the layer you want to edit.
Note
• When you have selected a layer, all other layers will automatically
be made inaccessible.
04-16006-04-en, March 2015 Technical
955
31 Layers
31.7 Hiding a Layer
31.7 Hiding a Layer
You hide a layer to change the visibility property for the layer, and all its contents.
For more information, see section 31.1 “Layers” on page 945.
To hide a layer
1. In Graphics Editor, on the View menu, click Layers.
2. In the Layers pane, clear the box in the eye icon column for the layer you
want to hide.
Note
• Selecting the box in the eye icon column displays the layer.
• It is not possible to hide the Tgml layer.
Technical 04-16006-04-en, March 2015
956
31 Layers
31.8 Controlling the Visibility of a Layer
31.8 Controlling the Visibility of a Layer
You control the visibility of a layer in a graphic by binding a signal to the Visibility
property, or by using a JavaScript.
For more information, see section 31.1 “Layers” on page 945.
To control the visibility of a layer
1. In Graphics Editor, in the Objects pane, select the layer that you want to
control with a signal.
2. Right-click, point to New, and then click Bind.
3. In the Properties pane, under General, in the Name box, enter a layer
name and add “.Value”.
4. Right-click the Bind element and add two ConvertValue elements.
5. For the first ConvertValue element, in the Properties pane, under
Behavior, in the AtributeValue box, type Hidden.
6. For the first ConvertValue element, in the Properties pane, under
Behavior, in the SignalLessOrEqualTo box, enter “0”.
Continued on next page
04-16006-04-en, March 2015 Technical
957
31 Layers
31.8 Controlling the Visibility of a Layer
7. For the second ConvertValue element, in the Properties pane, under
Behavior, in the AtributeValue box, type Visible.
8. For the second ConvertValue element, in the Properties pane, under
Behavior, in the SignalMoreOrEqualTo box, enter “1”.
The visibility of the layer in the graphic can now be controlled by the signal values 0
and 1, bound to [Layer name].Value.
Technical 04-16006-04-en, March 2015
958
32 Grid and Zoom
Topics
Grid
Showing/Hiding the Grid
Switching on/off Snap to Grid
Nudging an Object
Zooming
Zoom to a Specified Value
32 Grid and Zoom
32.1 Grid
32.1 Grid
A grid is a Graphics Editor feature that can be of assistance when you draw and
position graphic figures in a graphic. Graphic figures can be made to snap (attach)
to the grid intersection points, which always align with the logical pixels.
There are two kinds of pixels:
• Logical pixels
• Screen pixels
The logical pixel is the unit of measurement in the graphic. Figure coordinates,
stroke width, and so on, are all based on pixels. Although a line with Stroke width
1.0 px will look different (use few or many screen pixels) depending on the zoom
level, the line will always have the width of 1.0 logical pixel.
The width of the grid lines can be set to: 1, 2, 5, 10, or 20 logical pixels.
The screen pixel is the smallest possible detail on a screen and its physical size
depends on the screen resolution.
When you zoom out of a graphic, the grid pattern eventually becomes cluttered. In
this case, the grid lines are removed so that the distance between two grid lines
never gets shorter than five pixels.
You can customize the pixel space between the grid lines. This is useful when you
draw small details.
The grid size is saved in the .tgml document.
When you zoom in on a graphic, additional, lighter grid lines are added to show the
logical 1.0x1.0 pixel grid. This is the grid that is used when you nudge a figure.
04-16006-04-en, March 2015 Technical
961
32 Grid and Zoom
32.2 Showing/Hiding the Grid
32.2 Showing/Hiding the Grid
You show the grid to get assistance when you position objects in the work area.
Note
• By default, the grid is hidden.
• Even if the grid is hidden, Snap to grid can be active.
For more information, see section 32.1 “Grid” on page 959.
To show/hide the grid
1. In Graphics Editor, on the Drawing toolbar, click Show grid/Hide grid .
Note
• Show Grid has a drop-down menu where you set the grid
distance to 1, 2, 5, 10, or 20 pixels.
Show grid toggles between showing and hiding the grid.
Technical 04-16006-04-en, March 2015
962
32 Grid and Zoom
32.3 Switching on/off Snap to Grid
32.3 Switching on/off Snap to Grid
You use Snap to Grid to get a certain degree of alignment in a design.
For more information, see section 32.1 “Grid” on page 959.
To switch on/off Snap to Grid
1. In Graphics Editor, on the Drawing toolbar, click Snap to Grid .
Note
• You can snap to the grid even when the grid is hidden.
Snap to Grid toggles between switching on and switching off the Snap to Grid.
04-16006-04-en, March 2015 Technical
963
32 Grid and Zoom
32.4 Nudging an Object
32.4 Nudging an Object
You nudge an object to make a small adjustment to its position.
For more information, see section 32.1 “Grid” on page 959.
To nudge an object
1. In Graphics Editor, in the work area, select the object you want to nudge.
2. If Snap to Grid is active, press ALT to temporarily disable the snap function
during the nudging.
3. Use the arrow keys to move the object in the desired direction.
You move the object one pixel each time you press an arrow key.
Technical 04-16006-04-en, March 2015
964
32 Grid and Zoom
32.5 Zooming
32.5 Zooming
You zoom in to get a more detalied view of an object. You zoom out to get an
overview of a design.
To zoom
1. In Graphics Editor, on the Drawing toolbar, click Zoom .
2. On the Options toolbar, select the magnifying glass you want to use, + to
zoom in and - to zoom out.
3. In the work area, click the object you want to zoom in or out on.
Note
You zoom in/out by 10% each time you click the object.
04-16006-04-en, March 2015 Technical
965
32 Grid and Zoom
32.6 Zoom to a Specified Value
32.6 Zoom to a Specified Value
You zoom to a specified value to get an exact percentage of the original size.
To zoom to a specified value
1. In Graphics Editor, on the menu bar, enter a percentage in the Zoom box .
Note
• Zoom to fit zooms the drawing to fill the available presentation
area.
• You can enter any percentage value in the Zoom box.
Technical 04-16006-04-en, March 2015
966
33 Graphics Editor Figures
Topics
Figures
Lines
Drawing a Line
Polylines
Drawing a Polyline
Curves
Drawing a Curve
Editing a Curve
Polygons
Drawing a Polygon
Rectangles
Drawing a Rectangle
Drawing a Square
Ellipses
Drawing an Ellipse
Circles
Drawing a Circle
Arcs
Pies
Drawing an Arc or a Pie
Editing an Arc
Texts and Textboxes
Adding Text Using the Text Tool
Making Text Content Dynamic
Adding Text Using the Textbox tool
Editing Text
Paths
Creating a Text Path
Editing a Text Path
Pictures
SVG Support
Inserting a Picture
Adjusting a Picture
Adding an Animated Picture
Making an Animated Picture Dynamic
33 Graphics Editor Figures
33.1 Figures
33.1 Figures
A figure is the smallest independent element of a graphic, for example, a circle.
All figures in a graphic are displayed in a tree structure in the Objects pane. The
TGML root object is always present in the tree structure and cannot be deleted. The
TGML root object properties define the size and color of the work area. The position
of the objects in the tree structure reflects the relationship between figures in the
graphic. The closer in the tree structure a figure is to the TGML root object, the
further back it is located in the work area. You can move the figures in the tree
structure. When you move a figure in the tree structure, it is dynamically moved
back or forward in the work area.
Note
• Apart from the two surface coordinates, x and y, figures also have a hidden
stacking order known as the z-coordinate or the z-order. The z order means
that more recently added figures are put in the front and older ones in the
back. Thus, more recent figures can cover previous figures in the graphic.
Tip
• To change the order of the figures, you select a figure in the Objects pane
and click the Move up or Move down button.
When you select a figure in the work area, the figure and its elements are selected in
the Objects pane. You can also select an element in the Objects pane.
Important
• Before you can select a figure in the work area, you have to make sure that
the layer where the figure is located is active.
To create certain elements on an object, you need to right-click on the object and
then click the element in the Objects pane.
Use this method to create the following elements on an object:
• Bind
• Link
• Animate
• TargetArea
• Metadata
• Chord
• AnimatedImage
• Expose
• Script
you have to right-click the object and then click the element in the Objects pane.
04-16006-04-en, March 2015 Technical
969
33 Graphics Editor Figures
33.1 Figures
33.1.1 Figure Tools
Use the Graphics Editor drawing tools to add lines, polylines, curves, polygons,
rectangles, ellipses, arcs, pies, texts, and textboxes to a graphic.
For more information, see section 23.7 “Drawing Tools” on page 801.
33.1.2 Snippets
Snippets are standardized, predefined functions for defined use.
For more information, see section 24.11 “Snippets” on page 828.
33.1.3 Attributes
Each element in the Objects pane has a number of properties. The Graphics Editor
object properties are referred to as attributes, in compliance with XML standards.
The attributes are displayed in the Properties pane, where they can be edited.
Attributes are used to give a complete description of a graphic object. Most of the
attributes are automatically defined when the graphic object is created. By
changing the attributes, you can change, for example, the appearance and
behavior of a graphic object.
For more information, see section 27.1 “Attributes” on page 851.
33.1.4 Binds and Links
A dynamic graphic object can be bound to, and thus controlled by, server variables
(signals). When the signal changes the behavior or appearance of the object
changes dynamically.
For more information, see section 28.1 “Binds and Links” on page 871.
33.1.5 Graphics Editing Tools
You can edit all graphic objects, that is, modify their properties. For example,
shape, size, and color.
For more information, see section 30.2 “Graphics Editing Tools” on page 896.
Technical 04-16006-04-en, March 2015
970
33 Graphics Editor Figures
33.2 Lines
33.2 Lines
Use the Graphics Editor Line tool to draw a straight line, that is, a line between two
points.
You can set stroke, style and width properties for the line to change the line color,
pattern and thickness.
04-16006-04-en, March 2015 Technical
971
33 Graphics Editor Figures
33.3 Drawing a Line
33.3 Drawing a Line
You draw a line when you want to draw an extending one-dimensional figure that
has no curvature .
To draw a line
1. In Graphics Editor, in the Layers pane, select the layer whre you want to draw
the line.
2. On the Drawing toolbar, click Line.
3. In the work area, click where you want the line to start and drag to where you
want it to end.
4. On the Drawing toolbar, click Select.
5. In the Properties pane, in the Name box, type the name of the line.
Note
You only need to name the drawing object if you will be binding the
object. Naming the object now will help you identify the object later.
6. On the Options toolbar, or in the Properties pane, adjust the appearance of
the line.
7. On the File menu, click Save.
Technical 04-16006-04-en, March 2015
972
33 Graphics Editor Figures
33.4 Polylines
33.4 Polylines
Use the Graphics Editor Polyline tool to draw a line with several nodes, that is, a
line with angles.
You can set fill, stroke, style and line width to achieve a certain appearance of the
polyline.
04-16006-04-en, March 2015 Technical
973
33 Graphics Editor Figures
33.5 Drawing a Polyline
33.5 Drawing a Polyline
You draw a polyline to get a figure that consists of two or more connected line
segments.
For more information, see section 33.4 “Polylines” on page 971.
To draw a polyline
1. In Graphics Editor, in the Layers pane, select the layer where you want to
draw the polyline
2. On the Drawing toolbar, click Polyline.
3. In the work area, drag from where you want the polyline to start and click for
each new line segment you want to add.
Note
You have to add a new segment for every turn of the polyline.
4. Double-click to finish the polyline.
5. On the Drawing toolbar, click Select.
6. In the Properties pane, in the Name box, type the name of the polyline.
Note
You only need to name the drawing object if you will be binding the
object. Naming the object now will help you identify the object later.
7. On the Options toolbar, or in the Properties pane, adjust the appearance of
the curve.
8. On the File menu, click Save.
Technical 04-16006-04-en, March 2015
974
33 Graphics Editor Figures
33.6 Curves
33.6 Curves
Use the Graphics Editor Curve tool to draw a curve, that is, a line that is not
straight.
Drawing perfect curves requires some understanding of the principles of curves, as
well as some practical experience. When you draw a curve and click the key points
of the curve, a number of curve segments are created. These segments are defined
by three vertices:
• The vertex, that is, the start point
• The highest/lowest point of a curve segment
• The end point
When a curve consists of more than one segment, the point connecting two curve
segments is also a vertex. The curve passes through all of these vertex points.
Normally, the vertex points are not displayed, but to modify the curve you need to
access these points.
When you double-click the curve, the vertices are displayed. Two handles are
associated with each vertex (except for the start and end points, which have only
one handle).
Figure: A simple curve with its three vertices and two plus two handles
Each handle controls the shape of the curve at its side of the vertex. The length and
the angle of the handle determine the direction and curvature of that end of the
segment. The handle can be regarded as a magnet attracting its part of the
segment.
Figure: By stretching the top right handle, that part of the curve segment is modified
If you want to modify a curve, you have the following options:
• Moving a Curve Vertex
• Adjusting a Curve Handle
Tip
You can also nudge the vertex by using the arrow keys.
04-16006-04-en, March 2015 Technical
975
33 Graphics Editor Figures
33.7 Drawing a Curve
33.7 Drawing a Curve
You draw a curve to get a line that is not straight and that consists of two or more
segments.
For more information, see section 33.6 “Curves” on page 973.
To draw a curve
1. In Graphics Editor, in the Layers pane, select the layer where you want to
draw the curve.
2. On the Drawing toolbar, click Curve.
3. In the work area, drag from where you want the curve to start and click for
each segment you want to add.
Note
You have to add a new segment for each turn of the curved line.
4. Double-click to finish the curve.
5. On the Drawing toolbar, click Select.
6. In the Properties pane, in the Name box, type the name of the curve.
Note
You only need to name the drawing object if you will be binding the
object. Naming the object now will help you identify the object later.
7. On the Options toolbar or in the Properties pane, adjust the appearance of
the curve.
8. On the File menu, click Save.
Technical 04-16006-04-en, March 2015
976
33 Graphics Editor Figures
33.8 Editing a Curve
33.8 Editing a Curve
You edit a curve to adjust any point of the curve.
For more information, see section 33.6 “Curves” on page 973.
To edit a curve
1. In Graphics Editor, in the work area, double-click the curve to display its
vertices.
2. Drag the vertex you want to change to a new position.
3. Click outside the curve to finish.
04-16006-04-en, March 2015 Technical
977
33 Graphics Editor Figures
33.9 Polygons
33.9 Polygons
Use the Graphics Editor Polygon tool to draw a polygon, that is, a plane figure that
is bounded by a closed path, composed of a finite sequence of straight line
segments.
Technical 04-16006-04-en, March 2015
978
33 Graphics Editor Figures
33.10 Drawing a Polygon
33.10 Drawing a Polygon
You draw a polygon when you need a closed multi-sided figure.
To draw a polygon
1. In Graphics Editor, in the Layers pane, select the layer where you want to
draw the polygon.
2. On the Drawing toolbar, click Polygon.
3. In the work area, click where you want to locate the corners of the polygon.
4. Double-click to close the polygon.
5. On the Drawing toolbar, click Select.
6. In the Properties pane, in the Name box, type the name of the polygon.
Note
You only need to name the drawing object if you will be binding the
object. Naming the object now will help you identify the object later.
Continued on next page
04-16006-04-en, March 2015 Technical
979
33 Graphics Editor Figures
33.10 Drawing a Polygon
7. On the Options toolbar or in the Properties pane, adjust the appearance of
the polygon.
8. On the File menu, click Save.
Technical 04-16006-04-en, March 2015
980
33 Graphics Editor Figures
33.11 Rectangles
33.11 Rectangles
Use the Graphics Editor Rectangle tool to draw a simple rectangle, that is, a
quadrilateral with four right angles.
04-16006-04-en, March 2015 Technical
981
33 Graphics Editor Figures
33.12 Drawing a Rectangle
33.12 Drawing a Rectangle
You draw a rectangle when you need a four-sided figure with four 90 ° angles and
there is no component that works for this situation.
For more information, see section 23.7 “Drawing Tools” on page 801.
To draw a rectangle
1. In Graphics Editor, in the Layers pane, select the layer you want to draw the
rectangle on.
2. On the Drawing toolbar, click Rectangle.
3. In the work area, click where you want the rectangle to begin and drag the
pointer to where you want it to end.
4. On the Drawing toolbar, click Select.
5. In the Properties pane, in the Name box, type the name of the rectangle.
Note
You only need to name the drawing object if you will be binding the
object. Naming the object now will help you identify the object later.
6. On the Options toolbar or in the Properties pane, adjust the appearance of
the rectangle.
7. On the File menu, click Save.
Technical 04-16006-04-en, March 2015
982
33 Graphics Editor Figures
33.13 Drawing a Square
33.13 Drawing a Square
You draw a square when you need a figure with four equal sides and four 90 °
angels.
To draw a square
1. In Graphics Editor, in the Layers pane, select the layer you want to draw the
square.
2. On the Drawing toolbar, click Rectangle
3. In the work area, press SHIFT and click where you want the square to begin
and drag to where you want it to end.
4. On the Drawing toolbar, click Select.
5. In the Properties pane, in the Name box, type the name of the square.
Note
You only need to name the drawing object if you will be binding the
object. Naming the object now will help you identify the object later.
6. On the Options toolbar or in the Properties pane, adjust the appearance of
the rectangle.
7. On the File menu, click Save.
04-16006-04-en, March 2015 Technical
983
33 Graphics Editor Figures
33.14 Ellipses
33.14 Ellipses
Use the Graphics Editor Ellipse tool to draw an ellipse, that is, a plane curve that
results from the intersection of a cone by a plane in a way that produces a closed
curve.
Tip
To draw a circle, select Ellipse and press SHIFT while you draw.
Technical 04-16006-04-en, March 2015
984
33 Graphics Editor Figures
33.15 Drawing an Ellipse
33.15 Drawing an Ellipse
You draw an ellipse when you need a conic section whose plane is not parallel to
the axis, base, or generatrix of the intersected cone.
To draw an ellipse
1. In Graphics Editor, in the Layers pane, select the layer where you want to
draw the ellipse.
2. On the Drawing toolbar, click Ellipse.
3. In the work area, drag the pointer from where you want to start the ellipse to
where you want it to end.
4. On the Drawing toolbar, click Select.
5. In the Properites pane, in the Name box, type the name of the ellipse.
Note
You only need to name the drawing object if you will be binding the
object. Naming the object now will help you identify the object later.
Continued on next page
04-16006-04-en, March 2015 Technical
985
33 Graphics Editor Figures
33.15 Drawing an Ellipse
6. On the Options toolbar or in the Properties pane, adjust the appearance of
the ellipse.
7. On the File menu, click Save.
Technical 04-16006-04-en, March 2015
986
33 Graphics Editor Figures
33.16 Circles
33.16 Circles
In Graphics Editor, use the Ellipse tool to draw a circle, that is, a line forming a
closed loop, every point on which is a fixed distance from a center point. A circle is
actually a special case of an ellipse. In an ellipse, if you make the major and minor
axis the same length, the result is a circle, with both foci at the center.
04-16006-04-en, March 2015 Technical
987
33 Graphics Editor Figures
33.17 Drawing a Circle
33.17 Drawing a Circle
You draw a circle when you need a figure forming a closed loop where every point
is a fixed distance from the center point.
For more information, see section 33.16 “Circles” on page 985.
To draw a circle
1. In Graphics Editor, in the Layers pane, select the layer where you want to
draw the circle.
2. On the Drawing toolbar, click Ellipse.
3. I the work area, click SHIFT while dragging the pointer from where you want
the circle to begin to where you want it to end.
4. On the Drawing toolbar, click Select.
5. In the Properties pane, in the Name box, type the name of the circle.
Note
You only need to name the drawing object if you will be binding the
object. Naming the object now will help you identify the object later.
6. On the Options toolbar or in the Properties pane, adjust the apperance of
the circle.
7. On the File menu, click Save.
Technical 04-16006-04-en, March 2015
988
33 Graphics Editor Figures
33.18 Arcs
33.18 Arcs
Use the Graphcis Editor Arc tool to draw an arc, that is, a part of the periphery of
an ellipse, or a circle.
The arc is defined by a center point, a radius X, a radius Y, a start angle, and a
sweep angle. The start angle is the angle between the X-axis and the start of the
arc. The sweep angle can lie in the interval ±(0° – 360°).
04-16006-04-en, March 2015 Technical
989
33 Graphics Editor Figures
33.19 Pies
33.19 Pies
Use the Graphics Editor Pie tool to draw a pie, that is, an area enclosed by two
radii of a circle and their intercepted arc.
The pie is defined by a radius X, a radius Y, a start angle, and a sweep angle. The
start angle is the angle between the X-axis and the start of the arc. The sweep angle
can lie in the interval ±(0° – 360°).
A pie is similar to an arc, but includes the two radii and the area within.
Technical 04-16006-04-en, March 2015
990
33 Graphics Editor Figures
33.20 Drawing an Arc or a Pie
33.20 Drawing an Arc or a Pie
Use Arc or Pie to draw a curve-like segment, but with specified start and end
points. The initial sweep angle is always 90°. The orientation of the 90° arc or pie
corresponds to the position of the end point, related to the start point.
For more information, see section 33.18 “Arcs” on page 987. For more information,
see section 33.19 “Pies” on page 988.
To draw an arc
1. In Graphics Editor, in the Layers pane, select the layer where you want to draw
the arc or pie.
2. On the Drawing toolbar, select Arc The cursor will change into a crosshair
pointer.
3. In the work area, drag the pointer from where you want to start the arc or pie
to where you want it to end.
4. On the Drawing toolbar, click Select.
5. In the Properties pane, in the Name box, type the name of the arc or pie.
Note
You only need to name the drawing object if you will be binding the
object. Naming the object now will help you identify the object later.
6. On the Options toolbar, or in the Properties pane, adjust the appearance of
the arc or pie.
7. On the File menu, click Save.
04-16006-04-en, March 2015 Technical
991
33 Graphics Editor Figures
33.21 Editing an Arc
33.21 Editing an Arc
You edit the start and sweep vertexes of an arc to change its angle.
For more information, see section 33.19 “Pies” on page 988.
To edit an arc
1. In Graphics Editor, in the work area, double-click anywhere on the arc to
display the vertexes.
2. Select the vertex you want to edit and drag it to a new position.
Note
• You can extend the angle handle to increase the precision. This
does not affect the arc in other ways.
• If you press the SHIFT key while moving the cursor, the angle
changes in steps of 7.5°, somewhat depending on how much
you extend the handle.
3. Click outside the arc to finish.
Technical 04-16006-04-en, March 2015
992
33 Graphics Editor Figures
33.22 Texts and Textboxes
33.22 Texts and Textboxes
Use the Graphics Editor Text tool to write a single line of text with no wrapping.
Use the Graphics Editor Textbox tool to write one or several lines of text that are
wrapped within the specified box.
You can edit and format the text by using the standard formatting tools.
33.22.1 Text Path
A text path is a free form curve of text. You use the text path to make the characters
independent of any font library. The disadvantage of this is that you can no longer
edit the characters as text.
When you create a path of text, you create a copy, which can be treated as an
ordinary closed curve. You can set Stroke and Fill color for the text path.
The original text remains unchanged and if required you can delete it.
04-16006-04-en, March 2015 Technical
993
33 Graphics Editor Figures
33.23 Adding Text Using the Text Tool
33.23 Adding Text Using the Text Tool
Text is typically used for adding labels or informative comments within your graphic.
You add a single line of text using the Text tool. Textboxes are used when you need
to wrap text.
For more information, see section 33.22 “Texts and Textboxes” on page 991.
To add text using the Text tool
1. In Graphics Editor, in the Layers pane, select the layer you want to add the
text on.
2. On the Drawing toolbar, click Text.
3. Click in the work area where you want the text to start.
4. Type the text you want to add to the graphic.
5. Press Enter.
6. On the Drawing toolbar, click Select.
7. In the Properties pane, in the Name box, type the name of the text.
Note
You only need to name the drawing object if you will be binding the
object. Naming the object now will help you identify the object later.
8. On the Options toolbar or in the Properties pane, adjust the appearance of
the text.
9. On the File menu, click Save.
Technical 04-16006-04-en, March 2015
994
33 Graphics Editor Figures
33.24 Making Text Content Dynamic
33.24 Making Text Content Dynamic
You make text content dynamic so that the text changes according to the value of
the variable it is bound to. This way you use only one text object to show different
texts depending on the value of the variable.
To make text content dynamic
1. In Graphics Editor, in the Layers pane, select the layer that contains the text
you want to make dynamic.
2. In the work area, select the text you want to make dynamic.
3. In the Object pane, right-click Text, point to New, and then click Bind.
4. In the Properties pane, in the Name box, type the name of the Bind object.
Continued on next page
04-16006-04-en, March 2015 Technical
995
33 Graphics Editor Figures
33.24 Making Text Content Dynamic
5. In the Attribute box, select Content.
6. In the Objects pane, right-click Bind, point to New, and then click
ConvertValue.
7. In the Properties pane, in the Name box, type a name for the ConvertValue
object.
8. In the AttributeValue box, type the text that you want to display in the
graphic.
Continued on next page
Technical 04-16006-04-en, March 2015
996
33 Graphics Editor Figures
33.24 Making Text Content Dynamic
9. In the SignalEqualTo box, type the value when the text is to be displayed.
10. Add more ConvertValue objects to the Bind object, one for each value of the
variable that is to be displayed as text.
11. In the Objects pane, right-click the Text, point to Group as, and then click
Component.
12. In the Properties pane, in the Name box, type the name of the component.
13. On the File menu, click Save.
04-16006-04-en, March 2015 Technical
997
33 Graphics Editor Figures
33.25 Adding Text Using the Textbox tool
33.25 Adding Text Using the Textbox tool
You add text within a textbox when you want to add several lines of text with
automatic line wrap within a defined area.
For more information, see section 33.22 “Texts and Textboxes” on page 991.
To add text using the Textbox tool
1. In Graphics Editor, in the Layers pane, select the layer you want to add the
text on.
2. On the Drawing toolbar, click Textbox.
3. In the work area, click where you want to locate the upper-left corner of the
textbox.
4. Drag the pointer to where the lower-right corner of the textbox is to end.
5. Type the text you want to add to the graphic.
6. On the drawing toolbar, click Select.
7. Adjust the size of the textbox.
8. In the Properties pane, in the Name box, type the name of the textbox.
Note
You only need to name the drawing object if you will be binding the
object. Naming the object now will help you identify the object later.
9. On the Options toolbar or in the Properties pane, adjust the appearance of
the text.
10. On the File menu, click Save.
Technical 04-16006-04-en, March 2015
998
33 Graphics Editor Figures
33.26 Editing Text
33.26 Editing Text
You can reformat single line texts and texts within textboxes.
For more information, see section 33.22 “Texts and Textboxes” on page 991.
To edit text
1. In Graphics Editor, in the work area, select the text or textbox object
containing the text you want to edit.
2. On the Options toolbar, expand Stroke and select a new text color from the
Color palette.
3. On the Options toolbar, expand Fill and select a new background color for
the textbox from the Color palette.
4. Double-click the text/textbox object and edit the text by adding or deleting
text.
5. On the Options toolbar, set font, font size, and other text properties.
6. When finished, click outside the text/textbox.
04-16006-04-en, March 2015 Technical
999
33 Graphics Editor Figures
33.27 Paths
33.27 Paths
When you create a path of one or several objects, you create a copy in the form of a
path, where the original objects have been dissolved and replaced with
corresponding lines and fills. For example, a rectangle dissolves into a path of four
connected strokes.
By creating a path, the number of objects is reduced to one. That is, the resulting
path.
The advantage of using a path is that it speeds up the drawing of the object, which
can be important when using animations.
The original objects remain unchanged and can be deleted, if required.
Technical 04-16006-04-en, March 2015
1000
33 Graphics Editor Figures
33.28 Creating a Text Path
33.28 Creating a Text Path
You create a text path to protect the text so that it cannot be manipulated and to be
able to use effects like gradients on the text. When you creat a text path, the text in
reality becomes a curve.
For more information, see section 33.22 “Texts and Textboxes” on page 991.
To create text path
1. In Graphics Editor, on the Options toolbar set the Fill, Stroke, Style, and
Width properties for the text path you are going to create.
2. On the Drawing toolbar, click Text or Textbox .
3. In the work area, click the general area where you want to position the text
path and write the text.
4. Right-click the text or textbox object and click Create Path.
The characters are transformed to curve paths, with the appearance you specified
in the first step. You can edit the appearance.
Note
• The original text remains untouched, but can be moved or deleteed.
04-16006-04-en, March 2015 Technical
1001
33 Graphics Editor Figures
33.29 Editing a Text Path
33.29 Editing a Text Path
You edit a text path to change its appearance or other properties. The text path is in
fact a curve and can be modified like any other curve, but you can no longer edit the
text itself.
For more information, see section 33.22 “Texts and Textboxes” on page 991.
To edit a text path
1. In Graphics Editor, in the work area, select the text path.
2. In the Properties pane, edit the properties (Fill, Opacity, Stroke,
StrokeDashArray, StrokeWidth, or Visibility).
3. Double-click the path and drag the vertices to change the shape of the path.
4. Click outside the textpath to clear the selection.
Technical 04-16006-04-en, March 2015
1002
33 Graphics Editor Figures
33.30 Pictures
33.30 Pictures
Use the Graphics Editor Insert Pictures tool to insert supported image files into
your graphic.
The native Graphics Editor file formats are . *.gif, *.jpg, and *.png files. That is,
pasted components and graphics will be saved as one of these file types.
Table: File Formats You Can Insert into a Graphic
Graphic Type File Type
Bitmap *.bmp
Bitmap *.dib
GIF *.gif
Icon *.ico
JPEG *.jpg
JPEG *.jpeg
JPEG *.jpe
JPEG *.jfif
JPEG *.exif
Metafile *.wmf
Metafile *.emf;
PNG *.png
TIFF *.tiff
TIFF *.tif
33.30.1 Image Insertion
A raster image can be inserted anywhere in the work area. When you add an image,
the actual image is saved with the graphic. That is, the image is not linked into the
graphic.
Raster images put a heavy load on graphics handling.
Important
• To minimize system load, reduce size and color depht of the images before
inserting them into a graphic.
Use an image editor to resize the image to the size required in the graphic. If you
use the .jpg format, the image can be compressed to a quality of 60% without any
adverse effects on the appearance.
04-16006-04-en, March 2015 Technical
1003
33 Graphics Editor Figures
33.30 Pictures
If you want to use transparency, you should add it to the original image. This can be
done if you use the .png format.
Tip
• You can paste any picture residing on the clipboard to the work area.
• You can also drag pictures to the work area.
Technical 04-16006-04-en, March 2015
1004
33 Graphics Editor Figures
33.31 SVG Support
33.31 SVG Support
You can import SVG pictures, but only the following SVG Elements and Properties
are supported.
33.31.1 Supported SVG Elements
SVG
VERSION
LINE
POLYLINE
POLYGON
ELLIPSE
CIRCLE
RECT
TEXT
PATH
GROUP
DEFS
LINEARGRADIENT
RADIALGRADIENT
STOP
IMAGE
33.31.2 Supported SVG Attributes
LEFT
TOP
WIDTH
HEIGHT
D
R
X
X1
X2
CX
RX
Y
Y1
04-16006-04-en, March 2015 Technical
1005
33 Graphics Editor Figures
33.31 SVG Support
Y2
CY
RY
FX
FY
ID
POINTS
STYLE
FILL
STROKE
STROKEWIDTH
OPACITY
OFFSET
FONTFAMILY
FONTSIZE
VISIBILITY
DISPLAY
VISIBILITY_HIDDEN
VISIBILITY_NONE
VISIBILITY_COLLAPSE
VISIBILITY_VISIBLE
VISIBILITY_INLINE
TRANSFORM
TRANSLATE
SCALE
SCALEX
SCALEY
ROTATE
SKEWX
SKEWY
STOP_COLOR
SPREADMETHOD
SPREADMETHOD_PAD
SPREADMETHOD_REFLECT
SPREADMETHOD_REPEAT
STROKE_OPACITY
FILL_OPACITY
XLINK_HREF
STROKEDASHARRAY
Technical 04-16006-04-en, March 2015
1006
33 Graphics Editor Figures
33.31 SVG Support
GRADIENTSTOP
04-16006-04-en, March 2015 Technical
1007
33 Graphics Editor Figures
33.32 Inserting a Picture
33.32 Inserting a Picture
You insert a picture when you want to add an image, such as a .bmp or .png file,
into a graphic.
For more information, see section 33.30 “Pictures” on page 1001.
To insert a picture
1. In Graphics Editor, in the Layers pane, select the layer where you want to add
the picture.
2. On the Drawing toolbar, click Insert Picture.
3. In the work area, click where you want to locate the upper-left corner of the
picture.
4. Select the picture you want to insert into the graphic.
5. On the Drawing toolbar, click Select.
6. In the Properties pane, in the Name box, type the name of the picture.
Note
You only need to name the drawing object if you will be binding the
object. Naming the object now will help you identify the object later.
7. On the Options toolbar or in the Properties pane, adjust the appearance of
the picture.
8. On the File menu, click Save.
Technical 04-16006-04-en, March 2015
1008
33 Graphics Editor Figures
33.33 Adjusting a Picture
33.33 Adjusting a Picture
You adjust a picture to change any of its properties.
For more information, see section 33.30 “Pictures” on page 1001.
To adjust a picture
1. In Graphics Editor, in the work area, select the picture you want to adjust.
2. Drag the picture to reposition it.
3. Press SHIFT while dragging one of the corner handles to resize the picture but
keep the aspect ratio.
4. To change the opacity or visibility for the picture, in the Properties pane, in
the Appearance area, select the corresponding elements and enter new
values.
Note
• For performance reasons, it is strongly recommended that you
edit the picture before inserting it into the graphic.
5. On the File menu, click Save.
04-16006-04-en, March 2015 Technical
1009
33 Graphics Editor Figures
33.34 Adding an Animated Picture
33.34 Adding an Animated Picture
You insert an animated picture when you want to add an animated image, such as
a .gif file, into a graphic.
To add an animated picture
1. In Graphics Editor, in the Layers pane, select the layer where you want to add
an animated image.
2. On the Drawing toolbar, click Insert Picture.
3. In the work area, click where you want to locate the upper-left corner of the
animated image.
4. Select the animated picture you want to insert into the graphic.
5. On the Drawing toolbar, click Select.
6. In the Properties pane, in the Name box, type the name of the animated
image.
Note
You only need to name the drawing object if you will be binding the
object. Naming the object now will help you identify the object later.
7. On the Options toolbar or in the Properties pane, adjust the appearance of
the animated image.
8. On the File menu, click Save.
Technical 04-16006-04-en, March 2015
1010
33 Graphics Editor Figures
33.35 Making an Animated Picture Dynamic
33.35 Making an Animated Picture Dynamic
You make an animated image dynamic so that the animation can start and stop
according to the value of the variable it is bound to. This way you use the animation
in the image instead of using components.
To make an animated picture dynamic
1. In Graphics Editor, in the Layers pane, select the layer where you want to
make an animated image dynamic.
2. In the work area, select the picture you want to make dynamic.
3. In the Objects pane, right-click AnimatedImage, point to New, and then
click Bind.
4. In the Properties pane, in the Name box, type the name of the Bind object.
5. In the Attribute box, select Animation.
6. In the Objects pane, right-click Bind, point to New, and then click
ConvertValue.
7. In the Properties pane, in the Name box, type the name of the ConvertValue
object.
8. In the AttributeValue box, select Start.
Continued on next page
04-16006-04-en, March 2015 Technical
1011
33 Graphics Editor Figures
33.35 Making an Animated Picture Dynamic
9. In the SignalEqualTo box, type the value that should start the animation.
10. In the Objects pane, right-click Bind, point to New, and then click Convert
Value.
11. In the Properties pane, in the Name box, type the name of the
ConvertValue.
12. In the AttributeValue box, select Stop.
13. In the SignalEqualTo box, type the value that should stop the animation.
14. On the File menu, click Save.
Technical 04-16006-04-en, March 2015
1012
34 Graphics TGML Format
Specification
Topics
TGML Overview
TGML Coordinate System
TGML Rendering Model
TGML Types and Enumerations
TGML File Format
TGML Code Snippets
TGML Common Attributes
TGML Components
TGML Document Structure
TGML Document Type Element and Metadata
TGML User-Defined Descriptions of Custom Attributes
TGML Animations
TGML Animation: <Animate>
TGML Sequences: <Sequence>
TGML Attribute Exposure
TGML Expose Element: <Expose>
TGML Curves and Paths
TGML Cubic Bezier Curve: <Curve>
TGML Path Element: <Path>
TGML Dynamics
TGML Signal Binding: <Bind>
TGML Value Conversion: <ConvertValue>
TGML Text Value Conversion: <ConvertText>
TGML Value Range Conversion: <ConvertRange>
TGML Custom Conversion: <ConvertCustom>
TGML Status Conversion: <ConvertStatus>
TGML Basic Shapes
TGML Line: <Line>
TGML Polyline: <Polyline>
TGML Polygon: <Polygon>
TGML Rectangle: <Rectangle>
TGML Ellipse: <Ellipse>
TGML Segment Shapes
TGML Elliptical Arc: <Arc>
TGML Elliptical Pie: <Pie>
TGML Elliptical Chord: <Chord>
TGML Gradients
TGML Linear Gradient: <LinearGradient>
TGML Radial Gradient: <RadialGradient>
TGML Gradient Stop: <GradientStop>
TGML Grouping Elements
TGML Grouping: <Group>
TGML Components: <Component>
TGML Layers: <Layer>
TGML Link element: <Link>
TGML Raster Images
TGML Image Element: <Image>
TGML Animated Images (GIF89a): <AnimatedImage>
TGML Scripting
TGML Script Element: Script
TGML Target Area Element: <TargetArea>
TGML Text
TGML Text Line: <Text>
TGML Text Flow: <TextBox>
TGML Transformations
TGML Rotation: <Rotate>
TGML Skewing: <SkewX> and <SkewY>
TGML Scaling: <Scale>
TGML Translations: <Translate>
34 Graphics TGML Format Specification
34.1 TGML Overview
34.1 TGML Overview
TGML (TAC Graphics Markup Language) is a declarative XML-based language for
dynamic 2D graphics.
TGML is inspired by the XML based Scalable Vector Graphics (SVG) which is an
open standard for 2D graphics.
TGML specifies a hierarchy of runtime objects with a set of properties and logic.
Each markup element (XML element) represents a TGML object which can be
edited, or configured, in the Graphics Editor. However, not all of the objects are
graphical (visible). Several objects are used to add a specific behavior to a graphical
object, such as enabling dynamic update of attributes, transformations and
gradients.
The TGML object model is based on the W3C Document Object Model (DOM). The
TGML graphics elements are accessible for applications through the exposed
TGML DOM interfaces.
TGML version
The TGML version is specified in a XML processing instruction:
Figure: TGML code displaying the TGML version
Namespaces
The TGML graphics elements specified in this specification belong to the default
XML namespace, TGML.
TGML allows inclusion of elements from foreign namespaces anywhere with the
TGML content. In general, the TGML loader will include the unknown (foreign)
elements in the DOM, but will otherwise ignore the unknown elements.
34.1.1 Properties and Attributes
In the underlying class library, public data members are exposed as properties.
Each TGML element attribute has a corresponding property in the TGML class that
implements the TGML element.
Default Values
Most of the object properties have a default value. Element attributes that are
omitted in the TGML document are considered to be undefined. An undefined
attribute will result in assigning a default value to the corresponding property, unless
the value is inherited from a parent element.
Attribute Inheritance
TGML supports attribute inheritance similar to the SVG and XAML attribute
inheritance.
04-16006-04-en, March 2015 Technical
1017
34 Graphics TGML Format Specification
34.1 TGML Overview
The attribute inheritance means that a child element inherits (gets) the attribute
value from an ancestor element if the attribute value is omitted and if the attribute
has been specified for an ancestor (any of the parents).
In the example below, Line will inherit the Stroke value from the Group. StrokeWidth
is not defined either, but since it is not specified at the parent level, StrokeWidth will
be assigned the default StrokeWidth value.
Custom Attributes
The implementation of attribute inheritance also enables the user to specify custom
attributes, since an element will accept attributes that are actually unknown for the
element. For example, in the attribute inheritance example, Stroke was specified,
and accepted at the group level, despite the Group does not have a Stroke
attribute.
Custom attributes can, for example, be used to create "local" variables. The custom
attribute can be bound to a signal, or animated, as any other attribute of an element
and it can be accessed from scripts in the graphics.
Error Notifications
TGML does not specify any error or warning notifications. However, the TGML
implementation (e.g. Graphics Services) and the viewer and editor applications
should notify the user about any error conditions.
Implicit Syntax
TGML uses an implicit syntax. The object model implementation is not exposed in
the serialized TGML.
The following example defines a group containing a line. The TGML code does not
reveal how the containment is implemented in Group. The Group implementation
includes for example a child list that is the actual container, but such information is
not serialized.
Undefined (non-specified) attributes values are not serialized, to avoid breaking the
attribute inheritance.
Technical 04-16006-04-en, March 2015
1018
34 Graphics TGML Format Specification
34.2 TGML Coordinate System
34.2 TGML Coordinate System
The origin of the TGML default coordinate system is in the upper-left corner. Values
of x increase as you move right, and values of y increase as you move down.
Container elements such as TGML and Component establish new coordinate
systems. Group is also a container element, but does not establish a new
coordinate system.
Figure: TGML container elements
Coordinates
The unit of measurement for coordinates is the device independent pixel, which is
1/96 of an inch (96dpi). The data type for coordinates and lengths (that is, Width
and Height) is Double.
Initial Scale
A TGML viewer uses the Width, Height and Stretch attributes of the outermost
TGML element to determine the initial scale. Stretch specifies if the document is
scaled to fit within the work area (preserving the aspect ratio or not) or if the original
size is preserved (scale 1:1).
04-16006-04-en, March 2015 Technical
1019
34 Graphics TGML Format Specification
34.3 TGML Rendering Model
34.3 TGML Rendering Model
The following description is a summary of the TGML rendering model, which is very
similar to the SVG rendering model.
Elements in a TGML document have an implicit drawing order, with the first
elements in the TGML document getting "painted" first. Subsequent elements are
painted on top of previously painted elements.
Grouping elements have the effect of producing a temporary separate canvas onto
which child elements are painted. Upon the completion of the group, any filter
effects specified for the group are applied to create a modified temporary canvas.
The modified temporary canvas is composited into the background, taking into
account any group-level settings, such as opacity, on the group.
Individual graphics elements are rendered as if each graphics element represented
its own group (applicable when for example opacity is defined for the element).
Grouping elements have the effect of producing a temporary separate canvas onto
which child elements are painted.
Figure: Temporary canvas of grouped elements.
Upon the completion of the group, any filter effects specified for the group are
aööoled to create a modified temporary canvas.
Figure: Filter effects specified for the group modify the temporary canvas.
The modified temporary canvas is composited into the background, taking into
account any group-level settings, such as opacity, on the group.
Figure: Temporary canvas composited into the background
Technical 04-16006-04-en, March 2015
1020
34 Graphics TGML Format Specification
34.4 TGML Types and Enumerations
34.4 TGML Types and Enumerations
All TGML attributes are of a certain type or enumeration.
Type/Enumeration Description
Animation An enumeration that controls an animation:
"Start", "Stop"
Bool A boolean value:
"True", "False"
Brush Describes how an area (Fill) or a stroke
(Stroke) is painted. Accepted values (WP1):
"None", "<Color>"
CalcMode Specifies how values are interpolated when
animated:
"Discrete", "Linear"
Remark: "Linear" is only applicable when
you animate attributes of the types Double,
Color, Point and array of Point.
Color An RGB or an ARGB color.
RGB is described as the hexadecimal
representation of the red,gren and blue
components.
ARGB is described as the hexadecimal
representation of the alpha (00-FF, where 00
is fully transparent), red, green, and blue
components (in that order).
Example, opaque red: Fill="#FF0000"
Example, 50% transparent red:
Fill="#7FFF0000"
Double Double-precision floating-point numbers. For
example, heights and widths are Double.
Example:"50, 25"
FontStyle Describes the style of the font: "Normal",
"Italic"
FontWeight Describes the weight of the font: "Normal",
"Bold"
Format This enumeration describes the formating of
the subscribed data.
"None": No formating. The data type of the
received data matches the data type of the
server variable (integer, float, boolean, string
etc).
"Presentation": Formated as text. The
server is expected to deliver the text
representation of the value, if any (e.g.
On/Off instead of 0/1.
04-16006-04-en, March 2015 Technical
1021
34 Graphics TGML Format Specification
34.4 TGML Types and Enumerations
Continued
Type/Enumeration Description
HorizontalAlign Describes the horizontal alignment of a text
string.
"Left", "Center", "Right"
Point Represents an XY coordinate.
Syntax: "<Double>, <Double>".
Example: "25.00 , 50.00"
Repeat Describes the way the animation will be
repeated.
"<Iterations>" "Forever"
<Iterations> specifies the number of times
the animation is repeated.
SpreadMethod Specifies how a gradient should be drawn
outside of the specified gradient vector or
space:
"Pad": The color values at the ends of the
gradient vector are used to fill the remaining
space.
"Reflect": The gradient is repeated in the
reverse direction until the space is filled.
"Repeat": The gradient is repeated in the
original direction until the space is filled.
Stretch An enumeration that specifies how the
content shall be stretched.
"None": Preserve the original size.
"Uniform": Resize the content, preserving
the native aspect ratio.
"Fill": The content is resized but aspect
ratio is not preserved.
String A string value, i.e. plain text. Reserved XML
characters (&<>) are escaped using the
standard XML escaping.
TextDecoration Describes decorations that are added to the
texts.
"None", "Underline", "Strikethrough"
VerticalAlign Describes the vertical alignment of a text
string.
"Top", "Middle", "Bottom"
Visibility An enumeration that specifies the visibility of
an element:
"Visible", "Hidden"
Technical 04-16006-04-en, March 2015
1022
34 Graphics TGML Format Specification
34.4 TGML Types and Enumerations
Type/Enumeration Description
34.4.1 Arrays
Some attributes accepts arrays of values, such as arrays of Double and Point.
Arrays are written as a sequence of values, delimited by space.
04-16006-04-en, March 2015 Technical
1023
34 Graphics TGML Format Specification
34.5 TGML File Format
34.5 TGML File Format
TGML (TAC Graphics Markup Language) is a declarative XML-based language for
dynamic 2D graphics.
Graphics created in Graphics Editor are saved as .TGML files.
When you create a graphic in Graphics Editor, a TGML root object is created at the
bottom of the Objects tree in the objects pane. The TGML root object is also the
default layer in the work area of Graphics Editor. The TGML object cannot be
deleted.
34.5.1 Supported File Formats
You can import other graphics or photographs in supported formats. The following
formats are supported:
Table: Supported file formats that you can import to Graphics Editor
Graphic type File type
TGML *.tgml
OGC *.ogc
OGC *.sym
OGC *.sgr
OGC *.ogx
SVG *.svg
CAD *.dxf
CAD *.dwg
You can export graphics to supported formats.
Table: Supported file formats that you can export from Graphics Editor
Graphic type File type
Bitmap *.bmp
GIF *.gif
JPEG *.jpg
JPEG *.jpeg
JPEG *.jpe
PNG *.png
TIFF *.tiff
Technical 04-16006-04-en, March 2015
1024
34 Graphics TGML Format Specification
34.5 TGML File Format
Continued
Graphic type File type
TIFF *.tif
04-16006-04-en, March 2015 Technical
1025
34 Graphics TGML Format Specification
34.6 TGML Code Snippets
34.6 TGML Code Snippets
A snippet is a stored piece of TGML code. It can be used for reusing constructs
such as preconfigured animations and gradients.
A snippet file contains only one TGML snippet. The root element includes at least
two Metadata elements descibing the snippet; one for Name and one for
Description. It is recommended that the file name matches the Name metadata.
Figure: TGML code with Name and Description Metadata elements
Figure: Animation snippet that can be inserted as a child to any graphical (renderable)
TGML element
Technical 04-16006-04-en, March 2015
1026
34 Graphics TGML Format Specification
34.7 TGML Common Attributes
34.7 TGML Common Attributes
The following attributes are applicable to all TGML elements.
Attribute Type Description
ID String The identity of the element.
Reserved for scripts and
other entities that need to
use unique element
identifiers to access specific
elements.
Inheritable: No
Animatable: No
Name String The name of the element.
The primary use is to identify
exposed elements such as
Bind.
Inheritable: No
Animatable: No
04-16006-04-en, March 2015 Technical
1027
34 Graphics TGML Format Specification
34.8 TGML Components
34.8 TGML Components
Components are standardized, predefined graphics for defined use.
Component Library
Components are stored the same way as TGML code snipptets. Component is the
root element and the associated Metadata elements describe the component.
ComponentContent Element
The document type ComponentContent is the root of the document when the
content of a component is edited in the TGML graphics editor. ComponentContent
is replaced with Component when the component is stored in the library.
ComponentContent has the following attributes:
• Height
• Opacity
• Visibility
• Width
Width and Height are replaced with (copied to) ContentWidth and ContentHeight of
the Component element when the component is stored.
Initial Viewport
Width and Height of the stored Component are the initial viewport, that is, the initial
size of the component when it is pasted into a TGML document.
Technical 04-16006-04-en, March 2015
1028
34 Graphics TGML Format Specification
34.9 TGML Document Structure
34.9 TGML Document Structure
A TGML Graphics document always consists of at least one element, the root
("outermost") TGML element. This TGML element is the ancestor of all other
elements in the document.
Layer and Group are example of grouping (container) elements that are used to
structure the graphics. Elements that describe shapes and other graphical (visible)
objects can also have children, but these children are not visible objects, but
elements that add a specific behavior, such as gradients, animations and dynamic
bindings.
Figure: TGML code with the TGML root element and a number of child elements.
Figure: The graphic as seen in Graphics Editor.
04-16006-04-en, March 2015 Technical
1029
34 Graphics TGML Format Specification
34.10 TGML Document Type Element and Metadata
34.10 TGML Document Type Element and
Metadata
Each TGML document contains the TGML root element. It also contains metadata
created and interpreted by the TGML application.
Document Type Element : <TGML>
The root element of a TGML document is TGML. This element specifies that the
document type is TGML.
Table: TGML element attributes
Attribute Type Description
Background Brush The background color of the
document canvas (the
viewing area).
Default: "#FFFFFF"
Inheritable: No
Animatable: Yes
Height Double The height of the document.
Default: "600"
Inheritable: No
Animatable: No
Stretch Stretch Specifies how the document
shall be stretched initially
within a viewer.
Default: "None"
Inheritable: No
Animatable: No
Width Double The width of the document.
Default: "800"
Inheritable: No
Animatable: No
Remarks
The viewer uses the width, height, and stretch information to determine how the
document initially is streteched.
The viewer can display a document where information about width and height is
missing. When you view such a document no stretching is applied and any scroll
bars are disabled.
Stretch="None": Preserve the original size. This usually means that scroll bars are
enabled so the user can scroll to the right and the bottom of the document.
Stretch="Uniform": Resize the content, preserving the native aspect ratio. Scroll
bars are initially disabled.
Technical 04-16006-04-en, March 2015
1030
34 Graphics TGML Format Specification
34.10 TGML Document Type Element and Metadata
Stretch="Fill": The content is resized but aspect ratio is not preserved. Scroll
bars are initially disabled.
Metadata: <Metadata>
The Metadata element carries textual information about its parent element. It is up
to the TGML application to create and interpret the metadata.
Applying metadata to the outermost TGML element is the same as applying the
information to the TGML document.
Table: Metadata element attributes
Attribute Type Description
Name String A name that identifies the
information.
Inheritable: No
Animatabel: No
Value String The information.
Inheritable: No
Animatable: No
04-16006-04-en, March 2015 Technical
1031
34 Graphics TGML Format Specification
34.11 TGML User-Defined Descriptions of Custom Attributes
34.11 TGML User-Defined Descriptions of
Custom Attributes
In Graphics Editor, when an attribute is selected, a short description of the element
attribute is displayed in the properties pane.
Custom attributes have no description since the TGML implementation has no
knowledge of the attribute. However, it is possible to use Metadata to add a
description of a custom attribute:
Figure: TGML code containing a user-defined description of a custom attribute. When the
user selects MyAttribute in the Graphics Editor properties pane the desciption is
displayed.
The Name of the Metadata element has to be the same as the attribute name. Value
contains the description.
Technical 04-16006-04-en, March 2015
1032
34 Graphics TGML Format Specification
34.12 TGML Animations
34.12 TGML Animations
An animation is a time-based modification of an element attribute. The animation
defines a mapping of time to values for the target attribute.
The TGML implementation (Graphics Services) only runs animations in Dynamic
mode. The value of an attribute that has been animated (changed) in Dynamic
mode is not preserved in the TGML file. The animated value is only valid while
running in Dynamic mode.
34.12.1 Animation: <Animate>
Animate animates a specified attribute of the immediate parent element.
34.12.2 Sequences: <Sequence>
Sequence plays a sequence of graphical elements, for example, shapes, text,
images, as a 'movie'.
04-16006-04-en, March 2015 Technical
1033
34 Graphics TGML Format Specification
34.13 TGML Animation: <Animate>
34.13 TGML Animation: <Animate>
Animate animates a specified attribute of the immediate parent element.
Table: Animate element attributes
Attribute Type Description
Animation Animation Starts and stops the
animation in Dynamic mode.
Default: "Start"
Inheritable: No
Animatable: Yes
Attribute String The animated attribute of the
parent element.
Inheritable: No
Animatable: No
AutoReverse Bool Indicates whether the
timeline plays in reverse after
it completes a forward
iteration.
Default: "Reverse"
Inheritable: No
Animatable: Yes
CalcMode CalcMode Specifies how values are
interpolated.
Default: "Discrete"
Inheritable: No
Animatable: Yes
Duration Double Specifies the "simple
duration" of the animation
measured in seconds.
Inheritable: Yes
Animatable: No
Freeze Bool Specifies if the animated
attribute value is kept or not
when the animation ends
(end of "active duration" or
stopped by setting Animation
to Stop).
Default: "False"
Inheritable: No
Animatable: Yes
Technical 04-16006-04-en, March 2015
1034
34 Graphics TGML Format Specification
34.13 TGML Animation: <Animate>
Continued
Attribute Type Description
From String (untyped) The starting value of an
animation. The type is
determined by the
referenced Attribute.
Inheritable: Yes
Animatable: Yes
Repeat Repeat Describes the way the
animation is repeated.
Defautl: "Forever"
Inheritable: No
Animatable: Yes
To String (untyped) The ending value of the
animation. The type is
determined by the
referenced Attribute.
Inheritable. Yes
Animatable: Yes
Figure: Different CalcMode values
Figure: TGML code containing an Animate element that performs a blink
04-16006-04-en, March 2015 Technical
1035
34 Graphics TGML Format Specification
34.14 TGML Sequences: <Sequence>
34.14 TGML Sequences: <Sequence>
Sequence plays a sequence of graphical elements, for example, shapes, text,
images, as a 'movie'.
The Interval attribute controls the "frame rate". Interval specifies for how long,
measured in seconds, each graphical element is visible. The sequence can be
started and stopped by setting the Animation attribute to "Start" and "Stop".
Sequence belongs to the immediate parent container element and controls the
visibility of the container's graphical elements.
Table: Sequence element attributes
Attribute Type Description
Animation Animation Starts and stops the
animation in Dynamic mode.
Default: "Start"
Inheritable: No
Animatable: Yes
Interval Double Specifies for how long,
measured in seconds, each
of the shapes in the
container is to be visible.
Inheritable: Yes
Animatable: Yes
Figure: TGML code containing a Sequence element
The example plays a sequence of three rectangles and the frame rate is set to one
second. The Visibility attributes of the second and third rectangles are set to
"Hidden" to hide them in Edit mode.
Technical 04-16006-04-en, March 2015
1036
34 Graphics TGML Format Specification
34.15 TGML Attribute Exposure
34.15 TGML Attribute Exposure
In TGML, it is possible to indicate that an attribute is to be exposed by the TGML
editor in such a way that it is easy to find and set the attribute value.
The primary purpose is to be able to create a "Component interface" to the user. A
Component can be rather complex. The component developer can choose to
expose some of the attributes of the Component (or the contained elements) to, for
example, make it easy to change the appearance of the Component.
An Expose element is used to expose an attribute. The Name of the Expose
element is presented to the user instead of the original attribute name.
The Expose element has a Description attribute that can be used to add a
description of the exposed attribute. This description is presented to the user in the
TGML editor.
The attribute exposure is only handled by the TGML editor. TGML viewers ignores
the exposure.
34.15.1 Expose Element: <Expose>
Expose indicates that an attribute of the immediate parent element is to be exposed
by the TGML editor, using the Name of the Expose element instead of the original
attribute name.
04-16006-04-en, March 2015 Technical
1037
34 Graphics TGML Format Specification
34.16 TGML Expose Element: <Expose>
34.16 TGML Expose Element: <Expose>
Expose indicates that an attribute of the immediate parent element is to be exposed
by the TGML editor, using the Name of the Expose element instead of the original
attribute name.
Table: Expose element attributes
Attribute Type Description
ExposedAttribute String The exposed attribute of the
parent element
Inheritable: No
Animatable: No
Description String A user-defined description of
the exposed attribute
Inheritable: No
Animatable: No
Figure: TGML code containing Expose element including a user-defined description of the
exposed attribute
Technical 04-16006-04-en, March 2015
1038
34 Graphics TGML Format Specification
34.17 TGML Curves and Paths
34.17 TGML Curves and Paths
TGML contains a definition for curve and path elements.
34.17.1 Cubic Bezier Curve: <Curve>
Curve defines a cubic Bezier curve. The cubic Bezier curve has a start point, an end
point, and two control points. The control points act as magnets, pulling the curve
in certain directions to influence the way the Bezier curve bends.
34.17.2 Path Element: <Path>
Path represents the outline of a shape.
04-16006-04-en, March 2015 Technical
1039
34 Graphics TGML Format Specification
34.18 TGML Cubic Bezier Curve: <Curve>
34.18 TGML Cubic Bezier Curve: <Curve>
Curve defines a cubic Bezier curve. The cubic Bezier curve has a start point, an end
point, and two control points. The control points act as magnets, pulling the curve
in certain directions to influence the way the Bezier curve bends.
Figure: Bezier curve with control points
Curve supports polybezier, which is a consecutive set of Bezier points. The end
point of the preceding Bezier becomes the start point of the following Bezier.
Figure: Polybezier
Table: Cubic Bezier Curve element attributes
Attribute Type Description
Closed Bool Describes if the curve is
closed or not. That is, if
Points data end with "z" or
not.
Default: "False"
Inheritable: No
Animatable: No
Fill Brush Specifies how the interior of
the shape is painted.
Default: "None"
Inheritable: Yes
Animatable: Yes
Opacity Double A value between "0.0"
(transparent) and "1.0"
(opaque)
Default: "1.0"
Inheritable: No
Animatable: Yes
Technical 04-16006-04-en, March 2015
1040
34 Graphics TGML Format Specification
34.18 TGML Cubic Bezier Curve: <Curve>
Continued
Attribute Type Description
Points Array of Point The points: start point,
control points, and end point,
of the Bexier. Polybezier is
supported.
Inheritable: No
Animatable: No
Stroke Brush Describes how the line is
painted.
Default: "#000000"
Inheritable: Yes
Animatable: Yes
StrokeDashArray Array of Double The pattern of dashes and
gaps used to outline shapes:
"<dash> [ <gap> <dash>
<gap>...]"
If the array only specifies the
first dash, the line is
patterned as if a gap with the
same length as the dash was
specified.
An array with only one dash
set to "0" results in a line
without any pattern.
Default: "0"
Inheritable: Yes
Animatable: Yes
StrokeWidth Double The width of the outline of a
line.
Default: "1"
Inheritable: Yes
Animatable: Yes
Visibility Visibility Specifies if the element is
visible or not.
Default: "Visible"
Inheritable: No
Animatable: Yes
04-16006-04-en, March 2015 Technical
1041
34 Graphics TGML Format Specification
34.19 TGML Path Element: <Path>
34.19 TGML Path Element: <Path>
Path represents the outline of a shape.
The path is described by the PathData attribute, shich can contain moveto, line,
curve (both cubic and quadratic Beziers), arc,, and closepath instructions.
The path element is an implementation of the SVG path data specification. the
Scalable Vector Graphics (SVG) 1.1 Specification.
Table: Path element attributes
Attribute Type Description
Fill Brush Specifies how the interior of
the shape is painted.
Default: "None"
Inheritable: Yes
Animatable: Yes
Opacity Double A value between "0.0"
(transparent) and "1.0"
(opaque)
Default: "1.0"
Inheritable: No
Animatable: Yes
PathData String SVG path data.
Inheritable: No
Animatable: No
Stroke Brush Describes how the line is
painted.
Default: "#000000"
Inheritable: Yes
Animatable: Yes
StrokeDashArray Array of Double The pattern of dashes and
gaps used to outline shapes:
"<dash> [ <gap> <dash>
<gap>...]"
If the array only specifies the
first dash, the line is
patterned as if a gap with the
same length as the dash was
specified.
An array with only one dash
set to "0" results in a line
without any pattern.
Default: "0"
Inheritable: Yes
Animatable: Yes
Technical 04-16006-04-en, March 2015
1042
34 Graphics TGML Format Specification
34.19 TGML Path Element: <Path>
Continued
Attribute Type Description
StrokeWidth Double The width of the outline of a
line.
Default: "1"
Inheritable: Yes
Animatable: Yes
Visibility Visibility Specifies if the element is
visible or not.
Default: "Visible"
Inheritable: No
Animatable: Yes
Remarks
Some of the path commands can be converted or replaced when you import SVG
paths. For example, h, H (Horizontal lineto) and v, V (Vertical lineto) can be replaced
with l and L (lineto).
04-16006-04-en, March 2015 Technical
1043
34 Graphics TGML Format Specification
34.20 TGML Dynamics
34.20 TGML Dynamics
A dynamic graphic object is an object (TGML element) whose properties (TGML
attributes) are bound to, and controlled by, server variables (signals).
The TGML implementation (Graphics Services) only runs the dynamics engine in
Dynamic mode. That is, bound properties are not dynamically updated in Static
(edit) mode.
Server variables are connected to element attributes via Bind elements with
associated rule elements. A Bind element belongs to the immediate parent element
and specifies which attribute of the parent element that are going to be dynamically
updated (similar to animations). The rule elements belong to the immediate parent
Bind element and they specify how a signal value is going to be converted to a
TGML attribute value.
The rules are evaluated in sequence, in the same order as they are specified. A rule
is executed (and the specified attribute is set) only if the specified conditions are
fulfilled. If no matching rules are found, the bound attribute is left unaffected.
TGML supports different types of rule elements (ConvertValue, ConvertRange,
ConvertText, ConvertStatus, and so on). Different types of rules can be combined in
the same Bind element.
The Name attribute of the Bind element identifies the binding and is exposed to
bind tools as a binding point to which the server variable is connected.
Figure: Overview of how an attribute in a graphic is bound to a server object, which in turn
dynamically affects the graphic.
Bindings can be thought of as a "connection table" between the exposed Bind
elements and the server variables. The TGML implementation (Graphics Services)
only has knowledge about the Name of the Bind elements.
Subscriptions are set up using the names of the Bind elements. When the value of a
bound signal is updated, it will be experienced as if the binding point was updated
(the signal identity is "hidden" behind the binding point). It is up to the server, or the
communication proxy depending on the binding implementation, to resolve the
name.
A TGML document can contain multiple Bind elements with the same Name.
However, the TGML implementation is only going to expose the Name once to the
bind tool in WorkStation (unique binding point). This makes it possible to have
multiple presentations of a signal, using a single binding point.
Technical 04-16006-04-en, March 2015
1044
34 Graphics TGML Format Specification
34.20 TGML Dynamics
Figure: Multiple Bind elements with the same Name
34.20.1 Signal Binding: <Bind>
Bind enables a dynamic (server/device controlled) update of an attribute of the
immediate parent element.
34.20.2 Value Conversion: <ConvertValue>
ConvertValue specifies how a server variable (signal) value is to be converted to a
TGML element attribute value. A ConvertValue element belongs to the immediate
parent Bind element.
34.20.3 Text Value Conversion: <ConvertText>
ConvertText specifies how a server variable (signal) value is to be converted to a
TGML element attribute value. ConvertText assumes that the signal value is a text.
A ConvertText element belongs to the immediate parent Bind element.
34.20.4 Value Range Conversion: <ConvertRange>
ConvertRange specifies how a server variable (signal) value shall be converted to a
TGML element attribute value using min and max values. A ConvertRange element
belongs to the immediate parent Bind element.
34.20.5 Custom Conversion: <ConvertCustom>
ConvertCustom defines a custom conversion of a signal value. The ConvertCustom
element is a script element with a JavaScript function named 'convert'.
04-16006-04-en, March 2015 Technical
1045
34 Graphics TGML Format Specification
34.20 TGML Dynamics
34.20.6 Status Conversion: <ConvertStatus>
ConvertStatus specifies how the status of a server variable (signal) value is to be
converted to a TGML element attribute value. A ConvertStatus element belongs to
the immediate parent Bind element.
Technical 04-16006-04-en, March 2015
1046
34 Graphics TGML Format Specification
34.21 TGML Signal Binding: <Bind>
34.21 TGML Signal Binding: <Bind>
Bind enables a dynamic (server/device controlled) update of an attribute of the
immediate parent element.
The Name of the Bind element is exposed to the WorkStation bind tool as a binding
point.
The Bind element has a Description attribute that can be used to add a description
of the binding. The Description can be exposed together with the Name and
presented to the user in the bind tool.
Bind makes the parent element an "interactive" element. The TGML viewer is
supposed to respond, for example, show a "change value" dialog box, when the
user clicks the element.
Table: Bind element attributes
Attribute Type Description
Attribute String The bound attribute of the
parent element.
Inheritable: No
Animatable: No
Description String A user-defined description of
the binding.
Inheritable: No
Animatable: No
Format Format Specifies the formating of the
subscibed data.
Default: "None"
Inheritable: No
Animatable: No
PreventDefault Bool Cancels the defautl action
normally taken by the
implementation, for example,
the viewer.
Default: "False"
Inheritable: Yes
Animatable: No
DynamicUpdates DynamicUpdates Specifies if the Bind should
be enabled or disabled.
Default: "Enabled"
Inheritable: Yes
Animatable: No
Remarks
Format is an instruction to the server how the subscribed value is to be formated.
04-16006-04-en, March 2015 Technical
1047
34 Graphics TGML Format Specification
34.21 TGML Signal Binding: <Bind>
"None" means "deliver the data as is". The data type is preserved (integer, float,
boolean, string, and so on ). You typically use conversion elements to convert the
server variable value to a TGML element attribute value.
"Presentation" is an instruction to the server: Deliver the text representation of the
variable value, if any (for example, On/Off instead of 0/1). "Presentation" is typically
used when the data i to be presented by a Text element without any value
conversions.
The “default action” when a user clicks an element containing a Bind element, is
usually to open an “edit value” dialog. This action is canceled when PreventDefault
is set to 'True'.
PreventDefault is typically set to 'True' in components that mimics interactive
controls such as check boxes and spin buttons. In such components, the value is
set in a JavaScript using the setValue function.
Figure: TGML code contianing a Bind element that dynamically presents a text
Figure: This TGML code example shows Bind that will be enabled/disabled on the
OnMouseOver event.
Technical 04-16006-04-en, March 2015
1048
34 Graphics TGML Format Specification
34.22 TGML Value Conversion: <ConvertValue>
34.22 TGML Value Conversion:
<ConvertValue>
ConvertValue specifies how a server variable (signal) value is to be converted to a
TGML element attribute value. A ConvertValue element belongs to the immediate
parent Bind element.
A ConvertValue rule is only executed when each of the specified conditions are
fulfilled.
Figure: TGML code containing a ConvertValue element where the attribute is set to
#00FF00 (green) when the signal value is more than 18 and less than or equal to 22
Figure: A rule can never be fulfilled (and thus, never executed) if the signal value is both
equal to 0 and more than 10
Table: ConvertValue element attributes
Attribute Type Description
AttributeValue String (untyped) The attribute value that is to
be set (resulting value). The
type is determined by the
bound Attribute (referenced
by the Bind element).
Inheritable: No
Animatable: No
SignalEqualTo String (untyped) Corresponds to "="
Inheritable: No
Animatable: No
SignalMoreThan String (untyped) Corresponds to ">"
Inheritable: No
Animatable: No
SignalMoreOrEqualTo String (untyped) Corresponds to ">="
Inheritable: No
Animatable: No
SignalLessThan String (untyped) Corresponds to "<"
Inheritable: No
Animatable: No
SignalLessOrEqualTo String (untyped) Corresponds to "<="
Inheritable: No
Animatable: No
04-16006-04-en, March 2015 Technical
1049
34 Graphics TGML Format Specification
34.22 TGML Value Conversion: <ConvertValue>
Attribute Type Description
Figure: TGML code containing ConvertValue element
Figure: ConvertValue element on screen
Figure: TGML code containing ConvertValue element
Figure: ConvertValue element on screen
Technical 04-16006-04-en, March 2015
1050
34 Graphics TGML Format Specification
34.23 TGML Text Value Conversion: <ConvertText>
34.23 TGML Text Value Conversion:
<ConvertText>
ConvertText specifies how a server variable (signal) value is to be converted to a
TGML element attribute value. ConvertText assumes that the signal value is a text.
A ConvertText element belongs to the immediate parent Bind element.
A ConvertText rule is executed when the signal value matches the specified text
(SignalEqualTo).
Table: ConvertText element attributes
Attribute Type Description
AttributeValue String (untyped) The attribute value that is to
be set (resulting value). The
type is determined by the
bound Attribute (referenced
by the Bind element).
Inheritable: No
Animatable: No
SignalEqualTo String Corresponds to "="
Inheritable: No
Animatable: No
04-16006-04-en, March 2015 Technical
1051
34 Graphics TGML Format Specification
34.24 TGML Value Range Conversion: <ConvertRange>
34.24 TGML Value Range Conversion:
<ConvertRange>
ConvertRange specifies how a server variable (signal) value shall be converted to a
TGML element attribute value using min and max values. A ConvertRange element
belongs to the immediate parent Bind element.
A ConvertRange rule is executed when the signal value is within the specified range.
Table: ConvertRange element attributes
Attribute Type Description
AttributeMax Value String (untyped) The upper bound of the
attribute value. The
referenced attribute
(referenced by the Bind
element) will be set to this
value when the signal value is
more than or equal to
SignalMaxValue.
Inheritable: No
Animatable: No
AttributeMin Value String (untyped) The lower bound of the
attribute value. The
referenced attribute
(referenced by the Bind
element) will be set to this
value when the signal value is
less than or equal to
SignalMinValue.
Inheritable: No
Animatable: No
SignalMax Value String (untyped) The upper bound of the
signal value.
Inheritable: No
Animatable: No
SignalMin Value String (untyped) The lower bound of the
signal value.
Inheritable: No
Animatable: No
Figure: TGML code containing a ConvertRange element that calculates an attribute value
Technical 04-16006-04-en, March 2015
1052
34 Graphics TGML Format Specification
34.24 TGML Value Range Conversion: <ConvertRange>
Figure: ConvertRange element on screen
04-16006-04-en, March 2015 Technical
1053
34 Graphics TGML Format Specification
34.25 TGML Custom Conversion: <ConvertCustom>
34.25 TGML Custom Conversion:
<ConvertCustom>
ConvertCustom defines a custom conversion of a signal value. The ConvertCustom
element is a script element with a JavaScript function named 'convert'.
Figure: JavaScript convert function
The function takes one parameter which is the signal value and returns a converted
value.
The user can insert any valid JavaScript code in the function body to accomplish a
value conversion
Figure: TGML code containing a ConvertCustom element.
Technical 04-16006-04-en, March 2015
1054
34 Graphics TGML Format Specification
34.26 TGML Status Conversion: <ConvertStatus>
34.26 TGML Status Conversion:
<ConvertStatus>
ConvertStatus specifies how the status of a server variable (signal) value is to be
converted to a TGML element attribute value. A ConvertStatus element belongs to
the immediate parent Bind element.
ConvertStatus is executed when the status of the value is different from “normal”,
which means when the status value is 0, 1 or 3.
ConvertStatus can be combined with other converters (for example, ConvertValue
and ConvertRange) but the converters are executed in the same order as they are
specified. The ConvertStatus should be placed last if it is combined with other
converters.
Table: ConvertStatus element attributes
Attribute Type Description
Error String (untyped) The attribute value that is to
be set when the status is 0
(Error). The type is
determined by the bound
Attribute (referenced by the
Bind element).
Inheritable: No
Animatable: No
Stored String (untyped) The attribute value that is to
be set when the status is 1
(Stored value). The type is
determined by the bound
Attribute (referenced by the
Bind element).
Inheritable: No
Animatable: No
Forced String (untyped) The attribute value that is to
be set when the status is 3
(Forced value). The type is
determined by the bound
Attribute (referenced by the
Bind element).
Inheritable: No
Animatable: No
04-16006-04-en, March 2015 Technical
1055
34 Graphics TGML Format Specification
34.27 TGML Basic Shapes
34.27 TGML Basic Shapes
The TGML specification contains a number of basic shapes.
34.27.1 Shape Attributes
The following table describes the common attributes of the basic shapes.
Attribute Type Description
Fill Brush Specifies how the interior of
the shape is painted.
Default: "None"
Inheritable: Yes
Animatable: Yes
Opacity Double A value between "0.0"
(transparent) and "1.0"
(opaque)
Default: "1.0"
Inheritable: No
Animatable: Yes
Stroke Brush Describes how the line is
painted.
Default: "#000000"
Inheritable: Yes
Animatable: Yes
StrokeDashArray Array of Double The pattern of dashes and
gaps used to outline shapes:
"<dash> [ <gap> <dash>
<gap>...]"
If the array only specifies the
first dash, the line is
patterned as if a gap with the
same length as the dash was
specified.
An array with only one dash
set to "0" will result in a line
without any pattern.
Default: "0"
Inheritable: Yes
Animatable: Yes
Technical 04-16006-04-en, March 2015
1056
34 Graphics TGML Format Specification
34.27 TGML Basic Shapes
Continued
Attribute Type Description
StrokeWidth Double The width of the outline of a
line.
Default: "1"
Inheritable: Yes
Animatable: Yes
Visibility Visibility Specifies if the element is
visible or not.
Default: "Visible"
Inheritable: No
Animatable: Yes
34.27.2 Line: <Line>
The Line element describes a straight line between two points.
34.27.3 Polyline: <Polyline>
The Polyline element describes a series of connected straight lines.
34.27.4 Polygon: <Polygon>
The Polygon element describes a polygon, which is a connected series of lines that
forms a closed shape. The end point does not have to be specified. The polygon is
closed automatically.
34.27.5 Rectangle: <Rectangle>
The Rectangle element defines a rectangle. Rounded rectangles can be achived by
setting values for the attributes RadiusX and RadiusY.
34.27.6 Ellipse: <Ellipse>
The Ellipse element defines an ellipse.
04-16006-04-en, March 2015 Technical
1057
34 Graphics TGML Format Specification
34.28 TGML Line: <Line>
34.28 TGML Line: <Line>
The Line element describes a straight line between two points.
Table: Line element attributes
Attribute Type Description
Opacity Double A value between "0.0"
(transparent) and "1.0"
(opaque)
Default: "1.0"
Inheritable: No
Animatable: Yes
Stroke Brush Describes how the line is
painted.
Default: "#000000"
Inheritable: Yes
Animatable: Yes
StrokeDashArray Array of Double The pattern of dashes and
gaps used to outline shapes:
"<dash> [ <gap> <dash>
<gap>...]"
If the array only specifies the
first dash, the line is
patterned as if a gap with the
same length as the dash was
specified.
An array with only one dash
set to "0" results in a line
without any pattern.
Default: "0"
Inheritable: Yes
Animatable: Yes
StrokeWidth Double The width of the outline of a
line.
Default: "1"
Inheritable: Yes
Animatable: Yes
Visibility Visibility Specifies if the element is
visible or not.
Default: "Visible"
Inheritable: No
Animatable: Yes
Technical 04-16006-04-en, March 2015
1058
34 Graphics TGML Format Specification
34.28 TGML Line: <Line>
Continued
Attribute Type Description
X1 Double The x coordinate of the line
start point.
Default: "0"
Inheritable: No
Animatable: Yes
X2 Double The x coordinate of the line
end point.
Default: "0"
Inheritable: No
Animatable: Yes
Y1 Double The y coordinate of the line
start point.
Default: "0"
Inheritable: No
Animatable: Yes
Y2 Double The y coordinate of the line
end point.
Default: "0"
Inheritable: No
Animatable: Yes
Figure: TGML code containing a Line element
Figure: Line element on screen
04-16006-04-en, March 2015 Technical
1059
34 Graphics TGML Format Specification
34.29 TGML Polyline: <Polyline>
34.29 TGML Polyline: <Polyline>
The Polyline element describes a series of connected straight lines.
Table: Polyline element attributes
Attribute Type Description
Fill Brush Specifies how the interior of
the shape is painted.
Default: "None"
Inheritable: Yes
Animatable: Yes
Opacity Double A value between "0.0"
(transparent) and "1.0"
(opaque)
Default: "1.0"
Inheritable: No
Animatable: Yes
Points Array of Point The vertex points of the
polyline:
"<x1>,<y1> <x2>,<y2>..."
Inheritable: No
Animatable: No
Stroke Brush Describes how the line is
painted.
Default: "#000000"
Inheritable: Yes
Animatable: Yes
StrokeDashArray Array of Double The pattern of dashes and
gaps used to outline shapes:
"<dash> [ <gap> <dash>
<gap>...]"
If the array only specifies the
first dash, the line is
patterned as if a gap with the
same length as the dash was
specified.
An array with only one dash
set to "0" results in a line
without any pattern.
Default: "0"
Inheritable: Yes
Animatable: Yes
Technical 04-16006-04-en, March 2015
1060
34 Graphics TGML Format Specification
34.29 TGML Polyline: <Polyline>
Continued
Attribute Type Description
StrokeWidth Double The width of the outline of a
line.
Default: "1"
Inheritable: Yes
Animatable: Yes
Visibility Visibility Specifies if the element is
visible or not.
Default: "Visible"
Inheritable: No
Animatable: Yes
Figure: TGML code containing a Polyline element
Figure: Polyline element on screen.
04-16006-04-en, March 2015 Technical
1061
34 Graphics TGML Format Specification
34.30 TGML Polygon: <Polygon>
34.30 TGML Polygon: <Polygon>
The Polygon element describes a polygon, which is a connected series of lines that
forms a closed shape. The end point does not have to be specified. The polygon is
closed automatically.
Table: Polygon element attributes
Attribute Type Description
Fill Brush Specifies how the interior of
the shape is painted.
Default: "None"
Inheritable: Yes
Animatable: Yes
Opacity Double A value between "0.0"
(transparent) and "1.0"
(opaque)
Default: "1.0"
Inheritable: No
Animatable: Yes
Points Array of Point The vertex points of the
polygon:
"<x1>,<y1> <x2>,<y2>..."
Inheritable: No
Animatable: No
Stroke Brush Describes how the line is
painted.
Default: "#000000"
Inheritable: Yes
Animatable: Yes
StrokeDashArray Array of Double The pattern of dashes and
gaps used to outline shapes:
"<dash> [ <gap> <dash>
<gap>...]"
If the array only specifies the
first dash, the line is
patterned as if a gap with the
same length as the dash was
specified.
An array with only one dash
set to "0" results in a line
without any pattern.
Default: "0"
Inheritable: Yes
Animatable: Yes
Technical 04-16006-04-en, March 2015
1062
34 Graphics TGML Format Specification
34.30 TGML Polygon: <Polygon>
Continued
Attribute Type Description
StrokeWidth Double The width of the outline of a
line.
Default: "1"
Inheritable: Yes
Animatable: Yes
Visibility Visibility Specifies if the element is
visible or not.
Default: "Visible"
Inheritable: No
Animatable: Yes
Figure: TGML code containing a Polygon element
Figure: Polygon element on screen
04-16006-04-en, March 2015 Technical
1063
34 Graphics TGML Format Specification
34.31 TGML Rectangle: <Rectangle>
34.31 TGML Rectangle: <Rectangle>
The Rectangle element defines a rectangle. Rounded rectangles can be achived by
setting values for the attributes RadiusX and RadiusY.
Table: Rectangle element attributes
Attribute Type Description
Fill Brush Specifies how the interior of
the shape is painted.
Default: "None"
Inheritable: Yes
Animatable: Yes
Height Double The height of the rectangle.
Inheritable: No
Animatable: Yes
Left Double The x coordinate of the
upper left corner of the
rectangel.
Default: "0"
Inheritable: No
Animatable: Yes
Opacity Double A value between "0.0"
(transparent) and "1.0"
(opaque)
Default: "1.0"
Inheritable: No
Animatable: Yes
RadiusX Double For rounded rectangles. The
x axis radius of the ellipse
used to round off the corners
of the rectangle.
Default: "0"
Inheritable: No
Animatable: Yes
RadiusY Double For rounded rectangles. The
y axis radius of the ellipse
used to round off the corners
of the rectangle.
Default: "0"
Inheritable: No
Animatable: Yes
Technical 04-16006-04-en, March 2015
1064
34 Graphics TGML Format Specification
34.31 TGML Rectangle: <Rectangle>
Continued
Attribute Type Description
Stroke Brush Describes how the line is
painted.
Default: "#000000"
Inheritable: Yes
Animatable: Yes
StrokeDashArray Array of Double The pattern of dashes and
gaps used to outline shapes:
"<dash> [ <gap> <dash>
<gap>...]"
If the array only specifies the
first dash, the line is
patterned as if a gap with the
same length as the dash was
specified.
An array with only one dash
set to "0" results in a line
without any pattern.
Default: "0"
Inheritable: Yes
Animatable: Yes
StrokeWidth Double The width of the outline of a
line.
Default: "1"
Inheritable: Yes
Animatable: Yes
Top Double The y coordinate of the
rectangles upper left corner.
Default: "0"
Inheritable: No
Animatable: Yes
Visibility Visibility Specifies if the element is
visible or not.
Default: "Visible"
Inheritable: No
Animatable: Yes
Width Double The width of the rectangle.
Inheritable: No
Animatable: Yes
04-16006-04-en, March 2015 Technical
1065
34 Graphics TGML Format Specification
34.31 TGML Rectangle: <Rectangle>
Attribute Type Description
Figure: TGML code containing a Rectangle element
Figure: Rectangle element on screen
Technical 04-16006-04-en, March 2015
1066
34 Graphics TGML Format Specification
34.32 TGML Ellipse: <Ellipse>
34.32 TGML Ellipse: <Ellipse>
The Ellipse element defines an ellipse.
Table: Ellipse element attributes
Attribute Type Description
Fill Brush Specifies how the interior of
the shape is painted.
Default: "None"
Inheritable: Yes
Animatable: Yes
Height Double The height of the ellipse.
Inheritable: No
Animatable: Yes
Left Double The x coordinate of the
upper left corner of the
ellipse.
Default: "0"
Inheritable: No
Animatable: Yes
Opacity Double A value between "0.0"
(transparent) and "1.0"
(opaque)
Default: "1.0"
Inheritable: No
Animatable: Yes
Stroke Brush Describes how the line is
painted.
Default: "#000000"
Inheritable: Yes
Animatable: Yes
04-16006-04-en, March 2015 Technical
1067
34 Graphics TGML Format Specification
34.32 TGML Ellipse: <Ellipse>
Continued
Attribute Type Description
StrokeDashArray Array of Double The pattern of dashes and
gaps used to outline shapes:
"<dash> [ <gap> <dash>
<gap>...]"
If the array only specifies the
first dash, the line is
patterned as if a gap with the
same length as the dash was
specified.
An array with only one dash
set to "0" results in a line
without any pattern.
Default: "0"
Inheritable: Yes
Animatable: Yes
StrokeWidth Double The width of the outline of a
line.
Default: "1"
Inheritable: Yes
Animatable: Yes
Top Double The y coordinate of the
upper left corner of the
ellipse.
Visibility Visibility Specifies if the element is
visible or not.
Default: "Visible"
Inheritable: No
Animatable: Yes
Width Double The width of the ellipse.
Inheritable: No
Animatable: Yes
Figure: TGML code containing an Ellipse element
Technical 04-16006-04-en, March 2015
1068
34 Graphics TGML Format Specification
34.32 TGML Ellipse: <Ellipse>
Figure: Ellipse element on screen
04-16006-04-en, March 2015 Technical
1069
34 Graphics TGML Format Specification
34.33 TGML Segment Shapes
34.33 TGML Segment Shapes
The TGML specification defines a number of shapes that are segments of an ellipse.
34.33.1 Elliptical Arc: <Arc>
Arc defines an elliptical arc. The elliptical arc is part of an ellipse.
34.33.2 Elliptical Pie: <Pie>
Pie defines an elliptical pie slice. Pie is similar to Arc.
34.33.3 Elliptical Chord: <Chord>
Chord defines an elliptical chord. Chord is similar to Pie and Arc.
Technical 04-16006-04-en, March 2015
1070
34 Graphics TGML Format Specification
34.34 TGML Elliptical Arc: <Arc>
34.34 TGML Elliptical Arc: <Arc>
Arc defines an elliptical arc. The elliptical arc is part of an ellipse.
Figure: Elliptical Arc
Table: Arc element attributes
Attribute Type Description
Center Point The center point of the
ellipse.
Default: "0.0 , 0.0"
Inheritable: No
Animatable: Yes
Fill Brush Specifies how the interior of
the shape is painted.
Default: "None"
Inheritable: Yes
Animatable: Yes
Opacity Double A value between "0.0"
(transparent) and "1.0"
(opaque)
Default: "1.0"
Inheritable: No
Animatable: Yes
RadiusX Double The horizontal radius of the
ellipse.
Inheritable: No
Animatable: Yes
RadiusY Double The vertical radius of the
ellipse.
Inheritable: No
Animatable: Yes
04-16006-04-en, March 2015 Technical
1071
34 Graphics TGML Format Specification
34.34 TGML Elliptical Arc: <Arc>
Continued
Attribute Type Description
StartAngle Double Specifies the angle between
the x axis and the starting
point of the arc.
Default: "0.0"
Inheritable: No
Animatable: Yes
SweepAngle Double Specifies the angle between
the starting and ending
points of the arc.
Default: "0.0"
Inheritable: No
Animatable: Yes
Stroke Brush Describes how the line is
painted.
Default: "#000000"
Inheritable: Yes
Animatable: Yes
StrokeDashArray Array of Double The pattern of dashes and
gaps used to outline shapes:
"<dash> [ <gap> <dash>
<gap>...]"
If the array only specifies the
first dash, the line is
patterned as if a gap with the
same length as the dash was
specified.
An array with only one dash
set to "0" results in a line
without any pattern.
Default: "0"
Inheritable: Yes
Animatable: Yes
StrokeWidth Double The width of the outline of a
line.
Default: "1"
Inheritable: Yes
Animatable: Yes
Visibility Visibility Specifies if the element is
visible or not.
Default: "Visible"
Inheritable: No
Animatable: Yes
Technical 04-16006-04-en, March 2015
1072
34 Graphics TGML Format Specification
34.35 TGML Elliptical Pie: <Pie>
34.35 TGML Elliptical Pie: <Pie>
Pie defines an elliptical pie slice. Pie is similar to Arc.
Figure: Elliptical Pie
Table: Pie element attributes
Attribute Type Description
Center Point The center point of the
ellipse.
Default: "0.0 , 0.0"
Inheritable: No
Animatable: Yes
Fill Brush Specifies how the interior of
the shape is painted.
Default: "None"
Inheritable: Yes
Animatable: Yes
Opacity Double A value between "0.0"
(transparent) and "1.0"
(opaque)
Default: "1.0"
Inheritable: No
Animatable: Yes
RadiusX Double The horizontal radius of the
ellipse.
Inheritable: No
Animatable: Yes
RadiusY Doubel The vertical radius of the
ellipse.
Inheritable: No
Animatable: Yes
04-16006-04-en, March 2015 Technical
1073
34 Graphics TGML Format Specification
34.35 TGML Elliptical Pie: <Pie>
Continued
Attribute Type Description
StartAngle Double Specifies the angle between
the x axis and the starting
point of the arc.
Default: "0.0"
Inheritable: No
Animatable: Yes
SweepAngle Double Specifies the angle between
the starting and ending
points of the arc.
Default: "0.0"
Inheritable: No
Animatable: Yes
Stroke Brush Describes how the line is
painted.
Default: "#000000"
Inheritable: Yes
Animatable: Yes
StrokeDashArray Array of Double The pattern of dashes and
gaps used to outline shapes:
"<dash> [ <gap> <dash>
<gap>...]"
If the array only specifies the
first dash, the line is
patterned as if a gap with the
same length as the dash was
specified.
An array with only one dash
set to "0" results in a line
without any pattern.
Default: "0"
Inheritable: Yes
Animatable: Yes
StrokeWidth Double The width of the outline of a
line.
Default: "1"
Inheritable: Yes
Animatable: Yes
Visibility Visibility Specifies if the element is
visible or not.
Default: "Visible"
Inheritable: No
Animatable: Yes
Technical 04-16006-04-en, March 2015
1074
34 Graphics TGML Format Specification
34.36 TGML Elliptical Chord: <Chord>
34.36 TGML Elliptical Chord: <Chord>
Chord defines an elliptical chord. Chord is similar to Pie and Arc.
Figure: Elliptical Chord
Table: Chord element attributes
Attribute Type Description
Center Point The center point of the
ellipse.
Default: "0.0 , 0.0"
Inheritable: No
Animatable: Yes
Fill Brush Specifies how the interior of
the shape is painted.
Default: "None"
Inheritable: Yes
Animatable: Yes
Opacity Double A value between "0.0"
(transparent) and "1.0"
(opaque)
Default: "1.0"
Inheritable: No
Animatable: Yes
RadiusX Double The horizontal radius of the
ellipse.
Inheritable: No
Animatable: Yes
RadiusY Double The vertical radius of the
ellipse.
Inheritable: No
Animatable: Yes
04-16006-04-en, March 2015 Technical
1075
34 Graphics TGML Format Specification
34.36 TGML Elliptical Chord: <Chord>
Continued
Attribute Type Description
StartAngle Double Specifies the angle between
the x axis and the starting
point of the arc.
Default: "0.0"
Inheritable: No
Animatable: Yes
SweepAngle Double Specifies the angle between
the starting and ending
points of the arc.
Default: "0.0"
Inheritable: No
Animatable: Yes
Stroke Brush Describes how the line is
painted.
Default: "#000000"
Inheritable: Yes
Animatable: Yes
StrokeDashArray Array of Double The pattern of dashes and
gaps used to outline shapes:
"<dash> [ <gap> <dash>
<gap>...]"
If the array only specifies the
first dash, the line is
patterned as if a gap with the
same length as the dash was
specified.
An array with only one dash
set to "0" results in a line
without any pattern.
Default: "0"
Inheritable: Yes
Animatable: Yes
StrokeWidth Double The width of the outline of a
line.
Default: "1"
Inheritable: Yes
Animatable: Yes
Visibility Visibility Specifies if the element is
visible or not.
Default: "Visible"
Inheritable: No
Animatable: Yes
Technical 04-16006-04-en, March 2015
1076
34 Graphics TGML Format Specification
34.37 TGML Gradients
34.37 TGML Gradients
Gradients consist of continuously smooth color transitions along a vector from one
color to another. TGML provides for two types of gradients, linear gradients and
radial gradients.
34.37.1 Linear Gradient: <LinearGradient>
The LinearGradient creates a linear gradient brush for the stroke or fill area of the
immediate parent.
34.37.2 Radial Gradient: <RadialGradient>
RadialGradient defines a radial gradient brush for the stroke or fill area of the
immediate parent.
34.37.3 Gradient Stop: <GradientStop>
The GradientStop describes the location and color of a transition point in a gradient.
GradientStop belongs to its immediate parent gradient element.
04-16006-04-en, March 2015 Technical
1077
34 Graphics TGML Format Specification
34.38 TGML Linear Gradient: <LinearGradient>
34.38 TGML Linear Gradient: <LinearGradient>
The LinearGradient creates a linear gradient brush for the stroke or fill area of the
immediate parent.
LinearGradient works in conjunction with gradient stops (see 19.3 Gradient stop),
which describe the location and color of transition points in gradients.
Table: LinearGradient element attributes
Attribute Type Description
Attribute String The brush attribute of the
parent ("Fill" or "Stroke")
Inheritable: No
Animatable: No
EndPoint Point The ending coordinates of
the linear gradient
Default: "1.0 , 0.0"
Inheritable: Yes
Animatable: Yes
SpreadMethod SpreadMethod Specifies how the gradient
should be drawn outside of
the specified gradient vector
or space
Default: "Pad"
Inheritable: Yes
Animatable: Yes
StartPoint Point The starting coordinates of
the linear gradient
Default: "0.0 , 0.0"
Inheritable: Yes
Animatable: Yes
Remarks
StartPoint and EndPoint specify the starting and ending coordinates of the linear
gradient. "0.0 , 0.0" represents the upper left corner of the element and "1.0 , 1.0"
represents the lower right corner.
Technical 04-16006-04-en, March 2015
1078
34 Graphics TGML Format Specification
34.38 TGML Linear Gradient: <LinearGradient>
Figure: StartPoint set to "0.0 , 0.0" and EndPoint set to "1.0 , 1.0
Figure: Different SpreadMethod values
04-16006-04-en, March 2015 Technical
1079
34 Graphics TGML Format Specification
34.39 TGML Radial Gradient: <RadialGradient>
34.39 TGML Radial Gradient: <RadialGradient>
RadialGradient defines a radial gradient brush for the stroke or fill area of the
immediate parent.
RadialGradient works in conjunction with gradient stops, which describe the
location and color of transition points in gradients.
Table: RadialGradient element attributes
Attribute Type Description
Attribute String The brush attribute of the
parent ("Fill" or "Stroke")
Inheritable: No
Animatable: No
Center Point The center of the circle of the
radial gradient
Default:"0.5 , 0.5"
Inheritable: Yes
Animatable: Yes
Focus Point The location of the focal
point that defines the
beginning of the gradient
Default:"0.5 , 0.5"
Inheritable: Yes
Animatable: Yes
RadiusX Double The horizontal radius of the
circle of the radial gradient
Default:"0.5"
Inheritable: Yes
Animatable: Yes
RadiusY Double The vertical radius of the
circle of a radial gradient
Default:"0.5"
Inheritable: Yes
Animatable: Yes
SpreadMethod SpreadMethod Specifies how the gradient
should be drawn outside of
the specified gradient vector
or space
Default: "Pad"
Inheritable: Yes
Animatable: Yes
Technical 04-16006-04-en, March 2015
1080
34 Graphics TGML Format Specification
34.39 TGML Radial Gradient: <RadialGradient>
Attribute Type Description
Remarks
The RadialGradient element is similar in programming model to the LinearGradient
element. To define the gradient behavior, the RadialGradient element has a circle
along with a focal point instead of start and end points. The focal point defines the
beginning of the gradient and the circle defines the end point of the gradient. Radial
gradient only supports the spread method Pad in TGML version 1.0.
Figure: RadialGradient element
04-16006-04-en, March 2015 Technical
1081
34 Graphics TGML Format Specification
34.40 TGML Gradient Stop: <GradientStop>
34.40 TGML Gradient Stop: <GradientStop>
The GradientStop describes the location and color of a transition point in a gradient.
GradientStop belongs to its immediate parent gradient element.
Table: GradientStop element attributes
Attribute Type Description
Color Color The color of the gradient
stop
Inheritable: Yes
Animatable: yes
Offset Double The location of the gradient
stop within the gradient
Inheritable: Yes
Animatable: Yes
Figure: The relations between the StartPoint/EndPoint of the LinearGradient element and
the Color/Offset of the GradientStop element
Figure: TGML code containing LinearGradient with GradientStop elements
Technical 04-16006-04-en, March 2015
1082
34 Graphics TGML Format Specification
34.40 TGML Gradient Stop: <GradientStop>
Figure: LinearGradient with GradientStop elements on screen
Figure: TGML code containing RadialGradient with GradientStop elements
Figure: RadialGradient with GradientStop elements on screen
04-16006-04-en, March 2015 Technical
1083
34 Graphics TGML Format Specification
34.41 TGML Grouping Elements
34.41 TGML Grouping Elements
With TGML there are several ways to collect elements in a common container
element.
34.41.1 Grouping: <Group>
The Group element is a container element, used for grouping elements together so
they can, for example, be moved, copied and resized as if they were a single
element.
34.41.2 Components: <Component>
The Components element is a container element (similar to Group) which defines a
reusable group of elements.
34.41.3 Layers: <Layer>
The Layer element is a container element used to create layered TGML graphics.
Technical 04-16006-04-en, March 2015
1084
34 Graphics TGML Format Specification
34.42 TGML Grouping: <Group>
34.42 TGML Grouping: <Group>
The Group element is a container element, used for grouping elements together so
they can, for example, be moved, copied and resized as if they were a single
element.
Table: Group element attributes
Attribute Type Description
Opacity Double A value between 0.0
(transparent) and 1.0
(opaque).
Default: "1.0"
Inheritable: No
Animatable: Yes
Visibility Visibility Specifies if the element shall
be visible or not.
Default: "Visible"
Inheritable: No
Animatable: Yes
Figure: TGML code containing a group element
04-16006-04-en, March 2015 Technical
1085
34 Graphics TGML Format Specification
34.43 TGML Components: <Component>
34.43 TGML Components: <Component>
The Components element is a container element (similar to Group) which defines a
reusable group of elements.
Top and Left of Component specifies the position of the component in the parent
coordinate system. Component itself establishes a new coordinate system for the
contained elements, which means that the upper left corner of Component is the
origin (0,0) for the contained elements.
Width and Height specifies the "viewport" (size on screen) of the component.
ContentWidth and ContentHeight specify the "viewbox", which is the boundary of
the contained elements. If the viewport is different from the viewbox, a scale
transformation is applied by the TGML implementation (similar to Stretch="Fill", see
7.1 Document type element). In other words, resizing a Component has the effect
of scaling the content of the Component.
The Clip attribute specifies if the renderer shall clip elements that exceed (are drawn
outside) the specified viewbox or not.
When a Component includes Bind or Link elements, the Name of Component will
prefix the exposed bind names ("MyComponent.MyBind").
Table: Component element attributes
Attribute Type Description
Clip Bool Specifies if the content shall
be clipped or not.
Default: "True"
Inheritable: No
Animatable: No
ContentHeight Double Specifies the viewbox height
(height of the content).
Inheritable: No
Animatable: No
ContentWidth Double Specifies the viewbox width
(width of the content).
Inheritable: No
Animatable: No
Height Double The viewport height of the
component (height on
screen).
Inheritable: No
Animatable: Yes
Left Double The x coordinate of the
component's upper left
corner.
Default: "0"
Inheritable: No
Animatable: Yes
Technical 04-16006-04-en, March 2015
1086
34 Graphics TGML Format Specification
34.43 TGML Components: <Component>
Continued
Attribute Type Description
Opacity Double A value between 0.0
(transparen) and 1.0
(opaque).
Default: "1.0"
Inheritable: No
Animatable: Yes
Top Double The y coordinate of the
components upper left
corner.
Default: "0"
Inheritable: No
Animatable: Yes
Visibility Visibility Specifies if the element shall
be visible or not.
Default: "Visible"
Inheritable: No
Animatable: Yes
Width Double The viewport width of the
component (width on
screen).
Inheritable: No
Animatable: Yes
Figure: TGML code containing a component element
Figure: TGML component element on screen
04-16006-04-en, March 2015 Technical
1087
34 Graphics TGML Format Specification
34.44 TGML Layers: <Layer>
34.44 TGML Layers: <Layer>
The Layer element is a container element used to create layered TGML graphics.
Only the TGML root element can contain Layer elements, which means that nested
layers are not supported.
Layer elements cannot be transformed. Child transformation elements will have no
effect on the Layer element.
Table: Layer element attributes
Attribute Type Description
Opacity Double A value between 0.0
(transparent) and 1.0
(opaque).
Default: "0"
Inheritable: No
Animatable: Yes
Visibility Visbility Specifies if the element is
visible or not.
Default: "Visibile"
Inheritable: No
Animatable: Yes
Figure: TGML code containing two layer elements
Technical 04-16006-04-en, March 2015
1088
34 Graphics TGML Format Specification
34.45 TGML Link element: <Link>
34.45 TGML Link element: <Link>
Link represents a hyperlink to another presentation stored in the database, or file
system, of the connected server. Examples of presentation objects are: TGML
graphics files, trend log views and on-line plots.
Figure: Example of a text made into a link object
Link indicates that the immediate parent shape or container element is a hyperlink
object, which the user can click to navigate to another presentation.
A Link is bound to a presentation object on the server with the same technique
used for Dynamics. The Name attribute of the Link element is exposed as a
connection point to which the presentation object is connected in WorkStation. For
more information, see section 34.20 “TGML Dynamics” on page 1042.
The Link element has a Description attribute that you can use to add a description
of the link. You can expose Description along with Name and present it to the user
by binding it in WorkStation.
Link makes the parent element an interactive element, and a TGML viewer is
supposed to open the linked presentation object when the user clicks the element.
Table: Link element attributes
Attribute Type Description
Description String A user-defined description of
the link.
Inheritable: No
Animatable: No
PreventDefault Bool Cancels the default action
normally taken by the
implementation, for example
the viewer.
Default: "False"
Inheritable: Yes
Animatable: No
Remarks
The default action when the user clicks an element containing a Link element is to
navigate to, or open, another presentation. When PreventDefault is set to "True" this
action is canceled.
Only painted regions are clickable. Clicking a hollow shape, that is a shape with the
Fill attribute set to "None", has no effect.
04-16006-04-en, March 2015 Technical
1089
34 Graphics TGML Format Specification
34.46 TGML Raster Images
34.46 TGML Raster Images
TGML defines raster images and an animated raster image.
34.46.1 Image Element: <Image>
Image represents a raster image. Image supports JPEG and PNG images.
34.46.2 Animated Images (GIF89a): <Animated
Image>
Animated image represents an animated raster image. AnimatedImage supports
the GIF89a format.
Technical 04-16006-04-en, March 2015
1090
34 Graphics TGML Format Specification
34.47 TGML Image Element: <Image>
34.47 TGML Image Element: <Image>
Image represents a raster image. Image supports JPEG and PNG images.
The image data is stored as a Base64 encoded string in the CDATA section of the
Image element.
Figure: TGML code containing an Image element
The image data is accessible through the Content attribute which means that it can
be bound and dynamically updated in View mode.
Table: Image element attributes
Attribute Type Description
Content String The image data (Base64
encoded).
Inheritable: No
Animatable: Yes
Height Double The height of the image.
Inheritable: No
Animatable: Yes
Left Double The x coordinate of the
upper left corner of the
image.
Default: "0"
Inheritable: No
Animatable: Yes
Opacity Double A value between 0.0
(transparent) and 1.0
(opaque).
Default: "1.0"
Inheritable: No
Animatable: Yes
Top Double The y coordinate of the
upper left corner of the
image.
Default: "0"
Inheritable: No
Animatable: Yes
04-16006-04-en, March 2015 Technical
1091
34 Graphics TGML Format Specification
34.47 TGML Image Element: <Image>
Continued
Attribute Type Description
Visibility Visibility Specifies if the element is
visible or not.
Default: "Visible"
Inheritable: No
Animatable: Yes
Width Double The width of the image.
Inheritable: No
Animatable: Yes
Technical 04-16006-04-en, March 2015
1092
34 Graphics TGML Format Specification
34.48 TGML Animated Images (GIF89a): <AnimatedImage>
34.48 TGML Animated Images (GIF89a):
<AnimatedImage>
Animated image represents an animated raster image. AnimatedImage supports
the GIF89a format.
The Animation attribute starts and stops the animation.
The image data is stored as a Base64-encoded string in the CDATA section of the
AnimatedImage element. The image data is accessible through the Content
attribute.
Table: Animated Image element attributes
Attribute Type Description
Content String The image data (Base64
encoded).
Inheritable: No
Animatable: Yes
Height Double The height of the image.
Inheritable: No
Animatable: Yes
Left Double The x coordinate of the
upper left corner of the
image.
Default: "0"
Inheritable: No
Animatable: Yes
Opacity Double A value between 0.0
(transparent) and 1.0
(opaque).
Default: "1.0"
Inheritable: No
Animatable: Yes
Top Double The y coordinate of the
upper left corner of the
image.
Default: "0"
Inheritable: No
Animatable: Yes
Visibility Visibility Specifies if the element is
visible or not.
Default: "Visible"
Inheritable: No
Animatable: Yes
04-16006-04-en, March 2015 Technical
1093
34 Graphics TGML Format Specification
34.48 TGML Animated Images (GIF89a): <AnimatedImage>
Continued
Attribute Type Description
Width Double The width of the image.
Inheritable: No
Animatable: Yes
Animation Animation Starts and stops the
animation.
Default: "Start"
Inheritable: No
Animatable: Yes
Technical 04-16006-04-en, March 2015
1094
34 Graphics TGML Format Specification
34.49 TGML Scripting
34.49 TGML Scripting
TGML supports the script language JavaScript 1.5. A JavaScript editor is available
in Graphics Editor. You can use the JavaScript edtor to access the elements and
their attributes in View mode. The script engine does not run in Edit mode.
The DOM (the elements and their attributes) is accesed using DOM methods such
as getCurrentTarget, getAttribute, and setAttribute.
Apart from accessing the DOM, it is also possible to interact with the TGML Viewer,
and thus the underlying system, using Building Operation-specific JavaScript
functions such as setValue and execute.
The execution of the scripts is event driven. Event attributes are used to specify the
event and a function name. The function is executed in View mode when the
specified event is raised.
34.49.1 Script Element: Script
Script defines a script block that belongs to the immediate parent element.
34.49.2 Target Area Element: TargetArea
TargetArea represents a clickable area in a graphic. Target area is not painted, that
is, it is always invisible.
Global Variables
Variables declared outside the Java script functions are global within the script
block. The global variables exist while the TGML document is displayed (executed)
in Dynamic mode.
The global variables can only be accessed by the functions that are defined in the
same script block.
About Data Types
Java script variables are untyped. If you, for example, use global variables or
custom attributes to store numeric values: Convert the variables to a Number.
04-16006-04-en, March 2015 Technical
1095
34 Graphics TGML Format Specification
34.49 TGML Scripting
Figure: TGML code with an example of how you can convert a varible to a number
Common Event Methods
Method Description
getCurrentTarget() Returns the element the Script belongs to.
That is, the EventTarget whose
EventListeners are currently being
processed.
getTarget() Returns the element to which the event was
originally dispatched. For example, the
element you clicked.
preventDefault() If the event is cancelable, preventDefault
cancels the default action normally taken by
the implementation, for example, the viewer.
stopPropagation Prevents further propagation of an event.
Technical 04-16006-04-en, March 2015
1096
34 Graphics TGML Format Specification
34.49 TGML Scripting
Method Description
When an element contains Bind or Link, the viewer is supposed to respond when
the user clicks the element. The viewer is supposed to respond by showing a
change value dialog box or opening the linked presentation object. This is the
viewer default action that is canceled by the preventDefault function.
preventDefault in an OnMouseClick function cancels the change value dialog box
(when the element contains a Bind) or the link function (when the element contains
a Link).
preventDefault in an OnSignalChange function cancels the error indication indicated
by a red cross.
Figure: TGML code with a scipts containing getTarget() and getCurrentTarget() methods
Mouse Event Methods
Method Description
getButton() Returns an integer describing which button
was pressed or released. Applicable for
MouseDownEvent and MouseUpEvent.
0 = Left button, 1 = Middle button, and 2 =
Right button.
getClientX() Returns the X coordinate of the cursor,
relative the origin of the target coordinate
system.
The coordinate is calculated using the
transformations of the target element.
getClientY() Returns the Y coordinate of the cursor,
relative the origin of the target coordinate
system.
The coordinate is calculated using the
transformations of the target element.
04-16006-04-en, March 2015 Technical
1097
34 Graphics TGML Format Specification
34.49 TGML Scripting
Continued
Method Description
getCurrentTargetX() Returns the X coordinate of the cursor,
relative the origin of the current target
coordinate system.
The coordinate is calculated using the
transformations of the current target element
getCurrentTargetY() Returns the Y coordinate of the cursor,
relative the origin of the current target
coordinate system.
The coordinate is calculated using the
transformations of the current target
element.
getCurrentTargetParentX() Returns the X coordinate of the cursor,
relative the origin of the current target's
parent coordinate system.
The coordinate is calculated using the
transformations of the current target's
parent.
getCurrentTargetParentY() Returns the Y coordinate of the cursor,
relative the origin of the current target's
parent coordinate system.
The coordinate is calculated using the
transformations of the current target's
parent.
getScreenX() Returns the X coordinate of the cursor,
relative to the origin of the document
coordinate system.
getScreenY() Returns the Y coordinate of the cursor,
relative to the origin of the document
coordinate system.
SignalChange Event Methods
Method Description
getStatus() Returns the status of the signal:
0: Error (Bad quality)
1: Stored value (Uncertain quality)
2: Real value (Good quality).3: Forced value
(Good quality)
getPresentationValue() Returns the value of the bound signal as a
presentation value.
getUnit() Returns the unit of the bound signal as a
string.
getValue() Returns the value of the bound signal.
Technical 04-16006-04-en, March 2015
1098
34 Graphics TGML Format Specification
34.49 TGML Scripting
Method Description
TGML DOM Methods
Object Mehtod Description
Any element getChild ("‹name›") Returns the immediate child
element that has the Name
attribute with the given value.
If no such child exists, this
returns null. If more than one
immediate child element has
a Name attribute with that
value, what is returned is
undefined.
Any element getChildRecursive ("‹name›") Returns the child element at
any level that has the Name
attribute with the given value.
If no such element exists, this
returns null. If more than one
element has a Name
attribute with that value, what
is returned is undefined.
Any element getFullBindName() Returns the exposed name
of the Bind or Link element,
including names of parent
components.
Figure: TGML code with a script containing a getFullBindName() method
Standard DOM Methods
These standard methods are commonly used. the W3C Document Object Model
(DOM), Level 3 Core Specifications.
Object Method Description
Any element getAttribute("‹attribute›") Returns the value of
‹attribute›
04-16006-04-en, March 2015 Technical
1099
34 Graphics TGML Format Specification
34.49 TGML Scripting
Continued
Object Method Description
Any element getChildNodes() Returns a NodeList that
contains all children of this
node
Any element getOwnerDocument() Returns the document
Any element getParentNode() Returns the parent element
Any element getTagName() Returns the element tag
name, e.g. Rectangle or Bind
Any element setAttribute("‹attribute›", Sets the value of ‹attribute› to
"‹value›") ‹value›. If the element does
not have the attribute, it is
created as a TGML custom
attribute.
Document getDocumentElement() Returns the TGML (root)
element
Document getElementById("‹Id›") Returns the child element
that has the Id attribute with
the given value
Document getElementsByTagName Returns a NodeList of all the
("‹tagName›") elements in document order
with a given tag name
NodeList getLength() Returns the number of
elements in the NodeList
NodeList item("‹index›") Returns the element at
‹index› in the NodeList
Technical 04-16006-04-en, March 2015
1100
34 Graphics TGML Format Specification
34.49 TGML Scripting
Object Method Description
Figure: TGML code with a script containing getAttribute() and setAttribute() methods
TGML JavaScript Functions
Method Description
alert("<messages>") Displays a message box
clearInterval(intervalID) Cancels the previously started interval using
the setInterval function.
intervalID is an identifier returned by a
previous call to the setInterval function.
clearTimeout(timeoutID) Cancels a time-out that was set with the
setTimeout function.
timeoutID is an identifier returned by a
previous call to the setTimeout function.
confirm("<message>") Displays a confirm box with "Yes" and "No"
buttons.
Returns true if the user clicks "Yes" or false if
the user clicks "No".
04-16006-04-en, March 2015 Technical
1101
34 Graphics TGML Format Specification
34.49 TGML Scripting
Continued
Method Description
execute("<commande>"), Requests an execute operation to be
execute("<command>", "<options>") performed by the TGML viewer (start a
Windows program).
command is the name of the program (full
path) and options is the command line
options.
Returns true if succeeded or false if failed.
Note: The implementation of this function is
system dependent. May not be implemented
in some systems.
invoke("<bindingName>", "<operation>") Requests an operation to be performed on a
bound object by the TGML viewer. The
bindingName is the full name (as it is
exposed to the binding tools) of a Bind or
Link element.
Returns true if succeeded or false if failed.
Note: The implementation of this function is
system dependent. May not be implemented
in some systems.
openFile("<path>", "<operation>") Request the TGML viewer to open a file. The
operation is typical Windows object verbs.
Returns true if succeeded or false if failed.
Note: The implementation of this function is
system dependent. May not be implemented
in some systems.
prompt("<message>", "<defaultValue>") Prompts the user to enter a value.
Returns the entered value or null if canceled.
setForce("<bindingName>", "<true|false>")| Sets the force state of a bound signal object.
The bindingName is the full name (as it is
exposed to the binding tools) of a Bind
element.
Returns true if succeeded or false if failed.
Note: The implementation of this function is
system dependent. May not be implemented
in some systems.
setInterval("<expression>", "<milliseconds>") Evaluates (executes) the expression each
time the specified number of milliseconds
has elapsed.
Returns an identifier that cancels the timer
with the clearInterval method.
setTimeout("<expression>", Evaluates (executes) the expression after the
"<milliseconds>") specified number of milliseconds has
elapsed.
Returns an identifier that cancels the timer
with the clearTimeout method.
Technical 04-16006-04-en, March 2015
1102
34 Graphics TGML Format Specification
34.49 TGML Scripting
Continued
Method Description
setValue("<bindingName>", "<value>") Sets the value of a bound signal object. The
bindingName is the full name (as it is
exposed to the binding tools) of a Bind
element.
Returns true if succeeded or false if failed.
Note: The implementation of this function is
system dependent. May not be implemented
in some systems.
Figure: TGML code containing a rectangle that toggles a value
04-16006-04-en, March 2015 Technical
1103
34 Graphics TGML Format Specification
34.49 TGML Scripting
Figure: Rectangle that toggles a value on screen
Figure: TGML code that starts an interval timer and animates (toggles) the fill color when
the pointer is placed over the rectangle. The timer is stopped and the color is restored
when the pointer is moved from the rectangle.
Figure: TGML code where an alert box is displayed when the pointer is held over the
rectangle for one second. The timer is stopped wehn the pointer is moved from the
rectangle.
JavaScript 1.5
ECMAScript Language Specification, Rev. 3.
Technical 04-16006-04-en, March 2015
1104
34 Graphics TGML Format Specification
34.50 TGML Script Element: Script
34.50 TGML Script Element: Script
Script defines a script block that belongs to the immediate parent element.
Specifying an event attribute on the Script element makes the parent element the
target for the specified event. For example, if OnMouseClick and the function
name "click" are specified, the click function is executed when the user clicks the
parent element (assuming that the element is a visible graphical element).
If the parent element of Script is a container element, such as Component, the
mouse event is sent when any of the contained graphical elements are hit. The hit
element is the target, while the parent element, which handles the event, is the
current target.
The functions are always defined with an in parameter. The parameter is a reference
to the event object that can be used to get event specific information and to access
the DOM, starting with getTarget or getCurrentTarget.
Each Script element (script block) creates a JavaScript context. Function calls
between script blocks (contexts) are not supported, that is, no support for global
script functions.
The script functions are stored in the CDATA section of the Script element. The
CDATA section is accessible through the Content attribute.
Table: Script element attribute
Attribute Type Descirption
Content String The script.
Inheritable: No
Animatable: No
Table: Events and event attributes
Event Attribute Event Type Target Desciption
OnDocumentLoad DocumentLoadEvent Any element The TGML document
is uploaded (opened).
Cancelable: No
OnMouseClick MouseClickEvent Painted element A mouse button is
clicked over an
element.
Cancelable: Yes
OnMouseDown MouseDownEvent Painted element A mouse button is
pressed over an
element.
Cancelable: Yes
OnMouseUp MouseUpEvent Painted element A mouse button is
released over an
element.
Cancelable: Yes
04-16006-04-en, March 2015 Technical
1105
34 Graphics TGML Format Specification
34.50 TGML Script Element: Script
Continued
Event Attribute Event Type Target Desciption
OnMouseOver MouseOverEvent Painted element The pointer is moved
onto an element.
Cancelable: Yes
OnMouseMove MouseMoveEvent Painted element The pointer is moved
while it is over an
element.
Cancelable: Yes
OnMouseOut MouseOutEvent Painted element The pointer is moved
away from an
element.
Cancelable: Yes
OnSignalChange SignalChangeEvent Bind element The value of the
bound signal has
been changed.
The referenced
attribute in the Bind
element is updated
before the event is
sent.
Cancelable: Yes
Figure: TGML code containing a Script element with an OnMouseClick attribute event
Figure: Script element on screen
Technical 04-16006-04-en, March 2015
1106
34 Graphics TGML Format Specification
34.51 TGML Target Area Element: <TargetArea>
34.51 TGML Target Area Element:
<TargetArea>
TargetArea represents a clickable area in a graphic. Target area is not painted, that
is, it is always invisible.
You do not have to use TargetArea to be able to handle mouse events. All of the
graphical (painted) elements can be targets of mouse events. Use TargetArea when
you need an invisible but clickable area.
Table: TargetArea element attributes
Attribute Type Description
Height Double The height of the area.
Inheritable: No
Animatable: Yes
Length Double The x-coordinate of the
area's upper left corner.
Default: "0"
Inheritable: No
Animatable: Yes
Top Double The y-coordinate of the
area's upper left corner.
Default: "0"
Inheritable: No
Animatable: Yes
Width Double The width of the area.
Inheritable: No
Animatable: Yes
You can use TargetArea to create a mouse-sensitive area that covers the whole
Component.
Without the TargetArea, the MouseOver and MouseOut events are sent every
time the cursor passes the contained elements when the Script is defined at the
Component level. The TargetArea has the effect of "hiding" the contained shapes
and you only get one MouseOver and one MouseOut when the cursor passes the
Component.
04-16006-04-en, March 2015 Technical
1107
34 Graphics TGML Format Specification
34.51 TGML Target Area Element: <TargetArea>
Figure: TGML code containing a TargetArea element and an OnMouseOut attribute event
Figure: TGML code fragment containing an invisible link area that can be placed above
other shapes
Technical 04-16006-04-en, March 2015
1108
34 Graphics TGML Format Specification
34.52 TGML Text
34.52 TGML Text
TGML supports two types of text elements: Text and TextBox.
Figure: The character data (the text) is stored within the Text element as XML element
content.
The character data is accessible through the Content attribute which means that it
is possible to cerate dynamic texts by animating or binding the Content attribute.
34.52.1 Text Line: <Text>
Text defines a graphics element consisting of text. Each Text element causes a
single string of text to be rendered. The Text element perfoms no automatic line
break or word wrapping.
34.52.2 Text Flow: <TextBox>
Text defines a graphics element consisting of text. TextBox wraps the text within
the specified box. The TextBox element also supports manual line breaks (ASCII
character 10).
Table: Common text attributes
Attribute Type Description
Content String The character data.
Inheritable: No
Animatable: Yes
FontFamily String The name of the font or font
family.
Inheritable: Yes
Animatable: Yes
FontSize Double The size of the font, in device
independent pixels. For more
information, see section 34.2
“TGML Coordinate System”
on page 1017.
Inheritable: Yes
Animatable: Yes
FontStyle FontStyle The style of the font, that is,
Normal or Italic.
Default: "Normal"
Inheritable: Yes
Animatable: Yes
04-16006-04-en, March 2015 Technical
1109
34 Graphics TGML Format Specification
34.52 TGML Text
Continued
Attribute Type Description
FontWeight FontWeight The weight of the font, that
is, Normal or Bold.
Default: "Normal"
Inheritable: Yes
Animatable: Yes
HorizontalAlign HorizontalAlign Describes the horizontal
alignment of a text string:
Text: relative to the x
coordinate Left
TextBox: relative the
specified box
Default: "Left"
Inheritable: Yes
Animatable: Yes
Left Double The x coordinate of the
upper left corner of the text
area.
Default: "0"
Inheritable: No
Animatable: Yes
Opacity Brush A value between 0.0
(transparent) and 1.0
(opaque).
Default: "1.0"
Inheritable: No
Animatable: Yes
Stroke Brush Specifies how the text is
painted.
Default: "#000000"
Inheritable: Yes
Animatable: Yes
TextDecoration TextDecoration Specifies decorations that
are added to the text.
Default: "None"
Inheritable: Yes
Animatable: Yes
Technical 04-16006-04-en, March 2015
1110
34 Graphics TGML Format Specification
34.52 TGML Text
Continued
Attribute Type Description
Top Double The y coordinate of the
upper left corner of the text
area.
Default: "0"
Inheritable: No
Animatable: Yes
VerticalAlign VerticalAlign Describes the vertical
alignment of a text string:
Text: relative to the x
coordinate Left
TextBox: relative the
specified box
Default: "Top"
Inheritable: Yes
Animatable: Yes
Visibility Visibility Specifies if the text is visible
or not.
Default: "Visible"
Inheritable: No
Animatable: Yes
04-16006-04-en, March 2015 Technical
1111
34 Graphics TGML Format Specification
34.53 TGML Text Line: <Text>
34.53 TGML Text Line: <Text>
Text defines a graphics element consisting of text. Each Text element causes a
single string of text to be rendered. The Text element perfoms no automatic line
break or word wrapping.
Table: Text element attributes
Attribute Type Description
Content String The character data.
Inheritable: No
Animatable: Yes
FontFamily String The name of the font or font
family.
Inheritable: Yes
Animatable: Yes
FontSize Double The size of the font, in device
independent pixels. For more
information, see section 34.2
“TGML Coordinate System”
on page 1017.
Inheritable: Yes
Animatable: Yes
FontStyle FontStyle The style of the font, that is,
Normal or Italic.
Default: "Normal"
Inheritable: Yes
Animatable: Yes
FontWeight FontWeight The weight of the font, that
is, Normal or Bold.
Default: "Normal"
Inheritable: Yes
Animatable: Yes
HorizontalAlign HorizontalAlign Describes the horizontal
alignment of a text string:
Text: relative to the x
coordinate Left
TextBox: relative the
specified box
Default: "Left"
Inheritable: Yes
Animatable: Yes
Technical 04-16006-04-en, March 2015
1112
34 Graphics TGML Format Specification
34.53 TGML Text Line: <Text>
Continued
Attribute Type Description
Left Double The x coordinate of the
upper left corner of the text
area.
Default: "0"
Inheritable: No
Animatable: Yes
Opacity Double A value between 0.0
(transparent) and 1.0
(opaque).
Default: "1.0"
Inheritable: No
Animatable: Yes
Stroke Brush Specifies how the text is
painted.
Default: "#000000"
Inheritable: Yes
Animatable: Yes
TextDecoration TextDecoration Specifies decorations that
are added to the text.
Default: "None"
Inheritable: Yes
Animatable: Yes
Top Double The y coordinate of the
upper left corner of the text
area.
Default: "0"
Inheritable: No
Animatable: Yes
VerticalAlign VerticalAlign Describes the vertical
alignment of a text string:
Text: relative to the x
coordinate Left
TextBox: relative the
specified box
Default: "Top"
Inheritable: Yes
Animatable: Yes
04-16006-04-en, March 2015 Technical
1113
34 Graphics TGML Format Specification
34.53 TGML Text Line: <Text>
Continued
Attribute Type Description
Visibility Visibility Specifies if the text is visible
or not.
Default: "Visible"
Inheritable: No
Animatable: Yes
Technical 04-16006-04-en, March 2015
1114
34 Graphics TGML Format Specification
34.54 TGML Text Flow: <TextBox>
34.54 TGML Text Flow: <TextBox>
Text defines a graphics element consisting of text. TextBox wraps the text within
the specified box. The TextBox element also supports manual line breaks (ASCII
character 10).
The text is stored in the CDATA section of the TextBox element.
Table: TextBox element attributes
Attribute Type Description
Content String The character data.
Inheritable: No
Animatable: Yes
FontFamily String The name of the font or font
family.
Inheritable: Yes
Animatable: Yes
FontSize Double The size of the font, in device
independent pixels. For more
information, see section 34.2
“TGML Coordinate System”
on page 1017.
Inheritable: Yes
Animatable: Yes
FontStyle FontStyle The style of the font, that is,
Normal or Italic.
Default: "Normal"
Inheritable: Yes
Animatable: Yes
FontWeight FontWeight The weight of the font, that
is, Normal or Bold.
Default: "Normal"
Inheritable: Yes
Animatable: Yes
HorizontalAlign HorizontalAlign Describes the horizontal
alignment of a text string:
Text: relative to the x
coordinate Left
TextBox: relative the
specified box
Default: "Left"
Inheritable: Yes
Animatable: Yes
04-16006-04-en, March 2015 Technical
1115
34 Graphics TGML Format Specification
34.54 TGML Text Flow: <TextBox>
Continued
Attribute Type Description
Left Double The x coordinate of the
upper left corner of the text
area.
Default: "0"
Inheritable: No
Animatable: Yes
Opacity Double A value between 0.0
(transparent) and 1.0
(opaque).
Default: "1.0"
Inheritable: No
Animatable: Yes
Stroke Brush Specifies how the text is
painted.
Default: "#000000"
Inheritable: Yes
Animatable: Yes
TextDecoration TextDecoration Specifies decorations that
are added to the text.
Default: "None"
Inheritable: Yes
Animatable: Yes
Top Double The y coordinate of the
upper left corner of the text
area.
Default: "0"
Inheritable: No
Animatable: Yes
VerticalAlign VerticalAlign Describes the vertical
alignment of a text string:
Text: relative to the x
coordinate Left
TextBox: relative the
specified box
Default: "Top"
Inheritable: Yes
Animatable: Yes
Technical 04-16006-04-en, March 2015
1116
34 Graphics TGML Format Specification
34.54 TGML Text Flow: <TextBox>
Continued
Attribute Type Description
Visibilty Visibility Specifies if the text is visible
or not.
Default: "Visible"
Inheritable: No
Animatable: Yes
Height Double The height of the text area.
Inheritable: No
Animatable: Yes
Width Double The width of the text area.
Inheritable: No
Animatable: Yes
Figure: TGML code containing a TextBox element
Figure: Textbox element on screen
04-16006-04-en, March 2015 Technical
1117
34 Graphics TGML Format Specification
34.55 TGML Transformations
34.55 TGML Transformations
Transformation elements control the size, position, rotation and skew of graphic
objects. The transformation establishes a transformed coordinate system for the
immediate parent element.
Transformations are appliced in the same order as they are specified in the TGML
file.
Transformations can be nested to any level. The effect of nested transformations is
to post-multiply, that is, concatenate, the subsequent transformation matrices onto
previously defined transformations.
34.55.1 Rotation: <Rotate>
Rotate rotates the coordinate system for the immediate parent element about a
specified point.
34.55.2 Skewing: <SkewX> and <SkewY>
SkewX and SkewY skew (stretch) the coordinate system for the immediate parent
element about a specified point.
34.55.3 Scaling: <Scale>
Scale scales the coordinate system for the immediate parent element.
34.55.4 Translations: <Translate>
Translate translates (moves) the coordinate system for the immediate parent
element.
Technical 04-16006-04-en, March 2015
1118
34 Graphics TGML Format Specification
34.56 TGML Rotation: <Rotate>
34.56 TGML Rotation: <Rotate>
Rotate rotates the coordinate system for the immediate parent element about a
specified point.
Table: Rotate element attributes
Attribute Type Description
Angle Double The angle of the rotation,
measured in degrees.
A positive value implies
clockwise rotation. A
negative value implies
counter-clockwise rotation.
Default: "0.0"
Inheritable: No
Animatable: Yes
Center Point Describes the position of the
center point ("X,Y") of the
rotation.
"0.0 , 0.0" represents the
upper left corner of the
element and "1.0 , 1.0"
represents the lower right
corner.
Remarks
Figure: Different Center values
Figure: TGML code containg a Rotate element
04-16006-04-en, March 2015 Technical
1119
34 Graphics TGML Format Specification
34.56 TGML Rotation: <Rotate>
Figure: Rotate element on screen
Technical 04-16006-04-en, March 2015
1120
34 Graphics TGML Format Specification
34.57 TGML Skewing: <SkewX> and <SkewY>
34.57 TGML Skewing: <SkewX> and <SkewY>
SkewX and SkewY skew (stretch) the coordinate system for the immediate parent
element about a specified point.
Skew X specifies a skew transformation along the X axis. The skew angle is
measured in degrees from the Y axis.
Skew Y specifies a skew transformation along the Y axis. The skew angle is
measured in degrees from the X axis.
Figure: Skewing along the X axis and the Y axis
Table: Skew element attributes
Attribute Type Description
Angle Double The skew angle, measured in
degrees.
A positive value implies
counterclockwise skew. A
negative value implies
clockwise skew.
Default: "0.0"
Inheritable: No
Animatable: Yes
Center Point Describes the position of the
center point of the skew.
For more information, see
section 34.56 “TGML
Rotation: <Rotate>” on page
1117.
Default: "0.5 , 0.5"
Inheritable: No
Animatable: Yes
04-16006-04-en, March 2015 Technical
1121
34 Graphics TGML Format Specification
34.57 TGML Skewing: <SkewX> and <SkewY>
Attribute Type Description
Figure: TGML code containing Skew elements
Figure: Skew elements on screen
Technical 04-16006-04-en, March 2015
1122
34 Graphics TGML Format Specification
34.58 TGML Scaling: <Scale>
34.58 TGML Scaling: <Scale>
Scale scales the coordinate system for the immediate parent element.
Table: Scale element attributes
Attribute Type Description
Center Point Describes the position of the
center point (origin) of the
scale.
For more information, see
section 34.56 “TGML
Rotation: <Rotate>” on page
1117.
Default: "0.5 , 0.5"
Inheritable: No
Animatable: Yes
ScaleX Double The horizontal scale factor.
Default: "0.0"
Inheritable: No
Animatable: Yes
ScaleY Double The vertical scale factor.
Default: "0.0"
Inheritable: No
Animatable: Yes
04-16006-04-en, March 2015 Technical
1123
34 Graphics TGML Format Specification
34.59 TGML Translations: <Translate>
34.59 TGML Translations: <Translate>
Translate translates (moves) the coordinate system for the immediate parent
element.
Table: Translate element attributes
Attribute Type Description
X Double Specifies the X direction.
Default: "0.0"
Inheritable: No
Animatable: Yes
Y Double Specifies the Y direction.
Default: "0.0"
Inheritable: No
Animatable: Yes
Figure: TGML code containing Translate element
Figure: Translate element on screen
Technical 04-16006-04-en, March 2015
1124
35 TGML Additions for Building
Operation
Topics
TGML Elements
TGML Limitations
Displaying the TGML Version
Global Scripts in TGML Graphics
Invoke Function
Panel Navigation
35 TGML Additions for Building Operation
35.1 TGML Elements
35.1 TGML Elements
TGML supports the listed elements.
TGML Element Type Possible parent Description
<Animate> Animation Brush, Container, Animate animates a
Image, Shape, specified attribute of
Transform, the immediate parent
<GradientStop> element.
For more information,
see section 34.13
“TGML Animation:
<Animate>” on page
1032.
<AnimatedImage> Image Container, <Tgml> Animated image
represents an
animated raster
image.
AnimatedImage
supports the GIF89a
format.
For more information,
see section 34.48
“TGML Animated
Images (GIF89a):
<AnimatedImage>”
on page 1091.
<Arc> Shape Container, <Tgml> Arc defines an
elliptical arc. The
elliptical arc is part of
an ellipse.
For more information,
see section 34.34
“TGML Elliptical Arc:
<Arc>” on page
1069.
<Bind> Shape Not in Rule, Bind enables a
<Expose>, <Link>, dynamic
<Metadata> or (server/device
<Script> controlled) update of
an attribute of the
immediate parent
element.
For more information,
see section 34.21
“TGML Signal
Binding: <Bind>” on
page 1045.
04-16006-04-en, March 2015 Technical
1127
35 TGML Additions for Building Operation
35.1 TGML Elements
Continued
TGML Element Type Possible parent Description
<Component> Container Container, <Tgml> The Components
element is a
container element
(similar to Group)
which defines a
reusable group of
elements.
For more information,
see section 34.43
“TGML Components:
<Component>” on
page 1084.
<ComponentContent Container
>
<ConvertCustom> Rule <Bind> ConvertCustom
defines a custom
conversion of a signal
value. The
ConvertCustom
element is a script
element with a
JavaScript function
named 'convert'.
For more information,
see section 34.25
“TGML Custom
Conversion:
<ConvertCustom>”
on page 1052.
<ConvertRange> Rule <Bind> ConvertRange
specifies how a
server variable
(signal) value shall be
converted to a TGML
element attribute
value using min and
max values. A
ConvertRange
element belongs to
the immediate parent
Bind element.
For more information,
see section 34.24
“TGML Value Range
Conversion:
<ConvertRange>” on
page 1050.
Technical 04-16006-04-en, March 2015
1128
35 TGML Additions for Building Operation
35.1 TGML Elements
Continued
TGML Element Type Possible parent Description
<ConvertStatus> Rule <Bind> ConvertStatus
specifies how the
status of a server
variable (signal) value
is to be converted to
a TGML element
attribute value. A
ConvertStatus
element belongs to
the immediate parent
Bind element.
For more information,
see section 34.26
“TGML Status
Conversion:
<ConvertStatus>” on
page 1053.
<ConvertText> Rule <Bind> ConvertText specifies
how a server variable
(signal) value is to be
converted to a TGML
element attribute
value. ConvertText
assumes that the
signal value is a text.
A ConvertText
element belongs to
the immediate parent
Bind element.
For more information,
see section 34.23
“TGML Text Value
Conversion:
<ConvertText>” on
page 1049.
<ConvertValue> Rule <Bind> ConvertValue
specifies how a
server variable
(signal) value is to be
converted to a TGML
element attribute
value. A
ConvertValue
element belongs to
the immediate parent
Bind element.
For more information,
see section 34.22
“TGML Value
Conversion:
<ConvertValue>” on
page 1047.
04-16006-04-en, March 2015 Technical
1129
35 TGML Additions for Building Operation
35.1 TGML Elements
Continued
TGML Element Type Possible parent Description
<Chord> Shape Container, <Tgml> Chord defines an
elliptical chord.
Chord is similar to Pie
and Arc.
For more information,
see section 34.36
“TGML Elliptical
Chord: <Chord>” on
page 1073.
<Curve> Shape Container, <Tgml> Curve defines a cubic
Bezier curve. The
cubic Bezier curve
has a start point, an
end point, and two
control points. The
control points act as
magnets, pulling the
curve in certain
directions to
influence the way the
Bezier curve bends.
For more information,
see section 34.18
“TGML Cubic Bezier
Curve: <Curve>” on
page 1038.
<Ellipse> Shape Container, <Tgml> The Ellipse element
defines an ellipse.
For more information,
see section 34.32
“TGML Ellipse:
<Ellipse>” on page
1065.
<Expose> Not in <Script> Expose indicates that
an attribute of the
immediate parent
element is to be
exposed by the
TGML editor, using
the Name of the
Expose element
instead of the original
attribute name.
For more information,
see section 34.16
“TGML Expose
Element: <Expose>”
on page 1036.
Technical 04-16006-04-en, March 2015
1130
35 TGML Additions for Building Operation
35.1 TGML Elements
Continued
TGML Element Type Possible parent Description
<GradientStop> Brush The GradientStop
describes the
location and color of
a transition point in a
gradient.
GradientStop
belongs to its
immediate parent
gradient element.
For more information,
see section 34.40
“TGML Gradient
Stop:
<GradientStop>” on
page 1080.
<Group> Container Container, <Tgml> The Group element is
a container element,
used for grouping
elements together so
they can, for
example, be moved,
copied and resized
as if they were a
single element.
For more information,
see section 34.42
“TGML Grouping:
<Group>” on page
1083.
<Image> Image Container, <Tgml> Image represents a
raster image. Image
supports JPEG and
PNG images.
For more information,
see section 34.47
“TGML Image
Element: <Image>”
on page 1089.
<Layer> Container <Tgml> The Layer element is
a container element
used to create
layered TGML
graphics.
For more information,
see section 34.44
“TGML Layers:
<Layer>” on page
1086.
04-16006-04-en, March 2015 Technical
1131
35 TGML Additions for Building Operation
35.1 TGML Elements
Continued
TGML Element Type Possible parent Description
<Line> Shape Container, <Tgml> The Line element
describes a straight
line between two
points.
For more information,
see section 34.28
“TGML Line: <Line>”
on page 1056.
<LinearGradient> Brush Container, Shape The LinearGradient
creates a linear
gradient brush for the
stroke or fill area of
the immediate
parent.
For more information,
see section 34.38
“TGML Linear
Gradient:
<LinearGradient>” on
page 1076.
<Link> Container, Image, Link represents a
Shape, <TargetArea> hyperlink to another
presentation stored
in the database, or
file system, of the
connected server.
Examples of
presentation objects
are: TGML graphics
files, trend log views
and on-line plots.
For more information,
see section 34.45
“TGML Link element:
<Link>” on page
1087.
<Metadata> Not in <Metadata> or Each TGML
<Script> document contains
the TGML root
element. It also
contains metadata
created and
interpreted by the
TGML application.
For more information,
see section 34.10
“TGML Document
Type Element and
Metadata” on page
1028.
Technical 04-16006-04-en, March 2015
1132
35 TGML Additions for Building Operation
35.1 TGML Elements
Continued
TGML Element Type Possible parent Description
<Path> Shape Container, <Tgml> Path represents the
outline of a shape.
For more information,
see section 34.19
“TGML Path
Element: <Path>” on
page 1040.
<Pie> Shape Container, <Tgml> Pie defines an
elliptical pie slice. Pie
is similar to Arc.
For more information,
see section 34.35
“TGML Elliptical Pie:
<Pie>” on page
1071.
<Polygon> Shape Container, <Tgml> The Polygon element
describes a polygon,
which is a connected
series of lines that
forms a closed
shape. The end point
does not have to be
specified. The
polygon is closed
automatically.
For more information,
see section 34.30
“TGML Polygon:
<Polygon>” on page
1060.
<Polyline> Shape Container, <Tgml> The Polyline element
describes a series of
connected straight
lines.
For more information,
see section 34.29
“TGML Polyline:
<Polyline>” on page
1058.
<RadialGradient> Brush Container, Shape RadialGradient
defines a radial
gradient brush for the
stroke or fill area of
the immediate
parent.
For more information,
see section 34.39
“TGML Radial
Gradient:
<RadialGradient>” on
page 1078.
04-16006-04-en, March 2015 Technical
1133
35 TGML Additions for Building Operation
35.1 TGML Elements
Continued
TGML Element Type Possible parent Description
<Rectangle> Shape Container, <Tgml> The Rectangle
element defines a
rectangle. Rounded
rectangles can be
achived by setting
values for the
attributes RadiusX
and RadiusY.
For more information,
see section 34.31
“TGML Rectangle:
<Rectangle>” on
page 1062.
<Rotate> Transform Container, Image, Rotate rotates the
Shape coordinate system
for the immediate
parent element about
a specified point.
For more information,
see section 34.56
“TGML Rotation:
<Rotate>” on page
1117.
<Scale> Transform Container, Image, Scale scales the
Shape coordinate system
for the immediate
parent element.
For more information,
see section 34.58
“TGML Scaling:
<Scale>” on page
1121.
<Script> Container, Image, Script defines a script
Shape, <Bind>, block that belongs to
<TargetArea>, the immediate parent
<Tgml> element.
For more information,
see section 34.50
“TGML Script
Element: Script” on
page 1103.
<Sequence> Animation Container Sequence plays a
sequence of
graphical elements,
for example, shapes,
text, images, as a
'movie'.
For more information,
see section 34.14
“TGML Sequences:
<Sequence>” on
page 1034.
Technical 04-16006-04-en, March 2015
1134
35 TGML Additions for Building Operation
35.1 TGML Elements
Continued
TGML Element Type Possible parent Description
<SkewX> Transform Container, Image, SkewX and SkewY
Shape skew (stretch) the
coordinate system
for the immediate
parent element about
a specified point.
For more information,
see section 34.57
“TGML Skewing:
<SkewX> and
<SkewY>” on page
1119.
<SkewY> Transform Container, Image, SkewX and SkewY
Shape skew (stretch) the
coordinate system
for the immediate
parent element about
a specified point.
For more information,
see section 34.57
“TGML Skewing:
<SkewX> and
<SkewY>” on page
1119.
<Snippet> Container A snippet is a stored
piece of TGML code.
It can be used for
reusing constructs
such as
preconfigured
animations and
gradients.
For more information,
see section 34.6
“TGML Code
Snippets” on page
1024.
<TargetArea> Container, <Tgml> TargetArea
represents a
clickable area in a
graphic. Target area
is not painted, that is,
it is always invisible.
For more information,
see section 34.51
“TGML Target Area
Element:
<TargetArea>” on
page 1105.
04-16006-04-en, March 2015 Technical
1135
35 TGML Additions for Building Operation
35.1 TGML Elements
Continued
TGML Element Type Possible parent Description
<Text> Shape Container Text defines a
graphics element
consisting of text.
Each Text element
causes a single string
of text to be
rendered. The Text
element perfoms no
automatic line break
or word wrapping.
For more information,
see section 34.53
“TGML Text Line:
<Text>” on page
1110.
<TextBox> Shape Container Text defines a
graphics element
consisting of text.
TextBox wraps the
text within the
specified box. The
TextBox element also
supports manual line
breaks (ASCII
character 10).
For more information,
see section 34.54
“TGML Text Flow:
<TextBox>” on page
1113.
<Tgml> Each TGML
document contains
the TGML root
element. It also
contains metadata
created and
interpreted by the
TGML application.
For more information,
see section 34.10
“TGML Document
Type Element and
Metadata” on page
1028.
<Translate> Transform Container, Image, Translate translates
Shape (moves) the
coordinate system
for the immediate
parent element.
For more information,
see section 34.59
“TGML Translations:
<Translate>” on
page 1122.
Technical 04-16006-04-en, March 2015
1136
35 TGML Additions for Building Operation
35.2 TGML Limitations
35.2 TGML Limitations
In some implementations, for example, Microsoft GDI+ there are limitations to
TGML attributes.
Positional and Size-Related Limitations
Positional attributes have a limitation of +/- 10.000 pixels. Size-related attributes
have a limitation of 10.000 by 10.000 pixels. That is, no TGML figure can have a
size that exceeds 10.000 by 10.000 pixels. This size limitation also applies for the
canvas. The following TGML attributes are affected by the limitations:
• Top
• Left
• Height
• Width
• Length
• X1
• X2
• Y1
• Y2
• Points
• RadiusX
• RadiusY
• StartPoint
• EndPoint
• ContentHeight
• ContentWidth
• FontSize
• StrokeWidth
04-16006-04-en, March 2015 Technical
1137
35 TGML Additions for Building Operation
35.3 Displaying the TGML Version
35.3 Displaying the TGML Version
You display the TGML version to find out which TGML version the Graphics Editor
version supports.
For more information, see section 34.1 “TGML Overview” on page 1015.
To display the TGML Version
1. In Graphics Editor, click the Design button.
2. On the File menu, click Properties.
The TGML version is displayed in the TGML version box.
Technical 04-16006-04-en, March 2015
1138
35 TGML Additions for Building Operation
35.4 Global Scripts in TGML Graphics
35.4 Global Scripts in TGML Graphics
By default, each Script element (script block) creates a JavaScript context. In this
mode, function calls between script blocks (contexts) are not supported, that is, no
support for global script functions.
From Building Operation 1.6 it is possible to enable scripts to run in one single
context for the whole graphic so that functions and variables can be shared
between script blocks. This is done by setting the TGML element property
‘UseGlobalScripts’ in the Graphics Editor to ‘True’. By default, 'UseGlobalScripts' is
‘False’.
Using ‘UseGlobalScripts’ may have a very positive effect on graphics loading
performance in some of the viewers, such as the HTML5-based viewer in
WebStation.
Global variables
In the HTML5 viewer some names are reserved for the Web Browser. It might not
be apparent for users writing Java Scripts that using reserved names can cause a
conflict when viewing the TGML graphic in the HTML5 viewer, as it works fine in the
WorkStation viewer.
You can check whether or not there is a conflict by using the Global Variables tool in
the Graphics Editor Statistics pane to analyze the scripts in the TGML graphic and
looks for global variables that could cause name conflicts.
Example:
A script that contains a variable named ‘window’ without the var declaration might
have been intended to be used as a local variable. However, not declaring it as ‘var’
makes it a global variable and since ‘window’ is a reserved word (an object in the
Web Browser) this object is referenced instead, when the Web Browser executes
the script.
function load(evt)
{
window = 1;
}
Note
• The variable 'window' is visible in the list of Global script variables.
• To use reserved words locally in scripts as variables, make sure to declare
them as ‘var’.
function load(evt)
{
var window = 1;
}
04-16006-04-en, March 2015 Technical
1139
35 TGML Additions for Building Operation
35.5 Invoke Function
35.5 Invoke Function
Graphic components can be used to navigate within panels. The navigation
function requires that you add a script with an invoke function to the graphic
component in Graphics Editor.
With invoke functions in the script, you can configure the graphic component to
open a linked target object in a target location when the user performs a specific
action on the component. For example a graphics component can be configured to
open a trend chart in another pane in the panel of your graphic when the user clicks
the graphic component.
This is an example of the invoke command syntax:
invoke("BindingName", "Operation") where Operation is "OperationName Attribute
1 | Attribute2"
The operation in the invoke function defines where the target object is to be
opened.
For more information, see section 34.49 “TGML Scripting” on page 1093.
Figure: An example of the Invoke syntax in Graphics Editor
Table: Invoke commands
Command Description
invoke("Link 1", "OpenInFloatingWindow"); Opens the target object in a floating window.
invoke("Link 1", "OpenInNewWindow"); Opens the target object in a new window.
invoke("Link 1", "OpenInParent"); The target object replaces the parent
location, that is, the panel in which the
graphic is contained.
invoke("Link 1", "OpenInSelf"); The target object replaces the graphic.
invoke("Link 1", "OpenInTarget"); Opens the target object in a specific pane.
invoke("Link 1", "OpenInTop"); The target object replaces the top panel,
that is the panel in which all other panels are
contained.
invoke("Link 1", "OpenInWorkArea"); Opens the target object in the work area.
This command replaces the obsolete 'View
object' command.
invoke("", "HistoryForward"); Navigates forward to a view you have visited
before in the selected window.
invoke("", "HistoryBack"); Navigates back to a view you have visited
before in the selected window.
Invoke("", "LogOff"); Logs off the current user from WorkStation
Technical 04-16006-04-en, March 2015
1140
35 TGML Additions for Building Operation
35.5 Invoke Function
Command Description
35.5.1 Invoke Function Attributes
You can include any number of attributes that are supported for the used
command. The OpenInTarget command has to include the Target attribute in order
to work.
For each invoke command you can set a number of attributes:
• Width: sets the width of the window in pixels.
• Height: sets the height of the window in pixels
• Top: sets the top position of the window in number of pixels from the top left
corner o the screen
• Left: sets the left position of the window in number of pixels from the top left
corner or the screen
• Target: sets the target location where the link target is to be opened. You type
the name of the pane. The pane and the graphic have to be contained in the
same panel.
• DisplayName: displays the name you have typed for the target pane. By
default, the object name is the display name of the target pane.
• ShowToolbar: displays the toolbar in the target pane when set to “Yes“.
• SkipFallback: when set to “Yes“, this attribute makes the invoke function return
a "false" message if the target object does not exist. By using SkipFallback in
your script, you make it possible for the script to control what to do if the target
location does not exist.
By default, the fallback handles a non-existing target location as follows: If the
graphic is contained in a panel, the object opens in the workarea. If the graphic
is stand-alone, the object replaces the graphic.
Table: Invoke Function Attributes
Command Supported Attributes
OpenInFloatingWindow • Width
• Height
• Top
• Left
• ShowToolBar
OpenInTarget • Target
• DisplayName
• SkipFallback
• ShowToolbar
OpenInSelf • DisplayName
• ShowToolbar
04-16006-04-en, March 2015 Technical
1141
35 TGML Additions for Building Operation
35.5 Invoke Function
Continued
Command Supported Attributes
OpenInWorkArea • SkipFallback
• ShowToolbar
OpenInParent • DisplayName
• SkipFallback
• ShowToolbar
OpenInTop • SkipFallback
• ShowToolbar
OpenInNewWindow • ShowToolbar
Figure: Example of the invoke syntax where you want Trend Chart 1 to open in the pane
named TopPane. If TopPane does not exist in the panel of the graphic, Trend Chart 1 is to
be opened in a floating window. The display name is Graphic 1 and a toolbar is to be
hidden.
Important
The following attribute settings made in the graphic override the corresponding
attributes of the previously displayed object in the panel:
• DisplayName
• ShowToolbar
Technical 04-16006-04-en, March 2015
1142
35 TGML Additions for Building Operation
35.6 Panel Navigation
35.6 Panel Navigation
When you use graphics in a panel, you can configure in which target location a
target object linked to the graphic is to be opened when the user performs an
action on the graphic, for example, a mouse click. You configure the graphic in
Graphics Editor by adding an invoke function script. In WorkStation or WebStation,
you link the graphic to the target object you want to open when the user performs
the action.
A target object can be opened from a graphic in any of the following target
locations:
• Floating window
• New window
• Parent
• Self
• Target
• Top
• Work area
You can also use the invoke function script to give the user the ability to navigate
back and forward to a previously visited view.
04-16006-04-en, March 2015 Technical
1143
36 Graphics User Interface
Topics
Graphics Editor
Graphics Editor Menu Bar
Graphics Editor File Menu
Graphics Editor File Menu – New Submenu
File Menu – Open Submenu
File Menu – Save As Submenu
File Menu – Print Submenu
File Menu – Settings Submenu
Graphics Editor View Menu
Categories Context Menu
Graphics Editor Drawing Toolbar
Graphics Editor Options Toolbar
Components Pane
Graphics Editor Snippets Pane
Graphics Editor Panes
Graphics Editor Objects Pane
Graphics Editor Properties Pane
Graphics Editor Statistics Pane
Graphics Editor Test Pane
Graphics Editor Binds and Links Pane
Graphics Editor Layers Pane
Create Graphics Wizard - Basic Settings Page
Graphic Properties - Basic Tab
Graphic Properties – Bindings Tab
Graphic Properties – Links Tab
Graphic Properties - References Tab
Document Properties Dialog Box
Unsupported Characters
36 Graphics User Interface
36.1 Graphics Editor
36.1 Graphics Editor
Use the Graphics Editor main window to create, test, and save application
graphics.
Figure: Graphics Editor
Table: Graphics Editor Window
Number Description
Toolbars
Contain tools used to create and edit .tgml
files and other objects.
Work area
You can drag elements from the panes to
the work area. You can also draw free form
objects by using the drawing tools.
04-16006-04-en, March 2015 Technical
1147
36 Graphics User Interface
36.1 Graphics Editor
Continued
Number Description
Panes
Includes the following:
• Objects pane with a tree structure of
what is included in the graphic
• Properties pane where you edit the
properties of a selected object
• Layers pane where you manage layers
in a graphic
• Statistics Pane where you check the
efficiency of a graphic
• Binds and Links pane with
information on the bind objects
• Test pane where you test the behavior
of a graphic
• Components pane where you can
access standard components libraries
as well as components categories that
you have imported or created on your
own
• Snippets pane where you can access
standard snippets libraries as well as
snippets categories that you have
imported or created on your own
Technical 04-16006-04-en, March 2015
1148
36 Graphics User Interface
36.2 Graphics Editor Menu Bar
36.2 Graphics Editor Menu Bar
Use the menu bar to manage graphic files, and to toggle between different views of
the current graphic.
Figure: Graphics Editor menu bar
Table: Graphics Editor Menu Bar
Button Description
File
Click to open the File menu. For more
information, see section 36.3 “Graphics
Editor File Menu” on page 1149.
Save
Click to open the standard Save As
window.
Undo
Click to revert the graphic to the state it was
in before the latest performed command
was executed. Repeated use of Undo takes
you back in the changes history, all the way
to when the graphic file was opened.
Redo
Click to revert the graphic to the state it was
in before the latest Undo command.
Repeated use of Redo takes you forward in
the changes history, all the way to the most
recent change.
Magnification
Click to enter the percentage of
magnification of the work area.
Design
Click to open the current graphic's work
area for drawing and editing. It also displays
the tools on the drawing toolbar. Graphics
Editor opens in Design mode.
Source
Click to open the current graphic for tgml
text editing, by putting the cursor in the text.
Common text editing tools are made
available in the Options bar.
Preview
Click to open the current graphic to test
animations, bindings, and links.
04-16006-04-en, March 2015 Technical
1149
36 Graphics User Interface
36.2 Graphics Editor Menu Bar
Continued
Button Description
View
Click to open the View menu from which
you can select the panes you want to use in
Graphics Editor: Components, Snippets,
Statistics, Layers, Objects, Properties, Binds
and Links, and Test. You can also select Full
Screen mode. For more information, see
section 36.9 “Graphics Editor View Menu”
on page 1156.
Technical 04-16006-04-en, March 2015
1150
36 Graphics User Interface
36.3 Graphics Editor File Menu
36.3 Graphics Editor File Menu
Use the File menu to manage graphic files.
Figure: Graphics Editor File menu
Table: Graphics Editor File Menu
Command Description
New Opens a submenu where you can select if
you want to create a graphic or a
component.
Open Opens a submenu where you select a .tgml
graphic file or an .ogc file.
Save Saves the graphic as a Building Operation
object in the database.
Save As Opens a submenu where you select how the
current graphic file is to be saved. When you
use the Save As command to save a graphic
as a file, the link to Building Operation is
broken.
Import Opens a dialog box where you can locate
graphics files that you want to import into
Graphics Editor.
Export Exports a graphics file to the selected
location, under the name you enter, and in
the file format you specify.
Print Opens a submenu where you can make a
number of print preferences for printing the
active graphic or component.
Properties Opens the document properties pane. For
more information, see section 36.17
“Graphics Editor Properties Pane” on page
1172.
Settings Opens a submenu from which you access
user interface settings for Graphics Editor.
04-16006-04-en, March 2015 Technical
1151
36 Graphics User Interface
36.3 Graphics Editor File Menu
Continued
Command Description
Close Closes the current design and the editor in
which it is open. If you have several
instances of the editor open simultaneously,
only the current editor is closed.
Exit Exits all instances of the program.
Technical 04-16006-04-en, March 2015
1152
36 Graphics User Interface
36.4 Graphics Editor File Menu – New Submenu
36.4 Graphics Editor File Menu – New
Submenu
Use the New submenu to create a graphic or a component.
Figure: Graphics Editor File menu - New submen
Table: Graphics Editor File Menu - New Submenu
Command Description
Graphic Click to open a graphic workspace where
you create a new graphic. For more
information, see section 23.1 “Graphics
Editor Overview” on page 789.
Component Click to open a new component workspace
where you create a new component. For
more information, see section 23.1
“Graphics Editor Overview” on page 789.
04-16006-04-en, March 2015 Technical
1153
36 Graphics User Interface
36.5 File Menu – Open Submenu
36.5 File Menu – Open Submenu
Use the Open submenu to open .tgml or .ogc files in Graphics Editor.
Figure: Graphics Editor File menu - Open submenu
Table: Open Submenu
Command Description
File Click to open a graphics or components file
in .tgml or .ogc format.
Technical 04-16006-04-en, March 2015
1154
36 Graphics User Interface
36.6 File Menu – Save As Submenu
36.6 File Menu – Save As Submenu
Use the Save As submenu to save a graphics or components file.
Figure: Graphcis Editor File menu - Save As submenu
Table: Graphics Editor File Menu - Save As Submenu
Command Description
File Click to save the graphic as a .tgml file.
Component Click to save a component in a component
category.
04-16006-04-en, March 2015 Technical
1155
36 Graphics User Interface
36.7 File Menu – Print Submenu
36.7 File Menu – Print Submenu
Use the Print submenu to make settings that affect how a graphic or component is
printed.
Figure: Graphics Editor File menu - Print submenu
Table: Graphics Editor File Menu - Print Submenu
Command Description
Page settings Click to open a dialog box where you can set
paper size, source, orientation and margins.
Print preview Click to display a print preview of the page,
that is, a view of how the page appears
when printed.
Print Click to open the default Print dialog box
where you can select a printer, set the page
range, and set the number of copies you
want to print.
Technical 04-16006-04-en, March 2015
1156
36 Graphics User Interface
36.8 File Menu – Settings Submenu
36.8 File Menu – Settings Submenu
Use the Settings submenu to save settings you have made to the user interface or
to reset the user interface to the default settings.
Figure: Graphics Editor File menu - Settings submenu
Table: Graphics Editor File Menu - Settings Submenu
Command Description
Save settings Click to save customized settings that define
the size, position and visibility of the grid,
panes, magnification, tools options, and
columns. Snap to the grid is also saved.
Reset to default Click to reset the user interface to the default
settings.
04-16006-04-en, March 2015 Technical
1157
36 Graphics User Interface
36.9 Graphics Editor View Menu
36.9 Graphics Editor View Menu
Use the View menu to show or hide the Graphics Editor tabs and panes. From the
View menu, you can also toggle a graphic between full screen mode and
displaying it in the Graphics Editor window.
Figure: Graphics Editor View menu
Table: Graphics Editor View Menu
Command Description
Components Click to show or hide the Components tab
where you can access and manage
components.
Snippets Click to show or hide the Snippets tab where
you can access and manage snippets.
Layers Click to show or hide the Layers pane where
you can manage the layers of your graphic.
Objects Click to show or hide the Objects pane
where you can view the object tree with all
the elements included in the graphic.
Properties Click to show or hide the Properties pane
where you can view and set the properties of
a graphic.
Statistics Click to show or hide the Statistics pane
where you can view the efficiency of the
graphic.
Binds and Links Click to show or hide the Binds and Links
pane where you manage the binds and links
of the graphic.
Test Click to show or hide the Test pane where
you can test that your graphics functions
behave as expected.
Full Screen Click to view the graphic in full screen mode
or to revert to the Graphics Editor window.
Technical 04-16006-04-en, March 2015
1158
36 Graphics User Interface
36.10 Categories Context Menu
36.10 Categories Context Menu
Use the categories context menu to manage components and snippets categories.
Figure: Categories context menu
Table: Categories Context Menu
Command Description
Libraries Opens the Libraries dialog box where you
manage components and snippets libraries.
For more information, see section 24.11
“Snippets” on page 828.
Categories Opens the Categories dialog box where
you select or clear the components and
snippets categories that you want to be
displayed in the Components pane or
Snippets pane.
Import Opens an Explorer window where you can
import a components or snippets archive
file.
Export Opens an Explorer window where you can
save a components or snippets archive file.
New Category Opens the New Component Category or
the New Snippet Category dialog box
where you type a name for the new category
you want to create.
Delete Category Opens the Delete Category dialog box
where you confirm that you want to delete
the selected components or snippets
category.
Rename Category Opens the Rename Category dialog box
where you type a new name for the selected
components or snippets category.
Hide Category Hides the selected components or snippets
category in Graphics Editor.
04-16006-04-en, March 2015 Technical
1159
36 Graphics User Interface
36.11 Graphics Editor Drawing Toolbar
36.11 Graphics Editor Drawing Toolbar
Use the Drawing toolbar to access the tools you need to create and edit .tgml files
and other objects.
Figure: Graphics Editor Drawing toolbar
Table: Graphics Editor Drawing Toolbar
Button Description
Select
Click the border, or anywhere within a filled
object, to select the object.
Scroll
Click and drag to adjust the work area in the
pane.
Zoom
Click to display three zoom tools in the
Options bar: Restore original, Zoom In, and
Zoom Out.
Line
Click-drag-release in the work area to draw
a line between the two end points.
Polyline
Click a number of times in the work area to
draw a polyline between the click points.
Double-click to finish the polyline.
Curve
Click a number of times in the work area to
draw a curve between the click points.
Double-click to finish the curve.
Polygon
Click a number of times in the work area to
draw a polygone between the click points.
Double-click to finish the polygon.
Rectangle
Click and drag in the work area to open up a
rectangle between the two corner points.
Simultaneously, press SHIFT to open up a
square.
Ellipse
Click and drag in the work area to open up
an ellipse between the two size-determining
points. Simultaneously, press SHIFT to open
up a circle.
Technical 04-16006-04-en, March 2015
1160
36 Graphics User Interface
36.11 Graphics Editor Drawing Toolbar
Continued
Button Description
Arc
Click and drag in the work area to open up
an arc between the two size-determining
points. Simultaneously, press SHIFT to open
up a quarter of a circle. For more
information, see section 33.19 “Pies” on
page 988.
Pie
Click and drag in the work area to open up a
pie (filled arc) between the two size-
determining points. Simulataneously, press
SHIFT to open up a quarter of a pie. For
more information, see section 33.19 “Pies”
on page 988.
Text
Click in the work area to position the start
point of a text string. Type the text and press
ENTER.
Textbox
Click and drag in the work area to open up a
rectangular text box between the two corner
points. Simultaneously, press SHIFT to open
up a square. Type the text and press
ENTER.
Insert Picture
Click in the work area to position the upper
left corner of a picture insert. An Open
window lets you browse to the desired
picture file.
Cut
Click to remove the selected object from the
graphic. The object is temporarily stored on
the clipboard.
Copy
Click to save a copy of the selected object
on the clipboard.
Paste
Click to create a copy of the object residing
on the clipboard. The copy is displayed on
the graphic slightly displaced from the
original, or from any previous copy.
Delete
Click to delete the selected object from the
graphic. The clipboard is not affected.
04-16006-04-en, March 2015 Technical
1161
36 Graphics User Interface
36.11 Graphics Editor Drawing Toolbar
Continued
Button Description
Show Grid
Click to toggle between show and hide grid.
Select a grid size value from the adjacent
combo box.
Snap to Grid
Click to toggle between enabling and
disabling the snap objects to the grid
function.
Technical 04-16006-04-en, March 2015
1162
36 Graphics User Interface
36.12 Graphics Editor Options Toolbar
36.12 Graphics Editor Options Toolbar
Use the Options toolbar to specify properties, or perform commands that become
available when you have selected a tool on the toolbar.
Figure: Graphics Editor Options toolbar
Table: Graphics Editor Options Toolbar
Button Description
Point Selection
Click the border, or anywhere within a filled
object, to select the object and display the
curve points.
Rotate Selection
Click to rotate the selected object by
dragging the handle that is displayed at the
top of the object.
Fill Select the required fill color or gradient from
the palette. For more information, see
section 30.26 “Gradients” on page 925.
Swap Colors
Click to swap the current colors of the stroke
and the fill.
Stroke Select the required stroke color or gradient
from the palette. For more information, see
section 30.26 “Gradients” on page 925.
Style Select the required stroke style from the list.
Width Select the required stroke width, 0–30
pixels, from the list.
Corner Select the required corner radius, 0–50
pixels, from the list.
Group
Click to group the selected objects in the
work area.
Ungroup
Click to ungroup objects that were
previously grouped.
Align
Select the required alignment of two or more
objects from the list: left, center, right, top,
middle, bottom, or center and middle.
04-16006-04-en, March 2015 Technical
1163
36 Graphics User Interface
36.12 Graphics Editor Options Toolbar
Continued
Button Description
Arrange
Select the required arrangement of an object
relative to other objects, from the list.
Distribute
Select the required distribution of three or
more objects, in the horizontal or vertical
direction, from the list.
Flip
Select the required flip operation of the
selected object, in the horizontal or vertical
direction, from the list.
Resize
Select the required resize operation of two or
more objects from the list: same width,
height, or width and height.
Rotate Left
Click to rotate objects (single or group) 90°
left.
Rotate Right
Click to rotate objects (single or group) 90°
right.
Skew Horizontal
Click to skew the objects (single or group)
horizontally to ±60°, ±45°, ±30°, or ±15°.
Skew Vertical
Click to skew the objects (single or group)
vertically to ±60°, ±45°, ±30°, or ±15°.
Font
Select the required font family from the list.
Size
Select the required font size, 8–100 pixels,
from the list.
Bold
Click to make the characters of the selected
text string or text box bold.
Italic
Click to make the characters of the selected
text string or text box italic.
Technical 04-16006-04-en, March 2015
1164
36 Graphics User Interface
36.12 Graphics Editor Options Toolbar
Continued
Button Description
Underline
Click to make the characters of the selected
text string or text box underlined.
Strikethrough
Click to display the characters of the
selected text string or text box with
strikethrough.
Text
Click to align the text to the left based on the
insertion point of the text row.
Textbox
Click to align the text to the left in the text
box.
Text
Click to center the text based on the
insertion point of the text row.
Textbox
Click to center each text row in the textbox.
Text
Click to align the text to the left based on the
insertion point of the text row.
Textbox
Click to align the text to the right in the text
box.
Text
Click to align the top of the text to the
insertion point.
Textbox
Click to align the text to the top of the
textbox
Text
Click to align the middle of the text to the
insertion point.
Textbox
Click to align the text in the middle of the
texbox.
04-16006-04-en, March 2015 Technical
1165
36 Graphics User Interface
36.12 Graphics Editor Options Toolbar
Continued
Button Description
Text
Click to align the bottom of the text to the
insertion point.
Textbox
Click to align the text to the bottom of the
textbox.
Technical 04-16006-04-en, March 2015
1166
36 Graphics User Interface
36.13 Components Pane
36.13 Components Pane
Use the Components pane to access components and manage components
categories.
Figure: Graphics Editor Components pane
Table: Graphics Editor Components Pane
Number Description
Basic Controls
This category contains standard controls
delivered with the program.
DIN Symbols
Standardized DIN control symbols.
ISO Symbols
Standardized ISO control symbols.
04-16006-04-en, March 2015 Technical
1167
36 Graphics User Interface
36.13 Components Pane
Continued
Number Description
My Components
This category is where you add customized
components that you want to reuse in the
future.
Technical 04-16006-04-en, March 2015
1168
36 Graphics User Interface
36.14 Graphics Editor Snippets Pane
36.14 Graphics Editor Snippets Pane
Use the Graphics Editor Snippets pane to manage function categories.
Figure: Graphics Editor Snippets pane
Tip
• To get a description of a snippet, right-click the snippet in the list, and then
click Properties.
Table: Graphics Editor Snippets Pane
Number Description
Basic Functions
This category contains standard functions
delivered with the program.
04-16006-04-en, March 2015 Technical
1169
36 Graphics User Interface
36.14 Graphics Editor Snippets Pane
Continued
Number Description
My Snippets
This category is where you save customized
functions that you want to reuse in the
future.
Technical 04-16006-04-en, March 2015
1170
36 Graphics User Interface
36.15 Graphics Editor Panes
36.15 Graphics Editor Panes
Use the Graphics Editor panes to manage graphics and components.
Figure: Graphics Editor panes
Table: Graphics Editor Panes
Number Description
Layers
Use the Layers pane to manage layers in a
graphic.
Objects
Use the Objects pane tree structure to
navigate among the objects that make up a
graphic or a component.
Properties
Use the Properties pane to view and edit
the properties of a graphic or a component.
Statistics
Use the Statistics pane to test the
performance of a graphic.
04-16006-04-en, March 2015 Technical
1171
36 Graphics User Interface
36.15 Graphics Editor Panes
Continued
Number Description
Test
Use the Test pane to test the behavior of a
graphic or a component.
Binds and Links
Use the Binds and Links pane to manage
and test the binds and links of a graphic or a
component.
Snippets
Use the Snippets pane to access and
manage functions.
Components
Use the Components pane to access and
manage components.
Technical 04-16006-04-en, March 2015
1172
36 Graphics User Interface
36.16 Graphics Editor Objects Pane
36.16 Graphics Editor Objects Pane
Use the Objects pane to get an overview of the structure of a graphic and all its
objects, graphical and non-graphical. You can also use the Objects pane to
manage objects.
Figure: Graphics Editor Objects pane with the Tgml tree structure
Table: Graphics Editor Objects Pane
Button Description
Expand All
Click to show all branches in the Tgml tree.
Collapse All
Opens the standard Save As window.
Move Up
Moves the selected object upward in the
Tgml tree.
Move Down
Moves the selected object down in the Tgml
tree.
04-16006-04-en, March 2015 Technical
1173
36 Graphics User Interface
36.17 Graphics Editor Properties Pane
36.17 Graphics Editor Properties Pane
Use the Properties pane to view and edit properties of the objects present in the
work area.
Figure: Graphics Editor Properties pane
Table: Graphics Editor Properties Pane
Button Description
Normal
Click to display a selection of commonly
used properties.
Detailed
Click to display all properties.
Which properties that are displayed in the Properties pane depends on the objects
included in the graphic. Graphics properties define the appearance, boundary, and
behavior of the graphic.
Technical 04-16006-04-en, March 2015
1174
36 Graphics User Interface
36.18 Graphics Editor Statistics Pane
36.18 Graphics Editor Statistics Pane
Use the Statistics pane to get information on the performance of your graphics
and components.
Figure: Statistics pane
Table: Graphics Editor Statistics Pane
Component Description
Loading Parse time displays the time it takes to
load the graphic file. Small files load quickly
whereas large files take longer to load. If the
loading process takes long, you should
consider reducing the amount of figures
included in the graphic.
Script setup and document load display
the amount of time it takes to load Script
blocks, initiate and start the script engine,
and execute the OnDocumentLoad scripts.
If this takes too long, you can consider
reducing the amount of OnDocumentLoad
scripts and the total number of Script blocks
in the graphic. Complex OnDocumentLoad
scripts delay the opening of the graphic.
04-16006-04-en, March 2015 Technical
1175
36 Graphics User Interface
36.18 Graphics Editor Statistics Pane
Continued
Component Description
Rendering Initial render time displays the time it
takes to draw the graphics file the first time,
that is, the time it takes for the system to
draw all the graphic figures. The more
complex the graphic is, the longer it takes to
render.
Average render time in sample displays
the time it takes to update the graphic in run
time. The result is updated every second.
The average rendering time and the
maximum rendering time are displayed.
Drawing efficiency The bar indicates the performance of the
graphic:
• Green = Excellent performance
• Yellow = Acceptable. Consider
simplifying the graphic.
• Red = The graphic could be perceived
as slow. Simplify the graphic.
Update Click to analyze all the scripts and refresh the
view to show all global variables, that is,
variables not declared as 'var'.
Validate Click to analyze the found Global script
variables and notify which variables are in
conflict with reserved names.
Technical 04-16006-04-en, March 2015
1176
36 Graphics User Interface
36.19 Graphics Editor Test Pane
36.19 Graphics Editor Test Pane
Use the Test pane to test the dynamic behavior in Preview mode.
Figure: Graphics Editor Test pane
Table: Graphics Editor Test Pane
Component Description
Name The name of the object you are testing.
Value Tests a bind, that is, a dynamic behavior.
Enter a value to start the test.
Unit Tests the unit management under the
condition that you have used getUnit in
your scripts. Enter any text.
Status Simulates signal status. "Value from device"
is the normal status.
04-16006-04-en, March 2015 Technical
1177
36 Graphics User Interface
36.20 Graphics Editor Binds and Links Pane
36.20 Graphics Editor Binds and Links Pane
Use the Binds and Links pane to get an overview of the binds and links used in a
graphic and their properties.
Note
• The actual binding and linking are perfomred in WorkStation.
Figure: Graphics Editor Binds and Links pane
Table: Graphcis Editor Binds and Links Pane
Column Description
Name Displays the name of the bind/link,
consisting of the object’s name and, for the
binds, a suffix normally ‘Value’. Name also
shows the number of bind values or link
targets that use this name. (One signal can
affect several properties.)
Attribute Displays the property (if present) that is
affected by the bound value.
Format None or Presentation. As selected in the
Properties pane, under Behavior - Format.
Description Displays an optional descriptive text.
Technical 04-16006-04-en, March 2015
1178
36 Graphics User Interface
36.21 Graphics Editor Layers Pane
36.21 Graphics Editor Layers Pane
Use the Layers pane to manage layers in a graphic.
Figure: Graphics Editor Layers pane
Table: Graphics Editor Layers Pane
Button Description
New layer
Click to create a new layer.
Duplicate layer
Click to duplicate the current layer.
Merge layer
Click to merge the selected layers.
Delete layer
Click to delete the current layer.
Move up
Moves the selected layer upward in the layer
pane.
Move down
Moves the selected layer down in the layer
pane.
Table: Layers Pane
Column Description
1st column Click to select the active layer. For more
information, see section 31.1 “Layers” on
page 945.
2nd column Displays the graphics contents of the layer.
04-16006-04-en, March 2015 Technical
1179
36 Graphics User Interface
36.21 Graphics Editor Layers Pane
Continued
Column Description
3rd column Displays the name of the layer (the Name
property).
4th column Select to make the layer visible.
Technical 04-16006-04-en, March 2015
1180
36 Graphics User Interface
36.22 Create Graphics Wizard - Basic Settings Page
36.22 Create Graphics Wizard - Basic Settings
Page
Use the Basic Settings page to enter a tgml file if you want to use a pre-existing
graphic. You can also leave this empty if the tgml file has not yet been created.
Figure: Basic Settings page
Table: Basic Settings Page
Property Description
File Enter a tgml file if you want to use a pre-
existing graphic.
04-16006-04-en, March 2015 Technical
1181
36 Graphics User Interface
36.23 Graphic Properties - Basic Tab
36.23 Graphic Properties - Basic Tab
Use the Graphic properties Basic tab to select a new TGML file to present in the
graphic viewer.
Figure: Basic tab
Table: Basic Tab
Property Description
File Enter the graphic file you want to display in
the graphic viewer. For more information,
see section 23.3 “Graphics in WorkStation”
on page 794.
Technical 04-16006-04-en, March 2015
1182
36 Graphics User Interface
36.24 Graphic Properties – Bindings Tab
36.24 Graphic Properties – Bindings Tab
Use the Bindings tab to view and edit the bindings of the graphic.
Figure: Bindings tab
Table: Bindings Tab
Property Description
[Binding name] Enter the path to the object to which you
want to bind the graphic. For more
information, see section 15.1 “Bindings
Overview” on page 411.
04-16006-04-en, March 2015 Technical
1183
36 Graphics User Interface
36.25 Graphic Properties – Links Tab
36.25 Graphic Properties – Links Tab
Use the Links tab to view and edit the links of the graphic.
Figure: Links tab
Table: Links Tab
Property Description
[Link name] Enter the path to the object to which you
want to link the graphic. For more
information, see section 28.1 “Binds and
Links” on page 871.
Technical 04-16006-04-en, March 2015
1184
36 Graphics User Interface
36.26 Graphic Properties - References Tab
36.26 Graphic Properties - References Tab
Use the References Properties to view and access the references of the graphic.
Figure: References tab
04-16006-04-en, March 2015 Technical
1185
36 Graphics User Interface
36.27 Document Properties Dialog Box
36.27 Document Properties Dialog Box
Use the Document Properties dialog box to view, enter, or edit details on the
creation of the TGML graphic.
Figure: Document Properties dialog box
Table: Document Properties Dialog Box
Component Description
TGML version Displays the TGML version of the TGML
graphic.
Title View, add, or edit the title of the TGML
graphic.
Author View, add, or edit the name of the author
who created the TGML graphic.
Company View, add, or edit the name of the company
the author belongs to.
Created Displays the date the TGML graphic was
created.
Modified Displays the date the TGML graphic was
modified.
Revision View, add, or edit the document revision
number.
Comments View, add, or edit the document comments.
Technical 04-16006-04-en, March 2015
1186
36 Graphics User Interface
36.28 Unsupported Characters
36.28 Unsupported Characters
Object names cannot include any of the following characters: exclamation point (!),
quotation mark (“), number sign (#), percent sign (%), ampersand (&), apostrophe ('),
left parenthesis ((), right parenthesis ()), asterisk (*), plus sign (+), comma (,), hyphen-
minus (-), full stop (.), semicolon (;), less than sign (<), greater than sign (>), equals
sign (=), question mark (?), backslash (\), or pipe symbol (|).
In addition, the following restrictions apply:
• Object names can contain full stops (.), however, leading and trailing full stops
(.) are not supported in object names.
• Leading and trailing spaces are automatically removed from object names.
• You cannot create an object with an empty name.
• You cannot create an object with a name beginning with a question mark (?).
This applies for all property values.
• You cannot create an object with a name beginning with a dollar sign ($).
04-16006-04-en, March 2015 Technical
1187
37 Function Block Introduction
Topics
Graphical Programming
Function Block Editor Overview
Function Block Workflow
Function Block Editor File Type
Function Block Editor Shortcut Keys
Programming Hints
Units of Measure
Function Block Diagram Structure
Programming Phases
Design Phase
Operation Modes
37 Function Block Introduction
37.1 Graphical Programming
37.1 Graphical Programming
When you program a function block program using Function Block Editor, you
define the function block program graphically in the function block diagram. The
function block diagram has two fundamental elements:
• Function blocks, which process the data
• Connections, which transport the signals
37.1.1 How a Function Block Program Works
In a function block program, the input signals to the blocks are processed and
generated into a single output signal.
Each function block can have one or several parameters that process the input
signals. The parameters can be defined as numerical values or as identifiers
(constants).
The output signal is forwarded to other blocks. The signal follows the route defined
by the connections, which represent the data flow during the program execution.
The data normally flows left-to-right in the diagram: An exception to this rule is when
a connection is used to close a feedback loop. In this case, the data flows back to
complete a loop.
Figure: A simple function block diagram (FBD)
In general, blocks with no inputs (source blocks) are located on the left in the
diagram.
Blocks with no outputs connected to other blocks (destination blocks) are often
placed to the right in the diagram.
Intermediate blocks, which make calculations and logical decisions, are placed
between the source blocks and the destination blocks. These intermediate blocks
are oriented in the direction of the data flow.
A function block program is cyclic and is executed at a constant time interval, called
the program cycle. During each program cycle, source blocks send data to the
intermediate blocks, which then send data to the destination blocks.
37.1.2 Printouts of Function Block Programs with
Multiple Pages
Boundary ties are cross references at both ends of a connection that crosses
pages. The boundary ties are useful when you prepare a printout of a function block
program with multiple pages. Boundary ties indicate where the signal continues in a
three-position format, separated by a dot: x-axis.y-axis.page. Boundary ties are
automatically created but can be manually moved and deleted.
04-16006-04-en, March 2015 Technical
1191
37 Function Block Introduction
37.2 Function Block Editor Overview
37.2 Function Block Editor Overview
Function Block Editor is a graphical programming tool for Automation Servers,
which you use to create function block programs that control and monitor building
automation systems. For example, you create a basic program, called OfficeLight,
to control lighting in a room based on occupancy.
Important
Ensure that you have a working and available Function Block Editor license. A
working license is required to start the Function Block Editor software. For more
information, see the Licenses topic on WebHelp.
When you open your new OfficeLight program in Function Block Editor, you begin
by adding function blocks based on the type of action you wish the program to
perform. You then connect the blocks. For more information, see section 37.1
“Graphical Programming” on page 1189.
When you have finished the graphical programming, you create points in
WorkStation. You then bind the signals of the function block program to those
points to view the output.
When you are finished, you use the Function Block Editor Simulation mode to check
the program for errors and save the program.
In WorkStation, in the Properties pane, you select the task in which you want to
include your programs. You then execute your function block program.
For more information, see section 37.3 “Function Block Workflow” on page 1191.
You can store your function block programs and include them later in projects for
use in your control system. By putting small function block programs together, you
can create function block programs that perform anything from simple to very
complex operations, such as lighting, boilers, and air handling units at multiple sites.
Technical 04-16006-04-en, March 2015
1192
37 Function Block Introduction
37.3 Function Block Workflow
37.3 Function Block Workflow
The function block workflow enables you to create (and edit) function block
programs in Building Operation.
The following flowchart describes the basic steps required to create (or edit) a
function block program. Related information can be found in the sections after the
flowchart. If you want to edit an existing function block program, select the program
in the Automation Server and then continue from the second step.
04-16006-04-en, March 2015 Technical
1193
37 Function Block Introduction
37.3 Function Block Workflow
Figure: Function block workflow
Create a function block program
In WorkStation, create a function block program under an Automation Server.
Technical 04-16006-04-en, March 2015
1194
37 Function Block Introduction
37.3 Function Block Workflow
For more information, see section 38.3 “Creating a Function Block Program” on
page 1211.
Open Function Block Editor
In WorkStation, open Function Block Editor so that you can edit the program.
For more information, see section 38.8 “Editing a Function Block Program” on page
1218.
Add, name, and connect function blocks
In Function Block Editor, in Edit mode, add, name, and connect function blocks.
Edit library programs as required.
For more information, see section 47.2 “Adding a Simple Block” on page 1373.
For more information, see section 48.2 “Adding an Operator” on page 1484.
For more information, see section 46.2 “Adding an Expression Block” on page
1353.
For more information, see section 39.11 “Naming a Function Block” on page 1256.
For more information, see section 45.3 “Connecting a Block Output to a Block
Input” on page 1337.
Open the program in Simulation mode
In Function Block Editor, open the program in Simulation mode.
For more information, see section 44.2 “Changing to Simulation Mode” on page
1308.
Test and verify the program
In Simulation mode, execute the program for one or more cycles, for different input
values.
For more information, see section 44.7 “Starting a Simulation” on page 1313.
For more information, see section 44.5 “Simulating One Cycle Only” on page 1311.
For more information, see section 44.6 “Simulating a Defined Number of Cycles” on
page 1312.
Change the program to Edit mode
Change to Edit mode so that you can save the program.
For more information, see section 39.2 “Changing to Edit Mode” on page 1246.
Save program to server
In Function Block Editor, in Edit mode, save the tested program to the Automation
Server.
For more information, see section 38.11 “Saving a Function Block Program” on
page 1223.
Bind inputs and outputs
In WorkStation, bind the inputs and outputs of the program to I/O bus variables.
For more information, see section 38.9 “Binding a Function Block Program to I/Os”
on page 1219.
04-16006-04-en, March 2015 Technical
1195
37 Function Block Introduction
37.3 Function Block Workflow
Select a task and execute the program
In WorkStation, select the function block execution frequency (the task) and
execute the program.
For more information, see section 50.24 “Adding a Task to a Program” on page
1603.
Technical 04-16006-04-en, March 2015
1196
37 Function Block Introduction
37.4 Function Block Editor File Type
37.4 Function Block Editor File Type
A Function Block Editor .AUT file is the data file type used for creating a function
block program for an Automation Server.
The .AUT file is a text file with function block program source code and data
including a graphical block diagram. When you save a function block program from
Function Block Editor, it is saved to the function block program object in the
Building Operation database. To use the file outside Building Operation, you need
to export the text file.
.MTA
An .MTA file can be imported into Function Block Editor but, when saved, it is
converted into an .AUT file.
04-16006-04-en, March 2015 Technical
1197
37 Function Block Introduction
37.5 Function Block Editor Shortcut Keys
37.5 Function Block Editor Shortcut Keys
You can use shortcut commands to make the work in Function Block Editor more
efficient.
In Edit mode the following commands are available:
Table: Shortcut Commands in Edit Mode
Key Function
F7 Open the Search dialog box.
F8 Open the Replace dialog box.
F9 Center a selection in the diagram window.
F12 Change to Simulation mode.
In Simulation mode the following commands are available:
Table: Shortcut Commands in Simulation Mode
Key Function
F2 Start and stop a simulation.
F5 Change to table view.
F7 Open the Search dialog box.
F12 Change to Edit mode.
Technical 04-16006-04-en, March 2015
1198
37 Function Block Introduction
37.6 Programming Hints
37.6 Programming Hints
To make your programming tasks in Function Block Editor more efficient, use these
hints.
37.6.1 Program Cycle Time
The cycle time for the function block program is variable. Take this into account
when drawing your function block program.
For example, you can use the INTEG block to calculate Energy consumption from
the input Power. When resetting the block at the start of a new calculation interval,
the reset value must be the input signal multiplied by the program cycle time.
37.6.2 Time Counter
The time counter counts in seconds, which takes care of the actual function block
program cycle time. The counter is reset by a binary signal.
Figure: Time counter
You can also make Time counters by using the PULSE and RT blocks. Designs
using RT and INTEG can be reset during the count. You can use the INTEG counter
when counting something, such a time or power, over time.
37.6.3 Equality
When testing whether two values are equal, ensure that the tested values are of the
Binary or Integer type. Do not carry out an equal test on Real values.
37.6.4 Reset Counter
You can use the RST, for example, to reset an energy counter without losing any
pulses during the reset:
Figure: Reset a counter
04-16006-04-en, March 2015 Technical
1199
37 Function Block Introduction
37.6 Programming Hints
37.6.5 Bitwise Operators
The output of the bitwise AND (&) operator is an integer that represents the result of
the AND operation on two analog signals. By using this operation inside an
expression block with a binary output and assigning the result of the AND operation
to the output, you obtain a binary signal that is zero if there is no match and one as
soon as there is a match in at least one bit position.
37.6.6 Sliding Average Value
You use sliding average values to display previous values.
Programming example of the sliding average of three values:
Figure: Sliding average value
37.6.7 Time Shift
You can detect a time shift, if the latest displayed time has a lower value than the
previously displayed time. A lower value of an HOUR block indicates a day shift, a
lower value in a MINUTE block indicates an hour shift, and a lower value in a
SECOND block indicates a minute shift.
Figure: A lower value in an HOUR block indicates a day shift
37.6.8 Expression Blocks
You cannot change the output type of an expression block when the output is
connected to a node.
Expression blocks can be used to convert from a Real signal to an Integer signal
and vice versa:
Technical 04-16006-04-en, March 2015
1200
37 Function Block Introduction
37.6 Programming Hints
Figure: Expression blocks
If the expression block contains an IF-THEN-ELSE statement, both the IF and the
ELSE part of the statement are calculated each cycle.
37.6.9 Start-Up Delay
Use the RST block to create a start-up delay following a warm start of the device.
Use different delays for different AHUs by altering the DelayOff time (60 s in the
example):
Figure: Start-Up delay
04-16006-04-en, March 2015 Technical
1201
37 Function Block Introduction
37.7 Units of Measure
37.7 Units of Measure
In Function Block Editor, a number of blocks use either the SI unit system or the
imperial unit system. SI units are the metric units and imperial units are the inch-
pound units.
The regional settings of the Windows operating system that is used to create the
function block program, determines the units of measure for some blocks. The
definition of the signal determines the units of measure for other blocks.
Technical 04-16006-04-en, March 2015
1202
37 Function Block Introduction
37.8 Function Block Diagram Structure
37.8 Function Block Diagram Structure
In a function block diagram (FBD), the function blocks process input signals and
generate a single output signal. During the program execution, the output signal is
forwarded to other blocks by using connections that represent the data flow from
left to right.
The first step when structuring is to make an outline structure by:
• Identifying the main functions, and
• Determine where to graphically locate these function groups in relation to each
other.
The grouping can be done in several ways. The most important thing is to make the
FBD easy to understand. Function blocks that perform a function together should
preferably be located together.
The second step is to graphically locate the groups. Create a left-to-right logical
sequence in the FBD. If there is a connection between two groups, place a group
that delivers an output to the left of a group that receives an input. To standardize
this, we recommend a logical order from left-to-right: START CONDITION - STOP
CONDITION - GENERAL CONTROL - PID CONTROL SEQUENCES - ALARM
HANDLING.
Figure: Left-to-right logical sequence
Use the following rules of thumb when you locate blocks and groups:
• Enter a framed comment containing the last edition date of the FBD in the
upper left corner. History notes, describing the revision, can also be included.
Update this information whenever you make a program revision.
• Try to structure every page so that the physical input blocks are arranged in a
column to the left, and the physical output blocks in a column to the right.
• Adjust the function block diagram to the page break lines, to make a printout
legible.
• Make space between the groups so that it is possible to add connections and
additional functions.
• Add new pages to the right when necessary, but try to use only one page in a
vertical direction.
• Locate connections like a bus with common left-to-right connections at the top
of the diagram. Avoid mixing connections running in opposite directions. Put
connections running in opposite directions in a separate bus at the bottom of
the page. Mark the direction of these signals.
• Reuse tested macros from the Macro Block Library or your own library as often
as possible.
• Structure the function block program so that all public signals that you want to
display together belong to the same module (and have the same module
name).
04-16006-04-en, March 2015 Technical
1203
37 Function Block Introduction
37.8 Function Block Diagram Structure
Figure: Page breaks have to be adjusted to make printouts easy to read
Technical 04-16006-04-en, March 2015
1204
37 Function Block Introduction
37.9 Programming Phases
37.9 Programming Phases
When you program an Automation Server, the work can be divided into three
fundamental phases:
• Function phase: analyze the requirements
• Design phase: program the function block program
• Test phase: simulate the functionality of the function block program
37.9.1 Function Phase
In the function phase, you read and analyze the functional specification. You add
your analysis and form an overall solution. In this phase, you sometimes need to
acquire more data regarding parts of the installation that affect the programming.
An important part of this phase is to locate function block programs that are ready
to use or that only require small changes, in the folder where you store your function
block programs.
37.9.2 Design Phase
During the Design phase, you start working in Function Block Editor. You identify
points, name the points, and allocate them. You plan the structure of the function
block program and finally build your function block program in Function Block
Editor.
37.9.3 Test Phase
During the test phase you can test a function block program in two ways:
• In Simulation mode in Function Block Editor.
• As a final system test where you download the complete function block
program to an Automation Server and test it.
04-16006-04-en, March 2015 Technical
1205
37 Function Block Introduction
37.10 Design Phase
37.10 Design Phase
During the Design phase, you start working in Function Block Editor. You identify
points, name the points, and allocate them. You plan the structure of the function
block program and finally build your function block program in Function Block
Editor.
37.10.1 Point Identification and Allocation
The importance of a good point allocation is often underestimated. There is a very
close relationship between a well-prepared point allocation and the efficiency that
can be achieved later on in the project.
With good point allocation, copying techniques can substantially reduce the
engineering hours needed for the design and manufacturing of electrical panels.
Installation and commissioning work benefits from efficient point allocation.
37.10.2 Points and Alarms Naming Conventions
The naming of points and signals is an important part of design work. I/O and
signals are best given names that are descriptive and easy to recognize. The
customer or end user has often specific demands on the use of acronyms or
designations. The same applies, even in a higher degree, for alarm texts.
37.10.3 The Function Block Diagram Structure
In a function block diagram (FBD), the function blocks process input signals and
generate a single output signal. During the program execution, the output signal is
forwarded to other blocks by using connections that represent the data flow from
left to right.
For more information, see section 37.8 “Function Block Diagram Structure” on page
1201.
Technical 04-16006-04-en, March 2015
1206
37 Function Block Introduction
37.11 Operation Modes
37.11 Operation Modes
In Function Block Editor, there are two modes to choose from depending on if you
are programming a function block program or if you are testing a function block
program.
37.11.1 Edit Mode
You use Edit mode when designing the function block program. In Edit mode you
add and edit blocks and connections.
For more information, see section 39.1 “Edit Mode” on page 1245.
37.11.2 Simulation Mode
You use Simulation mode to test and troubleshoot function block programs and to
show the state of the signals. You can run Simulation mode without a connected
Automation Server.
For more information, see section 44.1 “Simulation Mode” on page 1307.
04-16006-04-en, March 2015 Technical
1207
38 Function Block Programs
Topics
Function Block Programs in WorkStation
Function Block Program Printouts
Creating a Function Block Program
Function Block Program Import
Importing Function Block Program Code
Exporting Function Block Program Code
Opening a Function Block Program
Editing a Function Block Program
Binding a Function Block Program to I/Os
Binding Values Using a Binding Template
Saving a Function Block Program
Tasks
Adding a Task to a Program
Program Cycles in Building Operation
Configuring the Execution Precedence for a Program
Finding Cycles in a Task
Module Names
Default Names
Adding and Editing the Module Name
Adding Default Names to Function Blocks
Searching for a Text String
Replacing a Text String
Program Conversion
Importing a Xenta 280/300/401 Program
38 Function Block Programs
38.1 Function Block Programs in WorkStation
38.1 Function Block Programs in
WorkStation
You create function block programs in WorkStation. In WorkStation, function block
programs are represented by a designated icon. At this stage, the function block
program is empty, that is, it contains no function blocks or source code of any kind.
Figure: Function Block programs in WorkStation
Function Block Editor starts automatically when you use the Edit command on a
function block program from WorkStation.
04-16006-04-en, March 2015 Technical
1211
38 Function Block Programs
38.2 Function Block Program Printouts
38.2 Function Block Program Printouts
In Function Block Editor, you can print function block programs. You use the Print
dialog box to determine what you want to include in the printout and the Page
Setup dialog box to set up the appearance of the printout. If you make a selection,
only the selected blocks are printed.
Technical 04-16006-04-en, March 2015
1212
38 Function Block Programs
38.3 Creating a Function Block Program
38.3 Creating a Function Block Program
You create a Function Block program to import existing program code or to
program new logic for the Automation Server using Function Block Editor.
For more information, see section 37.1 “Graphical Programming” on page 1189.
To create a function block program
1. In WorkStation, in the System Tree pane, select the server or folder where
you want to create the function block program.
2. On the File menu, point to New and then click Program.
3. In the object type list, select Function Block Program.
4. In the Name box, type a name for the function block program.
Continued on next page
04-16006-04-en, March 2015 Technical
1213
38 Function Block Programs
38.3 Creating a Function Block Program
5. In the Description box, type a description for the function block program.
6. Click Create.
Technical 04-16006-04-en, March 2015
1214
38 Function Block Programs
38.4 Function Block Program Import
38.4 Function Block Program Import
You can import and reuse a function block program that has been exported from
Function Block Editor and saved at an earlier stage. For more information, see
section 38.5 “Importing Function Block Program Code” on page 1214.
04-16006-04-en, March 2015 Technical
1215
38 Function Block Programs
38.5 Importing Function Block Program Code
38.5 Importing Function Block Program Code
You import function block program code to reuse all or parts of existing code.
Function Block Editor supports import of .aut and .mta files created for Xenta
280/300/400 LonWorks devices in Menta Editor, as well as .aut file previously
created in Function Block Editor.
For more information, see section 37.1 “Graphical Programming” on page 1189.
To import function block program code
1. In WorkStation, in the System Tree pane, select the function block program
you want to import program code to.
2. On the Actions menu, click Edit.
3. In Function Block Editor, on the File menu, click Import.
4. Select the file you want to import.
5. Click Open.
Continued on next page
Technical 04-16006-04-en, March 2015
1216
38 Function Block Programs
38.5 Importing Function Block Program Code
6. On the File menu, click Save.
Tip
• When a Menta file is imported, TSCH blocks and ALARM blocks
are removed, AI/DI blocks are converted to RI/BI blocks, and
AO/DO blocks are converted to RO/BO blocks. As a result of
these conversions, you may need to make adjustments to the
imported Menta code.
04-16006-04-en, March 2015 Technical
1217
38 Function Block Programs
38.6 Exporting Function Block Program Code
38.6 Exporting Function Block Program Code
You export function block program code to an .aut file when you want to save a
copy of the program code, which can be imported into Function Block Editor and
reused for other function block programs.
For more information, see section 37.1 “Graphical Programming” on page 1189.
To export function block program code
1. In Function Block Editor, on the File menu, click Export.
2. In the File name box, type a path and file name for the export file.
3. Click Save.
Technical 04-16006-04-en, March 2015
1218
38 Function Block Programs
38.7 Opening a Function Block Program
38.7 Opening a Function Block Program
You open a function block program to view its properties.
For more information, see section 38.1 “Function Block Programs in WorkStation”
on page 1209.
To open a function block program
1. In WorkStation, in the System Tree pane, click the function block program
you want to open.
2. On the File menu, click Open.
04-16006-04-en, March 2015 Technical
1219
38 Function Block Programs
38.8 Editing a Function Block Program
38.8 Editing a Function Block Program
You edit a function block program in Function Block Editor to modify the function
block program logic.
For more information, see section 37.2 “Function Block Editor Overview” on page
1190.
Important
Ensure that you have a working and available Function Block Editor license. A
working license is required to start the Function Block Editor software. For more
information, see the Licenses topic on WebHelp.
To edit a function block program
1. In WorkStation, in the System Tree pane, select the function block program.
2. On the Actions menu, click Edit.
The function block program opens in Function Block Editor where you can edit it.
Technical 04-16006-04-en, March 2015
1220
38 Function Block Programs
38.9 Binding a Function Block Program to I/Os
38.9 Binding a Function Block Program to
I/Os
You bind a function block program to I/Os to connect the inputs and outputs of a
function block program to variables in an Automation Server. For more information,
see the I/O Bus Overview topic on WebHelp.
To bind a function block program to I/Os
1. In WorkStation, in the System Tree pane, select the function block program
to which you want to bind values.
2. On the Actions menu, click Edit bindings.
3. In the binding Browser, drag IO Bus values to inputs and outputs in the
binding list to create the bindings.
4. On the toolbar, click Save to save the bindings to the Automation Server.
04-16006-04-en, March 2015 Technical
1221
38 Function Block Programs
38.10 Binding Values Using a Binding Template
38.10 Binding Values Using a Binding
Template
You use binding templates to reduce engineering time when creating bindings.
Binding templates are defined and created for binding patterns that are frequently
reused.
Using binding templates, you create bindings between the Automation Server
program variables, internal values, and I/O points using the following recommended
process:
• First, bind the Automation Server IO Bus to each of the Programs in the
Automation Server that requires data flow with the I/O points.
• Next, bind the Internal Variables to each of the Programs in the Automation
Server that requires data flow with Internal Variables.
• Then, bind each of the individual Programs to all other Programs that require
data flow with other Programs.
• Finally, bind any time schedules and alarms that are required as part of the
programmed control logic.
Tip
• When creating bindings, follow the recommended general guidelines: create
bindings between Inputs and Outputs only and do not create bindings to
Public Signals.
For more information, see section 16.1 “Binding Templates” on page 449.
To bind values using a binding template
1. In WorkStation, in the System Tree pane, select the object that you want to
bind values to.
2. On the Actions menu, click Edit bindings.
Continued on next page
Technical 04-16006-04-en, March 2015
1222
38 Function Block Programs
38.10 Binding Values Using a Binding Template
3. In the binding point browser, drag the object or folder to the binding template
that you want to apply.
4. Select the bindings that you want to create.
5. Click OK.
Continued on next page
04-16006-04-en, March 2015 Technical
1223
38 Function Block Programs
38.10 Binding Values Using a Binding Template
6. Verify that all bindings are correctly bound.
7. On the File menu, click Save.
Tip
• To ensure data flow is occurring as intended, use the Watch pane to view
values and monitor changes.
Technical 04-16006-04-en, March 2015
1224
38 Function Block Programs
38.11 Saving a Function Block Program
38.11 Saving a Function Block Program
You save a function block program to make it available for reuse. The Save process
automatically processes the function block program data and creates a number of
subfolders in the System Tree pane.
To save a function block program
1. In Function Block Editor, on the File menu, click Save.
You can now use the function block program, with the blocks and the folders
automatically created in the database.
04-16006-04-en, March 2015 Technical
1225
38 Function Block Programs
38.12 Tasks
38.12 Tasks
Function block and Script programs must be connected to tasks in order to run.
You access Tasks from the Properties dialog box.
The task is a property of the object that defines the program cycles.
When you create a new function block or Script program, Task 3 is the default. This
means that one program cycle executes in 1000 ms.
Figure: Tasks
The way you schedule programs to execute in Script differs from how you schedule
them to execute in Continuum. For more information, see the Script and Plain
English Program Differences topic on WebHelp.
Table: Task Intervals
Task Interval
Task 1 0.1 seconds
Task 2 0.5 seconds
Task 3 1 seconds
Task 4 5 seconds
Task 5 10 seconds
Technical 04-16006-04-en, March 2015
1226
38 Function Block Programs
38.13 Adding a Task to a Program
38.13 Adding a Task to a Program
To make a Script or Function Block program run, the program must be connected
to a task.
For more information, see section 50.23 “Tasks” on page 1602.
To add a task to a program
1. In WorkStation, in the System Tree pane, select the program you want to
add a task to.
2. On the File menu, click Properties.
3. In the Task box, enter the task you want to add.
4. Click OK.
04-16006-04-en, March 2015 Technical
1227
38 Function Block Programs
38.14 Program Cycles in Building Operation
38.14 Program Cycles in Building Operation
All programs are executed in the order they are bound in Building Operation. For
example, in programs that are executed in a straight order or in any similar
configuration, Program 4 runs after Program 3 that runs after Program 2 that runs
after Program 1. The first program to be executed is Program 1.
The illustration that follows shows the execution sequence for a straight order
configuration.
Figure: Execution order of programs
When programs are connected in an algebraic loop, the execution order cannot be
determined and the program that runs first needs to be established. In Building
Operation, algebraic loops are called Cycles. In this case, there is no way to
determine the execution order of the programs. Program 4 runs after Program 3
that runs after Program 2 that runs after Program 1 that runs after Program 4.
Figure: In an algebraic loop the execution order of programs cannot easily be determined.
To resolve a cycle and determine which program runs first in the cycle, you use the
execution precedence function. Programs can have execution precedence values
ranging from 0 to 255 where 0 results in the highest priority and 255 results in the
lowest priority. The program with highest execution precedence is always executed
first in the cycle.
Execution Precedence
Values: Integers ranging from 0 to 255
Highest priority value: 0
Lowest priority value: 255
The execution precedence is configured in the properties for the program. The
default value when you create a new program is 100.
Technical 04-16006-04-en, March 2015
1228
38 Function Block Programs
38.14 Program Cycles in Building Operation
Figure: Execution precedence
The execution precedence can never override the execution order of programs
based on how they are bound. The execution precedence decides the order in
which the programs are run when they are set up in some form of cycle and the
binding does not give a straight order for which program runs first.
The execution precedence can be used in two different situations:
• To determine the execution order when programs are bound in a cycle.
• As troubleshooting, for example when a there are delays without any known
reason. A long delay might be the result of programs that run in the wrong
order.
38.14.1 Example A
In this example we have four programs that are connected in a cycle. The execution
order cannot be determined from how programs are bound. Program 1 should run
before Program 2, Program 2 before Program 3, and Program 4 before Program 1.
04-16006-04-en, March 2015 Technical
1229
38 Function Block Programs
38.14 Program Cycles in Building Operation
Figure: Example
However, Program 2 reads from a physical input, Input A, and the information from
this reading is transferred to Program 4, which writes to a physical output, Output
B.
Figure: Example
So, we want to Program 2 to run before Program 4. To do this we use execution
precedence. By configuring the Execution precedence as 99 for Program 2,
Program 2 will be the first program to be executed in the cycle.
Figure: Example
The resulting execution order will be P2, P3, P4 and P1.
Technical 04-16006-04-en, March 2015
1230
38 Function Block Programs
38.14 Program Cycles in Building Operation
38.14.2 Example B
All programs use the default execution precedence that is 100. In this example, it is
not possible to determine the execution order of Program 1 and Program 2 and the
execution order of Program 3 and Program 4. The only thing we can be sure of is
that the cycle with Program 1 and Program 2 is executed before the cycle with
Program 3 and Program 4 due to the fact that Program 3 awaits input from
Program 2.
Figure: Example
To resolve the order we configure Program 2 and Program 3 to have the execution
precedence of 99. Then Program 2 runs before Program 1 in the first cycle and
Program 3 before Program 4 in the second cycle.
Figure: Example
Now the execution order is Program 2, Program 3, Program 4 and Program 1.
38.14.3 Application Scheduler
The Application Scheduler displays the programs execution order and if you have
any cycles in your system. In the System Tree pane, the Application Scheduler is
displayed in the Modules folder. The programs are represented with an entry under
the task they are assigned to.
04-16006-04-en, March 2015 Technical
1231
38 Function Block Programs
38.14 Program Cycles in Building Operation
Figure: Application scheduler
The object called cycle identifies a cycle. In the properties dialog for the task the
property "Conflict" is set to "True" if there is any cycle in the Task. Conflicts do not
mean that the programs will not run at all. The programs will run but the might run in
an execution order that may cause unnecessary delays from input to output.
Technical 04-16006-04-en, March 2015
1232
38 Function Block Programs
38.14 Program Cycles in Building Operation
Figure: Conflict setting in task 3
Use the List View to see the execution order of the programs.
Figure: Entries in the List View
Entry is the order of execution of the programs for a specific task. In this case
Program 2 executes first followed by Program 4. Program 3 runs last.
04-16006-04-en, March 2015 Technical
1233
38 Function Block Programs
38.15 Configuring the Execution Precedence for a Program
38.15 Configuring the Execution Precedence
for a Program
You configure the highest execution precedence number on the program you want
to be executed first in a cycle.
For more information, see section 50.25 “Program Cycles in Building Operation ” on
page 1604.
To configure the execution precedence for a program
1. In WorkStation, in the System tree pane, select the program.
2. On the File menu, click Properties.
3. In the Execution precedence box, enter a number that is higher than all the
other programs in the cycle.
4. Click OK.
Technical 04-16006-04-en, March 2015
1234
38 Function Block Programs
38.16 Finding Cycles in a Task
38.16 Finding Cycles in a Task
If you encounter unexpected delays in input to output response, the execution
order of the programs in a Task might not optimized.
For more information, see section 50.25 “Program Cycles in Building Operation ” on
page 1604.
To find cycles in a task
1. In WorkStation, in the System Tree pane, in the System folder, open the
Modules, and then ApplicationScheduler foldes.
2. Open a Task.
3. If the Task contains an object called Cycle, a cycle is present.
04-16006-04-en, March 2015 Technical
1235
38 Function Block Programs
38.17 Module Names
38.17 Module Names
You can add a module name to the name of a signal to make the signal name
unique. Using modules in the signal name enables you to divide a large function
block program into separate systems, such as multiple heating groups. This division
provides two major advantages:
• You can use the same signal name in multiple systems, and make them unique
using the module name in the signal name. For example, AHU1\T1_SP and
AHU2\T1_SP.
• All public signals in a module are treated as a group and are located together in
the database when they are imported into Building Operation.
You can enter and edit the module name for a single block or a group of blocks.
Figure: Blocks in Modules
Module Signal Names
Use the following syntax for the module name in a signal name:
Module name\Signal
The module part of a signal name can have a maximum of 12 characters.
Technical 04-16006-04-en, March 2015
1236
38 Function Block Programs
38.18 Default Names
38.18 Default Names
You can let the program generate default names for all function blocks. When you
save a function block program, all public blocks without any Identifier get a default
name. For example, a block of type BI (Binary Input) gets the identifier “BI1”. If more
than one block of the same type is used in the function block program, the blocks
are separated with a continuous series of numbers; BI1, BI2, BI3, and so on.
04-16006-04-en, March 2015 Technical
1237
38 Function Block Programs
38.19 Adding and Editing the Module Name
38.19 Adding and Editing the Module Name
You can add and edit module names in the diagram window.
To add and edit the module name
1. In Function Block Editor, in the diagram window, select the block or group of
blocks you want to name or rename.
2. Right-click the selection and then click Module.
3. In the Module Name box, type the desired module name.
4. Click OK.
The module name is displayed in each function block in the module. The block type
designation of a block in a module is underlined and purple.
Technical 04-16006-04-en, March 2015
1238
38 Function Block Programs
38.20 Adding Default Names to Function Blocks
38.20 Adding Default Names to Function
Blocks
You can save unnamed function blocks under default names generated by the
program.
To add default names to function blocks
1. In Function Block Editor, on the File menu, click Save to save unnamed
function blocks under default names.
All previously unnamed blocks get an identifier referring to the block type and a
number, for example, BI1 and BI2 for Binary input blocks.
04-16006-04-en, March 2015 Technical
1239
38 Function Block Programs
38.21 Searching for a Text String
38.21 Searching for a Text String
You search for a text string when you want to locate certain signals, constants,
comments, modules, or block types.
To search for a text string
1. In Function Block Editor, on the Edit menu, click Search.
2. In the Search for box, type the text string you want to search for.
3. Select Signal-/ Constant Names to search for the text string in signal and
constant names.
4. Select Comment Text to search for the text string in comment texts.
5. Select Module Names to search for the text string in module names.
6. In the Block Types list, select the block type to search in.
7. Select Match case to match the letter case in the text string.
8. Select Whole words to only match whole words in the text string.
9. Click Search Next to start the search.
Technical 04-16006-04-en, March 2015
1240
38 Function Block Programs
38.21 Searching for a Text String
The text is displayed in the Text in Found Block area and the blocks containing the
text are selected.
04-16006-04-en, March 2015 Technical
1241
38 Function Block Programs
38.22 Replacing a Text String
38.22 Replacing a Text String
You search for and replace a text string in a function block program to locate a
certain block or function.
To replace a text string
1. In Function Block Editor, on the Edit menu, click Replace.
2. In the Search for box, type the text string to replace.
3. In the Replace with box, type the text string to replace with.
4. Select Signal-/ Constant Names to search for the text string in signal and
constant names.
5. Select Comment Text to search for the text string in comment texts.
6. Select Module Names to search for the text string in module names.
7. In the Block Types list, select the block type to search.
8. Select Case sensitive to match the letter case in the text string.
9. Select Whole words to match whole words in the text string.
10. Click Search Next to search for the text string.
11. Click Replace to replace the text string.
12. Click Search Next if you want to search for the text string again.
Note
• To replace text strings in all blocks, click Replace All.
Technical 04-16006-04-en, March 2015
1242
38 Function Block Programs
38.23 Program Conversion
38.23 Program Conversion
In Function Block Editor, the programming principles and features are quite different
from the programming principles of Menta Editor. In Function Block Editor, the
functionality is built up by program modules, but in Menta Editor the functionality is
typically built up by logical blocks into a single large program.
It is still possible to import and save Menta programs for Xenta 280/300/401 into
Function Block Editor. When you save the program it is saved as a function block
program, that is, an .AUT file. Some of the blocks that were available for Xenta
280/300/401 controllers in Menta are automatically converted into new blocks
when you save the program in Function Block Editor. Some of the converted blocks
lose their configuration data but are necessary for non-public blocks to function
properly.
The following conversions are made:
• AI blocks are converted into RI blocks.
• AO blocks are converted into RO blocks.
• ALARM blocks are converted into modified ALARM blocks, with inputs and
outputs but no parameters. The block acts as an input/output between the
function block program and Building Operation, but because of the alarm
capabilities in Building Operation, it is often unnecessary to keep the alarm
handling in the function block program. When imported into Function Block
Editor, Alarm blocks in Menta programs generate Change of State alarm
objects in Building Operation. You have to configure the alarms from
WorkStation. You can mass create alarms in Building Operation. For more
information, see the Alarm Functions topic on WebHelp.
Because of the improved capabilities in Building Operation alarm, it is often
possible to remove logic in Menta connected to alarm handling
• CNT blocks are converted into PI blocks connected to control inputs.
• DI blocks are converted into BI blocks.
• DO blocks are converted into BO blocks.
• DOPU blocks are converted into PO blocks.
• ERR blocks are converted into ERROR blocks.
• TSCH blocks are converted into TSCHI blocks, with inputs only. The block acts
as an input from the time schedule in Building Operation into the function block
program.
• Trend logs are lost and have to be manually recreated in Building Operation.
You can mass create trend logs in Building Operation. For more information,
see the Trend Log Functions topic on WebHelp.
• The bindings to physical I/Os are lost. You have to create the I/O point list in
Building Operation and then recreate the bindings either manually or by using a
binding template. For more information, see section 38.10 “Binding Values
Using a Binding Template” on page 1220.
• SNVTs are converted into RI/RO blocks.
• The .MTA file is converted into an .AUT file. For more information, see section
37.4 “Function Block Editor File Type” on page 1195.
04-16006-04-en, March 2015 Technical
1243
38 Function Block Programs
38.24 Importing a Xenta 280/300/401 Program
38.24 Importing a Xenta 280/300/401
Program
You import a Xenta 280/300/401 program to Function Block Editor to reuse its
functions in an Automation Server.
To import a Xenta 280/300/401 program
1. In Function Block Editor, on the File menu, click Import.
2. Enter the name of the Menta program you want to import.
3. Click Open.
4. Click Yes.
The Menta program is now converted into a function block program is now
uploaded and can be edited in Function Block Editor.
Technical 04-16006-04-en, March 2015
1244
39 Function Blocks
Topics
Edit Mode
Changing to Edit Mode
Duplicating a Function Block
Selecting a Function Block
Copying a Selection to the Clipboard
Clearing a Function Block Selection
Printing a Selection
Moving a Function Block
Copying a Function Block
Deleting a Function Block
Naming a Function Block
Selecting a Group
Centering a Group
Moving a Group
Deleting a Group
Copying a Group
Disconnecting a Group
39 Function Blocks
39.1 Edit Mode
39.1 Edit Mode
You use Edit mode when designing the function block program. In Edit mode you
add and edit blocks and connections.
39.1.1 Function Block Programming
You work with graphical elements that contain functionality. You put the elements
together to get a function block program that can be used in an Automation Server.
For more information, see section 45.1 “Function Block Programming” on page
1333.
39.1.2 Programming Phases
When you program an Automation Server, the work can be divided into three
fundamental phases:
• Function phase: analyze the requirements
• Design phase: program the function block program
• Test phase: simulate the functionality of the function block program
For more information, see section 37.9 “Programming Phases” on page 1203.
04-16006-04-en, March 2015 Technical
1247
39 Function Blocks
39.2 Changing to Edit Mode
39.2 Changing to Edit Mode
You change from Simulation mode to Edit mode to edit your function block
program.
For more information, see section 37.11 “Operation Modes” on page 1205.
To change to Edit mode
1. In Function Block Editor, on the Options menu, click Edit.
Technical 04-16006-04-en, March 2015
1248
39 Function Blocks
39.3 Duplicating a Function Block
39.3 Duplicating a Function Block
You create an empty function block to get a function block of a certain type but
without any specific parameters. You cannot duplicate Hierarchical Function Blocks
(HFB) using the Duplicate command.
To duplicate a function block
1. In Function Block Editor, in the diagram window, right-click the block you want
to duplicate and then click Duplicate.
2. Move the duplicate block to a suitable position in the diagram window.
3. Clear the function block selection.
You can now edit the name and parameters of the new block.
04-16006-04-en, March 2015 Technical
1249
39 Function Blocks
39.4 Selecting a Function Block
39.4 Selecting a Function Block
You select a function block if you want to move or copy it.
To select a function block
1. In Function Block Editor, in the diagram window, drag the pointer around the
block.
The block is now enclosed in a green rectangle and you can move or copy it.
Technical 04-16006-04-en, March 2015
1250
39 Function Blocks
39.5 Copying a Selection to the Clipboard
39.5 Copying a Selection to the Clipboard
You copy a selection to the clipboard when you want to export it to metafile
formatted function block programs.
To copy a selection to the clipboard
1. In Function Block Editor, in the diagram window, select the group of function
blocks you want to copy.
2. On the Edit menu, click Copy To Clipboard.
04-16006-04-en, March 2015 Technical
1251
39 Function Blocks
39.6 Clearing a Function Block Selection
39.6 Clearing a Function Block Selection
You clear a selection of blocks and connections that you no longer want to move or
copy.
To clear a function block selection
1. In Function Block Editor, in the diagram window, click outside the green
rectangle that encloses the block.
The function block selection is cleared.
Technical 04-16006-04-en, March 2015
1252
39 Function Blocks
39.7 Printing a Selection
39.7 Printing a Selection
You print a selection when you want to print only a part of a function block program.
To print a selection
1. In Function Block Editor, in the diagram window, select the function block you
want to print.
2. On the File menu, click Print.
3. Under Options, select Scale Output to one page.
Continued on next page
04-16006-04-en, March 2015 Technical
1253
39 Function Blocks
39.7 Printing a Selection
4. Click Print.
Technical 04-16006-04-en, March 2015
1254
39 Function Blocks
39.8 Moving a Function Block
39.8 Moving a Function Block
You can move a function block to a new position in the diagram window.
To move a function block
1. In Function Block Editor, in the diagram window, select the function block you
want to move.
2. Drag the selected function block to a new position.
3. Click outside the function block to clear the selection.
The block is now moved to its new location.
04-16006-04-en, March 2015 Technical
1255
39 Function Blocks
39.9 Copying a Function Block
39.9 Copying a Function Block
You copy function blocks whose parameters and connections you want to reuse.
To copy a function block
1. In Function Block Editor, in the diagram window, select the function block you
want to copy.
2. On the Edit menu, click Copy.
3. On the Edit menu, click Paste.
4. Drag the block from the top left corner to a new position in the diagram
window.
You can now change the block parameters.
Technical 04-16006-04-en, March 2015
1256
39 Function Blocks
39.10 Deleting a Function Block
39.10 Deleting a Function Block
You can delete a function block that you no longer want in the function block
program.
To delete a function block
1. In Function Block Editor, in the diagram window, select the function block you
want to delete.
2. On the Edit menu, click Delete.
04-16006-04-en, March 2015 Technical
1257
39 Function Blocks
39.11 Naming a Function Block
39.11 Naming a Function Block
You name a function block to make it unique, which is required to avoid conflicts in
the function block program. You can also add a description for the block.
For more information, see section 37.1 “Graphical Programming” on page 1189.
To name a function block
1. In Function Block Editor, in the diagram window, right-click the block you want
to name..
2. On the BLOCK menu, click Edit.
3. In the Identifier box, type a name for the block.
4. In the Description box, type a description for the block.
5. Click OK.
The block name is displayed at the top of the block in the diagram window.
Technical 04-16006-04-en, March 2015
1258
39 Function Blocks
39.12 Selecting a Group
39.12 Selecting a Group
You select a group of blocks in the diagram window to be able to perform an action
on multiple blocks. A connection is only partially selected if either the starting point
or the end point of the connection is selected. A connection is completely selected
if the starting point and end point are selected.
To select a group
1. In Function Block Editor, in the diagram window, drag the pointer around all
the blocks and connections you want to select.
The group is now selected and you can move, delete or copy it.
04-16006-04-en, March 2015 Technical
1259
39 Function Blocks
39.13 Centering a Group
39.13 Centering a Group
You can center a group to display a selection of blocks and connections in the
center of the diagram window.
To center a group
1. In Function Block Editor, in the diagram window, select all the blocks and
connections you want to center.
2. On the Edit menu, click Center Selection.
Note
• The selection shifts what is displayed in the center of the diagram
window. It does not move any blocks or connections.
• Selections to the far left or at the top are not centered as well as
selections made at the bottom or to the right in the diagram
window.
The program centers the selection as well as possible.
Technical 04-16006-04-en, March 2015
1260
39 Function Blocks
39.14 Moving a Group
39.14 Moving a Group
You can move a group of function blocks in the diagram window.
To move a group
1. In Function Block Editor, in the diagram window, select all the blocks and
connection you want to move.
2. Drag the selected group to a new position.
3. Click outside the selection to clear the selection.
04-16006-04-en, March 2015 Technical
1261
39 Function Blocks
39.15 Deleting a Group
39.15 Deleting a Group
You can delete all function blocks in a group.
To delete a group
1. In Function Block Editor, in the diagram window, select the blocks and
connections you want to delete.
2. On the Edit menu, click Delete.
Technical 04-16006-04-en, March 2015
1262
39 Function Blocks
39.16 Copying a Group
39.16 Copying a Group
You can copy blocks and connections in a function block program.
To copy a group
1. In Function Block Editor, in the diagram window, select all the blocks and
connections you want to copy.
2. On the Edit menu, click Copy.
3. On the Edit menu, click Paste.
The copy is located at the top and to the left in the diagram window. You can now
move it to another position in the function block program and edit the block
parameters.
04-16006-04-en, March 2015 Technical
1263
39 Function Blocks
39.17 Disconnecting a Group
39.17 Disconnecting a Group
You can disconnect all function blocks in a group from blocks outside the group.
To disconnect a group
1. In Function Block Editor, in the diagram window, select the group.
2. Right-click inside the selection.
3. Click Disconnect.
The connections between the blocks inside the group and blocks outside the group
are removed. The connections between the blocks within the group are kept.
Technical 04-16006-04-en, March 2015
1264
40 Hierarchical Function Blocks
Topics
Hierarchical Function Blocks
Creating an Empty HFB
Adding an HFB I/O Block
Creating an HFB of Existing Function Blocks
Expanding an HFB
Compressing an HFB
Navigating in a Hierarchical Structure of HFBs
Printing an HFB
40 Hierarchical Function Blocks
40.1 Hierarchical Function Blocks
40.1 Hierarchical Function Blocks
In Function Block Editor, you use hierarchical function blocks referred to as HFBs to
get an overview of a function block program. An HFB is a graphical solution for
grouping and structuring function blocks.
You can print or view a function block program with HFBs on the screen. You can
download the function block program to an Automation Server as an ordinary
function block program, not as HFBs.
You can create HFBs two ways:
• You can create an empty HFB and then add function blocks and connections.
• You can create a function block program from a group of existing function
blocks and connections, and then split it into hierarchical function blocks.
You can create one or more HFBs in another HFB.
Important
• If you create or rename a function block program that includes an HFB, the
HFB and all its lower levels are included in this function block program.
HFBs have their own inputs and outputs.
An HFB with at least one public signal has a red dot in the upper right corner of the
HFB symbol. The red dot is also used when the public signal is located in an
embedded HFB.
The figures below show an HFB on the top level, as well as on the expanded level.
Figure: HFB on top level
04-16006-04-en, March 2015 Technical
1267
40 Hierarchical Function Blocks
40.1 Hierarchical Function Blocks
Figure: HFB on expanded level
You can add and connect blocks for the function block program in the HFB function
block diagram the same way as an ordinary function block diagram. You use HFB
I/O blocks to connect signals from the HFB to other levels in the hierarchical
function block diagram.
You connect the HFB signals to function blocks outside the HFB by using the HFAI,
HFAO, HFDI, and HFDO blocks.
Technical 04-16006-04-en, March 2015
1268
40 Hierarchical Function Blocks
40.2 Creating an Empty HFB
40.2 Creating an Empty HFB
You can create an empty HFB in which you can structure your function block
program in a hierarchy.
For more information, see section 40.1 “Hierarchical Function Blocks” on page
1265.
To create an empty HFB
1. In Function Block Editor, in the diagram window, right-click and then click
HFB.
2. In the Identifier box, type a name for the hierarchical function block.
3. In the Description box, type a description of the HFB.
4. Click OK.
The empty HFB is added to the diagram window at the position where you right-
clicked.
04-16006-04-en, March 2015 Technical
1269
40 Hierarchical Function Blocks
40.3 Adding an HFB I/O Block
40.3 Adding an HFB I/O Block
You add HFB I/O blocks to connect the HFB signals to function blocks outside the
HFB.
For more information, see section 40.1 “Hierarchical Function Blocks” on page
1265.
To add an HFB I/O block
1. In Function Block Editor, in the diagram window, double-click to expand the
HFB.
2. In the diagram window, right-click and then click HFB I/O.
3. In the HFB I/O types list, click the type of input or output you want to create.
4. Click OK.
5. In the Identifier box, type a name for the signal.
6. Click OK.
Note
• The signals within the HFB must have unique names. The input
and output blocks are only displayed when the HFB is expanded
and the signals cannot be made public.
The HFB I/O is added to the HFB in the diagram window.
Technical 04-16006-04-en, March 2015
1270
40 Hierarchical Function Blocks
40.4 Creating an HFB of Existing Function Blocks
40.4 Creating an HFB of Existing Function
Blocks
You create an HFB of existing function blocks to create a hierarchy of function
blocks.
Important
• When an HFB has been created, it cannot be reverted to its original flat
structure.
• When you create an HFB of a group of blocks and connections, the required
input and output block types HFAI, HFAO, HFDI, and HFDO are automatically
created and use the existing signal names.
• Do not change the name of the blocks (HFAI, HFAO, HFDI and HFDO).
For more information, see section 40.1 “Hierarchical Function Blocks” on page
1265.
To create an HFB of existing function blocks
1. In Function Block Editor, in the diagram window, select all function blocks and
connections you want to save as an HFB block.
2. Right-click the selection and then click Create HFB.
3. In the Edit Hierarchy dialog box, in the Identifier box, type a name for the
HFB.
4. In the Description box, type a description of the HFB.
5. Click OK.
6. Click Save.
04-16006-04-en, March 2015 Technical
1271
40 Hierarchical Function Blocks
40.5 Expanding an HFB
40.5 Expanding an HFB
You expand an HFB to view the structure of the function blocks in the HFB.
For more information, see section 40.1 “Hierarchical Function Blocks” on page
1265.
To expand an HFB
1. In Function Block Editor, in the diagram window, right-click the HFB function
block and then click Expand HFB.
The expanded HFB is displayed and contains the input and output block types
HFAI, HFAO, HFDI, and HFDO.
Note
• The displayed HFB I/Os are only symbols used to show the connections to
the higher level in the function block diagram structure.
Technical 04-16006-04-en, March 2015
1272
40 Hierarchical Function Blocks
40.6 Compressing an HFB
40.6 Compressing an HFB
You compress an HFB to show the HFB on the higher level in the diagram window.
For more information, see section 40.1 “Hierarchical Function Blocks” on page
1265.
To compress an HFB
1. In Function Block Editor, in the diagram window, right-click the expanded HFB
and then click Compress HFB.
04-16006-04-en, March 2015 Technical
1273
40 Hierarchical Function Blocks
40.7 Navigating in a Hierarchical Structure of HFBs
40.7 Navigating in a Hierarchical Structure of
HFBs
You can navigate in a hierarchical function block using the HFB Navigation Tree.
For more information, see section 40.1 “Hierarchical Function Blocks” on page
1265.
To navigate in the hierarchical structure of HFBs
1. In Function Block Editor, on the Options menu, click Show HFB
Navigation Tree.
Continued on next page
Technical 04-16006-04-en, March 2015
1274
40 Hierarchical Function Blocks
40.7 Navigating in a Hierarchical Structure of HFBs
2. In the HFB Navigation Tree dialog box, click the HFB.
04-16006-04-en, March 2015 Technical
1275
40 Hierarchical Function Blocks
40.8 Printing an HFB
40.8 Printing an HFB
You can print either a single HFB or all levels of a function block diagram.
For more information, see section 40.1 “Hierarchical Function Blocks” on page
1265.
To print an HFB
1. In Function Block Editor, on the File menu, click Print.
2. In the FBD area, select FBD.
3. Select a level to print: Click Current Level to print only the current level of the
HFB. Click All levels, to print each HFB level on separate pages, with the
name and the page number of the HFB at the bottom of the page.
4. Click Print.
Technical 04-16006-04-en, March 2015
1276
41 Macros
Topics
Function Block Editor Macros
Function Block Editor Macro Commands
Saving a Macro
Loading a Macro
Replacing a String
Adding a Message Box
Adding a Reminder
Adding a Sound
41 Macros
41.1 Function Block Editor Macros
41.1 Function Block Editor Macros
Macros in Function Block Editor, are small function block programs that contain
useful functions you want to reuse.
By saving existing function block programs or parts of them as macros, you can
reduce time when designing a function block program. A number of pre-tested
macros are delivered with Function Block Editor and stored in the following location:
• Windows 7 and Windows 8.1: \ProgramData\Schneider Electric
StruxureWare\Building Operation x.x\WorkStation\Function Block Editor
x.x indicates the Building Operation version number.
04-16006-04-en, March 2015 Technical
1279
41 Macros
41.2 Function Block Editor Macro Commands
41.2 Function Block Editor Macro Commands
Macro commands are texts written in Comments, used to reduce time when
designing a function block program.
You use macro commands to replace generic text strings with site-specific texts,
display messages when you upload macros to Function Block Editor, display
reminders, or play sounds when you open a function block program.
Macro commands are executed as they appear in the Comment, from top to
bottom. For example, the first Replace command replaces the first text string in all
blocks. The second Replace command replaces the second text string, and so on.
Macro Command Syntax
You create macro commands by entering one or more of the following commands
in a comment:
• $REPLACE$ – text appears once and is replaced by _REPLACE$ when you
have entered a new text.
Syntax example: $REPLACERoofUnit$
• $MESSAGEBOX$ – Message appears once and is replaced by
_MESSAGEBOX$ when it has been displayed once.
Syntax example: $MESSAGEBOXText$
• $REMINDER$ - Reminder appears every time you open the function block
program file.
Syntax example: $REMINDERText$
• $PLAYSOUND$ - is played every time you open the function block program
file.
Syntax example: $PLAYSOUNDC:\MySounds\Soundfilename.wav$
Note
• You can use a macro command in more than one comment.
• You can mix macro commands with ordinary text in comments.
Technical 04-16006-04-en, March 2015
1280
41 Macros
41.3 Saving a Macro
41.3 Saving a Macro
You save a part of a function block program as a macro to make the function
accessible for future use.
For more information, see section 41.2 “Function Block Editor Macro Commands”
on page 1278.
To save a macro
1. In Function Block Editor, in the diagram window, select all function blocks and
connections you want to include when saving the macro.
2. Right-click the selection and on the GROUP menu, click Save to save part of
the function block program.
3. Enter the location where you want to save the macro.
4. In the File name box, type a file name for the macro.
5. Click Save.
04-16006-04-en, March 2015 Technical
1281
41 Macros
41.4 Loading a Macro
41.4 Loading a Macro
You can load a function block macro (part of a function block program) into a
function block program. When you load the function block macro its constants are
automatically added to the constants table.
For more information, see section 41.2 “Function Block Editor Macro Commands”
on page 1278.
To load a macro
1. In Function Block Editor, right-click in the diagram window.
2. On the NEW menu, click Load Macro.
3. In the File name box, enter the name of the function block program you want
to load.
4. Click Open.
The imported function block program is added to the existing function block
program and selected.
Technical 04-16006-04-en, March 2015
1282
41 Macros
41.5 Replacing a String
41.5 Replacing a String
You can replace text strings in function block names, function block parameters,
and comments, for example, to apply a naming convention on blocks with text
strings. Macro commands replace the command text strings in the comments. If
you save the macro again, it will use the replacement strings.
For more information, see section 41.2 “Function Block Editor Macro Commands”
on page 1278.
To replace a text string
1. In Function Block Editor, in the diagram window, right-click and then click
Comment.
2. Type '$REPLACE', the text string you want to replace, and then '$'.
3. Click OK.
4. Save the function block program and exit Function Block Editor.
5. In WorkStation, right-click the saved function block program and then click
Edit.
6. In the Macro Replace dialog box, in the With box, type the text string you
want to replace the existing text string with.
Continued on next page
04-16006-04-en, March 2015 Technical
1283
41 Macros
41.5 Replacing a String
7. Click OK.
Technical 04-16006-04-en, March 2015
1284
41 Macros
41.6 Adding a Message Box
41.6 Adding a Message Box
You add a message box to get a text box that opens every time you open the
function block program for editing.
For more information, see section 41.2 “Function Block Editor Macro Commands”
on page 1278.
To add a message box
1. In Function Block Editor, in the diagram window, right-click and then click
Comment.
2. Type '$MESSAGEBOX$' and then type the text you want to display in the
message box.
3. Click OK.
4. Save the function block program and exit Function Block Editor.
5. In WorkStation, right-click the saved function block program and then click
Edit.
6. Click OK.
The message box opens every time you open the function block program for
editing.
04-16006-04-en, March 2015 Technical
1285
41 Macros
41.7 Adding a Reminder
41.7 Adding a Reminder
You add a reminder box to get a text box that opens every time you open the
function block program for editing.
For more information, see section 41.2 “Function Block Editor Macro Commands”
on page 1278.
To add a reminder
1. In Function Block Editor, in the diagram window, right-click and then click
Comment.
2. Type '$REMINDER$' and then type the text you want to display in the
reminder box.
3. Click OK.
4. Save the function block program and exit Function Block Editor.
5. In WorkStation, right-click the saved function block program and then click
Edit.
6. Click OK.
The message box for the REMINDER macro command displays the reminder every
time the function block program is opened for editing.
Technical 04-16006-04-en, March 2015
1286
41 Macros
41.8 Adding a Sound
41.8 Adding a Sound
You add a sound to play a sound file every time you open the function block
program for editing. The sound file has to be located in the same folder as the
macro file (.AUT).
For more information, see section 41.2 “Function Block Editor Macro Commands”
on page 1278.
To add a sound
1. In Function Block Editor, in the diagram window, right-click and then click
Comment.
2. Type '$PLAYSOUND$' and then type the name of the .wav sound file you
want to use.
3. Click OK.
4. Save the function block program and exit Function Block Editor.
5. In WorkStation, right-click the saved function block program and then click
Edit.
6. Click OK.
The sound file is played every time you open the function block program for editing.
04-16006-04-en, March 2015 Technical
1287
42 Constants
Topics
Constants
Using a Constant
Making a Constant Public
Deleting All Unused Constants
Deleting a Constant
Editing a Constant
Adding a Constant
Changing the Value of a Constant
42 Constants
42.1 Constants
42.1 Constants
Constant names are alphanumerical strings of up to 20 characters. A constant
name must have at least one letter.
You can create constants separately or when you configure parameters in a
function block.
If you create a constant when you configure parameters in a function block, you
select the use of the constant by entering a text string instead of a numerical value
for the parameter in the function block. The text string is the identifier for the
constant.
Constants can be declared as either public or internal. By definition, a constant
cannot be modified by the function block program in which it is declared. When you
declare a constant as public, it can be accessed and modified from other nodes on
the network.
42.1.1 Public Constants
To give better access to parameters in function blocks, you can use public
constants instead of numerical values. The use of a public constant also allows
access to the value from other nodes on the network.
A small circle to the right of the parameter field in a function block indicates that a
public constant is used.
Figure: Public constant
By default, the module name of a public constant is the same as the module name
of the block. The module name of the public constant is not displayed in the
function block program unless it differs from the module name of the block.
Public constants in a function block program are listed in the program specification
and can be of the following types:
• Binary constants (PVB)
• Integer constants (PVI)
• Real constants (PVR)
Depending on whether other nodes are allowed to read and/or modify the constant
value, constants are read-only or read/write. You can change the value of a public
constant only in Simulation mode. Values of internal, that is non-public, constants
can be viewed but not modified. If a value for a public constant is modified from the
Constants Table, the source code for the function block program is changed. The
source code is not changed if the modifications are made during a simulation in
tabular mode.
04-16006-04-en, March 2015 Technical
1291
42 Constants
42.1 Constants
Important
• Public constants can be modified over the network as well during runtime.
• A public constant in Function Block Editor can only be assigned to one
function block parameter.
• An internal constant can be assigned to any number of function block
parameters. Non-public constant names are substituted with the
corresponding numerical values when the FBD is compiled.
• A public constant cannot have the same name as a public signal.
• Public constants are not allowed in expression blocks, or in operators.
• Public constants are not allowed inside the binding parameters of IO blocks.
• A constant used as a parameter in a function block is not removed from the
Constants Table when the function block is deleted.
You should always name blocks containing public constants so that the constants
can retrieve/change module names.
Note
• When you create a function block program, this block gets the initial value as
specified in the block.
• When you edit a function block program, this block keeps the value from the
last program cycle. When you change the init value in Function Block Editor it
does not affect the block.
Technical 04-16006-04-en, March 2015
1292
42 Constants
42.2 Using a Constant
42.2 Using a Constant
You can make parameters in function blocks accessible from the function block
program by using public constants instead of numerical values.
To use a constant
1. In Function Block Editor, in the diagram window, right-click the function block
and then click Edit.
2. In the Parameter box, type a text string (identifier) instead of a numerical
value to use the value of the constant as the parameter setting.
3. Click OK.
04-16006-04-en, March 2015 Technical
1293
42 Constants
42.3 Making a Constant Public
42.3 Making a Constant Public
You define a constant as public to make it available to other nodes on the network,
and to make it editable from the function block program.
For more information, see section 42.1 “Constants” on page 1289.
To make a constant public
1. In Function Block Editor, in the diagram window, right-click the function block
that contains the constant and then click Edit.
2. Select Public.
3. Click OK.
The constant is now available to other nodes on the network and can be edited
from the function block program.
Technical 04-16006-04-en, March 2015
1294
42 Constants
42.4 Deleting All Unused Constants
42.4 Deleting All Unused Constants
You can simultaneously delete all unused constants.
For more information, see section 42.1 “Constants” on page 1289.
To delete all unused constants
1. In Function Block Editor, on the Options menu, click Constants Table.
2. Click Delete Unused.
3. Click Exit.
04-16006-04-en, March 2015 Technical
1295
42 Constants
42.5 Deleting a Constant
42.5 Deleting a Constant
You delete a constant when it is no longer needed.
To delete a constant
1. In Function Block Editor, on the Options menu, click Constants Table.
2. Select the constant.
3. Click Delete.
4. Click Exit.
Technical 04-16006-04-en, March 2015
1296
42 Constants
42.6 Editing a Constant
42.6 Editing a Constant
You edit a constant to change its properties. All properties are editable, with the
exception of the identifier.
For more information, see section 42.1 “Constants” on page 1289.
To edit a constant
1. In Function Block Editor, on the Options menu, click Constants Table.
2. Double-click the constant you want to edit.
3. In the Value box, type the value.
4. Select Public to get a public constant.
5. In the Unit box, select unit for the constant.
6. In the Description box, type a description for the constant.
7. Click OK.
8. Click Exit.
04-16006-04-en, March 2015 Technical
1297
42 Constants
42.7 Adding a Constant
42.7 Adding a Constant
You add a constant value to a function block program by adding it to the Constants
Table.
For more information, see section 42.1 “Constants” on page 1289.
To add a constant
1. In Function Block Editor, on the Options menu, click Constants Table.
2. Click Add.
3. In the Identifier box, type a name for the constant.
4. In the Value box, type the value of the constant.
5. Select Public to make the constant public.
6. In the Unit box, select a unit for the constant.
7. In the Description box, type a description for the constant.
8. Click OK.
9. Click Exit.
Technical 04-16006-04-en, March 2015
1298
42 Constants
42.8 Changing the Value of a Constant
42.8 Changing the Value of a Constant
You can change the value of a constant.
Important
• You can only change values for public constants in Simulation mode.
• You can view but not change values for internal constants.
• Values for public constants, modified from the Constants Table, update the
source code for the function block program, except when changes are made
during a simulation in tabular mode.
To change the value of a constant
1. In Function Block Editor, in Simulation mode, on the Options menu, click
Constants Table.
2. In the Constants Table dialog box, double-click the constant.
3. In the Edit constant dialog box, enter the required value.
4. Click OK.
5. Click Exit.
04-16006-04-en, March 2015 Technical
1299
43 Signals
Topics
Signals
Signal Names
43 Signals
43.1 Signals
43.1 Signals
The signals in a function block program are variables. These variables are generated
as outputs of function blocks and are transferred to inputs in other blocks by using
connections.
All function blocks in Function Block Editor have one output only. Each function
block generates a unique signal.
43.1.1 Signal Types
Three types of signals are used in Function Block Editor:
• Integer: Signed 16 bit number (range: –32768 to 32767).
• Real: Signed real 32 bit number in the IEEE format with a precision of 6 digits
(range: 3.4x10-38 to 3.4x1038).
• Binary: 1 bit to represent binary values (0/1 = FALSE/TRUE).
Normally, you can only connect outputs to inputs of the same type in the function
block program.
43.1.2 Public Signals
By declaring the signals of interest as public signals, you make them readable and
they can be modified outside the function block program. Many signals in a function
block program represent intermediate values. In most function block programs, only
a few of the signals in the function block program are useful to other nodes on the
network.
All public signals in the function block program are compiled in the Public Signal
Table, an automatically compiled part of the program specification.
43.1.3 Accessing Signals
The permissions for a user to view, enter, or modify a block output signal are
defined by the access class for the signal. The following classes are used:
• Read-only (RO): The signal can be read from other nodes on the network, but
not modified.
• Read/write (RW): The signal can be read and modified from other nodes on the
network.
The signals in blocks where the computed output value depends only on the
current value(s) of the input signal(s) are read-only (RO).
If the output of such a block is modified over the network, the modification is
restored by the function block program in the next program cycle. Subsequent
blocks that use the signal can detect and reflect the transitory change.
For other block types, such as integrators and accumulators, you can allow external
write operations on the block outputs. For example, when you modify the value of a
block output and the new value is computed by adding or subtracting the
increment of the previous output value.
04-16006-04-en, March 2015 Technical
1303
43 Signals
43.1 Signals
43.1.4 Signal Names
In Function Block Editor, public signals have alpha numerical string names of up to
20 characters. In signal names, you can use national character sets. However, you
cannot begin the name with a number and you cannot use any blank spaces. Public
signal names have to be unique. They cannot differ only in using upper and
lowercase characters.
For more information, see section 43.2 “Signal Names” on page 1303.
Technical 04-16006-04-en, March 2015
1304
43 Signals
43.2 Signal Names
43.2 Signal Names
In Function Block Editor, public signals have alpha numerical string names of up to
20 characters. In signal names, you can use national character sets. However, you
cannot begin the name with a number and you cannot use any blank spaces. Public
signal names have to be unique. They cannot differ only in using upper and
lowercase characters.
The module name does not count in the 20 character limit. For more information,
see section 38.17 “Module Names” on page 1234.
Unsupported characters
The following characters are reserved for use as separators or system object
identifiers in monitoring and supervising systems and cannot be used: comma ( , ),
semicolon ( ; ), colon ( : ), hyphen ( - ), period ( . ), dollar ( $ ), and apostrophe ( ' ).
Double-quotes are not allowed. If you type a name string with double-quotes
("Signal_name", for example), the double-quotes are deleted when the dialog box is
closed.
The space character (white space) is not allowed. Use the underscore character ( _ )
instead.
04-16006-04-en, March 2015 Technical
1305
44 Simulation Mode
Topics
Simulation Mode
Changing to Simulation Mode
Setting Date and Time
Tiling the Simulation Area Vertically and Horizontally
Simulating One Cycle Only
Simulating a Defined Number of Cycles
Starting a Simulation
Setting Analog Simulation Inputs
Setting Digital Simulation Inputs
Changing from Function Diagram View to Table View
Adding a Binary Signal to the Recorder
Removing a Signal from the Recorder
Editing the Range of a Recorded Value
Restarting the Recorder
Resetting the Recorder
Viewing Sampled Values
Scanning Sampled Values
Defining the Sampling Period
Automatically Generated Input Signals
Automatically Generating an Analog Input Signal
Automatically Generating a Binary Input Signal
Modifying an Analog Signal
Modifying a Binary Signal
Viewing Parameters in a Function Block
44 Simulation Mode
44.1 Simulation Mode
44.1 Simulation Mode
You use Simulation mode to test and troubleshoot function block programs and to
show the state of the signals. You can run Simulation mode without a connected
Automation Server.
When simulating in Function Block Editor, you can modify the physical inputs in
different ways. One way is to manually alter the input values by using the buttons.
When the value for an input is manually modified, it remains constant until modified
again.
There are buttons for each physical input block in the function block program. The
buttons show the name of the corresponding input block. The buttons are located
on the left side of the diagram window. A scroll bar is displayed if the number of
inputs exceeds the available space.
In Simulation mode, you can start/stop the program execution and alter
values/states, which is useful when troubleshooting a function block program.
04-16006-04-en, March 2015 Technical
1309
44 Simulation Mode
44.2 Changing to Simulation Mode
44.2 Changing to Simulation Mode
You change from Edit mode to Simulation mode to test your function block
program.
For more information, see section 37.11 “Operation Modes” on page 1205.
To change to simulation mode
1. In Function Block Editor, on the Options menu, click Simulate.
2. Adjust the size of the diagram window and the trend area by moving the
separation bar between the two panes.
Technical 04-16006-04-en, March 2015
1310
44 Simulation Mode
44.3 Setting Date and Time
44.3 Setting Date and Time
You set date and time values in Simulation mode to simulate, for example, time
schedules.
To set date and time
1. In Function Block Editor, in Simulation mode, on the Options menu, click
Set Date And Time.
2. In the Date box, enter the date.
3. In the Time box, enter the time.
4. Click OK.
04-16006-04-en, March 2015 Technical
1311
44 Simulation Mode
44.4 Tiling the Simulation Area Vertically and Horizontally
44.4 Tiling the Simulation Area Vertically and
Horizontally
You tile the simulation area to change the orientation of the user interface vertically
and horizontally.
For more information, see section 37.11 “Operation Modes” on page 1205.
To tile the simulation area vertically and horizontally
1. In Function Block Editor, in Simulation mode, double-click the separation
bar between the diagram window and the trend area.
The simulation areas changes from horizontal to vertical, or vice versa.
Technical 04-16006-04-en, March 2015
1312
44 Simulation Mode
44.5 Simulating One Cycle Only
44.5 Simulating One Cycle Only
You simulate the function block program one step at a time to observe the changes
in the program cycle-by-cycle. The cycle number in the Cycle box upper right side
of the window is incremented.
For more information, see section 44.1 “Simulation Mode” on page 1307.
To simulate one cycle only
1. In Function Block Editor, in Simulation mode, on the Commands menu,
click Step.
04-16006-04-en, March 2015 Technical
1313
44 Simulation Mode
44.6 Simulating a Defined Number of Cycles
44.6 Simulating a Defined Number of Cycles
You define the number of cycles to observe changes, for example, delays.
To simulate a defined number of cycles
1. In Function Block Editor, in Simulation mode, on the Commands menu,
click Execute n Times.
2. In the Number of Cycles box, type the number of cycles.
3. Press ENTER.
Technical 04-16006-04-en, March 2015
1314
44 Simulation Mode
44.7 Starting a Simulation
44.7 Starting a Simulation
You start a simulation of a function block program to observe the changes in the
program.
For more information, see section 44.1 “Simulation Mode” on page 1307.
To start a simulation
1. In Function Block Editor, in Simulation mode, on the Commands menu,
click Execute.
The simulation toggles between start and stop when you click Execute.
04-16006-04-en, March 2015 Technical
1315
44 Simulation Mode
44.8 Setting Analog Simulation Inputs
44.8 Setting Analog Simulation Inputs
You simulate the analog inputs of a function block program to ensure that the
function block program behaves as expected.
For more information, see section 44.1 “Simulation Mode” on page 1307.
To set analog simulation inputs
1. In Function Block Editor, in Simulation mode, in the left part of the diagram
window, click the button of the analog input block.
2. In the Value box, type the required value.
Note
• You have to enter values in the engineering unit defined for the
analog input block.
3. Press ENTER.
Technical 04-16006-04-en, March 2015
1316
44 Simulation Mode
44.9 Setting Digital Simulation Inputs
44.9 Setting Digital Simulation Inputs
You simulate the digital inputs of a function block program to ensure that the
function block program behaves as expected.
For more information, see section 44.1 “Simulation Mode” on page 1307.
To set digital simulation inputs
1. In Function Block Editor, in Simulation mode, in the left part of the diagram
window, click the button of the digital input block.
The symbols on digital input buttons toggle between open and closed switches
when you click the buttons.
04-16006-04-en, March 2015 Technical
1317
44 Simulation Mode
44.10 Changing from Function Diagram View to Table View
44.10 Changing from Function Diagram View
to Table View
You can change from graphically viewing the blocks to viewing a table of all blocks
and signals.
To change from function diagram view to table view
1. In Function Block Editor, in Simulation mode, press the F5 function key.
Note
You can toggle between the graphical view and the table view by
pressing F5.
The view shifts from the graphical view to the table view.
Technical 04-16006-04-en, March 2015
1318
44 Simulation Mode
44.11 Adding a Binary Signal to the Recorder
44.11 Adding a Binary Signal to the Recorder
You can record a binary signal in Simulation mode.
To add a binary signal to the recorder
1. In Function Block Editor, in Simulation mode, right-click the function block
with the signal you want to record and then click Record.
Note
• When you record a binary signal, the plot range (scale) for the
signal is always 0 to 1.
One of the six trend channel boxes in the trend logging area shows the name of the
signal you added to the recorder.
04-16006-04-en, March 2015 Technical
1319
44 Simulation Mode
44.12 Removing a Signal from the Recorder
44.12 Removing a Signal from the Recorder
You can remove a signal from the recorder when you no longer want to record it.
To remove a signal from the recorder
1. In Function Block Editor, in Simulation mode, in the trend logging area, right-
click the trend record box and then click Delete.
Technical 04-16006-04-en, March 2015
1320
44 Simulation Mode
44.13 Editing the Range of a Recorded Value
44.13 Editing the Range of a Recorded Value
You can change the range of a recorded signal during the simulation.
To edit the range of a recorded value
1. In Function Block Editor, in Simulation mode, right-click in the Trend record
box and then click Edit Range.
2. In the Maximum Value box, type the value.
3. In the Minimum Value box, type the value.
4. Press ENTER.
04-16006-04-en, March 2015 Technical
1321
44 Simulation Mode
44.14 Restarting the Recorder
44.14 Restarting the Recorder
You restart the recorder to resume recording when you have paused.
To restart the recorder
1. In Function Block Editor, in Simulation mode, right-click anywhere in the
trend logging area and then click Restart.
Note
• When you record a binary signal, the plot range (scale) for the
signal is always 0 to 1.
The recorder continues to display the graphs, starting from the left in the trend
logging area. Previously drawn graphs are left unchanged.
Technical 04-16006-04-en, March 2015
1322
44 Simulation Mode
44.15 Resetting the Recorder
44.15 Resetting the Recorder
You reset the recorder to remove all defined log signals. Previously drawn graphs
are unchanged.
To reset the recorder
1. In Function Block Editor, in Simulation mode, right-click anywhere in the trend
logging area and then click Reset.
04-16006-04-en, March 2015 Technical
1323
44 Simulation Mode
44.16 Viewing Sampled Values
44.16 Viewing Sampled Values
You can view the logged signals values at any point of time in the trend logging
area.
To view sampled values
1. In Function Block Editor, in Simulation mode, in the trend logging area, click
the point of time where you want to view the value.
2. In the Cycle counter, view the cycle for the sampling value.
3. In the trend record box, view the logged values for the sampling.
4. Right-click the trend logging area when finished.
Technical 04-16006-04-en, March 2015
1324
44 Simulation Mode
44.17 Scanning Sampled Values
44.17 Scanning Sampled Values
You scan the graph to view each sampled value and the cycle it was sampled.
To scan sampled values
1. In Function Block Editor, in Simulation mode, in the trend logging area, click
the point of time.
2. Drag the dotted line.
3. In the recorded signal boxes, view the logged values for each sampling.
4. Right-click the trend logging area when finished.
04-16006-04-en, March 2015 Technical
1325
44 Simulation Mode
44.18 Defining the Sampling Period
44.18 Defining the Sampling Period
You can define the number of times a program is executed between each sampling
period.
To define the sampling period
1. In Function Block Editor, in Simulation mode, on the Commands menu,
click Sampling.
2. In the Cycles per sample box, type the number of program cycles.
3. Press ENTER.
Technical 04-16006-04-en, March 2015
1326
44 Simulation Mode
44.19 Automatically Generated Input Signals
44.19 Automatically Generated Input Signals
In the Function Block Editor Simulation mode, you can automatically generate signal
variations for physical inputs. You define the conditions for the variations in the
Analog Input or Binary Input dialog box with Automatic mode selected. The
simulated values generated by the input buttons are independent of the IO
configuration parameters for the input. The exception to this is the Time Constant
parameter in the RI block. In the RI block, an automatically generated signal is
filtered using the same filter function as defined by the Time Constant parameter.
04-16006-04-en, March 2015 Technical
1327
44 Simulation Mode
44.20 Automatically Generating an Analog Input Signal
44.20 Automatically Generating an Analog
Input Signal
You can automatically generate signal variations for physical inputs in II, PI, and RI
blocks.
To automatically generate an analog input signal
1. In Function Block Editor, in Simulation mode, in the left part of the diagram
window, right-click the button for the analog input.
2. In the Analog Input dialog box, click Automatic.
3. In the Wave Form box, select the wave form.
4. Select Circular if repeated lapses are required.
5. In the Amplitude box, enter the amplitude.
6. In the Average Value box, enter the value.
7. In the Phase (degrees) box, enter the phase relationship.
8. In the Period (sec) box, enter the period.
9. Click OK.
Technical 04-16006-04-en, March 2015
1328
44 Simulation Mode
44.21 Automatically Generating a Binary Input Signal
44.21 Automatically Generating a Binary Input
Signal
You can automatically generate a binary input signal in a BI block.
To automatically generate a binary input signal
1. In Function Block Editor, in Simulation mode, in the left part of the diagram
window, right-click the button for the digital input.
2. In the Digital Input dialog box, click Automatic.
3. Select Circular if repeated lapses are required.
4. In the Sequence box, type the sequence.
5. In the Period box, enter the period.
6. Click OK.
04-16006-04-en, March 2015 Technical
1329
44 Simulation Mode
44.22 Modifying an Analog Signal
44.22 Modifying an Analog Signal
You can modify the value of an analog signal.
To modify an analog signal
1. In Function Block Editor, in Simulation mode, click the block (signal).
2. In the Value box, type the value.
3. Press ENTER.
Technical 04-16006-04-en, March 2015
1330
44 Simulation Mode
44.23 Modifying a Binary Signal
44.23 Modifying a Binary Signal
You can modify the value of a binary signal.
To modify a binary signal
1. In Function Block Editor, in Simulation mode, click the block (signal).
2. In the dialog box, select the State option button to simulate a logical one or
clear the State option button to simulate a logical zero.
3. Press ENTER.
04-16006-04-en, March 2015 Technical
1331
44 Simulation Mode
44.24 Viewing Parameters in a Function Block
44.24 Viewing Parameters in a Function Block
You can view the internal block parameters as they are shown in the View block
dialog box when you simulate a function block program.
To view parameters in a function block
1. In Function Block Editor, in Simulation mode, in the diagram window, right-
click the block and then click View.
2. In the View block dialog box, view the available values.
3. Click OK.
Note
• When you use a public constant for a block parameter, you can
change the value by using the constants table.
Technical 04-16006-04-en, March 2015
1332
45 Function Block Programming
Topics
Function Block Programming
Connections
Connecting a Block Output to a Block Input
Creating a Node on a Connection Line
Drawing a Connection Line from a Node
Drawing a Connection Line in the Diagram Window
Disconnecting All Connections
Disconnecting a Connection
Changing a Connection
Deleting a Connection
Detaching a Connection
Changing the Color of a Connection Line
Changing the Orthogonal Connection Setting
45 Function Block Programming
45.1 Function Block Programming
45.1 Function Block Programming
You work with graphical elements that contain functionality. You put the elements
together to get a function block program that can be used in an Automation Server.
45.1.1 Simple Blocks
Simple blocks are graphical representations of functions in a function block
program.
For more information, see section 47.1 “Simple Blocks” on page 1367.
45.1.2 Operators
An operator is a type of function, which can perform an operation on one or several
operands.
For more information, see section 48.1 “Operators” on page 1481.
45.1.3 Expression Blocks
Expression blocks are blocks with an expression. You give the expression block its
behavior when you type the expression using input variables, constants, operators
or arithmetical functions. You can use several input variables. The graphic
representation of the blocks varies in size, depending on the expression and the
number of inputs.
For more information, see section 46.1 “Expression Blocks” on page 1351.
45.1.4 Connections
Connections in function block programs transport signals (data) between the
function blocks in the function block diagram. The connection is a link between the
output of one block and one or more inputs of other blocks.
For more information, see section 45.2 “Connections” on page 1335.
45.1.5 Signals
The signals in a function block program are variables. These variables are generated
as outputs of function blocks and are transferred to inputs in other blocks by using
connections.
For more information, see section 43.1 “Signals” on page 1301.
04-16006-04-en, March 2015 Technical
1335
45 Function Block Programming
45.1 Function Block Programming
45.1.6 Macros
Macros in Function Block Editor, are small function block programs that contain
useful functions you want to reuse.
For more information, see section 41.1 “Function Block Editor Macros” on page
1277.
45.1.7 Comments
Comments are graphical containers for text. You use Comments when there is a
need to explain what the function block is supposed to do. Comments are plain text
that is displayed in the function block program. Comments are also the containers
where you write macro commands that are to be used in Function Block Editor.
Technical 04-16006-04-en, March 2015
1336
45 Function Block Programming
45.2 Connections
45.2 Connections
Connections in function block programs transport signals (data) between the
function blocks in the function block diagram. The connection is a link between the
output of one block and one or more inputs of other blocks.
Connections inherit their data types from the connected outputs. Outputs and
inputs can only be connected when they have the same signal data type.
Connections are formed by straight line segments. The points where line segments
join are called nodes. The corners, formed when connection lines change direction,
are also nodes.
Figure: Connection node
In the function block diagram, binary connections end at an input with an unfilled
arrowhead, and analog (real or integer) connections end at an input with a filled
arrowhead.
A node, joining more than two segments, is displayed as a black circle to
differentiate it from connections crossing each other.
A connection normally starts at a block output and ends at a block input but you
can sometimes use incomplete connections. When a connection is connected to
an output only, the unconnected end is displayed as a black circle. When a
connection is connected to an input only, the unconnected end is displayed as a
black square.
Note
• You cannot compile a function block diagram when there are unconnected
inputs.
• Unconnected inputs must be connected before switching to simulation
mode.
In Function Block Editor, you can draw connections from different starting points in
the diagram.
• Starting at a block output
• Starting at a connection line
• Starting at a node
• Starting in the work area
When you click the output of a function block, the cursor changes to an angled
cross.
When you start moving the cursor, a floating connection line is created and
movements are tracked by an elastic, green line.
When it is necessary to change position or direction of the connection line, you can
fixate the current segment end by clicking once. The floating connection line
changes into a fixed segment and a new floating connection line starts at the break
point.
You can repeat this fixation as many times as necessary, creating a connection
made up of various consecutive segments.
04-16006-04-en, March 2015 Technical
1337
45 Function Block Programming
45.2 Connections
When you point to an input where you can connect, the cursor changes to a square
around a small angled cross.
Technical 04-16006-04-en, March 2015
1338
45 Function Block Programming
45.3 Connecting a Block Output to a Block Input
45.3 Connecting a Block Output to a Block
Input
You draw a connection line to connect the output of one function block to the input
of another function block in the diagram window.
For more information, see section 45.2 “Connections” on page 1335.
To connect a block output to a block input
1. In Function Block Editor, in the diagram window, click the output of the block.
2. Drag the pointer to the input of the block you want to connect to.
Tip
When it is necessary to change position or direction of the
connection line, you can fixate the current segment by clicking once.
You can repeat this fixation as many times as needed.
3. Click the input to finish the connection.
04-16006-04-en, March 2015 Technical
1339
45 Function Block Programming
45.4 Creating a Node on a Connection Line
45.4 Creating a Node on a Connection Line
You create a node on a connection line to connect the signal to an additional
function block in the diagram window.
For more information, see section 45.2 “Connections” on page 1335.
To create a node on a connection line
1. In Function Block Editor, in the diagram window, right-click the connection line
at a point where you want to create a node.
2. On the CONNECTION menu, click Create Node.
3. Click where you want to finish the connection.
Tip
When it is necessary to change position or direction of the
connection line, you can fixate the current segment by clicking once.
You can repeat this fixation as many times as needed.
A node shaped as a filled, black circle is created on the connection line at the point
where you right-clicked.
Technical 04-16006-04-en, March 2015
1340
45 Function Block Programming
45.5 Drawing a Connection Line from a Node
45.5 Drawing a Connection Line from a Node
You draw a new connection line, starting from a node on an existing connection
line, to make an additional connection.
For more information, see section 45.2 “Connections” on page 1335.
To draw a connection line from a node
1. In Function Block Editor, in the diagram window, click the node.
2. Click where you want the connection line to finish.
A connection line is created on the node.
04-16006-04-en, March 2015 Technical
1341
45 Function Block Programming
45.6 Drawing a Connection Line in the Diagram Window
45.6 Drawing a Connection Line in the
Diagram Window
You can draw a connection at an arbitrary place on the diagram window.
For more information, see section 45.2 “Connections” on page 1335.
To draw a connection line in the diagram window
1. In Function Block Editor, in the diagram window, right-click a location in the
diagram window where you want to start the connection line, point to Node,
and then click the type of connection (Real, Integer, or Binary) you want to
use.
2. Double-click where you want to finish the connection line.
Technical 04-16006-04-en, March 2015
1342
45 Function Block Programming
45.7 Disconnecting All Connections
45.7 Disconnecting All Connections
You can remove all connections to a function block with a single command.
For more information, see section 45.2 “Connections” on page 1335.
To disconnect all connections
1. In Function Block Editor, in the diagram window, right-click the block and then
click Disconnect.
04-16006-04-en, March 2015 Technical
1343
45 Function Block Programming
45.8 Disconnecting a Connection
45.8 Disconnecting a Connection
You can remove a connection to an input or an output of a function block with a
single command.
For more information, see section 45.2 “Connections” on page 1335.
To disconnect a connection
1. In Function Block Editor, in the diagram window, right-click the connection at
an input or an output, and then click Disconnect.
Technical 04-16006-04-en, March 2015
1344
45 Function Block Programming
45.9 Changing a Connection
45.9 Changing a Connection
You can change a connection from one input to another or one output to another.
The connection lines are not lost.
For more information, see section 45.2 “Connections” on page 1335.
To change a connection
1. In Function Block Editor, in the diagram window, right-click the connection you
want to change and then click Detach.
2. Click the input or output to which you want to connect.
04-16006-04-en, March 2015 Technical
1345
45 Function Block Programming
45.10 Deleting a Connection
45.10 Deleting a Connection
You delete a connection or parts of it when you want to disconnect a block or
change the direction of the connection:
• When you right-click the connection close to the output of a block, the whole
connection, including all branches, is deleted.
• When you right-click the connection after a branch, only the part between the
point where you click and the connected input is deleted.
For more information, see section 45.2 “Connections” on page 1335.
To delete a connection
1. In Function Block Editor, in the diagram window, right-click the connection line
you want to delete.
2. On the CONNECTIONS menu, click Delete Node.
Technical 04-16006-04-en, March 2015
1346
45 Function Block Programming
45.11 Detaching a Connection
45.11 Detaching a Connection
You detach a connection to an input or output to move it to another input or output.
For more information, see section 45.2 “Connections” on page 1335.
To detach a connection
1. In Function Block Editor, in the diagram window, right-click the connection you
want to detach and then click Detach.
04-16006-04-en, March 2015 Technical
1347
45 Function Block Programming
45.12 Changing the Color of a Connection Line
45.12 Changing the Color of a Connection
Line
You change the color of a connection line to differentiate different lines. For
example, you change the color of a connection to trace signals in a function block
program.
For more information, see section 45.2 “Connections” on page 1335.
To change the color of a connection line
1. In Function Block Editor, in the diagram window, right-click the connection,
point to Mark, and then select color.
The connection is marked with its new color.
Technical 04-16006-04-en, March 2015
1348
45 Function Block Programming
45.13 Changing the Orthogonal Connection Setting
45.13 Changing the Orthogonal Connection
Setting
You change the orthogonal connection setting to draw connection lines in
segments that form 90 degree angles.
For more information, see section 45.2 “Connections” on page 1335.
To change the orthogonal connection setting
1. In Function Block Editor, on the Preferences menu, click Orthogonal
Connections.
04-16006-04-en, March 2015 Technical
1349
46 Expression Blocks and
Comments
Topics
Expression Blocks
Adding an Expression Block
Expression Block Arithmetical Functions
Expression Block Operators
Function Block Editor Comments
Adding a Comment
Adding a Rectangle
46 Expression Blocks and Comments
46.1 Expression Blocks
46.1 Expression Blocks
Expression blocks are blocks with an expression. You give the expression block its
behavior when you type the expression using input variables, constants, operators
or arithmetical functions. You can use several input variables. The graphic
representation of the blocks varies in size, depending on the expression and the
number of inputs.
Figure: Function Block Editor expression
There is only one output from an expression block. You choose if it should be
binary, integer or real. The name of the block will depend of the type of output
signal.
Table: The Expression Block Characteristics
Name Description
XPB Expression block with a binary output.
If the expression result is any value other
than zero, the output is one.
XPI Expression block with an integer output. The
result of the expression is converted to a 16
bit signed integer.
XPR Expression block with a real output.
The result of the expression is a real number.
Expression blocks are always read-only. The memory they occupy when compiled
depends on the complexity of the expression.
46.1.1 Expression Block Input Variables
Input variables are declared in the expression using a single letter. An uppercase
letter represents an analog variable and a lowercase letter represents a binary
variable.
You cannot use the same letter in both upper and lowercase, that is, “A” and “a”
cannot be used in the same expression.
The input variables are sorted in alphabetical order on the left side of the expression
block.
04-16006-04-en, March 2015 Technical
1353
46 Expression Blocks and Comments
46.1 Expression Blocks
46.1.2 Expression Block Constants
Expression blocks can contain two types of constants:
• Numerical, for example, “5”, “–13”, “0.03”
• Alphanumerical, for example, “PI”, “ENERGY”, “1.25E12”
A numerical constant is an integer portion which can be preceded by a symbol: +
or –. The integer portion cab be followed by a decimal point (.) and a decimal
portion. Finally, an exponential portion can be added: the letters e or E, followed by
an integer with two digits.
Alphanumerical constants are alphanumerical identifiers of 20 significant characters
which must be defined in the Constants Table. The constant name must be placed
between quotation marks if a / (solidus) or : (colon) character is included in the
name.
46.1.3 Expression Block Operators
Expressions have two components: operands and operators. Operands are the
variables, numbers, values, or objects that are being manipulated by operators.
For more information, see section 46.4 “Expression Block Operators” on page
1356.
46.1.4 Expression Block Arithmetical Functions
Arithmetical functions can be used in the expression block to make more complex
calculations.
For more information, see section 46.3 “Expression Block Arithmetical Functions”
on page 1355.
Technical 04-16006-04-en, March 2015
1354
46 Expression Blocks and Comments
46.2 Adding an Expression Block
46.2 Adding an Expression Block
You create a program by adding simple blocks, operators, and expression blocks.
For more information, see section 46.1 “Expression Blocks” on page 1351.
To add an expression block
1. In Function Block Editor, right-click in the diagram window at the position
where you want to add the expression block.
2. On the NEW menu, click Expression.
3. In the Identifier box, type a name for the expression block.
4. In the Unit box, enter the required engineering unit for the output.
5. In the Description box, type a short description that explains the expression.
6. Select Public to make the output signal into a public signal.
7. Click the type of expression you want for the output: Real, Integer, or
Binary.
Continued on next page
04-16006-04-en, March 2015 Technical
1355
46 Expression Blocks and Comments
46.2 Adding an Expression Block
8. In the Expression box, type the expression you want to use to calculate the
output.
9. Click OK.
10. If the block is enclosed by a red rectangle, move the block to an empty space.
11. Click outside the green rectangle that encloses the block to clear the
selection.
Technical 04-16006-04-en, March 2015
1356
46 Expression Blocks and Comments
46.3 Expression Block Arithmetical Functions
46.3 Expression Block Arithmetical Functions
Arithmetical functions can be used in the expression block to make more complex
calculations.
Table: Arithmetical Functions in the Expression Blocks
Syntax Description
x**y x raised to the power of y
LN (x) Natural logarithm of x
LOG (x) Base 10 logarithm of x
EXP (x) Exponential e to the power of x
COS (x) Cosine of x (radians), defined for all x
SIN (x) Sine of x (radians), defined for all x
TAN (x) Tangent of x (radians), defined for all x
ACOS (x) Arc cosine of x, where –1 < x < 1, gives a
result between 0 and /2 radians
ASIN (x) Arc sine of x, where –1 < x < 1, gives a result
between –p/2 and p/2 radians
ATAN (x) Arc tangent of x, defined for all x, gives a
result between –/2 and /2 radians
SQRT (x) Square root of x
ABS (x) Absolute value of x
INT (x) Conversion to Integer (truncation)
You can use parentheses in an expression to force an evaluation order to differ from
the precedence order of the operators.
The three types of variables can always be combined with an operator without
problem, since the necessary type conversions are automatically performed
according to the rules described below:
• For the operations +, –, * and /, all values are converted to Real values.
• For the operations %, <<, >>, &, ^ and |, all values are converted to Integer
values (Real values are truncated).
• For the operation !, a Real or Integer value is converted to Binary using the
following rule: if the value is zero, it converts to zero, and if it is non-zero, it
converts to one before logical negation is carried out. A “true” bitwise Not
operation on an integer A can be obtained with the operation A ^ (-1), i.e. A
XOR (-1).
• The operations >, <, >=, <=, =, != convert the operands to Real values,
perform the comparison and return a Binary result.
04-16006-04-en, March 2015 Technical
1357
46 Expression Blocks and Comments
46.4 Expression Block Operators
46.4 Expression Block Operators
Expressions have two components: operands and operators. Operands are the
variables, numbers, values, or objects that are being manipulated.
In a function block program you can find, for example, “-” (change of sign), “*”
(multiplication), “+” (addition), “>>” (right shift), “<” (less than) and “a ? b : c” (IF-
THEN-ELSE statement: “if a then b else c”).
Operators indicate particular actions. For example, if y - 10 is an expression, y and
10 are the operands and the minus sign (-) is the operator. Each expression has at
least one operand and one or more operators.
The Function Block Editor Expression block operands can be manipulated with the
operators, described in the table in order of precedence.
Table: Operators in Expression Blocks
Operator Description
–,! Change of sign, logical negation
*, /, % Multiplication, division and modulus
+,– Addition, subtraction
<< , >> Left shift, right shift
<,> Less than, greater than
<= , >= Less than or equal to, greater than or equal
to
= , != Equal to, not equal to
& Logical AND (bit wise)
^ Logical Exclusive OR (bit wise)
| Logical OR (bit wise)
?: IF-THEN-ELSE statement.
“a ? b : c” means “if a then b else c”.
Note
• Operators in Function Block Editor are equivalent to operators that can be
used in expression blocks. The result is equivalent; each single operator is
compiled to a single expression block, exactly as if it had been written in an
expression block.
Miscellaneous Operators
In an expression block, operands of different types can be combined by using any
operator. However, when you use an operator in the Function Block Editor shortcut
menu, you should perform conversions explicitly.
Technical 04-16006-04-en, March 2015
1358
46 Expression Blocks and Comments
46.4 Expression Block Operators
The D/A and A/D operators are simply operators that convert from binary to analog
and vice versa. Those operators are needed because the rest of the operators have
typed inputs. That is, without them you would not, for example, be able to
summarize a binary and an analog signal. In expression blocks, conversions are
done implicitly so you do not need to use these operators in expressions. The
conversion rules are as follows:
• A real or integer value is converted to a binary value giving a logical 0 if the
input is exactly 0, or 1 if it is anything but 0.
• A binary value is converted to an analog value as follows: logical 0 gives the
number 0 and logical 1 gives the number 1.
The multiplexer operators are switches, which select one of two input signals
depending on the binary switch value.
The Conversion AA operator is used when connecting an integer output to a real
input or vice versa. Since operators do not distinguish between real and integer
values, the Conversion AA operator does not carry out an explicit type conversion
with rounding or truncation. Instead, this type conversion is done in the block using
the Conversion AA output value as the input. It is recommended that you use
expression blocks when explicit type conversions with rounding or truncation are
required.
04-16006-04-en, March 2015 Technical
1359
46 Expression Blocks and Comments
46.5 Function Block Editor Comments
46.5 Function Block Editor Comments
Comments are graphical containers for text. You use Comments when there is a
need to explain what the function block is supposed to do. Comments are plain text
that is displayed in the function block program. Comments are also the containers
where you write macro commands that are to be used in Function Block Editor.
Figure: Function Block Editor comment
Technical 04-16006-04-en, March 2015
1360
46 Expression Blocks and Comments
46.6 Adding a Comment
46.6 Adding a Comment
You add a comment to add a title to a function block program, explain the reason
for adding a certain function, or add information on the changes in a revised
function block program.
For more information, see section 46.5 “Function Block Editor Comments” on page
1358.
To add a comment
1. In Function Block Editor, right-click in the diagram window at the position
where you want to add the comment.
2. On the NEW menu, click Comment.
3. Type the text you want to display in the comment.
4. Click Font.
Continued on next page
04-16006-04-en, March 2015 Technical
1361
46 Expression Blocks and Comments
46.6 Adding a Comment
5. Configure the font settings.
6. Click OK.
7. In the Edit comment dialog box, click OK.
8. Click outside the green rectangle that encloses the comment to clear the
selection.
Technical 04-16006-04-en, March 2015
1362
46 Expression Blocks and Comments
46.7 Adding a Rectangle
46.7 Adding a Rectangle
You add a rectangle to make the function block diagram easy to understand, for
example, add a rectangle that encloses function blocks that perform a function
together.
To add a rectangle
1. In Function Block Editor, right-click in the diagram window at the position
where you want the rectangle to begin.
2. On the NEW menu, click Rectangle.
3. Drag the pointer to where you want the rectangle to end.
4. Click where you want the rectangle to end.
04-16006-04-en, March 2015 Technical
1363
47 Function Block Types
Topics
Simple Blocks
Adding a Simple Block
Connection Blocks
BI – Binary Input
BO – Binary Output
II – Integer Input
IO – Integer Output
PI – Pulse-Counter Binary Input
PO – Pulsed Binary Output
RI – Real Input
RO – Real Output
Time Schedule and Alarm Blocks
ALARM – Alarm
TSCHI – Time Schedule
Accumulator Blocks
ACCUM – Accumulator
INTEG – Integrator
RT – Run-Time Measurement
Non-linear Function Blocks
AHYST – Analog Hysteresis
HYST – Binary Hysteresis
LIMIT – High/Low Signal Limit
MAX – Maximum Signal Selector
MIN – Minimum Signal Selector
Logical Function Blocks
AND – Logical AND Gate
NOT – NOT Gate
OR – OR Gate
PULSE – Pulse Generator
SR – Set-Reset Flip-Flop
TRIG – Trigger
XOR – Exclusive OR Gate
Transformation Function Blocks
CURVE – Curve Function
ENTH – Enthalpy
POLY – Polynomial Function
PRCNT – Percentage
VECTOR – Vectorial Curve Function
Delay Blocks
DELAY – Delayed On/Off
DELB – Binary Value Delay
DELI – Integer Value Delay
DELR – Real Value Delay
SHB – Sample and Hold Binary Value
SHI – Sample and Hold Integer Value
SHR – Sample and Hold Real Value
System Variable Blocks
DATE – Day
ERROR – System Error
Error Codes for the ERROR Function Block
HOUR – Hour
MINUTE – Minute
MONTH – Month
RST – Restart
SECOND – Second
WDAY – Week Day
TCYC – Cycle Time
Controller and Filter Blocks
FILT – First Order Filter
OPT – Optimization
PIDA – PID Controller – Analog Output
PIDI – PID Controller – Incremental Output
PIDP – PID Controller – Analog Output
RAMP – Ramp Filter
SEQ – Sequencer
Signal Source Blocks
NCYC – Program Cycle Counter
OSC – Oscillator
PVB – Parameter Value Binary
PVI – Integer Value Parameter
PVR – Real Value Parameter
47 Function Block Types
47.1 Simple Blocks
47.1 Simple Blocks
Simple blocks are graphical representations of functions in a function block
program.
Each simple block has a number of inputs and parameters and one simple block
generates a single output signal.
The parameters in a simple block are always a numerical value or a list of numerical
values within a predetermined range for each type of parameter.
There are two ways to specify the numerical value:
• By using a decimal number in exponential format.
• By using an identifier of 20 significant characters which must be defined in the
Constants Table.
In the description of a block the following information is provided:
Table: Block Characteristics and Their Descriptions
Characteristics Description
Identifier Defines the name of the block.
Unit Defines the measurement unit of the block.
Inputs Defines the input types and briefly explains
their function.
Parameters Defines the functional block parameters and
briefly explains their meaning.
Output Types Defines the data type of the block output.
When two blocks are connected, the output
type should coincide with the input type.
Access Defines whether the signal exported by the
block is read-only (RO) or read/write (R/W).
Description A brief functional description of the block.
Figure: Simple block example
47.1.1 Connection Blocks
You use connection blocks to connect signals to and from a function block
program.
For more information, see section 47.3 “Connection Blocks” on page 1374.
04-16006-04-en, March 2015 Technical
1369
47 Function Block Types
47.1 Simple Blocks
Table: Connection Block Names and Their Descriptions
Name Description
RI Real input connection block
RO Real output connection block
II Integer input connection block
IO Integer output connection block
PI Pulse counting, digital input connection
block
PO Pulse width modulated output connection
block
BI Boolean input connection block
BO Boolean output connection block
47.1.2 Signal Source Blocks
Signal sources are function blocks that can give signals into the function block
program.
For more information, see section 47.66 “Signal Source Blocks” on page 1473.
Table: Signal Source Names and Their Descriptions
Name Description
NCYC Program cycle counter Single source block
OSC Oscillator, gives a pulse train
PVB Binary value parameter
PVI Integer value parameter
PVR Real value parameter
47.1.3 Logical Function Blocks
A Logical function block adds logical operations to a function block program.
For more information, see section 47.25 “Logical Function Blocks” on page 1403.
Table: Logical Function Names and Their Descriptions
Name Description
AND AND function on two binary signals
NOT Inverts a binary signal
Technical 04-16006-04-en, March 2015
1370
47 Function Block Types
47.1 Simple Blocks
Continued
Name Description
OR OR function on two binary signals
PULSE Mono-stable pulse generator (signal)
SR Set/Reset flip-flop
TRIG Trigger, true on input change of state
XOR XOR function on two binary signals
47.1.4 Non-linear Function Blocks
Non-linear function blocks are used for min and max limitations of signals.
For more information, see section 47.19 “Non-linear Function Blocks” on page
1395.
Table: Non-linear Function Names and Their Descriptions
Name Description
AHYST Analog hysteresis
HYST Binary hysteresis (relay function)
LIMIT Max/Min limit
MAX Maximum value of two signals
MIN Minimum value of two signals
47.1.5 Delay Blocks
A Delay block delays a signal in one of a number of ways.
For more information, see section 47.39 “Delay Blocks” on page 1424.
Table: Delay Block Names and Their Descriptions
Name Description
DELAY Delay on or off
DELB Delays a binary value one cycle
DELI Delays an integer value once cycle
DELR Delays a real value one cycle
SHB Maximum vale of two signals
SHI Sample and hold a binary value
04-16006-04-en, March 2015 Technical
1371
47 Function Block Types
47.1 Simple Blocks
Continued
Name Description
SHR Sample and hold a real value
47.1.6 Controller and Filter Blocks
Controller and Filter blocks control and filter signals in a function block program.
For more information, see section 47.58 “Controller and Filter Blocks” on page
1448.
Table: Controller and Filter Names and Their Descriptions
Name Description
FILT First order filter
OPT Start/Stop time optimization
PIDA PID controller (analog output)
PIDI PID controller (increased/decreased output)
PIDP Improved PID controller (analog output)
RAMP Ramp filter (rate limit)
SEQ Sequencer
47.1.7 Accumulator Blocks
The Accumulator block is used to accumulate the total consumption from an
incremental input (the consumption during one program cycle).
For more information, see section 47.15 “Accumulator Blocks” on page 1388.
Table: Accumulator Names and Their Descriptions
Name Description
ACCUM Real accumulator
INTEG Integrator
RT Running time measurement
47.1.8 System Variable Blocks
The System variable blocks have no inputs. The blocks display values from the
system clock or the system program.
For more information, see section 47.47 “System Variable Blocks” on page 1436.
Technical 04-16006-04-en, March 2015
1372
47 Function Block Types
47.1 Simple Blocks
Table: System Variable Names and Their Descriptions
Name Description
DATE Actual date
ERROR System error
HOUR Actual hour
MINUTE Actual minute
MONTH Actual month
RST Restart. The output is activated the first
execution
SECOND Actual second
TCYC Cycle time for the Function Block Program
module
WDAY Actual day of the week. 1=Monday
47.1.9 Time Schedule and Alarm Blocks
Time Schedules and Alarms blocks define time control and alarm handling in a
function block program. Time schedules and alarms are configured in WorkStation
and executed outside the function block program.
For more information, see section 47.12 “Time Schedule and Alarm Blocks” on
page 1384.
Table: Time Schedule and Alarm Names and Their Descriptions
Name Description
ALARM Initiates alarm message
TSCHI Time schedule block
47.1.10 Transformation Function Blocks
Transformation function blocks include blocks that transform signals in various
ways in a function block program.
For more information, see section 47.33 “Transformation Function Blocks” on page
1413.
Table: Transformation Functions Names and Their Description
Name Description
CURVE Partially linear curve function
ENTH Enthalpy calculation
04-16006-04-en, March 2015 Technical
1373
47 Function Block Types
47.1 Simple Blocks
Continued
Name Description
POLY Polynomial transformation function
PRCNT Percentages transformation function
VECTOR Vectorial transformation function
Technical 04-16006-04-en, March 2015
1374
47 Function Block Types
47.2 Adding a Simple Block
47.2 Adding a Simple Block
You create a program by adding simple blocks, operators, and expression blocks.
For more information, see section 47.1 “Simple Blocks” on page 1367.
To add a simple block
1. In Function Block Editor, right-click in the diagram window at the position
where you want to add the simple block.
2. On the NEW menu, click Simple Block.
3. In the block type list, select the type of simple block you want to add.
4. Click OK.
5. If the block is enclosed by a red rectangle, move the block to an empty space.
6. Click outside the green rectangle that encloses the block to clear the
selection.
04-16006-04-en, March 2015 Technical
1375
47 Function Block Types
47.3 Connection Blocks
47.3 Connection Blocks
You use connection blocks to connect signals to and from a function block
program.
47.3.1 BI
The BI block is a binary input to a function block program.
For more information, see section 47.4 “BI – Binary Input” on page 1376.
47.3.2 BO
The BO block is a binary output from a function block program.
For more information, see section 47.5 “BO – Binary Output ” on page 1377.
47.3.3 II
The II block is an integer input to function block program.
For more information, see section 47.6 “II – Integer Input” on page 1378.
47.3.4 IO
The IO block is an integer output from function block program.
For more information, see section 47.7 “IO – Integer Output ” on page 1379.
47.3.5 PI
The PI function block counts the number of pulses on the input during one
execution of a function block program.
For more information, see section 47.8 “PI – Pulse-Counter Binary Input” on page
1380.
47.3.6 PO
The PO block is designed to be used together with the PIDI function block.
For more information, see section 47.9 “PO – Pulsed Binary Output” on page 1381.
47.3.7 RI
The RI block represents a real input in a function block program.
Technical 04-16006-04-en, March 2015
1376
47 Function Block Types
47.3 Connection Blocks
For more information, see section 47.10 “RI – Real Input” on page 1382.
47.3.8 RO
The RO block represents a real output in a function block program.
For more information, see section 47.11 “RO – Real Output” on page 1383.
04-16006-04-en, March 2015 Technical
1377
47 Function Block Types
47.4 BI – Binary Input
47.4 BI – Binary Input
The BI block is a binary input to a function block program.
Figure: The binary input block
The block is updated once during each program cycle. Changes to the inputs with
a duration of less than one program cycle are not noted by the function block
program.
Note
• The BI block has no parameters.
Table: The BI Block Input
Data Type Access
BINARY RO
Technical 04-16006-04-en, March 2015
1378
47 Function Block Types
47.5 BO – Binary Output
47.5 BO – Binary Output
The BO block is a binary output from a function block program.
Figure: The binary output block
Important
It is not recommended to make any connection after the BO function blocks. Due
to system infrastructure, bindings to physical outputs are handled outside the
function block program. If you force the value of an output signal, the forced value
is not transferred back to the application program and anything connected after
the BO function block is unaffected by the forced value.
Note
• The BO block has no parameters.
Table: The BO Block Output
Data Type Access
BINARY RO
04-16006-04-en, March 2015 Technical
1379
47 Function Block Types
47.6 II – Integer Input
47.6 II – Integer Input
The II block is an integer input to function block program.
Figure: The integer input block
The value of the integer input connection block is a 16 bit integer value. The block
handles inputs of 32 bit integer values controlled by the Mode parameter value:
• Value 0.
The block integer value is limited to the range -32768 and 32767. An input
value outside this range generates a system error called integer
underflow/overflow and can be detected by the ERROR block.
• Value 1.
The block integer value is the most significant word (16 bits) of the 32 bits input
value.
• Value 2.
The block integer value is the least significant word (16 bits) of the 32 bits input
value.
Table: The II Block Parameter
Parameter Data Type Description
Mode – 16 bit output control
Table: The II Block Input
Data Type Description
INTEGER RO
Technical 04-16006-04-en, March 2015
1380
47 Function Block Types
47.7 IO – Integer Output
47.7 IO – Integer Output
The IO block is an integer output from function block program.
Figure: The integer output block
Important
It is not recommended to make any connection after the IO function blocks. Due
to system infrastructure, bindings to physical outputs are handled outside the
function block program. If you force the value of an output signal, the forced value
is not transferred back to the application program and anything connected after
the IO function block is unaffected by the forced value.
Note
• The IO block has no parameters.
Table: The INTEG Block Output
Data Type Access
INTEGER RO
04-16006-04-en, March 2015 Technical
1381
47 Function Block Types
47.8 PI – Pulse-Counter Binary Input
47.8 PI – Pulse-Counter Binary Input
The PI function block counts the number of pulses on the input during one
execution of a function block program.
Figure: The pulse-counter binary input block
Note
• The ACCUM block can be used to accumulate the number of pulses during
execution.
• The PI block has no parameters.
Table: The PI Block Input
Data Type Description
INTEGER –
Table: The PI Block Output
Data Type Access
REAL RO
Technical 04-16006-04-en, March 2015
1382
47 Function Block Types
47.9 PO – Pulsed Binary Output
47.9 PO – Pulsed Binary Output
The PO block is designed to be used together with the PIDI function block.
Figure: The pulsed binary output block
The pulse duration is determined by the block input signal value (in seconds).
Negative values are ignored.
Block input signals with duration shorter than the MinPulse value are accumulated
until the MinPulse value is reached. Short input signals can only be accumulated to
a duration of the program cycle.
Input pulses with durations longer than the program cycle time can create output
pulses longer than the program cycle time.
When the block gets a value equal to or higher than the cycle time of the function
block program, the block automatically adds 10% to avoid a dip in the output value.
That is, if the function block program execution takes 10 seconds the online viewer
shows 10 seconds for the block connected to the PO block and 11 seconds for the
PO block.
Important
It is not recommended to make any connection after the PO function blocks. Due
to system infrastructure, bindings to physical outputs are handled outside the
function block program. If you force the value of an output signal, the forced value
is not transferred back to the application program and anything connected after
the PO function block is unaffected by the forced value.
Table: The PO Block Parameter
Parameter Data Type Description
MinPulse REAL Minimum output pulse
duration (seconds)
Table: The PO Block Output
Data Type Access
REAL RO
04-16006-04-en, March 2015 Technical
1383
47 Function Block Types
47.10 RI – Real Input
47.10 RI – Real Input
The RI block represents a real input in a function block program.
Figure: The real input block
The real input block has a discrete time first order software filter for filtering a sensor
reading. The filter time constant is specified in seconds with the parameter
TimeConst.
Table: The RI Block Parameter
Parameter Data Type Description
TimeConst REAL Filter time constant (seconds)
Table: The RI Block Input
Data Type Description
REAL RO
Technical 04-16006-04-en, March 2015
1384
47 Function Block Types
47.11 RO – Real Output
47.11 RO – Real Output
The RO block represents a real output in a function block program.
Figure: The real output
Important
It is not recommended to make any connection after the RO function blocks. Due
to system infrastructure, Bindings to physical outputs are handled outside the
function block program. If you force the value of an output signal, the forced value
is not transferred back to the application program and anything connected after
the RO function block is unaffected by the forced value.
Note
• The RO block has no parameters.
Table: The RO Block Output
Data Type Access
REAL RO
04-16006-04-en, March 2015 Technical
1385
47 Function Block Types
47.12 Time Schedule and Alarm Blocks
47.12 Time Schedule and Alarm Blocks
Time Schedules and Alarms blocks define time control and alarm handling in a
function block program. Time schedules and alarms are configured in WorkStation
and executed outside the function block program.
47.12.1 ALARM
The ALARM block monitors the state of the binary input signal.
For more information, see section 47.13 “ALARM – Alarm” on page 1385.
47.12.2 TSCHI
The TSCHI block is an integer output indicating the number of minutes until the next
change of state of the time schedule.
For more information, see section 47.14 “TSCHI – Time Schedule” on page 1387.
Technical 04-16006-04-en, March 2015
1386
47 Function Block Types
47.13 ALARM – Alarm
47.13 ALARM – Alarm
The ALARM block monitors the state of the binary input signal.
Figure: The Alarm block
In the alarm block, a rising edge (transition from 0 to 1) starts a timer which
measures how long the input is true (1). If the measured time exceeds the specified
alarm activation (set) delay time, an alarm record containing information about the
status, time, signal name, priority, and an optional alarm text is generated by the
system software.
When an alarm is set, the alarm block waits for the input to become false (0). The
falling edge of the input signal triggers a timer in the same manner as the rising
edge. After the alarm reset delay time has expired, the alarm is reset by the system
software.
The alarm block output signal indicates the current alarm status:
• 1 = alarm set
• 0 = no alarm (reset)
The alarm set and reset delay times are specified in seconds with the DelayOn and
DelayOff parameters, respectively. Please refer to the timing diagram below, which
shows the setting and resetting of an alarm. If a power outage occurs during the
delay, the elapsed delay time is saved if the Backup check box is selected.
The alarm priority is specified with the Priority parameter.
Figure: The relation between input signal and alarm output signal
Note
• The input signal must be true for a time interval longer than DelayOn in order
to generate a new alarm. The input must also be false for a time interval
longer than DelayOff in order to reset the alarm.
04-16006-04-en, March 2015 Technical
1387
47 Function Block Types
47.13 ALARM – Alarm
Table: The ALARM Block Parameters
Parameter Data Type Description
DelayOn REAL Delay before the alarm is set
(sec)
DelayOff REAL Delay before the alarm is
reset (sec)
Priority INTEGER Alarm priority level
AlarmText STRING Optional alarm text
Table: The ALARM Block Input
Input Data Type Description
Variable BINARY Input signal
Table: The ALARM Block Output
Data Type Access
BINARY RO
Technical 04-16006-04-en, March 2015
1388
47 Function Block Types
47.14 TSCHI – Time Schedule
47.14 TSCHI – Time Schedule
The TSCHI block is an integer output indicating the number of minutes until the next
change of state of the time schedule.
Figure: The time schedule block
The TSCHI block has a signed integer output whose sign indicates the time
schedule status (negative = true, positive = false), and whose value indicates the
time left until the next status change (negative = time in minutes to false, positive =
time in minutes to true).
Note
• The TSCHI block has no parameters.
Table: The TSCHI Block Output
Data Type Access
INTEGER RO
04-16006-04-en, March 2015 Technical
1389
47 Function Block Types
47.15 Accumulator Blocks
47.15 Accumulator Blocks
The Accumulator block is used to accumulate the total consumption from an
incremental input (the consumption during one program cycle).
47.15.1 ACCUM
The ACCUM block is used to accumulate the total consumption from an
incremental input (the consumption during one program cycle).
For more information, see section 47.16 “ACCUM – Accumulator” on page 1389.
47.15.2 INTEG
The INTEG block integrates a rate or flow over time.
For more information, see section 47.17 “INTEG – Integrator” on page 1391.
47.15.3 RT
The RT block is used to calculate the runtime of the RunIndication signal.
For more information, see section 47.18 “RT – Run-Time Measurement” on page
1393.
Technical 04-16006-04-en, March 2015
1390
47 Function Block Types
47.16 ACCUM – Accumulator
47.16 ACCUM – Accumulator
The ACCUM block is used to accumulate the total consumption from an
incremental input (the consumption during one program cycle).
The block calculates the sum of the variable increment over time. The summation is
done using numerical precision to avoid underflow when the increment is small.
Figure: The accumulator block
Note
• The accumulated value is delayed by one program cycle before it appears on
the output.
The accumulator output is set to InitValue at the initial state. When the Reset input is
activated, the accumulator output is reset to a value specified by the ResetValue
input signal. When the Reset input is deactivated, the accumulation resumes from
the last value of the ResetValue input.
The upper and lower output limits are set by the maximum floating-point number
that can be represented in the controller.
Note
• When you create a function block program, this block gets the initial value as
specified in the block.
• When you edit a function block program, this block keeps the value from the
last program cycle. When you change the init value in Function Block Editor it
does not affect the block.
The ACCUM block has the following characteristics.
Table: The ACCUM Block Parameter
Parameter Data Type Description
InitValue REAL Initial accumulator value
Table: The ACCUM Block Inputs
Input Data Type Description
Increment (i) REAL Amount accumulated in each
program cycle
Reset (rs) BINARY Reset input (1 = reset)
04-16006-04-en, March 2015 Technical
1391
47 Function Block Types
47.16 ACCUM – Accumulator
Continued
Input Data Type Description
ResetValue (rv) REAL Value assigned to the output
when the reset input is
activated
Table: The ACCUM Block Output
Data Type Access
REAL R/W
Technical 04-16006-04-en, March 2015
1392
47 Function Block Types
47.17 INTEG – Integrator
47.17 INTEG – Integrator
The INTEG block integrates a rate or flow over time.
Figure: The integrator block
Table: The INTEG Block Parameter
Parameter Data Type Description
InitValue REAL Initial integrator value
Table: The INTEG Block Inputs
Input Data Type Description
Rate (r) REAL Rate input variable
Reset (rs) REAL Reset input (1 = reset)
ResetValue (rv) REAL Value assigned to the output
when the reset input is
activated
Table: The INTEG Block Output
Data Type Access
REAL R/W
The integral is computed as the sum of the rate multiplied by the time increment
(program cycle). The summation is done using extended numerical precision to
avoid underflow when the rate is small.
The integrator output is set to InitValue at the initial state. When the Reset input is
activated, the integrator output is reset to a value specified by the ResetValue input
signal. When the Reset input is deactivated, the integration is resumed starting from
the last value of the ResetValue input.
The upper and lower output limits are set by the maximum floating-point number
that can be represented in the controller.
Note
• When you create a function block program, this block gets the initial value as
specified in the block.
Continued on next page
04-16006-04-en, March 2015 Technical
1393
47 Function Block Types
47.17 INTEG – Integrator
• When you edit a function block program, this block keeps the value from the
last program cycle. When you change the init value in Function Block Editor it
does not affect the block.
Technical 04-16006-04-en, March 2015
1394
47 Function Block Types
47.18 RT – Run-Time Measurement
47.18 RT – Run-Time Measurement
The RT block is used to calculate the runtime of the RunIndication signal.
Figure: The run-time measurement block
Table: The RT Block Parameter
Parameter Data Type Description
Unit INTEGER Output time unit
0 = hours
1 = minutes
2 = seconds
Default value = 0
Table: The RT Block Inputs
Input Data Type Description
RunIndication (i) BINARY Running indication to be
measured
Reset (rs) BINARY Reset input
1 = reset
Table: The RT Block Output
Data Type Access
INTEGER R/W
The output time unit (hours, minutes or seconds) is selected using the Unit
parameter. The output and all internal block states are set to zero at the initial state
or when the Reset input is activated. When the Reset input is deactivated,
accumulation resumes.
When the output reaches the maximum Integer limit (32767), accumulation stops,
but the output is not reset to zero.
04-16006-04-en, March 2015 Technical
1395
47 Function Block Types
47.18 RT – Run-Time Measurement
Note
• When you create a function block program, this block gets the initial value as
specified in the block.
• When you edit a function block program, this block keeps the value from the
last program cycle. When you change the init value in Function Block Editor it
does not affect the block.
Technical 04-16006-04-en, March 2015
1396
47 Function Block Types
47.19 Non-linear Function Blocks
47.19 Non-linear Function Blocks
Non-linear function blocks are used for min and max limitations of signals.
47.19.1 AHYST
The AHYST block implements an analog hysteresis function.
For more information, see section 47.20 “AHYST – Analog Hysteresis” on page
1396.
47.19.2 HYST
The binary HYST block implements a relay function with hysteresis.
For more information, see section 47.21 “HYST – Binary Hysteresis” on page 1398.
47.19.3 LIMIT
The LIMIT block limits the analog signal within a given range.
For more information, see section 47.22 “LIMIT – High/Low Signal Limit” on page
1400.
47.19.4 MAX
The MAX signal selector block selects the highest of two analog signals.
For more information, see section 47.23 “MAX – Maximum Signal Selector” on
page 1401.
47.19.5 MIN
The MIN signal selector block selects the lowest of two analog signals.
For more information, see section 47.24 “MIN – Minimum Signal Selector” on page
1402.
04-16006-04-en, March 2015 Technical
1397
47 Function Block Types
47.20 AHYST – Analog Hysteresis
47.20 AHYST – Analog Hysteresis
The AHYST block implements an analog hysteresis function.
The output follows the input as long as the input is outside the limits of the
hysteresis loop. When the input variable enters into the hysteresis loop, the output
takes the limiting values of the hysteresis.
Figure: The analog hysteresis block
Figure: Analog hysteresis
If Rise > Fall, the loop is counter-clockwise. If Rise < Fall, the hysteresis loop is
clockwise.
If a complex function containing several hysteresis loops is required, program the
function by using other blocks (POLY, CURVE, VECTOR, and so on) and append in
cascade as many AHYST blocks as there are hysteresis loops in the desired
transfer function.
Table: The AHYST Block Parameters
Parameter Data Type Description
Rise REAL Value of the input signal for
the ascent in the hysteresis
loop
Fall REAL Value of the input signal for
the descent in the hysteresis
loop
Table: The AHYST Block Input
Input Data Type Description
Variable REAL Input signal
Technical 04-16006-04-en, March 2015
1398
47 Function Block Types
47.20 AHYST – Analog Hysteresis
Input Data Type Description
Table: The AHYST Block Output
Data Type Access
REAL RO
04-16006-04-en, March 2015 Technical
1399
47 Function Block Types
47.21 HYST – Binary Hysteresis
47.21 HYST – Binary Hysteresis
The binary HYST block implements a relay function with hysteresis.
Figure: The binary hysteresis block
Table: The HYST Block Parameters
Parameter Data Type Description
Activate REAL Threshold value of the input
signal for activation of the
output
Deactivate REAL Threshold value of the input
signal for deactivation of the
output
Table: The HYST Block Input
Input Data Type Description
Variable REAL Input signal
Table: The HYST Block Output
Data Type Access
BINARY RO
When activate is greater than deactivate, the block has the following functions:
• If the output is false (0) and the input signal exceeds the activation threshold,
the output changes to true (1).
• If the output is true (1) and the input signal drops below the deactivation
threshold, the output changes to false (0).
• When the input signal is in the zone between the two thresholds, the output
remains in its previous state.
Figure: Binary hysteresis, when activate is greater than deactivate
Technical 04-16006-04-en, March 2015
1400
47 Function Block Types
47.21 HYST – Binary Hysteresis
When activate is less than deactivate, the block has the following functions:
• If the output is true (1) and the input signal exceeds the deactivation threshold,
the output changes to false (0).
• If the output is false (0) and the input signal drops below the activation
threshold, the output changes to true (1).
• When the input signal is in the zone between the two thresholds, the output
remains in its previous state.
Figure: Binary hysteresis, when activate is less than deactivate
04-16006-04-en, March 2015 Technical
1401
47 Function Block Types
47.22 LIMIT – High/Low Signal Limit
47.22 LIMIT – High/Low Signal Limit
The LIMIT block limits the analog signal within a given range.
Figure: The high/low signal limit block
Table: The LIMIT Block Parameters
Parameter Data Type Description
MinValue REAL Minimum value limit
MaxValue REAL Maximum value limit
Table: The LIMIT Block Input
Data Type Description
REAL Input signal
Table: The LIMIT Block Output
Data Type Access
REAL RO
Technical 04-16006-04-en, March 2015
1402
47 Function Block Types
47.23 MAX – Maximum Signal Selector
47.23 MAX – Maximum Signal Selector
The MAX signal selector block selects the highest of two analog signals.
Figure: The maximum signal selector block
Note
• The MAX block has no parameters.
Table: The MAX Block Inputs
Data Type Description
REAL Input1. First input signal
REAL Input2. Second input signal
Table: The MAX Block Output
Data Type Access
REAL RO
04-16006-04-en, March 2015 Technical
1403
47 Function Block Types
47.24 MIN – Minimum Signal Selector
47.24 MIN – Minimum Signal Selector
The MIN signal selector block selects the lowest of two analog signals.
Figure: The minimum signal selector block
Note
• The MIN block has no parameters.
Table: The MIN Block Input
Data Type Description
REAL Input1. First input signal
REAL Input2. Second input signal
Table: The MIN Block Output
Data Type Access
REAL RO
Technical 04-16006-04-en, March 2015
1404
47 Function Block Types
47.25 Logical Function Blocks
47.25 Logical Function Blocks
A Logical function block adds logical operations to a function block program.
47.25.1 AND
The logical AND gate block calculates the boolean AND function of state1 and
state2.
For more information, see section 47.26 “AND – Logical AND Gate” on page 1405.
47.25.2 NOT
The NOT gate block inverts a binary signal.
For more information, see section 47.27 “NOT – NOT Gate” on page 1406.
47.25.3 OR
The OR gate block calculates the boolean OR function.
For more information, see section 47.28 “OR – OR Gate” on page 1407.
47.25.4 PULSE
The PULSE generator block generates a variable width pulse when the control input
is triggered.
For more information, see section 47.29 “PULSE – Pulse Generator” on page 1408.
47.25.5 SR
The SR flip-flop block is a bi-stable block with two inputs: set and reset.
For more information, see section 47.30 “SR – Set-Reset Flip-Flop” on page 1409.
47.25.6 TRIG
The TRIG block is mono-stable and fires when it detects a transition in its input
signal and generates a pulse which is equal to the duration of one program cycle.
For more information, see section 47.31 “TRIG – Trigger” on page 1411.
04-16006-04-en, March 2015 Technical
1405
47 Function Block Types
47.25 Logical Function Blocks
47.25.7 XOR
The exclusive OR gate block is a logical exclusive OR operator between two binary
values.
For more information, see section 47.32 “XOR – Exclusive OR Gate” on page 1412.
Technical 04-16006-04-en, March 2015
1406
47 Function Block Types
47.26 AND – Logical AND Gate
47.26 AND – Logical AND Gate
The logical AND gate block calculates the boolean AND function of state1 and
state2.
Figure: The logical AND gate
Note
• The AND block has no parameters.
Table: The AND Block Inputs
Data Type Description
BINARY State1
BINARY State2
Table: The AND Block Output
Data Type Access
BINARY RO
Table: Calculation of the Boolean AND Function of state1 and state2 in the Logical
AND Gate Block
state 1 state 2 output
0 0 0
0 1 0
1 0 0
1 1 1
04-16006-04-en, March 2015 Technical
1407
47 Function Block Types
47.27 NOT – NOT Gate
47.27 NOT – NOT Gate
The NOT gate block inverts a binary signal.
Figure: The NOT gate block
Note
• The NOT block has no parameters.
Table: The NOT Block Input
Data Type Description
BINARY Input signal
Table: The NOT Block Output
Data Type Access
BINARY RO
Technical 04-16006-04-en, March 2015
1408
47 Function Block Types
47.28 OR – OR Gate
47.28 OR – OR Gate
The OR gate block calculates the boolean OR function.
Figure: The OR gate block
Note
• The OR block has no parameters.
Table: The OR Block Inputs
Data Type Description
BINARY State1. Input signal 1
BINARY State2. Input signal 2
Table: The OR Block Output
Data Type Access
BINARY RO
Table: Calculation of the Boolean OR Function of state1 and state2 Using the OR
Gate Block
state1 state2 Output
0 0 0
0 1 1
1 0 1
1 1 1
04-16006-04-en, March 2015 Technical
1409
47 Function Block Types
47.29 PULSE – Pulse Generator
47.29 PULSE – Pulse Generator
The PULSE generator block generates a variable width pulse when the control input
is triggered.
Figure: The pulse generator block
Note
• The PULSE block has no parameters.
Table: The PULSE Block Inputs
Input Data Type Description
Trig (t) BINARY Trigger signal
PulseLength (pl) REAL Duration of output pulse
(seconds)
Table: The PULSE Block Output
Data Type Access
BINARY RO
The pulse generator block is a function block with a mono-stable binary output of
variable pulse length (pulse generator). The pulse length (in seconds) is given by the
input signal PulseLength. The PULSE block only has one stable output state (0).
When the input signal Trig switches from 0 to 1, the output switches to the unstable
state (1) and remains in this state for PulseLength seconds, after which it returns to
0. The output pulse is triggered by the transition of the input signal, from zero to
one, and not on its state. Thus, the output pulse length is independent of the
duration of the trig input pulse length.
Figure: Pulse length
The output pulse length is always a multiple of the program cycle time, for example,
if the PulseLength input is set to 5.2 seconds and the cycle time is 1 second, the
output pulse duration is 6 seconds.
Technical 04-16006-04-en, March 2015
1410
47 Function Block Types
47.30 SR – Set-Reset Flip-Flop
47.30 SR – Set-Reset Flip-Flop
The SR flip-flop block is a bi-stable block with two inputs: set and reset.
Figure: The set-reset flip-flop block
Table: The SR Block Parameter
Parameter Data Type Description
InitValue BINARY Initial value of the output
signal
Table: The SR Block Inputs
Input Data Type Description
Set (s) (D) BINARY Activates the output state
Reset (r) BINARY Deactivates the output state
Table: The SR Block Output
Data Type Access
BINARY R/W
Depending on the value of these inputs at any given moment, the output of the
block is given a value during the next program cycle in accordance with the
following transition table:
Table: Set-Reset Flip-Flop Block Transition Table
State (t) Reset (t) Output (t+1)
0 0 output (t)
0 1 0
1 0 1
1 1 inverse (output(t))
04-16006-04-en, March 2015 Technical
1411
47 Function Block Types
47.30 SR – Set-Reset Flip-Flop
State (t) Reset (t) Output (t+1)
Thus, the output at time t+1 is equal to the input at time t if the two inputs are
inactive. If the two inputs are active, the output changes state every program cycle.
If only one of them is active, the output is activated or deactivated depending on
whether the input variable set or reset is active respectively.
Figure: The set-reset flip-flop block function
Technical 04-16006-04-en, March 2015
1412
47 Function Block Types
47.31 TRIG – Trigger
47.31 TRIG – Trigger
The TRIG block is mono-stable and fires when it detects a transition in its input
signal and generates a pulse which is equal to the duration of one program cycle.
Figure: The trigger block
Table: The TRIG Block Parameter
Parameter Data Type Description
Mode INTEGER Operation modes 1, 2, or 3
Table: The TRIG Block Input
Input Data Type Description
State BINARY Trigger signal
Table: The TRIG Block Output
Data Type Access
BINARY RO
Depending on the mode of operation selected, the trigger can fire:
• Mode 0 and 1: on the low to high transitions
• Mode 2: on the high to low transitions
• Mode 3: on any transition
The mode can be entered as an integer between 0 and 255, but any mode higher
than mode 3 works as mode 3 (the trigger fires on any transition).
04-16006-04-en, March 2015 Technical
1413
47 Function Block Types
47.32 XOR – Exclusive OR Gate
47.32 XOR – Exclusive OR Gate
The exclusive OR gate block is a logical exclusive OR operator between two binary
values.
Figure: The exclusive OR gate block
Note
• The XOR block has no parameters.
Table: The XOR Block Inputs
Data Type Description
BINARY State1
BINARY State2
Table: The XOR Block Output
Data Type Access
BINARY RO
The exclusive OR gate block calculates the boolean exclusive OR function of state1
and state2, according to the following truth table:
Table: The Exclusive OR Gate Block Calculation Table
State1 State2 Output
0 0 0
0 1 1
1 0 1
1 1 0
Technical 04-16006-04-en, March 2015
1414
47 Function Block Types
47.33 Transformation Function Blocks
47.33 Transformation Function Blocks
Transformation function blocks include blocks that transform signals in various
ways in a function block program.
47.33.1 CURVE
The CURVE function block implements an arbitrary partially linear curve defined by a
number of curve breakpoints (xi, yi), that are the function values y = f(x) for a set of
input x values.
For more information, see section 47.34 “CURVE – Curve Function” on page 1414.
47.33.2 ENTH
The ENTH block is used to calculate moist air at normal atmospheric pressure as a
function of the dry-bulb temperature and the relative humidity.
For more information, see section 47.35 “ENTH – Enthalpy” on page 1416.
47.33.3 POLY
The POLY block calculates the polynomial function.
For more information, see section 47.36 “POLY – Polynomial Function” on page
1419.
47.33.4 PRCNT
The PRCNT block transforms an input signal to a 0–100% output signal.
For more information, see section 47.37 “PRCNT – Percentage” on page 1421.
47.33.5 VECTOR
In the VECTOR block the output value is calculated using a ranged array of input
values.
For more information, see section 47.38 “VECTOR – Vectorial Curve Function” on
page 1422.
04-16006-04-en, March 2015 Technical
1415
47 Function Block Types
47.34 CURVE – Curve Function
47.34 CURVE – Curve Function
The CURVE function block implements an arbitrary partially linear curve defined by a
number of curve breakpoints (xi, yi), that are the function values y = f(x) for a set of
input x values.
Figure: The Curve function block
Table: The CURVE Block Parameters
Parameter Data Type Description
Limit BINARY Selector for limit function
(limit = 1) or linear
extrapolation (limit = 0)
Dimension (Pair list x,y) REAL A list of coordinate pairs x,y
defining the breakpoints of
the curve function
Table: The CURVE Block Input
Data Type Description
REAL Input signal
Table: The CURVE Block Output
Data Type Access
BINARY RO
The number of breakpoints must not exceed 127. The number of specified
breakpoints (N) is indicated as Dimension in the graphical function block symbol.
The breakpoints are entered as a list of Real values x,y separated by commas, with
one coordinate pair on each row. The x values in the list have to be entered in order,
that is xi-1 < xi < xi+1.
The input signal is compared to the x-components of the breakpoints in order. The
first coordinate pair with an x-component greater than the input signal is chosen as
the end point of a line segment starting in the previous point. The output signal is
then calculated by linear interpolation on this line segment.
Technical 04-16006-04-en, March 2015
1416
47 Function Block Types
47.34 CURVE – Curve Function
If the limit function selector is set to 1, the output is set to y1 when the input is less
than x1, and to yN when the input is greater than xN. When the limit selector is
disabled, the output is computed by linear extrapolation whenever the input signal
exceeds the range (x1, xN).
The following is a graphical representation of a “simple” case:
Figure: A simple case of the curve function block
If two coordinates are equal, the curve look like this:
Figure: A case where two coordinates are equal.
At the discontinuity (when the input = x2) the function output is y2.
04-16006-04-en, March 2015 Technical
1417
47 Function Block Types
47.35 ENTH – Enthalpy
47.35 ENTH – Enthalpy
The ENTH block is used to calculate moist air at normal atmospheric pressure as a
function of the dry-bulb temperature and the relative humidity.
Figure: The enthalpy block
Note
• The ENTH block has no parameters.
Table: The ENTH Block Inputs
Input Data Type Description
Temperature (T) REAL Dry-bulb temperature °C (ºF)
Humidity (H) REAL Relative humidity (%)
Table: The ENTH Block Output
Data Type Access
REAL RO
The enthalpy, kJ/kg (BTU/pound), of moist air at normal atmospheric pressure is
calculated as a function of the dry-bulb temperature °C (ºF) and the relative humidity
(%).
The ENTH block uses the T input (temperature) in SI unit system (metric) or I-P
(inch-pound) unit system, depending on the regional settings of the computer on
which the function block program is generated. The metric setting produces a block
where the T input is in degrees Celsius. A US setting produces a block where the T
input is in degrees Fahrenheit.
The above-mentioned setting also determines the units for the calculated enthalpy.
An SI (metric) setting gives the result in kJ/kg. An I-P (inch-pound) setting gives a
result in BTU/pound. The calculation of enthalpy in each unit system differs, and
cannot be converted from one unit system to another.
Algorithm, SI measurement units
The water vapor saturation pressure over liquid water for the temperature range 0
to 200 °C is approximated by the following function:
pws(T) = exp(c8/T + c9 + c10*T + c11*T² + c12*T³ + c13*ln(T)) (6)
where
• T = Absolute temperature (K),
• pws = saturation pressure (Pa) and
Technical 04-16006-04-en, March 2015
1418
47 Function Block Types
47.35 ENTH – Enthalpy
• c8 = –5.8002206E+03;
• c9 = 1.3914993E+00;
• c10 = –4.8640239E-02;
• c11 = 4.1764768E-05;
• c12 = –1.4452093E-08;
• c13 = 6.5459673+00;
The enthalpy of moist air at normal atmospheric pressure as a function of the dry-
bulb temperature and the relative humidity is then given by the following equations:
pwsat = pws(t+273.15)
pw =F*pwsat/100)(24)
W = 0.62198*pw/(p-pw)(22)
h = 1.006 *t + W*(2501+1.805*t)(32)
where
• pwsat = water vapor saturation pressure (Pa)
• t = dry-bulb temperature (°C)
• F = relative humidity (%)
• pw = partial pressure of water vapor in moist air (Pa)
• p = ambient pressure (101325 Pa)
• W = humidity ratio, mass of water per unit mass of dry air
• h = enthalpy (kJ/kg)
Note
• Reference: ASHRAE Handbook 2001 – Fundamentals SI System of units.
Chapter 6, Psychrometrics. The equation numbers within parenthesis refer to
the corresponding equations in the ASHRAE Handbook.
Algorithm, I-P measurement units
The water vapor saturation pressure over liquid water for the temperature range
–80 to 300 °F is approximated by the following function:
pws(T) = exp(c8/T + c9 + c10*T + c11*T² + c12*T³ + c13*ln(T)) (6)
where
• T= Absolute temperature (ºR)
• pws = saturation pressure (psia) and
• c8 = –1.0440397E+04;
• c9 = –1.1294650E+01;
• c10 = –2.7022355E-02;
• c11 = 1.2890360E-05;
• c12 = –2.4780681E-09;
• c13 = 6.5459673;The enthalpy of moist air at normal atmospheric pressure as
a function of the dry-bulb temperature and the relative humidity is then given by
the following equations:
04-16006-04-en, March 2015 Technical
1419
47 Function Block Types
47.35 ENTH – Enthalpy
pwsat = pws(t+459.67)
pw = F*pwsat/100)(24)
W = 0.62198*pw/(p-pw)(22)
h = 0.240*t + W*(1061+0.444*t)(32)
where
• pwsat = water vapor saturation pressure (psi)
• t = dry-bulb temperature (°F)
• F = relative humidity (%)
• pw = partial pressure of water vapor in moist air (psi)
• p = ambient pressure (14.696 psi)
• W = humidity ratio, mass of water per unit mass of dry air
• h = enthalpy (BTU/Pound)
Note
• Reference: ASHRAE Handbook 2001 – Fundamentals I-P System of units.
Chapter 6, Psychrometrics. The equation numbers within parenthesis refer to
the corresponding equations in the ASHRAE Handbook.
Technical 04-16006-04-en, March 2015
1420
47 Function Block Types
47.36 POLY – Polynomial Function
47.36 POLY – Polynomial Function
The POLY block calculates the polynomial function.
Figure: The polynomial function block
Table: The POLY Block Parameter
Parameter Data Type Description
Order REAL List of coefficients
Table: The POLY Block Input
Data Type Description
REAL –
Table: The POLY Block Output
Data Type Access
REAL RO
The Polynomial block calculates the polynomial function defined by the expression:
Figure: Polynomial function
The order of the polynomial (n) is equal to the number of coefficients minus one, and
this is indicated in the graphical function block symbol. The maximum number of
coefficients is 255.
The polynomial value p(x) is calculated using an algorithm known as Horner's
scheme [Reference: Fröberg, Carl-Erik: “Numerical Mathematics – Theory and
Computer Applications”, Addison-Wesley (1985)] to improve the numerical
accuracy and reduce the number of floating point operations. The algorithm can be
described using the following equations, where p(x) = bn:
04-16006-04-en, March 2015 Technical
1421
47 Function Block Types
47.36 POLY – Polynomial Function
Figure: Polynomial value calculated by using the algorithm known as Horner's scheme
Technical 04-16006-04-en, March 2015
1422
47 Function Block Types
47.37 PRCNT – Percentage
47.37 PRCNT – Percentage
The PRCNT block transforms an input signal to a 0–100% output signal.
Figure: The percentage block
Table: The PRCNT Block Parameters
Parameter Data Type Description
Value0% REAL Value of the input variable for
0% at the output
Value100% REAL Value of the input variable for
100% at the output
Table: The PRCNT Block Input
Data Type Description
REAL Input signal
Table: The PRCNT Block Output
Data Type Access
REAL RO
04-16006-04-en, March 2015 Technical
1423
47 Function Block Types
47.38 VECTOR – Vectorial Curve Function
47.38 VECTOR – Vectorial Curve Function
In the VECTOR block the output value is calculated using a ranged array of input
values.
Figure: The Vectorial curve function block
Table: The VECTOR Block Parameters
Parameter Data Type Description
Xmin REAL Lower limit of the input range
Xmax REAL Upper limit of the input range
Dimension(Y(X)) REAL List of function values
(minimum of 2 and maximum
of 255). Each value in the list
is entered on a separate line.
Table: The VECTOR Block Input
Data Type Description
REAL Input signal
Table: The VECTOR Block Output
Data Type Access
REAL RO
The Vectorial curve function block permits the definition of any piece-wise linear
function for an input signal within the limits Xmax and Xmin. The function is defined
by specifying the output function values y = f(x) for N equally spaced input (x) values
between the two limits. For input values between two points, the function value is
calculated by linear interpolation. If the value of the input signal is less than Xmin,
the value defined at that point is used, and likewise if the input is greater than Xmax.
Technical 04-16006-04-en, March 2015
1424
47 Function Block Types
47.38 VECTOR – Vectorial Curve Function
Note
• The Vectorial curve function block can act as a ranged array of Real values for
use as a look-up table as in the example below.
Table: The VECTOR Block as a Ranged Array of Real Values
Input Output
5 34.5
6 28.0
7 42.5
8 33.9
To do this, the input must always be an integer between Xmin and Xmax (Xmin = 5,
Xmax = 8 in the example), and the number of elements in the list must be equal to
Xmax – Xmin + 1 (8 – 5 + 1 = 4 in the example).
04-16006-04-en, March 2015 Technical
1425
47 Function Block Types
47.39 Delay Blocks
47.39 Delay Blocks
A Delay block delays a signal in one of a number of ways.
47.39.1 DELAY
The DELAY on/off block delays the transitions of an input signal (state) by the time
specified in seconds as defined by the DelayOn (transition 0 to 1) and DelayOff
(transition 1 to 0) parameters.
For more information, see section 47.40 “DELAY – Delayed On/Off” on page 1426.
47.39.2 DELB
The DELB block introduces a delay of one program cycle in the propagation of a
binary signal. For each program cycle, the output value is updated with the input
value from the previous cycle.
For more information, see section 47.41 “DELB – Binary Value Delay” on page
1427.
47.39.3 DELI
The DELI block introduces a delay of one program cycle in the propagation of an
Integer signal. For each program cycle, the value of the output is updated with the
input value from the previous cycle.
For more information, see section 47.42 “DELI – Integer Value Delay” on page
1428.
47.39.4 DELR
The DELR block introduces a delay of one program cycle in the propagation of a
Real signal. For each program cycle, the value of the output is updated with the
input value from the previous cycle.
For more information, see section 47.43 “DELR – Real Value Delay” on page 1429.
47.39.5 SHB
The SHB binary value block copies the input state to the output if the control signal
is active. If the control signal is inactive the output remains in the same state.
For more information, see section 47.44 “SHB – Sample and Hold Binary Value” on
page 1430.
Technical 04-16006-04-en, March 2015
1426
47 Function Block Types
47.39 Delay Blocks
47.39.6 SHI
The SHI integer value block copies the input state to the output if the control signal
is active. If the control signal is inactive the output remains in the same state.
For more information, see section 47.45 “SHI – Sample and Hold Integer Value” on
page 1432.
47.39.7 SHR
The SHR real value block copies the input state to the output if the control signal is
active. If the control signal is inactive the output remains in the same state.
For more information, see section 47.46 “SHR – Sample and Hold Real Value” on
page 1434.
04-16006-04-en, March 2015 Technical
1427
47 Function Block Types
47.40 DELAY – Delayed On/Off
47.40 DELAY – Delayed On/Off
The DELAY on/off block delays the transitions of an input signal (state) by the time
specified in seconds as defined by the DelayOn (transition 0 to 1) and DelayOff
(transition 1 to 0) parameters.
Figure: The delayed on/off block
Table: The DELAY Block Parameters
Parameter Data Type Description
DelayOn REAL Activation delay in seconds
DelayOff REAL Deactivation delay in
seconds
Table: The DELAY Block Input
Data Type Description
BINARY State. Input signal
Table: The DELAY Block Output
Data Type Access
BINARY RO
The input signal must be true for a time interval longer than DelayOn in order to
generate a pulse on the block output. The input must also be false for a time interval
longer than DelayOff in order to reset the output to false.
Figure:
If a power outage occurs during the delay, the elapsed delay time is saved if
Backup is selected in the Edit block dialog box.
Technical 04-16006-04-en, March 2015
1428
47 Function Block Types
47.41 DELB – Binary Value Delay
47.41 DELB – Binary Value Delay
The DELB block introduces a delay of one program cycle in the propagation of a
binary signal. For each program cycle, the output value is updated with the input
value from the previous cycle.
Figure: The binary value delay block
Table: The DELB Block Parameter
Parameter Data Type Description
InitValue BINARY Initial value for the output
signal
Table: The DELB Block Input
Input Data Type Description
State BINARY Binary input signal
Table: The DELB Block Output
Data Type Access
BINAY R/W
04-16006-04-en, March 2015 Technical
1429
47 Function Block Types
47.42 DELI – Integer Value Delay
47.42 DELI – Integer Value Delay
The DELI block introduces a delay of one program cycle in the propagation of an
Integer signal. For each program cycle, the value of the output is updated with the
input value from the previous cycle.
Figure: The integer value delay block
Table: The DELI Block Parameter
Parameter Data Type Description
InitValue INTEGER Initial value for the output
signal
Table: The DELI Block Input
Input Data Type Description
Variable INTEGER Input signal
Table: The DELI Block Output
Data Type Access
INTEGER R/W
Technical 04-16006-04-en, March 2015
1430
47 Function Block Types
47.43 DELR – Real Value Delay
47.43 DELR – Real Value Delay
The DELR block introduces a delay of one program cycle in the propagation of a
Real signal. For each program cycle, the value of the output is updated with the
input value from the previous cycle.
Figure: The real value delay block
Table: The DELR Block Parameter
Parameter Data Type Description
InitValue REAL Initial value for the output
signal
Table: The DELR Block Input
Data Type Description
REAL Analog input signal
Table: The DELR Block Output
Data Type Access
REAL R/W
04-16006-04-en, March 2015 Technical
1431
47 Function Block Types
47.44 SHB – Sample and Hold Binary Value
47.44 SHB – Sample and Hold Binary Value
The SHB binary value block copies the input state to the output if the control signal
is active. If the control signal is inactive the output remains in the same state.
Figure: The sample and hold binary value block
Table: The SHB Block Parameter
Parameter Data Type Description
InitValue BINARY Initial value of the input signal
Table: The SHB Block Inputs
Input Data Type Description
State (d) BINARY Binary input signal
Control (c) BINARY Control signal
Table: The SHB Block Output
Data Type Access
BINARY R/W
Table: The Sample and Hold Function
state (t) control (t) output (t+1)
0 0 output (t)
0 0 output (t)
0 1 0
1 1 1
Technical 04-16006-04-en, March 2015
1432
47 Function Block Types
47.44 SHB – Sample and Hold Binary Value
state (t) control (t) output (t+1)
Figure: The sample and hold function binary value
Note
• When you create a function block program, this block gets the initial value as
specified in the block.
• When you edit a function block program, this block keeps the value from the
last program cycle. When you change the init value in Function Block Editor it
does not affect the block.
04-16006-04-en, March 2015 Technical
1433
47 Function Block Types
47.45 SHI – Sample and Hold Integer Value
47.45 SHI – Sample and Hold Integer Value
The SHI integer value block copies the input state to the output if the control signal
is active. If the control signal is inactive the output remains in the same state.
However, while the control signal remains inactive, the output retains the value of
the input during the last cycle that the control signal was active.
Figure: The sample and hold integer value
Table: The SHI Block Parameter
Parameter Data Type Description
InitValue INTEGER Initial value of the output
Table: The SHI Block Inputs
Input Data Type Description
Variable (D) INTEGER Analog input signal
Control (c) BINARY Control signal
Table: The SHI Block Output
Data Type Access
INTEGER R/W
Technical 04-16006-04-en, March 2015
1434
47 Function Block Types
47.45 SHI – Sample and Hold Integer Value
Data Type Access
Figure: The sample and hold integer value function
Note
• When you create a function block program, this block gets the initial value as
specified in the block.
• When you edit a function block program, this block keeps the value from the
last program cycle. When you change the init value in Function Block Editor it
does not affect the block.
04-16006-04-en, March 2015 Technical
1435
47 Function Block Types
47.46 SHR – Sample and Hold Real Value
47.46 SHR – Sample and Hold Real Value
The SHR real value block copies the input state to the output if the control signal is
active. If the control signal is inactive the output remains in the same state.
Figure: The sample and hold real value block
Table: The SHR Block Parameter
Parameter Data Type Description
InitValue INTEGER Initial value of the output
Table: The SHR Block Inputs
Input Data Type Description
Variable (D) NTEGER Analog input signal
Control (c) BINARY Control signal
Table: The SHR Block Output
Data Type Access
REAL R/W
Technical 04-16006-04-en, March 2015
1436
47 Function Block Types
47.46 SHR – Sample and Hold Real Value
Data Type Access
Figure: The sample and hold real value function
Note
• When you create a function block program, this block gets the initial value as
specified in the block.
• When you edit a function block program, this block keeps the value from the
last program cycle. When you change the init value in Function Block Editor it
does not affect the block.
04-16006-04-en, March 2015 Technical
1437
47 Function Block Types
47.47 System Variable Blocks
47.47 System Variable Blocks
The System variable blocks have no inputs. The blocks display values from the
system clock or the system program.
47.47.1 DATE
The DATE block provides the date of the month (1–31) according to the internal
system clock.
For more information, see section 47.48 “DATE – Day” on page 1438.
47.47.2 ERROR
The output of the system ERROR block is an integer value where each bit
represents an internal signal or error from the system program.
For more information, see section 47.49 “ERROR – System Error” on page 1439.
47.47.3 HOUR
The HOUR block provides the current hour (0–23) according to the internal system
clock.
For more information, see section 47.51 “HOUR – Hour” on page 1441.
47.47.4 MINUTE
The MINUTE block provides the current minute (0–59), according to the internal
system clock.
For more information, see section 47.52 “MINUTE – Minute” on page 1442.
47.47.5 MONTH
The MONTH block provides the month of the year (1–12) according to the internal
system clock.
For more information, see section 47.53 “MONTH – Month” on page 1443.
47.47.6 RST
The output in the RST block is activated the first program cycle after a warm start.
For more information, see section 47.54 “RST – Restart” on page 1444.
Technical 04-16006-04-en, March 2015
1438
47 Function Block Types
47.47 System Variable Blocks
47.47.7 SECOND
The SECOND block provides the current second (0–59), according to the system
clock.
For more information, see section 47.55 “SECOND – Second” on page 1445.
47.47.8 TCYC
The TCYC block gives the duration in seconds of the set program cycle.
For more information, see section 47.57 “TCYC – Cycle Time” on page 1447.
47.47.9 WDAY
The WDAY block provides the week according to the system clock. 1 = Monday,
and so on.
For more information, see section 47.56 “WDAY – Week Day” on page 1446.
04-16006-04-en, March 2015 Technical
1439
47 Function Block Types
47.48 DATE – Day
47.48 DATE – Day
The DATE block provides the date of the month (1–31) according to the internal
system clock.
Figure: The day block
Note
• The DATE block has no parameters.
Table: The DATE Block Output
Data Type Access
INTEGER RO
Technical 04-16006-04-en, March 2015
1440
47 Function Block Types
47.49 ERROR – System Error
47.49 ERROR – System Error
The output of the system ERROR block is an integer value where each bit
represents an internal signal or error from the system program.
Figure: The system error block
Note
• The ERROR block has no parameters.
Table: The ERROR Block Output
Data Type Access
INTEGER RO
Each output bit is set as long as the error condition remains. In the case of a restart
after a warm start, during the first program cycle following the restart, the output
value is zero when no error conditions are set.
04-16006-04-en, March 2015 Technical
1441
47 Function Block Types
47.50 Error Codes for the ERROR Function Block
47.50 Error Codes for the ERROR Function
Block
Bit 0, 1, and 3 are used for error codes in the ERROR function block.
Table: Error Codes for the ERROR Function Block
Bit No. Output Value Description
0 1 Set during the first execution
when restarted after a warm
start.
1 2 Integer underflow/overflow
when the II function block is
used in 16 bit mode (Mode
0).
3 8 RT block overflow.
Technical 04-16006-04-en, March 2015
1442
47 Function Block Types
47.51 HOUR – Hour
47.51 HOUR – Hour
The HOUR block provides the current hour (0–23) according to the internal system
clock.
Figure: The hour block
Note
• The HOUR block has no parameters.
Table: The HOUR Block Output
Data Type Access
INTEGER RO
04-16006-04-en, March 2015 Technical
1443
47 Function Block Types
47.52 MINUTE – Minute
47.52 MINUTE – Minute
The MINUTE block provides the current minute (0–59), according to the internal
system clock.
Figure: The minute block
Note
• The MINUTE block has no parameters.
Table: The MINUTE Block Output
Data Type Access
INTEGER RO
Technical 04-16006-04-en, March 2015
1444
47 Function Block Types
47.53 MONTH – Month
47.53 MONTH – Month
The MONTH block provides the month of the year (1–12) according to the internal
system clock.
• Month 1 corresponds to January
• Month 12 corresponds to December
Figure: The month block
Note
• The MONTH block has no parameters.
Table: The MONTH Block Output
Data Type Access
INTEGER RO
04-16006-04-en, March 2015 Technical
1445
47 Function Block Types
47.54 RST – Restart
47.54 RST – Restart
The output in the RST block is activated the first program cycle after a warm start.
Figure: The restart block
Note
• The RST block has no parameters.
Table: The RST Block Output
Data Type Access
BINARY RO
Technical 04-16006-04-en, March 2015
1446
47 Function Block Types
47.55 SECOND – Second
47.55 SECOND – Second
The SECOND block provides the current second (0–59), according to the system
clock.
Figure: The second block
Note
• The SECOND block has no parameters.
Table: The SECOND Block Output
Data Type Access
INTEGER RO
Note
• The output signal does not change its value during execution of the function
block program module where it is being used. This is important if longer cycle
times than one second are used.
04-16006-04-en, March 2015 Technical
1447
47 Function Block Types
47.56 WDAY – Week Day
47.56 WDAY – Week Day
The WDAY block provides the week according to the system clock. 1 = Monday,
and so on.
The output value 1 corresponds to Monday and 7 to Sunday.
The WDAY block has no parameters.
Figure: The week day block
Note
• If you use both Script and Function Block programming, for example, when
using control sequences, be aware of the following. Script uses Sunday as
the first day of the week and assigns a value of 1 to that day, while Function
Block uses Monday as the first day of the week and assigns Monday a value
of 1.
Table: The WDAY Block Output
Data Type Access
INTEGER RO
Technical 04-16006-04-en, March 2015
1448
47 Function Block Types
47.57 TCYC – Cycle Time
47.57 TCYC – Cycle Time
The TCYC block gives the duration in seconds of the set program cycle.
Figure: The cycle time block
Note
• The TCYC block has no parameters.
Table: The TCYC Block Output
Data Type Access
REAL RO
04-16006-04-en, March 2015 Technical
1449
47 Function Block Types
47.58 Controller and Filter Blocks
47.58 Controller and Filter Blocks
Controller and Filter blocks control and filter signals in a function block program.
47.58.1 FILT
The FILT block is a discrete time first order software filter.
For more information, see section 47.59 “FILT – First Order Filter” on page 1450.
47.58.2 OPT
The OPT block calculates optimum start and stop times according to actual
temperatures.
For more information, see section 47.60 “OPT – Optimization” on page 1452.
47.58.3 PIDA
The PIDA controller block is designed to be used in control loops where the
controller output is either connected to an analog physical output or used as a set
point for another control loop (cascade control).
For more information, see section 47.61 “PIDA – PID Controller – Analog Output”
on page 1459.
47.58.4 PIDI
The PIDI controller block is designed to be used together with digital pulse output
(PO) blocks in control loops with increase/decrease actuators.
For more information, see section 47.62 “PIDI – PID Controller – Incremental
Output” on page 1463.
47.58.5 PIDP
The PIDP controller block is designed to be used in control loops where the
controller output is either connected to an analog physical output or used as a set
point for another control loop (cascade control).
For more information, see section 47.63 “PIDP – PID Controller – Analog Output”
on page 1466.
47.58.6 RAMP
The RAMP filter block limits the rate of change of the input variable.
For more information, see section 47.64 “RAMP – Ramp Filter” on page 1470.
Technical 04-16006-04-en, March 2015
1450
47 Function Block Types
47.58 Controller and Filter Blocks
47.58.7 SEQ
The SEQ block activates stages in proportion to the input signal.
For more information, see section 47.65 “SEQ – Sequencer” on page 1471.
04-16006-04-en, March 2015 Technical
1451
47 Function Block Types
47.59 FILT – First Order Filter
47.59 FILT – First Order Filter
The FILT block is a discrete time first order software filter.
Figure: The first order filter block
Table: The FILT Block Parameter
Parameter Data Type Description
TimeConst REAL Time constant of the filter
measured in seconds
Table: The FILT Block Input
Data Type Description
REAL Input signal
Table: The FILT Block Output
Data Type Access
REAL R/W
The filter time constant is specified in seconds with the TimeConst parameter. The
initial block output value is zero.
The filter algorithm is:
Figure: Filter algorithm
where y(k) and u(k) are the filtered and unfiltered values at time k, respectively, h is
the sampling interval (that is the function block program cycle time), and T is the
filter time constant. If the time constant is less than or equal to zero, no filtering is
done. To obtain a good filter function, the time constant should be set significantly
greater than the function block program cycle time.
This filter algorithm is based on a straightforward backward difference
approximation of the continuous time derivative operator.
Technical 04-16006-04-en, March 2015
1452
47 Function Block Types
47.59 FILT – First Order Filter
Note
• When you create a function block program, this block gets the initial value as
specified in the block.
• When you edit a function block program, this block keeps the value from the
last program cycle. When you change the init value in Function Block Editor it
does not affect the block.
04-16006-04-en, March 2015 Technical
1453
47 Function Block Types
47.60 OPT – Optimization
47.60 OPT – Optimization
The OPT block calculates optimum start and stop times according to actual
temperatures.
Figure: The optimization block
Table: The OPT Block Parameters
Parameter Data Type Description
AutoAdjust INTEGER Automatic adjustment switch
AutoAdjust = 0 => no
adjustment
AutoAdjust = 1 =>
adjustment of curve points
AutoAdjust = 2 =>
adjustment of curve points
and holiday compensation
Default = 2
RoomTempF BINARY Room sensor flag
RoomTempF = 0 => Sensor
not present
RoomTempF = 1 => Sensor
present
Default = 1 sensor present
Technical 04-16006-04-en, March 2015
1454
47 Function Block Types
47.60 OPT – Optimization
Continued
Parameter Data Type Description
OperIndicF BINARY Flag for selecting whether
external operation indication
is present.
OperIndicF = 0 => Not
present
OperIndicF = 1 => Present
Default = 0 not present
StartTimeLo REAL Start-time (minutes) at low
outdoor temperature, -10 °C
(14 ºF), 10 °C (50 ºF).
Default = 105 °C
StartTimeHi REAL Start-time (minutes) at high
outdoor temperature, 10 °C
(50 ºF), 30 °C (86 ºF).
Default = 45 °C
HolidayComp REAL Holiday compensation (%)
when the plant has been
shut down > 48 h.
Default = 0 °C
MaxStartTi REAL Max start-time (hours).
Default = 12 °C
ETol REAL Temperature error when
switching from optimization
to normal operation.
Default = 0.5 °C
StopLoTemp REAL Low outdoor temperature
point in stop-time
optimization °C (ºF).
Default = –10 °C
StopTimeLo REAL Stop-time (minutes) when
outdoor temperature =
StopLoTemp.
Default = 0 °C
StopHiTemp REAL High outdoor temperature
point in stop-time
optimization °C (ºF).
Default = 10 °C
StopTimeHi REAL Stop-time (minutes) when
outdoor temperature =
StopHiTemp.
Default = 0 °C
04-16006-04-en, March 2015 Technical
1455
47 Function Block Types
47.60 OPT – Optimization
Continued
Parameter Data Type Description
StopTimeErr REAL Permissible deviation at the
end of normal optimal
operation. Used for
calculating stop-time.
Default = 0.5
Table: The OPT Block Inputs
Input Data Type Description
RoT REAL Room temperature ºC (ºF).
SP REAL Set point: the desired room
temperature during day time
ºC (ºF).
OuT REAL Outdoor temperature ºC (ºF).
OpI BINARY Operation indication: an
external signal that is used
for detecting whether the
controlled equipment is in
operation.
OpI = 0 => not in operation
OpI = 1 => in operation
TmL INTEGER Time left (minutes) until the
plant goes into operation. If
TmL is negative, OPT
interprets the size of TmL as
the time until the plant shuts
down.
Mode INTEGER Switch for media mode and
disabling optimization.
Mode = 0 => heating
Mode = 1 => cooling
Mode = –1 => no
optimization
Anything else is interpreted
as 0, that is, heating.
Table: The OPT Block Output
Data Type Access
INTEGER R/W
Technical 04-16006-04-en, March 2015
1456
47 Function Block Types
47.60 OPT – Optimization
Data Type Access
General
You can use the OPT block in heating as well as cooling function block programs.
OPT is executed at the same frequency as the other function blocks in the same
function block program. However, the main part of the algorithm is only executed
once every minute. The purpose of the start-time optimization is to start the
heating/cooling system in advance in order to obtain the correct temperature at the
beginning of normal operation. The purpose of the stop-time optimization is to shut
down the heating/cooling system before the end of normal operation, without the
temperature falling outside the given limits during normal operation.
You can block the optimization function by setting the parameter Mode = –1. The
output of OPT then follows the time schedule status, (output = 0 when TmL > 0,
and output = 1 when TmL < 0). Curve points and HolidayComp are not be adjusted
when Mode = –1.
The block uses the RoT, SP, and OuT inputs in the SI unit system (metric) or I-P
(inch-pound) unit system, depending on the regional settings of the computer on
which the function block program is generated. Using the metric setting produces a
block where the inputs are in degrees Celsius. A US setting produces a block
where the inputs are in degrees Fahrenheit.
The block parameters StartTimeLo and StartTimeHi define parts of coordinates for
breakpoints which are using fixed temperatures of –10 ºC (14 ºF), 10 ºC (50 ºF), and
30 ºC (86 ºF). Entering values for the start times completes definition of the
coordinates.
Start-Time Optimization
The start-time is calculated once every minute on condition that TmL > 0 and
optimization has not already started. If the calculated start-time is longer than the
time left until the plant goes into normal operation, the output of OPT is set to 2
(optimization state).
When the room temperature has reached the set point (SP) minus an adjustable
tolerance, ETol (default = 0.5 °C), the output of the function block is set to 1 (normal
operation) in order to indicate that the start-time optimization is completed and that
normal operation can begin. If the room temperature has not reached the
temperature required for normal operation, which has to be set before TmL turns
negative, the output is set to 1 at this point. During cooling, the output is instead set
to 1 when the room temperature falls below the set point (SP), plus the same
tolerance (ETol).
The start-time is obtained from a curve that defines the relationship between the
outdoor temperature (OuT) and the start-time. If a room sensor is not used, the
start-time is calculated directly from the curve with a possible contribution from
holiday compensation. When a room sensor is connected, the curve instead yields
the start-time per °C of deviation between the room temperature (RoT) and its set
point (SP). For example, the start-time is 120 min if the curve yields the value 60 min
at the outdoor temperature in question and the room temperature is 2 °C too low.
To obtain a correct start-time after longer shut-down periods, such as after holidays
or weekends, an extra contribution can be added to the start-time. Holiday
compensation is contributed to the start-time when the building has not been in use
for a long period. If the parameter OperIndicF is set to 1, OPT uses the input OpI to
decide whether the plant is in operation. If OperIndicF is set to 0, OPT ignores the
input OpI and instead assume that the plant is in operation if the output of OPT is 1
(normal operation) or 2 (optimization state).
04-16006-04-en, March 2015 Technical
1457
47 Function Block Types
47.60 OPT – Optimization
Finally, the start-time is limited to a maximum value (MaxStartTi).
OPT Output Values
The OPT block output value is used to set the plant's operating mode, as described
in the list:
• Output = 0 => Off
• Output = 1 => Normal operation
• Output = 2 => Optimization state
Curve, Start-Time as a Function of Outdoor Temperature
The curve that describes the relationship between the outdoor temperature and the
start-time, or alternatively the start-time per °C of room deviation if the room sensor
is connected, is defined by two points. The outdoor temperature at these points is
defined by the selection of the Mode (cooling or heating), while the corresponding
start-times (StartTimeLo and StartTimeHi) are freely selectable.
The outdoor temperatures of the curve points are –10 °C and 10 °C during heating,
respectively 10 °C and 30 °C during cooling. The default values for the start-times
are 105 minutes (StartTimeLo) and 45 minutes (StartTimeHi). The start-times at the
curve points can be adjusted automatically.
Figure: Curve, Start-Time as a Function of Outdoor Temperature
Automatic Adjustment of Curve Points
To be able to adjust the curve to the thermal properties of a specific building, there
is a mechanism for automatically adjusting the curve points. If the desired room
temperature has not been reached when the optimization time expires (or, if it is
reached too early), the adjustment mechanism computes an estimate of the
optimization time that should have been used and adjusts the curve points
accordingly. Automatic adjustment of the curve points can only be used in systems
with a room sensor.
Adjustment of the curve points is performed when normal operation begins
following an optimization phase and adjustment is selected (AutoAdjust > 0).
Adjustment of the curve points is not be performed when the plant has been shut
down for more than 20 hours.
You can alter the start-times in the curve points through the Operators Interface. If
this is done while optimization is active, no adjustment of the curve points is
performed when normal operation begins following this optimization phase. After
the next optimization phase, the adjustment mechanism works as normal again.
Holiday Compensation (Monday Effect)
When the building has been shut down for a long period of time, a longer heating
time is required to reach the desired temperature. To compensate for this, we add
an extra percentage of the start-time calculated above when the plant has been
shut down for more than 20 hours. 48 hours after shut down, the extra contribution
Technical 04-16006-04-en, March 2015
1458
47 Function Block Types
47.60 OPT – Optimization
is at maximum (HolidayComp), since we then assume that the building has reached
a stationary state (it will not get any colder even if the shut down lasts longer). The
percentage is increased linearly from 0 % at 20 h of shut down time to
HolidayComp % at 48 h of shut down time.
Figure: Holiday Compensation (Monday Effect)
The influence of holiday compensation is more important in systems without a room
sensor. The reason for this is that systems with a room sensor automatically start
earlier following a longer shut down, since the temperature in the room in general
has fallen more than during a normal shut down.
Automatic Adjustment of Holiday Compensation
The adjustment of holiday compensation is performed when normal operation
begins following an optimization phase, on the condition that the plant has been
shut down for more than 30 h. A necessary precondition is that adjustment has
been selected (AutoAdjust = 2). The curve points and HolidayComp are never
adjusted simultaneously following an optimization phase. The curve points can only
be adjusted if the plant has been shut down for less than 20 hours while
HolidayComp can only be adjusted if the plant has been shut down for more than
30 hours. This also means that no adjustment is performed if the shut-down time is
between 20 h and 30 h.
Stop-Time Optimization
The reason for using stop-time optimization is to save energy by stopping
heating/cooling before the end of the occupancy time. It is of course important that
the room temperature does not fall outside an acceptable temperature range during
the occupancy time. Since the stop time that can be used without the temperature
falling outside the acceptable temperature range depends on the room
temperature, optimized stop is normally only used in systems with a room sensor.
The stop time is obtained from a curve that describes the relationship between
outdoor temperature and stop time. The curve gives the stop time per °C of
deviation between the room temperature and the lowest permissible temperature in
the room at the end of normal operation, when a room sensor is used. The lowest
permissible temperature is set to the set point (SP) minus StopTimeErr during
heating. StopTimeErr is by default = 0.5 °C.
Figure: Stop-Time Optimization
During cooling, the highest permissible room temperature in the room at the end of
normal operation is set to the set point plus StopTimeErr. If a room sensor is not
used, the optimization function assumes that the room temperature exceeds the set
point by 1 °C in heating operation and is 1 °C below the set point during cooling, cf.
04-16006-04-en, March 2015 Technical
1459
47 Function Block Types
47.60 OPT – Optimization
start-time optimization. Both x (StopLoTemp and StopHiTemp) and y-values
(StopTimeLo and StopTimeHi) for both curve points are freely selectable. The
default values are (-10 °C, 0 min) and (10 °C, 0 min) respectively. This implies that
stop-time optimization does not have any effect before these parameters are
changed. The reason for this is that stop-time optimization is seldom used.
Technical 04-16006-04-en, March 2015
1460
47 Function Block Types
47.61 PIDA – PID Controller – Analog Output
47.61 PIDA – PID Controller – Analog Output
The PIDA controller block is designed to be used in control loops where the
controller output is either connected to an analog physical output or used as a set
point for another control loop (cascade control).
Figure: The PID controller - analog output block
Table: The PIDA Block Parameters
Parameter Data Type Description
ControlInt REAL Control interval (seconds)
UMin REAL Minimum permissible control
signal
UMax REAL Maximum permissible control
signal
StrokeTime REAL Actuator full stroke travel
time (seconds)
Table: The PIDA Block Inputs
Input Data Type Description
MV REAL Measured value
SP REAL Setpoint
Mod INTEGER Controller operating mode
G REAL Proportional gain
Ti REAL Integral time (seconds)
Td REAL Derivative time (seconds)
DZ REAL Dead zone
04-16006-04-en, March 2015 Technical
1461
47 Function Block Types
47.61 PIDA – PID Controller – Analog Output
Continued
Input Data Type Description
TSg REAL Tracking signal (actual value
of the previous control signal)
Table: The PIDA Block Output
Data Type Access
REAL R/W
Control Algorithm
The PIDA block is designed to be used in control loops where the controller output
is either connected to an analog physical output or used as a setpoint for another
control loop (cascade control). The control algorithm is a discrete time-incremental
PID algorithm, where the change in control signal du(t) is calculated as:
Figure: Control algorithm
where:
• e = control error
• y = measured value (MV)
• G = controller gain
• Ti = integral time
• Td = derivative time and
• h = control interval (ControlInt), that is, the time between two successive
updates of the controller output signal.
If ControlInt is set to 0, the control interval is automatically set equal to the program
cycle time. Time index t represents the present value of a variable, t-h represents
the value at the previous evaluation of the control algorithm, and so on.
The PID-module is executed at the interval hx seconds, where hx seconds is the
function block program execution interval, even if the selected control interval is
longer. The control interval, h, must be a multiple of hx. If this is not the case, the
PID algorithm automatically selects the closest multiple smaller than h as the control
interval. By default, the control interval is set equal to 1.
The control error e is defined as e = SP – MV. Thus, if the measured value is below
the setpoint and the gain G is positive, the controller output increases (heating
control). With a negative G value, the controller output decreases instead (cooling
control). When the control error is smaller than the dead zone, that is, abs(e) < DZ,
the change in the control output, du(t), is set to zero. The dead zone is given in the
same units as the measurement value and the setpoint.
The controller output signal is calculated as:
Technical 04-16006-04-en, March 2015
1462
47 Function Block Types
47.61 PIDA – PID Controller – Analog Output
Figure: Controller output
where:
• u(t) = present control signal and
• u(t–h) = previous value of the control signal
The value of u(t–h) is taken from the input TSg, which represents the actual value of
the previous control signal, taking into account any external limitations and/or
override functions in the function block program. Normally, the TSg input would be
connected directly to the controller output.
The proportional band corresponding to a certain proportional gain value G can be
calculated as:
Figure: Proportional band
P and PD Controller
The algorithm described above is used when the controller has integral action. If a
controller without I- or D-action is desired, Ti or Td respectively is set to 0. In
accordance with this, a PI-controller is obtained by setting Ti > 0 and Td = 0. If the
gain G is set to 0, the program does not fail to execute, but the control signal is not
changed, regardless of the size of the error.
If the incremental control algorithm in the equation (1) is used without integral
action, an arbitrarily large stationary error can be obtained which is not necessarily
decreased if the controller gain is increased. For this reason, we use a special
algorithm for P and PD control, where the control signal is calculated according to
the equation:
Figure: Calculation of control signal
where:
• UMax is the biggest permissible control signal and
• UMin is the smallest permissible control signal.
Limitation of the Control Signal
The maximum rate of change of the controller output during one control interval,
DuMax, depends on the actuator stroke time and can be calculated as:
Figure: Calculation of actuator stroke time
The calculated change in the control output, du(t), is limited to the range ±DuMax
before the absolute level of the control signal is calculated. The calculated new
control signal u(t) is limited to the interval (UMin, UMax). The parameters UMin and
UMax should be given in engineering units. Default values are 0 and 100 (%),
respectively.
04-16006-04-en, March 2015 Technical
1463
47 Function Block Types
47.61 PIDA – PID Controller – Analog Output
The parameter StrokeTime is used to define the actual full stroke travel time of the
actuator. StrokeTime can be used to limit the change of the control signal even if
the output is not connected to an actuator. The StrokeTime is then the minimum
permissible time for the control signal to change from UMin to UMax. If the
controller output is used as a setpoint for another controller and there is no special
reason for limiting the change in the control signal, StrokeTime should be set to 0.
Operating Mode
The controller operating mode depends on the input signal Mode where:
• Mode = 0 => Off, controller stopped (du = 0)
• Mode = 1 => Normal control
• Mode = 2 => Controller output forced to UMax
• Mode = 3 => Controller output forced to UMin
If Mode = 0, the controller output tracks the signal on the tracking signal (TSg) input.
If Mode < 0 or Mode > 3, the controller operating mode is Off (same as Mode = 0).
Technical 04-16006-04-en, March 2015
1464
47 Function Block Types
47.62 PIDI – PID Controller – Incremental Output
47.62 PIDI – PID Controller – Incremental
Output
The PIDI controller block is designed to be used together with digital pulse output
(PO) blocks in control loops with increase/decrease actuators.
Figure: The PID controller - incremental output block
Table: The PIDI Block Parameters
Parameter Data Type Description
ControlInt REAL Control interval (seconds)
StrokeTime REAL Actuator full stroke travel
time (seconds)
Table: The PIDI Block Inputs
Input Data Type Description
MV REAL Measured value
SP REAL Setpoint
Mod INTEGER Controller operating mode
G REAL Proportional gain
Ti REAL Integral time (seconds)
Td REAL Derivative time (seconds)
DZ REAL Dead zone
04-16006-04-en, March 2015 Technical
1465
47 Function Block Types
47.62 PIDI – PID Controller – Incremental Output
Input Data Type Description
Table: The PIDI Block Output
Data Type Access
REAL R/W
Control Algorithm
The control algorithm is a discrete time incremental PID algorithm, where the
calculated change (increment) in the control signal is converted to the
corresponding travel time of the actuator. The change in the control signal du(t) is
calculated using the same formula as in the PIDA block (cf. equation (1) in the PIDA
block description).
The calculated change in the control signal, du(t), is converted to the corresponding
actuator travel time dt (in seconds) using the following equation:
Figure: Calculated change of control signal
where: StrokeTime is the full stroke actuator travel time (in seconds). It is assumed
that StrokeTime corresponds to a 100% change in the actuator position. The PIDI
block output is the computed dt value.
If StrokeTime is set to 0, a stroke time of 60 seconds is automatically used.
If ControlInt is set to 0, the control interval is automatically set equal to the Function
Block Program cycle time. However, if the ControlInt is longer than the cycle time
(hx), the PO block cannot be active more than hx seconds before a new output
from the PIDI block is calculated. This means that the output time dt, calculated in
equation (2), has to be propagated in pieces that are not longer than hx.
Example: If ControlInt = 10 s, hx = 1 s and dt = 5.5 s, the output from the PIDI block
is 1 s for 5 cycles, then 0.5 s during the sixth cycle and finally 0 s during the
following 4 cycles, until it is time to calculate dt again.
The proportional band corresponding to a certain proportional gain value can be
calculated as:
Figure: Calculated proportional band
P- and PD Control
A controller with an incremental output does not work very well without I-action.
Arbitrarily large steady state errors can be obtained, which do not necessarily
decrease when the controller gain is increased. For this reason, a controller with an
incremental output without I-action should not be used. However, if a controller
without I or D-action is desired, Ti or Td respectively is 0. In accordance with this, a
PI-controller is obtained by setting Ti > 0 and Td = 0. If the gain G is set to 0, the
program does execute, but the control signal does not change regardless of the
size of the error.
Technical 04-16006-04-en, March 2015
1466
47 Function Block Types
47.62 PIDI – PID Controller – Incremental Output
Limitation of the Control Signal
The calculated travel time is limited to the range ±ControlInt (sec), since that is the
maximum amount of actuator travel time that can be obtained during one control
interval.
Operating Mode
The controller operating mode depends on the input signal Mode where:
• Mode = 0 => Off, controller stopped (dt = 0)
• Mode = 1 => Normal control
• Mode = 2 => Actuator forced to max (dt = ControlInt seconds)
• Mode = 3 => Actuator forced to min, (dt = –ControlInt seconds)
Note that when Mode = 2 or 3, the travel time is set to the smallest value that
makes the actuator move constantly in the desired direction. If Mode < 0 or Mode >
3, the controller operating mode is Off (same as Mode = 0).
04-16006-04-en, March 2015 Technical
1467
47 Function Block Types
47.63 PIDP – PID Controller – Analog Output
47.63 PIDP – PID Controller – Analog Output
The PIDP controller block is designed to be used in control loops where the
controller output is either connected to an analog physical output or used as a set
point for another control loop (cascade control).
Figure: The PID controller - analog output - block
Table: The PIDP Block Parameters
Parameter Data Type Description
ControlInt REAL Control interval (seconds)
UMin REAL Minimum permissible control
signal
UMax REAL Maximum permissible control
signal
StrokeTime REAL Actuator full stroke travel
time (seconds)
Table: The PIDP Block Inputs
Input Data Type Description
MV REAL Measured value
SP REAL Setpoint
Mode INTEGER Controller operating mode
G REAL Proportional gain
Ti REAL Integral time (seconds)
Td REAL Derivative time (seconds)
DZ REAL Dead zone
TSg REAL Tracking signal (actual value
of the previous control signal)
Technical 04-16006-04-en, March 2015
1468
47 Function Block Types
47.63 PIDP – PID Controller – Analog Output
Input Data Type Description
Table: The PIDP Block Output
Data Type Access
REAL R/W
Control Algorithm
The control algorithm is a discrete time positional PID algorithm, where the output
signal U(k) is calculated according to the diagram:
Figure: Figure control algorithm
Here SP is the setpoint value, MV is the measured value, G is the controller gain, Ti
is the integral time, Td is the derivative time and h is the control interval (ControlInt),
that is, the time between two successive updates of the controller output signal. If
ControlInt is set to 0, the control interval is automatically set equal to the program
cycle time.
04-16006-04-en, March 2015 Technical
1469
47 Function Block Types
47.63 PIDP – PID Controller – Analog Output
Time index k represents the present value of a variable, k-1 represents the value at
the previous evaluation of the control algorithm, and so on.
The PID-module is executed at the interval hx seconds, where hx seconds is the
function block program execution interval, even if the selected control interval is
longer. The control interval, h, must be a multiple of hx. If this is not the case, the
PID algorithm automatically selects the closest multiple smaller than h as the control
interval. By default the control interval is set equal to 1.
When the control error is smaller than the dead zone, that is abs(e) < DZ, the control
signal is set to the same value as the previous output, that is, the output is not
changed. The dead zone is given in the same units as the measurement value and
the setpoint.
Other Controller Types
The algorithm described above can be used for all types of controllers. At PI or PID
control the P-part does not depend on the difference between the setpoint and the
measured value, but only on the measured value, MV.
If P or PD control is used, the P-part automatically changes to depend on the error
(SP-MV). When these controllers are used, an offset value is also added to the
output signal:
Figure: Calculation of output signal
where Umax is the biggest permissible control signal and Umin is the smallest
permissible control signal.
If a controller without I- or D-action is desired, Ti or Td respectively is set to 0. In
accordance with this a PI-controller is obtained by setting Ti > 0 and Td = 0. If the
gain G is set to 0, the program does not fail to execute, but the control signal is not
changed regardless of the size of error.
Please note that when any of the G, Ti and Td parameters have been changed, an
automatic internal update of the controller is performed. No measures have to be
taken in the Function Block Program to avoid bumps in the control signal.
Limitation of the Control Signal
The parameter StrokeTime is used to define the actual full stroke travel time of the
actuator. Note that StrokeTime can be used to limit the change of the control signal
even if the output is not connected to an actuator.
If the controller output is used as a setpoint for another controller and there is no
special reason for limiting the change in the control signal, StrokeTime should be
set to 0, which is also the default value.
The maximum rate of change of the controller output during one control interval,
DuMax, depends on the actuator stroke time and can be calculated as:
Technical 04-16006-04-en, March 2015
1470
47 Function Block Types
47.63 PIDP – PID Controller – Analog Output
Figure: Calculated actuator stroke time
This corresponds to the maximum change in two successive output signals from
the PIDP block.
The calculated new control signal u(t) is limited to the interval (Umin , Umax). The
parameters UMin and UMax should be given in engineering units. Default values are
0 and 100 (%), respectively.
Operating Mode
The controller operating mode depends on the input signal Mode where:
• Mode = 0 => Off, controller stopped
• Mode = 1 => Normal control
• Mode = 2 => Controller output forced to UMax
• Mode = 3 => Controller output forced to UMin
If Mode = 0, the controller output tracks the signal on the tracking signal (TSg) input.
If Mode = 1, the controller ignores the (TSg input). If Mode < 0 or Mode > 3, the
controller operating mode is Off (same as Mode = 0).
04-16006-04-en, March 2015 Technical
1471
47 Function Block Types
47.64 RAMP – Ramp Filter
47.64 RAMP – Ramp Filter
The RAMP filter block limits the rate of change of the input variable.
Figure: The ramp filter block
Table: The RAMP Block Parameter
Parameter Data Type Description
Increment REAL Maximum increment in the
signal per second
Table: The RAMP Block Input
Data Type Description
REAL Input signal
Table: The RAMP Block Output
Data Type Access
REAL R/W
The maximum increment in the output signal per second is given by the parameter
increment. The sign of the increment parameter is ignored and the absolute value is
used as a rate limit.
Note
• When you create a function block program, this block gets the initial value as
specified in the block.
• When you edit a function block program, this block keeps the value from the
last program cycle. When you change the init value in Function Block Editor it
does not affect the block.
Technical 04-16006-04-en, March 2015
1472
47 Function Block Types
47.65 SEQ – Sequencer
47.65 SEQ – Sequencer
The SEQ block activates stages in proportion to the input signal.
Figure: The sequencer block
Table: The SEQ Block Parameters
Parameter Data Type Description
Stages REAL Number of output stages (1
to 16)
Rotation BINARY Defines whether or not there
is rotation of the stages
Period INTEGER Delay of simultaneous
activation of the stages in
milliseconds
Hysteresis REAL Width of the hysteresis (%)
Table: The SEQ Block Input
Data Type Description
REAL Input signal (%)
Table: The SEQ Block Output
Data Type Access
INTEGER RO
The Sequencer block is used to start N of M stages, where M is the total number of
output stages as defined by the Stages parameter (up to a maximum of 16) and N
is the Integer part of the result of the following calculation:
04-16006-04-en, March 2015 Technical
1473
47 Function Block Types
47.65 SEQ – Sequencer
Figure: Sequencer block algorithm
where Input is a value between 0% and 100%. The M stages are represented by
the first M bits of the Integer block output value. The first N of these bits is true (1)
and the rest false (0).
Example: If Stages is 4, and neither Hysteresis nor Rotation is used, stage one
starts (Output = 1; 0001) at 20% Input signal, stage two (Output = 3; 0011) at 40%,
stage three (Output = 7; 0111) at 60% and stage four (Output = 15; 1111) at 80%.
Function Block Editor uses a two-complement representation of signed integers,
the output signal for starting 16 stages would be –1 (1111111111111111).
If the Hysteresis parameter is zero, the previous formula gives the number of
activated stages as a function of the input signal. If Hysteresis has a non-zero value,
a hysteresis loop exists to the left or to the right (depending on whether Hysteresis
is a negative or a positive number) of the points calculated in the previous equation.
In this case, the activation values of the stages are displaced with respect to the
deactivation values. For example, if we define a 4 stage sequencer, the stages
started according to the previous formula is one stage at 20%, two stages at 40%,
three stages at 60% and four stages at 80%. If a positive hysteresis is defined,
equal to 10, activation of the stages is displaced to the right by 10%. The stages are
activated at 30%, 50%, 70% and 90%, but deactivation is maintained at the
previous values.
On the other hand, if the hysteresis were negative, for example –15%, deactivation
would be displaced to the left and so the stages would activate at 20%, 40%, 60%
and 80% and deactivate at 5%, 25%, 45% and 65%.
Figure: Hysteresis in different stages
The Period parameter is used to prevent two or more stages from being activated
simultaneously. If the value is non-zero, the stages is always activated sequentially
with an interval equal to Period (milliseconds), even if the input were to vary sharply,
obliging simultaneous activation of the stages. However, if this value is zero, the
stages can be activated simultaneously.
The Rotation parameter determines whether the active stages should rotate or not.
The difference between Rotation = 1 (with rotation) and Rotation = 0 (without
rotation) is that, in the first case, the stages deactivates in the same order in which
they activated. The stage which has been active longest is always deactivated first,
while in the second case, the deactivation order is the opposite of the activation
order. When the sequencer is defined with rotation, you can assume that the time
during which each stage remains active be approximately the same for all stages.
Technical 04-16006-04-en, March 2015
1474
47 Function Block Types
47.66 Signal Source Blocks
47.66 Signal Source Blocks
Signal sources are function blocks that can give signals into the function block
program.
47.66.1 NCYC
The NCYC program cycle counter block increments the output value by one unit
each program cycle if InitValue is less than Final, and decreases the output value if
the opposite applies. When the count reaches the final value, the counter restarts
the count at the initial value in the next cycle.
For more information, see section 47.67 “NCYC – Program Cycle Counter” on page
1474.
47.66.2 OSC
The OSC oscillator block generates a train of pulses of duration PulseTime and a
period of CycleTime.
For more information, see section 47.68 “OSC – Oscillator” on page 1475.
47.66.3 PVB
The PVB block is used to assign a binary value to the input signal of another block.
For more information, see section 47.69 “PVB – Parameter Value Binary” on page
1476.
47.66.4 PVI
The PVI block is used to assign an integer value to the input signal of another block.
For more information, see section 47.70 “PVI – Integer Value Parameter” on page
1477.
47.66.5 PVR
The PVR block is used to assign a real value to the input signal of another block.
For more information, see section 47.71 “PVR – Real Value Parameter” on page
1478.
04-16006-04-en, March 2015 Technical
1475
47 Function Block Types
47.67 NCYC – Program Cycle Counter
47.67 NCYC – Program Cycle Counter
The NCYC program cycle counter block increments the output value by one unit
each program cycle if InitValue is less than Final, and decreases the output value if
the opposite applies. When the count reaches the final value, the counter restarts
the count at the initial value in the next cycle.
Figure: The program cycle counter block
Note
• When you create a function block program, this block gets the initial value as
specified in the block.
• When you edit a function block program, this block keeps the value from the
last program cycle. When you change the init value in Function Block Editor it
does not affect the block.
Table: The NCYC Block Parameters
Parameter Data Type Description
InitValue INTEGER Initial value of the counter
Final INTEGER Final value of the counter
Table: The NCYC block output
Data Type Access
INTEGER R/W
Technical 04-16006-04-en, March 2015
1476
47 Function Block Types
47.68 OSC – Oscillator
47.68 OSC – Oscillator
The OSC oscillator block generates a train of pulses of duration PulseTime and a
period of CycleTime.
Figure: The oscillator block
Table: The OSC Block Parameters
Parameter Data Type Description
CycleTime REAL Oscillation period (seconds)
PulseTime REAL Pulse duration (seconds)
Table: The OSC Block Output
Data Type Access
BINARY RO
The train of pulses is always a multiple of the program cycle time. For example, if
CycleTime is 7.4 seconds and PulseTime is 5.2 seconds and the function block
program cycle time is 1 second, a 6 second pulse fires every eight seconds.
04-16006-04-en, March 2015 Technical
1477
47 Function Block Types
47.69 PVB – Parameter Value Binary
47.69 PVB – Parameter Value Binary
The PVB block is used to assign a binary value to the input signal of another block.
Figure: The binary value parameter block
Table: The PVB Block Parameter
Parameter Data Type Description
InitValue BINARY Initial output state
Table: The PVB Block Output
Data Type Access
BINARY R/W
The initial state of the output is determined by the InitValue parameter.
If the output signal is not public, this block acts as a constant parameter value for
another block input, since it is never modified during execution of the function block
program.
Note
• When you create a function block program, this block gets the initial value as
specified in the block.
• For public PVx blocks: When a program is edited, this block will keep the
value from the last program cycle. A change of the init value in the editor will
have no effect.
• For non public PVx blocks: When a program is edited, this block will get the
new value from the editor.
Technical 04-16006-04-en, March 2015
1478
47 Function Block Types
47.70 PVI – Integer Value Parameter
47.70 PVI – Integer Value Parameter
The PVI block is used to assign an integer value to the input signal of another block.
Figure: The integer value parameter
Table: The PVI Block Parameter
Parameter Data Type Description
InitValue INTEGER Initial value of the output
signal
Table: The PVI Block Output
Data Type Access
INTEGER R/W
The initial value of the output is determined by the InitValue parameter.
If the output signal is not public, this block acts as a constant parameter value for
another block input, since it is never modified during execution of the function block
program.
Note
• When you create a function block program, this block gets the initial value as
specified in the block.
• For public PVx blocks: When a program is edited, this block will keep the
value from the last program cycle. A change of the init value in the editor will
have no effect.
• For non public PVx blocks: When a program is edited, this block will get the
new value from the editor.
04-16006-04-en, March 2015 Technical
1479
47 Function Block Types
47.71 PVR – Real Value Parameter
47.71 PVR – Real Value Parameter
The PVR block is used to assign a real value to the input signal of another block.
Figure: The real value parameter block
Table: The PVR Block Parameter
Parameter Data Type Description
InitValue REAL Initial value of the output
Table: The PVR Block Output
Data Type Access
REAL R/W
The initial value of the output is determined by the InitValue parameter.
If the output signal is not public, this block acts as a constant parameter value for
another block input, since it is never modified during execution of the function block
program.
Note
• When you create a function block program, this block gets the initial value as
specified in the block.
• For public PVx blocks: When a program is edited, this block will keep the
value from the last program cycle. A change of the init value in the editor will
have no effect.
• For non public PVx blocks: When a program is edited, this block will get the
new value from the editor.
Technical 04-16006-04-en, March 2015
1480
48 Function Block Operators
Topics
Operators
Adding an Operator
Constant Operators
Logical Operators
Math Operators
Comparison Operators
Bit Operators
Bit Operator Examples
Miscellaneous Operators
48 Function Block Operators
48.1 Operators
48.1 Operators
An operator is a type of function, which can perform an operation on one or several
operands.
Figure: An example of an operator
You can connect the analog input of an operator to a real or an integer output. You
can connect the analog output of an operator to both real and integer inputs. When
the analog output of an operator is connected to an integer input, the operator
output is converted to an integer.
Note
• If the same operator output is connected to more than one function block,
these inputs receive an integer signal. An additional conversion might be
needed.
You can only connect binary inputs to other binary outputs.
Note
• Function Block Editor performs Modulo operations on integers.
48.1.1 Constant Operators
Constant operators give a static value to the function block program.
Table: Constant Operators
Name Description
Binary const No input / Binary output
Integer const No input / Integer output
Real const No input / Real output
48.1.2 Logical Operators
Logical operators perform logical operations.
Table: Logical Operators
Name Description
NOT Binary input – Binary output
04-16006-04-en, March 2015 Technical
1483
48 Function Block Operators
48.1 Operators
Continued
Name Description
AND Binary inputs – Binary output
OR Binary inputs – Binary output
XOR Binary inputs – Binary output
48.1.3 Math Operators
Math operators perform mathematical operations.
Table: Math Operators
Name Description
Negate Analog input – Analog output
Addition Analog inputs – Analog output
Subtraction Analog inputs – Analog output
Product Analog inputs – Analog output
Division Analog inputs – Analog output
Module Analog inputs – Analog output
48.1.4 Comparison Operators
Operators used in comparison operations.
Table: Comparison Operators
Name Description
Less than Analog inputs – Binary output
Greater than Analog inputs – Binary output
Equal Analog inputs – Binary output
Not equal Analog inputs – Binary output
Greater or equal Analog inputs – Binary output
Less or equal Analog inputs – Binary output
48.1.5 Bit Operators
Operators used in bit operations.
Technical 04-16006-04-en, March 2015
1484
48 Function Block Operators
48.1 Operators
Table: Bit Operators
Name Description
bit AND Analog inputs – Analog output
bit OR Analog inputs – Analog output
bit XOR Analog inputs – Analog output
Shift right Analog inputs – Analog output
Shift left Analog inputs – Analog output
48.1.6 Other Operators
Miscellaneous uncategorized operators.
Table: Other Operators
Name Description
D/A converter Binary input – Analog output
A/D converter Analog input – Binary output
Analog multiplexer Analog inputs – Analog output
Binary multiplexer Binary inputs – Binary output
Conversion AA Integer signal – Real signal
or
Real signal – Integer signal
04-16006-04-en, March 2015 Technical
1485
48 Function Block Operators
48.2 Adding an Operator
48.2 Adding an Operator
You create a program by adding simple blocks, operators, and expression blocks.
For more information, see section 48.1 “Operators” on page 1481.
To add an operator
1. In Function Block Editor, right-click in the diagram window at the position
where you want to add the operator.
2. On the NEW menu, click Operator.
3. In the Operators list, select the operator you want to add.
4. Click OK.
5. If the operator is enclosed by a red rectangle, move the operator to an empty
space.
6. Click outside the green rectangle that encloses the operator to clear the
selection.
Technical 04-16006-04-en, March 2015
1486
48 Function Block Operators
48.3 Constant Operators
48.3 Constant Operators
Constant operators give a static value to the function block program.
48.3.1 Binary Const
Binary constants give a binary static value to the function block program.
Inputs and Outputs
No input / Binary output
48.3.2 Integer Const
Integer constants give an integer static value to the function block program.
Inputs and Outputs
No input / Integer output
48.3.3 Real Const
Real constants give a real static value to the function block program.
Inputs and Outputs
No input / Real output
04-16006-04-en, March 2015 Technical
1487
48 Function Block Operators
48.4 Logical Operators
48.4 Logical Operators
Logical operators perform logical operations.
48.4.1 NOT operator
Logical NOT operators invert binary signals.
Inputs and Outputs
Binary input / Binary output
48.4.2 AND operator
AND operators perform logical AND operations between two binary signals.
Inputs and Output
Binary inputs / Binary output
48.4.3 OR operator
OR operators perform logical OR operations between two binary signals.
Inputs and Output
Binary inputs / Binary output
48.4.4 XOR operator
XOR operators perform logical XOR operations between two binary signals.
Inputs and Output
Binary inputs / Binary output
Technical 04-16006-04-en, March 2015
1488
48 Function Block Operators
48.5 Math Operators
48.5 Math Operators
Math operators perform mathematical operations.
48.5.1 Negate
Negate operators invert analog signals.
Input and Output
Analog input / Analog output.
48.5.2 Addition
Addition operators add values of analog signals.
Inputs and Output
Analog inputs / Analog output
48.5.3 Subtraction
Subtraction operators subtract one value from another.
Inputs and Output
Analog inputs / Analog output
48.5.4 Product
Product operators multiply two analog signals.
Inputs and Output
Analog inputs / Analog output
48.5.5 Division
Division operators divide two analog signals.
Inputs and Output
Analog inputs / Analog output
48.5.6 Modulo
Modulo operators calculate the remainder of division of one number by another.
04-16006-04-en, March 2015 Technical
1489
48 Function Block Operators
48.5 Math Operators
Inputs and Output
Analog inputs / Analog output
Technical 04-16006-04-en, March 2015
1490
48 Function Block Operators
48.6 Comparison Operators
48.6 Comparison Operators
Operators used in comparison operations.
48.6.1 Less than
Less than operators compare two analog values.
Inputs and Output
Analog inputs / Binary output
48.6.2 Greater than
Greater than operators compare two analog values.
Inputs and Output
Analog inputs / Binary output
48.6.3 Equal
Equal operator compare two analog values.
Inputs and Output
Analog inputs / Binary output
48.6.4 Not Equal
Not equal operators compare two analog values.
Inputs and Output
Analog inputs / Binary output
48.6.5 Greater or Equal
Greater or equal operators compare two analog values.
Inputs and Output
Analog inputs / Binary output
48.6.6 Less or Equal
Less or equal operators compare two analog values.
04-16006-04-en, March 2015 Technical
1491
48 Function Block Operators
48.6 Comparison Operators
Inputs and Output
Analog inputs / Binary output
Technical 04-16006-04-en, March 2015
1492
48 Function Block Operators
48.7 Bit Operators
48.7 Bit Operators
Operators used in bit operations.
48.7.1 bit AND
Bit AND operators compare bitwise AND operations.
Inputs and Output
Integer inputs / Integer output
48.7.2 bit OR
Bit OR operators compare bitwise OR operations.
Inputs and Output
Integer inputs / Integer output
48.7.3 bit XOR
Bit XOR operators compare bitwise XOR operations.
Inputs and Output
Integer inputs / Integer output
48.7.4 Shift Right
Shift right operators right-shift and insert 0 to the left most bit positions. The second
input indicates the number of positions to move.
Inputs and Output
Integer inputs / Integer output
48.7.5 Shift Left
Shift left operators left-shift and insert 0 to the right most bit positions. The second
input indicates the number of positions to move.
Inputs and Output
Integer inputs / Integer output
04-16006-04-en, March 2015 Technical
1493
48 Function Block Operators
48.8 Bit Operator Examples
48.8 Bit Operator Examples
Bit operators operate on bit level and have integers as signals.
Bit operation example
Figure: Operator bit AND – Analog inputs -> Analog output
Figure: Operator bit OR – Analog inputs -> Analog output
Figure: Operator XOR bit – Analog inputs -> Analog output
Figure: Operator << – Analog inputs -> Analog output
Technical 04-16006-04-en, March 2015
1494
48 Function Block Operators
48.8 Bit Operator Examples
Figure: Operator >> – Analog inputs -> Analog output
Note
• All 16 positions are shifted, and 0 is shifted into empty positions. Any shift
count >16 always gives the output value 0.
04-16006-04-en, March 2015 Technical
1495
48 Function Block Operators
48.9 Miscellaneous Operators
48.9 Miscellaneous Operators
Miscellaneous uncategorized operators.
48.9.1 D/A Converter
D/A Converter operators convert binary signals to an analog value. Logical FALSE
gives 0, logical TRUE gives 1.
Inputs and Output
Binary inputs / Analog output
48.9.2 A/D Converter
A/D Converter operators convert analog values to a binary signal. 0 gives logical
FALSE, all other values give logical TRUE.
Inputs and Output
Analog inputs / Binary output
48.9.3 Analog Multiplexer
Analog multiplexer operators select one of two possible analog values depending
on the logical signal.
Inputs and Output
Two analog and one binary input / Analog output
48.9.4 Binary Multiplexer
Binary multiplexer operators select one of two possible binary signals depending on
the logical signal.
Inputs and Output
Three binary inputs / Binary output
48.9.5 Conversion AA
Conversion AA operators convert a real value to an integer value or an integer value
to a real value.
Inputs and Output
Analog input / Analog output
Technical 04-16006-04-en, March 2015
1496
49 Function Block User Interface
Topics
Function Block Editor (Edit Mode)
Function Block Editor File Menu
Function Block Editor Edit Menu
Preferences Menu
Options Menu
Zoom Menu
Commands Menu
Function Block Editor Tools Menu
Function Block Editor Help Menu
Import Dialog Box
Export Dialog Box
Print Dialog Box
Page Setup Dialog Box
Search Dialog Box
Replace Dialog Box
NEW Menu
BLOCK Menu
INPUT Menu
OUTPUT Menu
CONNECTION Menu
Select Simple Block Dialog Box
Edit Expression Dialog Box
Edit Block Dialog Box
Select Operator Dialog Box
Edit Operator Dialog Box
Constants Table Dialog Box
New Constant Dialog Box
Public Signal Table
Edit Hierarchy Dialog Box
Edit Comment Dialog Box
Font Dialog Box
Select Hierarchy Connection Dialog Box
HFB Navigation Tree
Function Block Editor (Simulation Mode)
File Menu in Simulation Mode
Preferences Menu in Simulation Mode
Options Menu in Simulation Mode
Set Date and Time (Simulation) Dialog Box
Analog Input Dialog Box
Digital Input Dialog Box
RECORD Menu
Edit Break Limit Dialog Box
TREND Menu
SIGNAL Menu
Function Block Program Properties – Basic Tab
Function Block Program Properties – Inputs Tab
Function Block Program Properties – Public Signals Tab
Function Block Program Properties – Outputs Tab
Function Block Program Properties – References Tab
49 Function Block User Interface
49.1 Function Block Editor (Edit Mode)
49.1 Function Block Editor (Edit Mode)
Use Function Block Editor in Edit mode to program new or edit existing function
block programs. The work area in Edit mode consists of the diagram window.
Figure: Function Block Editor window in Edit mode
Table: Function Block Editor Window in Edit Mode
Number Description
Function Block Editor menu bar
Function Block Editor diagram window
Function block program in diagram window
Function Block Editor position indicator
04-16006-04-en, March 2015 Technical
1499
49 Function Block User Interface
49.2 Function Block Editor File Menu
49.2 Function Block Editor File Menu
Use the File menu in Edit mode to save, import, export, and print function block
programs.
Figure: Function Block Editor File menu
Component Description
Save Saves the function block program to the
object in the Building Operation database.
Import Opens the Import dialog box where you
import a function block program as an .aut
file.
Export Opens the Export dialog box where you
export a function block program as an .aut
file.
Print Opens the Print dialog box.
Technical 04-16006-04-en, March 2015
1500
49 Function Block User Interface
49.3 Function Block Editor Edit Menu
49.3 Function Block Editor Edit Menu
Use the Edit menu to work with objects in the Function Block Editor diagram
window.
Figure: Function Block Editor Edit menu
Table: Edit Menu
Command Description
Undo Undoes the latest command in Function
Block Editor.
Copy To Clipboard Copies a function block to the clipboard.
Copy Copies a function block.
Paste Pastes a function block.
Delete Deletes a function block.
Select All Selects all objects in the Function Block
Editor diagram window.
Search Opens the Search dialog box where you
search for text strings in the function blocks.
Replace Opens the Replace dialog box where you
replace text strings in the function blocks.
Center Selection Centers a selected group of objects in the
Function Block Editor diagram window.
Add Boundary Ties Adds boundary ties when you prepare a
printout.
• First position: Page number, vertically
continued.
• Second position: page number,
horizontally continued.
• Third position: signal number on page.
04-16006-04-en, March 2015 Technical
1501
49 Function Block User Interface
49.3 Function Block Editor Edit Menu
Continued
Command Description
Remove Boundary Ties Removes boundary ties from a printout. All
manually moved and deleted cross reference
boxes are restored when you add boundary
ties.
Technical 04-16006-04-en, March 2015
1502
49 Function Block User Interface
49.4 Preferences Menu
49.4 Preferences Menu
Use the Preferences menu to set various page display and print options in Edit
mode.
Figure: Function Block Editor Preferences menu
Table: Preferences Menu
Command Description
Page Setup Opens the Page Setup dialog box where
you customize printout pages from Function
Block Editor.
View Only Public Identifier Displays only the Public Identifier in the
Function Block Editor diagram window.
Show Status Bar Displays the status bar at the bottom of the
diagram window.
Orthogonal Connections Makes all connections in the diagram
window orthogonal, which means that all
segments are done in 90 degree angles.
Orthogonal connections is the default in
Function Block Editor.
Black And White Displays the diagram window and its
contents in black and white.
04-16006-04-en, March 2015 Technical
1503
49 Function Block User Interface
49.5 Options Menu
49.5 Options Menu
Use the Options menu to toggle between Edit mode and Simulation mode, to
access Simulation mode settings, lists, tables, and trees for specific function block
programs.
Figure: Function Block Editor Options menu
Table: Options Menu
Command Description
Simulate Changes to Simulation mode.
Set Date And Time Opens the Set Date and Time dialog box
where you set the date and time in
simulation mode.
Constants Table Opens the Constants Table dialog box
where you can view, add, and delete
constants.
Public Signal Table Opens the Public Signal Table property
sheet with a list of the public signals in the
function block program and their
descriptions.
Show HFB Navigation Tree Opens the Show HFB Navigation Tree.
Technical 04-16006-04-en, March 2015
1504
49 Function Block User Interface
49.6 Zoom Menu
49.6 Zoom Menu
Use the Zoom menu to zoom in and out in a function block program. You can
zoom out in any of the indicated percentages and return to normal view.
Figure: Function Block Editor Zoom menu in Simulation mode
04-16006-04-en, March 2015 Technical
1505
49 Function Block User Interface
49.7 Commands Menu
49.7 Commands Menu
Use the Commands menu to adjust the Function Block Editor simulation in
Simulation mode.
Figure: Function Block Editor Commands menu in Simulation mode
Table: Commands Menu
Command Description
Reset Resets all values in a function block program
simulation.
Step Executes the simulation of a function block
program step-by-step.
Execute Starts the simulation of a function block
program. Click Execute again to stop the
simulation.
Execute n Times Executes a simulation of a function block
program in the number of program cycles (n)
you type in the box. Press Enter to start the
execution.
Sampling Samples the program execution the number
of times you type in the box. Press Enter to
start the sampling.
Technical 04-16006-04-en, March 2015
1506
49 Function Block User Interface
49.8 Function Block Editor Tools Menu
49.8 Function Block Editor Tools Menu
Use the Tools menu to refresh the screen in both Edit and Simulation mode.
Figure: Function Block Editor Tools menu
Table: Tools Menu
Command Description
Redraw Screen Refreshes the screen.
04-16006-04-en, March 2015 Technical
1507
49 Function Block User Interface
49.9 Function Block Editor Help Menu
49.9 Function Block Editor Help Menu
Use the Help menu to get to the online help and information about the Function
Block Editor.
Figure: Function Block Editor Help menu
Table: Function Block Editor Help Menu
Command Description
Online Help Connect to WebHelp.
About Function Block Editor Displays the version number of Function
Block Editor, copyright information, the
license agreement, and technical
information.
Technical 04-16006-04-en, March 2015
1508
49 Function Block User Interface
49.10 Import Dialog Box
49.10 Import Dialog Box
Use the Import dialog box to import a function block program .aut file into Function
Block Editor.
The .aut file is a text file with function block program source code and data including
a graphical block diagram.
Figure: Function Block Editor Import dialog box
04-16006-04-en, March 2015 Technical
1509
49 Function Block User Interface
49.11 Export Dialog Box
49.11 Export Dialog Box
Use the Export dialog box to export a function block program that contains
functionality you want to make available for reuse. The function block program is
exported as an .aut file.
The .aut file is a text file with function block program source code and data including
a graphical block diagram.
Figure: Function Block Editor Export dialog box
Technical 04-16006-04-en, March 2015
1510
49 Function Block User Interface
49.12 Print Dialog Box
49.12 Print Dialog Box
Use the Print dialog box to customize printouts of function block programs in both
Edit and Simulation mode.
Figure: Function Block Editor Print dialog box
Table: Print Dialog Box
Component Description
Public Signals Select to print a list of all public signals in the
function block program. The properties
included in the table are:
• Name
• Type
• Acc (access class)
• Unit
• Description
Alarms Select to include a list of all alarms in the
function block program. The properties
included in the table are:
• Alarm name
• Parameter name
• Alarm Text
04-16006-04-en, March 2015 Technical
1511
49 Function Block User Interface
49.12 Print Dialog Box
Continued
Component Description
Constants Select to print a list of all defined constants in
the function block program. The properties
included in the table are:
• Public
• Name
• Value
Constants Usage Select to print a list of used constants in the
function block program. The properties
included in the table are:
• Constant
• Block where it is used.
Time Schedules Select to print a list of the time schedules in
the function block program. The properties
included in the table are:
• Name
• W (max. number of weekly charts)
• H (max. number of holiday charts)
• Start Date
• Stop Date
• Start Time
• Stop Time
• Weekdays.
Block Parameters Select to print a list of all function block
parameters in the function block program.
The properties included in the table are:
• Type
• Name
• Parameter or Value
• Parameter or Value
The content of the list depends on the
selected All Blocks or Public Blocks
options.
FBD Select to include a graphic presentation of
the function block diagram in the printout.
Page Number Select to number the function block
diagram. The properties are:
• Page number
• Total number of pages
Current Level Click to print only the current level of a
function block diagram when hierarchical
function blocks (HFBs) are used.
Technical 04-16006-04-en, March 2015
1512
49 Function Block User Interface
49.12 Print Dialog Box
Continued
Component Description
All Levels Click to print all levels of a function block
diagram when hierarchical function blocks
(HFBs) are used.
Text File Select to add an optional associated text file
to the function block program printout.
Overview This function is not available in this version of
Function Block Editor.
Detailed This function is not available in this version of
Function Block Editor.
Scale Output to one page Select if you want to print the selection on
one page only.
Color Printout Select to make a color print.
Skip Empty Pages Select to avoid printing empty pages.
Public Blocks Click to print only parameters from public
function blocks.
All Blocks Click to print out all blocks.
Printer Select the printer you want to use from the
list.
04-16006-04-en, March 2015 Technical
1513
49 Function Block User Interface
49.13 Page Setup Dialog Box
49.13 Page Setup Dialog Box
Use the Page Setup dialog box in Edit mode, to customize printouts of a function
block program.
Figure: Function Block Editor Page Setup dialog box
Table: Page Setup Dialog Box
Component Description
Variables Select the variables that are included in the
second line of the page heading of the
printout.
The available list items are:
• #abbrev, #author, #date, and #name
(originating from the program
specification)
• #prdate and #prtime (printout time and
date)
• #tab (tab character)
Left Type the left margin in mm.
Top Type the top margin in mm.
Right Type the right margin in mm.
Bottom Type the bottom margin in mm.
Horizontal Enter the number of horizontal pages used
to print the function block program. You
cannot set the number of pages to a lower
number than what is required to display the
complete function block program when
maximally zoomed out. Changing the Block
size percentage reduces the minimum
number of pages.
Technical 04-16006-04-en, March 2015
1514
49 Function Block User Interface
49.13 Page Setup Dialog Box
Continued
Component Description
Vertical Enter the number of vertical pages used to
print the function block program. You cannot
set the number of pages to lesser than
required to display the complete function
block program when maximally zoomed out.
Changing the Block size percentage
reduces the minimum number of pages.
Landscape Click to print the pages in landscape
orientation.
Portrait Click to print the pages in portrait orientation.
Block sizes (%) Enter the size of the blocks in percent.
Smaller block sizes can be used for a better
overview. Larger block sizes make the
printed pages easier to read.
Block sizes ranges from 25 to 500%. The
default value in Function Block Editor is
100%.
Show page breaks Select to display the page breaks in the
diagram window.
Page Header Type a title to use in the second line of the
page header. The first line in the page
header always contains the name of the
function block program. You can enter either
free text or add items from the Variables list
in the Page Header.
04-16006-04-en, March 2015 Technical
1515
49 Function Block User Interface
49.14 Search Dialog Box
49.14 Search Dialog Box
Use the Search dialog box to search for text strings in function block programs.
The text strings can be: signal names, constant names, module names, comment
text, and block types. When the searched text string is found, the item containing
the string is selected and framed in green. Search is available in Edit mode.
Figure: Function Block Editor Search dialog box
Table: Search Dialog Box
Component Description
Search for Enter the string to search for. When the
Search for box is empty, all blocks of the
marked block type(s) and comments are
searched for.
Signal-/ Constant Names Select to search for the string in signal
names in block identifiers, constant names,
and network addresses.
Comment Text Select to search for the string in comment
texts.
Block Types Select a single block type or all block types
to search in.
Module Names Select to search for the string used as a
Module name in block identifiers, constant
names, and network addresses.
Match case Select to make a case sensitive search for
the string.
Whole words Select to search for whole words.
Search Next Click to continue the search.
Close Click to close the dialog box.
Technical 04-16006-04-en, March 2015
1516
49 Function Block User Interface
49.15 Replace Dialog Box
49.15 Replace Dialog Box
You use the Replace dialog box to search and replace text strings in function
block programs. The text string can be: signal names, constant names, module
names, comment text, and block types. Replace is available in Edit mode.
Figure: Function Block Editor Replace dialog box
Table: Replace Dialog Box
Component Description
Search for Type the string you want to search for. If the
Search for box is empty, all blocks of the
marked block type(s) and comments are
searched for.
Replace with Type the string you want to use instead of
the original text.
Signal- /Constant Names Select to search for the string in signal
names in block identifiers, constant names,
and network addresses.
Comment Text Select to search for the string in comment
texts.
Block Types Select a single block type or all types to
search in.
Module Names Select to search for the string used as a
Module name in block identifiers, constant
names, and network addresses.
Case sensitive Select to make a case sensitive search for
the string.
Whole words Select to search for whole words.
04-16006-04-en, March 2015 Technical
1517
49 Function Block User Interface
49.15 Replace Dialog Box
Continued
Component Description
Replace only first appearance Select to replace only the first match of the
string in a block. Otherwise, all matches in
the block are replaced.
Search Next Click to continue the search.
Replace Click to replace the string.
After replacing text, ensure that the new
name does not exceed the character limit.
• Module Name does not exceed 12
characters.
• Signal or Constant Names do not
exceed 10 characters.
Replace All Click to replace all matches of the string.
After replacing text, ensure that the new
name does not exceed the character limit.
• Module Name does not exceed 12
characters.
• Signal or Constant Names do not
exceed 10 characters.
Close Click to close the dialog box.
Technical 04-16006-04-en, March 2015
1518
49 Function Block User Interface
49.16 NEW Menu
49.16 NEW Menu
Use the NEW menu to create new objects in the Function Block Editor diagram
window in Edit mode.
Figure: Function Block Editor NEW menu
Table: NEW Menu
Command Description
Simple Block Opens the Select Simple Block dialog
box where you select the type of function
block you want to create.
Operator Opens the Select Operator dialog box
where you select the type of operator you
want to create.
Expression Opens the Edit expression dialog box
where you can write and edit a logical
expression.
Node Defines the output signal type as Real,
Integer or Binary.
HFB Opens the Edit Hierarchy dialog box
where you can edit the hierarchy in a
hierarchical function block.
HFB I/O Opens the Select Hierarchy Connection
dialog box. The HFB I/O is only available if
you click inside a hierarchical function block.
Compress HFB Compresses a hierarchical function block.
Comment Opens the Edit comment dialog box.
Line Click to add a line.
Rectangle Adds a rectangle.
04-16006-04-en, March 2015 Technical
1519
49 Function Block User Interface
49.16 NEW Menu
Continued
Command Description
Paste Pastes a function block from the clipboard.
Load Macro Opens the Load Macro dialog box.
Technical 04-16006-04-en, March 2015
1520
49 Function Block User Interface
49.17 BLOCK Menu
49.17 BLOCK Menu
Use the BLOCK menu to edit a block and its connections in Edit mode.
Figure: Function Block Editor BLOCK menu
Table: BLOCK Menu
Command Description
Edit Opens the Edit block menu.
Duplicate Duplicates a function block.
Disconnect Disconnects a function block.
Delete Deletes a function block.
Expand HFB Expands an HFB.
04-16006-04-en, March 2015 Technical
1521
49 Function Block User Interface
49.18 INPUT Menu
49.18 INPUT Menu
Use the INPUT menu to edit a block input in Function Block Editor in Edit mode.
Figure: Function Block Editor INPUT menu
Table: INPUT Menu
Command Description
Disconnect Disconnects an input.
Detach Detaches an input.
Technical 04-16006-04-en, March 2015
1522
49 Function Block User Interface
49.19 OUTPUT Menu
49.19 OUTPUT Menu
Use the OUTPUT menu to edit a block output in Function Block Editor in Edit
mode.
Figure: Function Block Editor OUTPUT menu
Table: OUTPUT Menu
Command Description
Disconnect Disconnects an output.
Delete Deletes an output.
04-16006-04-en, March 2015 Technical
1523
49 Function Block User Interface
49.20 CONNECTION Menu
49.20 CONNECTION Menu
Use the CONNECTION menu to edit a connection in Function Block Editor in Edit
mode.
Figure: Function Block Editor CONNECTION menu
Table: CONNECTION Menu
Command Description
Move Node Moves a node.
Create Node Creates a node.
Delete Node Deletes a node.
Detach Detaches a node.
Mark Changes the color of the selected
connection.
Unmark Changes the color of the selected
connection to the default color (black).
Unmark all Changes the color of all the connections in
the Diagram window to the default color
(black).
Technical 04-16006-04-en, March 2015
1524
49 Function Block User Interface
49.21 Select Simple Block Dialog Box
49.21 Select Simple Block Dialog Box
Use the Select Simple Block dialog box to create a Function Block Editor simple
block in Edit mode.
Figure: Function Block Editor Select Simple Block dialog box
Table: Select Simple Block Dialog Box
Component Description
Simple Block Type the name of the block type you want to
create, if you know the name.
Description box Displays a short description of the selected
simple block.
List Select a subset of simple blocks to display in
the list.
Block selection list Select the block you want to create.
04-16006-04-en, March 2015 Technical
1525
49 Function Block User Interface
49.22 Edit Expression Dialog Box
49.22 Edit Expression Dialog Box
Use the Edit expression dialog box to create or edit a Function Block Editor
expression block in Edit mode.
Figure: Function Block Editor Edit Expression dialog box
Table: Edit Expression Dialog Box
Component Description
Identifier Type a new name for the expression block.
Unit Select an engineering unit.
Description Type a description of the block up to 40
characters.
Public Select if the output signal from the block is a
public signal.
Read/Write Select to be able to modify the output signal
from other network nodes during execution
of the function block program, and manually
during offline simulation.
The R/W option cannot be selected for
blocks with RO access.
Access Displays the type of access (RO or RW) for
the output signal from the block.
Node Click to define the output signal type as Real,
Integer or Binary.
Technical 04-16006-04-en, March 2015
1526
49 Function Block User Interface
49.22 Edit Expression Dialog Box
Continued
Component Description
Expression Type the arithmetic or logical expression.
The maximum length of an expression is 500
characters.
04-16006-04-en, March 2015 Technical
1527
49 Function Block User Interface
49.23 Edit Block Dialog Box
49.23 Edit Block Dialog Box
Use the Edit block dialog box to edit a Function Block Editor block in Edit mode.
Figure: Function Block Editor Edit block dialog box
Table: Edit Block Dialog Box
Component Description
Identifier Type a new name for the block in the
Identifier box.
Unit Select an engineering unit.
Description Type a description of the block up to 40
characters.
Public Select if the output signal from the block is a
public signal and included in the Public
Signal Table.
Read/Write Select to be able to modify the output signal
from other network nodes during execution
of the function block program, and manually
during offline simulation.
The R/W option cannot be selected for
blocks with RO access.
Backup Select to have the current value of the
function block output used when the devices
perform a warm start.
Type Displays the value type: Real, Integer or
Binary.
Access Displays the type of access (Read Only or
Read/Write) for the output signal from the
function block.
Technical 04-16006-04-en, March 2015
1528
49 Function Block User Interface
49.23 Edit Block Dialog Box
Continued
Component Description
Parameters Displays function block parameters. The set
of parameters depend on the function block
type. Some function blocks have no
parameters.
04-16006-04-en, March 2015 Technical
1529
49 Function Block User Interface
49.24 Select Operator Dialog Box
49.24 Select Operator Dialog Box
Use the Select Operator dialog box to create an operator in Function Block
Editor in Edit mode.
Figure: Function Block Editor Select Operator dialog box
Table: Select Operator Dialog Box
Component Description
Operator Type the name of the operator type you
want to create, if you know the name.
Operators Select the operator you want to create from
the list.
Technical 04-16006-04-en, March 2015
1530
49 Function Block User Interface
49.25 Edit Operator Dialog Box
49.25 Edit Operator Dialog Box
Use the Edit operator dialog box to edit the properties of the operator.
Figure: Edit operator dialog box
Table: Edit Operator Dialog Box
Component Description
Identifier Type a new name for the operator.
Unit Select an engineering unit.
Description Type a description of the operator.
Maximum 40 characters.
Public Select to make the output signal from the
operator a public signal that is included in
the Public Signal Table.
Mode 2 Select to change the orientation of the
connections.
Type Defines the data type of the operator output.
Access Defines whether the signal exported by the
operator is read-only (RO) or read/write
(R/W).
Parameters Displays the operator parameters. The set of
parameters depend on the operator type.
Some operators have no parameters.
04-16006-04-en, March 2015 Technical
1531
49 Function Block User Interface
49.26 Constants Table Dialog Box
49.26 Constants Table Dialog Box
Use the Constants Table dialog box to add or delete constants in Function Block
Editor in Edit mode.
Figure: Function Block Editor Constants Table dialog box
Table: Constants Table Dialog Box
Component Description
Public Displays if the constant is public.
Name Displays the name of the constant.
Value Displays the value of the constant.
Unit Displays the unit of the constant.
Description Displays the description of the constant.
Exit Click to exit the dialog box without making
any change.
Delete Click to delete the constant that is marked in
the constant list.
Add Click to add a new constant.
Delete Unused Click to delete all unused constants.
Technical 04-16006-04-en, March 2015
1532
49 Function Block User Interface
49.27 New Constant Dialog Box
49.27 New Constant Dialog Box
Use the New constant dialog box to add a new constant in Edit mode.
Figure: Function Block Editor New constant dialog box
Table: New Constant Dialog Box
Component Description
Identifier Type a name for the constant you want to
create. Blank spaces are not allowed.
Value Type the required constant value.
Public Select to make the constant public, that is,
accessible from outside the block.
Unit Select the engineering unit.
Description Type a description for the constant.
04-16006-04-en, March 2015 Technical
1533
49 Function Block User Interface
49.28 Public Signal Table
49.28 Public Signal Table
Use the Public Signal Table in Edit mode to display all public signals in a function
block program.
Figure: Function Block Editor Public Signal Table dialog box
Table: Public Signal Table Dialog Box
Component Description
Name Displays the name of the public signal.
Description Displays the description of the public signal.
Technical 04-16006-04-en, March 2015
1534
49 Function Block User Interface
49.29 Edit Hierarchy Dialog Box
49.29 Edit Hierarchy Dialog Box
Use the Edit Hierarchy dialog box to create a new hierarchical function block or
to edit an existing hierarchical function block in Edit mode.
Figure: Function Block Editor Edit Hierarchy dialog box
Table: Edit Hierarchy Dialog Box
Component Description
Identifier Type a name for the hierarchical function
block.
Description Type a description for the hierarchical
function block.
04-16006-04-en, March 2015 Technical
1535
49 Function Block User Interface
49.30 Edit Comment Dialog Box
49.30 Edit Comment Dialog Box
Use the Edit comment dialog box to add or edit a comment in the diagram
window in Edit mode.
Figure: Function Block Editor Edit comment dialog box
Table: Edit Comment Dialog Box
Component Description
Comment Type the comment you want to display in the
function block program.
Font Opens the Font dialog box.
Technical 04-16006-04-en, March 2015
1536
49 Function Block User Interface
49.31 Font Dialog Box
49.31 Font Dialog Box
Use the Font dialog box to change the font, font style, and size of a comment in
Edit mode.
Figure: Function Block Editor Font dialog box
Table: Font Dialog Box
Component Description
Font Select a font.
Font style Select a font style.
Size Select a font size.
Strikeout Select if you want the text to be struck out.
Underline Select if you want the text to be underlined.
Color Select a font color from the list.
Sample Displays the formatted text.
Script Select a script style.
04-16006-04-en, March 2015 Technical
1537
49 Function Block User Interface
49.32 Select Hierarchy Connection Dialog Box
49.32 Select Hierarchy Connection Dialog Box
Use the Select Hierarchy Connection dialog box to add inputs and outputs
from a hierarchical function block in Edit mode.
Figure: Function Block Editor Select Hierarchy Connection dialog box
Table: Select Hierarchy Connection Dialog Box
Component Description
HB I/O types Select the required input or output for the
hierarchical function block.
Technical 04-16006-04-en, March 2015
1538
49 Function Block User Interface
49.33 HFB Navigation Tree
49.33 HFB Navigation Tree
Use the HFB Navigation Tree to navigate inside hierarchical function blocks in
Edit mode.
Figure: Function Block Editor HFB Navigation Tree box
04-16006-04-en, March 2015 Technical
1539
49 Function Block User Interface
49.34 Function Block Editor (Simulation Mode)
49.34 Function Block Editor (Simulation Mode)
Use Function Block Editor in Simulation mode to test function block programs.
Figure: Function Block Editor window in Simulation mode
Table: Function Block Editor Window in Simulation Mode
Number Description
Function Block Editor menu bar
Simulation control buttons
Function block diagram window
Online/Offline status box
Cycle counter
Trend area
Technical 04-16006-04-en, March 2015
1540
49 Function Block User Interface
49.34 Function Block Editor (Simulation Mode)
Continued
Number Description
Input buttons
Function Block Editor Simulation mode has a number of buttons that you use to
control how the Simulation is done.
Table: Tools in Simulation Mode
Button Description
Click to start or stop a simulation.
Click to execute a simulation in steps.
Displays the number of executed program
cycles.
Click to reset the cycle counter.
Right-click to open the Input dialog box.
Click to modify a value during simulation, or
right-click to open the RECORD menu where
you make the required recording settings.
04-16006-04-en, March 2015 Technical
1541
49 Function Block User Interface
49.35 File Menu in Simulation Mode
49.35 File Menu in Simulation Mode
Use the File menu in Simulation mode to print a simulation or to exit Function Block
Editor.
Figure: Function Block Editor File menu in Simulation mode
Table: File Menu
Command Description
Print Opens the Print dialog box that you use to
print out a function block program.
Exit Exits Function Block Editor.
Technical 04-16006-04-en, March 2015
1542
49 Function Block User Interface
49.36 Preferences Menu in Simulation Mode
49.36 Preferences Menu in Simulation Mode
Use the Preferences menu to set display options in Simulation mode.
Figure: Function Block Editor Preferences menu in Simulation mode
Table: Preferences Menu in Simulation Mode
Command Description
Page Setup Opens the Page Setup dialog box.
View Only Public Identifier Displays only Public Identifier in the Function
Block Editor diagram window.
View Signal Values Displays the signal values in the function
blocks during simulation.
Show Status Bar Displays the status bar at the bottom of the
diagram window.
04-16006-04-en, March 2015 Technical
1543
49 Function Block User Interface
49.37 Options Menu in Simulation Mode
49.37 Options Menu in Simulation Mode
Use the Options menu to toggle between Simulation mode and Edit mode, to set
date and time, and to access tables and a view of hierarchical function blocks in
Simulation mode.
Figure: Function Block Editor Options menu in Simulation mode
Table: Options Menu in Simulation Mode
Command Description
Edit Changes to Edit mode.
Set Date and Time Opens the Set Date and Time dialog box.
Constants Table Opens the Constants Table dialog box.
Public Signal Table Opens the Public Signal Table dialog box.
Show HFB Navigation Tree Opens the HFB Navigation Tree dialog
box.
Technical 04-16006-04-en, March 2015
1544
49 Function Block User Interface
49.38 Set Date and Time (Simulation) Dialog Box
49.38 Set Date and Time (Simulation) Dialog
Box
Use Set Date And Time (Simulation) to set date and time in Edit and Simulation
mode.
Figure: Set Date and Time (Simulation) dialog box
Table: Set Date and Time (Simulation) dialog box
Property Description
Date (yy/mm/dd) Type the date.
Time (hh/mm/ss) Type the time.
04-16006-04-en, March 2015 Technical
1545
49 Function Block User Interface
49.39 Analog Input Dialog Box
49.39 Analog Input Dialog Box
Use the Analog Input dialog box to generate analog signal variations for physical
inputs automatically or manually in Simulation mode.
Figure: Function Block Editor Analog Input dialog box
Table: Analog Input Dialog Box
Component Description
Manual Click to manually control the input values.
Automatic Click to automatically generate input values.
Wave Form Select the shape of the generated signal
from the list.
Amplitude Type the sequence of wave periods with
different amplitudes separated by a comma
for the generated signal.
Circular Select to repeat the sequence, defined in the
Amplitude box. Clear to revert the input to
manual mode after generating the sequence
once.
Average Value Type the average value that, together with
the amplitude, gives the generated value.
Phase (degrees) Type the time displacement of the generated
signal, in degrees. A complete period is 360
degrees.
Period (sec.) Type the duration of a complete wave period
in seconds.
Technical 04-16006-04-en, March 2015
1546
49 Function Block User Interface
49.40 Digital Input Dialog Box
49.40 Digital Input Dialog Box
Use the Digital Input dialog box to generate digital signal variations for physical
inputs automatically or manually in Simulation mode.
Figure: Function Block Editor Digital Input dialog box
Table: Digital Input Dialog Box
Component Description
Manual Click to manually control the input values.
Automatic Click to automatically generate input values.
Sequence Type the sequence you want to test
separated by a comma.
Circular Select to repeat the sequence. Clear to
revert the input to manual mode after
generating one sequence.
Period (ms.) Type the duration of a sequence period in
milliseconds.
04-16006-04-en, March 2015 Technical
1547
49 Function Block User Interface
49.41 RECORD Menu
49.41 RECORD Menu
Use the RECORD menu to define how to record signals in Simulation mode.
Figure: Function Block Editor RECORD menu in Simulation mode
Table: RECORD Menu
Command Description
Modify Modifies a value during simulation.
Edit Range Edits the maximum and minimum value for
the recording.
Stop at Limit Opens the Edit Break Limit dialog box
where you set the break points where the
simulation is stopped.
Delete Deletes the recording of the selected signal.
Technical 04-16006-04-en, March 2015
1548
49 Function Block User Interface
49.42 Edit Break Limit Dialog Box
49.42 Edit Break Limit Dialog Box
Use the Edit Break Limit dialog box to stop logging and simulation when the
logged values exceed a defined level in Simulation mode.
Figure: Function Block Editor Edit Break Limit dialog box in Simulation mode
Table: Edit Break Limit Dialog Box
Component Description
Break Active Select to stop the simulation when the set
value is reached.
Break when signal Select to stop the simulation when the value
exceeds or is below the limit.
the limit Type the limit for when to break the signal.
04-16006-04-en, March 2015 Technical
1549
49 Function Block User Interface
49.43 TREND Menu
49.43 TREND Menu
Use the TREND menu to clear, restart, and reset the recorder in Simulation mode.
You open the TREND menu by right-clicking on the Trend area in Function Block
Editor.
Figure: Function Block Editor TREND menu in Simulation mode
Table: TREND Menu
Command Description
Clear Clears all trends in the recorder. The logged
signals are not affected.
Restart Restarts the recorder. The previous graph is
not affected but the logging restarts.
Reset Restarts the recorder and removes all
defined logged signals from the recorder.
The previous graph is not affected.
Technical 04-16006-04-en, March 2015
1550
49 Function Block User Interface
49.44 SIGNAL Menu
49.44 SIGNAL Menu
Use the SIGNAL menu to modify the value or state of signals with a RW (read/write)
access in Simulation mode.
Figure: Function Block Editor SIGNAL menu in Simulation mode
Table: SIGNAL Menu
Command Description
Modify Modifies a value.
View Opens the View block property sheet. It
displays the information you can edit in the
Edit Block dialog box in Edit mode.
Record Adds the signal to the recorder.
Delete Deletes the signal from the recorder.
Mark Changes the color of the selected
connection.
Unmark Clears the selected color of a connection
and resets the color to the default color
(black).
Unmark all Resets the color of all connections to the
default color (black).
Expand Expands a hierarchical function block and
display the sub level.
04-16006-04-en, March 2015 Technical
1551
49 Function Block User Interface
49.45 Function Block Program Properties – Basic Tab
49.45 Function Block Program Properties –
Basic Tab
Use the Basic tab to view status and execution information for the function block
program and to make settings that affect the program execution.
Figure: Function Block Program properties - Basic tab
Table: Basic Tab
Component Description
Compilation valid Displays True if the function block program
is complete and able to run on the server.
Status Displays the current function block program
status. Displays Running if the program is
currently running. Displays Unloaded if the
program has never been started. Displays
Halted if the program has been manually
halted.
Number of cycles Displays the number of executed program
cycles.
Technical 04-16006-04-en, March 2015
1552
49 Function Block User Interface
49.45 Function Block Program Properties – Basic Tab
Continued
Component Description
Last execution time (ms) Displays the duration of the last function
block program execution.
Minimum execution time (ms) Displays the minimum duration of the last
function block program execution cycle.
Maximum execution time (ms) Displays the maximum duration of the last
function block program execution cycle.
Enabled Select Yes to run the function block
program on Automation Server.
Task Enter the task to set the function block
program execution frequency. For more
information, see section 50.23 “Tasks” on
page 1602.
Execution precedence Enter a number to set the execution priority
for function blocks with internal, cyclic
dependencies. A function block program
with a lower number is executed before a
function block program with a higher
number. For more information, see section
50.25 “Program Cycles in Building
Operation ” on page 1604.
04-16006-04-en, March 2015 Technical
1553
49 Function Block User Interface
49.46 Function Block Program Properties – Inputs Tab
49.46 Function Block Program Properties –
Inputs Tab
Use the Inputs tab to select whether or not to use the input values for the following
function blocks: BI, II, PI and RI.
Figure: Function Block Program properties - Inputs tab
Table: Inputs Tab
Component Description
[Block name] Select Force value to use the input value of
the function block in the function block
program. If the input has been bound, the
value is overwritten by the following program
execution cycle.
Technical 04-16006-04-en, March 2015
1554
49 Function Block User Interface
49.47 Function Block Program Properties – Public Signals Tab
49.47 Function Block Program Properties –
Public Signals Tab
Use the Public Signals tab set the values of the public signals in the function
block program.
Figure: Function Block Program properties Public Signals tab
Table: Public Signals Tab
Component Description
[Public Signal name] Enter a value for the public signal.
04-16006-04-en, March 2015 Technical
1555
49 Function Block User Interface
49.48 Function Block Program Properties – Outputs Tab
49.48 Function Block Program Properties –
Outputs Tab
Use the Outputs tab to view the output values for the following function blocks:
BO, IO, PO and RO.
Figure: Function Block Program properties Outputs tab
Table: Outputs Tab
Component Description
[Block name] Select Force value to use the output value
of the function block in the function block
program. If the output has been bound, the
value is overwritten by the following program
execution cycle.
Technical 04-16006-04-en, March 2015
1556
49 Function Block User Interface
49.49 Function Block Program Properties – References Tab
49.49 Function Block Program Properties –
References Tab
Use the References tab to view and access the references of the function block
program.
Figure: References tab
04-16006-04-en, March 2015 Technical
1557
50 Script Introduction
Topics
Script Overview
Script Workflow
Script Programs
Creating a Script Program
Opening a Script Program or Function
Script Keywords
Script Program Flow
FallThru Program Flow
Looping Program Flow
Script Program Instructions
Lines and Line Numbers
Reserved Words
Script Reserved Words
Bindings and Script Programs
Binding Values in Script Editor Using a Binding Template
Local Variable Declarations
Binding Attributes
Forced
Invalid
Offline
Overridden
Accessing a Binding Attribute
Tasks
Adding a Task to a Program
Program Cycles in Building Operation
Configuring the Execution Precedence for a Program
Finding Cycles in a Task
50 Script Introduction
50.1 Script Overview
50.1 Script Overview
Script programs are text-based instructions that tell the server to take some kind of
action to control a building.
For example, you can tell the server to take the following actions:
• OPEN THE DAMPER
• CLOSE THE VALVE
Each instruction is a complete text-command description. Program instructions are
listed in the order in which the controller must perform them.
50.1.1 Script Workflow
The Script workflow allows you to create (and edit) Script programs in Building
Operation.
For more information, see section 50.2 “Script Workflow” on page 1561.
50.1.2 Script Programs
You can store your Script programs like a common document and include them
later in other projects for use in your control system. You can also write programs
that perform very complex control system decisions, such as controlling lighting,
boilers, and air handling units at multiple sites.
For more information, see section 50.3 “Script Programs” on page 1565.
50.1.3 Script Functions
A function is a routine designed to carry out an often repeated task or series of
tasks. Your Script function then becomes a subroutine that can be called whenever
that particular action needs to be performed.
For more information, see section 51.96 “Script Functions” on page 1761.
50.1.4 Script Program Components
Script programs are composed of the following components that allow you to
develop your programs quickly and easily:
• Program constants
• Program operators
• Program statements
• Expressions
• Variables
For example, you can create program statements with everyday language, so you
do not need to be a programmer to learn how to program with Script.
04-16006-04-en, March 2015 Technical
1561
50 Script Introduction
50.1 Script Overview
For more information, see section 51.1 “Script Program Components” on page
1619.
50.1.5 Script Editor Overview
The Script Editor is a text programming tool you use to create Script programs that
control and monitor building automation systems. Script Editor opens when you
create or edit a Script program in WorkStation.
When you open a new program in the Script Editor, you begin by declaring local
variables for the program input and output followed by names for those variables.
The program starts with zero or more of these declarations followed by one or more
lines specifying the operation(s) to perform.
For more information, see section 52.1 “Script Editor Overview” on page 1853.
50.1.6 Script Web Services
Web Services are programmable applications accessible from standard Internet
protocols, like HTTP and XML. Web Services help solve application integration
challenges by allowing applications to communicate with one another independent
of the target, host operating system, object model, or programming language.
For more information, see section 53.1 “Script Web Services” on page 1917.
Technical 04-16006-04-en, March 2015
1562
50 Script Introduction
50.2 Script Workflow
50.2 Script Workflow
The Script workflow allows you to create (and edit) Script programs in Building
Operation.
The following flowchart describes the basic steps required to create (or edit) a
Script program. Related information can be found in the sections after the
flowchart. If you want to edit an existing Script program, select the program in the
Automation Server and then continue from the second step.
04-16006-04-en, March 2015 Technical
1563
50 Script Introduction
50.2 Script Workflow
Figure: Script Workflow
Create a Script program
In WorkStation, create a Script program under an Automation Server.
Technical 04-16006-04-en, March 2015
1564
50 Script Introduction
50.2 Script Workflow
For more information, see section 50.4 “Creating a Script Program” on page 1567.
Open your program in Script Editor
In WorkStation, select and open your program in Script Editor.
For more information, see section 50.5 “Opening a Script Program or Function” on
page 1569.
Declare local variables
In Script Editor, declare local variables for the program inputs and outputs followed
by names for the variables.
For more information, see section 50.16 “Local Variable Declarations” on page
1592.
Create program lines
In your Script program, create program lines to specify the type of actions you want
the program to perform.
For more information, see section 52.9 “Adding a Line” on page 1871.
Create points or values
In WorkStation, create points or values.
For more information, see section 76.10 “Creating a BACnet Point in a Server” on
page 2675.
For more information, see section 76.24 “Creating a BACnet Value” on page 2756.
Bind variables to the points or values
In WorkStation, bind the variables to the points or values you created to view the
output.
Note
In Script, you can bind using either the Bindings view in Building Operation, or the
Bindings view in Script Editor. For more information, see section 38.10 “Binding
Values Using a Binding Template” on page 1220.
Check and save your program
In Script Editor, check your program for errors and then save the program.
For more information, see section 52.15 “Checking and Saving a Script Program”
on page 1878.
Select the task
In WorkStation, select the task in which you wish to include your Script program.
For more information, see section 50.24 “Adding a Task to a Program” on page
1603.
Execute your Script program
In WorkStation, execute your Script program.
For more information, see section 52.16 “Executing a Script Program” on page
1879.
04-16006-04-en, March 2015 Technical
1565
50 Script Introduction
50.2 Script Workflow
Store and reuse your programs
In WorkStation, store your programs like a common document and import them
later for reuse in other projects.
For more information, see section 52.17 “Importing Script Program Code” on page
1881.
Technical 04-16006-04-en, March 2015
1566
50 Script Introduction
50.3 Script Programs
50.3 Script Programs
A Script program consists of a set of instructions or statements that direct the
server to perform one or more operations. Program statements are written with
Script words, known as keywords.
50.3.1 Script Keywords
Script keywords are arranged in a predefined structure with their own syntax.
According to the rules of that syntax, certain parameters and values are allowed or
not allowed to follow a keyword.
For more information, see section 50.6 “Script Keywords” on page 1570.
50.3.2 Script Program Instructions
The Script programming language consists of a set of instructions that tells the
server what to do. Each instruction is a complete text-command description that
tells the Automation Server to take some type of specific action to control a
building. Program instructions are listed in the order in which the controller must
perform them.
For more information, see section 50.10 “Script Program Instructions” on page
1581.
50.3.3 Script Program Flow
Script programs tell a server to perform numerous actions, such as increasing the
heat, locking doors, and printing reports. The program instructions that command
these actions are arranged and executed in a certain order, known as a program
flow.
For more information, see section 50.7 “Script Program Flow” on page 1577.
50.3.4 Tasks
Function block and Script programs must be connected to tasks in order to run.
You access Tasks from the Properties dialog box.
The task is a property of the object that defines the program cycles.
When you create a new function block or Script program, Task 3 is the default. This
means that one program cycle executes in 1000 ms.
For more information, see section 50.23 “Tasks” on page 1602.
04-16006-04-en, March 2015 Technical
1567
50 Script Introduction
50.3 Script Programs
50.3.5 Program Cycles in Building Operation
All programs are executed in the order they are bound in Building Operation. For
example, in programs that are executed in a straight order or in any similar
configuration, Program 4 runs after Program 3 that runs after Program 2 that runs
after Program 1. The first program to be executed is Program 1.
For more information, see section 50.25 “Program Cycles in Building Operation ” on
page 1604.
50.3.6 Bindings and Script Programs
A binding is an association between a local variable (numeric, string, datetime,
function) within a Script program and a property of an object in the system. The use
of bindings increases the flexibility of the building automation system.
For more information, see section 50.14 “Bindings and Script Programs” on page
1589.
Technical 04-16006-04-en, March 2015
1568
50 Script Introduction
50.4 Creating a Script Program
50.4 Creating a Script Program
You create a Script program to import existing program code or to program new
logic for an Automation Server using Script Editor.
For more information, see section 50.3 “Script Programs” on page 1565.
To create a Script program
1. In WorkStation, in the System Tree pane, select the server or folder where
you want to create the script program.
2. On the File menu, point to New and then click Program.
3. In the object type list, select Script Program.
4. In the Name box, type a name for the script program.
Continued on next page
04-16006-04-en, March 2015 Technical
1569
50 Script Introduction
50.4 Creating a Script Program
5. In the Description box, type a description for the script program.
6. Click Create.
Technical 04-16006-04-en, March 2015
1570
50 Script Introduction
50.5 Opening a Script Program or Function
50.5 Opening a Script Program or Function
You open a Script program or function in Script Editor to enter program
instructions.
For more information, see section 50.3 “Script Programs” on page 1565.
To open a Script program or function
1. In WorkStation, in the System Tree pane, select the Script program or
function.
2. On the Actions menu, click Edit.
The Script program or function is now open and ready for input.
04-16006-04-en, March 2015 Technical
1571
50 Script Introduction
50.6 Script Keywords
50.6 Script Keywords
Script keywords are arranged in a predefined structure with their own syntax.
According to the rules of that syntax, certain parameters and values are allowed or
not allowed to follow a keyword.
50.6.1 A-D
This table contains keywords that begin with the lettters A - D.
A B C D
ABS BASEDON...GOTO CEILING DATE
For more information, For more information, For more information, For more information,
see section 51.117 see section 51.48 see section 51.132 see section 51.81
“ABS” on page 1790. “BASEDON...GOTO” “CEILING” on page “DATE” on page
on page 1697. 1810. 1744.
ACOS BITAND CHR DATETIME
For more information, For more information, For more information, For more information,
see section 51.157 see section 51.16 see section 51.145 see section 51.41
“ACOS” on page “BITAND” on page “CHR” on page “DATETIME” on page
1844. 1646. 1830. 1683.
AND BITNOT CONTINUE DAYOFMONTH
For more information, For more information, For more information, For more information,
see section 51.21 see section 51.17 see section 51.50 see section 51.82
“AND” on page “BITNOT” on page “CONTINUE” on “DAYOFMONTH” on
1651. 1647. page 1700. page 1745.
ARG BITOR COS DAYOFYEAR
For more information, For more information, For more information, For more information,
see section 51.40 see section 51.18 see section 51.161 see section 51.83
“ARG” on page “BITOR” on page “COS” on page “DAYOFYEAR” on
1682. 1648. 1848. page 1746.
ASC BITXOR DIFFTIME
For more information, For more information, For more information,
see section 51.144 see section 51.19 see section 51.154
“ASC” on page 1829. “BITXOR” on page “DIFFTIME” on page
1649. 1840.
ASIN BREAK DIVIDED BY
For more information, For more information, For more information,
see section 51.158 see section 51.49 see section 51.27
“ASIN” on page “BREAK” on page “DIVIDED BY” on
1845. 1699. page 1661.
ATAN Buffered
For more information, For more information,
see section 51.159 see section 51.63
“ATAN” on page “Buffered ” on page
1846. 1722.
Technical 04-16006-04-en, March 2015
1572
50 Script Introduction
50.6 Script Keywords
Continued
A B C D
ATAN2
For more information,
see section 51.160
“ATAN2” on page
1847.
AVERAGE
For more information,
see section 51.137
“AVERAGE” on page
1815.
50.6.2 E-H
This table contains keywords that begin with the letters E - H.
E F G H
EQUALS FACTORIAL GETNAME HOD
For more information, For more information, For more information, For more information,
see section 51.22 see section 51.119 see section 51.126 see section 51.84
“EQUALS” on page “FACTORIAL” on “GETNAME” on page “HOD” on page
1653. page 1792. 1800. 1747.
ERRORS FAILURE GetBufferSize HOUR
For more information, For more information, For more information, For more information,
see section 51.93 see section 51.8 see section 51.110 see section 51.85
“ERRORS” on page “Failure” on page “GetBufferSize” on “HOUR” on page
1758. 1630. page 1780. 1748.
EXPONENTIAL FLOOR GetBufferedValue
For more information, For more information, For more information,
see section 51.118 see section 51.133 see section 51.111
“EXPONENTIAL” on “FLOOR” on page “GetBufferedValue”
page 1791. 1811. on page 1782.
FOR...NEXT GOTO
For more information, For more information,
see section 51.51 see section 51.52
“FOR...NEXT” on “GOTO” on page
page 1701. 1704.
FREEMEM
For more information,
see section 51.94
“FREEMEM” on page
1759.
04-16006-04-en, March 2015 Technical
1573
50 Script Introduction
50.6 Script Keywords
Continued
E F G H
50.6.3 I-N
This table contains keywords that begin with the letters I -N.
I L M N
IF...THEN...ELSE LEFT MAXIMUM NOT
For more information, For more information, For more information, For more information,
see section 51.53 see section 51.146 see section 51.138 see section 51.24
“IF...THEN...ELSE” “LEFT” on page “MAXIMUM” on page “NOT” on page 1657.
on page 1707. 1831. 1817.
INPUT LENGTH MAXITEM NUMERIC
For more information, For more information, For more information, For more information,
see section 51.62 see section 51.147 see section 51.139 see section 51.43
“INPUT” on page “LENGTH” on page “MAXITEM” on page “NUMERIC” on page
1721. 1832. 1819. 1689.
IS... LINE MID NUMTOSTR
For more information, For more information, For more information,
see section 51.23 see section 51.148 see section 51.113
“IS...” on page 1654. “MID” on page 1833. “NUMTOSTR” on
page 1784.
LN MINIMUM
For more information, For more information,
see section 51.120 see section 51.140
“LN” on page 1793. “MINIMUM” on page
1821.
LOG MINITEM
For more information, For more information,
see section 51.121 see section 51.141
“LOG” on page “MINITEM” on page
1794. 1823.
MINUS
For more information,
see section 51.28
“MINUS” on page
1662.
MINUTE
For more information,
see section 51.86
“MINUTE” on page
1749.
Technical 04-16006-04-en, March 2015
1574
50 Script Introduction
50.6 Script Keywords
Continued
I L M N
MOD
For more information,
see section 51.29
“MOD” on page
1663.
MONTH
For more information,
see section 51.87
“MONTH” on page
1750.
MOVE
For more information,
see section 51.54
“MOVE” on page
1711.
50.6.4 O-S
This table contains keywords that begin with the letters O - S.
O P R S
OFF P RANDOM SCAN
For more information, For more information, For more information, For more information,
see section 51.9 see section 51.35 “P” see section 51.122 see section 51.95
“OFF” on page 1631. on page 1670. “RANDOM” on page “SCAN” on page
1795. 1760.
ON PASSED ReadProperty SELECT CASE
For more information, For more information, For more information, For more information,
see section 51.10 see section 51.130 see section 51.127 see section 51.57
“ON” on page 1632. “PASSED Function” “ReadProperty” on “SELECT CASE” on
on page 1808. page 1804. page 1715.
-ON PLUS Relinquish SECOND
For more information, For more information, For more information, For more information,
see section 51.11 “- see section 51.30 see section 51.128 see section 51.88
ON” on page 1633. “PLUS” on page “Relinquish” on page “SECOND” on page
1664. 1805. 1752.
OR PRINT Repeat...Until SEARCH
For more information, For more information, For more information, For more information,
see section 51.25 see section 51.36 see section 51.55 see the Search topic
“OR” on page 1658. “PRINT” on page “Repeat...Until” on on WebHelp.
1671. page 1712.
04-16006-04-en, March 2015 Technical
1575
50 Script Introduction
50.6 Script Keywords
Continued
O P R S
OUTPUT PUBLIC RETURN SET
For more information, For more information, For more information, For more information,
see section 51.64 see section 51.65 see section 51.56 see section 51.37
“OUTPUT” on page “PUBLIC” on page “RETURN” on page “SET” on page 1677.
1723. 1724. 1713.
RIGHT SIN
For more information, For more information,
see section 51.149 see section 51.162
“RIGHT” on page “SIN” on page 1849.
1834.
ROUND StandardDeviatio
n
For more information,
see section 51.134 For more information,
“ROUND” on page see section 51.142
1812. “StandardDeviation”
on page 1825.
STOP
For more information,
see section 51.58
“STOP” on page
1717.
STRING
For more information,
see section 51.44
“STRING” on page
1691.
STRINGFILL
For more information,
see section 51.151
“STRINGFILL” on
page 1836.
STRTODATE
For more information,
see section 51.114
“STRTODATE” on
page 1785.
STRTONUM
For more information,
see section 51.115
“STRTONUM” on
page 1787.
SQRT
For more information,
see section 51.123
“SQRT” on page
1796.
Technical 04-16006-04-en, March 2015
1576
50 Script Introduction
50.6 Script Keywords
Continued
O P R S
SUM
For more information,
see section 51.124
“SUM” on page
1797.
50.6.5 T-Y
This table contains keywords that begin with the letters T - Y.
T W Y
TAB WAIT YEAR
For more information, see For more information, see For more information, see
section 51.152 “TAB” on section 51.59 “WAIT” on section 51.91 “YEAR” on
page 1838. page 1718. page 1756.
TAN WebService
For more information, see For more information, see
section 51.163 “TAN” on section 51.46 “ Webservice”
page 1850. on page 1694.
TIMEPIECE WEEKDAY
For more information, see For more information, see
section 51.155 “TIMEPIECE” section 51.90 “WEEKDAY”
on page 1842. on page 1754.
TOD WHILE
For more information, see For more information, see
section 51.89 “TOD” on section 51.60 “WHILE” on
page 1753. page 1719.
TD WriteProperty
For more information, see For more information, see
section 51.78 “TD” on page section 51.129
1739. “WriteProperty” on page
1806.
TH
For more information, see
section 51.77 “TH” on page
1738.
THE
For more information, see
section 51.45 “THE” on page
1693.
04-16006-04-en, March 2015 Technical
1577
50 Script Introduction
50.6 Script Keywords
Continued
T W Y
TIMES
For more information, see
section 51.31 “TIMES” on
page 1665.
TM
For more information, see
section 51.76 “TM” on page
1737.
TS
For more information, see
section 51.75 “TS” on page
1736.
TURN
For more information, see
section 51.38 “TURN” on
page 1679.
TRUNCATE
For more information, see
section 51.135 “TRUNCATE”
on page 1813.
Technical 04-16006-04-en, March 2015
1578
50 Script Introduction
50.7 Script Program Flow
50.7 Script Program Flow
Script programs tell a server to perform numerous actions, such as increasing the
heat, locking doors, and printing reports. The program instructions that command
these actions are arranged and executed in a certain order, known as a program
flow.
Script has two types of program flows: FallThru and Looping.
50.7.1 FallThru Program Flow
A FallThru program executes the program lines in the sequential order in which you
list them: from the first line to the last line. Therefore, the program flows, or “falls
thru” the entire sequence of instructions.
For more information, see section 50.8 “FallThru Program Flow” on page 1578..
50.7.2 Looping Program Flow
A Looping program remains on one line until the program is instructed to go to
another line.
For more information, see section 50.9 “Looping Program Flow” on page 1580.
04-16006-04-en, March 2015 Technical
1579
50 Script Introduction
50.8 FallThru Program Flow
50.8 FallThru Program Flow
A FallThru program executes the program lines in the sequential order in which you
list them: from the first line to the last line. Therefore, the program flows, or “falls
thru” the entire sequence of instructions.
In the following FallThru program example, when the controller determines that the
temperature is not less than 70 and not greater than 75, the program flows to the
next consecutive line (labeled “Pumping”).
Figure: Script FallThru Program Example
FallThru programs start when prompted by a specific point or system variable. Any
point or system variable can automatically start a progam when its value changes.
The program is triggered by the action of the point or system variable. Once you
create a point or choose a system variable, the program you want to run is attached
through the trigger.
For example, suppose you write a program to control a circulating fan. You want
the fan to turn on when the room is occupied and turn off when the room is not
occupied. In your program, you could choose to use a point called OCCUPIED that
triggers the following program.
Figure: FallThru Program Trigger
Technical 04-16006-04-en, March 2015
1580
50 Script Introduction
50.8 FallThru Program Flow
You configure the trigger for the OCCUPIED point on the b3 field controller. Note
that you can only configure triggers on the b3 device. For more information, see
section 83.10 “Configuring Script FallThru Program Triggers in a b3 BACnet
Device” on page 3285..
04-16006-04-en, March 2015 Technical
1581
50 Script Introduction
50.9 Looping Program Flow
50.9 Looping Program Flow
A Looping program remains on one line until the program is instructed to go to
another line.
In the following Looping program example, the program continuously scans the
CheckOccupied line to determine if the office is occupied. If so, the program turns
on the office lights and fan. If not, the program turns them off.
Figure: Looping Program Example
Technical 04-16006-04-en, March 2015
1582
50 Script Introduction
50.10 Script Program Instructions
50.10 Script Program Instructions
The Script programming language consists of a set of instructions that tells the
server what to do. Each instruction is a complete text-command description that
tells the Automation Server to take some type of specific action to control a
building. Program instructions are listed in the order in which the controller must
perform them.
Script has two types of program instructions: conditional and unconditional. A
conditional instruction establishes criteria that have to be met before the instruction
can be executed and the task performed by a server:
IF Temp is 78 THEN Turn on Fan
An unconditional instruction directs a specific action without establishing any criteria
before the action can occur:
Turn on Fan
You can use “the” in a Script program instruction to make the statement easier to
read. The following examples show how “the” improves the readability of a
statement:
IF FAN IS ON THEN TURN ON PUMP
IF THE FAN IS ON THEN TURN ON THE PUMP
50.10.1 Lines and Line Numbers
A line acts as the basic execution unit of a Script program. Lines consist of one or
more statements that belong together under one label. The first or only line of a
program does not need to have a label. You can also add a comment here
preceded by a single quote ('), to help explain the operation of the program.
Comments are not acted upon by the program's logic.
For example, you can create a simple program that contains a single declaration
followed by a single program line:
Numeric i ‘Declaration of a local variable of type Numeric
i = 1 ‘Single program line
You can add a label to the line:
Numeric i
Line Setting
i=1
In this example, the line is labeled with the Line keyword or a colon after the line
name (but not both). All of the statements following the “Setting” label are then part
of that line until another Line label is encountered.
For more information, see section 50.11 “Lines and Line Numbers” on page 1583.
50.10.2 Verb and Verb Elements
To construct a Script program instruction, you must follow these guidelines:
• Use only one verb
04-16006-04-en, March 2015 Technical
1583
50 Script Introduction
50.10 Script Program Instructions
• Use one verb element or a list of verb elements after the verb
For example, these Script program instructions are valid:
OPEN THE DAMPER
CLOSE THE VALVE
Open the damper, vent1, vent2, vent3, and vent4
Close the firstvalve, secondvalve, thirdvalve
You cannot use two verbs, such as open and close, in the same instruction.
Therefore, this instruction is invalid:
OPEN THE DAMPER AND CLOSE THE VALVE
50.10.3 Case Sensitivity
Script instructions are not case sensitive. For example, the uppercase letter R and
the lowercase letter r are not treated differently. In Script, the following names are
treated the same:
RoomTemp1
ROOMTEMP1
RoomtemP1
50.10.4 Reserved Words
Reserved words are those words used as system constants, keywords, system
functions, and system variables that are reserved as part of the Script programming
language. Being familiar with these words helps avoid naming errors. You cannot
use reserved words as line label or program variables.
Before importing older programs to your controllers, check the program for
reserved words and remove or replace them. For more information, see section
50.12 “Reserved Words” on page 1584.
Technical 04-16006-04-en, March 2015
1584
50 Script Introduction
50.11 Lines and Line Numbers
50.11 Lines and Line Numbers
A line acts as the basic execution unit of a Script program. Lines consist of one or
more statements that belong together under one label. The first or only line of a
program does not need to have a label. You can also add a comment here
preceded by a single quote ('), to help explain the operation of the program.
Comments are not acted upon by the program's logic.
You label a line with the LINE keyword or a colon after the line name:
Figure: Line Labeling
In the previous example, all of the statements following the “BEGIN” label are part of
that line, until another LINE label is encountered. Line labels are limited to 16
characters, including underscores, periods, and numbers.
Statements in a line are indented to emphasize their relationship to the line label.
Ideally, you should always form lines this way.
You can number the lines in your program window in Script for easy reference while
programming. When you enable this feature, line numbers display in the left hand
side of the Script Editor.
Figure: Line Numbering
04-16006-04-en, March 2015 Technical
1585
50 Script Introduction
50.12 Reserved Words
50.12 Reserved Words
Reserved words are those words used as system constants, keywords, system
functions, and system variables that are reserved as part of the Script programming
language. Being familiar with these words helps avoid naming errors. You cannot
use reserved words as line label or program variables.
Before importing older programs to your controllers, check the program for
reserved words and remove or replace them.
50.12.1 Script Constants
Script constants, including class names, are listed in alphabetical order in the
following tables. You cannot use Script constants as a line label or program
variable.
For more information, see section 51.6 “Script Constants” on page 1627.
50.12.2 Script Reserved Words
Script reserved words are listed in alphabetical order in the following tables. You
cannot use reserved words as a line label or program variable.
For more information, see section 50.13 “Script Reserved Words” on page 1585.
Technical 04-16006-04-en, March 2015
1586
50 Script Introduction
50.13 Script Reserved Words
50.13 Script Reserved Words
Script reserved words are listed in alphabetical order in the following tables. You
cannot use reserved words as a line label or program variable.
Table: Reserved Words A-H
A B C D E F G H
Above Basedon C Date E Fact GetName Hod
Abs Below Case DateTime Either Factorial GetObjec Hour
t
AccessLo Between CD DayOfMo Else First Go HourOfD
g nth ay
DayOfYe
ar
AccessS Bitand Ceiling Del En Floor GoTo Hr
erver
AckAlarm Bitnot Change DiffTime Enable For Greater
Acos Bitor Chr Dis Encrypt From
Adjust Bitxor Cos Disable Encrypte
d
All Break Cosine Div End
Am Breakpoi Curvefit Divided EndIf
nt
And By Does EndSelec
t
Append Dom EndWhen
Arcsine Doy EndWhile
Arctange Dt Equal
nt
Arctange Equals
nt2
Arg Erase
Asc Errors
Execute
Asin Exists
Ask Exp
Atan Exponenti
al
Atan2
04-16006-04-en, March 2015 Technical
1587
50 Script Introduction
50.13 Script Reserved Words
Continued
A B C D E F G H
Average
Averaged
Avg
Table: Reserved Words I-S
I L M N O P R S
If Last Max Neither Object P Random Sc
In Left Maximum Next Open Param Return Scan
Is Len Maxitem Not Or Passed Right Sd
Length Message Number Output Pid Rnd Search
Window
Less Mid Numeric Plus Run Sec
Second
Let Min NumToSt Pm Select
r
Ln Minimum Pr Print Set
Log Minitem Shut
Lookup Minus Sin
Minute Sine
Mod Site
Modify Sqrt
Month Standard
-
Deviation
Move Start
Mth Status
Mult StatusLin
e
Multiplied Step
Stop
String
Stringfill
Technical 04-16006-04-en, March 2015
1588
50 Script Introduction
50.13 Script Reserved Words
Continued
I L M N O P R S
StrToDat
e
StrToNu
m
StrToTim
e
Sum
Table: Reserved Words T-Z
T U V W
Tab Unadvise Val Weekday
Tan UniquePIN Version When
Tangent Until Where
Td Update While
Th UpdateAlarms With
Than UpdateEvents WriteProperty
The UpdateExitLog
Then
Through
Thru
Time
TimeOfDay
Timepiece
Times
TmTo
Tod
Touchedcell
Trace
Trunc
Truncate
04-16006-04-en, March 2015 Technical
1589
50 Script Introduction
50.13 Script Reserved Words
Continued
T U V W
Ts
Turn
Technical 04-16006-04-en, March 2015
1590
50 Script Introduction
50.14 Bindings and Script Programs
50.14 Bindings and Script Programs
A binding is an association between a local variable (numeric, string, datetime,
function) within a Script program and a property of an object in the system. The use
of bindings increases the flexibility of the building automation system. You can write
a program for one application, and use that program for a similar application by just
changing the bindings instead of changing all of the local variable names in the
program to suit the new program.
50.14.1 Local Variable Declarations
In Script, you declare local variables using either the Input, Output, or Public binding
keyword. Then, you bind those variables to the object properties. For example, you
can bind to the value of a point, or have a program's output bound to an input of
another program.
Note
With bindings, you are not limited solely to the properties of points and programs.
You can also use other object types.
For more information, see section 50.16 “Local Variable Declarations” on page
1592.
50.14.2 Binding Attributes
A binding is an association between a local variable (numeric, string, datetime, or
function) within a Script program and a property of an object in the system. In
Script, you declare local variables using either the Input, Output, or Public binding
keyword. Then, you bind those variables to the object properties (the values of the
points in the system).
For more information, see section 50.17 “Binding Attributes” on page 1596.
04-16006-04-en, March 2015 Technical
1591
50 Script Introduction
50.15 Binding Values in Script Editor Using a Binding Template
50.15 Binding Values in Script Editor Using a
Binding Template
You use binding templates to reduce engineering time when creating bindings for
variables and functions within a Script program. Binding templates are defined and
created for binding patterns that are frequently reused. You can access the
Bindings view without leaving Script Editor.
For more information, see section 16.1 “Binding Templates” on page 449.
To bind values in Script Editor using a binding template
1. In Script Editor, click Bindings to display the Bindings view for the Script
program.
2. In the binding point browser, drag the object or folder to the binding template
that you want to apply.
Continued on next page
Technical 04-16006-04-en, March 2015
1592
50 Script Introduction
50.15 Binding Values in Script Editor Using a Binding Template
3. Select the bindings that you want to create.
4. Click OK.
5. Verify that all bindings are correctly bound.
6. On the toolbar, click Save.
04-16006-04-en, March 2015 Technical
1593
50 Script Introduction
50.16 Local Variable Declarations
50.16 Local Variable Declarations
In Script, you declare local variables using either the Input, Output, or Public binding
keyword. Then, you bind those variables to the object properties. For example, you
can bind to the value of a point, or have a program's output bound to an input of
another program.
Note
With bindings, you are not limited solely to the properties of points and programs.
You can also use other object types.
During execution, when the program gets the value of an Input variable, the
program gets the value of the object property (the value of a point). When the
program sets the value of an Output variable, the program sets the value of the
object property (the value of a point).
You can use a binding with the following:
• Input variables
• Output variables
• Public variables
• User-Defined Functions
Any hardware or software input, output device like a fan, motion sensor, or a Script
function is represented as an object in Building Operation. When you create a local
variable in Script, that variable is generic and can potentially be associated with the
object property and the local variable that property is bound to. The object property
and the local variable must have similar types. For example, you bind a numeric
local variable to an integer, float, digital, and enumeration instead of a string or
datetime.
An example of a binding with a Script Program
To access the values of points in the system through bindings, a Script program
must include Input, Output, Public, or Function local variables. The following figure
shows the Bindings view for a Script program.
Technical 04-16006-04-en, March 2015
1594
50 Script Introduction
50.16 Local Variable Declarations
Figure: Bindings View for a Script Program
Tip
Corresponding properties tabs are displayed, one for each binding type. These
tabs list each of the local variables that can be bound to other objects in the
system.
In Script, you can bind using either the Bindings view in Building Operation, or the
Bindings view in the Script Editor. For more information, see section 38.10 “Binding
Values Using a Binding Template” on page 1220.
Using the Bindings view in Script Editor, you can slide the view, overlay your Script
program, bind the necessary objects, retract the view, and then resume
programming without leaving the Script Editor.
04-16006-04-en, March 2015 Technical
1595
50 Script Introduction
50.16 Local Variable Declarations
Figure: Bindings View - Slider View
You can also undock the Bindings view in Script Editor and include it as a tab
wherever you want in the Editor window. For example, you can position it at the
bottom of the window as shown in the following graphic.
Technical 04-16006-04-en, March 2015
1596
50 Script Introduction
50.16 Local Variable Declarations
Figure: Bindings View - Tabbed View
Public Binding Qualifier
Public is a binding qualifier that identifies a variable as a public variable. You can
modify a public variable from outside a Script program, such as from a graphic.
Public behaves like an output variable, so you may bind the public variable to the
value of a point, or to the input variable of a Script program as you would with any
output variable. Unlike an output variable, you do not have to use the force
capability to modify Public from the Script property grid, or from a graphic.
You should use the Public binding qualifier when you need to directly modify that
variable from the Script property grid (that is, modify the value the Public binding
variable is bound to). Unlike an output variable, you can manually change the value
of the public variable from a graphic.
04-16006-04-en, March 2015 Technical
1597
50 Script Introduction
50.17 Binding Attributes
50.17 Binding Attributes
In Script, you declare local variables using either the Input, Output, or Public binding
keyword. Then, you bind those variables to the object properties (the values of the
points in the system).
You can set and read four binding attributes in a Script program: Forced, Invalid,
Offline, and Overridden. To access these binding attributes, use the . (dot) syntax in
the Script Editor. For more information, see section 50.22 “Accessing a Binding
Attribute” on page 1601.
Tip
The Script Editor provides Intellisense for the binding attributes. Intellisense is an
auto-completion tool that you use to fill in predictive text based on the possible
matches to the text you type. For more information, see section 52.10 “Script
Auto-Completion” on page 1872.
50.17.1 Forced
You use the Forced binding attribute to force a point to its most recent value. You
can only force an output.
For more information, see section 50.18 “Forced” on page 1597.
50.17.2 Invalid
You use the Invalid binding attribute to determine if there is an error with the bound
point. Invalid works for any input and output point.
For more information, see section 50.19 “Invalid” on page 1598.
50.17.3 Offline
You use the Offline binding attribute to determine if the point is offline. If the point is
offline, it displays true.
For more information, see section 50.20 “Offline” on page 1599.
50.17.4 Overridden
You use the Overridden binding attribute to determine if the point has been
physically overridden. Overridden is valid for output bindings only.
For more information, see section 50.21 “Overridden” on page 1600.
Technical 04-16006-04-en, March 2015
1598
50 Script Introduction
50.18 Forced
50.18 Forced
You use the Forced binding attribute to force a point to its most recent value. You
can only force an output.
Forcing a value prevents the output point from receiving values from the Script
program. As a result, the last value stays in the output even if you attempt to
change it within the program.
Syntax
BINDING_NAME.Forced = true
BINDING_NAME.Forced = false
Table: Forced Parameters
Parameter Description
true Sets the point to the most recent value.
false Turns off the force operation.
Examples
This example forces output1 to its most recent value.
output1.Forced = true
04-16006-04-en, March 2015 Technical
1599
50 Script Introduction
50.19 Invalid
50.19 Invalid
You use the Invalid binding attribute to determine if there is an error with the bound
point. Invalid works for any input and output point.
Syntax
BINDING_NAME.Invalid = true
BINDING_NAME.Invalid = false
Table: Invalid Parameters
Parameter Description
true Specifies there is an error with the bound
point.
false Specifies there is no error with the bound
point.
Examples
This example checks the bound point for errors.
If output1.Invalid = true then...
Technical 04-16006-04-en, March 2015
1600
50 Script Introduction
50.20 Offline
50.20 Offline
You use the Offline binding attribute to determine if the point is offline. If the point is
offline, it displays true.
Syntax
BINDING_NAME.Offline = true
BINDING_NAME.Offline = false
Table: Offline Parameters
Parameter Description
true Specifies that the point is offline.
false Specifies that the point is online.
Note
If a Script program sets the Offline status and later checks it, the status will be
unchanged from when it was last set by the program. It will not show the actual
property value from the source.
Examples
This example determines if the bound point is offline.
If output1.Offline = true then...
04-16006-04-en, March 2015 Technical
1601
50 Script Introduction
50.21 Overridden
50.21 Overridden
You use the Overridden binding attribute to determine if the point has been
physically overridden. Overridden is valid for output bindings only.
Syntax
BINDING_NAME.Overridden = true
BINDING_NAME.Overridden = false
Table: Overridden Parameters
Parameter Description
true Specifies that the output is physically
overridden.
false Specifies that the output is not physically
overridden.
Examples
This example determines if the point has been physically overridden.
If output1.Overridden = true then...
Technical 04-16006-04-en, March 2015
1602
50 Script Introduction
50.22 Accessing a Binding Attribute
50.22 Accessing a Binding Attribute
You set and read binding attributes within a Script program or function.
For more information, see section 50.17 “Binding Attributes” on page 1596.
To access a binding attribute
1. Open the Script Editor.
2. Aaccess the binding attributes using the . (dot) syntax.
04-16006-04-en, March 2015 Technical
1603
50 Script Introduction
50.23 Tasks
50.23 Tasks
Function block and Script programs must be connected to tasks in order to run.
You access Tasks from the Properties dialog box.
The task is a property of the object that defines the program cycles.
When you create a new function block or Script program, Task 3 is the default. This
means that one program cycle executes in 1000 ms.
Figure: Tasks
The way you schedule programs to execute in Script differs from how you schedule
them to execute in Continuum. For more information, see the Script and Plain
English Program Differences topic on WebHelp.
Table: Task Intervals
Task Interval
Task 1 0.1 seconds
Task 2 0.5 seconds
Task 3 1 seconds
Task 4 5 seconds
Task 5 10 seconds
Technical 04-16006-04-en, March 2015
1604
50 Script Introduction
50.24 Adding a Task to a Program
50.24 Adding a Task to a Program
To make a Script or Function Block program run, the program must be connected
to a task.
For more information, see section 50.23 “Tasks” on page 1602.
To add a task to a program
1. In WorkStation, in the System Tree pane, select the program you want to
add a task to.
2. On the File menu, click Properties.
3. In the Task box, enter the task you want to add.
4. Click OK.
04-16006-04-en, March 2015 Technical
1605
50 Script Introduction
50.25 Program Cycles in Building Operation
50.25 Program Cycles in Building Operation
All programs are executed in the order they are bound in Building Operation. For
example, in programs that are executed in a straight order or in any similar
configuration, Program 4 runs after Program 3 that runs after Program 2 that runs
after Program 1. The first program to be executed is Program 1.
The illustration that follows shows the execution sequence for a straight order
configuration.
Figure: Execution order of programs
When programs are connected in an algebraic loop, the execution order cannot be
determined and the program that runs first needs to be established. In Building
Operation, algebraic loops are called Cycles. In this case, there is no way to
determine the execution order of the programs. Program 4 runs after Program 3
that runs after Program 2 that runs after Program 1 that runs after Program 4.
Figure: In an algebraic loop the execution order of programs cannot easily be determined.
To resolve a cycle and determine which program runs first in the cycle, you use the
execution precedence function. Programs can have execution precedence values
ranging from 0 to 255 where 0 results in the highest priority and 255 results in the
lowest priority. The program with highest execution precedence is always executed
first in the cycle.
Execution Precedence
Values: Integers ranging from 0 to 255
Highest priority value: 0
Lowest priority value: 255
The execution precedence is configured in the properties for the program. The
default value when you create a new program is 100.
Technical 04-16006-04-en, March 2015
1606
50 Script Introduction
50.25 Program Cycles in Building Operation
Figure: Execution precedence
The execution precedence can never override the execution order of programs
based on how they are bound. The execution precedence decides the order in
which the programs are run when they are set up in some form of cycle and the
binding does not give a straight order for which program runs first.
The execution precedence can be used in two different situations:
• To determine the execution order when programs are bound in a cycle.
• As troubleshooting, for example when a there are delays without any known
reason. A long delay might be the result of programs that run in the wrong
order.
50.25.1 Example A
In this example we have four programs that are connected in a cycle. The execution
order cannot be determined from how programs are bound. Program 1 should run
before Program 2, Program 2 before Program 3, and Program 4 before Program 1.
04-16006-04-en, March 2015 Technical
1607
50 Script Introduction
50.25 Program Cycles in Building Operation
Figure: Example
However, Program 2 reads from a physical input, Input A, and the information from
this reading is transferred to Program 4, which writes to a physical output, Output
B.
Figure: Example
So, we want to Program 2 to run before Program 4. To do this we use execution
precedence. By configuring the Execution precedence as 99 for Program 2,
Program 2 will be the first program to be executed in the cycle.
Figure: Example
The resulting execution order will be P2, P3, P4 and P1.
Technical 04-16006-04-en, March 2015
1608
50 Script Introduction
50.25 Program Cycles in Building Operation
50.25.2 Example B
All programs use the default execution precedence that is 100. In this example, it is
not possible to determine the execution order of Program 1 and Program 2 and the
execution order of Program 3 and Program 4. The only thing we can be sure of is
that the cycle with Program 1 and Program 2 is executed before the cycle with
Program 3 and Program 4 due to the fact that Program 3 awaits input from
Program 2.
Figure: Example
To resolve the order we configure Program 2 and Program 3 to have the execution
precedence of 99. Then Program 2 runs before Program 1 in the first cycle and
Program 3 before Program 4 in the second cycle.
Figure: Example
Now the execution order is Program 2, Program 3, Program 4 and Program 1.
50.25.3 Application Scheduler
The Application Scheduler displays the programs execution order and if you have
any cycles in your system. In the System Tree pane, the Application Scheduler is
displayed in the Modules folder. The programs are represented with an entry under
the task they are assigned to.
04-16006-04-en, March 2015 Technical
1609
50 Script Introduction
50.25 Program Cycles in Building Operation
Figure: Application scheduler
The object called cycle identifies a cycle. In the properties dialog for the task the
property "Conflict" is set to "True" if there is any cycle in the Task. Conflicts do not
mean that the programs will not run at all. The programs will run but the might run in
an execution order that may cause unnecessary delays from input to output.
Technical 04-16006-04-en, March 2015
1610
50 Script Introduction
50.25 Program Cycles in Building Operation
Figure: Conflict setting in task 3
Use the List View to see the execution order of the programs.
Figure: Entries in the List View
Entry is the order of execution of the programs for a specific task. In this case
Program 2 executes first followed by Program 4. Program 3 runs last.
04-16006-04-en, March 2015 Technical
1611
50 Script Introduction
50.26 Configuring the Execution Precedence for a Program
50.26 Configuring the Execution Precedence
for a Program
You configure the highest execution precedence number on the program you want
to be executed first in a cycle.
For more information, see section 50.25 “Program Cycles in Building Operation ” on
page 1604.
To configure the execution precedence for a program
1. In WorkStation, in the System tree pane, select the program.
2. On the File menu, click Properties.
3. In the Execution precedence box, enter a number that is higher than all the
other programs in the cycle.
4. Click OK.
Technical 04-16006-04-en, March 2015
1612
50 Script Introduction
50.27 Finding Cycles in a Task
50.27 Finding Cycles in a Task
If you encounter unexpected delays in input to output response, the execution
order of the programs in a Task might not optimized.
For more information, see section 50.25 “Program Cycles in Building Operation ” on
page 1604.
To find cycles in a task
1. In WorkStation, in the System Tree pane, in the System folder, open the
Modules, and then ApplicationScheduler foldes.
2. Open a Task.
3. If the Task contains an object called Cycle, a cycle is present.
04-16006-04-en, March 2015 Technical
1613
51 Script Programming
Topics
Script Program Components
Program Constants
Numeric Constants
String Constants
ASCII Codes
Script Constants
Constant Keywords
Failure
OFF
ON
-ON
Success
Program Operators
Operator Keywords
Bitwise Operators
BITAND
BITNOT
BITOR
BITXOR
Logical Operators
AND
EQUALS
IS...
NOT
OR
Mathematical Operators
DIVIDED BY
MINUS
MOD
PLUS
TIMES
Program Statements
Statement Keywords
Action Statements
P
PRINT
SET
TURN
Declaration Statements
ARG
DATETIME
LINE
NUMERIC
STRING
THE
Webservice
Program Control Statements
BASEDON...GOTO
BREAK
CONTINUE
FOR...NEXT
GOTO
IF...THEN...ELSE
MOVE
Repeat...Until
RETURN
SELECT CASE
STOP
WAIT
WHILE
Qualifier Statements
INPUT
Buffered
OUTPUT
PUBLIC
Expressions
Variables
Declaring a Variable
Program Variables
Local Program Variables
Variables Pane Types
Program Arrays
System Variables
Script Runtime Variables
TS
TM
TH
TD
System Variable Keywords
Date and Time System Variables
DATE
DAYOFMONTH
DAYOFYEAR
HOD
HOUR
MINUTE
MONTH
SECOND
TOD
WEEKDAY
YEAR
Runtime System Variables
ERRORS
FREEMEM
SCAN
Script Functions
Script Function Workflow
Script Functions without Arguments
Script Functions with Arguments
Script Functions that Return a Value
Script Functions and Programs
Function Declarations and Statements
Declaring and Calling a Script Function
Creating a Script Function
Declaring a Script Function Argument
Checking and Saving a Script Function
System Functions
System Function Keywords
Buffered Variable Functions
GetBufferSize
GetBufferedValue
Conversion Functions
NUMTOSTR
STRTODATE
STRTONUM
Mathematical Functions
ABS
EXPONENTIAL
FACTORIAL
LN
LOG
RANDOM
SQRT
SUM
Object Functions
GETNAME
ReadProperty
Relinquish
WriteProperty
PASSED Function
Rounding Functions
CEILING
FLOOR
ROUND
TRUNCATE
Statistical Functions
AVERAGE
MAXIMUM
MAXITEM
MINIMUM
MINITEM
StandardDeviation
String Functions
ASC
CHR
LEFT
LENGTH
MID
RIGHT
SEARCH
STRINGFILL
TAB
Time Functions
DIFFTIME
TIMEPIECE
Trigonometric Functions
ACOS
ASIN
ATAN
ATAN2
COS
SIN
TAN
51 Script Programming
51.1 Script Program Components
51.1 Script Program Components
Script programs are composed of the following components that allow you to
develop your programs quickly and easily:
• Program constants
• Program operators
• Program statements
• Expressions
• Variables
For example, you can create program statements with everyday language, so you
do not need to be a programmer to learn how to program with Script.
51.1.1 Program Constants
Constants are numbers, words, or dates that do not change.
For more information, see section 51.2 “Program Constants” on page 1621.
51.1.2 Program Operators
An operator is the part of an expression that causes a mathematical operation to
occur, such as addition, or tests a condition, such as equality.
For more information, see section 51.13 “Program Operators” on page 1635.
51.1.3 Program Statements
Program statements are written with Script words, known as keywords, that are
arranged in a predefined structure. Each keyword has its own keyword syntax.
According to the rules of that syntax, certain parameters and values are allowed or
not allowed to follow a keyword.
For more information, see section 51.32 “Program Statements” on page 1666.
51.1.4 Expressions
Instructions that consist of mathematical operations are called expressions.
Expressions can also be item names or constants that return a numeric or string
result.
For more information, see section 51.66 “Expressions” on page 1725.
51.1.5 Variables
A variable is a run-time (dynamically changing) property of an object.
04-16006-04-en, March 2015 Technical
1621
51 Script Programming
51.1 Script Program Components
For more information, see section 51.67 “Variables” on page 1726.
Technical 04-16006-04-en, March 2015
1622
51 Script Programming
51.2 Program Constants
51.2 Program Constants
Constants are numbers, words, or dates that do not change.
51.2.1 Numeric Constants
A numeric constant is a number. In Script, only floating point numbers are used. A
floating point number is a number with a decimal.
For more information, see section 51.3 “Numeric Constants” on page 1622.
51.2.2 String Constants
A string constant is a series of ASCII characters, including blanks, surrounded by
quotation marks ("string").
For more information, see section 51.4 “String Constants” on page 1623.
51.2.3 Script Constants
Script constants, including class names, are listed in alphabetical order in the
following tables. You cannot use Script constants as a line label or program
variable.
For more information, see section 51.6 “Script Constants” on page 1627.
51.2.4 Constant Keywords
Script constant keywords represent numbers or values that are used in
expressions.
For more information, see section 51.7 “Constant Keywords” on page 1629.
04-16006-04-en, March 2015 Technical
1623
51 Script Programming
51.3 Numeric Constants
51.3 Numeric Constants
A numeric constant is a number. In Script, only floating point numbers are used. A
floating point number is a number with a decimal.
You can enter a floating point number in one of the following ways:
• Number with up to seven decimal places
• Number in scientific notation
• Positive numbers between 1.40129E-45 and 3.402823E+38
• Negative numbers between -3.402823E+38 and -1.40129E-45
Floating point numbers can display without decimal points, but are still handled by
the system as floating point numbers. The accepted numbers are based on the
Institute of Electrical and Electronics Engineers, IEEE 754 single precision format.
The following numbers are examples of numeric constants:
• 12
• 74.5
• -.543
• 4E+32
Do not use a comma in the number. For example, 1,000 is an invalid numeric
constant.
Script interprets only the following numbers:
• Greater than 3.402823E+38 as infinity.
• Less than -.402823E+38 as negative infinity.
Script accepts all numbers, but interprets only the following numbers:
• Numbers greater than 3.402823E+38 are interpreted as infinity.
• Less than -.402823E+38 as negative infinity.
• Between 1.40129E-45 and -.40129E-45 as zero.
Technical 04-16006-04-en, March 2015
1624
51 Script Programming
51.4 String Constants
51.4 String Constants
A string constant is a series of ASCII characters, including blanks, surrounded by
quotation marks ("string").
The following are examples of some acceptable strings:
• "Hello world"
• "Access to the building is restricted"
• "123"
51.4.1 Rules for String Constants
Even though a string contains a number, the number cannot be directly used in
mathematical calculations.
In Script, the vertical bar, |, is the control character in a string. Anything you put after
the vertical bar is interpreted as a code or a format for a variable value. For example,
to print a quote enclosed by quotation marks you would use (“) following the vertical
bar. In the statement that follows:
PRINT "The string |" abc|" is included"
The printer outputs: The string "abc" is included.
More information about the vertical bar in strings is included under the PRINT
keyword.
51.4.2 ASCII Codes
Most keyboards have a limited set of characters. There are no characters to control
such actions as feeding the paper, turning on a beep, scrolling the screen, and so
on. For these actions, you use a set of codes called the American Standard Code
for Information Interchange (ASCII).
For more information, see section 51.5 “ASCII Codes” on page 1624.
04-16006-04-en, March 2015 Technical
1625
51 Script Programming
51.5 ASCII Codes
51.5 ASCII Codes
Most keyboards have a limited set of characters. There are no characters to control
such actions as feeding the paper, turning on a beep, scrolling the screen, and so
on. For these actions, you use a set of codes called the American Standard Code
for Information Interchange (ASCII).
You use these codes in a PRINT statement to control your printer or screen. For
more information, see section 51.36 “PRINT” on page 1671.
The following table lists ASCII codes. Examples follow the table.
Table: ASCII Code
Code (in Decimal) Character or Action
0 NUL
1 SOH
2 STX
3 ETX
4 EOT
5 ENQ
6 ACK
7 Beep
8 Backspace
9 TAB forward
10 Line feed
11 Vertical TAB
12 Form feed
13 Carriage return
14 SO
15 SI
16 DLE
17 DC1
18 DC2
19 DC3
20 DC4
21 NAK
Technical 04-16006-04-en, March 2015
1626
51 Script Programming
51.5 ASCII Codes
Continued
Code (in Decimal) Character or Action
22 SYN
23 ETB
24 CAN
25 EM
26 SUB
27 ESC
28 FS
29 GS
30 RS
31 US
127 DEL
Note
• Script supports characters at or below ASCII 127. Additional characters are
not supported and are replaced by a question mark (?).
Examples
For example, you might use the ASCII code for a character in the STRINGFILL
function. You must give STRINGFILL the code for the character with which you
want to fill the string. For more information, see section 51.151 “STRINGFILL” on
page 1836.
For example, to make the printer beep, you send the beep code a PRINT
statement, like this:
Print "|7" to Printer1
You can also make a terminal beep as follows:
Print "|7" to Screen1
To feed the paper forward one form feed:
Print "|12" to Printer1
To send an ESCAPE to the printer:
Print "|27" to Printer1
More printer control statements can be available for your printer. See the
manufacturer's documentation.
To create a bar in a chart, you might fill a string with asterisks using STRINGFILL
and the ASCII code for asterisk, 42, as follows:
Stringfill (Kilowatts, 42)
You could make a similar bar in a chart using pound signs:
04-16006-04-en, March 2015 Technical
1627
51 Script Programming
51.5 ASCII Codes
Stringfill (Pressure, 35)
Technical 04-16006-04-en, March 2015
1628
51 Script Programming
51.6 Script Constants
51.6 Script Constants
Script constants, including class names, are listed in alphabetical order in the
following tables. You cannot use Script constants as a line label or program
variable.
Table: Script Constants A-M
A B C D E F J M
Apr Binary Char Days Enabled Failed Jan Mar
April Bit Character Dec EnableDis Failure January March
SetNotSu able
pported
Aug Bitstring CharType Decembe EndResto False Jul Minutes
r re
August Closed Delete Equal Fault July MissingR
equiredP
arameter
Average Constant Digital Feb Jun Mon
Averaged CurrentV Disabled February June Monday
alue
Active Fri Months
Friday MonthTo
Date
Function MonthTo
Now
Table: Script Constants N-Z
N O P R S T
Nov Object Print Run Sat Thu
November ObjectClass Running Saturday Thursday
NoVTSession ObjectDeletio Sep Today
s-Available nNotPermitte
d
ObjectID September True
ObjectIdentifi Singular Tue
er-
AlreadyExists
ObjectRefere Site_Config Tuesday
nce
04-16006-04-en, March 2015 Technical
1629
51 Script Programming
51.6 Script Constants
Continued
N O P R S T
Oct Site_ConfigB
October Success
Odd Sun
Off Sunday
Offline
On
-On
OneWeekTo
Date
OneWeekTo
Now
OneYearToD
ate
OneYearToN
ow
Online
Opened
Or
Other
OverRange
Overridden
Technical 04-16006-04-en, March 2015
1630
51 Script Programming
51.7 Constant Keywords
51.7 Constant Keywords
Script constant keywords represent numbers or values that are used in
expressions.
There are five different Script constant keywords.
51.7.1 Failure
Failure is used in expressions to indicate a function has failed to complete. Failure is
always numeric and equal to one. Failure can be used to replace numbers in a
comparison expression.
For more information, see section 51.8 “Failure” on page 1630.
51.7.2 OFF
OFF is used in expressions to indicate an item is OFF or set to bottom of scale.
OFF is always numeric and thus, can be compared to numeric values of points or
variables in a comparison expression.
For more information, see section 51.9 “OFF” on page 1631.
51.7.3 ON
ON is used in expressions to indicate an item is ON or set top of scale.
ON is always numeric and can be compared to input, output, and numeric points or
variables in a comparison expression.
For more information, see section 51.10 “ON” on page 1632..
51.7.4 -ON
-ON is used in expressions to indicate a tri-state point is set to -ON.
-ON is always numeric and thus, can be compared to numeric values of points or
variables in a comparison expression.
For more information, see section 51.11 “-ON” on page 1633..
51.7.5 Success
Success is used in expressions to indicate a process or function has completed
successfully.
Sucess is always numeric and equal to zero.
For more information, see section 51.12 “Success” on page 1634..
04-16006-04-en, March 2015 Technical
1631
51 Script Programming
51.8 Failure
51.8 Failure
Failure is used in expressions to indicate a function has failed to complete. Failure is
always numeric and equal to one. Failure can be used to replace numbers in a
comparison expression.
Syntax
Failure
Technical 04-16006-04-en, March 2015
1632
51 Script Programming
51.9 OFF
51.9 OFF
OFF is used in expressions to indicate an item is OFF or set to bottom of scale.
OFF is always numeric and thus, can be compared to numeric values of points or
variables in a comparison expression.
Syntax
Off
Examples
Example 1
Program File
Turn the Lobby_Light Off
Example 2
Program File
If the Lobby_Light is Off then Turn Off the Heat
04-16006-04-en, March 2015 Technical
1633
51 Script Programming
51.10 ON
51.10 ON
ON is used in expressions to indicate an item is ON or set top of scale.
ON is always numeric and can be compared to input, output, and numeric points or
variables in a comparison expression.
Syntax
On
Example
Script Program File - Using ON and OFF
If timeofday is between 9 and 17 then
Set the Fan to ON
Else
Set the Fan to OFF
Endif
Technical 04-16006-04-en, March 2015
1634
51 Script Programming
51.11 -ON
51.11 -ON
-ON is used in expressions to indicate a tri-state point is set to -ON.
-ON is always numeric and thus, can be compared to numeric values of points or
variables in a comparison expression.
Syntax
-On
Example
Program File
If the Flow is greater than SetPoint then set the Damper to -On
04-16006-04-en, March 2015 Technical
1635
51 Script Programming
51.12 Success
51.12 Success
Success is used in expressions to indicate a process or function has completed
successfully.
Sucess is always numeric and equal to zero.
Syntax
Success
Examples
Call a user-defined Script function, which returns either Success or Failure.
If MyUpdateFunction (“Zone1”, “Temperature”, TempValue) =
Success then Print "Update Successful"
Else
user1Goto RecordFailure
Endif
Technical 04-16006-04-en, March 2015
1636
51 Script Programming
51.13 Program Operators
51.13 Program Operators
An operator is the part of an expression that causes a mathematical operation to
occur, such as addition, or tests a condition, such as equality.
51.13.1 Operator Precedence
In Script, operators are acted upon in a certain sequence when more than one
operator occurs in an expression. This is known as operator precedence. The
following table lists the order (top to bottom) that is used when working out an
expression.
Table: Operator Precedence
Operator Description Association
() Parentheses Left to Right
[] Array Element Left to Right
Blank or \ Path Name Connector Right to Left
+ Plus Sign on Number Right to Left
- Minus Sign on Number
NOT Logical Negation
BITNOT Bitwise Negation
% Percentage
^ Exponentiation Left to Right
* Multiplication Left to Right
/ Division
MOD Modulo
+ Addition Left to Right
- Subtraction
< Less Than Left to Right
<= Less Than or Equal
> Greater Than
>= Greater Than or Equal
= Equal Left to Right
<> Not Equal
IS IN Set Inclusion
IS NOT IN Set Exclusion
IS BETWEEN Range
IS THRU Range
04-16006-04-en, March 2015 Technical
1637
51 Script Programming
51.13 Program Operators
Continued
Operator Description Association
BITAND Bitwise Logical And Left to Right
BITOR Bitwise Logical Or
BITXOR Bitwise Exclusive Or
& Logical And Left to Right
! Logical Or
; Joining Operator Left to Right
51.13.2 Plus Sign, Minus Sign, Negation, BITNOT, and
Percentage Operators
The following table identifies and defines the plus sign, minus sign, negation,
BITNOT, and percentage operators.
Table: Plus Sign, Minus Sign, Negation, BITNOT, and Percentage
Operator Definition
+ number Shows that a number is positive, but does
not affect the value.
- number Makes a positive number negative and a
negative number positive. This operator
works only on numeric expressions.
NOT number Negates the number or expression. If the
value of the expression is nonzero, NOT
changes that expression to 0. If the
expression is TRUE, NOT makes that
expression FALSE.
BITNOT integer Changes the 1s to 0s and 0s to 1s in the
binary equivalent of the integer, and then
gives you the decimal integer equivalent of
that binary number.
number % Divides the number by 100 to determine the
percentage.
51.13.3 Fundamental Operators
The following table identifies and defines the fundamental operators.
Technical 04-16006-04-en, March 2015
1638
51 Script Programming
51.13 Program Operators
Table: Fundamental Operators
Operator Example Definition
Addition number + number Adds the numbers. Works on
numbers or datetimes and
the resulting expression is
numeric or datetime.
Alias: PLUS
Subtraction number - number Works on numbers or
datetimes and the resulting
expression is numeric or
datetime.
Alias: MINUS
Multiplication number * number Multiples the numbers.
Works on numbers and the
resulting expression is
numeric.
Aliases: TIMES, MULT, and
MULTIPLIED BY
Division number / number Divides the first number by
the second. Works on
numbers and the resulting
expression is numeric.
Alias: DIVIDED BY
Modulus number MOD number Finds the amount left over
when dividing the first
number by the second. For
example, 9 MOD 7 gives 2.
Alias: REMAINDER
Exponentiation number ^ number Raises the first number to the
power of the second
number. For example, 2 ^ 3
=8
Alias: EXP
51.13.4 Comparative Operators
A comparative operator compares the number to the left of the keyword with the
number to its right. The results are TRUE (numeric 1) or FALSE (numeric 0) and are
considered numeric.
04-16006-04-en, March 2015 Technical
1639
51 Script Programming
51.13 Program Operators
Table: Comparative Operators
Operator Example Definition
Less Than number < number Determines whether the
value of the left number is
less than the value of the
right number.
Aliases: IS LESS THAN
(THAN is optional) and IS
BELOW
Less Than or Equal number <= number Determines whether the
value of the left number is
less than or equal to the
value of the right number.
Alias: IS LESS THAN OR
EQUAL TO where THAN and
TO are optional
Greater Than number > number Determines whether the
value of the left number is
greater than the value of the
right number.
Alias: IS GREATER THAN
(THAN is optional) and IS
ABOVE
Greater Than or Equal number >= number Determines whether the
value of the left number is
greater than or equal to the
value of the right number.
Alias: IS GREATER THAN
OR EQUAL TO, where THAN
and TO are optional
Equal number = number Determines whether the
value of the left number is
equal to the value of the right
number.
Aliases: EQUALS, IS EQUAL
TO, and IS EQUAL
Not Equal number <> number Determines whether the
value of the left number is not
equal to the value of the right
number.
Aliases: DOES NOT EQUAL,
IS NOT EQUAL TO, and IS
NOT EQUAL
Technical 04-16006-04-en, March 2015
1640
51 Script Programming
51.13 Program Operators
Operator Example Definition
Comparing String Values
You can also use Greater Than, Less Than, or Equal To operators to compare two
string values. The strings are evaluated by ASCII code, using their numerical ASCII
values. For example, "Z" which has an ASCII value of 90 is greater than "A" which
has an ASCII value of 65. Likewise, "9" is greater than "0", and "A" is greater than
"9". Also, "ABC", which is the equivalent to the sum of the ASCII values of each
individual character, is greater than "A". For more information, see section 51.5
“ASCII Codes” on page 1624..
51.13.5 List and Range Operators
The following table identifies and defines list and range operators.
Table: List and Range Operators
Operator Example Definition
IS IN number IS IN list Determines if the number or
expression on the left is in
Or the listed set. If the number
number IS list on the left-hand side of the
expression is in the list
expression on the right-hand
side, the expression yields
TRUE (numeric 1). If the
expression is not in the list on
the right-hand side, the
expression yields FALSE
(numeric 0).
Alias: IS EITHER
IS NOT IN number is NOT IN list Determines if the number or
expression on the left is NOT
in the listed set. If the number
on the left-hand side of the
expression is NOT in the list
expression on the right-hand
side, the expression yields
TRUE (numeric 1). If the
expression is in the list on the
right-hand side, the
expression yields FALSE
(numeric 0).
Alias: IS NEITHER
04-16006-04-en, March 2015 Technical
1641
51 Script Programming
51.13 Program Operators
Continued
Operator Example Definition
IS THRU number IS number THRU Designates a range starting
number with the number or
expression on the left-hand
side of THRU and ending
with the number or
expression on the right-hand
side. If the number at
beginning of the expression
is within the inclusive range,
the expression yields TRUE
(numeric 1). If the expression
is not in the inclusive range,
the expression yields FALSE
(numeric 0).
This statement is
operationally equivalent to IS
BETWEEN.
IS BETWEEN number IS BETWEEN Designates a range starting
number AND number with the number or
expression on the left-hand
side of AND and ending with
the number or expression on
the right-hand side. If the
number at the beginning of
the expression is within the
inclusive range, the
expression yields TRUE
(numeric 1). If the expression
is not in the inclusive range,
the expression yields FALSE
(numeric 0).
This statement is
operationally equivalent to IS
THRU.
51.13.6 Bit Operators
The following table identifies and defines the bit operators.
Technical 04-16006-04-en, March 2015
1642
51 Script Programming
51.13 Program Operators
Table: Bit Operators
Operator Example Definition
BITAND integer BITAND integer Compares the binary
equivalents of the two
integers, digit by digit, as if
the 1s were TRUE and the 0s
were FALSE.
If both binary numbers
contain a 1 in the same
place, that is TRUE AND
TRUE, which is TRUE If both
numbers contain a 0 in the
same place, that is FALSE
and FALSE, which is FALSE.
If one number contains a 1
and the other a 0 in the same
place, that is TRUE AND
FALSE, which is also FALSE.
Refer to the Truth Tables that
follow for further explanation.
BITOR integer BITOR integer Compares the binary
equivalents of the two
integers, digit by digit, as if
the 1s were TRUE and the 0s
FALSE.
If both binary numbers
contain a 1 in the same
place, that is TRUE OR
TRUE, which is TRUE. If both
numbers contain a 0 in the
same place, that is FALSE
OR FALSE, which is FALSE.
If one number contains a 1
and the other a 0 in the same
place, that is TRUE OR
FALSE, which is TRUE.
Refer to the Truth Tables that
follow for further explanation.
04-16006-04-en, March 2015 Technical
1643
51 Script Programming
51.13 Program Operators
Continued
Operator Example Definition
BITXOR integer BITXOR integer Compares the binary
equivalents of the two
integers, digit by digit, as if
the 1s were TRUE and the 0s
FALSE. BITXOR finds cases
where one digit or the other
is TRUE, but not cases
where both digits are TRUE.
If both binary numbers
contain a 1 in the same
place, that is TRUE XOR
TRUE, which is FALSE
because only one or the
other can be TRUE, not both.
If both numbers contain a 0
in the same place, that is
FALSE XOR FALSE, which is
FALSE. If one number
contains a 1 and the other a
0 in the same position, that is
TRUE XOR FALSE, which is
TRUE.
Refer to the Truth Tables that
follow for further explanation.
Truth Tables
The following table is the truth table for the bit operators:
Table: Truth Table
Operator Integer1 Integer2 Result
BITAND TRUE TRUE TRUE
BITAND TRUE FALSE FALSE
BITAND FALSE FALSE FALSE
BITAND FALSE TRUE FALSE
BITOR TRUE TRUE TRUE
BITOR TRUE FALSE TRUE
BITOR FALSE FALSE FALSE
BITOR FALSE TRUE TRUE
BITXOR TRUE TRUE FALSE
BITXOR TRUE FALSE TRUE
BITXOR FALSE FALSE FALSE
BITXOR FALSE TRUE TRUE
Technical 04-16006-04-en, March 2015
1644
51 Script Programming
51.13 Program Operators
Operator Integer1 Integer2 Result
51.13.7 AND/OR and String Joining Operators
The following table identifies and defines the AND, OR, and String Joining
Operators.
Operator Example Definition
AND number & number Compares two expressions,
which must be numeric or
converted to numeric, in a
comparison. The statement
returns TRUE (numeric 1) if
both expressions are
nonzero.
Alias: AND
OR number ! number Determines whether a
comparison is true by
making the comparison to
each expression (which must
be numeric or converted to
numeric) separately,
excluding the others. The
statement returns FALSE
(numeric 0) if both
expressions are false, TRUE
(numeric 1) if at least one is
true.
Alias: OR
String Joining string ; string Joins two strings by adding
the second one onto the end
of the first to form a new
string. Both expressions
must be string or convert to
type string (that includes
numeric and datetime types).
Also known as the
concatenation operator.
51.13.8 Operator Keywords
Operators carry out a mathematical process, such as addition, subtraction, or a
logical TRUE/FALSE comparison.
For more information, see section 51.14 “Operator Keywords” on page 1644.
04-16006-04-en, March 2015 Technical
1645
51 Script Programming
51.14 Operator Keywords
51.14 Operator Keywords
Operators carry out a mathematical process, such as addition, subtraction, or a
logical TRUE/FALSE comparison.
Script uses three different types of operator keywords: bitwise, logical, and
mathematical operators.
51.14.1 Bitwise Operators
Bitwise operators perform logical operations on the binary equivalents of integers.
Bitwise operators include the following keywords:
• BITAND
• BITNOT
• BITOR
• BITXOR
For more information, see section 51.15 “Bitwise Operators ” on page 1645...
51.14.2 Logical Operators
Logical operators carry out TRUE/FALSE comparisons.
Logical operators include the following keywords:
• AND
• EQUALS
• IS...
• NOT
• OR
For more information, see section 51.20 “Logical Operators ” on page 1650...
51.14.3 Mathematical Operators
Mathematical operators perform mathematical operations, such as addition or
subtraction.
Mathematical operators include the following keywords:
• DIVIDED BY
• MINUS
• MOD
• PLUS
• TIMES
For more information, see section 51.26 “Mathematical Operators” on page 1660...
Technical 04-16006-04-en, March 2015
1646
51 Script Programming
51.15 Bitwise Operators
51.15 Bitwise Operators
Bitwise operators perform logical operations on the binary equivalents of integers.
51.15.1 BITAND
BITAND logically compares the binary equivalents of the two integers, digit by digit.
This operator creates a new binary number that contains a 1 for each digit position,
where the first number's bit and the second number's bit are both 1, and sets all
other digits to zero. The new binary number is then converted to its decimal
equivalent.
For more information, see section 51.16 “BITAND” on page 1646..
51.15.2 BITNOT
BITNOT switches 1s to 0s and 0s to 1s in the binary equivalent of the integer, digit
by digit. (This is called the one’s complement of the binary number.) This operator
creates a new binary number and then converts that number back to its decimal
equivalent.
For more information, see section 51.17 “BITNOT” on page 1647..
51.15.3 BITOR
BITOR logically compares the binary equivalents of the two integers, digit by digit.
For more information, see section 51.18 “BITOR” on page 1648..
51.15.4 BITXOR
BITXOR logically compares the binary equivalents of the two integers, digit by digit.
For more information, see section 51.19 “BITXOR” on page 1649..
04-16006-04-en, March 2015 Technical
1647
51 Script Programming
51.16 BITAND
51.16 BITAND
BITAND logically compares the binary equivalents of the two integers, digit by digit.
This operator creates a new binary number that contains a 1 for each digit position,
where the first number's bit and the second number's bit are both 1, and sets all
other digits to zero. The new binary number is then converted to its decimal
equivalent.
BITAND carries out comparisons of checksums and similar operations.
Syntax
integer bitand integer
Table: BITAND Parameter
Parameter Description
integer Any number from 0 to 65535.
If you provide a number with a decimal point,
BITAND uses only the integer and drops
everything to the right of the decimal point.
Example
Suppose you want to compare Total1 and Total2:
Total1 = 13 (binary equivalent is 0000000000001101)
Total2 = 11 (binary equivalent is 0000000000001011)
You would compare them with BITAND as follows:
Program File
Set result = Total1 bitand Total2
The comparison would give 0000000000001001. RESULT would be set to 9.
Technical 04-16006-04-en, March 2015
1648
51 Script Programming
51.17 BITNOT
51.17 BITNOT
BITNOT switches 1s to 0s and 0s to 1s in the binary equivalent of the integer, digit
by digit. (This is called the one’s complement of the binary number.) This operator
creates a new binary number and then converts that number back to its decimal
equivalent.
BITNOT carries out bitmasking and similar operations.
Syntax
bitnot integer
Table: BITNOT Parameter
Parameter Description
integer Any number from 0 to 65535.
If you provide a number with a decimal point,
BITNOT uses only the integer and drops
everything to the right of the decimal point.
Example
Suppose you want to find the one’s complement of AMOUNT:
Amount = 13 (binary equivalent is 0000000000001101)
You could reverse the number with BITNOT as follows:
Program File
Set result = bitnot AMOUNT
The BITNOT of the amount would be 1111111111110010. The statement would
set RESULT to 65522.
04-16006-04-en, March 2015 Technical
1649
51 Script Programming
51.18 BITOR
51.18 BITOR
BITOR logically compares the binary equivalents of the two integers, digit by digit.
This operator creates a new binary number that contains a 1 for each digit position
where the first number's bit or the second number's bit is 1 and where both the first
and second number's bits are 1. The operator also sets all other digits to zero.
BITOR converts the new binary number to its decimal equivalent.
BITOR carries out comparisons of checksums and similar operations.
Syntax
integer bitor integer
Table: BITOR Parameter
Parameter Description
integer Any number from 0 to 65535.
If you provide a number with a decimal point,
BITOR uses only the integer and drops
everything to the right of the decimal point.
Example
Suppose you want to compare Total1 and Total2:
Total1 = 13 (binary equivalent is 0000000000001101)
Total2 = 11 (binary equivalent is 0000000000001011)
You would compare them with BITOR as follows:
Program File
Set result = Total1 bitor Total2
The comparison would give 0000000000001111. RESULT would be set to 15.
Technical 04-16006-04-en, March 2015
1650
51 Script Programming
51.19 BITXOR
51.19 BITXOR
BITXOR logically compares the binary equivalents of the two integers, digit by digit.
This operator creates a new binary number that contains a 1 for each digit position,
where either the first number's bit or the second number's bit is 1, but gives zeros
where both are 1 or both are 0. BITXOR converts the new binary number to its
decimal equivalent.
BITXOR carries out comparisons of checksums and similar operations.
Syntax
integer bitxor integer
Table: BITXOR Parameter
Parameter Description
integer Any number from 0 to 65535.
If you provide a number with a decimal point,
BITXOR uses only the integer and drops
everything to the right of the decimal point.
Example
Suppose you want to compare Total1 and Total2:
Total1 = 13 (binary equivalent is 0000000000001101)
Total2 = 11 (binary equivalent is 0000000000001011)
Program File
Set result = Total1 bitxor Total2
The comparison would give 0000000000000110. RESULT would be set to 6.
04-16006-04-en, March 2015 Technical
1651
51 Script Programming
51.20 Logical Operators
51.20 Logical Operators
Logical operators carry out TRUE/FALSE comparisons.
51.20.1 AND
The AND keyword can be used in two ways.
For more information, see section 51.21 “AND” on page 1651..
51.20.2 EQUALS
EQUALS is similar to the IS... operator.
For more information, see section 51.23 “IS...” on page 1654.
51.20.3 IS...
IS... carries out the logical test you specify.
For more information, see section 51.23 “IS...” on page 1654.
51.20.4 NOT
NOT logically negates or inverts a number or expression, changing 0 (FALSE to
OFF) to 1 (TRUE or ON) or vice versa.
For more information, see section 51.24 “NOT” on page 1657..
51.20.5 OR
The OR keyword can be used to provide the logical OR between two expressions,
or positioned in a list of names beween the last two items.
For more information, see section 51.25 “OR” on page 1658..
Technical 04-16006-04-en, March 2015
1652
51 Script Programming
51.21 AND
51.21 AND
Alias: Ampersand (&) is the alias for the logical AND only.
The AND keyword can be used in two ways.
See Syntax for more details.
The controller carries out all other operations (such as adding and subtracting)
before acting on AND or OR. Because AND and OR are acted on last, you can form
logical statements without using too many parentheses. (See Example 3 for using
AND and OR together.)
Syntax
Syntax 1: number and number
Provides the logical AND between two expressions.
Syntax 2: namelist and final_name
When used in a list of names between the last two items, indicates the end of the
series.
Table: AND Parameters
Parameter Description
number Any number or expression.
namelist One or more names with commas between
them.
final_name A single name at the end of a series of
names.
AND before the last name is optional.
Examples
Example 1
Instead of forming IF..THEN statements to turn the heat on when multiple
conditions exist, you can make one statement using AND:
Program File
If Temp < 70 and TOD > 7:00am then turn On the Heat
or
If Temp < 70 & TOD > 7:00am then turn On the Heat
Example 2
To run a series of programs, instead of using RUN several times, you can list the
program names on the same line, using AND (final comma optional) to indicate the
last item in the list:
Program File
Run the Cooling, Heating and Fan
or using the final comma:
Run the Cooling, Heating, and Fan
04-16006-04-en, March 2015 Technical
1653
51 Script Programming
51.21 AND
You cannot use the ampersand (&) for AND in a series. You can, however, leave out
AND as follows:
Run the Cooling, Heating, Fan
Example 3
If OR occurs before AND, the controller interprets OR first because the controller
works from left to right on AND and OR. For example, take this statement:
Program File
If Wkd = Sat or Wkd = Sun and TOD > 9:00 then...
The above statement is interpreted so that the items in parentheses below are
calculated first:
If (Wkd = Sat or Wkd = Sun) and TOD > 9:00 then...
If AND occurs before OR, the controller interprets AND first:
Program File
If TOD > 9:00 and Wkd = Sat or Wkd = Sun then...
is interpreted as:
If (TOD > 9:00 and Wkd = Sat) or Wkd = Sun then...
Example 4
AND is also used with the operator BETWEEN, as in the following example:
Program File
If TOD is between 8:00am and 6:00pm then...
You cannot use the ampersand (&) for AND when AND is used with BETWEEN.
Note
• Use parentheses to enforce the order of interpretations and resolve potential
ambiguities.
Technical 04-16006-04-en, March 2015
1654
51 Script Programming
51.22 EQUALS
51.22 EQUALS
EQUALS is similar to the IS... operator.
For more information, see section 51.23 “IS...” on page 1654..
04-16006-04-en, March 2015 Technical
1655
51 Script Programming
51.23 IS...
51.23 IS...
IS... carries out the logical test you specify.
Syntax
Greater-than-expression:
number > number
number is greater than number
number is above number
Greater-than-or-equal-to-expression:
number >= number
number is greater than or equal to number
Less-than-expression:
number < number
number is less than number
number is below number
Less-than-or-equal-to-expression:
number <= number
number is less than or equal to number
Equal-expression:
number = number
number is number
number is equal to number
number equals number
Not-equal-expression:
number <> number
number is not number
number is not equal to number
number does not equal number
List-inclusion-expression:
number is in list
number is range (see range-expression below)
number is EITHER list
List-exclusion-expression:
number is not in list
number is not range (see range-element below)
number is neither list
Range-expression:
number is between lower_number AND higher_number
Technical 04-16006-04-en, March 2015
1656
51 Script Programming
51.23 IS...
number is not between lower_number AND higher_number
number is lower_number THRU higher_number
number is not lower_number THRU higher_number
Table: IS...Parameters
Parameter Description
number Any number or expression, including a date
and time or name that stands for one.
list Two or more numbers (as defined above)
with commas between them.
range Two numbers (as defined above), each
marking one end of a range with THRU
between them, or two numbers preceded by
BETWEEN with AND between them.
Examples
Example 1
To compare two values, you usually place an IS... statement between IF and THEN
in an IF..THEN statement.
Note
• Because THAN is optional, in the following pairs of statements, each
statement gives the same instructions to the controller.
Program File
If Zone_Temp is greater than 70 then…
If Zone_Temp is greater 70 then…
If Zone_Temp is above 70 then…
If Zone_Temp is less than 70 then…
If Zone_Temp is less 70 then…
If Zone_Temp is below 70 then…
Example 2
The following statements are grouped together and give the same instructions to
the controller, because TO is optional and EQUALS can be used without IS:
Program File
If Zone_Temp is equal to 70 then…
If Zone_Temp is equal 70 then…
If Zone_Temp equals 70 then…
If Zone_Temp is not equal to 70 then…
IF Zone_Temp does not equal 70 then…
Example 3
04-16006-04-en, March 2015 Technical
1657
51 Script Programming
51.23 IS...
With IS IN, IS EITHER, IS NOT IN, or IS NEITHER, the comma in the list means OR.
You can also use the word OR before the last item in the list, for example:
Program File
If Zone_Temp is in Occupied, Warmup then…
If Zone_Temp is either Occupied, Warmup, OR Reset then…
If Zone_Temp is not in Occupied, Warmup then...
If Zone_Temp is neither Occupied, Warmup then...
If Zone_Temp is not 8 through 81 then...
Example 4
With IS BETWEEN and IS NOT BETWEEN, you always use AND. IS BETWEEN with
AND is equivalent to IS with THRU. The following statements are equivalent:
Program File
If Zone_Temp is between 70 and 80 then…
If Zone_Temp is 70 thru 80 then…
With THRU or BETWEEN, do not put parentheses around the two elements being
compared. The following parenthesis are not allowed:
If Zone_Temp is (70 thru 80) then…
If Zone_Temp is between (70 thru 80) then…
Program File
If Zone_Temp is not between 70 and 80 then…
If Zone_Temp is not 70 thru 80 then…
If Zone_Temp is not (ROOMTMP-5) thru (ROOMTMP+5)
If Zone_Temp is not ROOMTMP-5 thru ROOMTMP+5
With THRU or BETWEEN, always put the lower number first. The following
examples are not allowed:
If Zone_Temp is 80 thru 70 then…
If Zone_Temp is between 80 and 70 then…
Note
• Both THRU and BETWEEN are always inclusive, so the following are both
TRUE if the ZONE_TEMP is equal to 70 or 80.
If Zone_Temp is 70 thru 80 then…
If Zone_Temp is between 70 AND 80 then…
Technical 04-16006-04-en, March 2015
1658
51 Script Programming
51.24 NOT
51.24 NOT
NOT logically negates or inverts a number or expression, changing 0 (FALSE to
OFF) to 1 (TRUE or ON) or vice versa.
Syntax
not number
Table: NOT Parameter
Parameter Description
number Any number or expression.
Example
Program File
If not OCCUPIED then..
In this example, assume OCCUPIED can be ON or OFF. When OCCUPIED is ON,
placing NOT in front tests for the opposite condition, OFF.
04-16006-04-en, March 2015 Technical
1659
51 Script Programming
51.25 OR
51.25 OR
The OR keyword can be used to provide the logical OR between two expressions,
or positioned in a list of names beween the last two items.
In this second example, OR indicates the end of the series. OR with the last name is
optional. The system carries out all other operations (such as adding and
subtracting) before acting on OR (or AND).
Operators by Precedence compares the order of operations on which the system
software acts. Because OR (and AND) are acted on last, you can form logical
statements without using too many parentheses. See Example 4 for how to use
AND and OR together.
Syntax
number or number
namelist or final_name
Table: OR Parameters
Parameter Description
number Any number, name that stands for a number,
formula or function that gives a number.
namelist One or more names with commas between
them.
final_name A single name at the end of a series of
names.
Examples
Example 1
To take an action only if at least one of several conditions exists, you use OR
between the numbers, so if one of them is true, the resulting action occurs:
Program File
If the Heat is On or the Cool is On then...
Note that in the above statement, you can substitute exclamation mark (!) for OR.
Example 2
To put a list in an IF statement, you can use an OR between the last two names in
the list:
Program File
You cannot use the exclamation mark (!) for OR in a series. You can, however, leave
out OR as follows:
If the Zone is Warming, Occupied, Lowtemp then...
Example 3
You can also combine the logical OR with a name list containing an OR (with or
without the comma before OR) as follows:
Program File
Technical 04-16006-04-en, March 2015
1660
51 Script Programming
51.25 OR
If the Zone is either Warm, Occupied, or Low or Heat is Off then...
The controller always interprets the first OR as the list OR and the second as the
logical OR. If you want to reverse the order of the statement, use parentheses, as
follows:
Program File
If (Heat is Off) or Zone is either Warming, Occupied or Low
then...
Example 4
If OR occurs before AND, the system software interprets OR first because the
software works from left to right on AND and OR. For example, take this statement:
Program File
If WKD = Sat or Wkd = Sun and TOD > 900 then...
The above statement is interpreted so that the items in parentheses below are
calculated first:
If (Wkd = Sat or Wkd = Sun) and TOD > 900 then...
If AND occurs before OR, the controller interprets AND first:
Program File
If TOD > 900 and Wkd = Sat or Wkd = Sun then...
is interpreted as:
If (TOD > 900 and Wkd = Sat) or Wkd = Sun then...
04-16006-04-en, March 2015 Technical
1661
51 Script Programming
51.26 Mathematical Operators
51.26 Mathematical Operators
Mathematical operators perform mathematical operations, such as addition or
subtraction.
Mathematical operators include the following keywords.
51.26.1 DIVIDED BY
DIVIDED BY divides one number by another. The division operator (/) can be
substituted for DIVIDED BY.
For more information, see section 51.27 “DIVIDED BY” on page 1661..
51.26.2 MINUS
MINUS subtracts number from number.
For more information, see section 51.28 “MINUS” on page 1662..
51.26.3 MOD
MOD returns the remainder of one number divided by another.
For more information, see section 51.29 “MOD” on page 1663..
51.26.4 PLUS
PLUS adds two expressions.
For more information, see section 51.30 “PLUS” on page 1664..
51.26.5 TIMES
TIMES multiplies two numbers.
For more information, see section 51.31 “TIMES” on page 1665..
Technical 04-16006-04-en, March 2015
1662
51 Script Programming
51.27 DIVIDED BY
51.27 DIVIDED BY
Aliases: /, DIV
DIVIDED BY divides one number by another. The division operator (/) can be
substituted for DIVIDED BY.
Syntax
number divided by number
Table: DIVIDED BY Parameters
Parameter Description
number Any number or expression.
Examples
Example 1
Program File
Usage = kwh divided by 24
Example 2
Program File
Usage = kwh/24
04-16006-04-en, March 2015 Technical
1663
51 Script Programming
51.28 MINUS
51.28 MINUS
Alias: -
MINUS subtracts number from number.
Syntax
number minus number
Table: MINUS Parameters
Parameter Description
number Any number or expression.
list Two or more numbers (as defined above)
with commas between them.
range Two numbers (as defined above), each
marking one end of a range with THRU
between them, or two numbers preceded by
BETWEEN with AND between them.
Examples
Example 1
Program File
Kwh_day = Kwh_PM minus Kwh_AM
Example 2
Program File
Kwh_day = Kwh_PM - Kwh_AM
Technical 04-16006-04-en, March 2015
1664
51 Script Programming
51.29 MOD
51.29 MOD
Alias: REMAINDER
MOD returns the remainder of one number divided by another.
Syntax
number mod number
Table: MOD Parameter
Parameter Description
number Any number or expression.
Example
Program File
Extra = 5 mod 2
The equation divides 5 by 2 and gives a remainder of 1, so EXTRA is set to 1.
04-16006-04-en, March 2015 Technical
1665
51 Script Programming
51.30 PLUS
51.30 PLUS
Alias : +
PLUS adds two expressions.
Syntax
number plus number
Table: PLUS Parameter
Parameter Description
number Any number or expression.
Example
Example 1
Program File
TotalKwh = KwhMonth plus KwhDay
Example 2
Program File
TotalKwh = KwhMonth + KwhDay
Technical 04-16006-04-en, March 2015
1666
51 Script Programming
51.31 TIMES
51.31 TIMES
Aliases: MULTIPLIED BY, MULT, *
TIMES multiplies two numbers.
Syntax
number times number
Table: TIMES Parameter
Parameter Description
number Any number or expression.
Example
Example 1
Program File
Energycost = Building1_KW times 1.78
Example 2
Program File
Energycost = Building1_KW * 1.78
04-16006-04-en, March 2015 Technical
1667
51 Script Programming
51.32 Program Statements
51.32 Program Statements
Program statements are written with Script words, known as keywords, that are
arranged in a predefined structure. Each keyword has its own keyword syntax.
According to the rules of that syntax, certain parameters and values are allowed or
not allowed to follow a keyword.
51.32.1 Statement Keywords
Statements define the actions that controllers perform (such as START), or assist in
the structure of a statement (such as THE).
For more information, see section 51.33 “Statement Keywords” on page 1667.
Technical 04-16006-04-en, March 2015
1668
51 Script Programming
51.33 Statement Keywords
51.33 Statement Keywords
Statements define the actions that controllers perform (such as START), or assist in
the structure of a statement (such as THE).
Script uses three different types of statement keywords: action, declaration, and
program control statements.
51.33.1 Action Statements
Action statements define the actions that controllers perform (such as SET).
Action statements include the following keywords:
• P
• SET
• TURN
For more information, see section 51.34 “Action Statements ” on page 1669.
51.33.2 Declaration Statements
Declaration statements assist in defining program variables.
Declaration statements include the following keywords:
• ARG
• DATETIME
• LINE
• NUMERIC
• STRING
• THE
For more information, see section 51.39 “Declaration Statements ” on page 1680.
51.33.3 Program Control Statements
Program Control statements assist in directing program flow.
Program Control statements include the following keywords:
• BASED ON...GOTO
• BREAK
• CONTINUE
• FOR..NEXT
• GOTO
• IF...THEN...ELSE
04-16006-04-en, March 2015 Technical
1669
51 Script Programming
51.33 Statement Keywords
• MOVE
• REPEAT...UNTIL
• RETURN
• SELECT CASE
• STOP
• STOP
• WAIT
• WHILE
For more information, see section 51.47 “Program Control Statements ” on page
1695.
51.33.4 Qualifier Statements
Qualifier statements assist in defining input, output, and public variables.
Qualifier statements include the following keywords:
• INPUT
• OUTPUT
• PUBLIC
For more information, see section 51.61 “Qualifier Statements” on page 1720.
Technical 04-16006-04-en, March 2015
1670
51 Script Programming
51.34 Action Statements
51.34 Action Statements
Action statements define the actions that controllers perform (such as SET).
51.34.1 P
P prints the values of one or more variables, points, constants, or other expressions
representing a value, including strings of characters and datetimes, each on a
separate line.
For more information, see section 51.35 “P” on page 1670..
51.34.2 PRINT
PRINT prints a series of characters (text strings, often simply called strings) to a
string object or attribute, a local variable, a printer, or a communications port.
For more information, see section 51.36 “PRINT” on page 1671..
51.34.3 SET
SET assigns a value to a point or variable.
For more information, see section 51.37 “SET” on page 1677..
51.34.4 TURN
TURN sets the name or names to the top of the defined range for the point if ON
and to the bottom of the range if OFF.
For more information, see section 51.38 “TURN” on page 1679..
04-16006-04-en, March 2015 Technical
1671
51 Script Programming
51.35 P
51.35 P
Alias: PR
P prints the values of one or more variables, points, constants, or other expressions
representing a value, including strings of characters and datetimes, each on a
separate line.
The list can contain different types of items. Prints units with point values.
For points, system variables, and attributes, prints the name of the point (or variable
or attribute), followed by an equal sign, the value of the point, and the units.
Otherwise, only the value prints.
Also, can print to comm ports and string objects (including program string
variables).
Syntax
P list
Table: P Parameter
Parameter Description
list One or more expressions with commas
between them. The list can also include
functions or attributes.
Examples
Example 1
Command Line
P SupplyAir, ReturnAir, BurnerStat, CoilStatus
SupplyAir = 46 degrees F
ReturnAir = 68 degrees F
BurnerStat = on
CoilStatus = off
Notice that the name of the point and the units print for each point.
Example 2
Command Line
P OutsideAir, Avg (Temp), AvgSetpt, OutsideAir_Type, TOD
OutsideAir_Type = 46 degrees F
86
AvgSetpt = 64
OutsideAir Type = Input
TIMEOFDAY = 8:32 pm
Technical 04-16006-04-en, March 2015
1672
51 Script Programming
51.36 PRINT
51.36 PRINT
PRINT prints a series of characters (text strings, often simply called strings) to a
string object or attribute, a local variable, a printer, or a communications port.
You can also print to a string point or local variable to fill that point or variable with a
string of text or numbers. In addition, on WorkStation, you can print to an ASCII file.
Syntax
Format 1: any_of_formats_above to string_point_or_variable
Prints any value or string, including messages, points, or variables, into a string
point or variable to set the value of that string.
Format 2: Print string
Prints a string value of text to the default comm port of the program or report.
Format 3: Print list
Prints the values of one or more variables, points, constants, or other expressions
representing a value. The list can contain different types of items.
Format 4: Print string_format, list
Prints the variables, points, or other expressions in the list in the format you specify.
Table: PRINT Parameters
Parameter Description
string A series of characters in quotation marks.
string_format A known character or string of characters
combined with changeable characters to
form one print line.
list A known character or string of characters
combined with changeable characters to
form one print line.
; (Optional) If you end a PRINT statement
without the semicolon, the next line you print
starts on a new line. If you want to print two
strings one after the other on the same line,
you must end the first with a semicolon.
string_point_or_variable Any defined string point or string variable.
Formatting Characters
You can indicate the layout of the print line using the following special symbols:
04-16006-04-en, March 2015 Technical
1673
51 Script Programming
51.36 PRINT
Table: Special PRINT Line Symbols
Character Description
| Indicates the beginning of a series of
characters that are strictly for formatting and
not to be treated as text. When followed by a
numeric constant, indicates an ASCII code
follows.
|" (A vertical bar immediately before a
quotation mark.) Indicates to print the
quotation mark, rather than interpreting that
mark as the beginning or end of the string.
| numeric_constant Produces the ASCII code that corresponds
to the numeric constant. For example, |7
would produce a bell or beep if printed on a
terminal. |13 is the carriage return character.
See the ASCII Codes for more codes.
# Represents one character that is numeric.
The series of characters prints right-justified,
filling with blanks any blank characters to the
left.
$### Displays either ON, -ON, or OFF (as with
tristate Output point).
% Multiplies the point value by 100 and places
a percent sign after that point value (most
useful with scale of 0 to 1, where 1 is 100%).
* Prints the next argument result.
- Prints a leading or trailing minus sign, if
expression is a negative number; prints a
leading or trailing plus sign if expression is a
positive number.
} Removes trailing zeroes (extra decimal
spaces)
, Prints commas every third digit left of the
decimal point.
> Right justifies the number or text within the
format.
< Left justifies the number or text within the
format.
^ Displays a numeric expression in scientific
notation.
@ Represents one character of any kind,
alphabetic or numeric. A series of characters
prints left justified, filling with blanks any
blank characters to the right.
Technical 04-16006-04-en, March 2015
1674
51 Script Programming
51.36 PRINT
Character Description
The format must be enclosed in quotation marks. The comma is required after the
format (outside the quotation marks) if an item to insert in the format follows (see
Example 3).
Examples
Table: PRINT Program File and Output Columns
No. Program File Output Explanation
1 Print - Prints the value
"HEAT_SETPT" into the string
to PointName and changes its
setting. You can
set a string point
or variable this
way.
2 Print "WARNING - WARNING-Trouble The string of
Trouble on the on the 4th Floor! characters prints; the
4th Floor!" quotation marks do
not.
3 Print TEMP1, 67 72 77 75 The value of each
TEMP2, TEMP3, variable in the list
TEMP4 prints, with a space
after the value.
4 Print "The The Temperature is The string prints with
temperature is 75.0 at 4:32:05 a value of the first
|###.# at point (or variable) in
|##:##:##", the first format and
~Temp4, Hour, the value of the next
Minute, Second point or variable in
the next format. If
there are more than
two formats, the
subsequent point or
variable values are
printed in the
corresponding
formats in order.
5 Print 1340 Leaves 3 leading
"|#######", spaces before the
Total_Watts value of Total Watts.
The value prints on
the terminal called
TERMINAL.
6 Print WeekDay; Tuesday January 2 Prints all text and
spaces on the same
Print " "; line because each
Print Month; PRINT statement
ends with a
Print " "; semicolon (;).
Print DayOfMonth
04-16006-04-en, March 2015 Technical
1675
51 Script Programming
51.36 PRINT
Continued
No. Program File Output Explanation
7 Print 1,340.00 Leaves one leading
"|##,###.##", space. Adds the
Total_Watts comma after the 1
and has two zeros
after the decimal.
8 Print 1,340 Drops extra decimal
"#,###.##}", places (trailing zeros).
Total_Watts
9 Print "The Fan The Fan Status is ON Prints ON, -ON, or
Status is OFF for a digital or
|$###", tristate point, left-
FanStatus justifying ON in the
format.
10 Print "The The Damper Setting Prints the pulsing
Damper Setting is 20.00 value of the damper
is |##.##", in the format. Here
Damper the damper is ON for
20 seconds. for -ON,
the value is negative.
11 Print "| *", Murphy Johnson Outputs any number
Murphy FullName of characters of any
type that are in the
FullName attribute.
The * is particularly
useful when you do
not want to limit the
number of character
in a variable.
12 Print Heater Failed! The message inside
"|@@@@@@@@@@@@@ STRMSG prints left
@", justified in the 14
characters allowed
~ STRMSG to by the @ signs.
Building1
Console
13 Print 21.7 Right justifies and
"|>#######.##}" drops the trailing 0.
, 21.70
14 Print "|-##>##", +88.8 Prints leading minus
88.8 sign if the number is
negative and the
leading plus sign if
the number is
positive. Prints all
trailing zeros.
Technical 04-16006-04-en, March 2015
1676
51 Script Programming
51.36 PRINT
Continued
No. Program File Output Explanation
15 Print "|##.##-", 88.80- Prints trailing minus
-88.80 sign if the number is
negative and the
trailing plus sign if the
number is positive.
Prints all trailing
zeros.
16 Print "|###^## 8,97e03+05 is the Prints the number is
is the "Total." scientific notation.
|"TOTAL.|"", Also prints the
97000 quotation marks
around VALUE,
because a vertical
bar is before each
quotation mark that
should print.
17 Print 8,97e-01 Prints in scientific
"|###^##"", notation with
.8970 negative exponent.
18 Print "|- +1.340e+06 Prints in scientific
##.##^##"", notation with a
1340000 leading plus sign for
a positive number.
19 Print "The The blower's current Prints the text string
blower's current state is ENABLED. left justified in the
state is format and leaves a
|@@@@@@@@.",~ blank for the
Blower State unfulfilled character
at the end.
20 Print "The valve The Valve is set to Prints the value in
is set to |%### 45% open. engineering units as
open.",~Water_V a percentage of the
alue scale for the point.
This format works
best with a scale of 0
to 1, where 0 is fully
closed and 1 is fully
open. So, if the value
is 1, the statement
prints 100%. If the
value is .45, the
statement prints
45%.
04-16006-04-en, March 2015 Technical
1677
51 Script Programming
51.36 PRINT
Continued
No. Program File Output Explanation
21 Print "Date:", Date: December 4, Prints the date.
Month, 2008 Commas must
",~DayOfMonth, separate each group
Test Report of literal text. Notice
",",Year
that the only place a
Print " " space displays is
Print "Test immediately after the
Report" word Date. You must
specify the blank
space in quotation
marks.
Also prints a blank
line between the date
and the report title. If
you use the word
PRINT, followed by
one blank in
quotation marks,
then the entire line
prints as a blank line
(as long as you do
not put a semicolon
at the end).
Technical 04-16006-04-en, March 2015
1678
51 Script Programming
51.37 SET
51.37 SET
Alias: ADJUST and CHANGE (Format 1 only), LET (Format 2 only), MODIFY
SET assigns a value to a point or variable.
Syntax
Syntax 1: Set namelist to number
Syntax 2: Set namelist = number
Table: SET Parameters
Parameter Description
namelist Any defined name or list of names. The
name or names can be any of the following
types:
• Point (any type).
• Local variable, either numeric, string, or
datetime.
The type of name must match the type of
number.
number Any number or expression, including a string
or date and time, or a name that stands for
either of those.
A numeric name can accept only the results
of a numeric expression. A string name can
accept only text. A datetime name can
accept only a date and time.
Examples
Example 1
At any time in a program, you can set the value of a variable or array of variables
using SET and the word TO:
Program File
Set area to height times width
You can also use ADJUST, CHANGE, or MODIFY with TO. With ADJUST and
CHANGE, the TO is required:
Program File
Adjust Valve to Open
Program File
Change Space_SP to 72
Program File
Modify Space_SP to 72
You cannot use the equal sign with ADJUST or CHANGE, but you can use the
equal sign with MODIFY.
Example 2
04-16006-04-en, March 2015 Technical
1679
51 Script Programming
51.37 SET
You can set a variable using SET and an equals sign as in the example below:
Program File
Set KwAbg = Average (KW)
Instead of SET, you can use LET with the equals sign, as follows:
Program File
Let KwAvg = Average (KW)
You cannot use the word TO with LET.
Neither the word SET nor the word LET is required with the equals sign, so you can
set the same variable like this:
Program File
KwAvg = Average (KW)
Example 3
You can set a string variable or point to a particular value:
Program File
Set Stat_Message to "Heat active"
Example 4
You can set several points and variables to a particular value:
Program File
Set KwAvg, OATAvg, HWAvg, CHWAvg = 0
Technical 04-16006-04-en, March 2015
1680
51 Script Programming
51.38 TURN
51.38 TURN
TURN sets the name or names to the top of the defined range for the point if ON
and to the bottom of the range if OFF.
Syntax
Format 1: Turn On point_list
TURN OFF point_list
Format 2: Turn point_list On
TURN point_list OFF
Table: TURN Parameter
Parameter Description
point_list One or more defined output or numeric
points; the statement is not designed for
other types of points.
Examples
Example 1
Suppose you want to turn on the fan and the pump. You can turn both on in one
program statement:
Program File
Turn on the Fan and the Pump
Example 2
You can place the word ON or OFF after the name of the point:
Program File
Turn the Pump off
Example 3
You can also place ON or OFF before the name of the point:
Program File
Turn off the Pump
04-16006-04-en, March 2015 Technical
1681
51 Script Programming
51.39 Declaration Statements
51.39 Declaration Statements
Declaration statements assist in defining program variables.
51.39.1 ARG
ARG is a keyword that defines an argument and can be given a name. After you
assign an easy-to-remember name to an argument variable, you can then refer to
that variable by its name so your function is easier to understand.
For more information, see section 51.40 “ARG” on page 1682..
51.39.2 DATETIME
DATETIME creates and defines one or more names as local DATETIME variables.
You define the variables inside a program for use only in that particular program.
For more information, see section 51.41 “DATETIME” on page 1683..
51.39.3 LINE
LINE labels a particular line in the program so that program control can later branch
or move to that line with the GOTO (or more advanced BASED ON..GOTO)
statement.
For more information, see section 51.42 “LINE” on page 1685..
51.39.4 NUMERIC
NUMERIC creates and defines one or more names as local numeric variables. You
define the variables inside a program for use only in that particular program.
For more information, see section 51.43 “NUMERIC” on page 1689..
51.39.5 STRING
STRING creates and defines one or more names as local string variables. You
define the variables inside a program for use only in that particular program. You
can specify the length of the string of characters with the string_length.
For more information, see section 51.44 “STRING” on page 1691..
51.39.6 THE
THE performs no function, but enhances readability.
For more information, see section 51.45 “THE” on page 1693..
Technical 04-16006-04-en, March 2015
1682
51 Script Programming
51.39 Declaration Statements
51.39.7 Webservice
Webservice delares a Web Service in a Script program.
For more information, see section 51.46 “ Webservice” on page 1694.
04-16006-04-en, March 2015 Technical
1683
51 Script Programming
51.40 ARG
51.40 ARG
Alias: PARAM
ARG is a keyword that defines an argument and can be given a name. After you
assign an easy-to-remember name to an argument variable, you can then refer to
that variable by its name so your function is easier to understand.
ARG can only be used to declare that variable in a function (Syntax 1). ARG calls the
argument variable by the variable’s number (Syntax 2).
Syntax
Syntax 1: ARG integer_constant name
Syntax 2: ARG [ integer_expression ]
Table: ARG Parameters
Parameter Description
integer_constant Any integer between 1 and 15.
name Any name you choose for the argument
including underscore and period, but must
begin with a letter. Not a keyword.
integer_expression Any integer or expression that gives an
integer.
Examples
Example 1
In this example, ARG[5] represents the status of a report. To make that easier to
understand, ARG[5] is named RPTSTATUS. The program refers to RPTSTATUS for
the variable value from then on.
Function File
ARG 5 RptStatus
Example 2
To test to see if the report status equals SUCCESS, you can call on the argument
variable using the easy-to-remember name (from Example 1):
Function File
If RptStatus is Success then…
Example 3
To test to see if the report status equals SUCCESS, you can also call on the
argument variable using ARG[5]:
Function File
If ARG[5] is Success then…
Technical 04-16006-04-en, March 2015
1684
51 Script Programming
51.41 DATETIME
51.41 DATETIME
DATETIME creates and defines one or more names as local DATETIME variables.
You define the variables inside a program for use only in that particular program.
You define the variables as follows:
• Specify an array by including the array_size_number during the array definition
since each variable can be a single variable or an array.
• Add seconds as if the datetime were a number because the datetime is stored
in seconds.
• Define all local datetime variables at the top of your program.
• Set the datetime variable to the time at a given moment using the DATE system
variable.
• Print the datetime variable. When you do, you receive the date and time printed
in this format:
MONTH DD YYYY hh:mm:ss
The month is spelled out; the day is two digits, the year is four digits. The hour,
minute, and second are in 24-hour time.
Binding Qualifiers
Variables can also be bound to the object property of a point outside of the
program. To do this, you must use a keyword, either Input or Output.
Syntax
Datetime Binding_qualifier namelist [ array_size_number ]
Table: DATETIME Parameters
Parameter Description
namelist The name of a datetime variable you are
defining or a series of datetime variables
separated by commas.
array_size_number A number up to 32,767 that tells the
controller how many positions are in the
array.
Binding_qualifier The keyword Input or Output, which you can
bind to a point.
Examples
Example 1
In this program, the first statement defines the TEMPTIME as a datetime variable.
The next statement sets the variable to the time at a given moment with the DATE
system variable:
Program File
Datetime TempTime
TempTime = date
Example 2
04-16006-04-en, March 2015 Technical
1685
51 Script Programming
51.41 DATETIME
You can define a series of datetime variables in a single statement:
Program File
Datetime TempTime, FirstTime, LastTime
Example 3
You can define more than one array of datetime variables in a single statement:
Program File
Datetime TempTime[40], Timer[30], Watch[15]
Example 4
You can define several arrays of datetime variables and several single variables in a
single statement:
Program File
Datetime TempTime[40], FirstTime, Timer[30], LastTime
Technical 04-16006-04-en, March 2015
1686
51 Script Programming
51.42 LINE
51.42 LINE
LINE labels a particular line in the program so that program control can later branch
or move to that line with the GOTO (or more advanced BASED ON..GOTO)
statement.
Caution
• Line names 0, C, and E are reserved for use by WorkStation. LINE 0 is
predefined for stopping the program, so you cannot label a line LINE 0.
However, you can use GOTO line 0 to stop a program. You can label a line
LINE E and the program automatically goes to that line when an error occurs.
LINE C is reserved for future use.
You can label lines to redirect program flow to any part of the program. For
example, you could return program flow to an earlier line, such as the first line. Or
you could send program flow to a later line to branch into a specific set of actions.
Syntax
Line linename
linename:
Line integer
Integer:
Table: LINE Parameters
Parameter Description
linename Any single character or word that is not a
keyword, except:
• C (reserved)
• E (used for error detection)
You must begin the name with an alphabetic
character. In the GOTO statement, the label
must be spelled exactly as is in the LINE
statement; however, you can interchange
upper- and lowercase.
integer Any single whole number, except 0.
LINE 0 is predefined for stopping the
program, so you cannot label a line LINE 0.
However, you can use the GOTO line 0 to
stop a program.
Format 2 The linename followed by a colon (:) on its
own line.
Format 4 The integer followed by a colon (:) on its own
line. In this case, the line has a line number
for a name.
04-16006-04-en, March 2015 Technical
1687
51 Script Programming
51.42 LINE
Parameter Description
Examples
Example 1
In the following example the first linename is STARTUP, labeled LINE STARTUP.
Follow the program flow to see how the line name directs the control of the
program.
Program File
Line Startup
If Temp > 72 then goto Cooling
If Temp < 70 then goto Heating
Line Heating
Turn on the Heat
...
Goto Startup
Line Cooling
Turn on the Blower
...
Goto Startup
Example 2
This example is the same as the last, only each linename is labeled with the name
followed by a colon:
Program File
Startup:
If Temp > 72 then goto Cooling
If Temp < 70 then goto Heating
Heating:
Turn on the Heat
...
Goto Startup
Turn on the Blower
Cooling:
...
Goto Startup
Example 3
This example shows how to use an integer as a line label:
Program File
LINE 1
Start Fan1
Technical 04-16006-04-en, March 2015
1688
51 Script Programming
51.42 LINE
Goto 2
LINE 2
If Fan1_Status is on then goto Shutdown
LINE Shutdown
If Zone1 temperature is less than 60 then
Stop Fan1
Goto 1
Endif
Example 4
This example shows an integer with a colon as a line label:
Program File
1:
Start Fan1
Goto 2
2:
If Fan1_Status is on then goto 3
3:
If Zone1 temperature is less than 60 then
Stop Fan1
Goto 1
Endif
Example 5
This example shows a program that has a line labeled E. The program automatically
goes to line E when an error occurs. If you do not have a line E, the software
automatically disables the program. When an error occurs, you might want the
program to go to a special line. For example, you might want the program to go to a
special line that closes an open comm port (see OPEN).
The following program goes to line E and closes the comm port when an error
occurs:
Program File
Numeric Result
Line OpenPort3
Result = Open (Comm3)
Line TestingOpen
If result = success then goto PrintMenus
Line PrintMenus
Run MenuDisplay
...
If Comm3_PrintDone = true then goto ClosePort3
Line ClosePort3
04-16006-04-en, March 2015 Technical
1689
51 Script Programming
51.42 LINE
Result = Close (Comm3)
Line TestingClose
If result = Success then Stop
Line E
Result = Close (Comm3)
Print "EMERGENCY EXIT - MENUPROGRAM FAILED."
If you have a line E, when an error occurs, line E displays in the file status
information.
Technical 04-16006-04-en, March 2015
1690
51 Script Programming
51.43 NUMERIC
51.43 NUMERIC
Alias: NUMBER
NUMERIC creates and defines one or more names as local numeric variables. You
define the variables inside a program for use only in that particular program.
Tip
A numeric variable is a name that represents a number. Numeric variables are
subject to the same range limitations as numeric constants. Numeric constants,
variables, points, expressions (formulas), or functions can be compared to other
numeric type items or used in mathematical calculations.
Each variable can be a single variable or an array. You specify an array by including
the array_size_number during the array definition.
Binding Qualifiers
Varibles can also be bound to the object property of a point outside of the program.
To do this, you must use a keyword, either Input or Output.
Syntax
Numeric Binding_qualifier namelist [array_size_number]
Table: NUMERIC Parameters
Parameter Description
namelist The name of the numeric variable you are
defining, or a series of numeric variables
separated by commas.
array_size_number A number up to 32,767 that tells the
controller how many positions are in the
array.
Binding_qualifier The keyword Input or Output which you can
bind to a point.
Examples
Example 1
Suppose that you are averaging the values of the ten temperatures. The points that
take the outside air temperature have been defined using menus and windows, but
you define the variable that contains the average using NUMERIC:
Program File
Numeric Avg_Temp
Avg_Temp = Average (Temp)
Print Avg_Temp
Example 2
You can define a series of numeric variables in a single statement:
Program File
04-16006-04-en, March 2015 Technical
1691
51 Script Programming
51.43 NUMERIC
Numeric Ave_OAT, AVE_Temp, Fan_SP
Example 3
You can define an array of numeric variables in a single statement:
Program File
Numeric Fan_SP[20]
Example 4
You can define several arrays of numeric variables and several single variables in a
single statement:
Program File
Numeric Fan_SP[20], Pump_SP, AHU_SP[10], Heat_SP
Technical 04-16006-04-en, March 2015
1692
51 Script Programming
51.44 STRING
51.44 STRING
STRING creates and defines one or more names as local string variables. You
define the variables inside a program for use only in that particular program. You
can specify the length of the string of characters with the string_length.
Tip
A string variable is a name that represents a series of alphanumeric characters.
String constants, variables, points, expressions, or functions can be compared to
other string type items. Strings cannot be used in mathematical calculations
unless they are converted to a numeric type.
Each variable can be a single variable or an array. You specify an array by including
the array_size_number during the array definition.
You must define all local string variables at the top of your program.
STRING is used to store textual information in the current program.
If you do not give a string_length, the string is given the default length, which is 16
characters.
Tip
For Enterprise Servers and Automation Servers, the maximum string_length is
255 characters. For b3 BACnet devices, the maximum length is 32 characters.
The Script compiler catches any number that is out of range.
Binding Qualifiers
Varibles can also be bound to the object property of a point outside of the program.
To do this, you must use a keyword, either Input or Output.
Syntax
String Binding_qualifier string_length namelist [array_size_number]
Table: STRING Parameters
Parameter Description
namelist The name of the string (text) variable you are
defining, or a series of string variables
separated by commas.
array_size_number (Optional) Any number up to 32,767 that tells
the controller how many positions are in the
array.
Binding_qualifier The keyword Input or Output which you can
bind to a point.
Examples
Example 1
To set a string variable, you must first define that variable using STRING. To define a
single string variable of the default length, you enter this program line:
04-16006-04-en, March 2015 Technical
1693
51 Script Programming
51.44 STRING
Program File
String VarName
Example 2
To have a program read information from a file containing text, you would create a
series of string variables like those below to contain each piece of text information.
You can create them all in the same program line:
Program File
String 20 LNAME, LOGON, PWORD, ROOM, TERMINAL
The length of each string is 20. To give them different lengths, you must define
(declare) each one separately.
Example 3
To create a string array of variables, you must first define the array. The string called
PUMP below is an eight-character string with 20 variables in the array (PUMP[1],
PUMP[2], PUMP[3], and so on).
Program File
String 8 Pump[20]
Pump[6] = "HeatPump"
Example 4
You can create several arrays of string variables and single string variables all in one
program line:
Program File
String Pump[6], Blower[8], HeaterNM, FanName
Technical 04-16006-04-en, March 2015
1694
51 Script Programming
51.45 THE
51.45 THE
THE performs no function, but enhances readability.
Syntax
the name
Table: THE Parameter
Parameter Description
name Any point, piece of equipment, terminal,
computer, or printer.
THE can precede a name only. THE cannot
precede a keyword that designates an
action (verb).
Examples
Program File
Turn on the Fan
04-16006-04-en, March 2015 Technical
1695
51 Script Programming
51.46 Webservice
51.46 Webservice
Webservice delares a Web Service in a Script program.
Syntax
Webservice (service name)
Table: Webservice Parameter
Parameter Description
service name Any Web Service name of your choosing.
Tip
The Web Service declaration name does not need to match the Script Web
Service object you intend to bind.
Example
You declare a Web Service here in order to invoke an online calculator service.
Program File
Webservice wsCalculator
Technical 04-16006-04-en, March 2015
1696
51 Script Programming
51.47 Program Control Statements
51.47 Program Control Statements
Program Control statements assist in directing program flow.
51.47.1 BASEDON...GOTO
BASEDON...GOTO branches to a different line for each value the number can have.
You put the line names in the linelist.
For more information, see section 51.48 “BASEDON...GOTO” on page 1697..
51.47.2 BREAK
BREAK halts the smallest enclosing FOR...NEXT, REPEAT...UNTIL, WHILE, or
SELECT CASE statement.
For more information, see section 51.49 “BREAK” on page 1699..
51.47.3 CONTINUE
CONTINUE stops the current iteration of the smallest enclosing FOR...NEXT,
REPEAT...UNTIL, or WHILE statement and starts the next iteration from the top of
the loop. CONTINUE also exits the SELECT CASE statement.
For more information, see section 51.50 “CONTINUE” on page 1700..
51.47.4 FOR...NEXT
FOR...NEXT carries out all statements in a loop a fixed number of times.
For more information, see section 51.51 “FOR...NEXT” on page 1701..
51.47.5 GOTO
GOTO branches to the line labeled linename.
For more information, see section 51.52 “GOTO” on page 1704..
51.47.6 IF...THEN...ELSE
IF...THEN...ELSE carries out a given statement or series of statements if the
expression is TRUE.
IF...THEN...ELSE can also carry out a given statement or series of statements if the
given expression is FALSE.
For more information, see section 51.53 “IF...THEN...ELSE” on page 1707..
04-16006-04-en, March 2015 Technical
1697
51 Script Programming
51.47 Program Control Statements
51.47.7 MOVE
MOVE converts engineering units to electrical units to control the output point,
using the top and bottom of scale for that point.
For more information, see section 51.54 “MOVE” on page 1711..
51.47.8 Repeat...Until
Repeat...Until carries out the statements in the loop until the number is true.
For more information, see section 51.55 “Repeat...Until” on page 1712..
51.47.9 RETURN
In a function, the RETURN keyword controls the calling program, returns and sends
the number to the calling program, and returns the contents of the variable.
For more information, see section 51.56 “RETURN” on page 1713..
51.47.10 SELECT CASE
SELECT CASE executes one or more statements, depending on the value of a
test_expression.
For more information, see section 51.57 “SELECT CASE” on page 1715..
51.47.11 STOP
With an output point, STOP actually stops the piece of equipment. With an input
point, STOP sets the point to the bottom of the defined scale. With a numeric point,
STOP sets the point to the lowest number in the controller system. You might STOP
an input after using the RUN keyword in order to test whether the input is active.
For more information, see section 51.58 “STOP” on page 1717..
51.47.12 WAIT
WAIT makes a program's execution wait for a specified number of seconds and
then resume right after the WAIT command statement.
For more information, see section 51.59 “WAIT” on page 1718..
51.47.13 WHILE
WHILE carries out the instructions in the statements within the loop over and over
again as long as the given number is TRUE.
For more information, see section 51.60 “WHILE” on page 1719..
Technical 04-16006-04-en, March 2015
1698
51 Script Programming
51.48 BASEDON...GOTO
51.48 BASEDON...GOTO
BASEDON...GOTO branches to a different line for each value the number can have.
You put the line names in the linelist.
Syntax
Syntax 1:
Basedon (number) Goto linelist
or
Basedon (number) Go to linelist
or
Basedon (number) Go to linelist
Syntax 2:
Basedon (number) Goto Line linelist
or
Basedon (number) Go to Line linelist
Table: BASEDON... GOTO Parameters
Parameter Description
number Any number or expression. If less than 1 or
greater than the number of lines in the
linelist, the controller ignores the
BASEDON...GOTO statement and executes
the statement immediately after
BASEDON...GOTO.
linelist One or more defined line labels (see LINE
statement) present in the current program.
The label must be spelled here just as the
label is defined, except you can interchange
upper- and lowercase. The line label can
also be an integer.
Examples
You can have a series of steps (a line) that you want to run every Friday to shut
down equipment not required over the weekend. Then, every Monday you can
restart that equipment.
To run different lines on particular days, you write a program that activates certain
lines based on the day of the week. The lines are labeled with LINE, telling the line
the routine starts on.
Remember that SUN is considered the first day of the week, so in the program
below, the first line listed after GOTO runs on Sunday, the next on Monday, the next
on Tuesday, and so on:
Program File
Basedon Wkd Goto Sun_1, Mon_1, Tue_1, Wed_1, Thu_1, Fri_1, Sat_1
…
Line Sun_1
04-16006-04-en, March 2015 Technical
1699
51 Script Programming
51.48 BASEDON...GOTO
…
Line Mon_1
…
Line Tue_1
…
Line Wed_1
…
Line Thu_1
…
Line Fri_1
…
Line Sat_1
Note
• The following variations to the BASEDON statement (above) are acceptable.
You can also include the word LINE in front of the line list:
Basedon Wkd Goto Line Sun_1, Mon_1, Tue_1, Wed_1, Thu_1, Fri_1,
Sat_1
You can replace GOTO with the word GO:
Basedon Wkd Go Sun_1, Mon_1, Tue_1, Wed_1, Thu_1, Fri_1, Sat_1
You can separate the word GO from the word TO:
Basedon Wkd Go to Sun_1, Mon_1, Tue_1, Wed_1, Thu_1, Fri_1, Sat_1
You can include the word LINE after GO and TO:
Basedon Wkd Go to Line Sun_1, Mon_1, Tue_1, Wed_1, Thu_1, Fri_1,
Sat_1
Technical 04-16006-04-en, March 2015
1700
51 Script Programming
51.49 BREAK
51.49 BREAK
BREAK halts the smallest enclosing FOR...NEXT, REPEAT...UNTIL, WHILE, or
SELECT CASE statement.
After BREAK executes, the next statement the controller carries out is the one
immediately following the end of the loop or block.
Syntax
Break
Examples
To check several stored temperatures to see if any is reading over 75 degrees, you
use a FOR...NEXT loop. Normally, the loop below would end after checking the 20
temperatures. To exit the loop as soon as you find one over 75 degrees, you use
the BREAK statement.
Program File
04-16006-04-en, March 2015 Technical
1701
51 Script Programming
51.50 CONTINUE
51.50 CONTINUE
CONTINUE stops the current iteration of the smallest enclosing FOR...NEXT,
REPEAT...UNTIL, or WHILE statement and starts the next iteration from the top of
the loop. CONTINUE also exits the SELECT CASE statement.
Each time the loop repeats, the action is an iteration of that loop.
Syntax
Continue
Examples
To check several temperatures stored in an array and print names of those over 75
degrees, you use a FOR...NEXT loop. (See the FOR...NEXT statement.) Normally,
the loop below would print the names of all 20 stored temperatures. To get the loop
to select those over 75, use CONTINUE to break the loop whenever one is less than
or equal to 75, and skip to the next array item.
Program File
In the above program, if the temperature is less than or equal to 75 degrees,
CONTINUE tells the controller to go back to the top of the FOR...NEXT loop to
check the next temperature (and therefore skip any statement between CONTINUE
and the NEXT statement).
Technical 04-16006-04-en, March 2015
1702
51 Script Programming
51.51 FOR...NEXT
51.51 FOR...NEXT
FOR...NEXT carries out all statements in a loop a fixed number of times.
Syntax
Syntax 1:
For numeric_name = begin to end
Statement
Statement
...
Next numeric_name
Syntax 2:
For numeric_name = begin to end step number
Statement
Statement
...
Next numeric_name
Table: FOR...NEXT Parameters
Parameter Description
numeric_name A defined local variable or point that stands
for a number.
The numeric_name after NEXT must be the
same as the one after FOR.
statement Any complete instruction that tells the
program what to do next or what action to
take.
begin An integer expression.
end An integer expression.
number The amount to increase numeric_name by
each time the controller goes through the
loop.
Examples
Example 1
A FOR...NEXT loop looks like this:
Program File
For count = 2 to 10 step 2
Print count, " ", (10 + count)
Next count
04-16006-04-en, March 2015 Technical
1703
51 Script Programming
51.51 FOR...NEXT
The statement sets the value of the numeric_name to the begin value, then carries
out the statements after FOR until reaching NEXT. At NEXT, the program goes back
to FOR and gets the next value of numeric_name by adding number to begin.
Here, since begin is 2, end is 10, and number is 2, the numeric_name (often called
the counter) counts 2, 4, 6, 8, 10. The first time through the loop numeric_name is
2, the second time numeric_name is 4, and so on.
As long as numeric_name is less than or equal to end, the statements inside the
loop are carried out. When numeric_name is greater than end the program then
goes to the statement after NEXT.
Here is the output printed by the previous loop:
2 12
4 14
6 16
8 18
10 20
If you do not specify a STEP number, the name automatically increases by one
(increments) each time the loop executes.
The step can also be a negative step, taking the value of the name from a begin of,
for example, 10 to an end of 1 by a number of -1.
The step can also be a negative step, taking the value of the name from a begin of,
for example, 10 to an end of 1 by a number of -1.
Example 2
Before you run functions that use the ARG variables, you can set them all to zero
with one programming statement using FOR...NEXT:
Program File
For count = 1 to 15
Set ARG[count] = 0
Next count
The first time through the loop, ARG[1] is set to 0, the second time ARG[2] is set to
0, the third time ARG[3] is set to 0, and so on.
Example 3
To set every third value in an array to zero, you can go to the third item, then sixth,
then ninth, and so on, using STEP with FOR...NEXT:
Program File
Number count
For count = 3 to 15 step 3
Set Pump[count] = 0
Next count
Example 4
To find a filtered average, you could set up a function called FILT_TOTAL. The
function, shown below, uses FOR...NEXT to loop from ARG[3] through ARG[15],
and add only the numbers with a value between that of ARG[1] and ARG[2].
Function File
Technical 04-16006-04-en, March 2015
1704
51 Script Programming
51.51 FOR...NEXT
04-16006-04-en, March 2015 Technical
1705
51 Script Programming
51.52 GOTO
51.52 GOTO
GOTO branches to the line labeled linename.
Syntax
Syntax 1: Goto linename
Syntax 2: Goto Line linename
Syntax 3: Go linename
Syntax 4: Go To linename
Syntax 5: Go To Line linename
Table: GOTO Parameter
Parameter Description
linename Any line label created with the LINE
statement. Must be in the same program.
Examples
Example 1
In the following looping program, the GOTO statement with IF..THEN controls the
heating and cooling processes:
Program File
Line Beginning
If Temp is less than 68 then Goto Heating
If Temp is greater than 76 then Goto Cooling
Line Heating
Turn on Heater1
Goto Beginning
Line Cooling
Turn on Cool1
Goto Beginning
Both Heating and Cooling are line labels. When the temperature changes, GOTO
sends control to the appropriate line.
The controller then executes instructions in the labeled line.
Notice that the GOTOs have been strategically placed so the controller executes
some statements and skips others.
Example 2
You can include the word LINE in front of the line name, as follows:
Program File
Line 1
Start Fan1
Goto Line 2
Technical 04-16006-04-en, March 2015
1706
51 Script Programming
51.52 GOTO
Line 2
If Fan1_Status is on then Goto Line Shutdown
Line Shutdown
If Zone1 Temp is less than 60 then
Stop Fan1
Goto Line 1
Endif
Example 3
You can leave out TO and type only GO:
Program File
Line Beginning
If Temp is less than 68 then go Heating
If Temp is greater than 76 then go Cooling
Line Heating
Turn On Heater1
Go Beginning
Line Cooling
Turn On Cool1
Go Beginning
Example 4
You can separate GO and TO, as follows:
Program File
Line Beginning
If Temp is less than 68 then Go to Heating
IF Temp is greater than 76 then Go to Cooling
Line Heating
Turn Heater1
Go to Beginning
Line Cooling
Turn On Cool1
Go to Beginning
Example 5
You can separate GO and TO, and include LINE as well:
Program File
Line Beginning
If Temp is less than 68 then Go to Line Heating
If Temp is greater than 76 then Go to Line Cooling
Line Heating
Turn On Heating1
04-16006-04-en, March 2015 Technical
1707
51 Script Programming
51.52 GOTO
Go to Line Beginning
Line Cooling
Turn On Cool1
Go to Line Beginning
Technical 04-16006-04-en, March 2015
1708
51 Script Programming
51.53 IF...THEN...ELSE
51.53 IF...THEN...ELSE
IF...THEN...ELSE carries out a given statement or series of statements if the
expression is TRUE.
IF...THEN...ELSE can also carry out a given statement or series of statements if the
given expression is FALSE.
For all formats, the following actions take place:
• If the expression is TRUE, the controller carries out the statement or
statements following THEN.
• If the expression is FALSE, the controller skips those statements after THEN
and does either of these actions:
– Carries out the statements after ELSE (if ELSE is used).
– Moves on to the next statement after the IF..THEN block.
Whether the expression is TRUE or FALSE, when the IF..THEN statement is
complete, program flow goes to the statement following the IF..THEN statement
unless the flow is directed to another line using GOTO, BREAK, or CONTINUE.
If you have multiple statements after THEN, they must occur on consecutive
(physical) lines, and the end of the statement must be marked with ENDIF.
Here are some general rules you should follow for all formats:
• IF and THEN must always be on the same physical line.
• THEN can be followed by one statement on the same physical line or many
statements on the physical lines that follow.
• If a multi-line statement, ELSE must always be on a physical line by itself
(Syntax 4).
• ELSE can be followed by one statement on the same physical line or multiple
statements on the physical lines that follow (Syntax 4).
• ENDIF is required to close an IF..THEN block when multiple statements occur
after THEN or when one or more statements occur after ELSE.
• When you use an IF statement after THEN, that statement must be nested
under THEN and end with ENDIF. (See Example of an IF statement after THEN,
below.)
Syntax
Syntax 1:
If expression then statement
Syntax 2:
If expression then
statement
statement
statement
..
ENDIF
Syntax 3:
If expression then statement else statement
04-16006-04-en, March 2015 Technical
1709
51 Script Programming
51.53 IF...THEN...ELSE
Syntax 4:
If expression then
statement
statement
statement
...
Else
statement
statement
statement
...
Endif
Table: IF...THEN...ELSE Parameters
Parameter Description
expression Any number or expression. The expression
can be a TRUE or FALSE comparison.
statement Any complete instruction that tells the
program what to do next or what action to
take.
Examples
Example of Syntax 1
To take a single action if the expression is TRUE, you use Syntax 1, the single-line
IF..THEN statement:
Program File
If TOD >= 1200 then Goto Noon
If the time of day is greater than 12:00 noon, then program flow moves to the
NOON line. Otherwise, the program continues with the next statement.
Note
• If you put THEN on a separate physical line from IF, a syntax error occurs.
Example of Syntax 2
To take several actions if the expression is TRUE, and take no action if the
expression is FALSE, you use Syntax 2:
Program File
If Wkd = Mon and TOD > 800 and TOD < 1600 then
Run the HeaterProg
Run the FanCheckProg
Stop the PumpProg
Technical 04-16006-04-en, March 2015
1710
51 Script Programming
51.53 IF...THEN...ELSE
Endif
If the expression is FALSE, the controller ignores the statements following THEN
and moves to the statement after ENDIF.
Example of Syntax 3
To take a single action if an expression is TRUE and another single action if the
expression is FALSE, you use Syntax 3:
Program File
If TOD > 800 & TOD < 1700 then Run DayPrg else Run NiteProg
Notice that IF, THEN, and ELSE must all be on one line in this format.
Example of Syntax 4
To take several actions if the expression is TRUE or take several others if the
expression is FALSE, you use Syntax 4:
Program File
If Temp < 72 and Pump.Stat is off then
Turn on the Fan
Close the Damper
Else
Turn off the Fan
Open the Damper
Endif
ELSE stands on a line by itself in this format, and the end of the IF.. THEN..ELSE
statement must be marked by ENDIF.
Example of nested IFs
IF statements can be included (nested) within other IF statements.
Program File
If the Wkd is Either Saturday OR Sunday then
Set Occupancy to Off
Stop the DailyProgram
If the Temp is Greater Than 70 then
Turn On the Fan
Open the Damper
Else
Turn OFF the Fan
Open the Damper
Endif
Else
Set Occupancy to On
Start the DailyProgram
Endif
04-16006-04-en, March 2015 Technical
1711
51 Script Programming
51.53 IF...THEN...ELSE
Notice that each IF ends with an ENDIF. The inner (indented) ENDIF goes with the
inner IF and ELSE, the outer ENDIF with the outer IF and ELSE.
The ELSE and ENDIF that belong to the indented IF are aligned under that IF.
Notice that the last IF ends first.
Example of an IF statement after THEN
Take a look at the following statement with an IF after THEN:
Program File
If the Wkd is Sat then if the Hour is 1 then Goto 1 else Goto 2
Which IF does the ELSE belong to? In this case the ELSE belongs to the second IF.
Why? Because ELSE belongs to the closest previous IF on the same physical line.
An IF..THEN statement that starts right after THEN is always a self-contained
statement that ends on that physical line.
To make the ELSE belong to the first IF, you must form a nested IF arrangement, as
follows:
Program File
If the Wkd is Sat then
If the Hour is 1 then
Goto 1
Endif
Else
Goto 2
Endif
In this nested IF statement, the ELSE belongs with the first IF.
Example of a nonzero value number
Program File
If 10 then start Burner
Here, since 10 is a nonzero value, 10 is interpreted as TRUE and causes the burner
to fire up.
Caution
• Be careful when programming with IF..THEN..ELSE statements if the number
is any nonzero value. When this occurs, the number is interpreted as TRUE
and the THEN block is executed.
Technical 04-16006-04-en, March 2015
1712
51 Script Programming
51.54 MOVE
51.54 MOVE
Alias: MODULATE
MOVE converts engineering units to electrical units to control the output point,
using the top and bottom of scale for that point.
Set the point or points in output_point_list to number.
The percent sign is optional.
Syntax
MOVE output_point_list TO number
MOVE output_point_list TO number %
Table: MOVE Parameters
Parameter Description
output_point_list One or more output point names or variables
with commas between them. Top and
bottom of scale must be set for each point.
number Any number or expression, including a date
and time or name that stands for one.
Products Supported
CX series, BACnet series, CMX series, SCX series, TCX series, LCX series, ACX
series, DCX 250, Automation Server, Enterprise Server
Examples
Example 1
If Valve2 has engineering units of 0 to 90 degrees, and the corresponding electrical
units are 0 to 20 mA, when you move the setting of Valve2 to 45, the electrical unit
sets to 10 mA. To have the engineering units automatically converted to electrical
units, you use MOVE as follows:
Program File
MOVE VALVE2 TO 45
Example 2
For this valve, assume engineering units of 0 to 1 where 0 is closed and 1 is open
and corresponding electrical units of 0 to 20 mA. Moving the setting of Valve2 to
50% gives .5. At .5, the valve is set to the corresponding value of 10 mA.
Program File
MODULATE VALVE2 TO 50%
04-16006-04-en, March 2015 Technical
1713
51 Script Programming
51.55 Repeat...Until
51.55 Repeat...Until
Repeat...Until carries out the statements in the loop until the number is true.
Syntax
Repeat
statement
statement
...
Until number
Table: Repeat...Until Parameters
Parameter Description
statement Any complete instruction that tells the
program what to do next or what action to
take.
number Any number or expression, including a date
and time or name that stands for one.
The statements within the loop always execute at least once before the expression
is evaluated.
Examples
You want to print all the values in an array:
Program File
Numeric Count
Count = 1
Repeat
Print OutsideAir [Count]
Count = Count + 1
Until Count = OutsideAir_Size
Technical 04-16006-04-en, March 2015
1714
51 Script Programming
51.56 RETURN
51.56 RETURN
In a function, the RETURN keyword controls the calling program, returns and sends
the number to the calling program, and returns the contents of the variable.
If you expect to use the results of a calculation in more than one program, you set
up a function file and put the calculation instructions inside, thus creating a function.
When you need the function in a program, you call the function by using the
function variable as if that function were any other keyword verb.
Later, the RETURN statement tells the function the value to return to the calling
program.
Make sure to return a number or other value when you want to use the returned
value in the calling program.
Syntax
Return
Return number
Table: RETURN Parameter
Parameter Description
number (Optional) Any number or expression,
including a date and time or name that
stands for one.
Examples
Example 1
You use RETURN without an expression to return to the calling program without
passing parameters. You might do that with a function that contains a series of
actions to be carried out, as in the SHUTDOWN function shown below:
Function File
Turn off the Heat
Turn off the Fan
Run Pump, Cooling
Return
In this case, RETURN returns you to the program that called the SHUTDOWN
function, returning a numeric 0 because you supplied no arguments on the
RETURN statement.
The statement that calls SHUTDOWN in the calling program looks like this:
Program File
Shutdown ()
Example 2
To create a function called GetArea that calculates the cross-sectional area of a
circle, name the function file GetArea and enter the following in the function file:
Function File
ARG 1 radius
04-16006-04-en, March 2015 Technical
1715
51 Script Programming
51.56 RETURN
Return (3.14159 * (radius ^ 2))
You pass the radius into the function file from the calling statement in the main
program. Here is a sample calling statement:
Program File
VOL = GetArea(radius) * LEG
This statement calls the GetArea function, giving the radius value, which the
function requires to calculate the area.
Example 3
Create a function that uses a diameter as an argument to calculate and return the
value of the circumference.
Function File
ARG[1] diameter
Numeric Circumf
Circumf = 3.14159 * diameter
Return (Circumf)
Technical 04-16006-04-en, March 2015
1716
51 Script Programming
51.57 SELECT CASE
51.57 SELECT CASE
SELECT CASE executes one or more statements, depending on the value of a
test_expression.
Syntax
Select Case test_expression
Case expression_list
statement_list
Case expression_list
statement_list
...
Case Else
else_statement_list
EndSelect
Table: SELECT CASE Parameters
Parameter Description
test_expression Any numeric, string, or datetime expression.
expression_list A list of one or more expressions, separated
by commas.
statement_list One or more statements to execute if
test_expression matches any expression in
the corresponding expression_list.
else_statement_list One or more statements to execute if
test_expression matches any expression in
corresponding expression_list.
If test_expression matches any expression in CASE expression_list, then the
statements following that CASE clause are executed up to the next CASE clause, if
any, or up to EndSelect. At least one CASE expression_list clause is expected.
The CASE ELSE clause is used to execute the statements in else_statement_list if
test_expression does not match any expression in any of the CASE expression_list
clauses. The CASE ELSE clause is not required. However, you should include the
clause anyway to catch unexpected test_expression values.
Once the statements in the statement_list or else_statement_list have been
executed, the statement right after the EndSelect is the one to execute next.
Expressions can be numeric, string, or datetime.
Examples
Example 1
Program File
Select Case Weekday
Case Monday, Tuesday
04-16006-04-en, March 2015 Technical
1717
51 Script Programming
51.57 SELECT CASE
Print "Run Mon_Tue Report"
Case Wednesday thru Friday
Print "Run Wed_Thu_Fri Report"
Case Else
Print "Run Weekend Report"
EndSelect
Example 2
Program File
Numeric ReportId
Select Case ReportId
Case 1
Print "Run First Report"
Case 2, 3, 5 thru 10, 15
Print "Run Special Report"
Case 20
Print "Run Final Report"
Case Else
Print "Invalid Report Id"
EndSelect
Example 3
Program File
Select Case Numeric1 Description
Case Numeric2 Description
Print "Numeric1 and Numeric2 have the same description”
Case “West Building”
Print "Numeric1 is the West Building”
Case Else
Print "Numeric1 is not the West Building”
EndSelect
Technical 04-16006-04-en, March 2015
1718
51 Script Programming
51.58 STOP
51.58 STOP
Aliases: CLOSE, SHUT
With an output point, STOP actually stops the piece of equipment. With an input
point, STOP sets the point to the bottom of the defined scale. With a numeric point,
STOP sets the point to the lowest number in the controller system. You might STOP
an input after using the RUN keyword in order to test whether the input is active.
Syntax
Stop point_list
Sets the point (or points) to bottom of its defined scale, turns the equipment off, and
controls the equipment through the point. You can use this statement in a program
to turn off a piece of equipment.
Table: STOP Parameters
Parameter Description
point_list Usually any defined Output point or list of
points. The statement is not designed for
other types of points, but you can stop an
input or numeric point.
Examples
You can STOP a program from inside a program in response to a certain set of
conditions. For example, to halt the HEATPROG after 8 PM:
Program File
If TOD > 2000 then stop the HeatProg
If you do not name a program after STOP, the controller assumes you mean the
current program.
04-16006-04-en, March 2015 Technical
1719
51 Script Programming
51.59 WAIT
51.59 WAIT
Alias: Delay
WAIT makes a program's execution wait for a specified number of seconds and
then resume right after the WAIT command statement.
Syntax
WAIT number
Table: WAIT Parameter
Parameter Description
number Any expression that results in a number.
Interpreted as the number of seconds to
wait.
Products Supported
Automation Servers and Enterprise Servers
Examples
Wait 5 'waits for 5 seconds
Wait (3) 'waits for 3 seconds
Delay 10 'waits for 10 seconds
Restrictions
You can only use the WAIT keyword in the following situations:
• At the Server level (Automation Server and Enterprise Server)
• In a Script program and not in a Script function
Tip
WAIT is not supported inside a For loop.
Technical 04-16006-04-en, March 2015
1720
51 Script Programming
51.60 WHILE
51.60 WHILE
WHILE carries out the instructions in the statements within the loop over and over
again as long as the given number is TRUE.
Syntax
While number
statement
statement
...
Endwhile
Table: WHILE Parameters
Parameter Description
statement Any complete instruction that tells the
program what to do next or what action to
take.
number Any number, expression, or variable whose
value determines if the WHILE loop is
executed. If the value is TRUE (non-zero) the
WHILE loop is executed. If the value is
FALSE (zero), the WHILE loop is not
executed. If the value is a variable, the value
can be changed inside the WHILE loop to
cause the loop to terminate.
Examples
Initialize a 10 element manual array:
Program File
Numeric Counter
Set Counterto 1
While Counter <= 10
ManualArray[Counter] = Counter*10
Counter = Counter + 1
Endwhile
04-16006-04-en, March 2015 Technical
1721
51 Script Programming
51.61 Qualifier Statements
51.61 Qualifier Statements
Qualifier statements assist in defining input, output, and public variables.
51.61.1 INPUT
INPUT is a binding qualifier that identifies a variable declaration as an input variable.
You can bind an input variable to an object property outside of the program. The
input variable takes on the same value as the property it is bound to. You cannot
set an input variable's value.
For more information, see section 51.62 “INPUT” on page 1721..
51.61.2 Buffered
Buffered is used exclusively as a qualifier for an input variable to indicate that the
variable can hold one or more buffered values. The type of input variable may be
Numeric, String, or DateTime.
For more information, see section 51.63 “Buffered ” on page 1722.
51.61.3 OUTPUT
OUTPUT is a binding qualifier that identifies a variable declaration as an output
variable. You can bind an output variable to an object property outside of the
program. When the output variable is set, the bound property value will be set to the
same value.
For more information, see section 51.64 “OUTPUT” on page 1723..
51.61.4 PUBLIC
PUBLIC is a binding qualifier that identifies a variable as a public variable. You can
modify a public variable from outside a Script program, such as from a graphic.
For more information, see section 51.65 “PUBLIC” on page 1724..
Technical 04-16006-04-en, March 2015
1722
51 Script Programming
51.62 INPUT
51.62 INPUT
INPUT is a binding qualifier that identifies a variable declaration as an input variable.
You can bind an input variable to an object property outside of the program. The
input variable takes on the same value as the property it is bound to. You cannot
set an input variable's value.
Syntax
variable_declaration input namelist
Table: INPUT Parameters
Parameter Description
variable_declaration The keyword Numeric, String, or Datetime
which defines the type of input variable.
namelist The name of the input variable you are
defining, or a series of input variables
separated by commas.
Examples
Program File
If you have a program that controls a fan based on the value of a temperature input
point, you define an input variable to bind to the input's value property.
Numeric_input Temp_DegF
If Temp_DegF is greater than 75 then
Turn Fan On
Endif
04-16006-04-en, March 2015 Technical
1723
51 Script Programming
51.63 Buffered
51.63 Buffered
Buffered is used exclusively as a qualifier for an input variable to indicate that the
variable can hold one or more buffered values. The type of input variable may be
Numeric, String, or DateTime.
Note
The buffering of values is performed on a First-In, First-Out basis (that is, a
queue).
Syntax
type buffered input variable_name
Table: Buffered Parameters
Parameter Description
type The keyword Numeric, String, or DateTime
which defines the type of input variable.
variable_name The name of the input variable you are
defining, or a series of input variables
separated by a comma.
Example
You declare a buffered input variable (BIn1) and a pair of output variables in this
sample program. BIn1 has the same value every time it is used as expected.
Note
Buffered inputs are supported only in Automation Server and Enterprise Server
programs. They are not supported in functions, or on b3 BACnet controllers.
Program File
Numeric Buffered Input BIn1
Numeric Buffered Input BIn2
Numeric Output Out1
Out1 = BIn1 + BIn2
Technical 04-16006-04-en, March 2015
1724
51 Script Programming
51.64 OUTPUT
51.64 OUTPUT
OUTPUT is a binding qualifier that identifies a variable declaration as an output
variable. You can bind an output variable to an object property outside of the
program. When the output variable is set, the bound property value will be set to the
same value.
Syntax
variable_declaration output namelist
Table: OUTPUT Parameters
Parameter Description
variable_declaration The keyword Numeric, String, or Datetime
which defines the type of output variable.
namelist The name of the output variable you are
defining, or a series of output variables
separated by commas.
Examples
Program File
If you have a program that controls a thermostat temperature, you define an output
variable to bind to the thermostat's temperature property.
Numeric output Thermostat_Temp_DegF
Thermostat_Temp_DegF = 72.5
04-16006-04-en, March 2015 Technical
1725
51 Script Programming
51.65 PUBLIC
51.65 PUBLIC
PUBLIC is a binding qualifier that identifies a variable as a public variable. You can
modify a public variable from outside a Script program, such as from a graphic.
Public behaves like an output variable, so you may bind the public variable to the
value of a point, or to the input variable of a Script program as you would with any
output variable. Unlike an output variable, you do not have to use the force
capability to modify Public from the Script property grid, or from a graphic.
You should use the Public binding qualifier when you need to directly modify that
variable from the Script property grid (that is, modify the value the Public binding
variable is bound to). Unlike an output variable, you can manually change the value
of the public variable from a graphic.
Syntax
variable_declaration public namelist
Table: PUBLIC Parameter
Parameter Description
variable_declaration The keywords Numeric, String, or Datetime
which defines the type of public variable.
namelist The name of the public variable you are
defining, or a series of output variables
separated by commas.
Examples
Program File
Assume you want to set an output in your Script program using the PUBLIC
variable.
Numeric public ReceivedValue
Numeric Output OutputValue
Set OutputValue to ReceivedValue
Technical 04-16006-04-en, March 2015
1726
51 Script Programming
51.66 Expressions
51.66 Expressions
Instructions that consist of mathematical operations are called expressions.
Expressions can also be item names or constants that return a numeric or string
result.
51.66.1 Numeric Expressions
Numeric expressions always result in a number. Numeric constants and variables
are expressions. Expressions can also be mathematical calculations that result in a
number or comparisons that produce a TRUE or FALSE response.
The following expressions are valid numeric expressions:
• 2
• SQRT (9)
• 900 DIVIDED BY 8
• WKD IS GREATER THAN MONDAY
51.66.2 String Expressions
String expressions are textual expressions that always result in a string of
characters enclosed in quotation marks. String constants and string variables are
also expressions. String expressions can be combinations that result in a string of
characters.
The following expressions are valid string expressions:
• “WARNING- HIGH TEMPERATURE”
• LEFT (“TEST”, 1)
• “THE NUMBER OF ERRORS IS”, TOTAL1
04-16006-04-en, March 2015 Technical
1727
51 Script Programming
51.67 Variables
51.67 Variables
A variable is a run-time (dynamically changing) property of an object.
Script supports program, system, and runtime variables.
51.67.1 Program Variables
Variables are names that represent numbers, words, or dates and times. Unlike a
constant, a variable has a value that changes or varies.
For more information, see section 51.69 “Program Variables” on page 1728..
51.67.2 System Variables
System variables are objects that the system sets and updates automatically.
System variables are controlled by the system and cannot be changed by the user.
For more information, see section 51.73 “System Variables” on page 1734.
51.67.3 System Variable Keywords
Values that change are represented by system variables. The controller
automatically updates the value of these variables.
For more information, see section 51.79 “System Variable Keywords” on page
1740.
51.67.4 Script Runtime Variables
Script runtime variables are read-only properties that display information about the
state of a program.
For more information, see section 51.74 “Script Runtime Variables” on page 1735.
Technical 04-16006-04-en, March 2015
1728
51 Script Programming
51.68 Declaring a Variable
51.68 Declaring a Variable
You declare local program variables at the beginning of the Script program or
function where the variables are used.
For more information, see section 51.70 “Local Program Variables” on page 1729.
To declare a variable
1. In Script Editor, declare the variable you want to use in the program or
function:
• Declare the variable using the type keyword Numeric, String, or DateTime
before the name of the variable.
• Declare the variable using the binding keyword Input, Output, or Public
after the type keyword, and before the name of the variable, to enable
bindings to the variable.
You have now declared the variables in your Script program or function. These
declarations are then followed by one or more program lines or instructions that
specify the operations to perform.
04-16006-04-en, March 2015 Technical
1729
51 Script Programming
51.69 Program Variables
51.69 Program Variables
Variables are names that represent numbers, words, or dates and times. Unlike a
constant, a variable has a value that changes or varies.
51.69.1 Local Program Variables
Local program variables are related to system variables. Unlike system variables,
which are known to all controllers in the system, local program variables are only
known to the program where they are defined. You define each local variable at the
beginning of the program where they are used. For example, you can bind a local
program variable to a server variable, an I/O point, or a local program variable of
another program in order to allow them to read or change values in the system.
For more information, see section 51.70 “Local Program Variables” on page 1729.
51.69.2 Program Arrays
A Script array is a group of variables of the same size that shares a single name, but
is broken up into numbered cells, called elements.
For more information, see section 51.72 “Program Arrays” on page 1733.
51.69.3 Variables Pane Types
The types of variables displayed in the Variables Pane include Integer, Float,
Boolean, String, or DateTime, with Float as the Default value. Each of these types
are applicable to numeric variables only.
Technical 04-16006-04-en, March 2015
1730
51 Script Programming
51.70 Local Program Variables
51.70 Local Program Variables
Local program variables are related to system variables. Unlike system variables,
which are known to all controllers in the system, local program variables are only
known to the program where they are defined. You define each local variable at the
beginning of the program where they are used. For example, you can bind a local
program variable to a server variable, an I/O point, or a local program variable of
another program in order to allow them to read or change values in the system.
Note
• Script supports characters at or below ASCII 127. Additional characters are
not supported and are replaced by a question mark (?).
51.70.1 Local Program Variable Declaration
There are two formats available for the Local Program Variable Declaration Line:
Type Local_Variable Name[array_index]
Type Binding_Qualifier Local_Variable Name
In each format, you can use one or more local variables.
Note
• The array index option is not supported for binding variables.
Examples
Numeric A
Datetime D
String S
Numeric Input A1
Numeric Input A2, A3, A4
Numeric Input A2, A3, A4
String Input S1
Datetime Input DT1
Numeric Output B1
String Output outstr1
Datetime Output outdt1
Numeric Fan_SP [20], Temp [20]
You can declare local variable types using the following keyword statements:
• Numeric
• String
• DateTime
• Function
04-16006-04-en, March 2015 Technical
1731
51 Script Programming
51.70 Local Program Variables
• WebService
Numeric keyword
The Numeric keyword assigns the name that follows as a local numeric variable:
Numeric RateOfRise
String Keyword
The String keyword assigns the name that follows as a local string variable:
String DirtyFilterMsg
DateTime Keyword
The DateTime keyword assigns the name that follows as a local variable that
accepts a date and time:
DateTime LocalDateTime
Function Keyword
The Function keyword assigns the name that follows as a local variable, which you
bind to a Script user-defined function.
Function MyFunction
WebService Keyword
The WebService keyword assigns the name that follows as a local variable, which
you bind to a Script Web Service object.
WebService wsCalculator
51.70.2 Local Program Variables and Bindings
To enable a local program variable to bind to the property of an object, you must
include an additional keyword to qualify your declaration. You use the binding
keyword Input, Output, or Public after the type, and before the name of the local
variable.
These binding keywords indicate either the inputs or outputs of the program, or the
public variables that use property bindings outside of the program:
• An Input variable indicates that the program uses the variable to read the
object property that variable is bound to. For this type, the program is not
allowed to set the value of the local variable because the variable is read-only.
• An Output variable indicates that the program uses the variable to set the
object property that variable is bound to.
• A Public variable indicates that the program makes the variable accessible to
other applications. You can then allow an application to bind its output variable
to that public variable.
Tip
The Input and Output qualifiers apply only to the Numeric, String, and DateTime
types.
Technical 04-16006-04-en, March 2015
1732
51 Script Programming
51.70 Local Program Variables
The type of the object property you bind a local variable to must match the type of
the local variable you plan to bind to. For example, you must bind a Numeric local
variable to object property types such as integer, double, float, digital, and
enumeration. Similarly, you must also bind strings to string type properties, and
datetimes to datetime properties.
04-16006-04-en, March 2015 Technical
1733
51 Script Programming
51.71 Variables Pane Types
51.71 Variables Pane Types
The types of variables displayed in the Local or Binding Variables panes include
Integer, Float, Boolean, String, or DateTime, with Float as the Default value. Integer,
Float or Boolean types apply to a numeric variable only.
Table: Types of Variables
Declared Variable Description
Numeric Float Use when binding to a
floating point property, such
as an Analog Value
Int Use when binding to an
integer property, such as a
Multistate Value
Bool Use when binding to a
Boolean (true or false)
property, such as a Digital
Value
String String Use when binding to a String
value.
DateTime DateTime Use when binding to a
DateTime value.
Technical 04-16006-04-en, March 2015
1734
51 Script Programming
51.72 Program Arrays
51.72 Program Arrays
A Script array is a group of variables of the same size that shares a single name, but
is broken up into numbered cells, called elements.
You refer to each element in the array using a number called an index.
For example, if we had an array with 8 elements called CLOCK, you can refer to its
eight possible values as CLOCK[1], CLOCK[2], CLOCK[3], CLOCK[4], and so on.
Table: Example of an Eight Element Array
Index Value
1 8.00
2 8.51
3 9.00
4 9.62
5 10.00
6 10.75
7 11.00
8 11.25
CLOCK[1] is 8.00, CLOCK[2] is 8.51, CLOCK[3] is 9.00, and so on. Each entry in an
array is referred to as an element. An array can contain up to 32,767 elements.
You can also put a numeric variable in place of the index number, such as
CLOCK[COUNT]. The variable is called an index variable.
When you define an array variable, you must specify a type (numeric, string, or
datetime) and the number of elements. The following statement defines (declares) a
local array called “Temperature” as numeric with 50 elements:
NUMERIC TEMPERATURE[50]
04-16006-04-en, March 2015 Technical
1735
51 Script Programming
51.73 System Variables
51.73 System Variables
System variables are objects that the system sets and updates automatically.
System variables are controlled by the system and cannot be changed by the user.
Continuum devices, such as a b3 (with unchanged firmware), are the only
exception. The Date and Hour system variables can be changed in a b3 device with
unchanged firmware. For more information, see section 51.79 “System Variable
Keywords” on page 1740.
The following table provides a complete list of the system variables for Building
Operation.
Table: System Variables
Name Description
Date Retrieves current system date and time so
that you can then store that date and time in
a variable.
DayofMonth Supplies the current day of the month from 1
to 31.
DayofYear Supplies the current day of the year between
1 and 366.
Hour Indicates the current hour, from 0 to 23.
HourofDay Indicates the time in decimal form from 0 to
23.99.
Minute Supplies the minute of the current hour, from
0 to 59.
Month Supplies the current month of the year, from
January to December.
Scan Indicates the controller’s last scan time in
seconds.
Second Supplies the number of seconds of the
current minute, from 0 to 59.
TimeofDay Supplies the time of day with the hour and
minute in the format HHMM where HH is a
number between 0 and 23 and MM is a
number between 0 and 59.
Weekday Supplies the current day of the week, from
SUNDAY through SATURDAY.
Year Supplies the current year.
Technical 04-16006-04-en, March 2015
1736
51 Script Programming
51.74 Script Runtime Variables
51.74 Script Runtime Variables
Script runtime variables are read-only properties that display information about the
state of a program.
Script uses four different runtime variables.
51.74.1 TS
TS is a Script program runtime property that contains the number of seconds (Time
in Seconds) that have elapsed since the program has been on the current line.
TS stands for Time in Seconds.
For more information, see section 51.75 “TS” on page 1736..
51.74.2 TM
TM is a Script program runtime property that contains the number of minutes (Time
in Minutes) that have elapsed since the program has been on the current line.
TM stands for Time in Minutes.
For more information, see section 51.76 “TM” on page 1737..
51.74.3 TH
TH is a Script program runtime property that contains the number of hours (Time in
Hours) that have elapsed since the program has been on the current line.
TH stands for Time in Hours.
For more information, see section 51.77 “TH” on page 1738..
51.74.4 TD
TD is a Script program runtime property that contains the number of days (Time in
Days) that have elapsed since the program has been on the current line.
TD stands for Time in Days.
For more information, see section 51.78 “TD” on page 1739..
04-16006-04-en, March 2015 Technical
1737
51 Script Programming
51.75 TS
51.75 TS
TS is a Script program runtime property that contains the number of seconds (Time
in Seconds) that have elapsed since the program has been on the current line.
TS stands for Time in Seconds.
Syntax
TS
Example
To allow for a 90-second valve stroke time, see if 90 seconds have elapsed since
you opened the valve.
Program File:
The controller measures 90 seconds starting the instant that the program is on the
line making the request for elapsed time.
Technical 04-16006-04-en, March 2015
1738
51 Script Programming
51.76 TM
51.76 TM
TM is a Script program runtime property that contains the number of minutes (Time
in Minutes) that have elapsed since the program has been on the current line.
TM stands for Time in Minutes.
Syntax
TM
Example
To have a 5-minute warmup of a fan before turning on the pump, you would check
to see if the fan has been running for 5 minutes after activation.
Program File:
The controller measures 5 minutes starting the instant that the program is on the
line making the request for elapsed time.
04-16006-04-en, March 2015 Technical
1739
51 Script Programming
51.77 TH
51.77 TH
TH is a Script program runtime property that contains the number of hours (Time in
Hours) that have elapsed since the program has been on the current line.
TH stands for Time in Hours.
Syntax
TH
Example
To have the lead fan run 1 hour then run the lag fan, you would check to see if the
fan has been running for 1 hour after activation.
Program File:
The controller measures 1 hour starting the instant that the program is on the line
making the request for elapsed time.
Technical 04-16006-04-en, March 2015
1740
51 Script Programming
51.78 TD
51.78 TD
TD is a Script program runtime property that contains the number of days (Time in
Days) that have elapsed since the program has been on the current line.
TD stands for Time in Days.
Syntax
TD
Example
In order to have a lead pump run for 3 days, then turn on the lag pump, you would
check to see if the pump has been running for 3 days after activation.
Program File:
The controller measures 3 days starting the instant that the program is on the line
making the request for elapsed time.
04-16006-04-en, March 2015 Technical
1741
51 Script Programming
51.79 System Variable Keywords
51.79 System Variable Keywords
Values that change are represented by system variables. The controller
automatically updates the value of these variables.
Script uses two different types of system-variable keywords: date and time and
runtime variable keywords.
51.79.1 Date and Time System Variables
Date and Time System variables represent changeable time of day and calendar
values.
Date and Time System variables include the following keywords:
• DATE
• DAYOFMONTH
• DAYOFYEAR
• HOD
• HOUR
• MINUTE
• MONTH
• SECOND
• TOD
• WEEKDAY
• YEAR
For more information, see section 51.80 “Date and Time System Variables ” on
page 1741..
51.79.2 Runtime System Variables
Runtime system variables are variables the controller maintains.
Runtime system variables include the following keywords:
• ERRORS
• FREEMEM
• SCAN
For more information, see section 51.92 “Runtime System Variables ” on page
1757..
Technical 04-16006-04-en, March 2015
1742
51 Script Programming
51.80 Date and Time System Variables
51.80 Date and Time System Variables
Date and Time System variables represent changeable time of day and calendar
values.
A datetime variable is a name that represents a date and time. Datetime constants,
variables, points, expressions, or functions can be compared to other datetime
items. You can retrieve the date and time from the STRTODATE function or from
the DATE system variable.
Tip
You can print out a datetime variable to see what date and time the variable
contains. However, the date and time that prints out is a predefined format you
cannot change. The date and time prints in this format (in the 24-hour clock):
MONTH DD YYYY hh:mm:ss
51.80.1 DATE
DATE retrieves the current system date and time so that you can then store them in
a variable.
The value for DATE is always the current date.
DATE is designed to be used with DIFFTIME, along with a datetime variable (defined
using the DATETIME statement).
For more information, see section 51.81 “DATE” on page 1744..
51.80.2 DAYOFMONTH
DAYOFMONTH gives the day of month from 1 to 31.
You cannot change the DAYOFMONTH. The server automatically updates this
value.
For more information, see section 51.82 “DAYOFMONTH” on page 1745..
51.80.3 DAYOFYEAR
DAYOFYEAR gives the number of the day of the year, between 1 and 366.
You cannot change the DAYOFYEAR. The server automatically updates this value
For more information, see section 51.83 “DAYOFYEAR” on page 1746..
51.80.4 HOD
HOD gives the time in a decimal form from 0.0 to 23.99.
You cannot change the HOD. The system automatically updates this value.
For more information, see section 51.84 “HOD” on page 1747..
04-16006-04-en, March 2015 Technical
1743
51 Script Programming
51.80 Date and Time System Variables
51.80.5 HOUR
HOUR gives the current hour, from 0 to 23.
If the time is 5:23:02, the hour is 5.
The system automatically updates the HOUR variable.
For more information, see section 51.85 “HOUR” on page 1748..
51.80.6 MINUTE
MINUTE gives the exact minute of the current hour, from 0 to 59.
The minute is the minute on the controller clock, so if the time is 5:23:02, the minute
is 23.
You cannot change the MINUTE. The server automatically updates this value.
For more information, see section 51.86 “MINUTE” on page 1749...
51.80.7 MONTH
MONTH gives you the current month of year, from January to December.
You cannot change the MONTH. The server automatically updates this value.
For more information, see section 51.87 “MONTH” on page 1750...
51.80.8 SECOND
SECOND gives the exact number of seconds of the current minute, from 0 to 59.
The number of seconds is as indicated by the server clock. If the time is 10:02:12,
then SECOND equals 12.
For more information, see section 51.88 “SECOND” on page 1752..
51.80.9 TOD
TOD gives the time of the day from 0 (midnight) to 2359, where 2359 is the
equivalent of 23:59 on the 24-hour clock.
The time of day is the time from the controller clock. You cannot change TOD since
the controller automatically updates that setting.
For more information, see section 51.89 “TOD” on page 1753..
51.80.10 WEEKDAY
WEEKDAY gives current day of week, from SUNDAY through SATURDAY.
When printed, the weekday is spelled out as Sunday, Monday, Tuesday,
Wednesday, and so on through Saturday.
Technical 04-16006-04-en, March 2015
1744
51 Script Programming
51.80 Date and Time System Variables
For more information, see section 51.90 “WEEKDAY” on page 1754..
51.80.11 YEAR
YEAR gives the current year. You cannot change the YEAR. The system
automatically updates the value.
When printed, the four-digit year is given.
For more information, see section 51.91 “YEAR” on page 1756...
04-16006-04-en, March 2015 Technical
1745
51 Script Programming
51.81 DATE
51.81 DATE
Alias: TIME
DATE retrieves the current system date and time so that you can then store them in
a variable.
The value for DATE is always the current date.
DATE is designed to be used with DIFFTIME, along with a datetime variable (defined
using the DATETIME statement).
Syntax
Date
Example
Once you have defined the datetime variable called TEMP_DATE using the
DATETIME statement, you can then set the value of that variable using the DATE
system variable, as follows:
Program file
Datetime Temp_Date
Temp_Date = Date
This way, TEMP_DATE retrieves the exact system date and time at a given
moment.
You can, for example, record the date and time that a point changes. You can use
the variable you have created in subsequent calculations.
Technical 04-16006-04-en, March 2015
1746
51 Script Programming
51.82 DAYOFMONTH
51.82 DAYOFMONTH
Alias: DOM
DAYOFMONTH gives the day of month from 1 to 31.
You cannot change the DAYOFMONTH. The server automatically updates this
value.
Syntax
DayOfMonth
Example
Example 1
To print out a headline that contains the date, you would use DAYOFMONTH, as
shown below:
Program File
Print "The kwh history for", MONTH, DayofMonth, "," , YEAR
The resulting header would print the actual month, day of the month, and year, like
this:
The kwh History for October 15, 2008
Example 2
To make some events occur only on particular days of each month, you could set
up an IF..THEN statement that would check for the day of the month:
Program File
If DayofMonth is between 7 and 14 then…
04-16006-04-en, March 2015 Technical
1747
51 Script Programming
51.83 DAYOFYEAR
51.83 DAYOFYEAR
Alias: DOY
DAYOFYEAR gives the number of the day of the year, between 1 and 366.
You cannot change the DAYOFYEAR. The server automatically updates this value
Syntax
DayOfYear
Example
Suppose on a certain date, you need to switch off the heating and switch on
cooling. You would use DAYOFYEAR to instruct the controller:
Program File
If DayofYear is 152 then
Stop the Heating_Prog
Run the Cooling_prog
Endif
Technical 04-16006-04-en, March 2015
1748
51 Script Programming
51.84 HOD
51.84 HOD
Alias: HOUROFDAY
HOD gives the time in a decimal form from 0.0 to 23.99.
You cannot change the HOD. The system automatically updates this value.
Syntax
HOD
Example
Example 1
You can use the decimal form of the time to see if the time is past 5:30 a.m.:
Program File
If HOD is greater than 5.50 then...
Example 2
A simple way to calculate the StartTime based on OutsideAir could use HOD as
follows:
Program File
If OutsideAir > 70 then Goto CoolStart
Set StartTime = (8.00 - (70-OutsideAir) * RateOfRise)
If HOD = StartTime then Goto StartBldg
04-16006-04-en, March 2015 Technical
1749
51 Script Programming
51.85 HOUR
51.85 HOUR
Alias : HR
HOUR gives the current hour, from 0 to 23.
If the time is 5:23:02, the hour is 5.
The system automatically updates the HOUR variable.
Syntax
Hour
Example
To take action every day at 5:00 a.m., you would check the hour with the following
statement:
Program File
If Hour is equal to 5 then Goto Startup
Technical 04-16006-04-en, March 2015
1750
51 Script Programming
51.86 MINUTE
51.86 MINUTE
Alias: MIN
MINUTE gives the exact minute of the current hour, from 0 to 59.
The minute is the minute on the controller clock, so if the time is 5:23:02, the minute
is 23.
You cannot change the MINUTE. The server automatically updates this value.
Syntax
Minute
Example
Suppose you have eight programs to run every hour. To avoid customizing scan
time by running all the programs at once, you could run two programs in each
quarter of any hour:
Program File
If Minute equals 15 then
Run the System_Check
Run the Power_Usage
Endif
If Minute equals 30 then
Run the Temp_Check
Run the Temp_Rept
Endif
If Minute equals 45 then
Run the Fan_Check
Run the Damper_Check
Endif
If Minute equals 0 then
Run the Heater_Check
Run the CO_Check
Endif
The SYSTEM_CHECK and POWER_USAGE programs now run at 15 minutes after
the hour every hour of every day, 24 hours a day and 365 days a year.
The TEMP_CHECK and TEMP_REPT programs now run at 30 minutes after the
hour every hour of every day, 24 hours a day and 365 days a year.
The FAN_CHECK and DAMPER_CHECK programs now run at 45 minutes after the
hour every hour of every day, 24 hours a day and 365 days a year.
The HEATER_CHECK and CO_CHECK programs now run on the hour every hour
of every day, 24 hours a day and 365 days a year.
04-16006-04-en, March 2015 Technical
1751
51 Script Programming
51.87 MONTH
51.87 MONTH
Alias: MTH
MONTH gives you the current month of year, from January to December.
You cannot change the MONTH. The server automatically updates this value.
When printed, the month is spelled out as January, February, March, and so on
through December. You can also compare the MONTH to:
• The numbers (1 through 12).
• The abbreviated three-letter names (first three letters).
All values for MONTH are listed below:
Table: MONTH Values
Constant Short Name Long Name
1 JAN JANUARY
2 FEB FEBRUARY
3 MAR MARCH
4 APR APRIL
5 MAY MAY
6 JUN JUNE
7 JUL JULY
8 AUG AUGUST
9 SEP SEPTEMBER
10 OCT OCTOBER
11 NOV NOVEMBER
12 DEC DECEMBER
Syntax
Month
Example
Example 1
You can use the spelled out (long) names for printing or for comparing to an actual
month:
Program File
If Month is December then print Month
Output
Saturday
Technical 04-16006-04-en, March 2015
1752
51 Script Programming
51.87 MONTH
Example 2
You can use the short names for comparing the month:
Program File
If Month is either JUN, JUL, AUG or SEP then…
Example 3
You can use the constants 1 through 12 for comparing the month:
Program File
If Month is 2 then…
04-16006-04-en, March 2015 Technical
1753
51 Script Programming
51.88 SECOND
51.88 SECOND
Alias: SEC
SECOND gives the exact number of seconds of the current minute, from 0 to 59.
The number of seconds is as indicated by the server clock. If the time is 10:02:12,
then SECOND equals 12.
Syntax
Second
Example
If you want to take action every time 50 seconds of the minute have gone by, you
enter the following program statement:
Program File
If Second is greater than 50 then…
Technical 04-16006-04-en, March 2015
1754
51 Script Programming
51.89 TOD
51.89 TOD
Alias: TIMEOFDAY
TOD gives the time of the day from 0 (midnight) to 2359, where 2359 is the
equivalent of 23:59 on the 24-hour clock.
The time of day is the time from the controller clock. You cannot change TOD since
the controller automatically updates that setting.
Syntax
TOD
Example
Example 1
To check to see if the time of day is past 5:00 AM, you enter the following program
line:
Program File
If TOD is greater than 500 then…
Example 2
When you print out TOD, as in the following example, you always receive the 24-
hour time:
Print TOD
The time displays as follows:
20.000 (that means 8:00:00 PM)
04-16006-04-en, March 2015 Technical
1755
51 Script Programming
51.90 WEEKDAY
51.90 WEEKDAY
Alias: WKD
WEEKDAY gives current day of week, from SUNDAY through SATURDAY.
When printed, the weekday is spelled out as Sunday, Monday, Tuesday,
Wednesday, and so on through Saturday.
You can also compare the WEEKDAY to:
• The numbers 1 through 7 (1 equal to Sunday).
• The abbreviated three-letter names (first three letters).
Note
• If you use both Script and Function Block programming, for example, when
using control sequences, be aware of the following. Script uses Sunday as
the first day of the week and assigns a value of 1 to that day, while Function
Block uses Monday as the first day of the week and assigns Monday a value
of 1.
All values for the weekday are as follows:
Table: WEEKDAY Values
Constant Short Name Long Name
1 SUN SUNDAY
2 MON MONDAY
3 TUE TUESDAY
4 WED WEDNESDAY
5 THU THURSDAY
6 FRI FRIDAY
7 SAT SATURDAY
Syntax
Weekday
Example
Example 1
You can spell out names for printing or for comparing to an actual day:
Program File
If Weekday is Saturday then Print Weekday
Output
Saturday
Example 2
Technical 04-16006-04-en, March 2015
1756
51 Script Programming
51.90 WEEKDAY
You can use the short name or the constants 1 through 7 for comparing the
weekday in an IF statement:
Program File
If Weekday > Sun OR Weekday < 7 then…
04-16006-04-en, March 2015 Technical
1757
51 Script Programming
51.91 YEAR
51.91 YEAR
Alias: YR
YEAR gives the current year. You cannot change the YEAR. The system
automatically updates the value.
When printed, the four-digit year is given.
Syntax
Year
Example
To take an action in the distant future, such as sending a reminder message to
check certain pieces of equipment, you use the YEAR system variable to test the
year:
Program File
If year is 2010 THEN PRINT "Welcome to the year Two Thousand and
Ten."
Technical 04-16006-04-en, March 2015
1758
51 Script Programming
51.92 Runtime System Variables
51.92 Runtime System Variables
Runtime system variables are variables the controller maintains.
51.92.1 ERRORS
ERRORS, a variable the controller maintains, indicates the number of system errors
pending. The number increments (increases by one) each time a new error occurs
and is cleared when manually reset to zero (0).
For more information, see section 51.93 “ERRORS” on page 1758..
51.92.2 FREEMEM
FREEMEM contains the number of bytes of free memory in the largest single
contiguous memory block on a controller.
For more information, see section 51.94 “FREEMEM” on page 1759..
51.92.3 SCAN
SCAN indicates the length in seconds of the last interpreter scan interval, which the
program updates regularly.
For more information, see section 51.95 “SCAN” on page 1760..
04-16006-04-en, March 2015 Technical
1759
51 Script Programming
51.93 ERRORS
51.93 ERRORS
ERRORS, a variable the controller maintains, indicates the number of system errors
pending. The number increments (increases by one) each time a new error occurs
and is cleared when manually reset to zero (0).
The controller automatically updates ERRORS. You can only reset the controller to
zero.
The controller increments ERRORS when any of the following occurs:
• A Script program error disables a program (which also sets the program
ERROR attribute).
• The controller’s input reference voltage goes out of its normal range, usually
when you apply too much voltage to one or more inputs.
• The controller’s output reference voltage goes out of its normal range, usually
when drawing too much current from one or more inputs.
• The server has trouble transmitting or receiving data.
• Someone resets a controller.
• Someone turns off the AC power to a controller so that the AC power shuts
down, but the battery retains memory.
Syntax
Errors
Example
Since the ERRORS variable automatically decrements after you acknowledge an
error, the value of the variable should never get very large.
In the sample program below, you set a limit to how many errors can accumulate
and generate a report on all errors if the limit is exceeded:
Program File
If Errors > 10 then
Goto Report_Error
Technical 04-16006-04-en, March 2015
1760
51 Script Programming
51.94 FREEMEM
51.94 FREEMEM
FREEMEM contains the number of bytes of free memory in the largest single
contiguous memory block on a controller.
For system managers only. Primarily designed to be used on the command line
only, not in programs, because the value of FREEMEM does not change
dynamically. Primarily, FREEMEM is used in the programs to slow the controller
scan.
Syntax
Freemem
Example
If you want to know the size of the largest block of free memory available on a
controller, enter the following:
Program File
Print Freemem
04-16006-04-en, March 2015 Technical
1761
51 Script Programming
51.95 SCAN
51.95 SCAN
Alias: SC
SCAN indicates the length in seconds of the last interpreter scan interval, which the
program updates regularly.
Syntax
Scan
Example
To find the average number of seconds per scan, you would run the following
program once every scan after all other programs have been run.
Program File
Numeric Tot_Scan_SCS, Scan_Count, Scan_Avg
Set Tot_Scan_SCS, Scan_Count, Scan_Avg = 0
Line Totaling
Tot_Scan_SCS = Tot_Scan_SCS + Scan
Scan_Count = Scan_Count + 1
If TOD = 2359 then
Scan_Avg = Tot_Scan_SCS/Scan_Count
Print "The average scan for", WKD " is", Scan_Avg, "sec"
Set Scan_Avg = 0
Set Scan_Count = 0
Set Tot_ScSCS = 0
Endif
For each scan the program adds the seconds that scan took to the total seconds
for the day. Also for each scan, the program adds 1 to the scan counter.
At the end of the day (2359, or 11:59 PM), the program divides the scan total by the
number of scans to get the average length of the scans that day. The program then
prints the average for the day.
The numeric variables used to calculate the average number of scans per day are all
set to zero at the end of each day, so that they start at zero the next day.
Technical 04-16006-04-en, March 2015
1762
51 Script Programming
51.96 Script Functions
51.96 Script Functions
A function is a routine designed to carry out an often repeated task or series of
tasks. Your Script function then becomes a subroutine that can be called whenever
that particular action needs to be performed.
When a function is used to calculate or provide a value, the function “returns” the
value to the program that calls the function. A program can also provide (“pass”) the
function some values (called “arguments”) to use in calculations or actions the
program must take. Arguments (separated by commas) are included in parentheses
following the function name. Function calls require parentheses, so you should
include the parentheses even if the function is empty (that is, function ()).
Note
Script functions support up to 15 arguments.
51.96.1 Script Function Workflow
In Script, you must declare a local variable of type Function and bind it to a Script
function object within the same device (for example, server or field bus).
For more information, see section 51.97 “Script Function Workflow” on page 1762.
51.96.2 Script Functions and Programs
You create a function just like you create a program, using standard Script
keywords, and then save that function to a file.
Functions perform specific tasks or calculations that return a resulting value. They
are simple and flexible and can make programs run in a much more efficient manner
by eliminating redundant tasks.
For more information, see section 51.101 “Script Functions and Programs” on page
1767.
51.96.3 System Functions
System functions carry out a particular set of calculations or actions and can return
one or more specific values, such as Sum, Sqrt, Length, and Avg.
For more information, see section 51.107 “System Functions” on page 1774.
04-16006-04-en, March 2015 Technical
1763
51 Script Programming
51.97 Script Function Workflow
51.97 Script Function Workflow
In Script, you must declare a local variable of type Function and bind it to a Script
function object within the same device (for example, server or field bus).
You do this as follows:
• Write a Script program and in that program, declare a local variable of the type,
Function. For more information, see section 51.103 “Declaring and Calling a
Script Function” on page 1770.
• Bind the local variable to the Script Function object.
For more information, see section 38.10 “Binding Values Using a Binding
Template” on page 1220.
For more information, see section 50.15 “Binding Values in Script Editor Using
a Binding Template” on page 1590.
• Use the name of that local variable to activate the function
You do so by using the Function keyword, thus enabling the program to refer to or
call the function, through its binding. This is similar to the way in which the program
calls a system function.
Tip
You can use the RETURN statement to return a value to the calling program or
function.
There are several different types of Script functions, including:
• Functions without arguments
• Functions with arguments
• Functions that return a value
51.97.1 Script Functions without Arguments
A function need not have arguments.
For more information, see section 51.98 “Script Functions without Arguments” on
page 1764.
51.97.2 Script Functions with Arguments
Functions can have valid Script expressions for arguments, including local variables
from the calling program, or function.
For more information, see section 51.99 “Script Functions with Arguments” on page
1765.
Technical 04-16006-04-en, March 2015
1764
51 Script Programming
51.97 Script Function Workflow
51.97.3 Script Functions that Return a Value
In addition to returning to the calling program, RETURN can also bring back the
results of a calculation. These results are: a variable, a constant, or an expression.
For more information, see section 51.100 “Script Functions that Return a Value” on
page 1766.
04-16006-04-en, March 2015 Technical
1765
51 Script Programming
51.98 Script Functions without Arguments
51.98 Script Functions without Arguments
A function need not have arguments. For example, you can define a function that
stops all fans and name that function FANSTOP.
Numeric Output Fan1, Fan2, Fan3, Fan4
Stop Fan1, Fan2, Fan3, AND Fan4
Return
Calling Program:
Function Fanstop
If TOD > 1800 and TOD < 800 then FanStop ( )
FANSTOP knows about the fans because they are points on the controller.
Technical 04-16006-04-en, March 2015
1766
51 Script Programming
51.99 Script Functions with Arguments
51.99 Script Functions with Arguments
Functions can have valid Script expressions for arguments, including local variables
from the calling program, or function.
The following example shows a function that starts and stops two programs.
ARG 1 Program1
ARG 2 Program2
Start Program1
Start Program2
Return
The calling program can send any two arguments to this function that can be acted
on by START or STOP. You can start and stop any object (piece of equipment) or
program.
04-16006-04-en, March 2015 Technical
1767
51 Script Programming
51.100 Script Functions that Return a Value
51.100 Script Functions that Return a Value
In addition to returning to the calling program, RETURN can also bring back the
results of a calculation. These results are: a variable, a constant, or an expression.
The following example shows a function that returns a value. In this case, the
RETURN statement contains an expression. The function returns the value of that
expression to the program.
ARG 1 Tmp1
ARG 2 Tmp2
ARG 3 Tmp3
ARG 4 Tmp4
Numeric Total_Change
Total_Change = (Tmp1 - Tmp2) + (Tmp2 - Tmp3) + (Tmp3 - Tmp4)
Return (Total_Change/3)
As shown below, you could also give the expression a local variable name.
ARG 1 Tmp1
ARG 2 Tmp2
ARG 3 Tmp3
ARG 4 Tmp4
Numeric Total_Change, Mid_Change
Total_Change = (Tmp1 - Tmp2) + (Tmp2 - Tmp3) + (Tmp3 - Tmp4)
Mid_Change = Total_Change/3
Return Mid_Change
Note
• Use a variable instead of an expression in the RETURN statement because
the name of the variable, when created, should generally describes its
purpose.
Technical 04-16006-04-en, March 2015
1768
51 Script Programming
51.101 Script Functions and Programs
51.101 Script Functions and Programs
You create a function just like you create a program, using standard Script
keywords, and then save that function to a file.
Functions perform specific tasks or calculations that return a resulting value. They
are simple and flexible and can make programs run in a much more efficient manner
by eliminating redundant tasks.
If your system performs complex calculations or processes repeatedly, you can
avoid retyping these programs every time you need them by making them
functions. You can think of these functions as tools you use to build larger
programs. To determine whether you need a function, look at the kinds of actions
you repeat. For example, suppose you repeatedly test for occupancy. You can
create a function that performs the task, then call that function whenever necessary.
An example of a function is a PID loop. Some PID loops can be very large and
contain cumbersome portions of programming code. Rather than clutter up a
program with the PID code, you can create a function that contains all of the PID
code. When you need to use the PID loop, you call the PID function. As a result, the
main program is much smaller and easier to understand.
You call functions in a Script program or function by declaring a function at the
beginning of the program or function in which you would like to use that function. A
function variable is a name that represents a Script function. Any function call using
the local variable name means a call to the actual function. For more information,
see section 51.102 “Function Declarations and Statements” on page 1768.
Be sure that any local variable of type Function declared in a program or function is
bound to an actual function object. If the local variable is declared, but not properly
bound, that program does not run.
51.101.1 Function Declarations and Statements
Unlike Script programs, Script functions do not support the concept of lines as
execution units. Instead, Script functions consist of declarations and statements.
For more information, see section 51.102 “Function Declarations and Statements”
on page 1768.
04-16006-04-en, March 2015 Technical
1769
51 Script Programming
51.102 Function Declarations and Statements
51.102 Function Declarations and Statements
Unlike Script programs, Script functions do not support the concept of lines as
execution units. Instead, Script functions consist of declarations and statements.
Declarations specify the arguments that the function takes, followed by the local
variables. Statements specify the actions the function must perform and must be
executed together. Typically, the function returns a value to the calling program.
Argument declarations begin with the ARG keyword. For example, the following
basic Script function, called myaverage, adds 3 variables and then determines their
average.
The optional comment preceded by the single quotation mark (') helps explain the
operation and purpose of the function. You can place comments either at the
beginning or end of the declaration or function as you wish.
Figure: Function Example
Once you finish creating the function, you then add a declaration (1) and a function
call (2) in the designated program to invoke that function.
Technical 04-16006-04-en, March 2015
1770
51 Script Programming
51.102 Function Declarations and Statements
Figure: Function Declaration and Call
04-16006-04-en, March 2015 Technical
1771
51 Script Programming
51.103 Declaring and Calling a Script Function
51.103 Declaring and Calling a Script Function
You can declare and call a Script function in a Script program or another Script
function. For example, you include a function as a subroutine and access it
repeatedly in the same program or any other program.
For more information, see section 51.102 “Function Declarations and Statements”
on page 1768.
To declare and call a Script function
1. In Script Editor, declare the function you want to call by using the keyword
Function before the name of the function.
2. Add the function call.
You have now declared and called a function in a Script program or another Script
function.
Technical 04-16006-04-en, March 2015
1772
51 Script Programming
51.104 Creating a Script Function
51.104 Creating a Script Function
You create Script functions so that you can program code that can be used in one
or several Script programs or functions.
For more information, see section 51.101 “Script Functions and Programs” on page
1767.
To create a Script function
1. In WorkStation, in the System Tree pane, select the server or folder where
you want to create the Script function.
2. On the File menu, point to New and then click Program.
3. In the object type list, select Script Function.
4. In the Name box, type a name for the Script function.
5. In the Description box, type a description for the Script function.
6. Click Create.
04-16006-04-en, March 2015 Technical
1773
51 Script Programming
51.105 Declaring a Script Function Argument
51.105 Declaring a Script Function Argument
You declare arguments at the beginning of the Script function where they are used.
The argument values are provided by the calling Script program or function.
For more information, see section 51.102 “Function Declarations and Statements”
on page 1768.
To declare a Script function argument
1. In Script Editor, declare the Script function arguments using the ARG
keyword.
You have now declared the arguments in the Script function. You can now add one
or more instructions that specify the operations to perform.
Technical 04-16006-04-en, March 2015
1774
51 Script Programming
51.106 Checking and Saving a Script Function
51.106 Checking and Saving a Script Function
You check your Script function to ensure there are no syntax errors. You perform a
save operation to check and then save your Script function.
For more information, see section 51.101 “Script Functions and Programs” on page
1767.
To check and save a Script function
1. In Script Editor, click Check.
2. In the Check pane, double-click on an error message to go to the line of code
that contains the error.
3. Click Save to check and save your Script function.
You have now checked and saved your Script function.
The Script Editor displays the Save Successful message, even if the function
contains errors and does not compile successfully.
If you save a function that contains errors, that function will not run. The function
must have a successful check prior to running.
04-16006-04-en, March 2015 Technical
1775
51 Script Programming
51.107 System Functions
51.107 System Functions
System functions carry out a particular set of calculations or actions and can return
one or more specific values, such as Sum, Sqrt, Length, and Avg.
For example, the system function SQRT returns the square root of a given number:
Result = SQRT (25)
The number on which the function operates (25) is included within the parentheses.
This function returns the value 5.
51.107.1 System Function Keywords
Script uses the following types of system function keywords:
• Buffered variable functions
• Conversion functions
• Mathematical functions
• Object functions
• Passed function
• Rounding functions
• Statistical functions
• String functions
• Time functions
• Trigonometric functions
Technical 04-16006-04-en, March 2015
1776
51 Script Programming
51.108 System Function Keywords
51.108 System Function Keywords
System functions carry out a particular set of calculations or actions and can return
one or more specific values, such as Sum, Sqrt, Length, and Avg.
Script uses the following types of system function keywords:
• Buffered variable functions
• Conversion functions
• Mathematical functions
• Object functions
• Passed function
• Rounding functions
• Statistical functions
• String functions
• Time functions
• Trigonometric functions
51.108.1 Buffered Variable Functions
Buffered variable functions perform input variable-related operations.
For more information, see section 51.109 “Buffered Variable Functions” on page
1779.
51.108.2 Conversion Functions
Conversion functions convert numeric or string variables.
Conversion functions include the following keywords:
• NUMTOSTR
• STRTODATE
• STRTONUM
For more information, see section 51.112 “Conversion Functions” on page 1783...
51.108.3 Mathematical Functions
Mathematical functions perform mathematical operations.
Mathematical functions include the following keywords:
• ABS
• EXPONENTIAL
• FACTORIAL
• LN
04-16006-04-en, March 2015 Technical
1777
51 Script Programming
51.108 System Function Keywords
• LOG
• RANDOM
• SQRT
• SUM
For more information, see section 51.116 “Mathematical Functions” on page
1788...
51.108.4 Object Functions
Object functions perform operations on mathematical objects.
Object functions include the following keywords:
• GETNAME
• ReadProperty
• Relinquish
• WriteProperty
For more information, see section 51.125 “Object Functions” on page 1799...
51.108.5 PASSED Function
The PASSED function keyword indicates whether or not the argument with the
arg_number has been passed into the current function. Returns TRUE (numeric 1) if
the argument is actually passed and FALSE (numeric 0) if not.
For more information, see section 51.130 “PASSED Function” on page 1808..
51.108.6 Rounding Functions
Rounding functions round numbers to the next integer and then return values.
Rounding functions include the following keywords:
• CEILING
• FLOOR
• ROUND
• TRUNCATE
For more information, see section 51.131 “Rounding Functions” on page 1809...
51.108.7 Statistical Functions
Statistical functions perform statistical operations.
Statistical functions include the following keywords:
• AVERAGE
• MAXIMUM
Technical 04-16006-04-en, March 2015
1778
51 Script Programming
51.108 System Function Keywords
• MAXITEM
• MINIMUM
• MINITEM
• StandardDeviation
For more information, see section 51.136 “Statistical Functions” on page 1814...
51.108.8 String Functions
String functions perform string-related operations.
String functions include the following keywords:
• ASC
• CHR
• LEFT
• LENGTH
• MID
• RIGHT
• SEARCH
• STRINGFILL
• TAB
For more information, see section 51.143 “String Functions” on page 1827...
51.108.9 Time Functions
Time functions perform time-related operations.
Time functions include the following keywords:
• DIFFTIME
• TIMEPIECE
For more information, see section 51.153 “Time Functions” on page 1839.. .
51.108.10 Trigonomentric Functions
Trigonometric functions return arccosine, arctangents, and arcsines of given
numbers.
Trigonometric functions include the following keywords:
• ACOS
• ASIN
• ATAN
• ATAN2
• COS
04-16006-04-en, March 2015 Technical
1779
51 Script Programming
51.108 System Function Keywords
• SIN
• TAN
For more information, see section 51.156 “Trigonometric Functions” on page
1843.. .
Technical 04-16006-04-en, March 2015
1780
51 Script Programming
51.109 Buffered Variable Functions
51.109 Buffered Variable Functions
Buffered variable functions perform input variable-related operations.
51.109.1 GetBufferSize
GetBufferSize returns the current buffer size (that is, the number of buffered values)
of a passed buffered input variable.
For more information, see section 51.110 “GetBufferSize” on page 1780.
51.109.2 GetBufferedValue
GetBufferedValue gets the next available value of the passed buffered input
variable. This function returns Success or Failure.
For more information, see section 51.111 “GetBufferedValue” on page 1782.
04-16006-04-en, March 2015 Technical
1781
51 Script Programming
51.110 GetBufferSize
51.110 GetBufferSize
GetBufferSize returns the current buffer size (that is, the number of buffered values)
of a passed buffered input variable.
Note
A returned value of 0 indicates that the passed argument is not a buffered input
variable, or that there is no buffered input variable value. If two or more arguments
are passed, the program goes to Line E if one exists. When the program goes to
Line E, it indicates that an error has occurred.
Syntax
GetBufferSize (variable_name)
Table: GetBufferSize Parameter
Parameter Description
variable_name The name of the passed input variable
whose buffer size you are querying.
Example
You can use the following program to check the buffer size and if the number of
items in the buffer exceeds 15, empty the buffer.
Program File
Technical 04-16006-04-en, March 2015
1782
51 Script Programming
51.110 GetBufferSize
Note
This program, BufferedVariablesTest.xml, is included in the Sample Import Files
folder in the Code Library. For more information, see section 52.24 “Working with
Code Library Sample Import Files” on page 1894.
04-16006-04-en, March 2015 Technical
1783
51 Script Programming
51.111 GetBufferedValue
51.111 GetBufferedValue
GetBufferedValue gets the next available value of the passed buffered input
variable. This function returns Success or Failure.
Note
If the returned value is zero, it is not a buffered input variable. If two or more
arguments are passed, the program is disabled or goes to Line E if one exists.
When the program goes to Line E, it indicates an error has occurred.
Syntax
GetBufferedValue (variable_name)
Table: GetBufferedValue Parameter
Parameter Description
variable_name The name of the passed input variable
whose next available value you wish to
determine.
Example
You declare two buffered input variables (BIn1 and BIn2) and two output variables in
this example. BIn1 has the same value every time it is used as expected until a call
is made to the function GetBufferedValue to obtain the next buffered value. This
example checks to see if there are any buffered values for BIn1 by calling the
GetBufferSize function and making sure that the number of buffered values is
greater than zero. Then, it gets the next available value from the buffer. BIn1
assumes that newly-obtained value.
Program File
Numeric Buffered Input BIn1
Numeric Buffered Input BIn2
Numeric Output Out1
Numeric Output Out2
Out1 = BIn1 + BIn1
Out2 = 0
While GetBufferSize (BIn2) > 0
if GetBufferedValue (BIn2) = Success then
Out2 = Out2 + Bin2 'add all buffered values
Endif
EndWhile
Technical 04-16006-04-en, March 2015
1784
51 Script Programming
51.112 Conversion Functions
51.112 Conversion Functions
Conversion functions convert numeric or string variables.
51.112.1 NUMTOSTR
NUMTOSTR converts a number in a numeric variable or other numeric form to a
string variable so the number can be used in string operations. NUMTOSTR returns
the converted string value.
For more information, see section 51.113 “NUMTOSTR” on page 1784...
51.112.2 STRTODATE
STRTODATE returns a datetime that corresponds to the particular date and time
you specify in the date_time. The controller has a unique number for each
understandable moment in time.
For more information, see section 51.114 “STRTODATE” on page 1785..
51.112.3 STRTONUM
STRTONUM converts a string that contains a number in a string variable or other
string form to a numeric variable for use in mathematical operations. StrToNum
returns the converted numeric value.
For more information, see section 51.115 “STRTONUM” on page 1787..
04-16006-04-en, March 2015 Technical
1785
51 Script Programming
51.113 NUMTOSTR
51.113 NUMTOSTR
NUMTOSTR converts a number in a numeric variable or other numeric form to a
string variable so the number can be used in string operations. NUMTOSTR returns
the converted string value.
Syntax
NumToStr ( number )
Table: NUMTOSTR Parameter
Parameter Description
number Any number or expression.
A number in a string variable can be used in
string operations..
Examples
The following program translates the number 240 into a string:
Program File
String Trans
Trans = NumToStr (240)
Print TRANS
TRANS is no longer numeric and cannot be used in calculations.
Technical 04-16006-04-en, March 2015
1786
51 Script Programming
51.114 STRTODATE
51.114 STRTODATE
Alias: STRTOTIME
STRTODATE returns a datetime that corresponds to the particular date and time
you specify in the date_time. The controller has a unique number for each
understandable moment in time.
The system uses this date_time to process information about the date and time. If
you print a variable that is equal to a STRTODATE, you receive the date_time.
Note
Be aware that STRTODATE converts a text string to local rather than UTC time.
To receive the date and time from STRTODATE, you must enter both the date and
the time in one continuous input line. You can position the time before the date on
that line, if you prefer.
You can set up the date in any reasonably interpretable format—using all numbers
or spelling the month as either the full word or the three-letter abbreviation. You can
also separate the month, day, and year with spaces, slashes, dashes, periods,
commas, or any combination of these punctuation characters.
DAY and MONTH If you prefer to put the day first, ensure that the day is obviously a
day. There are two ways that a day cannot be misinterpreted as a month:
• Spell the month as a word so that the day is the only other number so low.
• Use numbers for both month and day only if the day is greater than 12, since
any number between 1 and 12 could be a month.
The month can be any of the following options:
• JAN[UARY]
• FEB[RUARY]
• MAR[CH]
• APR[IL]
• MAY
• JUN[E]
• JUL[Y]
• AUG[UST]
• SEP[TEMBER]
• OCT[OBER]
• NOV[EMBER]
• DEC[EMBER]
YEAR
You must enter the year as a four-digit year after 2008.
WEEKDAY
Since the controller already knows the day of the week that corresponds to each
date, you don’t need the day. You can, however, place the day of the week after
the date. The day of week must be either the three-letter abbreviation or the
completely spelled-out name of the day.
04-16006-04-en, March 2015 Technical
1787
51 Script Programming
51.114 STRTODATE
The weekday can be any of the following options:
• MON[DAY]
• TUE[SDAY]
• WED[NESDAY]
• THU[RSDAY]
• FRI[DAY]
• SAT[URDAY]
• SUN[DAY]
TIME
You enter the time as the one- or two-digit hour and one- or two-digit minute
separated by a colon. You can type another colon and follow that colon with
seconds.
You can enter the time in 24-hour time or use regular time with AM or PM following.
The controller translates that time into the 24-hour clock. For example, you can
enter 3:00 PM which the controller automatically translates to 15:00:00.
The following formats are acceptable:
• hh:mm:ss [AM/PM]
• hh:mm [AM/PM]
Where AM and PM (upper- or lowercase) are optional and the following are true:
• hh is hours (00 – 23)
• mm is minutes (00 – 59)
• ss is seconds (00 – 59)
Syntax
StrToDate (date_time)
Table: STRTODATE Parameter
Parameter Description
date_time Any actual date and time in a string
(surrounded by quotation marks) or a name
that stands for a date and time.
Examples
Program File
CONV_DATE = StrToDate (‘SEPTEMBER-21-2000 11:00 pm’)
Technical 04-16006-04-en, March 2015
1788
51 Script Programming
51.115 STRTONUM
51.115 STRTONUM
Alias: VAL
STRTONUM converts a string that contains a number in a string variable or other
string form to a numeric variable for use in mathematical operations. StrToNum
returns the converted numeric value.
Once a number is in a numeric variable, the number can be used in mathematical
expressions and operations.
Syntax
StrToNum (string)
Table: STRTONUM Parameter
Parameter Description
string Any number in string form (in quotation
marks) or string expression that stands for a
number in text form.
If string is not a valid numeral or series of
numerals, STRTONUM fails. If STRTONUM
fails, the program either goes to LINE E (see
LINE keyword) or disables.
Examples
If you receive string input from the keyboard, but want the input to be numeric so
you can add another number, you use STRTONUM. The following program adds
the string (in quotation marks) that contains 78.5 to the number 92.8:
Program File
Numeric Trans
Trans = StrToNum ("78.5") + 92.8
Output
171.3
04-16006-04-en, March 2015 Technical
1789
51 Script Programming
51.116 Mathematical Functions
51.116 Mathematical Functions
Mathematical functions perform mathematical operations.
51.116.1 ABS
ABS returns the absolute value of number. The absolute value of any number,
positive or negative, is always the positive number.
For more information, see section 51.117 “ABS” on page 1790..
51.116.2 EXPONENTIAL
EXPONENTIAL returns a value equal to the base e raised to the number power.
For more information, see section 51.118 “EXPONENTIAL” on page 1791..
51.116.3 FACTORIAL
FACTORIAL returns the factorial of integer_expression.
For more information, see section 51.119 “FACTORIAL” on page 1792..
51.116.4 LN
LN returns the natural logarithm of any number_expression.
For more information, see section 51.120 “LN” on page 1793..
51.116.5 LOG
LOG returns the base 10 logarithm of integer_expression.
For more information, see section 51.121 “LOG” on page 1794..
51.116.6 RANDOM
RANDOM returns a random number from 0 to 32,767 using number. Random is
used to simulate real-life values to test programs.
For more information, see section 51.122 “RANDOM” on page 1795..
51.116.7 SQRT
SQRT returns the square root of the number.
Technical 04-16006-04-en, March 2015
1790
51 Script Programming
51.116 Mathematical Functions
For more information, see section 51.123 “SQRT” on page 1796..
51.116.8 SUM
SUM returns the sum of the listed items (Syntax 1), the sum of an array (Syntax 2),
or the sum of a numeric log (Syntax 3).
For more information, see section 51.124 “SUM” on page 1797.
04-16006-04-en, March 2015 Technical
1791
51 Script Programming
51.117 ABS
51.117 ABS
ABS returns the absolute value of number. The absolute value of any number,
positive or negative, is always the positive number.
Syntax
ABS (number)
Table: ABS Parameter
Parameter Description
number Any number or expression.
Examples
Example 1
You find the absolute value of -3 as follows:
Program File
Result=ABS(-3)
This statement sets RESULT to 3.
To maintain a setpoint temperature to within plus or minus 3 degrees, when the
temperature changes in either direction, the fan should blow in either the heating or
cooling as required.
In this situation, you should find the absolute value of the change to control the fan.
Whether the change is positive or negative makes no difference.
Example 2
Program File
If ABS(Temp_SP - Temp_2) >= 3 then run Fan_2
Technical 04-16006-04-en, March 2015
1792
51 Script Programming
51.118 EXPONENTIAL
51.118 EXPONENTIAL
Alias: EXP
EXPONENTIAL returns a value equal to the base e raised to the number power.
Syntax
Exponential (number)
Table: EXPONENTIAL Parameter
Parameter Description
number Any number or expression.
Examples
Example 1
Program File
EVAL = Exponential (0)
The result of e to the 0 power is 1. Because the EXPONENTIAL function returns 1,
EVAL is set to 1.
Example 2
Program File
R_VAL = Exponential (-1)
The result of e to the -1 power is 0.368, so R_VAL is set to 0.368.
04-16006-04-en, March 2015 Technical
1793
51 Script Programming
51.119 FACTORIAL
51.119 FACTORIAL
Alias: FACT
FACTORIAL returns the factorial of integer_expression.
Syntax
Factorial (integer_expression)
Table: FACTORIAL Parameters
Parameter Description
integer_expression Factorial (integer_expression)
The value returned is between 0 and pi (3.14159) radians.
Radians = degrees TIMES (3.14159/180).
Degrees = radians TIMES (180/3.14159).
Examples
The following statement sets FVAL to the result of factorial 3:
Program File
FVAL = Factorial (3)
The function returns 6, so FVAL = 6.
Technical 04-16006-04-en, March 2015
1794
51 Script Programming
51.120 LN
51.120 LN
LN returns the natural logarithm of any number_expression.
Syntax
LN (number_expression)
Table: LN Parameter
Parameter Description
integer_expression Any number not equal to zero.
Examples
Program File
LGVAL = LN(3.2)
The natural log is returned and placed in LGVAL.
04-16006-04-en, March 2015 Technical
1795
51 Script Programming
51.121 LOG
51.121 LOG
LOG returns the base 10 logarithm of integer_expression.
Syntax
LOG (number_expression)
Table: LOG Parameter
Parameter Description
integer_expression An integer greater than zero.
Examples
Program File
Result = LOG(10)
This statement sets RESULT equal to 1.
Technical 04-16006-04-en, March 2015
1796
51 Script Programming
51.122 RANDOM
51.122 RANDOM
Alias: RND
RANDOM returns a random number from 0 to 32,767 using number. Random is
used to simulate real-life values to test programs.
You must vary the number to generate different random sequences. If you do not
vary the number, you can see a repetitious pattern of values emerging over time.
Syntax
Random (number)
Table: RANDOM Parameter
Parameter Description
number Any number or expression.
You can omit number, but the parentheses
are required, as with all functions.
Examples
To simulate fluctuations of temperature between 50 and 70 degrees, you put any
number in the number. To generate a result in the range of 20 possible
temperatures, you divide the random number you generate by 32767, which gives
you a number between 0 and 1. Then multiply the result by 20. Finally, add 50
degrees to set the bottom of the range.
Program File
Random (8)/32767 times 20
Finally you add the bottom of the range you are trying to simulate to the random
number:
Program File
Temp = (Random (8)/32767 times 20) + 50
04-16006-04-en, March 2015 Technical
1797
51 Script Programming
51.123 SQRT
51.123 SQRT
SQRT returns the square root of the number.
Syntax
SQRT (number)
Table: SQRT Parameter
Parameter Description
number Any number or expression.
Examples
Program File
MVAL = SQRT (4)
The SQRT function returns 2 and the statement sets MVAL to 2.
Technical 04-16006-04-en, March 2015
1798
51 Script Programming
51.124 SUM
51.124 SUM
SUM returns the sum of the listed items (Syntax 1), the sum of an array (Syntax 2),
or the sum of a numeric log (Syntax 3).
Items in the list must all be either numbers or variables that contains numbers.
If any of the items in the list in Syntax 1 is an array or a log, the controller retrieves
the first item from the array or log and treats that item like any other single one in the
list.
Syntax
Format 1: Sum (numeric_list)
Format 2: Sum (numeric_array)
Format 3: Sum (numeric_log)
Table: SUM Parameters
Parameter Description
numeric_list One or more numbers or names that stand
for numbers, separated by commas.
numeric_array Any defined array that contains numbers.
numeric_log Any defined log that contains numbers.
Examples
Example 1
To sum several timers, you place them directly in the SUM function statement. You
list them in parentheses after SUM, as follows:
Program File
Total_Timers = Sum (Timer1, Timer2. Timer3, Timer4)
Example 2
You have been storing calculated values in an array called PARTTME. You then use
the sum on that array, as follows:
Program File
TotalTime = Sum (PartTime)
Example 3
You have been logging temperatures in a log for several hours. To find the sum of
them, you find the sum of that log, as follows:
Program File
HourlyTot = Sum (TempLog)
Example 4
You find the sum of several temperatures in a list, including the current value of
TEMPLOG, as follows:
Program File
HourlyAvg = Sum (Tmp801, Tmp802, TempLog)
04-16006-04-en, March 2015 Technical
1799
51 Script Programming
51.124 SUM
In this example, TEMPLOG is interpreted as the current value of TEMPLOG.
Technical 04-16006-04-en, March 2015
1800
51 Script Programming
51.125 Object Functions
51.125 Object Functions
Object functions perform operations on mathematical objects.
51.125.1 GETNAME
GETNAME changes the string to a name, such as the name of a defined point, so
the string can then be set to a value or used anywhere in the language that a point
name is allowed.
For more information, see section 51.126 “GETNAME” on page 1800...
51.125.2 ReadProperty
ReadProperty retrieves the value of a property of a BACnet object.
For more information, see section 51.127 “ReadProperty” on page 1804...
51.125.3 Relinquish
Relinquish relinquishes a command. (You may also use WriteProperty and pass no
argument for the value).
For more information, see section 51.128 “Relinquish” on page 1805..
51.125.4 WriteProperty
WriteProperty sets the value of a property of a BACnet object. The returned value is
either SUCCESS or FAILURE.
For more information, see section 51.129 “WriteProperty” on page 1806..
04-16006-04-en, March 2015 Technical
1801
51 Script Programming
51.126 GETNAME
51.126 GETNAME
GETNAME changes the string to a name, such as the name of a defined point, so
the string can then be set to a value or used anywhere in the language that a point
name is allowed.
Getname can be used to give one name to a series of items in the database that
have the same root in their names. Each of the names is made up of a root abutted
with (joined to) a variable.
Syntax
Getname (string)
Getname (string, bacnet_broadcast_flag)
Table: GETNAME Parameters
Parameter Description
string This argument can be either text (word or
words) or a text expression. The text
expression can be a known character or
characters combined with a changeable
character or characters to form one word. A
semicolon joins parts of the combined string
("TEMP";X gives TEMP1, TEMP2, TEMP3,
as X becomes 1, then 2, then 3).
The word formed in the string must be a
path name or a single-word name that you
have defined somewhere in the control
system software.
bacnet_broadcast_flag This argument is for BACnet controllers.
Using this argument, a Script program can
execute a GETNAME function
asynchronously, as a BACnet broadcast, to
find an object – usually on another BACnet
controller. The GETNAME function executes
Who Has – I Have BACnet broadcast.
Inserting this argument makes execution of
this function asynchronous. Enter either
TRUE or FALSEr:
• TRUE, 1, or any other numeric
expression not equal to zero
• FALSE, 0, or any other numeric
expression equal to FALSE
Enter TRUE (or equivalent numeric
expression) to send this Who Has – I Have
broadcast to other BACnet controllers on
the network, in search of the object.
Enter FALSE (or equivalent numeric
expression) to perform a search on the local
controller.
See Example 3 for an example of the
bacnet_broadcast_flag argument.
Technical 04-16006-04-en, March 2015
1802
51 Script Programming
51.126 GETNAME
Parameter Description
Examples
Example 1
In the following example, GETNAME converts the "TEMP"; ROOM string to the
TEMP1, TEMP2, and other temperature point names up to TEMP10. These points
have been defined on the controller. The program prints the values of the points:
Program File
Numeric room
Line SettingRoom
Set Room = 1
Goto PrintingTemp
Line PrintingTemp
Print Getname("Temp";ROOM) TO Printer1
Goto GettingRoom
Line GettingRoom
Set Room = Room + 1
If Room is less than 11 then
Goto PrintingTemp
Else
Stop
Endif
Example 2
You can use GETNAME to get the value of a point from more than one controller. In
this example, the controllers are VAV box controllers called ROOM1, ROOM2,
ROOM3, and so on, up to ROOM10. Since each ROOM controller has a TEMP
point, GETNAME can easily retrieve that point from each controller:
Program File
Numeric room
Line SettingRoom
Room = 1
Goto CheckingTemp
Line CheckingTemp
If Getname("ROOM";ROOM;" TEMP") > 75 then
Print "Room |## IS |###", ROOM, GETNAME("Room"; ROOM;" TEMP")
Endif
Goto GetNextRoom
Line GetNextRoom
If room >= 10 then Stop
Room = Room + 1
04-16006-04-en, March 2015 Technical
1803
51 Script Programming
51.126 GETNAME
Goto CheckingTemp
"Room"; ROOM; "Temp" gets the path to the TEMP point on the ROOM1 controller
first. Once the program gets the value of TEMP from each controller, the program
compares that value to the setpoint of 75. If the temperature is not at setpoint, the
program prints a message.
Example 3
Here is a program example using the bacnet_broadcast_flag argument:
Program File
Object ObjRef
Line GettingObject
ObjRef = Getname(“BCX2 \ ANALOGVALUE1”)
Line SettingObject
ObjRef = 72
Example 4
To get an attribute with GETNAME, you must include the full path in the GETNAME
string. (You cannot get the name and then follow that with an attribute.) Include the
attribute as follows:
Program File
Print Getname("Room"; room; "Temp VALUE")
Example 5
You can also get attributes of a point other than the value. This example retrieves
the STATE (enabled or disabled):
Program File
Print "The Lights are |*", Getname("Room";room;"Lights State")
Example 6
You can also get attributes of any other name defined in the control system
software, for example, the STATUS of a program called HEATING (active or
inactive):
Program File
Print "Status of Heating is|*",
Getname("Floor";FloorNum;"Heating STATUS")
Example 7
You can use GETNAME to generate a report on several points at a particular time.
For example, you can get the setting of the lights in a particular space, the status of
the lighting program, the setpoint at that time, the actual temperature at that time,
the airflow setpoint, and the actual airflow:
Program File
Numeric room
Line SetRoom
Room = 1
Print "Today’s Date and Time are ";DATE
Goto CheckRoom
Line CheckRoom
Technical 04-16006-04-en, March 2015
1804
51 Script Programming
51.126 GETNAME
Print "Room |## Status", room
Print "The lights are |$###", Getname("Room";room;"Lights")
Print "The lighting program is |*",
Getname("Floor";Num,"Lighting STATUS")
Print "The temperature setpoint is |##.#",
Getname("Room";room;"Setpt")
Print "The actual temperature is |##.#",
Getname("Room";room;"Temp")
Print "The airflow setpoint is |### cfm",
Getname("Room";room;"AirSetpt")
Print "The actual air flow is |### cfm",
Getname("Room";room;"AirFlow")
Goto GetNextRoom
Line GetNextRoom
If Room >=10 then stop
Room = Room + 1
Goto CheckRoom
04-16006-04-en, March 2015 Technical
1805
51 Script Programming
51.127 ReadProperty
51.127 ReadProperty
ReadProperty retrieves the value of a property of a BACnet object.
Syntax
ReadProperty (object_property, index)
Table: ReadProperty Parameters
Parameter Description
local var This is bound to the object property.
index This is optional. It applies only to an array-
type BACnet property. The index is ignored
when it is not applicable.
Products Supported
b3 series controllers, Automation Servers, Enterprise Servers
Examples
Example 1
Use ReadProperty to get a property value, without designating the property name:
Numeric Input AV1
Numeric Temp
Temp = ReadProperty (AV1)
Example 2
Use ReadProperty to get the description of an analog point and place it in a string
point:
String Input AV1_Description
String StringPoint
StringPoint = ReadProperty (AV1_Description)
Example 3
Use ReadProperty to get the value of a point, using index 3:
Numeric Input Indexed_Property
Numeric Temp
Temp = ReadProperty (Indexed_Property, 3)
Technical 04-16006-04-en, March 2015
1806
51 Script Programming
51.128 Relinquish
51.128 Relinquish
Relinquish relinquishes a command. (You may also use WriteProperty and pass no
argument for the value).
Either an application program or operator issues a command to write to the
commandable property of a BACnet object, or relinquishes a command issued at
an earlier time.
A relinquish operation is similar to a WriteProperty operation, except that it places a
NULL value in the Priority_Array corresponding to the appropriate priority. When
that occurs, the next lower priority, non-NULL position, takes control of the
property.
If all the priority table array elements are NULL, the commandable property
assumes the one defined in the Relinquish Default property of the object.
Note
• Present Value is the commandable property for the following classes: Analog
Output, Binary Output, Multistate Output, Analog Value, Multistate value,
Binary Value.
Syntax
Relinquish (object_property, priority)
Table: Relinquish Parameters
Parameter Description
local var Bound to object property.
priority Priority number, ranging from 1 (highest) to
16 (lowest).
This applies only to a BACnet commandable
property. For controllers: If not present, the
property value that matches priority 16, if
applicable, is used.
Products Supported
b3 series controllers, Automation Servers, Enterprise Servers
Example
Use Relinquish to relinquish the last command issued with priority 5. This statement
places a NULL in the fifth entry of the priority array (1-biased):
Numeric Output AV1
Relinquish (AV1,5)
04-16006-04-en, March 2015 Technical
1807
51 Script Programming
51.129 WriteProperty
51.129 WriteProperty
WriteProperty sets the value of a property of a BACnet object. The returned value is
either SUCCESS or FAILURE.
Syntax
WriteProperty (object_property, value, priority, index)
Table: WriteProperty Parameters
Parameter Description
local var Bound to an object property.
The object identifier and property identifier
are combined as one argument.
value Actual value to which the property is set.
This is optional. If it is not present, then the
next argument, priority, must be present to
perform a Relinquish command.
priority Priority number, ranging from 1 (highest) to
16 (lowest).
This is optional. It applies only to a BACnet
commandable property.
For controllers: If it is not present, priority 10,
if applicable, is used.
index This is optional. It applies only to an array-
type BACnet property. The index is ignored
whenever it is not applicable.
Products Supported
b3 series controllers, Automation Servers, Enterprise Servers
Examples
Example 1
Use WriteProperty to set the analog value of an object to 100.
‘Value property is assumed
Numeric Output AV1
WriteProperty (AV1, 100)
Example 2
Use WriteProperty to set the Present_Value property of an object to 100, using
priority 5:
Numeric Output AV1
WriteProperty (AV1, 100, 5)
Example 3
Use WriteProperty to relinquish a command using priority 5:
Technical 04-16006-04-en, March 2015
1808
51 Script Programming
51.129 WriteProperty
‘Value is not passed; This is equivalent to a relinquish
Numeric Output AV1
WriteProperty (AV1, , 5)
Exceptions
When an Automation Server or Enterprise Server program uses the WriteProperty
keyword to set the value of a BACnet object (including b3 objects), the value is
always written to priority 16. For example, if you bind the program’s output to an
analog value in $SERVER/BACnet Device/Application and add it to a task, the value
is written to the analog output’s priority 16.
To write to a specific priority in a BACnet object from an Automation Server or
Enterprise Server program, the program must be bound directly to the priority you
wish to write to. This means that the priority no longer gets passed an argument as
shown in the examples that follow.
‘bound to BACnet analog value AV1 Priority 5
Numeric output x
Numeric a
‘places the value of 100 into AV1 Priority 5 slot
WriteProperty (x, 100)
‘places the value of AV1 Priority 5 into variable a
a = ReadProperty (x)
‘relinquishes the AV1 Priority 5 value
Relinquish (x)
‘relinquishes the AV1 Priority 5 value
‘Value argument is not passed into the WriteProperty
‘function
WriteProperty (x, )
WriteProperty (x)
04-16006-04-en, March 2015 Technical
1809
51 Script Programming
51.130 PASSED Function
51.130 PASSED Function
The PASSED function keyword indicates whether or not the argument with the
arg_number has been passed into the current function. Returns TRUE (numeric 1) if
the argument is actually passed and FALSE (numeric 0) if not.
Syntax
Passed (arg_number)
Table: PASSED Parameter
Parameter Description
arg_number Returns TRUE (numeric 1) if the argument is
actually passed and FALSE (numeric 0) if
not.
Examples
You can create a function that takes an argument and checks to see if the
argument is passed. The function below returns the number of the argument that
has the highest value and also returns after finding the first argument that is not
passed. The function called MAXITEM, predefined in the language, is shown as
follows:
Function File
Numeric Count, Lastmax
Lastmax = 1
For Count = 1 TO 15
If not(Passed (Count)) then return (Lastmax)
If ARG[Count] > Lastmax then Lastmax = Count
Next Count
Technical 04-16006-04-en, March 2015
1810
51 Script Programming
51.131 Rounding Functions
51.131 Rounding Functions
Rounding functions round numbers to the next integer and then return values.
51.131.1 CEILING
CEILING rounds a number to the next larger integer on the number line and returns
that integer.
For more information, see section 51.132 “CEILING” on page 1810..
51.131.2 FLOOR
FLOOR returns the next smaller integer on the number line and returns that integer.
For more information, see section 51.133 “FLOOR” on page 1811..
51.131.3 ROUND
ROUND rounds a number to the nearest integer and returns that value.
For more information, see section 51.134 “ROUND” on page 1812..
51.131.4 TRUNCATE
TRUNCATE drops the fractional part of number and returns the integer.
For more information, see section 51.135 “TRUNCATE” on page 1813..
04-16006-04-en, March 2015 Technical
1811
51 Script Programming
51.132 CEILING
51.132 CEILING
CEILING rounds a number to the next larger integer on the number line and returns
that integer.
See ROUND for a comparison of all rounding functions.
Syntax
Ceiling (number)
Table: CEILING Parameter
Parameter Description
number Any number or expression.
Examples
Example 1
Program File
The following shows how the controller calculates the ceiling of -2.7:
Top = Ceiling(-2.7)
This statement returns -2.
Example 2
Program File
RndVal = Ceiling(4.3)
This statement returns 5.
Technical 04-16006-04-en, March 2015
1812
51 Script Programming
51.133 FLOOR
51.133 FLOOR
FLOOR returns the next smaller integer on the number line and returns that integer.
Syntax
Floor (number)
Table: FLOOR Parameter
Parameter Description
number Any number or expression. (See ROUND for
a comparison of all rounding functions.)
Examples
Example 1
Program File
TmpVar = Floor (42.7)
This statement returns 42.
Example 2
Program File
Result = Floor(-1.1)
This statement returns -2.
04-16006-04-en, March 2015 Technical
1813
51 Script Programming
51.134 ROUND
51.134 ROUND
ROUND rounds a number to the nearest integer and returns that value.
The number is any number or expression.
ROUND, CEILING, FLOOR, and TRUNCATE are similar, but differ in the following
ways:
• ROUND rounds up if the decimal is .5 or higher and down if the decimal is
below .5. ROUND (-1.7) gives -2 (see figure below).
• CEILING always rounds up. CEILING (-2.7) gives the closest higher number on
the number line, -2. For more information, see section 51.132 “CEILING” on
page 1810.
• FLOOR always rounds down. FLOOR (-3.8) gives the closest lower number on
the number line, -4. For more information, see section 51.133 “FLOOR” on
page 1811.
• TRUNCATE cuts off the decimal value. TRUNCATE (-3.8) gives the integer
without the decimal, -3.
The following table illustrates how the four functions differ:
Table: ROUND Functions
Function 4.2 4.7 -3.1 -3.7
ROUND 4 5 -3 -4
CEILING 5 5 -3 -3
FLOOR 4 4 -4 -4
TRUNCATE 4 4 -3 -3
Syntax
Round (number)
Parameter Description
number Any number or expression.
Examples
Example 1
Program File
Tmpvar = Round (-42.7)
This statement returns -43.
Example 2
Program File
Rndval = Round (4.3)
This statement returns 4.
Technical 04-16006-04-en, March 2015
1814
51 Script Programming
51.135 TRUNCATE
51.135 TRUNCATE
Alias: TRUNC
TRUNCATE drops the fractional part of number and returns the integer.
Syntax
Truncate (number)
Table: TRUNCATE Parameter
Parameter Description
number Any number or expression.
Examples
Example 1
Program File
CHP = Truncate (4.5)
TRUNCATE returns 4 and the program statement sets CHP to 4.
Example 2
Program File
VAL_C = Truncate (-1.7)
TRUNCATE returns -1 and the program statement sets VAL_C to -1.
04-16006-04-en, March 2015 Technical
1815
51 Script Programming
51.136 Statistical Functions
51.136 Statistical Functions
Statistical functions perform statistical operations.
51.136.1 AVERAGE
AVERAGE returns the average of a list of items, the average of the items in an array
you name, or the average of the items in the log you name.
For more information, see section 51.137 “AVERAGE” on page 1815..
51.136.2 MAXIMUM
MAXIMUM finds the maximum number in a list of numeric values, a numeric array,
or a numeric log.
For more information, see section 51.138 “MAXIMUM” on page 1817..
51.136.3 MAXITEM
MAXITEM finds the position of the largest number in a list, an array, or a log. For
example, MAXITEM returns 1 if the largest number is the first one in the list.
For more information, see section 51.139 “MAXITEM” on page 1819..
51.136.4 MINIMUM
MINIMUM finds the minimum number in a list of numeric values, a numeric array, or
a numeric log.
For more information, see section 51.140 “MINIMUM” on page 1821..
51.136.5 MINITEM
MINITEM finds the position of the smallest number in a list, an array, or log. For
example, MINITEM returns 1 if the smallest number is the first one in the list.
For more information, see section 51.141 “MINITEM” on page 1823..
51.136.6 StandardDeviation
StandardDeviation finds the standard deviation of a series of numbers.
For more information, see section 51.142 “StandardDeviation” on page 1825..
Technical 04-16006-04-en, March 2015
1816
51 Script Programming
51.137 AVERAGE
51.137 AVERAGE
Alias: AVG
AVERAGE returns the average of a list of items, the average of the items in an array
you name, or the average of the items in the log you name.
Syntax
Format 1: Average (numeric_list)
Format 2: Average (numeric_array)
Format 3: Average (numeric_log)
• Format 1 is supported in Building Operation and in field devices, such as b3
BACnet devices.
• Format 2 is supported for local variables declared in a program in Building
Operation and in field devices, such as b3 BACnet devices.
• Format 2 is not supported in a Script program running on a Building Operation
server, such as an Automation Server or Enterprise Server. This is true for
binding variables bound to a numeric, manual, array external to the program.
• Format 3 is supported in a program running in a field device like a b3 BACnet
device that accesses a numeric log.
• Format 3 is not supported in a Script program running in a Building Operation
server, such as an Automation Server or Enterprise Server. This is true for
binding variables bound to any numeric log in the server itself or any other
device, including field devices like b3 BACnet devices.
Table: AVERAGE Parameters
Parameter Description
numeric_list One or more numbers or names that stand
for number, separated by commas.
numeric_array Any defined array that contains numbers.
numeric_log Any defined log that contains numbers.
Items in the list must all be either numbers or variables that contain numbers.
Element numbers are not required. Omitting element numbers averages the entire
array or log.
Examples
Example 1
To average several temperatures, you place them directly in the AVERAGE function
statement. You list them in parentheses after AVERAGE, as follows:
Program File
Flr8_AVG = Average (TMP801, TMP802, TMP803, TMP804)
Example 2
Since you know a certain temperature varies, you have been storing readings in an
array called OAT. You then use the AVERAGE function on that array, as follows:
04-16006-04-en, March 2015 Technical
1817
51 Script Programming
51.137 AVERAGE
Program File
OAT_AVG = Average (OAT)
Example 3
You have been logging temperatures in a log, called TEMPLOG, for several hours.
To find their average, you use the AVERAGE function as follows:
Program File
HourlyAVG = Average (TEMPLOG)
Technical 04-16006-04-en, March 2015
1818
51 Script Programming
51.138 MAXIMUM
51.138 MAXIMUM
Alias: MAX
MAXIMUM finds the maximum number in a list of numeric values, a numeric array,
or a numeric log.
Syntax
Format 1: Maximum (numeric_list)
Format 2: Maximum (numeric_array)
Format 3: Maximum (numeric_log)
• Format 1 is supported in Building Operation and in field devices, such as b3
BACnet devices.
• Format 2 is supported for local variables declared in a program in Building
Operation and in field devices, such as b3 BACnet devices.
• Format 2 is not supported in a Script program running on a Building Operation
server, such as an Automation Server or Enterprise Server. This is true for
binding variables bound to a numeric, manual, array external to the program.
• Format 3 is supported in a program running in a field device like a b3 BACnet
device that accesses a numeric log.
• Format 3 is not supported in a Script program running in a Building Operation
server, such as an Automation Server or Enterprise Server. This is true for
binding variables bound to any numeric log in the server itself or any other
device, including field devices like b3 BACnet devices.
Table: MAXIMUM Parameters
Parameter Description
numeric_list One or more numbers or names that stand
for numbers, separated by commas.
numeric_array Any defined array that contains numbers.
numeric_log Any defined log that contains numbers.
Items in the list must all be either numbers or variables that contain numbers.
If any of the items in the list in Format 1 is an array or a log but does not indicate an
element number, the controller retrieves the current value of the point and treats
that point like any other single item in the list.
Examples
Example 1
The MAXIMUM function finds the maximum number in a list of variables as follows:
Program File
TOPNUMBER = Maximum (Zone1, Zone2, Zone3, Zone4)
The TOPNUMBER variable is assigned the maximum value found.
Example 2
04-16006-04-en, March 2015 Technical
1819
51 Script Programming
51.138 MAXIMUM
You can find the maximum number of kilowatts (KW) in the array of variables as
follows:
Program File
TOPNUMBER = Maximum (KW)
Example 3
You find the highest of several temperatures, including the current value of
TEMPLOG, as follows:
Program File
TOPNUMBER = Maximum (TMP801, TMP802, TEMPLOG)
In this example, TEMPLOG is interpreted as the current value of TEMPLOG.
Technical 04-16006-04-en, March 2015
1820
51 Script Programming
51.139 MAXITEM
51.139 MAXITEM
MAXITEM finds the position of the largest number in a list, an array, or a log. For
example, MAXITEM returns 1 if the largest number is the first one in the list.
Syntax
Format 1: Maxitem (numeric_list)
Format 2: Maxitem (numeric_array)
Format 3: Maxitem (numeric_log)
• Format 1 is supported in Building Operation and in field devices, such as b3
BACnet devices.
• Format 2 is supported for local variables declared in a program in Building
Operation and in field devices, such as b3 BACnet devices.
• Format 2 is not supported in a Script program running on a Building Operation
server, such as an Automation Server or Enterprise Server. This is true for
binding variables bound to a numeric, manual, array external to the program.
• Format 3 is supported in a program running in a field device like a b3 BACnet
device that accesses a numeric log.
• Format 3 is not supported in a Script program running in a Building Operation
server, such as an Automation Server or Enterprise Server. This is true for
binding variables bound to any numeric log in the server itself or any other
device, including field devices like b3 BACnet devices.
Table: MAXITEMS Parameters
Parameter Description
numeric_list One or more numbers or names that stand
for numbers, separated by commas.
numeric_array Any defined array that contains numbers.
numeric_log Any defined log that contains numbers.
If any of the items in the list in Format 1 is an array or a log, the controller retrieves
the first item from the array or log and treats that item like any other single item in
the list.
Examples
Example 1
To find the position of the largest number in a series of numbers, you enter the
series in the parentheses:
Program File
Temp1 = 60
Temp2 = 65
Temp3 = 70
Temp4 = 67
Maxitem (Temp1, Temp2, Temp3, Temp4)
04-16006-04-en, March 2015 Technical
1821
51 Script Programming
51.139 MAXITEM
The Maxitem statement returns 3, because the third item in the list contains the
largest number.
Example 2
To find the index position of the largest number in an array, you give the array name
in parentheses:
Program File
Maxitem (KW)
Example 3
To find the index position of the largest number in a log, you give the log name in
parentheses:
Program File
Maxitem(Temp)
Example 4
You find the position of the highest of several temperatures in a list, including the
current value of TEMPLOG, as follows:
Program File
Maxindex = Maxitem (TMP801, TMP802, TEMPLOG)
In this example, TEMPLOG is interpreted as the current value of TEMPLOG.
Technical 04-16006-04-en, March 2015
1822
51 Script Programming
51.140 MINIMUM
51.140 MINIMUM
MINIMUM finds the minimum number in a list of numeric values, a numeric array, or
a numeric log.
Items in the list must all be either numbers or variables that contains numbers.
If any of the items in the list in Format 1 is an array or a log but does not indicate an
element number, the controller retrieves the current value of the point and treats
that value like any other single item in the list.
Syntax
Format 1: Minimum (numeric_list)
Format 2: Minimum (numeric_array)
Format 3: Minimum (numeric_log)
• Format 1 is supported in Building Operation and in field devices, such as b3
BACnet devices.
• Format 2 is supported for local variables declared in a program in Building
Operation and in field devices, such as b3 BACnet devices.
• Format 2 is not supported in a Script program running on a Building Operation
server, such as an Automation Server or Enterprise Server. This is true for
binding variables bound to a numeric, manual, array external to the program.
• Format 3 is supported in a program running in a field device like a b3 BACnet
device that accesses a numeric log.
• Format 3 is not supported in a Script program running in a Building Operation
server, such as an Automation Server or Enterprise Server. This is true for
binding variables bound to any numeric log in the server itself or any other
device, including field devices like b3 BACnet devices.
Table: MINIMUM Parameters
Parameter Description
numeric_list One or more numbers or names that stand
for numbers.
numeric_array Any defined array that contains numbers.
numeric_log Any defined log that contains numbers.
Examples
Example 1
The MINIMUM function finds the minimum number in a list of variables as follows:
Program File
BotNumber = Minimum (Zone1, Zone2, Zone3, Zone4)
The BotNumber variable is assigned the minimum value found.
Example 2
You can find the minimum number of kilowatts in the array of variables as follows:
Program File
04-16006-04-en, March 2015 Technical
1823
51 Script Programming
51.140 MINIMUM
BottomNumber = Minimum (KW)
Example 3
You find the minimum of several temperatures, including the current value of
TEMPLOG, as follows:
Program File
BottomNumber = Minimum (TMP801, TMP802, TEMPLOG)
In this example, TEMPLOG is interpreted as the current value of TEMPLOG.
Example 4
You have a log called AV_TEMP that holds the average temperature for each of the
last five days. You can use the MINIMUM function to find the minimum temperature:
Program File
WklyMin = Minimum (AV_TEMP)
If AV_TEMP contains 110, 114, 112, 108, 109, MINIMUM returns 108 and the
program statement sets WKLYMIN to 108.
Technical 04-16006-04-en, March 2015
1824
51 Script Programming
51.141 MINITEM
51.141 MINITEM
MINITEM finds the position of the smallest number in a list, an array, or log. For
example, MINITEM returns 1 if the smallest number is the first one in the list.
If any of the items in the list in Format 1 is an array or a log, the controller retrieves
the first item from the array or log and treats that item like any other single item in
the list.
Syntax
Format 1: Minitem (numeric_list)
Format 2: Minitem (numeric_array)
Format 3: Minitem (numeric_log)
• Format 1 is supported in Building Operation and in field devices, such as b3
BACnet devices.
• Format 2 is supported for local variables declared in a program in Building
Operation and in field devices, such as b3 BACnet devices.
• Format 2 is not supported in a Script program running on a Building Operation
server, such as an Automation Server or Enterprise Server. This is true for
binding variables bound to a numeric, manual, array external to the program.
• Format 3 is supported in a program running in a field device like a b3 BACnet
device that accesses a numeric log.
• Format 3 is not supported in a Script program running in a Building Operation
server, such as an Automation Server or Enterprise Server. This is true for
binding variables bound to any numeric log in the server itself or any other
device, including field devices like b3 BACnet devices.
Table: MINITEM Parameters
Parameter Description
numeric_list One or more numbers or names that stand
for numbers.
numeric_array Any defined array that contains numbers.
numeric_log Any defined log that contains numbers.
Examples
Example 1
To find the position of the smallest number in a series of numbers, you enter the
series in the parentheses:
Program File
Temp1 = 60
Temp2 = 65
Temp3 = 70
Temp4 = 67
Minitem (Temp1, Temp2, Temp3, Temp4)
04-16006-04-en, March 2015 Technical
1825
51 Script Programming
51.141 MINITEM
The MINITEM statement returns 2, because the second item in the list contains the
smallest number.
Example 2
To find the index position of the smallest number in an array, you give the array
name in parentheses:
Program File
Minindex = Minitem (KW)
Example 3
To find the index position of the smallest number in a log, called TEMPLOG, you
give the log name in parentheses:
Program File
Minindex = Minitem (TEMPLOG)
Example 4
You find the position of the lowest of several temperatures in a list, including the
current value of TEMPLOG, as follows:
Program File
Minindex = Minitem(TMP801, TMP802, TEMPLOG)
In this example, TEMPLOG is interpreted as the current value of TEMPLOG.
Technical 04-16006-04-en, March 2015
1826
51 Script Programming
51.142 StandardDeviation
51.142 StandardDeviation
Alias: SD
StandardDeviation finds the standard deviation of a series of numbers.
The standard deviation is the result of the following steps:
Table: Finding the Standard Deviation
Step Action
1 Find the average of the list.
2 Find the differences between the average
and each number.
If the average is 110 and one of the numbers
is 112 that difference is 2.
3 Square the differences, so 2 becomes 4.
4 Add up the squares and find the average of
them.
5 Take the square root of the average.
Items in the list must all be either numbers or variables that contain numbers.
If any of the items in the list in Format 1 is an array or a log but does not indicate an
element number, the controller retrieves the current value of the point and treats
that point like any other single item in the list.
Syntax
Format 1: StandardDeviation (numeric_list)
Returns the standard deviation of the listed items.
Format 2: StandardDeviation (numeric_array)
Returns the standard deviation of the items in the array.
Format 3: StandardDeviation (numeric_log)
Returns the standard deviation of the items in the log.
• Format 1 is supported in Building Operation and in field devices, such as b3
BACnet devices.
• Format 2 is supported for local variables declared in a program in Building
Operation and in field devices, such as b3 BACnet devices.
• Format 2 is not supported in a Script program running on a Building Operation
server, such as an Automation Server or Enterprise Server. This is true for
binding variables bound to a numeric, manual, array external to the program.
• Format 3 is supported in a program running in a field device like a b3 BACnet
device that accesses a numeric log.
• Format 3 is not supported in a Script program running in a Building Operation
server, such as an Automation Server or Enterprise Server. This is true for
binding variables bound to any numeric log in the server itself or any other
device, including field devices like b3 BACnet devices.
04-16006-04-en, March 2015 Technical
1827
51 Script Programming
51.142 StandardDeviation
Table: StandardDeviation Parameters
Parameter Description
numeric_list One or more numbers or names that stand
for numbers, separated by commas.
numeric_array Any defined array that contains numbers.
numeric_log Any defined log that contains numbers.
Examples
Example 1
To find the standard deviation of several temperatures, you place them directly in
the STANDARDDEVIATION statement. You list them in parentheses as follows:
Program File
TempDev = StandardDeviation (70, 72, 74)
The standard deviation returned is 2.
Example 2
Since you know a certain temperature varies, you have been storing readings in an
array called VARTMP. You then use the STANDARDDEVIATION function on that
array, as follows:
Program File
Variation = StandardDeviation (VARTMP)
Example 3
You have been logging temperatures in a log for several hours. You find the
standard deviation of them as follows:
Program File
Deviance = StandardDeviation (TEMPLOG)
Example 4
You find the standard deviation of several temperatures in a list, including the
current value of TEMPLOG, as follows:
Program File
StdDev = StandardDeviation (TMP1, TMP2, TEMPLOG)
In this example, TEMPLOG is interpreted as the current value of TEMPLOG.
Technical 04-16006-04-en, March 2015
1828
51 Script Programming
51.143 String Functions
51.143 String Functions
String functions perform string-related operations.
51.143.1 ASC
ASC returns the ASCII value of the first character of the string.
For more information, see section 51.144 “ASC” on page 1829..
51.143.2 CHR
CHR returns one character whose ASCII code is number. CHR can be used to
send non-printing characters to a terminal, computer, or printer to initiate action.
For more information, see section 51.145 “CHR” on page 1830..
51.143.3 LEFT
LEFT returns a string consisting of the leftmost characters of string with a length
specified by integer.
For more information, see section 51.146 “LEFT” on page 1831..
51.143.4 LENGTH
LENGTH returns the number of characters in the string.
For more information, see section 51.147 “LENGTH” on page 1832..
51.143.5 MID
MID returns a string number character extracted from the string starting at offset.
For more information, see section 51.148 “MID” on page 1833..
51.143.6 RIGHT
RIGHT returns the number of requested characters (the integer) from the text string
starting from the right side (end) and counting left.
For more information, see section 51.149 “RIGHT” on page 1834..
04-16006-04-en, March 2015 Technical
1829
51 Script Programming
51.143 String Functions
51.143.7 SEARCH
SEARCH returns the position of the given search_string within string or 0 if the
controller can’t find the search_string.
For more information, see section 51.150 “SEARCH” on page 1835..
51.143.8 STRINGFILL
STRINGFILL returns a string of number length containing a particular character that
you specify with the ASCII character code named by character code.
For more information, see section 51.151 “STRINGFILL” on page 1836..
51.143.9 TAB
TAB returns a series of continuous blank spaces. The number of blank spaces is
number.
For more information, see section 51.152 “TAB” on page 1838..
Technical 04-16006-04-en, March 2015
1830
51 Script Programming
51.144 ASC
51.144 ASC
ASC returns the ASCII value of the first character of the string.
Syntax
ASC (string)
Table: ASC Parameter
Parameter Description
string Any text (word or words) or text expression
Examples
This statement returns 83, which is the ASCII value of the character S:
Program File
ASC ("S")
04-16006-04-en, March 2015 Technical
1831
51 Script Programming
51.145 CHR
51.145 CHR
CHR returns one character whose ASCII code is number. CHR can be used to
send non-printing characters to a terminal, computer, or printer to initiate action.
Syntax
CHR (number)
Table: CHR Parameter
Parameter Description
number Any number or expression.
Examples
Example 1
After several pages of messages print, you then want to send a report to that
printer.
You make sure the report starts on a clean sheet of paper by sending an instruction
telling the printer to bring the paper to the top of a new page. This action is called a
formfeed. The code to generate a formfeed is 12. You write the formfeed as follows:
Program File
‘Generate a formfeed and report title
Print CHR(12); "Weekly Energy Report"
Example 2
Another way to use the CHR function is to send a bell to a terminal, computer, or
printer to warn that the ERRORS variable has reached a critically high value. The
ASCII code to generate a bell sound is 7. You write the errors variable notification as
follows:
Program File
‘Decides if too many errors are not acknowledged and generates a
bell
If errors > 15 then print CHR(7)
Technical 04-16006-04-en, March 2015
1832
51 Script Programming
51.146 LEFT
51.146 LEFT
Alias: FIRST
LEFT returns a string consisting of the leftmost characters of string with a length
specified by integer.
Syntax
Left (string, integer)
Table: LEFT Parameters
Parameter Description
string Any text (word or words) or text expression.
integer Any integer or integer expression up to the
length of the string that tells how many
characters you want from the string.
If integer is greater than the length of the
string then the controller returns the entire
string.
Examples
Example 1
Program File
LVAL = Left("ABCDEF", 2)
This statement returns AB.
Example 2
Suppose that the TEXT variable contains ROOM808; the following statement
retrieves the word ROOM by carrying out the LEFT function:
Program File
LVAL = Left(TEXT, 4)
This statement returns ROOM.
04-16006-04-en, March 2015 Technical
1833
51 Script Programming
51.147 LENGTH
51.147 LENGTH
Alias: LEN
LENGTH returns the number of characters in the string.
Syntax
Length (string)
Table: LENGTH Parameter
Parameter Description
string Any text (word or words) or text expression.
Examples
Example 1
Program File
Result = Length ("ABCDE")
The LENGTH function returns 5 and the statement sets RESULT to 5.
Example 2
Program File
Result = Length ("")
The LENGTH function returns 0 and the statement sets RESULT to 0.
Technical 04-16006-04-en, March 2015
1834
51 Script Programming
51.148 MID
51.148 MID
MID returns a string number character extracted from the string starting at offset.
Syntax
MID (string, offset, number)
Table: MID Parameters
Parameter Description
string Any text (word or words) or text expression.
offset The number (or a variable that contains the
number) of the position where you want the
controller to start extracting the string of
characters.
If offset is greater than the length of the
string expression, then MID returns the
empty string, " ".
number Any number or expression. Tells how many
characters you want extracted from the text
string.
Examples
Example 1
Program File
MIDSTR = MID("ABCDE", 2, 3)
MID returns BCD and the statement sets MIDSTR to BCD.
Example 2
Program File
PARTSTR = MID (ABCDE, 9, 2) returns " ".
04-16006-04-en, March 2015 Technical
1835
51 Script Programming
51.149 RIGHT
51.149 RIGHT
Alias: LAST
RIGHT returns the number of requested characters (the integer) from the text string
starting from the right side (end) and counting left.
Syntax
Right ( string, integer )
Table: RIGHT Parameters
Parameter Description
string Any text (word or words) or text expression.
integer Any integer or integer expression up to the
length of the string that tells how many
characters you want from the string.
If integer is greater than the length of the
string, then the controller returns the entire
string.
Example
Program File
RGTVAL = Right ("ABCDE", 3)
This statement returns CDE.
Technical 04-16006-04-en, March 2015
1836
51 Script Programming
51.150 SEARCH
51.150 SEARCH
SEARCH returns the position of the given search_string within string or 0 if the
controller can’t find the search_string.
Syntax
Search (string, search_string)
Table: SEARCH Parameters
Parameter Description
string Any text (word or words) or text expression.
search_string Any text (word or words) that you want to
search for in the string.
Examples
Example 1
Program File
NSTR = Search ("ABCDE", "BC")
The search returns 2 and sets NSTR to 2, the position BC starts at in the string.
Example 2
Program File
NSTR = Search ("ABCDE", "CB")
The search returns 0 and sets NSTR to 0 because CB is not in the string.
04-16006-04-en, March 2015 Technical
1837
51 Script Programming
51.151 STRINGFILL
51.151 STRINGFILL
STRINGFILL returns a string of number length containing a particular character that
you specify with the ASCII character code named by character code.
Syntax
Stringfill (number, charactercode)
Table: STRINGFILL Parameters
Parameter Description
number Any number or expression. Gives the length
of the string.
charactercode The ASCII character code of the character
you want to fill the string.
Examples
Example 1
Suppose you want to print a series of 60 asterisks across the top of a report. You
use STRINGFILL to print the asterisks by providing the number 60 for the number of
asterisks, and the number 42 as the ASCII code for the asterisk, as follows:
Print Stringfill(60, 42)
Example 2
You can draw dashed horizontal lines in a report using STRINGFILL by providing
the number of spaces you want the line to print across (60) and the ASCII code for a
dash (45):
Report File
Print Stringfill(60, 45)
Example 3
Suppose you want to design a graph to show the peak kilowatt demand for each
day in the last week. You can create a bar graph by filling the appropriate number of
spaces with, for example, asterisks. The following program sets up such a graph:
Program File
Numeric ShortDays, DayX
Print "Peak KW Demand for Week"
Print " "
For DayX = 1 TO 7
Print ST(ShortDays, DayX);" | "; ~
Stringfill (KWD[DayX]/100, 42)
Next DayX
Print " +----+----+----+----+----+"
Print " 0 500 1000 1500 2000 2500 "
The program prints the title and proceeds to a FOR...NEXT loop.
Technical 04-16006-04-en, March 2015
1838
51 Script Programming
51.151 STRINGFILL
Inside the FOR...NEXT loop, the program first prints the short name of the weekday,
based on the number for the day (1 for SUN) using a customized function called ST.
Next, the program prints a plus sign after the name.
STRINGFILL then uses two values to print the kilowatt demand for that day:
Kilowatt demand for the day from the KWD array (KWD[1] = Sunday’s kilowatt
demand, KWD[2] = Monday’s kilowatt demand, and KWD[3] = Tuesday’s kilowatt
demand, and so on.
ASCII code for the asterisk (42).
To see how STRINGFILL uses these two values, take a look at Sunday in the graph
the program produces:
Program File Output
PEAK KWDEMAND FOR WEEK
SUN +******
MON +**********
TUE +********
WED +*********
THU +*******
FRI +********
SAT +***
+---+-----+-----+-----+-----+
0 500 1000 1500 2000 2500
First the program retrieves Sunday’s kilowatt demand from the KWD array.
Sunday’s kilowatt demand is 600 Kw. The program divides the demand by 100,
giving 6. So STRINGFILL prints six asterisks for Sunday.
The program then retrieves Monday’s kilowatt demand from the KWD array.
Monday’s kilowatt demand is 1000 Kw. The program divides the demand by 100,
giving 10. So STRINGFILL prints 10 asterisks for Monday.
The program continues to carry out the same process for each day of the week.
After printing Saturday’s kilowatt demand, the program prints the scale for the
graph, which displays 0 to 2500 Kw.
04-16006-04-en, March 2015 Technical
1839
51 Script Programming
51.152 TAB
51.152 TAB
TAB returns a series of continuous blank spaces. The number of blank spaces is
number.
Syntax
Tab (number)
Table: TAB Parameter
Parameter Description
number Any number or expression.
The number represents the number of
spaces you want to push the printed text to
the right, as on a typewriter. Must be less
than 132.
Examples
Program File
Print Tab (10); "This is a Title"
Output
This is a Title
The text is moved ten spaces to the right.
Technical 04-16006-04-en, March 2015
1840
51 Script Programming
51.153 Time Functions
51.153 Time Functions
Time functions perform time-related operations.
51.153.1 DIFFTIME
DIFFTIME calculates the difference in whole seconds, minutes, hours, or days
between two dates and times, date_time1 and date_time2. (Subtracts date_time1
from date_time2.)
For more information, see section 51.154 “DIFFTIME” on page 1840..
51.153.2 TIMEPIECE
TIMEPIECE retrieves the piece of time (hour, minute, second) or the piece of the
date (weekday, month, day of the month, year, day of the year) from a variable or
point.
For more information, see section 51.155 “TIMEPIECE” on page 1842..
04-16006-04-en, March 2015 Technical
1841
51 Script Programming
51.154 DIFFTIME
51.154 DIFFTIME
DIFFTIME calculates the difference in whole seconds, minutes, hours, or days
between two dates and times, date_time1 and date_time2. (Subtracts date_time1
from date_time2.)
Syntax
Syntax 1: Difftime ( SECOND, date_time1, date_time2 )
Calculates the difference in whole seconds between two dates and times,
date_time1 and date_time2. (Subtracts date_time1 from date_time2.)
Syntax 2: Difftime ( MINUTE, date_time1, date_time2 )
Calculates the different in whole minutes between two dates and times, date_time1
and date_time2. (Subtracts date_time1 from date_time2.)
Syntax 3: Difftime ( HOUR, date_time1, date_time2 )
Calculates the different in whole hours between two dates ad times, date_time1
and date_time2. (Subtracts date_time1 from date_time2.)
Syntax 4: Difftime ( WKD, date_time1, date_time2 )
Calculates and returns the different in whole days between two times and dates,
date_time1 and date_time2. (Subtracts date_time1 from date_time2.)
Table: DIFFTIME Parameters
Parameter Description
date_time1 Any actual date and time or a datetime
variable.
DIFFTIME always subtracts the first datetime
from the second one.
With SECOND, any time beyond a complete
second is not counted. So, 2 1/2 seconds
becomes 2 seconds.
With MINUTE, any time beyond a complete
minute is not counted. So, 2 minutes and 15
seconds becomes 2 minutes.
With HOUR, any time beyond a complete
hour is not counted. So, 2 hours and 15
minutes becomes 2 hours.
With WKD, any time beyond a complete day
is not counted. So, two days and 15 hours
becomes two days.
date_time2 If date_time1 is later than date_time2,
DIFFTIME returns a negative number.
Examples
Example 1
You can use DIFFTIME with SECOND to determine how many seconds have
passed. The sample program below calculates the difference between two readings
of the datetime variable TIMER.
Program File
Technical 04-16006-04-en, March 2015
1842
51 Script Programming
51.154 DIFFTIME
Datetime Timer[2]
If Difftime (second, Timer[1], Timer[2]) > 30 then Run Test
The statement determines the result of TIMER[2] - TIMER[1]. If the difference is
greater than 30 seconds, TEST runs.
You would substitute MINUTE or HOUR in the above example to get time difference
in minutes or hours.
Example 2
You can use DIFFTIME with WKD to determine how many days have passed. The
sample program that follows calculates the difference between the old date (stored
in the OLDDATE variable) and the current date (in the DATE system variable).
Program File
Datetime Timer[2]
Result = Difftime (WKD, OLDTIME, DATE)
The statement sets RESULT to the number of days that DATE - OLDDATE gives.
04-16006-04-en, March 2015 Technical
1843
51 Script Programming
51.155 TIMEPIECE
51.155 TIMEPIECE
TIMEPIECE retrieves the piece of time (hour, minute, second) or the piece of the
date (weekday, month, day of the month, year, day of the year) from a variable or
point.
Note
Be aware that the days of the week correspond to the following digits:
• Sunday = 1
• Monday = 2
• Tuesday = 3
• Wednesday = 4
• Thursday = 5
• Friday = 6
• Saturday = 7
Syntax
Timepiece (datetime_system_variable, datetime_name)
Table: TIMEPIECE Parameters
Parameter Description
datetime_system_variable One of the date or time system variables:
HOUR, MINUTE, SECOND, HOD, TOD,
WEEKDAY, MONTH, DAYOFMONTH,
YEAR, DAYOFYEAR.
datetime_name Any name that stands for a date and time,
including datetime variables and points and
the DATE system variable.
Examples
Example 1
Program File
Datetime Date1
Numeric CurrentMin
Date1 = StrToDate ("5-25-98 11:13:23")
CurrentMin = Timepiece (Minute, Date1)
In this program, the TIMEPIECE function retrieves the minute from DATE1 and
returns 13.
Example 2
Program File
Numeric TodayMonth
TodayMonth = Timepiece (Month, Date)
In this program, the TIMEPIECE function retrieves the month from the DATE system
variable. If the date is June 20, 2005, TODAYMONTH is set to JUNE.
Technical 04-16006-04-en, March 2015
1844
51 Script Programming
51.156 Trigonometric Functions
51.156 Trigonometric Functions
Trigonometric functions return arccosine, arctangents, and arcsines of given
numbers.
51.156.1 ACOS
ACOS returns the arccosine of the given number.
For more information, see section 51.157 “ACOS” on page 1844..
51.156.2 ASIN
ASIN returns the arcsine of the number.
For more information, see section 51.158 “ASIN” on page 1845..
51.156.3 ATAN
ATAN returns the arctangent of number.
For more information, see section 51.159 “ATAN” on page 1846..
51.156.4 ATAN2
ATAN2 returns an angle with a sine of sin and a cosine of cos.
For more information, see section 51.160 “ATAN2” on page 1847..
51.156.5 COS
COS returns the cosine of number.
For more information, see section 51.161 “COS” on page 1848..
51.156.6 SIN
SIN returns the sine of the angle you specify.
For more information, see section 51.162 “SIN” on page 1849..
51.156.7 TAN
TAN returns the tangent of number.
For more information, see section 51.163 “TAN” on page 1850..
04-16006-04-en, March 2015 Technical
1845
51 Script Programming
51.157 ACOS
51.157 ACOS
Alias: ARCCOSINE
ACOS returns the arccosine of the given number.
Syntax
ACOS (number)
Table: ACOS Parameter
Parameter Description
number Any number or expression that gives a result
between -1 and 1 inclusive.
The value returned is between 0 and pi (3.14159) radians.
Radians = degrees TIMES (3.14159/180).
Degrees = radians TIMES (180/3.14159).
Examples
Program File
AN_VALUE = ACOS(.7071)
Technical 04-16006-04-en, March 2015
1846
51 Script Programming
51.158 ASIN
51.158 ASIN
Alias: ARCSINE
ASIN returns the arcsine of the number.
Syntax
ASIN (number)
Table: ASIN Parameter
Parameter Description
number Any number or expression that gives a result
between -1 and 1 inclusive, or expression
that gives a result in that range.
Returns the arcsine of number as an angle between -3.14159/2 and 3.14159/2.
Radians = degrees TIMES (3.14159/180).
Degrees = radians TIMES (180/3.14159).
Examples
Program File
Result = ASIN(1)
04-16006-04-en, March 2015 Technical
1847
51 Script Programming
51.159 ATAN
51.159 ATAN
Alias: ARCTANGENT
ATAN returns the arctangent of number.
Syntax
ATAN (number)
Table: ATAN Parameter
Parameter Description
number Any number or expression.
Returns an angle value between -3.14159/2 and 3.14159/2.
Radians = degrees TIMES (3.14159/180).
Degrees = radians TIMES (180/3.14159).
Examples
Program File
Val_ARC = ATAN(0)
Technical 04-16006-04-en, March 2015
1848
51 Script Programming
51.160 ATAN2
51.160 ATAN2
Alias: ARCTANGENT2
ATAN2 returns an angle with a sine of sin and a cosine of cos.
Syntax
ATAN2 (sin, cos)
Table: ATAN2 Parameter
Parameter Description
sin A number that is the sine of an angle.
cos A number that is the cosine of an angle.
The angle returned is between -3.14159 and 3.14159 radians.
Radians = degrees TIMES (3.14159/180).
Degrees = radians TIMES (180/3.14159).
Examples
Program File
Ang_Damper = ATAN2(0.0, 1.0)
04-16006-04-en, March 2015 Technical
1849
51 Script Programming
51.161 COS
51.161 COS
Alias: COSINE
COS returns the cosine of number.
Syntax
COS (number)
Table: COS Parameter
Parameter Description
number Any number or expression that represents
an angle measured in radians, between -
65536 and 65536.
Radians = degrees TIMES (3.14159/180).
Degrees = radians TIMES (180/3.14159).
Examples
Example 1
Program File
My_COS = COS(3.14159/2)
Example 2
Program File
My_COS = COS(angle)
Technical 04-16006-04-en, March 2015
1850
51 Script Programming
51.162 SIN
51.162 SIN
Alias: SINE
SIN returns the sine of the angle you specify.
Syntax
SIN (number)
Table: SIN Parameter
Parameter Description
number Any number or expression. The number
represents an angle in radians, between -
65536 and 65536.
Radians = degrees TIMES (3.14159/180).
Degrees = radians TIMES (180/3.14159).
Examples
Program File
Result = SIN (1)
04-16006-04-en, March 2015 Technical
1851
51 Script Programming
51.163 TAN
51.163 TAN
Alias: TANGENT
TAN returns the tangent of number.
Syntax
TAN (number)
Table: TAN Parameter
Parameter Description
number Any number or expression.
The number represents an angle measured
in radians.
Radians = degrees TIMES (3.14159/180).
Degrees = radians TIMES (180/3.14159).
Examples
Program File
Position = TAN (3.14159/180)
Technical 04-16006-04-en, March 2015
1852
52 Script Editor
Topics
Script Editor Overview
Script Editor Program Creation
Script Compiler Errors
Script Runtime Errors
Script Editor Features
Script Editor Program Elements and Colors
Keyboard Shortcuts for Script Editor
Collapsible Code Segments
Adding a Line
Script Auto-Completion
Using Script Auto-Completion
Script Editor Initial Binding Variable Values
Comments in Script Programs
Adding a Comment
Checking and Saving a Script Program
Executing a Script Program
Importing Script Program Code
Exporting a Script Program
Converting a Plain English File
Customizing the Script Editor
Using a Collapsible Script Code Block
Adding an Entry to the Code Library
Working with Code Library Folders
Working with Code Library Sample Import Files
Working with Code Library Items
Inserting a Code Library Item in a Script Program or
Function
Referencing the Code Library File
Finding Text in Script Editor
Using Undo and Redo in Script Editor
Script Debugger
Script Debugger Function Keys
Debugging a Script Program
Controlling the Trace Operation in the Script Debugger
Changing Values in the Script Debugger Local or Binding
Variables Pane
52 Script Editor
52.1 Script Editor Overview
52.1 Script Editor Overview
Script Editor is a text programming tool you use to create Script programs that
control and monitor building automation systems. Script Editor opens when you
edit a Script program in WorkStation.
52.1.1 Script Editor Program Creation
Script Editor is a text programming tool you use to create Script programs that
control and monitor building automation systems. For example, in WorkStation, you
can create a basic program, called OfficeLights, to control lighting and ventilation in
a room based on occupancy.
For more information, see section 52.2 “Script Editor Program Creation” on page
1854.
52.1.2 Script Editor Features
There are a number of features in Script Editor that allow you to improve the
readability and efficiency of your Script programs. These include:
• Program elements and colors
• Keystrokes
• Collapsible code segments
• Comments
• Auto-completion
For more information, see section 52.5 “Script Editor Features” on page 1864.
52.1.3 Script Compiler Errors
Script compiler errors identify problems that may occur in Script programming.
For more information, see section 52.3 “Script Compiler Errors” on page 1859.
52.1.4 Script Runtime Errors
Script runtime errors identify problems that may occur in Script programming.
For more information, see section 52.4 “Script Runtime Errors” on page 1862.
04-16006-04-en, March 2015 Technical
1855
52 Script Editor
52.2 Script Editor Program Creation
52.2 Script Editor Program Creation
Script Editor is a text programming tool you use to create Script programs that
control and monitor building automation systems. For example, in WorkStation, you
can create a basic program, called OfficeLights, to control lighting and ventilation in
a room based on occupancy.
Important
Ensure that you have a working and available Script license. A working license is
required to start Script. For more information, see the Licenses topic on
WebHelp.
Figure: OffliceLights Program in the List View
When you open your new OfficeLights program in Script Editor, you begin by
declaring local variables for the program input and output followed by names for the
variables. For more information, see section 50.16 “Local Variable Declarations” on
page 1592.
Technical 04-16006-04-en, March 2015
1856
52 Script Editor
52.2 Script Editor Program Creation
Figure: Variable Declarations
Once you have declared and referenced these variables, you then create the
program lines to specify the type of action you wish the program to perform. Script
programs are composed of everyday language statements, called instructions, so
you do not need to be a programmer to learn how to program with the Script
Editor.
After you finish writing the instructions in your program, you create points in
WorkStation.
04-16006-04-en, March 2015 Technical
1857
52 Script Editor
52.2 Script Editor Program Creation
Figure: WorkStation Points
You then bind the variables to those points to view the output.
Figure: Script Program Bindings
Technical 04-16006-04-en, March 2015
1858
52 Script Editor
52.2 Script Editor Program Creation
By using bindings, you can increase the flexibility of your building automation
system. For example, you can use your OfficeLights program to control lighting and
ventilation in one room and then use that program for another room by changing
the bindings. You do not need to change all of the local variable names to suit the
new program. When you are finished, you use Script Editor to check the program
for errors and save the program.
Figure: Script Program Check and Save Process
In WorkStation, in the Properties pane, you select the task in which you wish to
include your program. You then execute your Script program.
04-16006-04-en, March 2015 Technical
1859
52 Script Editor
52.2 Script Editor Program Creation
Figure: Script Program Execution
You can store your Script programs like a common document and include them
later in other projects for use in your control system. You can also write programs
that perform very complex control system decisions, such as controlling lighting,
boilers, and air handling units at multiple sites.
A single program file controls one piece of equipment, which makes programs
easier to maintain and debug. The capability to control one piece of equipment also
eliminates the possibility of a conflict occurring between the instructions in two
different programs. For example, a program that locks and unlocks a door prevents
the likelihood of an accidental door locking and unlocking.
Technical 04-16006-04-en, March 2015
1860
52 Script Editor
52.3 Script Compiler Errors
52.3 Script Compiler Errors
Script compiler errors identify problems that may occur in Script programming.
Table: Script Compiler Error Messages (1001...1102)
Error Error Text
1001
1002 Identifier <name> is too long.
1025 String <name> is too long.
1026 Comment exceeds maximum number of
characters.
1027 Syntax error, unexpected character
<character>.
1029 Syntax error, unexpected token <token>.
1030 Array size <number> is not an integer
between 1 and 36,767.
1031 FOR loop variable and NEXT variable are
different.
1032 GOTO statement is not allowed inside a
loop.
1033 Not enough free memory.
1034 Line <label> is redefined.
1035 Line <label> is not defined.
1036 Local variable <name> is redeclared.
1037 Variable <name> is not declared.
1038 Cannot define any more local variables.
1039 BREAK or CONTINUE is outside a loop or
block.
1040 Argument <name> is redeclared.
1041 Unsupported operational code.
1042 <number> is not a valid number.
1043 Number cannot be longer than 132 digits.
1044 Internal error: Invalid Stack Address.
1045 Internal error: Illegal stack pop operation.
1046 No function with that name exists.
04-16006-04-en, March 2015 Technical
1861
52 Script Editor
52.3 Script Compiler Errors
Continued
Error Error Text
1047 Variable is not an attribute.
1048 No quotation marks at end of string.
1054 Path name is too long.
1055 Attribute <name> does not apply to object
<name>.
1056 <name> defines an argument that cannot be
a local variable.
1057 Incorrect array entry type.
1058 Alarm expression is too large.
1059 Cannot set this variable. Make sure the
variable is not an input or function variable.
1060 Cannot set this attribute.
1061 Illegal rotate identifier type.
1062 Cannot enable or disable that object.
1064 Internal error: Stack overflow.
1065 Illegal use of a FOR loop variable. You must
use a local numeric variable.
1067 Cannot set a system variable.
1068 Statement is too long.
1069 System reserved label.
1070 Unsupported feature.
1071 Non integer number.
1072 Passed too many arguments to a function.
Be aware that Script functions support up to
15 arguments.
1073 Argument outside of index range.
1074 No character is allowed after continuation
symbol.
1075 Cannot Run or Stop program.
1076 Cannot compile report.
1077 Illegal command option.
Technical 04-16006-04-en, March 2015
1862
52 Script Editor
52.3 Script Compiler Errors
Continued
Error Error Text
1080 Command is valid only in a program or
function.
1081 Illegal name in alarm expression.
1083 Operation is not available.
1084 Total number of errors: <number>
1086 Syntax error, unexpected keyword
<keyword>
1087 Syntax error, unexpected symbol <symbol>
1088 Syntax error, unexpected symbol.
1089 Syntax error, unexpected comment.
1090 Local variable <name> is not an array.
1091 Syntax error, unexpected end of line.
1092 Syntax error, unexpected end of file.
1093 File not saved - You have not made any
changes.
1095 No Errors.
1096 Total number of characters used in line
labels exceeded maximum.
1097 Object <name> and the program are not in
the same network.
1098 Cannot use custom attribute in Program and
Function.
1099 Exceeded number of displayable lines.
1100 Unknown identifier.
1101 Unknown file type.
1102 End of file.
04-16006-04-en, March 2015 Technical
1863
52 Script Editor
52.4 Script Runtime Errors
52.4 Script Runtime Errors
Script runtime errors identify problems that may occur in Script programming.
Table: Script Runtime Error Messages
Error Text
Illegal type of assignment left-hand identifier
Set type mismatch
Local variable does not exist
Illegal expression type
Illegal hour value
String has more than 255 characters
Operation not supported
Stack Overflow
Illegal argument
Invalid destination
Illegal identifier type
Illegal variable type
Tried to divide a value by zero
Index out of range
Illegal array index
Illegal argument count
Invalid DateTime value
Executed too many statements on one line
Loop variable is not numeric
Error stopping current program
Illegal import ID
Bad path name
Illegal attribute usage
Exit User Function
Invalid set value
Preparse failed
Technical 04-16006-04-en, March 2015
1864
52 Script Editor
52.4 Script Runtime Errors
Continued
Error Text
Could not read from text file
Could not write to text file
Execution failed
Text file open failed
Comm failed
Cannot set attribute
Recursion not supported
04-16006-04-en, March 2015 Technical
1865
52 Script Editor
52.5 Script Editor Features
52.5 Script Editor Features
There are a number of features in Script Editor that allow you to improve the
readability and efficiency of your Script programs. These include:
• Program elements and colors
• Keystrokes
• Collapsible code segments
• Comments
• Auto-completion
• Initial binding variable values
52.5.1 Script Editor Program Elements and Colors
Within the Script Editor, each program element is displayed in a different color to
differentiate it from other program elements.
For more information, see section 52.6 “Script Editor Program Elements and
Colors” on page 1866.
52.5.2 Keyboard Shortcuts for Script Editor
You use keystrokes to change, move, find, cut, and paste text in the Script Editor.
For more information, see section 52.7 “Keyboard Shortcuts for Script Editor” on
page 1867.
52.5.3 Collapsible Code Segments
You can improve the readability of your programs by using collapsible code
segments within the Script Editor.
For more information, see section 52.8 “Collapsible Code Segments” on page
1868.
52.5.4 Comments in Script Programs
Comments are optional sentences you use to help document the operation and
purpose of your Script programs for the reader.
For more information, see section 52.13 “Comments in Script Programs” on page
1876.
Technical 04-16006-04-en, March 2015
1866
52 Script Editor
52.5 Script Editor Features
52.5.5 Script Auto-Completion
You can use auto-completion to fill in predictive text based on the possible matches
to the text that you type. Intellisense™ is an auto-completion tool that Building
Operation uses to store a collection of keywords, function names, and constants
that you can use in Script programming.
For more information, see section 52.10 “Script Auto-Completion” on page 1872.
52.5.6 Script Editor Initial Binding Variable Values
In the Script Editor, you have two different ways of setting the initial binding variable
values:
• You can write statements in your Script program
• You can use the Initial Value field in the Variables pane
For more information, see section 52.12 “Script Editor Initial Binding Variable
Values” on page 1874.
04-16006-04-en, March 2015 Technical
1867
52 Script Editor
52.6 Script Editor Program Elements and Colors
52.6 Script Editor Program Elements and
Colors
Within the Script Editor, each program element is displayed in a different color to
differentiate it from other program elements.
Table: Program Elements and Default Colors
Program Element Default Color
Text Black
Keyword Blue
Function Dodger Blue
Value Maroon
String Red
Number Navy
Operator Teal
Comment Green
Technical 04-16006-04-en, March 2015
1868
52 Script Editor
52.7 Keyboard Shortcuts for Script Editor
52.7 Keyboard Shortcuts for Script Editor
You use keystrokes to change, move, find, cut, and paste text in the Script Editor.
Table: Changing and Moving Text
Keystroke Action
Backspace Deletes any selected text, or deletes one
character to the left of the cursor.
CTRL + F Opens the Find dialog box.
Ctrl + Insert or CTRL + C Copies selected text and stores that text in
the clipboard.
Shift + Insert Inserts text wherever you wish.
Delete Deletes selected text or deletes one
character to the right of the cursor. If the
cursor is at the end of a line, connects the
line to the next one.
Enter Ends a line and starts a new one.
Insert Toggles between two modes:
• Insert – Inserting text into current text
• Overwrite – Typing over current text
The current mode is shown on the Status
bar on the bottom of the Script Editor
screen.
Shift + Delete or CTRL + X Cuts the selected text and stores that text in
the clipboard.
Shift + Insert or CTRL + V Pastes the text you last cut or copied at the
current cursor position in your program.
04-16006-04-en, March 2015 Technical
1869
52 Script Editor
52.8 Collapsible Code Segments
52.8 Collapsible Code Segments
You can improve the readability of your programs by using collapsible code
segments within the Script Editor.
You can expand or collapse code for the following types of code segments:
• For...Next
• While...Endwhile
• Repeat...Until
• Select Case...Endselect
Collapsed code segments display as text within the program next to a Maximize
button indicating the keyword/collapser name in place of the full code lines.
52.8.1 Clipboard
You use the Clipboard pane as the area to store copied and cut items while
programming. You can paste items from the Clipboard into any of the program
editor panes that are being used. For example, by double-clicking on an item in the
clipboard pane, you can insert that text into the program where the cursor is
currently located.
You access the cut, copy, and paste commands in one of two ways:
• By using the toolbar buttons
• Through the use of keyboard shortcuts
52.8.2 Code Library
Within Script Editor, the Code Library is a helpful programming tool that allows you
to create multiple folders to save, organize, and recall frequently used text. You
store folders on your PC and these folders appear alphabetically in the Code Library
pane.
Technical 04-16006-04-en, March 2015
1870
52 Script Editor
52.8 Collapsible Code Segments
Figure: Folders
A code library folder is made up of frequently used units of text called entries. These
entries can be single words, a full code line, a function, or even an entire Script
program. You can decide how much and what kind of text is stored as an item
according to your programming preferences.
You can also give entries meaningful names to help you identify and use them
easily. You can reference the code library file from anywhere on the PC that you use
to run WorkStation.
System-Provided Programs, Functions, and Sample Import Files
The Script Editor Code Library contains a series of system-provided programs,
functions, and sample import files that can help you solve common problems. For
example, the sample import files help to implement and utilize Script program
features such as simulation and calculation programs. The Code Library contains
the entire set of objects, such as programs, functions, and values necessary for the
application to function.
You can use these system-provided programs, functions, and sample import files
as-is or as samples when developing your own Script programs. They are located in
the designated folders in the Code Library.
04-16006-04-en, March 2015 Technical
1871
52 Script Editor
52.8 Collapsible Code Segments
Figure: System-Provided Code Library Programs, Functions, and Import Files
Technical 04-16006-04-en, March 2015
1872
52 Script Editor
52.9 Adding a Line
52.9 Adding a Line
You add lines to specify the type of action you want your Script program to perform.
A line is an instruction or series of instructions that belong together under one line
label.
For more information, see section 50.11 “Lines and Line Numbers” on page 1583.
To add a line
1. In Script Editor, type a line label that is preceded by the Line keyword or
followed by a colon, and then add the instructions that belong to the line label.
You have now added line labels and instructions in your program.
04-16006-04-en, March 2015 Technical
1873
52 Script Editor
52.10 Script Auto-Completion
52.10 Script Auto-Completion
You can use auto-completion to fill in predictive text based on the possible matches
to the text that you type. Intellisense™ is an auto-completion tool that Building
Operation uses to store a collection of keywords, function names, and constants
that you can use in Script programming.
These matches display for Script keywords, functions, and constants. The list of
words displays in a box to the right side of the cursor when you start typing a new
word.
Figure: Auto-completion
As more characters are typed, the list shrinks as the possible matches decrease. If
there are no matches, the box closes automatically.
ToolTips display next to the text options with information about each, such as
function description, keyword name, and function parameters. You can use
ToolTips to auto-complete the text by selecting any of the options listed.
Technical 04-16006-04-en, March 2015
1874
52 Script Editor
52.11 Using Script Auto-Completion
52.11 Using Script Auto-Completion
To save time, you use auto-completion to fill in predictive text based on possible
matches to the text you enter in your Script programs or functions.
For more information, see section 52.10 “Script Auto-Completion” on page 1872.
To Use Script auto-completion
1. In Script Editor, start typing and notice the predictive text that displays for
Script keywords, functions, and constants.
2. In the list, double-click the text you want to use.
04-16006-04-en, March 2015 Technical
1875
52 Script Editor
52.12 Script Editor Initial Binding Variable Values
52.12 Script Editor Initial Binding Variable
Values
In the Script Editor, you have two different ways of setting the initial binding variable
values:
• You can write statements in your Script program
• You can use the Initial Value field in the Variables pane
52.12.1 Statements in Script Programs
You can write statements directly in your Script program using an initialization line,
with one or more statements typically setting the output variables.
Initializing:
Set Output1 to 1
Set Output2 to 2
...
E:
'Some Error occurred, Restart Execution
GoTo Initializing
Tip
With this method, you can issue a GoTo statement to the initialization line
anywhere in the program. This GoTo statement directs the program to re-execute
the initialization statements and start over (based on program execution logic).
52.12.2 Script Editor Variables Pane Initial Value Field
You can configure initial binding variables values using the Initial Value field in Script
Editor's Variables pane.
Technical 04-16006-04-en, March 2015
1876
52 Script Editor
52.12 Script Editor Initial Binding Variable Values
Figure: Script Editor Variables Pane
When you configure the initial binding variable values in the Variables pane, the
program uses those values. However, when those variables are bound to object
properties, the program uses the variable values of the objects when it runs, instead
of the initial ones from the Variables pane.
The table that follows explains how to configure an initial value for each variable
type.
Table: Initial Value Variable Types
Variable Expected Value Configuration object
Float Numeric Text box
Integer Numeric Text box
Boolean Numeric Dropdown
String String Text box
DateTime DateTime Date and time picker
04-16006-04-en, March 2015 Technical
1877
52 Script Editor
52.13 Comments in Script Programs
52.13 Comments in Script Programs
Comments are optional sentences you use to help document the operation and
purpose of your Script programs for the reader.
Comments are not operated upon. Instead, you enter comments as single lines
preceded by a single quotation mark (‘).
Note
• Script supports characters at or below ASCII 127. Additional characters are
not supported and are replaced by a question mark (?).
Figure: Comments in Script Program
You can add as many comments as necessary, but each is restricted to one
physical (132 characters) line.
You can also add a comment after a statement on the same physical line, such as
the following:
TURN THE FAN ON ‘start cooling
Technical 04-16006-04-en, March 2015
1878
52 Script Editor
52.14 Adding a Comment
52.14 Adding a Comment
You use optional comments to help document the operation and purpose of a
Script program or function.
For more information, see section 52.13 “Comments in Script Programs” on page
1876.
To add a comment
1. In Script Editor, type a single quotation mark (') and then type a comment.
You can add a comment at the beginning of the program or function to explain its
purpose. You can also add comments at the end of any statement in a Script
program or function.
04-16006-04-en, March 2015 Technical
1879
52 Script Editor
52.15 Checking and Saving a Script Program
52.15 Checking and Saving a Script Program
You check your Script program to ensure there are no syntax errors. You perform a
save operation to check and then save your Script program.
Important
If you save a program that contains errors, that program will not run. The progam
must have a successful check before running.
For more information, see section 50.3 “Script Programs” on page 1565.
To check and save a Script program
1. In Script Editor, click Check.
2. In the Check pane, double-click on an error message to go to the line of code
that contains the error.
3. Click Save to check and save your Script program.
When you save a program that contains Input, Output, Public, Function and
WebService variables, the entries are automatically added to the
corresponding binding tabs in the Properties pane.
The Script Editor displays a Save Successful message, even if the program
contains errors and does not compile successfully.
You have now checked and saved your Script program.
Technical 04-16006-04-en, March 2015
1880
52 Script Editor
52.16 Executing a Script Program
52.16 Executing a Script Program
You execute a Script program in order to tell the Automation Server or Enterprise
Server to take a specific action to control a building.
For more information, see section 50.23 “Tasks” on page 1602.
To execute a Script program
1. In WorkStation, in the List View, select the Script program.
2. On the File menu, click Properties.
3. Click the Basic tab.
4. In the Task box, enter the task you want to add to the program.
The default is Task 3.
5. Click OK.
6. In the List View, select the program you want to execute.
7. On the Actions menu, click Restart.
Continued on next page
04-16006-04-en, March 2015 Technical
1881
52 Script Editor
52.16 Executing a Script Program
8. In the Script Program Properties Basic tab, observe that the Runtime
fields, such as TS, TM, and TH, update as the program executes.
Technical 04-16006-04-en, March 2015
1882
52 Script Editor
52.17 Importing Script Program Code
52.17 Importing Script Program Code
You import Script program code to reuse all or parts of existing code. Script Editor
supports import of .txt files created using the Plain English tool, as well as previously
created Script program files.
For more information, see section 50.10 “Script Program Instructions” on page
1581.
To import Script program code
1. In WorkStation, in the System Tree pane, select the Script program or
function you want to import program code to.
2. On the Actions menu, click Edit.
3. In Script Editor, position the insertion point in the program or function where
you want to import program code.
4. Click the Script menu button .
5. Point to Import and click Text or Plain English.
6. Select the file you want to import.
7. Click Open.
8. Click Save.
Tip
• When a Plain English .txt file is imported, you have to load the file
and complete a conversion process. As a result of these
conversions, you may need to make adjustments to the
imported script program code.
04-16006-04-en, March 2015 Technical
1883
52 Script Editor
52.18 Exporting a Script Program
52.18 Exporting a Script Program
You can export the contents of any program file to a .txt file in the Script Editor. This
lets you export programs and modify them in a text editor application separate from
WorkStation, or write them to a text file for use in another location.
Note
• To import text into a new program, create the program in a text editor first
and then import the .txt file.
For more information, see section 50.3 “Script Programs” on page 1565.
To export a Script program
1. In WorkStation, in the List View, select the Script program or function you
want to open.
2. On the Actions menu, click Edit.
3. In Script Editor, select the text in the program that you want to export.
4. Click the Script menu button .
5. Click Export.
6. Select the location where you want to save the exported text.
7. In the File name box, enter a name for the .txt file.
8. Click Save.
Technical 04-16006-04-en, March 2015
1884
52 Script Editor
52.19 Converting a Plain English File
52.19 Converting a Plain English File
You convert Plain English files to Script to reuse all or parts of existing Plain English
code.
For more information, see the Script and Plain English Program Differences topic on
WebHelp.
To convert a Plain English file
1. In WorkStation, in the System Tree pane, select the Script program or
function you want to convert Plain English code to.
2. On the Actions menu, click Edit.
3. In Script Editor, position the insertion point in the program or function where
you want to import the Plain English code.
4. Click the Script menu icon , point to Import and then click Plain
English.
5. Click Load file to load an entire PE file, or paste the text you want from your
PE program or function into the Plain English Editor pane.
6. Select the .txt file you want to convert.
7. Click Open.
Continued on next page
04-16006-04-en, March 2015 Technical
1885
52 Script Editor
52.19 Converting a Plain English File
8. Convert all or part of the file:
• Click Convert all to convert the entire PE file to a Script program.
• Select the lines you want to convert and then click Convert selected to
convert the selected lines to the Script program or function.
9. Correct any errors that occur during the conversion.
10. Click Close.
11. In Script Editor, click Save.
Technical 04-16006-04-en, March 2015
1886
52 Script Editor
52.20 Customizing the Script Editor
52.20 Customizing the Script Editor
You can customize the Script Editor and choose the preferred layout, line numbers,
or colors you want to use. You can also customize the appearance of programming
elements for easy identification, or select a path for use with code libraries and the
import/export tool.
For more information, see section 52.5 “Script Editor Features” on page 1864.
To customize the Script Editor
1. In Script Editor, click Options.
2. Click the General tab.
3. Select Tabbed documents to display your programs and functions as
tabbed documents in the Script Editor.
4. Select Multiple documents to display your programs and functions as
multiple documents in the Script Editor.
5. Select Enable IntelliSense to auto-complete keywords, function names,
and constants as you create programs in the Script Editor.
For more information, see section 52.10 “Script Auto-Completion” on page
1872.
6. Select Enable outlining to show the code segments eligible for collapse.
7. Select Show line numbers to display line numbers in the program window.
8. Click Restore default settings to restore the settings to their default values.
9. Click the Fonts and Colors tab.
10. In the Font box, click the drop-down menu to select the font you want to use.
11. In the Size box, select the font size.
Continued on next page
04-16006-04-en, March 2015 Technical
1887
52 Script Editor
52.20 Customizing the Script Editor
12. In the Display items list, select the Script programming language element
you want to locate and highlight in your program.
For example, specify that a string in your Script program is highlighted in red.
13. Click Apply. Notice that the string in your Script program is now highlighted.
Continued on next page
Technical 04-16006-04-en, March 2015
1888
52 Script Editor
52.20 Customizing the Script Editor
14. Click the Paths tab.
15. For Code library path, enter a path:
• Click Browse to locate and select a path.
Click Restore to specify the default path.
16. For Import / export path, enter a path:
• Click Browse to locate and select a path.
• Click Restore to specify the default path.
17. Click OK.
04-16006-04-en, March 2015 Technical
1889
52 Script Editor
52.21 Using a Collapsible Script Code Block
52.21 Using a Collapsible Script Code Block
You improve the readability of your Script programs and functions by using
collapsible code blocks within Script Editor. Code blocks are elements that Script
Editor automatically adds for certain types of program statements, such as
For...Next, Repeat...Until, Select Case...Endselect, and While...Endwhile.
For more information, see section 52.8 “Collapsible Code Segments” on page
1868.
To use a collapsible Script code block
1. In Script Editor, create a code block that determines squares using the
For...Next, Repeat...Until, Select Case...Endselect, or While...Endwhile
statements.
Continued on next page
Technical 04-16006-04-en, March 2015
1890
52 Script Editor
52.21 Using a Collapsible Script Code Block
2. Expand or collapse the code in the code block by clicking + (Maximize), or -
(Minimize).
Collapsed code blocks appear as text within the program next to a + button
that indicates the keyword/collapser name in place of the full code lines.
You have now utilized a collapsible code block.
04-16006-04-en, March 2015 Technical
1891
52 Script Editor
52.22 Adding an Entry to the Code Library
52.22 Adding an Entry to the Code Library
You can add entries to the code library in Script Editor. Entries can be single words,
a full code line, a function, or a Script program.
For more information, see section 52.8 “Collapsible Code Segments” on page
1868.
To add an entry to the code library
1. In Script Editor, select the text that you want to save.
2. Right-click and select Add to library.
Continued on next page
Technical 04-16006-04-en, March 2015
1892
52 Script Editor
52.22 Adding an Entry to the Code Library
3. In the Entry name box, type an entry name.
4. In the Create in box, select a code library folder:
• Select a folder from the list to add the entry to an existing folder.
• Click New folder to add the entry to a new folder.
Continued on next page
04-16006-04-en, March 2015 Technical
1893
52 Script Editor
52.22 Adding an Entry to the Code Library
5. Click Add.
Technical 04-16006-04-en, March 2015
1894
52 Script Editor
52.23 Working with Code Library Folders
52.23 Working with Code Library Folders
You can add, delete, and rename code library folders on your PC using Script
Editor. A code library is composed of frequently used units of text called entries.
For more information, see section 52.8 “Collapsible Code Segments” on page
1868.
To work with code library folders
1. In Script Editor, click Library.
2. In the Library pane, click a folder.
3. To add a new folder, right-click and click New folder. Then, enter a name for
the folder and click OK.
4. To change a folder name, right-click and click Rename folder. Then, enter a
new name for the folder and click OK.
5. To delete a folder and its contents, right-click and click Delete folder. Then,
click Yes.
04-16006-04-en, March 2015 Technical
1895
52 Script Editor
52.24 Working with Code Library Sample Import Files
52.24 Working with Code Library Sample
Import Files
You use the system-provided sample import files in the Script Editor Code Library
to develop your own Script programs that utilize Web Services. In this procedure,
the sample import file provides you with weather data, such as temperature and
humidity, for a given US zip code.
For more information, see section 53.1 “Script Web Services” on page 1917.
To work with code library sample import files
1. In Script Editor, click Library.
2. In the Library pane, click Sample Import Files.
Continued on next page
Technical 04-16006-04-en, March 2015
1896
52 Script Editor
52.24 Working with Code Library Sample Import Files
3. Double-click the sample import file you want, such as WebService SOAP US
City Weather by ZipCode.xml file.
A dialog then displays with a summary of the impending import operation.
Tip
By default, the path for the import is the Server. You cannot change
Continued on next page
04-16006-04-en, March 2015 Technical
1897
52 Script Editor
52.24 Working with Code Library Sample Import Files
the path.
4. Click Import.
All of the objects contained in the import sample file are created in the server.
5. In the List View, click the City Zip Code variable and on the File menu, click
Properties.
6. Enter the zip code you want, such as 01845 for North Andover, MA.
7. Click OK.
Continued on next page
Technical 04-16006-04-en, March 2015
1898
52 Script Editor
52.24 Working with Code Library Sample Import Files
8. Drag these City values to the Watch pane and observe the functioning
program as it obtains the temperature and humidity for zip code 01845.
9. In the List View, click the GET US City Weather by Zip Code program.
10. On the Actions menu, click Edit.
Continued on next page
04-16006-04-en, March 2015 Technical
1899
52 Script Editor
52.24 Working with Code Library Sample Import Files
11. View and edit the program as needed.
12. Click Save to execute the updated GET US City Weather by Zip Code
program.
Technical 04-16006-04-en, March 2015
1900
52 Script Editor
52.25 Working with Code Library Items
52.25 Working with Code Library Items
You use items such as programs and functions in the code library when developing
your own Script programs and functions.
For more information, see section 52.8 “Collapsible Code Segments” on page
1868.
To work with code library items
1. In Script Editor, click Library.
2. In the Library pane, click the folder that contains the item.
3. Right-click the item and then click Rename item.
4. Enter a new name in the highlighted area.
5. To delete a code library item, click Delete item and then click Yes when
prompted.
6. To move a code library item, click Move to folder and then select the code
library location from the list.
04-16006-04-en, March 2015 Technical
1901
52 Script Editor
52.26 Inserting a Code Library Item in a Script Program or Function
52.26 Inserting a Code Library Item in a Script
Program or Function
You insert a code library item in a Script program or function to add a frequently
used unit of text such as a single word, a program instruction, a program line or set
of instructions, or a complete function or program.
For more information, see section 52.8 “Collapsible Code Segments” on page
1868.
To insert a code library item in a Script program or function
1. In Script Editor, position the insertion point in the program or function where
you want to insert the item.
2. Click Library.
3. In the Library pane, click the folder that contains the item.
4. Right-click the item and click Insert in editor.
The item appears at your insertion point in the Script program or function.
Technical 04-16006-04-en, March 2015
1902
52 Script Editor
52.27 Referencing the Code Library File
52.27 Referencing the Code Library File
You reference the code library file from anywhere on the PC you choose to run
Script.
For more information, see section 52.8 “Collapsible Code Segments” on page
1868.
To reference the code library file
1. In Script Editor, click Options.
2. Click the Paths tab.
3. For Code library path, enter a path:
• Click Browse to locate and select a path.
• Click Restore to specify the default path.
4. Click OK.
04-16006-04-en, March 2015 Technical
1903
52 Script Editor
52.28 Finding Text in Script Editor
52.28 Finding Text in Script Editor
You can find text in a Script program or function using the Script Editor toolbar Find
field.
Important
• Use this method when you want to search only the current program.
For more information, see section 52.5 “Script Editor Features” on page 1864.
To find text in Script Editor
1. In Script Editor, position the insertion point where you want to begin searching
in the program or function.
2. In the Find box, type the text or string you want to find in the program or
function.
3. Click the Find icon .
4. In the Find and replace dialog, click Find.
5. In the current program or function, view the highlighted results.
6. Click Enter to find the next instance of the queried text.
Technical 04-16006-04-en, March 2015
1904
52 Script Editor
52.29 Using Undo and Redo in Script Editor
52.29 Using Undo and Redo in Script Editor
You use the Undo button on the Quick access toolbar in Script Editor to undo the
last keystroke or action. You use the Redo button to repeat the last keystroke or
action that you previously undid.
For more information, see section 52.5 “Script Editor Features” on page 1864.
To use Undo and Redo in Script Editor
1. In Script Editor, click the Undo button to undo the last keystroke or
action.
2. Click the Redo button to repeat the last keystroke or action that you
previously undid.
Note
• The limit of Undo and Redo actions is forward or backwards by
24 instances.
04-16006-04-en, March 2015 Technical
1905
52 Script Editor
52.30 Script Debugger
52.30 Script Debugger
In order to solve complex problems, Script programs have become more and more
sophisticated. With this increased sophistication, finding and fixing issues in the
program's logic has become even more difficult. The Script Debugger is designed
to address such issues.
For example, in the Script Debugger, you can single step through your Script
programs and proceed to the next executing line. You can visually trace your
program's operation as it highlights every executing statement, potentially
uncovering any problems in the program's logic.
You can also set a breakpoint in order to do the following:
• Establish a line where you want your program execution to stop.
• Examine or change variable values.
• Resume execution from that point.
When setting a breakpoint, you may discover the statement at that line is never
reached, uncovering a potential problem. The ability to identify problems in your
Script programs is one of the major advantages of the Script Debugger. Using its
in-session editing capabilities, you can then edit and fix any of the issues that you
identify.
52.30.1 Debug Mode Editing
In the Script Debugger, you can utilize debug mode editing features that allow you
to skip over troublesome areas in your Script programs and then resolve their
problems later. For example, you can use the following features
• Line E ignores error conditions and continues executing your Script programs.
You can then go back later and clear the error condition by correcting the
program's logic.
• Set next statement places the cursor at any executable statement or line in
your Script program. That line then gets highlighted and when you click Go or
single Step, gets executed. Execution resumes or starts from that newly-
selected statement, thus letting you skip over troublesome program issues.
• Comments selected lets you comment out one or more selected statements in
your Script program. By doing so, you direct Script program execution to
ignore commented statements in the Debugger until you identify and fix the
problems. You may also uncomment one or more selected statements and
direct your program to execute them. This is particularly useful for debugging
large Script programs with a number of loops.
52.30.2 Debug b3 BACnet Script Programs
Directly troubleshooting b3 BACnet device Script programs is not supported in the
Script Debugger. However, you can create an Automation Server Script program
that contains similar logic. You can then use this Automation Server Script program
to access b3 BACnet device points and debug that program. Be aware, however,
that not every syntax permitted in the b3 BACnet device is available in an
Automation Server.
Technical 04-16006-04-en, March 2015
1906
52 Script Editor
52.30 Script Debugger
Note
Nested function calls are also not supported in the Script Debugger.
04-16006-04-en, March 2015 Technical
1907
52 Script Editor
52.31 Script Debugger Function Keys
52.31 Script Debugger Function Keys
You can use function keys in the Script Debugger to go to the next executing line in
your Script program, set or remove a breakpoint, or continuously execute your
program until a breakpoint is reached.
Function Key Action Acts like...
F5 Continuously executes a Clicking Go in the Script
Script program until a toolbar
breakpoint is reached or
execution ends.
F9 Sets or removes a Selecting the Insert
breakpoint in your Script breakpoint menu item
program.
F10 Goes to the next executing Clicking Step in the Script
line in the Script program. toolbar
Technical 04-16006-04-en, March 2015
1908
52 Script Editor
52.32 Debugging a Script Program
52.32 Debugging a Script Program
You use the Script Debugger to troubleshoot the Script programs you create.
For more information, see section 52.30 “Script Debugger ” on page 1904.
To debug a Script program
1. In WorkStation, in the List View, select the Script program you want to
debug.
2. On the Actions menu, click Edit.
3. In the Script Editor toolbar, click Start to initiate a Script debugging session.
4. Debug your Script program.
Continued on next page
04-16006-04-en, March 2015 Technical
1909
52 Script Editor
52.32 Debugging a Script Program
5. Click Trace On to initate a continuous single step operation. This saves you
from having to constantly press Step.
Note
The icon beside the program name changes to indicate the Script
Editor is now in Debug mode. Be aware that you can only debug one
program at a time.
6. Control the Trace operation.
For more information, see section 52.33 “Controlling the Trace Operation in
the Script Debugger ” on page 1911.
Continued on next page
Technical 04-16006-04-en, March 2015
1910
52 Script Editor
52.32 Debugging a Script Program
7. Click Step to go to the next executing line in your Script program.
8. Click Go to continuously execute a Script program until a breakpoint is
reached, or execution ends
9. Right click and select Insert breakpoint to toggle a breakpoint in your Script
program.
Programs execute until they reach a programmed breakpoint.
10. Place the cursor at any executable statement or line in your Script program.
Continued on next page
04-16006-04-en, March 2015 Technical
1911
52 Script Editor
52.32 Debugging a Script Program
11. Right click and select Set next statement from the Script Editor context
menu.
That line in the program gets highlighted.
12. Click Go or single Step to execute that statement.
Program execution resumes or starts from that newly-selected statement.
13. When finished, click Stop to terminate your Script debugging session.
Technical 04-16006-04-en, March 2015
1912
52 Script Editor
52.33 Controlling the Trace Operation in the Script Debugger
52.33 Controlling the Trace Operation in the
Script Debugger
You can control the Trace operation in the Script Debugger by setting a breakpoint
stop or specifying the timing trace.
For more information, see section 52.30 “Script Debugger ” on page 1904.
To control the trace operation in the Script Debugger
1. In WorkStation, in the List View, select the Script program you want to
debug.
2. On the Actions menu, click Edit.
3. In the Script Editor toolbar, click Options.
4. Click Debugger.
5. Control the Trace operation by clicking the Stop in breakpoint while
tracing check box.
6. In the Trace timer (ms) field, enter a value that specifies the timing of the
Trace operation.
Optionally, you may adjust the frequency of program statement execution,
such as .25, or .50 of a second.
7. Click Apply.
8. Click OK.
04-16006-04-en, March 2015 Technical
1913
52 Script Editor
52.34 Changing Values in the Script Debugger Local or Binding Variables Pane
52.34 Changing Values in the Script Debugger
Local or Binding Variables Pane
While in the Script Debugger, you can use the Local or Binding Variables pane
to re-calculate your Script program values.
For more information, see section 52.30 “Script Debugger ” on page 1904.
To change values in the Script Debugger local or binding
variables pane
1. In WorkStation, in the List View, select the Script program you want to
debug.
2. On the Actions menu, click Edit.
3. Click Start to enter the Script Debugger.
4. In the Script Debugger, click the Value field in the Local or Binding
Variables pane.
Continued on next page
Technical 04-16006-04-en, March 2015
1914
52 Script Editor
52.34 Changing Values in the Script Debugger Local or Binding Variables Pane
5. Type the new value and press Enter.
For example, you can change values here to force a shutdown in case the
boiler temperature rises above 100°.
6. Click Stop to exit the Script Debugger.
04-16006-04-en, March 2015 Technical
1915
53 Script Web Services
Topics
Script Web Services
Script Web Services Workflow
Creating a Script Web Service Interface
Configuring a Script Web Service Interface
Configuring a Script Program to use Web Services
Script SOAP Web Services Data Type
Script RESTful Web Services
Using Script to Send a Request to a RESTful Web Service
Using Script to Obtain a Secure Web Page from a RESTful
Web Service
53 Script Web Services
53.1 Script Web Services
53.1 Script Web Services
Web Services are programmable applications accessible from standard Internet
protocols, like HTTP and XML. Web Services help solve application integration
challenges by allowing applications to communicate with one another independent
of the target, host operating system, object model, or programming language.
Figure: Web Services Overview
Web Services are designed to support interoperable, machine-to-machine
interaction over a network. As a result, it makes perfect sense to use a Web Service
from a programming language, like Script. Because the Web Service is an
application delivered and utilized with regular Internet standards, the Web Service
operates as a URL by programmatically returning information for clients to employ.
The URL acts as a URI that specifies the location, identifies the available resource,
and provides a mechanism for retrieving it. For example, the following URLs identify
available online calculator and weather services:
• http://www.cs.fsu.edu/~engelen/calc.wsdl?wsdl
• http://ws.cdyne.com/WeatherWS/Weather.asmx?wsdl
To interact with Web Services, Script uses the Web Services Description Language
(WSDL) file to extract information about functions, parameters, and return types.
WSDL is an XML-based language that provides a model for describing Web
Services. For more information, see section 118.2 “Web Services ” on page 5064.
53.1.1 Script Web Services Workflow
You create and configure a Script Web Service by following these four basic steps:
• Create the Web Service interface
• Configure the Web Service interface
• Create a Script program
• Configure the Script Program to use Web Services
04-16006-04-en, March 2015 Technical
1919
53 Script Web Services
53.1 Script Web Services
For more information, see section 53.2 “Script Web Services Workflow” on page
1919.
53.1.2 Script SOAP Web Services Data Type
The Simple Object Access Protocol (SOAP) is a protocol for exchanging structured
information when implementing Web Services in computer networks. The Web
Service data type supports the interaction between a SOAP-based Web Service
and Script.
For more information, see section 53.6 “Script SOAP Web Services Data Type” on
page 1927.
53.1.3 Script RESTFul Web Services
REST (Representational State Transfer) is a style of software architecture for
distributed hypermedia systems, such as the World Wide Web. REST has emerged
as a predominant Web Service design model since it is lighter and simpler to use
than SOAP.
For more information, see section 53.7 “Script RESTful Web Services” on page
1931.
Technical 04-16006-04-en, March 2015
1920
53 Script Web Services
53.2 Script Web Services Workflow
53.2 Script Web Services Workflow
You create and configure a Script Web Service by following these four basic steps:
• Create the Web Service interface
• Configure the Web Service interface
• Create a Script Program
• Configure the Script Program to use Web Services
For example, you can use the online calculator service at Florida State University to
add 2 numerics and calculate the result. In WorkStation, you create a Script Web
Service interface called Calculator and configure this interface by entering the
location of the service you wish to target. In this example, you enter the URL of a
WSDL file located at http://www.cs.fsu.edu/~calc.wsdl?wsdl.
You then create a Script program named Calculator Program and configure this
Script program to use Web Services. In this example, you use the Webservice
keyword to declare the Web Service in the program.
04-16006-04-en, March 2015 Technical
1921
53 Script Web Services
53.2 Script Web Services Workflow
Technical 04-16006-04-en, March 2015
1922
53 Script Web Services
53.3 Creating a Script Web Service Interface
53.3 Creating a Script Web Service Interface
You create a Script Web Service to identify and deliver with standard Internet
protocols an application that you can utilize as a service.
For more information, see section 53.1 “Script Web Services” on page 1917.
To create a Script Web Service interface
1. In WorkStation, in the System Tree pane, select the server or folder where
you want to create a Web Service interface.
2. On the File menu, point to New and click Interface.
3. In the object type list, expand Web Service and then click Script Web
Service.
4. In the Name box, type the name of the Web Service interface.
5. In the Description box, type a description of the Web Service interface.
6. Click Create.
04-16006-04-en, March 2015 Technical
1923
53 Script Web Services
53.4 Configuring a Script Web Service Interface
53.4 Configuring a Script Web Service
Interface
You configure a Script Web Service interface by entering the URL or WSDL file
location and then specifying the service you wish to target.
For more information, see section 53.2 “Script Web Services Workflow” on page
1919.
To configure a Script Web Service interface
1. In WorkStation, in the System Tree pane, select the Web Service interface.
2. On the File menu, click Properties.
3. Click the Basic tab.
4. In the Wsdl Url box, type the URL or a WSDL file located on a local PC or on
the Internet.
Continued on next page
Technical 04-16006-04-en, March 2015
1924
53 Script Web Services
53.4 Configuring a Script Web Service Interface
5. In the Service box, enter the name of the service you want to target.
Tip
• When you create a Web Service, you should ensure that your PC
can connect to the target service.
6. In the EndPoint box, type the URL of the machine where the Web Service
calls are processed.
Note
• Typically, the WSDL file defines the EndPoint, in which case, this
box is completed automatically. In some circumstances, you
may still need to enter an EndPoint, however.
7. Click OK.
04-16006-04-en, March 2015 Technical
1925
53 Script Web Services
53.5 Configuring a Script Program to use Web Services
53.5 Configuring a Script Program to use
Web Services
You select a Script program and then configure that program to use Web Services.
For more information, see section 53.2 “Script Web Services Workflow” on page
1919.
To configure a Script program to use Web Services
1. In WorkStation, in the System Tree pane, select the Script program that you
want to use Web Services.
2. On the Actions menu, click Edit.
3. In Script Editor, use the Webservice keyword to declare the Web Service in
the program.
4. In the Script Editor toolbar, click Save.
5. In the Properties pane, click the Web Services tab.
Continued on next page
Technical 04-16006-04-en, March 2015
1926
53 Script Web Services
53.5 Configuring a Script Program to use Web Services
6. Enter the path to the Script Web Service interface.
7. In the Script Editor toolbar, click Save.
8. Continue building your Script program.
9. In the Script Editor toolbar, click Save.
Continued on next page
04-16006-04-en, March 2015 Technical
1927
53 Script Web Services
53.5 Configuring a Script Program to use Web Services
10. In the Variables pane, view the results of the Web Service program.
Technical 04-16006-04-en, March 2015
1928
53 Script Web Services
53.6 Script SOAP Web Services Data Type
53.6 Script SOAP Web Services Data Type
The Simple Object Access Protocol (SOAP) is a protocol for exchanging structured
information when implementing Web Services in computer networks. The Web
Service data type supports the interaction between a SOAP-based Web Service
and Script.
SOAP relies on XML for its message format, and usually relies on other application
protocols for message negotiation and transmission. SOAP can form the foundation
layer for Web Services and also provide a basic messaging framework upon which
Web Services are built.
You bind the Script Web Services object to a corresponding Script program. Once
you do so, Script extracts all of the necessary material, including the methods, data
type for the arguments, and return values and their types.
Figure: Web Services Object Model
The Script Editor then displays Web Services methods using Intellisense.
Intellisense is an auto-completion tool that you use to fill in predictive text based on
possible matches to the text you type. For more information, see section 52.10
“Script Auto-Completion” on page 1872.
04-16006-04-en, March 2015 Technical
1929
53 Script Web Services
53.6 Script SOAP Web Services Data Type
53.6.1 Supported Data Types
Only simple data types are supported for both Web Service methods and return
values including:
• String
• Numerics
• DateTime
Complex types are supported with the String data type. To manipulate complex
types, you use Script string operations.
Tip
Web Service method calls need their own execution lines within Script programs.
53.6.2 Web Service Declarations
You declare a Web Service the same way you declare a function. You do so using
the keyword Webservice followed by a local variable name at the beginning of your
Script program. Then, you bind a Web Service object to the Script program using
the binding generated by this Web Service declaration as shown:
Figure: Web Services Declarations
Technical 04-16006-04-en, March 2015
1930
53 Script Web Services
53.6 Script SOAP Web Services Data Type
In Script Editor, you use the .(dot) syntax to select the Web Service execution
method as shown here.
Figure: Web Services .(Dot) Notation
53.6.3 Web Service Selection and EndPoints
You select the Web Service you want to target by entering the Wsdl Url in the Basic
tab. In this case, the URL identifies an online calculator service. The Service field is
populated when you enter a valid Web Service URL. A WSDL file can contain one or
more services.
04-16006-04-en, March 2015 Technical
1931
53 Script Web Services
53.6 Script SOAP Web Services Data Type
Figure: Web Service Selection
Tip
When you create a Web Service, be sure that your PC can connect to the target
service.
The EndPoint is a reference to an entity, processor, machine, or resource for target
Web Service messages and calls. It represents the URL of the machine where the
Web Service calls are processed. Typically, information about EndPoints is
embedded inside the WSDL files. In those cases, the box is completed
automatically. In some circumstances, you may still have to enter an EndPoint,
however.
Technical 04-16006-04-en, March 2015
1932
53 Script Web Services
53.7 Script RESTful Web Services
53.7 Script RESTful Web Services
REST (Representational State Transfer) is a style of software architecture for
distributed hypermedia systems, such as the World Wide Web. REST has emerged
as a predominant Web Service design model since it is lighter and simpler to use
than SOAP.
REST defines a set of architectural principles you can use to connect to Web
Services that focus on a system's resources. This includes how resource states are
addressed and transferred over Hypertext Transfer Protocol (HTTP) by a wide range
of clients written in different languages. For more information, see section 53.6
“Script SOAP Web Services Data Type” on page 1927.
Script supports the generic use of REST Web Services through new Application
Programming Interfaces (APIs).
53.7.1 SendWebRequest
The SendWebRequest system function sends a request to a Uniform Resource
Locator (URL). Requests are sent from the running program in Script to a particular
Universal Resource Identifier (URI) following standard HTTP protocols.
The syntax for SendWebRequest is as follows:
SendWebRequest(BaseUrl,Method,ContentType,Headers,Message)
where:
• BaseUrl – A string with the location of the base URL to request data.
• Method – A string that contains the method type to access the URL. It can
take the following values:
– "POST"
– "GET"
• Headers – The headers for the HTTP message. Header fields are colon-
separated name-value pairs that can be concatenated with semi-colons (for
example, "IsMobileApp:TRUE;IsAndroidClient:TRUE")
• ContentType – A string that contains the content type. It is usually defined by
the target URL itself.
• Message – A string that contains the message sent to the URL. It is usually in
query-string values.
The return value is a string, usually in XML, that contains the response from the Web
Service.
53.7.2 UrlEncode
The UrlEncode system function encodes the entire URL, including the message
with its query-string values. If characters, such as blanks, punctuation marks, and
arithmetic are passed directly to the HTTP stream, they may be misinterpreted and
result in the return of incorrect results. This function converts characters that are not
allowed in a URL into their equivalents.
The syntax for UrlEncode is as follows:
UrlEncode(Message)
04-16006-04-en, March 2015 Technical
1933
53 Script Web Services
53.7 Script RESTful Web Services
where:
Message is a string that needs Url encoding.
The return value is a string with valid characters the HTTP stream transmits.
Technical 04-16006-04-en, March 2015
1934
53 Script Web Services
53.8 Using Script to Send a Request to a RESTful Web Service
53.8 Using Script to Send a Request to a
RESTful Web Service
You can use the SendWebRequest system function to send a request to a RESTful
Web Service. In this procedure, you use SendWebRequest to request US city
weather data.
For more information, see section 53.7 “Script RESTful Web Services” on page
1931.
To use Script to send a request to a RESTful Web Service
1. In WorkStation, in the System Tree pane, select the server or folder where
you want to create a Script program.
2. On the File menu, point to New and then click Program.
3. In the Name box, enter the name of your new Script program, such as Get US
City Weather by ZIP.
4. In the Description box, type a description of the program.
5. Click Create.
6. In the List View, click the new Weather by ZIP Script program.
7. Click Edit.
Continued on next page
04-16006-04-en, March 2015 Technical
1935
53 Script Web Services
53.8 Using Script to Send a Request to a RESTful Web Service
8. Develop a Script program using the SendWebRequest system function and
the following parameters:
• BaseUrl – http://wsf.cdyne.com
• Method – GET
• ContentType – txt/xml
• Headers – ""
• Message –
/WeatherWS/Weather.asmx/GetCityWeatherbyZIP?ZIP=02109
9. In the Script Editor toolbar, click Save.
10. Close the Script Editor.
11. In the List View, click the Get US City Weather by ZIP Script program.
12. In the Actions menu, click Restart to start the Script program.
13. On the File menu, click File and then Properties.
Continued on next page
Technical 04-16006-04-en, March 2015
1936
53 Script Web Services
53.8 Using Script to Send a Request to a RESTful Web Service
14. Click the Outputs tab and observe the resultXMLString output for zip code
02109.
The current weather for Boston is as follows:
• Description – Cloudy
• Temperature – 34°F
• Relative Humidity – 72%
• Wind - North at 13 MPH
• Barometric Pressure – 30.45 Steady
04-16006-04-en, March 2015 Technical
1937
53 Script Web Services
53.9 Using Script to Obtain a Secure Web Page from a RESTful Web Service
53.9 Using Script to Obtain a Secure Web
Page from a RESTful Web Service
You can use the SendWebRequest system function to obtain a secure web page
from a RESTful Web Service. In this procedure, you obtain a secure SSL certificate
authority page.
For more information, see section 53.7 “Script RESTful Web Services” on page
1931.
To use Script to obtain a secure web page from a RESTful Web
Service
1. In WorkStation, in the System Tree pane, select the server or folder where
you want to create a Script program.
2. On the File menu, click New and Program.
3. In the Name box, type the name of your new Script program, such as Get
Secure Web Page.
4. In the Description box, enter a description of the program.
5. Click Create.
6. In the List View, click the new Get Secure Web Page program.
7. Click Edit.
Continued on next page
Technical 04-16006-04-en, March 2015
1938
53 Script Web Services
53.9 Using Script to Obtain a Secure Web Page from a RESTful Web Service
8. Develop a Script program using the SendWebRequest system function and
the following parameters:
• BaseUrl – https://ssl.trustwave.com
• Method – GET
• ContentType – txt/xml
• Headers – ""
• Message – None
9. In the Script Editor toolbar, click Save.
10. Close the Script Editor.
11. In the List View, click the Get Secure Web Page Script program.
12. In the Actions menu, click Restart to start the Script program.
13. On the File menu, click File and then Properties.
Continued on next page
04-16006-04-en, March 2015 Technical
1939
53 Script Web Services
53.9 Using Script to Obtain a Secure Web Page from a RESTful Web Service
14. Click the Outputs tab and observe the webPageString output.
Technical 04-16006-04-en, March 2015
1940
54 Script User Interface
Topics
Script Editor
Script Editor Toolbars
Script Editor – Binding Variables Pane
Script Editor – Local Variables Pane
Script Editor Shortcut Menu
Import Plain English Dialog Box
Script Program Properties – Basic Tab
Script Program Properties – Advanced Tab
Script Program Properties – Inputs Tab
Script Program Properties – Outputs Tab
Script Program Properties – Publics Tab
Script Program Properties – Functions Tab
Script Program Properties – Web Services Tab
Script Function Properties – Basic Tab
Script Function Properties – Inputs Tab
Script Function Properties – Outputs Tab
Script Function Properties – Publics Tab
Script Function Properties – Functions Tab
Script Web Service – Basic Tab
Script Web Service – Methods Tab
54 Script User Interface
54.1 Script Editor
54.1 Script Editor
Use the Script Editor to develop Script programs.
Figure:
Table: Script Editor
Number Description
Script Editor Toolbars
Use the toolbars to perform a variety of
functions, including opening, closing, saving,
printing, importing, and exporting Script
programs.
Clipboard pane
Use this pane to store copied and cut items
to use in Script programming. By double-
clicking on an item in the clipboard pane,
you can insert that text into the program
where the cursor is currently located.
04-16006-04-en, March 2015 Technical
1943
54 Script User Interface
54.1 Script Editor
Continued
Number Description
Status bar
Use this pane to review the path of the active
Script program or function. You can view the
line and column where the cursor is
positioned within the current editor pane.
The status bar also identifies the input
method, Insert or Overwrite, currently being
used in the editor.
Code Library pane
Use this pane to create and display the
folders and entries contained within your
code library. You can use the Code Library
to create multiple folders to save, organize,
and recall frequently used text. You can also
use the system-provided programs and
functions available in the Code Library when
developing your Script programs and
functions.
Properties pane
Use this pane to view and change general,
configuration, and runtime information about
your Script programs and fuctions and their
inputs and outputs tabs.
Local Variables pane
Binding Variables pane
Use these panes to view and edit properties
of the local or binding variables in the Script
Editor.
For more information, see section 54.4
“Script Editor – Local Variables Pane” on
page 1948.
For more information, see section 54.3
“Script Editor – Binding Variables Pane” on
page 1947.
Check pane
Use this pane to review the results of your
program compilation, including any syntax
errors. If the Script Editor checks a program
and finds no errors, a Check Successful
message displays. If errors occur, they
display with the error message number, line
and column location within the program, and
text or keywords involved.
Technical 04-16006-04-en, March 2015
1944
54 Script User Interface
54.1 Script Editor
Continued
Number Description
Find pane
Use this pane to locate and display queried
text. The Find pane displays the queried text
in quotes on the first line of the pane, the
open program the instance is located in, the
line number within the program where the
text can be found, and the context in which
the queried text is found.
Bindings view
Click to display the Bindings view for a Script
program. You can access the Bindings view
without leaving the Script Editor. For more
information, see section 50.16 “Local
Variable Declarations” on page 1592.
04-16006-04-en, March 2015 Technical
1945
54 Script User Interface
54.2 Script Editor Toolbars
54.2 Script Editor Toolbars
Use the Script Editor toolbar to perform a variety of different tasks within the
application.
Figure: Script Editor toolbars
Table: Script Editor Toolbars
Button Description
Open
Click to open an existing Script or b3
program or function.
Save
Click to save the currently active program.
Save All
Click to save all open programs.
Print
Click to print the current program.
Cut
Click to cut the selected text.
Copy
Click to copy the selected text.
Paste
Click to paste text.
Window
Click to open a pane or activate a minimized
pane.
Options
Click to configure program editor options
such as fonts, colors, layout, and code
library path.
Refresh
Click to refresh the focus window in the
Script Editor.
Technical 04-16006-04-en, March 2015
1946
54 Script User Interface
54.2 Script Editor Toolbars
Continued
Button Description
Script Bindings
Click to display the read-only Script Binding
View which shows the path for the local
bindings variables in your Script programs.
Check
Click to check a program file for syntax
errors.
Check All
Click to check all open program files for
syntax errors.
Start
Initiates a Script Debugger session. As the
debugger proceeds, it highlights the current
executing line in the Script program.
Stop
Terminates a Script Debugger session.
Trace On
Initiates a continuous single step operation
without the need to keep pressing the Step
icon.
Trace Off
Terminates the continuous single step
operation.
Go
Continuously executes a Script program until
a breakpoint is reached or execution ends.
Step
Goes to the next executing line in the Script
program.
Find
Click to find a specific word in the current
program.
Replace
Click to replace a specific word in the current
program.
Help
Click to view help topics for Script
programming.
04-16006-04-en, March 2015 Technical
1947
54 Script User Interface
54.2 Script Editor Toolbars
Continued
Button Description
Script menu button
Click to open the Script menu.
Script menu
Click to open, save, import, export, print, or
close a program. Export exports the current
Script object to a text file. Import imports
text from a text file, or opens the Import
Plain English dialog box which allows you
to import Plain English text for conversion.
For more information, see section 54.6
“Import Plain English Dialog Box” on page
1951.
Save
Click to save a Script program or function.
Undo
Click to undo or revert back one keystroke
or action in the Script Editor to the last state
of the text.
Redo
Click to redo or move ahead one keystroke
or action in the Script Editor to the state of
the text which was previously undone.
Customize quick access toolbar
Click to access the Customize quick
access toolbar dialog box where you can
add or remove additional buttons from the
Quick access toolbar.
Technical 04-16006-04-en, March 2015
1948
54 Script User Interface
54.3 Script Editor – Binding Variables Pane
54.3 Script Editor – Binding Variables Pane
Use the Binding Variables pane to view and edit the properties of the binding
variables in Script Editor. If the Script program is executing, this pane is
automatically updated with the current variable values.
Figure: Script Editor - binding variables pane
Table: Binding Variables Pane
Component Description
Name Displays the variable name.
Value Displays the variable value.
Type Displays the variable type. For more
information, see section 51.71 “Variables
Pane Types” on page 1732.
Unit Displays the variable unit. Property values
bound to the program are automatically
converted to this unit.
Property Displays the path of the property bound to
the variable.
Initial value Provides a text box, dropdown, or date and
time picker you can use to configure the
initial binding variable values in your Script
program. For more information, see section
52.12 “Script Editor Initial Binding Variable
Values” on page 1874.
04-16006-04-en, March 2015 Technical
1949
54 Script User Interface
54.4 Script Editor – Local Variables Pane
54.4 Script Editor – Local Variables Pane
Use the Local Variables pane to view and edit the properties of the local variables
in the Script Editor, including arrays. The display limit is the first 1,000 elements of
an array.
Figure: Script Editor – local variables pane
Table: Local Variables Pane
Component Description
Name Displays the variable name.
Value Displays the variable value.
Type Displays the variable type. For more
information, see section 51.71 “Variables
Pane Types” on page 1732.
Technical 04-16006-04-en, March 2015
1950
54 Script User Interface
54.5 Script Editor Shortcut Menu
54.5 Script Editor Shortcut Menu
Use the Script Editor shortcut menu to write or edit Script programs and
functions.
Figure: Script Editor shortcut menu
Table: Script Editor Shortcut Menu
Command Description
Go to definition Positions the cursor at the definition line for
an item within the current Script program. If
the item is a function variable that is already
bound to a function object, the cursor is
positioned at the object definition the
function is bound to (the Script function
opens in the Script Editor).
Go to declaration Positions the cursor at the declaration line
for an item within the current Script program.
If the item is a function variable that is
already bound to a function, the cursor is
positioned at the line declaring the function
variable.
Add to library Opens the Add to Code Library dialog
box where you can save code library entries.
Collapse all Collapses all the collapsible code segments.
Expand all Expands all the collapsible code segments.
Comment selected Creates comments from the selected Script
program lines.
04-16006-04-en, March 2015 Technical
1951
54 Script User Interface
54.5 Script Editor Shortcut Menu
Continued
Command Description
Uncomment selected Uncomments the selected Script program
lines.
Toggle breakpoint Inserts and removes a breakpoint at the
selected program line in the Script
Debugger.
Set Next Statement Highlights the next program statement in the
Script Debugger.
Find Opens the Find tab in the Find and
Replace dialog box where you can find a
specific word in the current program.
Replace Opens the Replace tab in the Find and
Replace dialog box. You can then replace a
specific word in the current program.
Goto Opens the Goto dialog box. You can then
enter a program line to jump to.
Technical 04-16006-04-en, March 2015
1952
54 Script User Interface
54.6 Import Plain English Dialog Box
54.6 Import Plain English Dialog Box
Use the Import Plain English dialog box to import Plain English programs and
functions into Script.
Figure: Import Plain English dialog box
Table: Import Plain English Dialog Box
Component Description
Load file Click to locate and load the Plain English file
that you want to add to your current Script
Editor program or function.
Display pane Use this pane to view and edit the PE
program or function that you want to load in
the Script Editor.
Editor pane Use this pane to review the results of your
Plain English program or function
conversion. If the Script Editor conversion
tool checks a program and finds no errors, a
Converting and then Conversion
Successful message displays. If errors
occur, they display with the error message
number, line and column location within the
program, and text or keywords involved.
04-16006-04-en, March 2015 Technical
1953
54 Script User Interface
54.6 Import Plain English Dialog Box
Continued
Component Description
Convert all Use this button to convert all of the text in
the Plain English program or function to
Script.
Convert selected Use this button to convert the selected text
in the Plain English program or function to
Script.
Close Use this button to close the Import Plain
English dialog box.
Technical 04-16006-04-en, March 2015
1954
54 Script User Interface
54.7 Script Program Properties – Basic Tab
54.7 Script Program Properties – Basic Tab
Use the Basic tab to view and change general, configuration, runtime, and status
information about your Script programs.
Figure: Script program properties - basic tab
Table: Basic Tab
Component Description
Compilation valid Displays whether the program compiled
successfully.
Status Displays the program status.
Current line Displays the program's current line.
Line start time Displays the program's line start time.
TS Displays the number of seconds that have
elapsed since the program has been on the
current line.
04-16006-04-en, March 2015 Technical
1955
54 Script User Interface
54.7 Script Program Properties – Basic Tab
Continued
Component Description
TM Displays the number of minutes that have
elapsed since the program has been on the
current line.
TH Displays the number of hours that have
elapsed since the program has been on the
current line.
TD Displays the number of days that have
elapsed since the program has been on the
current line.
Scan Specifies the length in seconds of the last
interpreter interval.
Error Indicates whether the program ran
successfully or encountered an error.
Enabled Displays whether or not the program is
enabled.
Task Enter the task you wish to execute. For more
information, see section 50.23 “Tasks” on
page 1602.
Execution precedence Select the order in which two programs are
run when the two programs are in the same
task. Applies when there is a loop
connection between them such that the
input of one program is actually the output of
another. For more information, see section
50.25 “Program Cycles in Building
Operation ” on page 1604.
Flow type Select the Looping or FallThru flow type
to order the way Script program instructions
are arranged and executed.
Apply Initial Value Select Yes to apply the initial values of the
binding variables. The default No does not
apply the values, thus ensuring, for example,
that an output point does not reset every
time a program that binds to one of its own
output variables is saved.
Debug mode Displays either On or Off to indicate visually
whether the Script Editor is in Debug mode.
This is a read-only setting.
Technical 04-16006-04-en, March 2015
1956
54 Script User Interface
54.8 Script Program Properties – Advanced Tab
54.8 Script Program Properties – Advanced
Tab
Use the Advanced tab to add or remove object properties that trigger the Script
program currently being edited.
Figure: Script program properties - advanced tab
Table: Advanced Tab
Component Description
Triggers Adds or removes object properties that
trigger the Script program currently being
edited. Any object property value change
triggers or executes the Script program.
Click Add to browse and select the desired
object property, or Edit to modify a selected
item in the Triggers list. Uncheck the box
preceding the object property to remove that
item from the list.
04-16006-04-en, March 2015 Technical
1957
54 Script User Interface
54.9 Script Program Properties – Inputs Tab
54.9 Script Program Properties – Inputs Tab
Use the Inputs tab to display the input bindings associated with the Script
program.
Figure: Script program properties - inputs tab
Table: Inputs Tab
Component Description
[Property Name] Select the value of the bound property. Use
the up and down arrow keys to increment
the value up or down by .5 of a point. Click
the Configure Settings icon to open
the [Property name] dialog and its
Configuration and Operation tabs.
Technical 04-16006-04-en, March 2015
1958
54 Script User Interface
54.10 Script Program Properties – Outputs Tab
54.10 Script Program Properties – Outputs
Tab
Use the Outputs tab to display output bindings associated with the Script
program.
Figure: Script program properties - outputs tab
Table: Outputs Tab
Component Description
[Property Name] Select the value of the bound property. Use
the up and down arrow keys to increment
the value up or down by .5 of a point. Click
the Configure Settings icon to open
the [Property name] dialog and its
Configuration and Operation tabs.
04-16006-04-en, March 2015 Technical
1959
54 Script User Interface
54.11 Script Program Properties – Publics Tab
54.11 Script Program Properties – Publics Tab
Use the Publics tab to display public bindings associated with your Script
programs.
Figure: Script program properties - publics tab
Table: Publics Tab
Component Description
[Property Name] Select the value of the bound property. Use
the up and down arrow keys to increment
the value up or down by .5 of a point. Click
the Configure Settings icon to open
the [Property name] dialog and its
Configuration and Operation tabs.
Technical 04-16006-04-en, March 2015
1960
54 Script User Interface
54.12 Script Program Properties – Functions Tab
54.12 Script Program Properties – Functions
Tab
Use the Functions tab to display output bindings associated with the Script
function.
Figure: Script program properties - functions tab
Table: Functions Tab
Component Description
[Function Name] Select the value of the bound property. Use
the up and down arrow keys to increment
the value up or down by .5 of a point. Click
the Configure Settings icon to open
the [Property name] dialog and its
Configuration and Operation tabs.
04-16006-04-en, March 2015 Technical
1961
54 Script User Interface
54.13 Script Program Properties – Web Services Tab
54.13 Script Program Properties – Web
Services Tab
Use the Web Services tab to select and bind the displayed service to the Web
Service interface you created.
Figure: Script program properties - Web Services tab
Table: Web Services Tab
Component Description
[service name] Displays the Web Service name. Select and
bind this service to the Web Service interface
you created. For more information, see
section 53.3 “Creating a Script Web Service
Interface” on page 1921.
Technical 04-16006-04-en, March 2015
1962
54 Script User Interface
54.14 Script Function Properties – Basic Tab
54.14 Script Function Properties – Basic Tab
Use the Basic tab to view and change general and configuration information about
your Script functions.
Figure: Script function properties - basic tab
Table: Basic Tab
Component Description
Compilation valid Displays whether the program compiled
successfully.
04-16006-04-en, March 2015 Technical
1963
54 Script User Interface
54.15 Script Function Properties – Inputs Tab
54.15 Script Function Properties – Inputs Tab
Use the Inputs tab to display the input bindings associated with the Script
function.
Figure: Script function properties - inputs tab
Table: Inputs Tab
Component Description
[Property Name] Set the value of the bound property. Use the
up and down arrow keys to increment the
value up or down by .5 of a point. Click the
Configure Settings icon to open the
[Property name] dialog and its Operation tab.
Technical 04-16006-04-en, March 2015
1964
54 Script User Interface
54.16 Script Function Properties – Outputs Tab
54.16 Script Function Properties – Outputs
Tab
Use the Outputs tab to display output bindings associated with the Script function.
Figure: Script function properties - outputs tab
Table: Outputs Tab
Component Description
[Property name] Set the value of the bound property. Use the
up and down arrow keys to increment the
value up or down by .5 of a point. Click the
Configure Settings icon to open the
[Property name] dialog and its Operation tab.
04-16006-04-en, March 2015 Technical
1965
54 Script User Interface
54.17 Script Function Properties – Publics Tab
54.17 Script Function Properties – Publics Tab
Use the Publics tab to display public bindings associated with the Script function.
Figure: Script function properties - publics tab
Table: Publics Tab
Component Description
[Property Name] Set the value of the bound property. Use the
up and down arrow keys to increment the
value up or down by .5 of a point. Click the
Configure Settings icon to open the
[Property name] dialog and its Operation tab.
Technical 04-16006-04-en, March 2015
1966
54 Script User Interface
54.18 Script Function Properties – Functions Tab
54.18 Script Function Properties – Functions
Tab
Use the Functions tab to display function bindings associated with the Script
function.
Figure: Script function properties - functions tab
Table: Functions Tab
Component Description
[Function name] Set the value of the bound property. Use the
up and down arrow keys to increment the
value up or down by .5 of a point. Click the
Configure Settings icon to open the
[Property name] dialog and its Operation tab.
04-16006-04-en, March 2015 Technical
1967
54 Script User Interface
54.19 Script Web Service – Basic Tab
54.19 Script Web Service – Basic Tab
Use the Basic tab to specify the location, identify the Web Service, and provide a
mechanism for retrieving it.
Figure: Script Web Service - basic tab
Table: Basic Tab
Component Description
Wsdl Url Type the URL for the WSDL file. The URL
must end with ?wsdl. SOAP 1.1 and 1.2 files
are supported here.
Service Select the Web Service you want to target.
For more information, see section 53.6
“Script SOAP Web Services Data Type” on
page 1927.
EndPoint Type the Web Service endpoint. For more
information, see section 53.6 “Script SOAP
Web Services Data Type” on page 1927.
Technical 04-16006-04-en, March 2015
1968
54 Script User Interface
54.20 Script Web Service – Methods Tab
54.20 Script Web Service – Methods Tab
Use the Methods tab to view a list of the methods supported by Web Services.
Figure: Sript Web Services - methods tab
Table: Methods Tab
Component Description
Methods Displays the list of methods supported by
the Web Service. Methods are the functions
that a Web Service can execute. SOAP 1.1
and 1.2 are supported here.
04-16006-04-en, March 2015 Technical
1969
55 LonWorks Introduction
Topics
LonWorks Overview
LonWorks Engineering
LonWorks Interfaces
LonWorks in the Automation Server
LonWorks in the Enterprise Server
LonWorks NIC709-USB Interface
LonWorks NIC709-PCI Interface
LonWorks NIC709-IP Interface
LonWorks NIC852 Interface
L-IP Router Setup
Externally Managed LonWorks Network
Creating a LonWorks Interface
Discovering a LonWorks Interface
Configuring a LonWorks Interface
Creating a LonWorks Network
Configuring a LonWorks Network
Creating an Externally Managed LonWorks Network
Changing the Domain ID for a LonWorks Network
55 LonWorks Introduction
55.1 LonWorks Overview
55.1 LonWorks Overview
LonWorks is a fieldbus standard that is used for the automation of various functions
within buildings, such as lighting and HVAC. The platform is built on an open,
scalable protocol, called LonTalk that was developed by Echelon Corporation and
supported by LonMark International.
For more information, visit the LonMark website.
55.1.1 LonWorks Engineering
LonWorks engineering covers topics that describe how you use Building Operation
to configure and commission an automation system based on the LonWorks
fieldbus standard.
For more information, see section 55.2 “LonWorks Engineering” on page 1972.
55.1.2 LonWorks Operating
LonWorks operating covers topics that describe how you use Building Operation to
supervise and manage an automation system based on the LonWorks fieldbus
standard.
For more information, see section 59.11 “LonWorks Operating” on page 2127.
55.1.3 LonWorks Maintenance
LonWorks maintenance covers topics that describe how you use Building
Operation to replace hardware and troubleshoot an automation system based on
the LonWorks fieldbus standard.
For more information, see section 59.1 “LonWorks Maintenance” on page 2113.
04-16006-04-en, March 2015 Technical
1973
55 LonWorks Introduction
55.2 LonWorks Engineering
55.2 LonWorks Engineering
LonWorks engineering covers topics that describe how you use Building Operation
to configure and commission an automation system based on the LonWorks
fieldbus standard.
LonWorks devices communicate with network variables and can be configured with
configuration properties. Each LonWorks device has a predefined number of
variables and properties organized in functional blocks that are tailored for certain
tasks, such as temperature measuring and actuator control.
Figure: LonWorks communication overview
LonWorks bindings provide for efficient communication as they can be configured
to send and receive values according to rules, instead of having different
applications polling the devices.
Enterprise Servers and Automation Servers can have a local node on their networks
that can act as LonWorks node. By defining NVs and LonWorks bindings on the
local node, you can communicate with LonWorks devices in a very efficient way.
The functionality of a device is described in a device template, which is declared in a
XIF file. When a XIF is imported, the functional blocks, NVs, and CPs of the device
type are added to the Building Operation configuration.
Technical 04-16006-04-en, March 2015
1974
55 LonWorks Introduction
55.2 LonWorks Engineering
Figure: Resource files(DRF) and device template(XIF) in Building Operation
55.2.1 LonWorks Interfaces
Building Operation servers connect to LonWorks networks through various
LOYTEC interfaces and communicate with LonWorks devices over EIA-709 (FT-10)
or EIA 852 (Ethernet).
For more information, see section 68.3 “LonWorks Interfaces” on page 2358.
55.2.2 LonWorks Devices
LonWorks devices are commonly called devices or nodes in LonWorks
documentation. Each LonWorks device includes local processing (Neuron Chip or
similar) and often I/O hardware to process input data from sensors, execute a
control task, and control actuators. Each device also includes the capability to
communicate with other devices using the LonTalk protocol in firmware.
For more information, see section 56.1 “LonWorks Devices” on page 2005.
55.2.3 LonWorks Local Node
Enterprise Servers and Automation Servers can have a local node on their networks
that can act as a LonWorks node.
For more information, see section 57.1 “LonWorks Local Node” on page 2065.
55.2.4 LonWorks Bindings
LonWorks bindings differ from other Building Operation bindings because you can
set LonWorks specific properties, such as LonWorks binding profiles.
For more information, see section 58.1 “LonWorks Bindings ” on page 2093.
04-16006-04-en, March 2015 Technical
1975
55 LonWorks Introduction
55.3 LonWorks Interfaces
55.3 LonWorks Interfaces
Building Operation servers connect to LonWorks networks through various
LOYTEC interfaces and communicate with LonWorks devices over EIA-709 (FT-10)
or EIA 852 (Ethernet).
Figure: LonWorks in Building Operation
Technical 04-16006-04-en, March 2015
1976
55 LonWorks Introduction
55.3 LonWorks Interfaces
55.3.1 LonWorks in the Automation Server
The Automation Server connects to LonWorks networks through a built-in LOYTEC
FT interface and communicates with LonWorks devices over EIA-709 (FT-10).
For more information, see section 55.4 “LonWorks in the Automation Server” on
page 1976.
55.3.2 LonWorks in the Enterprise Server
The Enterprise Server connects to LonWorks networks through various LOYTEC
NIC-interfaces and communicates with LonWorks devices over EIA-709 (FT-10) or
EIA-852 (Ethernet).
For more information, see section 55.5 “LonWorks in the Enterprise Server” on
page 1977.
55.3.3 Externally Managed LonWorks Network
You can connect an externally managed LonWorks network to Building Operation
through an Automation Server, in order to view and represent that same LonWorks
network data in WorkStation. The externally managed network is configured and
managed, through LNS, with an external LonWorks manager tool connected to the
network.
For more information, see section 55.11 “Externally Managed LonWorks Network”
on page 1991.
04-16006-04-en, March 2015 Technical
1977
55 LonWorks Introduction
55.4 LonWorks in the Automation Server
55.4 LonWorks in the Automation Server
The Automation Server connects to LonWorks networks through a built-in LOYTEC
FT interface and communicates with LonWorks devices over EIA-709 (FT-10).
Figure: Automation server and LonWorks.
Each Automation Server has one physical LonWorks interface, which can connect
to one LonWorks network. For more information, see the Automation Servers topic
on WebHelp.
Technical 04-16006-04-en, March 2015
1978
55 LonWorks Introduction
55.5 LonWorks in the Enterprise Server
55.5 LonWorks in the Enterprise Server
The Enterprise Server connects to LonWorks networks through various LOYTEC
NIC-interfaces and communicates with LonWorks devices over EIA-709 (FT-10) or
EIA-852 (Ethernet).
Figure: Various LOYTEC NIC-interfaces
The NIC-LOYTEC Network Interface Software package includes NIC Legacy
Drivers and the L-Config Tool to configure and enable the LOYTEC network
interfaces. The package also includes the documentation for installing the network
interfaces. For more information and for downloads, visit the LOYTEC website.
55.5.1 LonWorks NIC709-PCI Interface
The Enterprise Server can be connected to a LonWorks FT network with a LOYTEC
NIC709-PCI interface.
04-16006-04-en, March 2015 Technical
1979
55 LonWorks Introduction
55.5 LonWorks in the Enterprise Server
For more information, see section 55.7 “LonWorks NIC709-PCI Interface” on page
1980.
55.5.2 LonWorks NIC709-USB Interface
The Enterprise Server can be connected to a LonWorks FT network with a LOYTEC
NIC709-USB interface.
For more information, see section 55.6 “LonWorks NIC709-USB Interface” on page
1979.
55.5.3 LonWorks NIC709-IP Interface
The Enterprise Server can be connected to a LonWorks FT network with a LOYTEC
NIC709-IP interface.
For more information, see section 55.8 “LonWorks NIC709-IP Interface” on page
1981.
55.5.4 LonWorks NIC852 Interface
The Enterprise Server can be connected to a LonWorks FT network with a LOYTEC
NIC852 interface.
For more information, see section 55.9 “LonWorks NIC852 Interface” on page
1982.
Note
• You need a LonTalk license USB service dongle to use NIC852.
Technical 04-16006-04-en, March 2015
1980
55 LonWorks Introduction
55.6 LonWorks NIC709-USB Interface
55.6 LonWorks NIC709-USB Interface
The Enterprise Server can be connected to a LonWorks FT network with a LOYTEC
NIC709-USB interface.
Figure: Basic LonWorks network with Enterprise Server with NIC709-USB.
In WorkStation, you use the LonWorks port on the Enterprise Server to represent a
NIC709-USB interface connected to an USB port.
Several network interfaces can be installed in the Enterprise Server so that several
LonWorks FT networks can be connected.
04-16006-04-en, March 2015 Technical
1981
55 LonWorks Introduction
55.7 LonWorks NIC709-PCI Interface
55.7 LonWorks NIC709-PCI Interface
The Enterprise Server can be connected to a LonWorks FT network with a LOYTEC
NIC709-PCI interface.
Figure: Basic LonWorks network with Enterprise Server with NIC709-PCI.
In WorkStation, you use the LonWorks interface on the Enterprise Server to
represent a NIC709-PCI interface installed in the PCI bus.
Several network interfaces can be installed in the Enterprise Server so that several
LonWorks FT networks can be connected.
Technical 04-16006-04-en, March 2015
1982
55 LonWorks Introduction
55.8 LonWorks NIC709-IP Interface
55.8 LonWorks NIC709-IP Interface
The Enterprise Server can be connected to a LonWorks FT network with a LOYTEC
NIC709-IP interface.
Figure: Basic LonWorks network with Enterprise Server with NIC709-IP
In WorkStation, you use the LonWorks interface on the Enterprise Server to
represent a NIC709-IP interface on the IP network.
This is called a Remote Network Interface, RNI, where the Enterprise Server is the
client and the NIC-IP interface is the RNI server.
Several network interfaces can be installed in the Enterprise Server so that several
LonWorks FT networks can be connected.
04-16006-04-en, March 2015 Technical
1983
55 LonWorks Introduction
55.9 LonWorks NIC852 Interface
55.9 LonWorks NIC852 Interface
The Enterprise Server can be connected to a LonWorks FT network with a LOYTEC
NIC852 interface.
Figure: Basic LonWorks network with Enterprise Server with NIC852-IP.
In WorkStation. you use the LonWorks interface on the Enterprise Server to
represent a LonWorks/IP router on the IP network using the EIA-852 protocol.
The 852 specification provides for multiple 852 channels on the same IP network,
which means that you can have several LonWorks FT channels integrated in one
LonWorks network.
With NIC852, you can integrate several LonWorks FT channels in Building
Operation and also create LonWorks bindings between devices on different
channels. (NIC709-IP can only have LonWorks bindings within its networks.)
If you have LonWorks/IP devices, you can connect these directly to the IP network
without the L-IP router.
Technical 04-16006-04-en, March 2015
1984
55 LonWorks Introduction
55.9 LonWorks NIC852 Interface
Note
• You need a LonTalk licence, which you can obtain by a USB service dongle
or software activation.
• You need to enable one of the L-IP routers to act as configuration server in
the LonWorks network.
55.9.1 L-IP Router Setup
The L-IP router from LOYTEC incorporates the NIC852 interface. Relevant software
downloads and user documentation is provided by LOYTEC. For more information,
visit the LOYTEC website.
This topic is a complement to existing LOYTEC documentation and a guideline
regarding the setup of the L-IP router in a Building Operation context.
04-16006-04-en, March 2015 Technical
1985
55 LonWorks Introduction
55.10 L-IP Router Setup
55.10 L-IP Router Setup
The L-IP router from LOYTEC incorporates the NIC852 interface. Relevant software
downloads and user documentation is provided by LOYTEC. For more information,
visit the LOYTEC website.
This topic is a complement to existing LOYTEC documentation and a guideline
regarding the setup of the L-IP router in a Building Operation context.
In this installation example, we include two L-IP devices, the Enterprise Server, and
assign one of them to be the configuration server. We use L-IP devices with factory
default values, and a PC with no previous installation of LOYTEC software.
55.10.1 Step 1: PC Setup
Install the Building Operation software package. In this example, you use the
Enterprise Server, the Software Administrator, and WorkStation.
Technical 04-16006-04-en, March 2015
1986
55 LonWorks Introduction
55.10 L-IP Router Setup
Figure: PC setup
When the Building Operation software is installed, proceed with the following tasks:
• In the Software Administrator, stop the Enterprise Server.
• Install the NIC software package from LOYTEC.
• Activate LonTalk licence with USB service dongle or software activation.
• In the Software Administrator, start the Enterprise Server again.
04-16006-04-en, March 2015 Technical
1987
55 LonWorks Introduction
55.10 L-IP Router Setup
55.10.2 Step 2: L-IP Device Configuration
Use a terminal program and an RS232 cable to connect to the L-IP device console.
Figure: L-IP device donfiguration
Use the following COM port settings when connecting to the console:
• Bits per second: 38 400
• Data bits: 8
• Parity: None
Technical 04-16006-04-en, March 2015
1988
55 LonWorks Introduction
55.10 L-IP Router Setup
• Stop bits: 1
• Flow control: None
In the L-IP device console, in the IP configuration menu, type the following
information:
• IP Address for the device
• IP Netmask
• IP Gateway
Save the IP configuration and Reset the L-IP device.
Connect to the other L-IP device and repeat the process.
Tip
On the L-IP devices, the router mode must physically be set to Smart Switch
Mode (DIP).
55.10.3 Step 3: Configuration Server Setup
One of the L-IP devices must act as configuration server as well. The configuration
server coordinates the Enterprise Server and the L-IP device(s) that interface the
LonWorks network.
The clients, the L-IP devices and the Enterprise Server, communicate through port
1628 (default). The configuration server communicates with its clients through port
1629 (default).
The configuration server and the L-IP device, on which it resides, share the same IP
address but use different ports.
Figure: Port communication
Use a web browser to connect to the L-IP device that you want to enable as
configuration server.
04-16006-04-en, March 2015 Technical
1989
55 LonWorks Introduction
55.10 L-IP Router Setup
Figure: Configuration server setup
In the EIA-852 Server section, select Config server status = Enabled.
In the EIA-852 Ch. List section, you can see the client L-IP device on which the
configuration server resides. Now add the other clients:
• Click Add Device, type the IP address of the other L-IP device and click Save.
• Click Add Device, type the IP address of the Enterprise Server and click Save.
Technical 04-16006-04-en, March 2015
1990
55 LonWorks Introduction
55.10 L-IP Router Setup
55.10.4 Step 4: Enterprise Server Setup
Open the LConfig tool from LOYTEC to configure the Enterprise Server.
Figure: Enterprise Server setup
04-16006-04-en, March 2015 Technical
1991
55 LonWorks Introduction
55.10 L-IP Router Setup
In the NIC852 tab, click CNIP Configuration. In the Conf. Server IP addr. box, type
the IP address of the configuration server. Click OK.
In the NIC852 tab, click Advanced. Select Run as Service and click OK.
In the NIC852 tab, increase both MNI settings to their maximum.
Figure: MNI settings
Click Test Device / Serial Number. The test should pass.
Click OK.
55.10.5 Step 5: Final Test
Use a web browser and connect to the configuration server again.
In the EIA-852 Ch. List section, click Reload.
Figure: Stat Flags
All Stat Flags should indicate registered.
Now you can log into WorkStation and discover the EIA-852 Interface. For more
information, see section 55.13 “Discovering a LonWorks Interface” on page 1994.
Technical 04-16006-04-en, March 2015
1992
55 LonWorks Introduction
55.11 Externally Managed LonWorks Network
55.11 Externally Managed LonWorks Network
You can connect an externally managed LonWorks network to an Automation
Server, so you can view the LonWorks network data in WorkStation. You use an
external LonWorks manager tool through LNS to configure and manage the
network.
Figure: Externally managed LonWorks interface
You cannot use WorkStation to create or manage bindings in the externally
managed network. All maintenance of bindings or of the network in the external
LonWorks network are managed through LNS in an external LonWorks manager,
such as NL-220 or LonMaker. See the Newron System or Echelon website.
The network variables in the Automation Server can be viewed in WorkStation. The
Building Operation bindings, trend logs, charts can be created within Building
Operation.
04-16006-04-en, March 2015 Technical
1993
55 LonWorks Introduction
55.11 Externally Managed LonWorks Network
When you create the externally managed LonWorks network, a local node is
automatically created. In the local node, it is possible to create any necessary
functional blocks. For more information, see section 57.1 “LonWorks Local Node”
on page 2065.
Figure: Externally managed LonWorks network local node with objects
Note
You cannot create any other LonWorks network in the Automation Server used
for the externally managed LonWorks network.
Technical 04-16006-04-en, March 2015
1994
55 LonWorks Introduction
55.12 Creating a LonWorks Interface
55.12 Creating a LonWorks Interface
You create a LonWorks interface under the Building Operation server to connect to
a LonWorks network.
For more information, see section 55.1 “LonWorks Overview” on page 1971.
To create a LonWorks interface
1. In WorkStation, in the System Tree pane, select the server where you want
to create the interface.
2. On the File menu, point to New and then click Interface.
3. In the object type list, select LonWorks Local FT-10 Interface or
LonWorks Interface.
4. In the Name box, type a name for the interface.
5. In the Description box, type a description.
6. Click Create.
You can now discover the interface and/or create the LonWorks network. You can
also configure the default settings of the interface.
04-16006-04-en, March 2015 Technical
1995
55 LonWorks Introduction
55.13 Discovering a LonWorks Interface
55.13 Discovering a LonWorks Interface
You discover a LonWorks interface to create or configure the LonWorks interface in
the Building Operation server. The LonWorks interface must be physically
connected to the Building Operation server.
For more information, see section 56.16 “LonWorks Device Workflows” on page
2029.
To discover a LonWorks interface
1. In WorkStation, in the System Tree pane, select the server that is connected
to the interface you want to discover.
2. Click the Device Discovery view.
3. In the Select device type box, select LonWorks.
4. Drag the discovered interface to the System Tree pane:
• Drag to an existing interface to associate it with the discovered physical
interface.
• Drag to the server to create the interface.
Technical 04-16006-04-en, March 2015
1996
55 LonWorks Introduction
55.14 Configuring a LonWorks Interface
55.14 Configuring a LonWorks Interface
You configure a LonWorks interface to define the network interface and its
properties.
For more information, see section 55.1 “LonWorks Overview” on page 1971.
To configure a LonWorks interface
1. In WorkStation, in the System Tree pane, select the interface you want to
configure.
2. On the File menu, click Properties.
3. Click the Basic tab.
4. Edit the basic properties:
Component Description
State Displays the interface status: Online or
Offline.
Network interface name Displays the name of the network
interface. The name is automatically set
when you drag-and-drop the interface
from the Device Discovery tab.
Maximum number of concurrent Select the maximum number of
messages messages to be transmitted at the same
time.
5. Click the Advanced tab.
6. Edit the advanced properties:
Component Description
Priority Select the priority for the alarm.
Device name Displays the name of the interface.
7. Click OK.
04-16006-04-en, March 2015 Technical
1997
55 LonWorks Introduction
55.15 Creating a LonWorks Network
55.15 Creating a LonWorks Network
You create a LonWorks network under the LonWorks interface to connect to
devices that are using the LonWorks protocol.
For more information, see section 55.1 “LonWorks Overview” on page 1971.
To create a LonWorks network
1. In WorkStation, in the System Tree pane, select the LonWorks interface
where you want to create the network.
2. On the File menu, point to New and then click LonWorks Network.
3. In the Name box, type a name for the network.
4. In the Description box, type a description.
5. Click Create.
Technical 04-16006-04-en, March 2015
1998
55 LonWorks Introduction
55.16 Configuring a LonWorks Network
55.16 Configuring a LonWorks Network
You configure a LonWorks network by editing its properties.
For more information, see section 55.1 “LonWorks Overview” on page 1971.
To configure a LonWorks network
1. In WorkStation, in the System Tree pane, select the network you want to
configure.
2. On the File menu, click Properties.
3. Click the Advanced tab.
Continued on next page
04-16006-04-en, March 2015 Technical
1999
55 LonWorks Introduction
55.16 Configuring a LonWorks Network
4. Edit the advanced properties:
Component Description
Index Displays the location of the entry in the
domain table. The first item is 0.
ID (decimal) Displays the domain ID of which the
device is a member.
Domain ID lenght Displays the byte length of the domain ID.
Subnet Displays the subnet of which the device is
a member.
Node Displays the node ID of the device. The
Local Node is always node 1.
Edit Click Edit to change domain ID.
Component Description
Classic Operator Panel Support Select Yes to get support for classic OP
functionality, that is, the OP can be
connected to any Xenta device.
Network name in blueprint Displays the current name of the network.
System alarm priority Enter the priority of Xenta non-application
alarms.
Time synchronization interval (min) Enter the time interval between
synchronization of Xenta and the server
clocks. The default value is 10.
Heartbeat (s) Enter the time interval for the server
heartbeat on the LonWorks network. The
default value is 20 s.
Component Description
Timeout (ms) Enter the amount of time in milliseconds
until Xenta communication should be
considered broken. The default is 10,000
ms.
Transmit timer (ms) Displays the time before Xenta
retransmission (if no answer).
Number of retries Enter the maximum number of attempts
before giving up. The default value is 4.
5. Click OK.
Technical 04-16006-04-en, March 2015
2000
55 LonWorks Introduction
55.17 Creating an Externally Managed LonWorks Network
55.17 Creating an Externally Managed
LonWorks Network
You create an externally managed LonWorks network to connect to an external
network that is using the LonWorks protocol.
For more information, see section 55.11 “Externally Managed LonWorks Network”
on page 1991.
To create an Externally Managed LonWorks Network
1. In WorkStation, in the System Tree pane, select the LonWorks interface
where you want to create the network.
2. On the File menu, point to New and then click Externally Managed
LonWorks Network.
3. In the Name box, type a name for the network.
4. In the Description box, type a description.
5. Click Create.
You can now discover the interface or create the externally managed LonWorks
network.
04-16006-04-en, March 2015 Technical
2001
55 LonWorks Introduction
55.18 Changing the Domain ID for a LonWorks Network
55.18 Changing the Domain ID for a
LonWorks Network
You change the domain ID for a LonWorks network to suit your requirements. For
example, you can change the domain ID to make it possible to use the same Xenta
Operator Panel on different sites.
For more information, see section 155.1 “LonTalk Addressing Overview” on page
5567.
To change the domain ID for a LonWorks network
1. In WorkStation, in the System Tree pane, select the LonWorks network that
you want to change the domain ID for.
2. On the File menu, click Properties.
3. Click the Advanced tab.
4. Under Domain table for Network Interface, select Index 0 and then click
the Edit button .
Continued on next page
Technical 04-16006-04-en, March 2015
2002
55 LonWorks Introduction
55.18 Changing the Domain ID for a LonWorks Network
5. In the ID (decimal) box, enter the domain ID.
6. Click OK.
Continued on next page
04-16006-04-en, March 2015 Technical
2003
55 LonWorks Introduction
55.18 Changing the Domain ID for a LonWorks Network
7. Click OK.
Important
• If there are commissioned devices connected to the LonWorks
network, you need to recommission all devices that indicate they
are out of sync.
Technical 04-16006-04-en, March 2015
2004
56 LonWorks Devices
Topics
LonWorks Devices
Creating a LonWorks Device
Configuring a LonWorks Device
LonWorks Commission and Decommission
Discovering a LonWorks Device
Commissioning a LonWorks Device
Decommissioning a LonWorks Device
Downloading the LonWorks Device Configuration
Uploading the LonWorks Device Configuration
LonWorks Application Upgrade
Upgrading the Device Application
LonWorks Device Templates
Importing a Device Template
Device Resource Files
Importing Device Resource Files
LonWorks Device Workflows
Create and then Discover LonWorks Device Workflow
Discover LonWorks Device Workflow
Create LonWorks Device Workflow
Network Variables and Configuration Parameters
Variable Members and Structured Variables
Network Variable and Configuration Parameter Values
Configuring a Network Variable
Configuring the Value for a Network Variable Member
Configuring a Configuration Property
LNS Plug-ins
Registering LNS Plug-ins
Unregistering LNS Plug-ins
Configuring Network Variables and Configuration
Parameters using LNS Plug-in
Importing a Device Template in LNS
Winking a Device
Adding Missing XIF and DRF Files
56 LonWorks Devices
56.1 LonWorks Devices
56.1 LonWorks Devices
LonWorks devices are commonly called devices or nodes in LonWorks
documentation. Each LonWorks device includes local processing (Neuron Chip or
similar) and often I/O hardware to process input data from sensors, execute a
control task, and control actuators. Each device also includes the capability to
communicate with other devices using the LonTalk protocol in firmware.
A LonWorks device can have an additional host processor beside the Neuron Chip.
In this case, the application can execute on the host processor and the Neuron
Chip can be used as the network interface.
56.1.1 LonWorks Device Templates
When you add a LonWorks device in Building Operation, you must define the
device so that Building Operation can recognize its type and communicate with the
device. You define a LonWorks device by associating it with a predefined device
template.
For more information, see section 56.12 “LonWorks Device Templates” on page
2022.
56.1.2 Device Resource Files
Device resource files are a set of files, called a DRF kit, that contain definitions of
enumerations, functional profiles, property types, and variables types used in device
templates.
For more information, see section 56.14 “Device Resource Files” on page 2026.
56.1.3 LonWorks Device Workflow
In WorkStation, you can select a Building Operation server and use Device
Discovery to locate its physical LonWorks interface and installed LonWork devices.
The purpose of locating the physical hardware is to associate it with the
corresponding objects in the System Tree.
For more information, see section 56.16 “LonWorks Device Workflows” on page
2029.
56.1.4 Network Variables and Configuration
Parameters
Applications can contain network variables and configuration parameters to share
data or to customize the application. These network variables and configuration
parameters are usually defined in the device template.
For more information, see section 57.9 “Network Variables and Configuration
Parameters” on page 2074.
04-16006-04-en, March 2015 Technical
2007
56 LonWorks Devices
56.1 LonWorks Devices
56.1.5 LonWorks Commission and Decommission
When you are configuring LonWorks devices or the local node in WorkStation the
configuration data are stored in the Building Operation server database. In order to
download the configuration data to devices or the local node, you need to perform
a commission.
For more information, see section 57.4 “LonWorks Commission and
Decommission” on page 2069.
56.1.6 LonWorks Application Upgrade
The application program in standard LonWorks devices (not host devices) can be
upgraded by downloading an NXE file.
For more information, see section 56.10 “LonWorks Application Upgrade” on page
2019.
56.1.7 LNS Plugins
The LNS Plug-in standard is defined by the LNS network operating system so that
device manufacturers can create custom software that simplifies the configuration
of their devices, and integrate seamlessly with the network commissioning tool. In
WorkStation, the LNS Plug-in function allows the user to register and launch an
LNS Plug-in and make an offline configuration of a generic LonWorks device. The
LNS Plug-in function makes it possible to launch specific manufacturers LNS
applications.
For more information, see section 56.26 “LNS Plug-ins” on page 2047.
Technical 04-16006-04-en, March 2015
2008
56 LonWorks Devices
56.2 Creating a LonWorks Device
56.2 Creating a LonWorks Device
You create LonWorks devices under the LonWorks network to connect to physical
LonWorks devices.
For more information, see section 56.16 “LonWorks Device Workflows” on page
2029.
To create a LonWorks device
1. In WorkStation, in the System Tree pane, select the LonWorks network or
LonWorks network folder where you want to create the device.
2. On the File menu, point to New and then click Device.
3. In the object type list, select a device template.
4. In the Name box, type a name for the device.
Tip
• The name of the LonWorks device must be unique in the
network, even for LonWorks devices in different folders in the
network.
5. In the Description box, type a description.
6. Click Next.
Continued on next page
04-16006-04-en, March 2015 Technical
2009
56 LonWorks Devices
56.2 Creating a LonWorks Device
7. In the Neuron ID box, enter the Neuron ID for the device.
8. Select Commission to commission the device.
9. Select which configuration to use:
• Click Keep current configuration in the device to leave the
configuration in the device as is.
• Click Download default configuration to device to use the default
configuration from the device template.
• Click Upload configuration from device to use the current
configuration in the device.
Important
All the above actions are executed after the NXE file download.
10. Select Device application file to upgrade the device application and enter
the NXE file in the Device application file box. For more information, see
section 56.10 “LonWorks Application Upgrade” on page 2019.
11. Click Create.
Technical 04-16006-04-en, March 2015
2010
56 LonWorks Devices
56.3 Configuring a LonWorks Device
56.3 Configuring a LonWorks Device
You configure a LonWorks device by editing its properties.
To configure a LonWorks device
1. In WorkStation, in the System Tree pane, select the device you want to
configure.
2. On the File menu, click Properties.
3. Click the Basic tab.
4. Edit the basic properties:
Component Description
Needs commissioning Displays True when the device needs to
be commissioned, for example after a
SNVT binding has been changed.
Needs device configuration Displays True when the network
download configuration has changed and the device
needs a configuration download.
Needs application download Displays True when the application has
changed and the device needs an
application download.
Program ID Displays the program ID for the node.
Neuron ID Displays the unique hardware ID for the
node.
Non group receive timer Displays the receive timer for all traffic that
does not reach the node through the
address table.
Use extended NMP Displays True when the node uses the
Extended Network Management
Command Set, ECS. For more
information, see section 155.1 “LonTalk
Addressing Overview” on page 5567.
Model Displays the model name or number.
File directory index Displays the index of the NVT that
specifies the configuration file for CPTs
implemented with direct memory
read/write access.
Host based application Displays Yes when the application runs
mainly in the host.
Complete template Displays False when the device template
is incomplete. Devices based on an
incomplete template can have limited
functionality.
04-16006-04-en, March 2015 Technical
2011
56 LonWorks Devices
56.3 Configuring a LonWorks Device
5. Click the Offline Detection tab.
6. Edit the offline detection properties:
Component Description
Last communication Displays the time when the device/node
last communicated its status
successfully.
Status Displays the status of the device/node:
Invalid, Offline or Online.
7. Click OK.
You must commission the device to update the configuration.
Technical 04-16006-04-en, March 2015
2012
56 LonWorks Devices
56.4 LonWorks Commission and Decommission
56.4 LonWorks Commission and
Decommission
When you are configuring LonWorks devices or the local node in WorkStation the
configuration data are stored in the Building Operation server database. In order to
download the configuration data to devices or the local node, you need to perform
a commission.
56.4.1 Commission
When you commission a device or a local node the following actions occur:
• Device tables (Address, Selector, Alias, and Domain table) are written to the
device or the local node.
• The Device state is set to Configured Online.
When you commission a device the following additional actions occur:
• If you select to download the configuration to device, the Configuration
Parameters values are written to the device.
• If you select to upload the configuration from the device, the Configuration
Parameters values are read from the device.
• If you select a device application file, the file is downloaded to the device.
• If the domain table is updated, or if a Configuration Parameter requires it, the
device is restarted.
56.4.2 Decommission
When you decommission a device or a local node the following actions occur:
• The device or the local node stops communicating.
• The application is stopped unless it is host based.
• The device object configuration is kept, which means that everything can be
restored in the physical device or the local node at a new commission.
Important
Decommission a LonWorks device before you remove it from the network.
Otherwise, the old network information can cause problems if the device is used
in another network.
04-16006-04-en, March 2015 Technical
2013
56 LonWorks Devices
56.5 Discovering a LonWorks Device
56.5 Discovering a LonWorks Device
You discover LonWorks devices to create or configure the LonWorks devices in the
server. The LonWorks devices must be physically connected to the server field bus.
For more information, see section 56.16 “LonWorks Device Workflows” on page
2029.
To discover a LonWorks device
1. In WorkStation, in the System Tree pane, select the server that is connected
to the device you want to discover.
2. Click the Device Discovery view.
3. In the Select device type box, select LonWorks.
4. Select the Devices folder.
5. On the Actions menu, click Activate listen to service pin.
6. Press the service pin on the physical device.
7. In the Device Discovery view, ensure that the LonWorks device is displayed
in the Devices folder. This may take up to 5 seconds.
8. On the Actions menu, click Deactivate listen to service pin.
Continued on next page
Technical 04-16006-04-en, March 2015
2014
56 LonWorks Devices
56.5 Discovering a LonWorks Device
9. Drag the discovered service pin (device) to the System Tree pane:
• Drag to an existing device to associate it with the discovered physical
device.
• Drag to the LonWorks network to create the device.
Important
• You cannot drag a standard MNL LonWorks device to the
System Tree pane if the discovered device is in an
unconfigured state. For more information, see section 158.18
“Dragging Discovered MNL LonWorks Device to System Tree
Pane Does Not Acquire Neuron ID” on page 5616. For more
information, see section 158.19 “Dragging Discovered MNL
LonWorks Device to System Tree Pane Does Not Create New
MNL Device” on page 5617.
Tip
• To verify the device Neuron ID, select the device in the System
Tree pane, and then select Properties on the File menu. The
Neuron ID can be found on the Basic tab of the Device
Properties.
04-16006-04-en, March 2015 Technical
2015
56 LonWorks Devices
56.6 Commissioning a LonWorks Device
56.6 Commissioning a LonWorks Device
You commission physical LonWorks devices to make them operational. The
commission enables the devices to communicate on the LonWorks network.
For more information, see section 57.4 “LonWorks Commission and
Decommission” on page 2069.
To commission a LonWorks device
1. In WorkStation, in the System Tree pane, select the device.
2. On the Actions menu, click Commission.
3. In the Neuron ID box, make sure that the correct Neuron ID is entered.
4. Select which configuration to use:
• Click Keep current configuration in the device to leave the
configuration in the device as is.
• Click Download current configuration to device to use the current
configuration from Building Operation.
• Click Download default configuration to device to use the default
configuration from the device template.
• Click Upload configuration from device to use the current
configuration in the device.
Important
• Before downloading or uploading the device configuration,
carefully consider the effects of overwriting the current device
configuration in the LonWorks device or server.
Continued on next page
Technical 04-16006-04-en, March 2015
2016
56 LonWorks Devices
56.6 Commissioning a LonWorks Device
Important
All the above actions are executed after the NXE file download.
5. Select Device application file to upgrade the device application and enter
the NXE file in the Device application file box.
6. Click Commission.
7. Click Close.
The device is commissioned and activated.
04-16006-04-en, March 2015 Technical
2017
56 LonWorks Devices
56.7 Decommissioning a LonWorks Device
56.7 Decommissioning a LonWorks Device
You decommission a device to silence it and to let the other devices in the network
know that it is deactivated.
To decommission a LonWorks device
1. In WorkStation, in the System Tree pane, select the device.
2. On the Actions menu, click Decommission.
The device address is revoked in the network and it stops communicating.
Technical 04-16006-04-en, March 2015
2018
56 LonWorks Devices
56.8 Downloading the LonWorks Device Configuration
56.8 Downloading the LonWorks Device
Configuration
You download the device configuration from WorkStation to update the
configuration parameters in the LonWorks device.
To download the LonWorks device configuration
1. In WorkStation, in the System Tree pane, select the LonWorks device.
2. On the Actions menu, click Download device configuration.
The configuration is downloaded to the LonWorks device.
04-16006-04-en, March 2015 Technical
2019
56 LonWorks Devices
56.9 Uploading the LonWorks Device Configuration
56.9 Uploading the LonWorks Device
Configuration
You upload the device configuration from the LonWorks device to update the
configuration parameters in the server with local device configuration changes,
which have been made through, for example, an operator panel.
Important
• Before uploading the device configuration from a device, carefully consider
the effects of overwriting the current device configuration in the server.
To upload the LonWorks device configuration
1. In WorkStation, in the System Tree pane, select the LonWorks device.
2. On the Actions menu, click Upload device configuration.
The configuration is uploaded to the server.
Technical 04-16006-04-en, March 2015
2020
56 LonWorks Devices
56.10 LonWorks Application Upgrade
56.10 LonWorks Application Upgrade
The application program in standard LonWorks devices (not host devices) can be
upgraded by downloading an NXE file.
In WorkStation, you can download an NXE to a device when creating or
commissioning a LonWorks device. Each NXE contains a Program ID that should
match the Program ID in the device or in the XIF file used when creating the device.
04-16006-04-en, March 2015 Technical
2021
56 LonWorks Devices
56.11 Upgrading the Device Application
56.11 Upgrading the Device Application
You upgrade a LonWorks device application by downloading a NXE file to the
device.
Warning
• Ensure that the program ID of the NXE file matches the Program ID of the
device application in the device. If the program IDs do not match, the device
can malfunction.
For more information, see section 56.10 “LonWorks Application Upgrade” on page
2019.
To upgrade the device application
1. In WorkStation, in the System Tree pane, select the device.
2. On the Actions menu, click Commission.
3. In the Neuron ID box, make sure that the correct Neuron ID is entered.
Continued on next page
Technical 04-16006-04-en, March 2015
2022
56 LonWorks Devices
56.11 Upgrading the Device Application
4. Select which configuration to use:
• Select Keep current configuration in the device to leave the
configuration in the device as is.
• Select Download current configuration to device to use the current
configuration from WorkStation.
• Select Download default configuration to device to use the default
configuration from the device template.
• Select Upload configuration from device to use the current
configuration in the device.
Important
All the above actions are executed after the NXE file download.
5. Select Device application file to upgrade the device application and enter
the NXE file in the Device application file box.
6. Click Commission.
7. Click Close.
The device application is upgraded and the device is commissioned.
04-16006-04-en, March 2015 Technical
2023
56 LonWorks Devices
56.12 LonWorks Device Templates
56.12 LonWorks Device Templates
When you add a LonWorks device in Building Operation, you must define the
device so that Building Operation can recognize its type and communicate with the
device. You define a LonWorks device by using a device template.
Every generic LonWorks device has a corresponding device template. The device
template itself is a set of predefined network variables and configuration properties
organized in functional blocks.
The following device templates are preinstalled in Building Operation:
• 102-B, 102-VF, 102-EF (80:00:13:50:0A:06:04:03)
• 102-ES (80:00:13:50:0A:06:04:04)
• 102-AX (80:00:13:50:0A:06:04:80)
• 103-A (80:00:13:50:46:06:04:05)
• 104-A (80:00:13:50:1E:06:04:01)
• 110-D (80:00:13:55:06:06:04:01)
• 151-D (80:00:13:6E:01:06:04:01)
• 121-FC (80:00:13:55:01:06:04:02)
• 121-HP (80:00:13:55:03:06:04:02)
• 420A (80:00:13:05:3C:06:04:01)
• 450A (80:00:13:05:0A:06:04:01)
• STR350 (80:00:13:50:5A:06:04:01)
• Xenta OP (90:00:13:05:28:00:04:00)
• ATV21 (80:00:13:3C:0A:0A:04:30)
• ATV61 (80:00:13:3C:0A:0A:04:10)
Each device template is based on a XIF file. The name of a device template in
Building Operation is comprised of the display name of its XIF file (can be edited)
and the Program ID that identifies the LonWorks device type.
You can also add new device templates to Building Operation by importing XIF files.
You can obtain XIF files from the following places:
• Device manufacturer
• Packaging for the shipped product
• LonMark website for certified and published devices
If you try to import a XIF file that refers to types not on your system, you are asked
to import the necessary resource files. For more information, see section 56.14
“Device Resource Files” on page 2026.
Technical 04-16006-04-en, March 2015
2024
56 LonWorks Devices
56.12 LonWorks Device Templates
Figure: LonWorks device template(XIF) in Building Operation
You can import a device template without the necessary types from the resource
files, but there are limitations in the devices created from the template.
04-16006-04-en, March 2015 Technical
2025
56 LonWorks Devices
56.13 Importing a Device Template
56.13 Importing a Device Template
You import device templates (XIF files) so that you can introduce new types of
devices to the system.
For more information, see section 56.12 “LonWorks Device Templates” on page
2022.
To import a device template
1. In WorkStation, on the File menu, point to LonWorks import, and then click
Device Template.
2. In the XIF file box, select the XIF file to import.
3. Click Import.
4. In the Template Name field, type a name for the template.
Note
Use a descriptive name for the template. The name will be shown
when creating new devices.
5. Click OK.
Continued on next page
Technical 04-16006-04-en, March 2015
2026
56 LonWorks Devices
56.13 Importing a Device Template
6. In the Import Device Template box, click Close.
If the device template refers to NVT or CPTs not on your system, you will be
prompted to import necessary resource files. When the resource files have been
imported, the device template import restarts. When finished, the device template is
imported and available when creating a new device. For more information, see
section 56.14 “Device Resource Files” on page 2026.
04-16006-04-en, March 2015 Technical
2027
56 LonWorks Devices
56.14 Device Resource Files
56.14 Device Resource Files
Device resource files are a set of files, called a DRF kit, that contain definitions of
enumerations, functional profiles, property types, and variables types used in device
templates.
If you try to import a XIF file that uses network variables types, configuration
parameters, or functional profiles that do not exist in your type library, you are asked
to import a new DRF kit with these definitions.
The DRF kits are provided by the manufacturer of your LonWorks device. You can
also download DRF kits from the LonMark website.
The following DRF kits are preinstalled on the Automation Server and the Enterprise
Server:
• TAC of version 1.48 (80:00:13:XX:XX:XX:XX:XX)
• HVACdrives of version 1.00 (80:00:13:3C:0A:XX:XX:XX)
• Standard of version 13.20 (XX:XX:XX:XX:XX:XX:XX:XX)
Technical 04-16006-04-en, March 2015
2028
56 LonWorks Devices
56.15 Importing Device Resource Files
56.15 Importing Device Resource Files
You import device resource files (DRF kit) to complement device templates.
Consequently, importing a device template may require that you import a DRF kit as
well.
For more information, see section 56.14 “Device Resource Files” on page 2026.
To import device resource files
1. In WorkStation, on the File menu, point to LonWorks import, and then click
Resource files.
2. In the Import Resource Files box, enter the resource kit directory to import.
3. Click Next.
Continued on next page
04-16006-04-en, March 2015 Technical
2029
56 LonWorks Devices
56.15 Importing Device Resource Files
4. When the download is finished, click Import.
5. Click Close.
Technical 04-16006-04-en, March 2015
2030
56 LonWorks Devices
56.16 LonWorks Device Workflows
56.16 LonWorks Device Workflows
There are three ways of creating and configuring a LonWorks device.
56.16.1 Create and then Discover LonWorks Device
Workflow
Use the Create and then Discover LonWorks Device workflow to create and
discover LonWorks devices online.
For more information, see section 56.17 “Create and then Discover LonWorks
Device Workflow” on page 2030.
56.16.2 Discover LonWorks Device Workflow
Use the Discover LonWorks Device workflow to create and discover LonWorks
devices online.
For more information, see section 56.18 “Discover LonWorks Device Workflow” on
page 2032.
56.16.3 Create LonWorks Device Workflow
Use the Create LonWorks Device workflow to create LonWorks devices offline in a
project and then deploy and commission the devices and the local node on an on-
site server.
For more information, see section 56.19 “Create LonWorks Device Workflow” on
page 2034.
04-16006-04-en, March 2015 Technical
2031
56 LonWorks Devices
56.17 Create and then Discover LonWorks Device Workflow
56.17 Create and then Discover LonWorks
Device Workflow
Use the Create and then Discover LonWorks Device workflow to create and
discover LonWorks devices online.
Figure: Deploy LonWorks project workflow
Technical 04-16006-04-en, March 2015
2032
56 LonWorks Devices
56.17 Create and then Discover LonWorks Device Workflow
Create a LonWorks interface
In WorkStation, create a LonWorks interface in the server.
For more information, see section 55.12 “Creating a LonWorks Interface” on page
1993.
Create a LonWorks network
In WorkStation, create the LonWorks network on the LonWorks Interface.
For more information, see section 55.15 “Creating a LonWorks Network” on page
1996.
Create LonWorks devices
In WorkStation, create the LonWorks devices on the LonWorks network.
For more information, see section 56.2 “Creating a LonWorks Device” on page
2007.
Connect the LonWorks devices
Physically connect the LonWorks devices to the on-site server.
Discover the LonWorks devices
In WorkStation, discover the LonWorks devices to obtain the Neuron ID.
For more information, see section 56.5 “Discovering a LonWorks Device” on page
2012.
Configure the LonWorks devices
Configure the network variables and configuration parameters, using properties or
an LNS Plug-in.
For more information, see section 56.3 “Configuring a LonWorks Device ” on page
2009.
For more information, see section 56.29 “Configuring Network Variables and
Configuration Parameters using LNS Plug-in” on page 2053.
Create a local node and local node variables
In WorkStation, create a Local Node and Local Node variables by mirroring a device
network variable or manually creating.
For more information, see section 57.2 “Creating a Local Node” on page 2067.
For more information, see section 57.12 “Creating Network Variables Automatically”
on page 2078.
Commission the LonWorks devices
In WorkStation, commission the devices on the server.
For more information, see section 56.6 “Commissioning a LonWorks Device” on
page 2014.
04-16006-04-en, March 2015 Technical
2033
56 LonWorks Devices
56.18 Discover LonWorks Device Workflow
56.18 Discover LonWorks Device Workflow
Use the Discover LonWorks Device workflow to create and discover LonWorks
devices online.
Figure: Deploy LonWorks project workflow
Create a LonWorks interface
In WorkStation, create a LonWorks interface in the server.
For more information, see section 55.12 “Creating a LonWorks Interface” on page
1993.
Create a LonWorks network
In WorkStation, create the LonWorks network on the LonWorks Interface.
Technical 04-16006-04-en, March 2015
2034
56 LonWorks Devices
56.18 Discover LonWorks Device Workflow
For more information, see section 55.15 “Creating a LonWorks Network” on page
1996.
Connect the LonWorks devices
Physically connect the LonWorks devices to the on-site server.
Discover the LonWorks devices
In WorkStation, discover the LonWorks devices to obtain the Neuron ID and create
the devices.
For more information, see section 56.5 “Discovering a LonWorks Device” on page
2012.
Configure the LonWorks devices
Configure the network variables and configuration parameters, using properties or
an LNS Plug-in.
For more information, see section 56.3 “Configuring a LonWorks Device ” on page
2009.
For more information, see section 56.29 “Configuring Network Variables and
Configuration Parameters using LNS Plug-in” on page 2053.
Create a local node and local node variables
In WorkStation, create a Local Node and Local Node variables by mirroring a device
network variable or manually creating.
For more information, see section 57.2 “Creating a Local Node” on page 2067.
For more information, see section 57.12 “Creating Network Variables Automatically”
on page 2078.
Commission the LonWorks devices
In WorkStation, commission the devices on the on-site server.
For more information, see section 56.6 “Commissioning a LonWorks Device” on
page 2014.
04-16006-04-en, March 2015 Technical
2035
56 LonWorks Devices
56.19 Create LonWorks Device Workflow
56.19 Create LonWorks Device Workflow
Use the Create LonWorks Device workflow to create LonWorks devices offline in a
project and then deploy and commission the devices and the local node on an on-
site server.
Technical 04-16006-04-en, March 2015
2036
56 LonWorks Devices
56.19 Create LonWorks Device Workflow
Figure: Deploy LonWorks project workflow
04-16006-04-en, March 2015 Technical
2037
56 LonWorks Devices
56.19 Create LonWorks Device Workflow
Create a LonWorks interface
In WorkStation for Projects, create a LonWorks interface.
For more information, see section 55.12 “Creating a LonWorks Interface” on page
1993.
Create a LonWorks network
In WorkStation for Projects, create a LonWorks network on the LonWorks interface.
For more information, see section 55.15 “Creating a LonWorks Network” on page
1996.
Create LonWorks devices
In WorkStation for Projects, create the LonWorks devices in an Automation Server
necessary for the project on the LonWorks network.
For more information, see section 56.2 “Creating a LonWorks Device” on page
2007.
Configure the LonWorks devices
Configure the network variables and configuration parameters, using properties or
an LNS Plug-in.
For more information, see section 56.3 “Configuring a LonWorks Device ” on page
2009.
For more information, see section 56.29 “Configuring Network Variables and
Configuration Parameters using LNS Plug-in” on page 2053.
Create a local node and local node variables
In WorkStation for Projects, create a Local Node and Local Node variables by
mirroring a device network variable or manually creating.
For more information, see section 57.2 “Creating a Local Node” on page 2067.
For more information, see section 57.12 “Creating Network Variables Automatically”
on page 2078.
Create objects
In WorkStation for Projects, create all necessary objects, such as alarms, schedules
and trend logs.
For more information, see the Alarm Overview topic on WebHelp.
For more information, see the Trend Overview topic on WebHelp.
For more information, see the Schedules Overview topic on WebHelp.
Update server communication parameters
In WorkStation for Projects, update the server communication parameters for all
servers.
For more information, see section 4.9 “Updating Project Configuration Server
Communication Parameters” on page 187.
Important
It is recommended that you update the Enterprise Server communication
parameters before the deploy of the first Automation Server.
Technical 04-16006-04-en, March 2015
2038
56 LonWorks Devices
56.19 Create LonWorks Device Workflow
For more information, see section 4.4 “Updating Communication Parameters” on
page 179.
Deploy the Automation Server
In WorkStation for Projects, deploy the Automation Server.
Caution
Ensure that you have created all domain devices and objects before the deploy of
an Automation Server. If you add devices and objects to the Automation Server
and deploy the server again, you first have to clear the database of the physical
Automation Server.
For more information, see section 6.8 “Deploy” on page 248.
For more information, see section 6.12 “Deploying a Server” on page 260.
Connect the LonWorks devices
Physically connect the LonWorks devices to the on-site server.
Commission the LonWorks devices
In WorkStation, commission the devices on the on-site server.
For more information, see section 56.6 “Commissioning a LonWorks Device” on
page 2014.
Commission the local node
In WorkStation, commission the local node on the on-site server.
For more information, see section 57.5 “Commissioning a Local Node” on page
2070.
Update server communication parameters
In WorkStation for Projects, update the server communication parameters for all
servers.
For more information, see section 4.9 “Updating Project Configuration Server
Communication Parameters” on page 187.
Important
It is recommended that you update all Automation Server communication
parameters before the deploy of the Enterprise Server.
For more information, see section 4.4 “Updating Communication Parameters” on
page 179.
Deploy the Enterprise Server
In WorkStation for Projects, deploy the Enterprise Server.
04-16006-04-en, March 2015 Technical
2039
56 LonWorks Devices
56.19 Create LonWorks Device Workflow
Important
Ensure that you have created all Automation Servers in the project before the
deploy of the Enterprise Server. You can only deploy to an empty Enterprise
Server. Any additional Automation Servers have to be created on the on-site
server.
For more information, see section 6.8 “Deploy” on page 248.
For more information, see section 6.12 “Deploying a Server” on page 260.
Technical 04-16006-04-en, March 2015
2040
56 LonWorks Devices
56.20 Network Variables and Configuration Parameters
56.20 Network Variables and Configuration
Parameters
Applications can contain network variables and configuration parameters to share
data or to customize the application. These network variables and configuration
parameters are usually defined in the device template.
56.20.1 Network Variables
A network variable is any data item that a device application gets from, or makes
available to, other devices on the network. A network variable is typically a
temperature, a switch value, or an actuator position setting.
Network variables allow a device to send (output) and receive (input) data over the
network to and from other devices.
In Building Operation, there are 4 classes of network variables:
• Internal NVI: Input variable owned by a local node
• Internal NVO: Output variable owned by a local node
• External NVI: Input variable owned by a device
• External NVO: Output variable owned by a device
You configure the network variables by editing the properties in WorkStation. For
more information, see section 57.15 “Configuring a Network Variable” on page
2083.
You can also configure LonWorks network variables by editing the properties using
an LNS Plug-in. For more information, see section 56.29 “Configuring Network
Variables and Configuration Parameters using LNS Plug-in” on page 2053.
56.20.2 Configuration Parameters
Configuration parameters are used to configure the operation of a device.
Configuration parameters can be implemented in two ways:
• Configuration network variable types use a special class of network variables.
• Direct memory access (DMA) configuration properties are stored in a data
block that is read and written using direct memory access.
You modify the configuration parameters by editing the properties in WorkStation.
For more information, see section 56.25 “Configuring a Configuration Property” on
page 2046.
You can also configure configuration parameters by editing the properties using an
LNS Plug-in. For more information, see section 56.29 “Configuring Network
Variables and Configuration Parameters using LNS Plug-in” on page 2053.
56.20.3 Variable Members and Structured Variables
A network variable can contain one or several variable members that hold different
values, structured with different members in a hierarchy.
04-16006-04-en, March 2015 Technical
2041
56 LonWorks Devices
56.20 Network Variables and Configuration Parameters
For more information, see section 56.21 “Variable Members and Structured
Variables” on page 2041.
56.20.4 NVTs and CPTs
The network variables and configuration parameters are based on types (NVTs and
CPTs) in the Building Operation type repository. The types are defined in the
LonWorks standard and define how the variable/parameter should be interpreted,
because the same raw value can have different meaning in different types.
For example, a value can correspond to a temperature in one case and to a date in
another case. The type repository is pre-installed with the standard LonWorks types
(SNVTs and SCPTs). User defined types (UNVTs and UCPTs) can also be added by
importing Device Resource Files.
56.20.5 Network Variable and Configuration Parameter
Values
Network variables and configuration parameters can be monitored in WorkStation,
and some of them can be edited.
For more information, see section 56.22 “Network Variable and Configuration
Parameter Values” on page 2042.
56.20.6 Update Monitor
Input network variables can be monitored if a device stops sending data updates,
detecting when incoming signals not are updated within a set period of time.
For more information, see section 57.10 “Update Monitor” on page 2076.
56.20.7 Propagation Trigger
A propagation trigger sends the output network variables in a local node functional
block to devices. The output network variables can be sent to the devices either
manually or triggered automatically through a program attached to functions, such
as a Menta application.
For more information, see section 57.11 “Propagation Trigger” on page 2077.
Technical 04-16006-04-en, March 2015
2042
56 LonWorks Devices
56.21 Variable Members and Structured Variables
56.21 Variable Members and Structured
Variables
A network variable can contain one or several variable members that hold different
values, structured with different members in a hierarchy.
For example, a Xenta 101 device has a functional block (SFPTfanCoilUnit) with a
number of network variables (nv...) and configuration properties (nc...).
Figure: Network variables and members in Building Operation System Tree
The nviFanSlave variable is an input variable containing the members State and
Value (structured SNVT).
The nviApplicMode variable HVAC mode is shown together with its associated CP
variable nciRcvHrtBt separately as nviApplicMode_nciRcvHrtBt. The
nviApplicMode_nciRcvHrtBt is an associated configuration property.
By associating a CP to an NV, you can control your NV with a CP value. In this
case, the nciRcvHrtBt stands for ”Receive Heart Beat” and can be 1 minute. This
means that if the NV does not get a new input value within this time, the NV falls
back to a default value.
04-16006-04-en, March 2015 Technical
2043
56 LonWorks Devices
56.22 Network Variable and Configuration Parameter Values
56.22 Network Variable and Configuration
Parameter Values
Network variables and configuration parameters can be monitored in WorkStation,
and some of them can be edited.
Read-only values
Read-only values cannot be modified in Building Operation. These values are
normally output variables sent by a device. Values that are not read-only can be
modified in Building Operation, but the value is overwritten when a new value is sent
from the network or device.
Forced values
You force network variables to make them into temporary parameters. A forced
value ignores updates from the network and keeps its value until it is manually
changed, removed, or the server is restarted.
Retained values
A retained value means that the value is saved and can be retrieved from the server
database in case of a power failure or restart. A value that is not retained exists only
in the RAM memory and is lost in case of a server restart.
The following table illustrates which features are available for the different variable
and parameter classes:
Class Read-only Force possible Retained
Local Node NVI Yes Yes No
Local Node NV0 No No Yes
External Device NVI No No No
External Device NVO Yes No No
Configuration No No Yes
Parameters
DMA - Configuration No No Yes
Parameters
Technical 04-16006-04-en, March 2015
2044
56 LonWorks Devices
56.23 Configuring a Network Variable
56.23 Configuring a Network Variable
You can configure a network variable by editing its properties.
For more information, see section 57.9 “Network Variables and Configuration
Parameters” on page 2074.
To configure a network variable
1. In WorkStation, in the System Tree pane, select the network variable.
2. On the File menu, click Properties.
3. Click the Variable Instance Settings tab.
4. Edit the variable instance properties:
Component Description
Direction Displays the direction of the variable:
Input (receives) or Output (sends).
Polling enabled Select if an input variable is to be polled at
regular intervals or not. If the variable is
not polled, it needs to be read according
to a binding.
Poll rate (s) Enter the time in seconds for the poll rate.
Sending enabled Select if an output variable is to be sent at
regular intervals or not. If the variable is
not sent at regular intervals, the variable
needs to be sent according to a binding.
Send rate (s) Enter the time in seconds for the send
rate.
5. Click OK.
6. In the System Tree pane, expand the network variable and then select the
variable member.
7. On the File menu, click Properties.
Continued on next page
04-16006-04-en, March 2015 Technical
2045
56 LonWorks Devices
56.23 Configuring a Network Variable
8. Edit the variable member property Value:
Component Description
Default value Displays the default value for the variable.
Defined in the XIF file.
Value Enter the value of the variable.
Minimum value Displays the minimum value for the
variable. Defined in the DRF kit.
Maximum value Displays the maximum value for the
variable. Defined in the DRF kit.
Invalid value Displays the invalid value for the variable.
Defined in the DRF kit.
9. Click OK.
Technical 04-16006-04-en, March 2015
2046
56 LonWorks Devices
56.24 Configuring the Value for a Network Variable Member
56.24 Configuring the Value for a Network
Variable Member
You configure the value for a network variable member by editing its properties.
For more information, see section 57.9 “Network Variables and Configuration
Parameters” on page 2074.
To configure the value for a network variable member
1. In WorkStation, in the System Tree pane, expand the network variable and
then select the variable member.
2. On the File menu, click Properties.
3. In the Value box, enter the value of the variable.
4. Click OK.
04-16006-04-en, March 2015 Technical
2047
56 LonWorks Devices
56.25 Configuring a Configuration Property
56.25 Configuring a Configuration Property
You configure the Configuration properties of the LonWorks device to ensure that
the device performs as required by the project.
For more information, see section 57.9 “Network Variables and Configuration
Parameters” on page 2074.
To configure a configuration property
1. In WorkStation, in the System Tree pane, select the configuration property.
2. In the List View, right-click on the column heading bar and click
Add/Remove columns.
3. Select Value.
4. Click OK.
5. In the Value column, click on the value.
6. Enter the value for the configuration property.
7. On the File menu, click Save.
Tip
When all configuration properties are defined for a LonWorks device,
you can copy and paste the device in the System Tree pane and
then rename it as a means to add another device of the same type
and configuration.
Technical 04-16006-04-en, March 2015
2048
56 LonWorks Devices
56.26 LNS Plug-ins
56.26 LNS Plug-ins
The LNS Plug-in standard is defined by the LNS network operating system so that
device manufacturers can create custom software that simplifies the configuration
of their devices, and integrate seamlessly with the network commissioning tool. In
WorkStation, the LNS Plug-in function allows the user to register and launch an
LNS Plug-in and make an offline configuration of a generic LonWorks device. The
LNS Plug-in function makes it possible to launch specific manufacturers LNS
applications.
In order to register the LNS plugin, configure the device, and download the
configuration to the device, you have to make some preparations on the computer
where Building Operation is installed.
• Install the OpenLNS software. For more information and for downloads, visit
the Echelon website.
• Install the LNS Plug-in for the device you intend to use. The LNS Plug-in
contains the corresponding XIF file/DRF kit. You can also download XIF
files/DRF kits from the LonMark website.
Figure: LNS Plug-in overview
The following Schneider Electric LNS Plug-ins are tested and supported in Building
Operation:
04-16006-04-en, March 2015 Technical
2049
56 LonWorks Devices
56.26 LNS Plug-ins
Continued
LNS Plug-in Package LNS Plug-in Device
TACSTR350PlugIn519 (or TAC STR350 Plug-in STR350
newer)
TACXenta100PlugIn519 (or TACXenta102AXPlugin Xenta102 AX
newer)
TAC ZBuilder Plug-in Xenta121 HP
" Xenta121 FC
TAC Xenta 100 Plug-in Xenta102 b
" Xenta102 ef
" Xenta102 vf
" Xenta102 ES
" Xenta103 A
" Xenta104 A
" Xenta110 D
Other LNS Plug-ins following the LNS network operating system not presented in
the table can also be supported by Building Operation but have not been tested.
Important
Communication with the LonWorks devices is not possible while using the LNS
Plug-in. For example, in purpose for calibration.
Note
You need to download the configuration when the device is configured through
the LNS Plug-in. For more information, see section 56.8 “Downloading the
LonWorks Device Configuration ” on page 2017.
Technical 04-16006-04-en, March 2015
2050
56 LonWorks Devices
56.27 Registering LNS Plug-ins
56.27 Registering LNS Plug-ins
You register LNS Plug-ins in LNS in order to be able to configure device variables
and configuration properties using the tools provided from the manufacturer.
For more information, see section 56.26 “LNS Plug-ins” on page 2047.
To register LNS Plug-ins
1. Ensure that the LNS Plug-ins are installed.
Note
Some plug-ins need a system restart to function properly.
2. In WorkStation, on the Tools menu, click Control Panel.
3. On the Control Panel toolbar, select the server.
4. Click LNS Plug-in Registration.
Continued on next page
04-16006-04-en, March 2015 Technical
2051
56 LonWorks Devices
56.27 Registering LNS Plug-ins
5. In the Available Plug-ins list, select the LNS Plug-ins.
6. Click the Add button .
7. Click Save.
Important
Depending on the implementation of the LNS Plug-in by the
manufacturer, there is an option to import the device template / XIF
file in LNS. For more information, see section 56.30 “Importing a
Device Template in LNS” on page 2056.
The LNS Plug-ins are registered in Building Operation.
Technical 04-16006-04-en, March 2015
2052
56 LonWorks Devices
56.28 Unregistering LNS Plug-ins
56.28 Unregistering LNS Plug-ins
You unregister LNS Plug-ins in Building Operation to disable the LNS Plug-ins when
you no longer want to use them.
For more information, see section 56.26 “LNS Plug-ins” on page 2047.
To unregister LNS Plug-ins
1. In WorkStation, on the Tools menu, click Control Panel.
2. Click LNS Plug-in Registration.
Continued on next page
04-16006-04-en, March 2015 Technical
2053
56 LonWorks Devices
56.28 Unregistering LNS Plug-ins
3. In the Registered Plug-ins list, select the LNS Plug-ins .
4. Click the Remove button .
5. Click Save.
The LNS Plug-ins are unregistered in Building Operation.
Technical 04-16006-04-en, March 2015
2054
56 LonWorks Devices
56.29 Configuring Network Variables and Configuration Parameters using LNS Plug-in
56.29 Configuring Network Variables and
Configuration Parameters using LNS
Plug-in
You configure LonWorks device network variables and configuration parameters
through the LNS Plug-in, to ensure that the device performs as required by the
project.
For more information, see section 56.26 “LNS Plug-ins” on page 2047.
To configure network variables and configuration parameters
using LNS Plug-in
1. In WorkStation, in the System Tree pane, select the LonWorks device that
you want to configure.
2. On the Actions menu, click Configure.
3. Click Next.
Continued on next page
04-16006-04-en, March 2015 Technical
2055
56 LonWorks Devices
56.29 Configuring Network Variables and Configuration Parameters using LNS Plug-in
4. Select the LNS Plug-in.
5. Click the Open LNS Plug-in button .
6. Edit the configuration data in the LNS Plug-in application and ensure that the
configuration data have been saved.
7. Close the LNS Plug-in application.
8. Click Next.
Continued on next page
Technical 04-16006-04-en, March 2015
2056
56 LonWorks Devices
56.29 Configuring Network Variables and Configuration Parameters using LNS Plug-in
9. Click Next.
10. Click Finish.
You need to download the configuration when the device is configured through the
LNS Plug-in. For more information, see section 56.8 “Downloading the LonWorks
Device Configuration ” on page 2017.
04-16006-04-en, March 2015 Technical
2057
56 LonWorks Devices
56.30 Importing a Device Template in LNS
56.30 Importing a Device Template in LNS
Depending on the implementation of the LNS Plug-in by the manufacturer, there is
an option to install the XIF file in LNS.
For more information, see section 56.26 “LNS Plug-ins” on page 2047.
To import a device template in LNS
1. In WorkStation, on the Tools menu, click Control Panel.
2. On the Control Panel toolbar, select the server.
3. Click LNS Plug-in Registration.
Continued on next page
Technical 04-16006-04-en, March 2015
2058
56 LonWorks Devices
56.30 Importing a Device Template in LNS
4. Click the Import Device Template in LNS button .
5. Select the device template / XIF file.
6. Click Open.
7. Click OK.
The selected device template is imported in LNS.
04-16006-04-en, March 2015 Technical
2059
56 LonWorks Devices
56.31 Winking a Device
56.31 Winking a Device
You wink a device to cause it to generate an application-dependant audible or
visible response, such as flashing the power LED. Winking can be useful for
identification and testing purposes.
Note
• For the Wink command to work, the device needs to support the Wink
function.
To wink a device
1. In WorkStation, in the System Tree pane, select the device.
2. On the Actions menu, click Wink.
Technical 04-16006-04-en, March 2015
2060
56 LonWorks Devices
56.32 Adding Missing XIF and DRF Files
56.32 Adding Missing XIF and DRF Files
You add missing XIF and DRF files to complete third party device templates and
DRF kits.
To add missing XIF and DRF files
1. In WorkStation, on the File menu, point to LonWorks import and then click
Add missing XIF/DRF files.
2. In the Searching for missing files page, click Next.
Continued on next page
04-16006-04-en, March 2015 Technical
2061
56 LonWorks Devices
56.32 Adding Missing XIF and DRF Files
3. In the Search directory box, enter a folder where the missing files can be
found. Building Operation searches subfolders as well.
4. Click Next.
5. In the Searching for replacement files page, click Import or click
Previous to search more missing files to import.
Continued on next page
Technical 04-16006-04-en, March 2015
2062
56 LonWorks Devices
56.32 Adding Missing XIF and DRF Files
6. In the Importing replacement files page, click Close.
04-16006-04-en, March 2015 Technical
2063
57 LonWorks Local Node
Topics
LonWorks Local Node
Creating a Local Node
Configuring a Local Node
LonWorks Commission and Decommission
Commissioning a Local Node
Decommissioning a Local Node
LonWorks Functional Block
Creating a Functional Block
Network Variables and Configuration Parameters
Update Monitor
Propagation Trigger
Creating Network Variables Automatically
Creating an Input Network Variable
Creating an Output Network Variable
Configuring a Network Variable
Configuring the Value for a Network Variable Member
Creating an Update Monitor
Creating a Propagation Trigger
Configuring an Update Monitor
Configuring a Propagation Trigger
57 LonWorks Local Node
57.1 LonWorks Local Node
57.1 LonWorks Local Node
Enterprise Servers and Automation Servers can have a local node on their networks
that can act as a LonWorks node.
In the local node, you can create your own NVs that can be bound to external
LonWorks devices using LonWorks bindings. The NVs in your local node can then
be used in Building Operation bindings for applications and graphics. For more
information, see section 57.12 “Creating Network Variables Automatically” on page
2078.
Figure: Local Node
04-16006-04-en, March 2015 Technical
2067
57 LonWorks Local Node
57.1 LonWorks Local Node
Using LonWorks bindings to communicate with external LonWorks devices is more
efficient than having applications polling the devices. LonWorks bindings can be
event driven, for example tuned to only send values when they are changed or
reach a predefined value. For more information, see section 58.1 “LonWorks
Bindings ” on page 2093.
This minimizes the communication on the network and saves the bandwidth.
57.1.1 LonWorks Commission and Decommission
When you are configuring LonWorks devices or the local node in WorkStation the
configuration data are stored in the Building Operation server database. In order to
download the configuration data to devices or the local node, you need to perform
a commission.
For more information, see section 57.4 “LonWorks Commission and
Decommission” on page 2069.
57.1.2 LonWorks Functional Block
A functional block organizes related network variables and configuration
parameters. The functional block is based on a Functional Profile Type that contains
network variables and configuration parameters.
For more information, see section 57.7 “LonWorks Functional Block” on page
2072.
57.1.3 Network Variables and Configuration
Parameters
Applications can contain network variables and configuration parameters to share
data or to customize the application. These network variables and configuration
parameters are usually defined in the device template.
For more information, see section 57.9 “Network Variables and Configuration
Parameters” on page 2074.
Technical 04-16006-04-en, March 2015
2068
57 LonWorks Local Node
57.2 Creating a Local Node
57.2 Creating a Local Node
You create a local node for your LonWorks network to add network variables in a
server that will be bound to network variables in the LonWorks devices on the field
bus.
For more information, see section 57.1 “LonWorks Local Node” on page 2065.
To create a local node
1. In WorkStation, in the System Tree pane, select the network where you want
to create the local node.
2. On the File menu, point to New and then click Local Node.
3. In the Name box, type a name for the node.
4. In the Description box, type a description.
5. Click Create.
04-16006-04-en, March 2015 Technical
2069
57 LonWorks Local Node
57.3 Configuring a Local Node
57.3 Configuring a Local Node
You configure a local node by editing its properties.
For more information, see section 57.1 “LonWorks Local Node” on page 2065.
To configure a local node
1. In WorkStation, in the System Tree pane, select the local node you want to
configure.
2. On the File menu, click Properties.
3. Click the Basic tab.
4. Edit the basic properties:
Component Description
Needs commissioning Displays True when the node needs to
be commissioned.
Needs device configuration Displays True when the configuration has
download changed and the node needs a
configuration download.
Program ID Displays the program ID for the node.
Non group receive timer Displays the receive timer for all traffic that
does not reach the node through the
address table.
Use extended NMP Displays True if the node can use the
Extended Network Management
Command Set, ECS. For more
information, see section 155.1 “LonTalk
Addressing Overview” on page 5567.
Model Displays the model.
Host based application Displays Yes if the application is host
based.
5. Click OK.
Technical 04-16006-04-en, March 2015
2070
57 LonWorks Local Node
57.4 LonWorks Commission and Decommission
57.4 LonWorks Commission and
Decommission
When you are configuring LonWorks devices or the local node in WorkStation the
configuration data are stored in the Building Operation server database. In order to
download the configuration data to devices or the local node, you need to perform
a commission.
57.4.1 Commission
When you commission a device or a local node the following actions occur:
• Device tables (Address, Selector, Alias, and Domain table) are written to the
device or the local node.
• The Device state is set to Configured Online.
When you commission a device the following additional actions occur:
• If you select to download the configuration to device, the Configuration
Parameters values are written to the device.
• If you select to upload the configuration from the device, the Configuration
Parameters values are read from the device.
• If you select a device application file, the file is downloaded to the device.
• If the domain table is updated, or if a Configuration Parameter requires it, the
device is restarted.
57.4.2 Decommission
When you decommission a device or a local node the following actions occur:
• The device or the local node stops communicating.
• The application is stopped unless it is host based.
• The device object configuration is kept, which means that everything can be
restored in the physical device or the local node at a new commission.
Important
Decommission a LonWorks device before you remove it from the network.
Otherwise, the old network information can cause problems if the device is used
in another network.
04-16006-04-en, March 2015 Technical
2071
57 LonWorks Local Node
57.5 Commissioning a Local Node
57.5 Commissioning a Local Node
You commission a local node to activate it. The commission enables the local node
to communicate on the LonWorks network.
For more information, see section 57.4 “LonWorks Commission and
Decommission” on page 2069.
To commission a Local Node
1. In Workstation, in the System Tree pane, select the local node.
2. On the Actions menu, click Commission.
The local node is commissioned.
Technical 04-16006-04-en, March 2015
2072
57 LonWorks Local Node
57.6 Decommissioning a Local Node
57.6 Decommissioning a Local Node
You decommission a local node to deactivate it, making it not communicating with
the network.
For more information, see section 57.4 “LonWorks Commission and
Decommission” on page 2069.
To decommission a Local Node
1. In Workstation, in the System Tree pane, select the local node.
2. On the Actions menu, click Decommission.
The device address is revoked in the network and it stops communicating.
04-16006-04-en, March 2015 Technical
2073
57 LonWorks Local Node
57.7 LonWorks Functional Block
57.7 LonWorks Functional Block
A functional block organizes related network variables and configuration
parameters. The functional block is based on a Functional Profile Type that contains
network variables and configuration parameters.
Figure: Functional block in the Local Node
A node can contain several functional blocks. On external devices, the functional
blocks are created from the device template. On the local node, you can create
your own functional blocks and add network variables to them.
Technical 04-16006-04-en, March 2015
2074
57 LonWorks Local Node
57.8 Creating a Functional Block
57.8 Creating a Functional Block
You create functional blocks in a local node to organize network variables that will
be created in the Local Node.
For more information, see section 57.7 “LonWorks Functional Block” on page
2072.
To create a functional block
1. In WorkStation, in the System Tree pane, select the local node where you
want to create the functional block.
2. On the File menu, point to New and then click Functional Block.
3. In the Name box, type a name for the functional block.
4. In the Description box, type a description.
5. Click Create.
04-16006-04-en, March 2015 Technical
2075
57 LonWorks Local Node
57.9 Network Variables and Configuration Parameters
57.9 Network Variables and Configuration
Parameters
Applications can contain network variables and configuration parameters to share
data or to customize the application. These network variables and configuration
parameters are usually defined in the device template.
57.9.1 Network Variables
A network variable is any data item that a device application gets from, or makes
available to, other devices on the network. A network variable is typically a
temperature, a switch value, or an actuator position setting.
Network variables allow a device to send (output) and receive (input) data over the
network to and from other devices.
In Building Operation, there are 4 classes of network variables:
• Internal NVI: Input variable owned by a local node
• Internal NVO: Output variable owned by a local node
• External NVI: Input variable owned by a device
• External NVO: Output variable owned by a device
You configure the network variables by editing the properties in WorkStation. For
more information, see section 57.15 “Configuring a Network Variable” on page
2083.
You can also configure LonWorks network variables by editing the properties using
an LNS Plug-in. For more information, see section 56.29 “Configuring Network
Variables and Configuration Parameters using LNS Plug-in” on page 2053.
57.9.2 Configuration Parameters
Configuration parameters are used to configure the operation of a device.
Configuration parameters can be implemented in two ways:
• Configuration network variable types use a special class of network variables.
• Direct memory access (DMA) configuration properties are stored in a data
block that is read and written using direct memory access.
You modify the configuration parameters by editing the properties in WorkStation.
For more information, see section 56.25 “Configuring a Configuration Property” on
page 2046.
You can also configure configuration parameters by editing the properties using an
LNS Plug-in. For more information, see section 56.29 “Configuring Network
Variables and Configuration Parameters using LNS Plug-in” on page 2053.
57.9.3 Variable Members and Structured Variables
A network variable can contain one or several variable members that hold different
values, structured with different members in a hierarchy.
Technical 04-16006-04-en, March 2015
2076
57 LonWorks Local Node
57.9 Network Variables and Configuration Parameters
For more information, see section 56.21 “Variable Members and Structured
Variables” on page 2041.
57.9.4 NVTs and CPTs
The network variables and configuration parameters are based on types (NVTs and
CPTs) in the Building Operation type repository. The types are defined in the
LonWorks standard and define how the variable/parameter should be interpreted,
because the same raw value can have different meaning in different types.
For example, a value can correspond to a temperature in one case and to a date in
another case. The type repository is pre-installed with the standard LonWorks types
(SNVTs and SCPTs). User defined types (UNVTs and UCPTs) can also be added by
importing Device Resource Files.
57.9.5 Network Variable and Configuration Parameter
Values
Network variables and configuration parameters can be monitored in WorkStation,
and some of them can be edited.
For more information, see section 56.22 “Network Variable and Configuration
Parameter Values” on page 2042.
57.9.6 Update Monitor
Input network variables can be monitored if a device stops sending data updates,
detecting when incoming signals not are updated within a set period of time.
For more information, see section 57.10 “Update Monitor” on page 2076.
57.9.7 Propagation Trigger
A propagation trigger sends the output network variables in a local node functional
block to devices. The output network variables can be sent to the devices either
manually or triggered automatically through a program attached to functions, such
as a Menta application.
For more information, see section 57.11 “Propagation Trigger” on page 2077.
04-16006-04-en, March 2015 Technical
2077
57 LonWorks Local Node
57.10 Update Monitor
57.10 Update Monitor
Input network variables can be monitored if a device stops sending data updates,
detecting when incoming signals not are updated within a set period of time.
When creating the update monitor on a local node input network variable, you can
set the period in minutes. As default the update monitor is set to a 5 minute period.
The period defines the time between the checkpoints of input network variable field
value changes. When the period is set to 5 minutes, the system monitors the
incoming data every fifth minute. If the system does not receive any incoming data
updates after 5 minutes, the network variable is considered offline. When incoming
data is received, the network variable is considered online.
This feature can be used for triggering events, such as an alarm. The alarm will then
be triggered when the incoming variable not is updated within the set period of time
in the update monitor.
Figure: Update monitor function
Technical 04-16006-04-en, March 2015
2078
57 LonWorks Local Node
57.11 Propagation Trigger
57.11 Propagation Trigger
A propagation trigger sends the output network variables in a local node functional
block to devices. The output network variables can be sent to the devices either
manually or triggered automatically through a program attached to functions, such
as a Menta application.
When several field values are changed, the propagation trigger sends a variable as
one value rather than as several values at different times. Propagation triggers
decrease network traffic and ensure that the necessary parts of the output network
variable are in synch before the variable is sent to the device.
Important
The propagation trigger feature disables any send variable instance setting on an
output network variable. For more information, see section 57.15 “Configuring a
Network Variable” on page 2083.
04-16006-04-en, March 2015 Technical
2079
57 LonWorks Local Node
57.12 Creating Network Variables Automatically
57.12 Creating Network Variables
Automatically
You create network variables in the local node by mirroring network variables in
LonWorks field bus devices when you want to create and bind multiple network
variables in one action, which saves you engineering time.
For more information, see section 57.1 “LonWorks Local Node” on page 2065.
To create network variables automatically
1. In WorkStation, in the System Tree pane, in the LonWorks network, select
the functional block that contains the network variables that you want to be
represented in the local node.
2. In the List View, select the network variables that you want to be represented
in the local node.
3. On the File menu, point to New and then click Mirrored network
variables.
Mirrored network variables of the network variables that you selected, are
automatically created and bound in the local node, within functional blocks that are
also automatically created and named according to the LonWorks devices from
where the network variables originate.
Note
• This procedure uses a lot of the Automation Server CPU and takes some time
to complete. System alarms might be triggered.
Technical 04-16006-04-en, March 2015
2080
57 LonWorks Local Node
57.13 Creating an Input Network Variable
57.13 Creating an Input Network Variable
You create input network variables in functional blocks in a local node for binding
LonWorks variables between the Automation Server and the Xenta 280/300/401
LonWorks devices or other LonWorks devices.
For more information, see section 57.1 “LonWorks Local Node” on page 2065.
To create an input network variable
1. In WorkStation, in the System Tree pane, select the functional block where
you want to create the variable.
2. On the File menu, point to New and then click Network Variable.
3. In the Resource files kit box, select the DRF that contains the types for the
variable.
4. In the Type box, select the type of variable.
5. In the Direction box, select Input.
6. In the Name box, type a name for the variable.
7. Click Next.
8. In the Polling enabled box, select Yes to poll the variable.
Tip
• To ensure efficient bandwidth usage, enable polling only when
the sending device cannot use event-driven communication.
Continued on next page
04-16006-04-en, March 2015 Technical
2081
57 LonWorks Local Node
57.13 Creating an Input Network Variable
9. In the Poll rate (s) box, enter the number of seconds between the polls.
10. Click Create.
Technical 04-16006-04-en, March 2015
2082
57 LonWorks Local Node
57.14 Creating an Output Network Variable
57.14 Creating an Output Network Variable
You create output network variables in functional blocks in a local node for binding
LonWorks variables between the Automation Server and the Xenta 280/300/401
LonWorks devices or other LonWorks devices.
For more information, see section 57.1 “LonWorks Local Node” on page 2065.
To create an output network variable
1. In WorkStation, in the System Tree pane, select the functional block where
you want to create the variable.
2. On the File menu, point to New and then click Network Variable.
3. In the Resource files kit box, select the DRF that contains the types for the
variable.
4. In the Type box, select the type of variable.
5. In the Direction box, select Output.
6. In the Name box, type a name for the variable.
7. Click Next.
Continued on next page
04-16006-04-en, March 2015 Technical
2083
57 LonWorks Local Node
57.14 Creating an Output Network Variable
8. In the Sending enabled box, select Yes to send the variables at periodic
intervals.
9. In the Send rate box, enter the number of seconds between the sends.
10. In the Initial Value box, enter the initial value for the variable.
11. Click Create.
Technical 04-16006-04-en, March 2015
2084
57 LonWorks Local Node
57.15 Configuring a Network Variable
57.15 Configuring a Network Variable
You can configure a network variable by editing its properties.
For more information, see section 57.9 “Network Variables and Configuration
Parameters” on page 2074.
To configure a network variable
1. In WorkStation, in the System Tree pane, select the network variable.
2. On the File menu, click Properties.
3. Click the Variable Instance Settings tab.
4. Edit the variable instance properties:
Component Description
Direction Displays the direction of the variable:
Input (receives) or Output (sends).
Polling enabled Select if an input variable is to be polled at
regular intervals or not. If the variable is
not polled, it needs to be read according
to a binding.
Poll rate (s) Enter the time in seconds for the poll rate.
Sending enabled Select if an output variable is to be sent at
regular intervals or not. If the variable is
not sent at regular intervals, the variable
needs to be sent according to a binding.
Send rate (s) Enter the time in seconds for the send
rate.
5. Click OK.
6. In the System Tree pane, expand the network variable and then select the
variable member.
7. On the File menu, click Properties.
Continued on next page
04-16006-04-en, March 2015 Technical
2085
57 LonWorks Local Node
57.15 Configuring a Network Variable
8. Edit the variable member property Value:
Component Description
Default value Displays the default value for the variable.
Defined in the XIF file.
Value Enter the value of the variable.
Minimum value Displays the minimum value for the
variable. Defined in the DRF kit.
Maximum value Displays the maximum value for the
variable. Defined in the DRF kit.
Invalid value Displays the invalid value for the variable.
Defined in the DRF kit.
9. Click OK.
Technical 04-16006-04-en, March 2015
2086
57 LonWorks Local Node
57.16 Configuring the Value for a Network Variable Member
57.16 Configuring the Value for a Network
Variable Member
You configure the value for a network variable member by editing its properties.
For more information, see section 57.9 “Network Variables and Configuration
Parameters” on page 2074.
To configure the value for a network variable member
1. In WorkStation, in the System Tree pane, expand the network variable and
then select the variable member.
2. On the File menu, click Properties.
3. In the Value box, enter the value of the variable.
4. Click OK.
04-16006-04-en, March 2015 Technical
2087
57 LonWorks Local Node
57.17 Creating an Update Monitor
57.17 Creating an Update Monitor
You create an update monitor to monitor the communication with an external
LonWorks device in a externally managed LonWorks network.
For more information, see section 57.10 “Update Monitor” on page 2076.
To create an Update Monitor
1. In WorkStation, in the System Tree pane, select the input network variable
where you want to create the update monitor.
2. On the File menu, point to New and then click Update Monitor.
3. In the Name box, type the name of the update monitor.
4. In the Description box, type the description of the update monitor.
5. Click Create.
Technical 04-16006-04-en, March 2015
2088
57 LonWorks Local Node
57.18 Creating a Propagation Trigger
57.18 Creating a Propagation Trigger
You create a propagation trigger to send network variable output data.
For more information, see section 57.11 “Propagation Trigger” on page 2077.
To create a Propagation Trigger
1. In WorkStation, in the System Tree pane, select the output network
variable where you want to create the propagation trigger.
2. On the File menu, point to New and then click Propagation Trigger.
3. In the Name box, type the name of the propagation trigger.
4. In the Description box, type the description of the propagation trigger.
5. Click Create.
04-16006-04-en, March 2015 Technical
2089
57 LonWorks Local Node
57.19 Configuring an Update Monitor
57.19 Configuring an Update Monitor
You configure the update monitor to change the amount of time between input
network variable updates before the variable is considered offline.
For more information, see section 57.10 “Update Monitor” on page 2076.
To configure an update monitor
1. In WorkStation, in the System Tree pane, expand the input network variable
and then select the update monitor.
2. On the File menu, click Properties.
3. In the Period box, enter the value of the period.
4. Click OK.
Technical 04-16006-04-en, March 2015
2090
57 LonWorks Local Node
57.20 Configuring a Propagation Trigger
57.20 Configuring a Propagation Trigger
You configure the propagation to send the network variable as one value rather
than several values at different times, or not.
For more information, see section 57.11 “Propagation Trigger” on page 2077.
To configure a propagation trigger
1. In WorkStation, in the System Tree pane, expand the output network
variable and then select the propagation trigger.
2. On the File menu, click Properties.
3. In the Propagate network variable box, select Yes or No.
4. Click OK.
04-16006-04-en, March 2015 Technical
2091
58 LonWorks Bindings
Topics
LonWorks Bindings
LonWorks Bindings in WorkStation
LonWorks Binding Profiles
LonWorks Binding Types
Bindable Objects in LonWorks
LonWorks Selectors and Bindings
Creating a LonWorks Binding
Replacing a Hub in a LonWorks Binding
58 LonWorks Bindings
58.1 LonWorks Bindings
58.1 LonWorks Bindings
A LonWorks binding is a connection between two or more network variables or
configuration properties for data exchange. In its simplest form, one variable is
bound to another in a Point-to-point binding. You can also bind one variable to
several (Fan-out), or several to one (Fan-in).
LonWorks bindings differ from other Building Operation bindings because you can
set LonWorks specific properties, such as LonWorks binding profiles.
Figure: Point-to-point binding
A binding consists of one hub and one or more targets. The hub is a unique node
that connects to one or more targets.
Note
• To create a LonWorks binding, you need to bind on the variable level. If you
bind two members of network variables, a Building Operation binding is
created rather than a LonWorks binding. For more information, see section
57.9 “Network Variables and Configuration Parameters” on page 2074.
Note
The lock feature is disabled for LonWorks bindings, because a locked LonWorks
binding may result in scenarios where a binding contains several hubs pointing to
one target, or different binding profiles are mixed.
58.1.1 LonWorks Bindings in WorkStation
Use the Bindings View in WorkStation to create your LonWorks bindings. You can
drag and drop NVs to create bindings.
For more information, see section 58.2 “LonWorks Bindings in WorkStation” on
page 2095.
58.1.2 Bindable objects in LonWorks
LonWorks network variables and configuration parameters can be bound to each
other in LonWorks bindings. They can also be bound to most points in Building
Operation, such as programs, graphics, alarms, and trend logs, but then Building
Operation bindings is used, not LonWorks bindings.
04-16006-04-en, March 2015 Technical
2095
58 LonWorks Bindings
58.1 LonWorks Bindings
For more information, see section 58.5 “Bindable Objects in LonWorks” on page
2101.
58.1.3 LonWorks Binding Profiles
When you create a binding in LonWorks, you decide its behavior by selecting a
binding profile. You either select a binding profile, or you use the default profile.
For more information, see section 58.3 “LonWorks Binding Profiles ” on page 2096.
58.1.4 LonWorks Binding Types
Building Operation supports different types of LonWorks bindings, such as point-to-
point, turnaround, fan-in, and fan-out.
For more information, see section 58.4 “LonWorks Binding Types” on page 2098.
58.1.5 LonWorks Selectors and Bindings
LonWorks uses selectors to create bindings between network variables. A selector
is a unique index that is assigned to a network variable and points to the target
device, where the bound network variable is assigned the same selector index.
For more information, see section 58.6 “LonWorks Selectors and Bindings” on
page 2102.
Technical 04-16006-04-en, March 2015
2096
58 LonWorks Bindings
58.2 LonWorks Bindings in WorkStation
58.2 LonWorks Bindings in WorkStation
Use the Bindings View in WorkStation to create your LonWorks bindings. You can
drag and drop NVs to create bindings.
Figure: Building Operation bindings View
When you select an object in the System Tree pane, all its bindable points are
displayed in the Binding point list. To create a binding, drag an NV (or NVs) from the
Browser to an NV in the Binding point list and save the binding. You can also add
more points to the binding, remove points, or change the hub of the binding. If all
points of a binding are removed, the binding itself is removed.
When you copy and paste LonWorks solutions in the System Tree, bindings are
retained as long as both bound sender and receiver objects are included.
Copy, paste, and move can be used within different scopes in the System Tree.
You can move objects within a network in the System Tree. You can copy and
paste objects within a server in the System Tree. To reuse a LonWorks solution
outside the server of origin, you need to use the export and import command ( For
more information, see section 18.10 “Import and Export of LonWorks Solutions” on
page 570.). For bindings to be retained in all these operations, both sender and
receiver objects need to be included in the operation.
04-16006-04-en, March 2015 Technical
2097
58 LonWorks Bindings
58.3 LonWorks Binding Profiles
58.3 LonWorks Binding Profiles
When you create a binding in LonWorks, you decide its behavior by selecting a
binding profile. You either select a binding profile, or you use the default profile.
There are basically three types of binding profiles:
• Acknowledged profiles
• Unacknowledged profiles
• Broadcast profiles
Use an acknowledged binding profile when the sending device should receive an
acknowledgement from the receiving device indicating that the value of the bound
variable was successfully sent.
Binding profile Transmit timer Retry count
Acknowledged Profile 96 ms 3
Acknowledged , Tx tmr 256 ms 3
256, 3 retries
Acknowledged , Tx tmr 256, 256 ms 5
5 retries
Acknowledged , Tx tmr 1024 ms 5
1024, 5 retries
Tip
Be careful of creating large, acknowledged fan-out bindings because they
generate a lot of traffic, especially if the device of one of the recipients is offline.
Use an unacknowledged binding profile when the sending device should not
receive an acknowledgement from the receiving device. Use this type when the
value being sent is not critical and is of low importance to the control logic.
Binding profile Repeat timer Repeat count
Unacknowledged Profile 0
Unacknowledged Repeated 48 ms 3
Profile
Unacknowledged 48 ms 5
Repeated , 5 repeats
Use a broadcast profile when you do not want to use up an entry in the address
table. The device address table has 15 available entries for bindings but the first
entry is a reserved broadcast entry that all broadcast bindings can share.
Binding profile Repeat timer Repeat count
Broadcast Profile 0
Broadcast Profile, 5 repeats 48 ms 5
Technical 04-16006-04-en, March 2015
2098
58 LonWorks Bindings
58.3 LonWorks Binding Profiles
Binding profile Repeat timer Repeat count
If no binding profile is selected, a default profile is used:
• Point-to-point bindings use the Acknowledged profile as default.
• Fan-out bindings use the Unacknowledged Repeated profile as default.
• Building Operation uses the broadcast profile as default when the device
address table has run out of entries.
If a point-to-point binding is changed to a fan-out binding, the binding profile is
automatically updated to an Unacknowledged Repeated profile.
If a fan-out binding is changed to a point-to-point binding, the binding profile is
automatically updated to an Acknowledged profile.
04-16006-04-en, March 2015 Technical
2099
58 LonWorks Bindings
58.4 LonWorks Binding Types
58.4 LonWorks Binding Types
Building Operation supports different types of LonWorks bindings, such as point-to-
point, turnaround, fan-in, and fan-out.
58.4.1 Hubs and Targets in Bindings
A binding consists of one hub and one or more targets. The hub is the center of the
binding which connects to one or more targets. When creating bindings, both the
hub and target can be an NVI as well as an NVO. A good rule is to always use the
NVO as the hub, except when creating a fan-in binding. With the NVO as the hub,
you can create a point-to-point binding and then expand it to a fan-out.
The following table describes which hub and targets are used in each type of
binding:
Binding Type Hub Target(s)
Point-to-point NVO NVI
Turnaround NVO NVI
Fan-out NVO NVIs
Fan-in NVI NVOs
58.4.2 Point-to-point Bindings
A point-to-point binding is a binding between two single network variables of
compatible types. An NVO must bind to an NVI and vice versa. A typical example of
a point-to-point binding is a LonWorks occupancy sensor that sends the
snvt_occupancy to a Xenta controller, that is doing the HVAC control of a room.
Figure: Point-to-point binding
In a point-to-point binding, the hub might be either the NVI or the NVO.
Technical 04-16006-04-en, March 2015
2100
58 LonWorks Bindings
58.4 LonWorks Binding Types
58.4.3 Turnaround Bindings
A turnaround binding is a connection between input and output network variables
on the same device. A turnaround binding is appropriate for a device that receives
the data it transmits. For example, a device that has a temperature input that is
bound to its actuator output.
Figure: Turnaround binding
In a turnaround binding, the hub might be either the NVI or the NVO.
58.4.4 Fan-out Bindings
A fan-out binding is a binding between one sender and several receivers. For
example a zone controller that sends out a snvt_temp_p as the (nvi-) setpoint for a
large number of HVAC controllers.
Figure: Fan-out bindings
In fan-out bindings, the hub should always be the unique output variable. In this
case, the unique variable is the NVO.
04-16006-04-en, March 2015 Technical
2101
58 LonWorks Bindings
58.4 LonWorks Binding Types
In the Binding view, drag the the NVIs to the hub in the Binding points list, not the
other way around.
58.4.5 Fan-in Bindings
A fan-in binding is a binding between several senders and one receiver. For
example, several temperatures from LonWorks devices bound into one single (nvi-)
temp_p in a device.
In Building Operation, fan-in bindings are treated just like a number of point-to-point
bindings. When several values are received, the last received value is used. No
mean value calculations are available.
Figure: Fan-in bindings
In fan-in bindings, the hub should always be the unique input variable. In this case,
the unique variable is the NVI.
In the Binding view, drag the the NVOs to the hub in the Binding points list, not the
other way around.
Note
• Do not use fan-in bindings for a polling NVI.
Technical 04-16006-04-en, March 2015
2102
58 LonWorks Bindings
58.5 Bindable Objects in LonWorks
58.5 Bindable Objects in LonWorks
LonWorks network variables and configuration parameters can be bound to each
other in LonWorks bindings. They can also be bound to most points in Building
Operation, such as programs, graphics, alarms, and trend logs, but then Building
Operation bindings is used, not LonWorks bindings.
Some points are read-only and can therefore only be used as producers. Other
points are of the type object reference and can only be used as consumers.
You can bind the following points in LonWorks:
Point Comments
Local node NVO
Local node NVI
LonWorks device NVO (producer only)
LonWorks device NVI
LonWorks device CP
You can bind LonWorks points with the following points in Building Operation:
Point Comments
Function Block output
Function Block input
Script output
Script input
Schedule outputs (producer only)
Variables
Central IO points
Graphics reference input (consumer only)
Alarm reference input (consumer only)
Trend reference input (consumer only)
04-16006-04-en, March 2015 Technical
2103
58 LonWorks Bindings
58.6 LonWorks Selectors and Bindings
58.6 LonWorks Selectors and Bindings
LonWorks uses selectors to create bindings between network variables. A selector
is a unique index that is assigned to a network variable and points to the target
device, where the bound network variable is assigned the same selector index.
In Building Operation, the selectors and the addresses of the bound nodes are kept
in different tables on each node. These tables are the domain table, address table,
selector table, and alias table. The tables can be viewed in WorkStation and are
stored on the device or local node when commissioned. A master selector table is
also stored on the Building Operation server that owns the network.
Domain Table
The domain table stores the node's own DSN address. The address is set for all
network nodes when the objects are created in Building Operation.
Figure: Domain table example
Address Table
The address table contains DSN addresses of other nodes together with a unique
index that is used by the Selector table.
Technical 04-16006-04-en, March 2015
2104
58 LonWorks Bindings
58.6 LonWorks Selectors and Bindings
Figure: Address table example
Selector Table
The selector table stores information about the network variables in the node. (The
selector table is also called network variable configuration table, or just variable
selectors.)
04-16006-04-en, March 2015 Technical
2105
58 LonWorks Bindings
58.6 LonWorks Selectors and Bindings
Figure: Selector table example
The selector table automatically assigns a selector for each network variable on the
node. Unused selectors are given a hex number between 3000-3FFF. Used
selectors is given a hex number between 0000-2FFF. The used selectors are
unique for the entire network. A device can be assigned a maximum of 4 096
selectors (3FFF-3000) and a network can use a total of 12 228 selectors (2FFF-
0000).
Simple Binding Example
In this single point-to-point binding, NV with index 1 (the second SNVT in the XIF
file) in DEVICE 1, is bound to the NV with index 6 (the seventh SNVT in that XIF file)
in DEVICE 2.
Technical 04-16006-04-en, March 2015
2106
58 LonWorks Bindings
58.6 LonWorks Selectors and Bindings
Figure: Domain, Address and Selector tables in Building Operation
When the binding is created, the selector table row for the used network variable on
the hub (Device 1) is assigned a unique selector number (453). The selector row
also points to an index(a) in the address table, with the address to the target
node(b).
04-16006-04-en, March 2015 Technical
2107
58 LonWorks Bindings
58.6 LonWorks Selectors and Bindings
The target node’s (Device 2) selector table is also assigned the same unique
selector number for its used network variable (c).
All used selector numbers are also stored in a master selector table in the Building
Operation server that owns the network, to keep track of used selectors.
When a network variable is bound to several other devices (a group binding), the
same selector number is assigned to the used network variables in all devices.
Alias Table
The alias table is a secondary selector table used for giving the same network
variable several selectors. In a selector table, the same selector index can only
appear once. If you want to bind one network variable to several target network
variables in the same device, aliases are used for each target.
Figure: Alias table example
Technical 04-16006-04-en, March 2015
2108
58 LonWorks Bindings
58.7 Creating a LonWorks Binding
58.7 Creating a LonWorks Binding
You create a LonWorks binding between the Automation Server local node and a
LonWorks device or between two LonWorks devices. You create the binding
between LonWorks Network Variables or Configuration Parameters (NV based).
You use a LonWorks binding to communicate with a LonWorks device because it
enables event-driven communication, which is more efficient than communication
using the polling method.
For more information, see section 58.1 “LonWorks Bindings ” on page 2093.
To create a LonWorks binding
1. In WorkStation, in the System Tree pane, select the local node or device for
which you want to create a LonWorks binding.
2. On the Actions menu, click Edit bindings.
3. In the binding point list, select the variable you want to bind to.
4. In the binding point browser, select the device to bind from.
5. Expand the selected device to display the variables that are available to be
bound.
Continued on next page
04-16006-04-en, March 2015 Technical
2109
58 LonWorks Bindings
58.7 Creating a LonWorks Binding
6. Select the variable to be bound and drag it to the binding box for the variable
in the binding point list.
Important
• To bind more than one variable to a binding point, drag the
variable to the name of the binding point. Each binding adds a
row to the binding point.
7. In the binding point list, click the Binding profile button for the binding
that you just created.
8. In the Lon binding properties dialog box, click a binding profile. For more
information, see section 58.3 “LonWorks Binding Profiles ” on page 2096.
9. Select Disable initial read to disable initial read of the network variable in
the device.
10. Click OK.
11. On the File menu, click Save.
Tip
• You cannot use a custom binding template when you create
LonWorks bindings. Custom binding templates can be used
when you create Building Operation bindings.
Technical 04-16006-04-en, March 2015
2110
58 LonWorks Bindings
58.8 Replacing a Hub in a LonWorks Binding
58.8 Replacing a Hub in a LonWorks Binding
You replace the hub in LonWorks binding to change the source value or the fan-in
destination value of a binding.
For more information, see section 58.4 “LonWorks Binding Types” on page 2098.
To replace a hub in a LonWorks binding
1. In WorkStation, in the System Tree pane, select the hub to replace.
2. In the Bindings view, in the bindings point list, right-click the hub variable and
click Replace hub.
Continued on next page
04-16006-04-en, March 2015 Technical
2111
58 LonWorks Bindings
58.8 Replacing a Hub in a LonWorks Binding
3. Select the new hub.
4. Click Select.
5. On the File menu, click Save.
Technical 04-16006-04-en, March 2015
2112
59 LonWorks Maintenance and
Operating
Topics
LonWorks Maintenance
LonWorks Device Replacement
Replacing an Online LonWorks Device
Replacing an Offline LonWorks Device
LonWorks Network Analysis
LonWorks Device Diagnostics
Viewing Diagnostic Data
Clearing Diagnostic Data
Rebinding a LonWorks Network
Detecting Subnet/Node Conflicts
LonWorks Operating
LonWorks Offline Alarms
59 LonWorks Maintenance and Operating
59.1 LonWorks Maintenance
59.1 LonWorks Maintenance
LonWorks maintenance covers topics that describe how you use Building
Operation to replace hardware and troubleshoot an automation system based on
the LonWorks fieldbus standard.
59.1.1 LonWorks Device Replacement
You replace a physical LonWorks device because of malfunction issues, new
requirements, or misplacement.
For more information, see section 59.2 “LonWorks Device Replacement” on page
2114.
59.1.2 LonWorks Network Analysis
Analyzing a LonWorks network in Building Operation is both a matter of general
network troubleshooting and reviewing your Building Operation configuration. A
systematic approach is to define the problem, gather facts, and find the cause. You
can then decide the actions to take, considering how your actions can affect other
parts of the network. The first place to start is to review your Building Operation
configuration. Check the properties of your ports, networks, devices, NVs, CPs,
and bindings. Try to wink your devices ( For more information, see section 56.31
“Winking a Device” on page 2058.) and check their status.
For more information, see section 59.5 “LonWorks Network Analysis” on page
2118.
59.1.3 LonWorks Device Diagnostics
Finding diagnostic data is important when reviewing or troubleshooting a LonWorks
network.
For more information, see section 59.6 “LonWorks Device Diagnostics” on page
2122.
04-16006-04-en, March 2015 Technical
2115
59 LonWorks Maintenance and Operating
59.2 LonWorks Device Replacement
59.2 LonWorks Device Replacement
You replace a physical LonWorks device because of malfunction issues, new
requirements, or misplacement.
The LonWorks device that you want to replace can be online or offline (not able to
communicate at all).
If the LonWorks device is online, you can upload the device configuration to
WorkStation before you remove the device and then reuse the old configuration in
the new device. Removing a LonWorks device, for any reason, should involve a
decommissioning of the device.
If the LonWorks device is offline, there is no possibility of uploading the device
configuration to WorkStation nor decommissioning the device. Then you will have to
manage and work with the device configuration that is stored in WorkStation. If the
device configuration that is stored in WorkStation is synchronized with the device,
then there is no issue.
Technical 04-16006-04-en, March 2015
2116
59 LonWorks Maintenance and Operating
59.3 Replacing an Online LonWorks Device
59.3 Replacing an Online LonWorks Device
You replace a physical LonWorks device because of malfunction issues, new
requirements, or misplacement.
For more information, see section 59.2 “LonWorks Device Replacement” on page
2114.
To replace an online LonWorks device
1. In WorkStation, in the System Tree pane, select the LonWorks device that
you want to replace.
Tip
• If the device configuration in the physical LonWorks device is not
synchronized with the configuration that is stored in the server,
you can upload the device configuration to the server before you
decommission and remove the LonWorks device. For more
information, see section 56.9 “Uploading the LonWorks Device
Configuration ” on page 2018.
2. On the Actions menu, click Decommission.
3. Remove the old physical LonWorks device.
4. Install the new physical LonWorks device.
5. On the Actions menu, click Commission.
Continued on next page
04-16006-04-en, March 2015 Technical
2117
59 LonWorks Maintenance and Operating
59.3 Replacing an Online LonWorks Device
6. In the Neuron ID box, type or retrieve the Neuron ID of the new LonWorks
device:
• Type the Neuron ID in the box.
• Click Service Pin and then press the service pin on the physical device
to retrieve the Neuron ID.
7. Click Download current configuration to device.
8. Click Commission.
9. Click Close.
The LonWorks device is replaced, commissioned, and activated.
Technical 04-16006-04-en, March 2015
2118
59 LonWorks Maintenance and Operating
59.4 Replacing an Offline LonWorks Device
59.4 Replacing an Offline LonWorks Device
You replace a physical LonWorks device because of malfunction issues, new
requirements, or misplacement.
For more information, see section 59.2 “LonWorks Device Replacement” on page
2114.
To replace an offline LonWorks device
1. Remove the old physical LonWorks device.
2. Install the new physical LonWorks device.
3. In WorkStation, in the System Tree pane, select the LonWorks device that
you have replaced.
4. On the Actions menu, click Commission.
5. In the Neuron ID box, type or retrieve the Neuron ID of the new LonWorks
device:
• Type the Neuron ID in the box.
• Click Service Pin and then press the service pin on the physical device
to retrieve the Neuron ID.
6. Click Download current configuration to device.
7. Click Commission.
8. Click Close.
The LonWorks device is replaced, commissioned, and activated.
04-16006-04-en, March 2015 Technical
2119
59 LonWorks Maintenance and Operating
59.5 LonWorks Network Analysis
59.5 LonWorks Network Analysis
Analyzing a LonWorks network in Building Operation is both a matter of general
network troubleshooting and reviewing your Building Operation configuration. A
systematic approach is to define the problem, gather facts, and find the cause. You
can then decide the actions to take, considering how your actions can affect other
parts of the network. The first place to start is to review your Building Operation
configuration. Check the properties of your ports, networks, devices, NVs, CPs,
and bindings. Try to wink your devices ( For more information, see section 56.31
“Winking a Device” on page 2058.) and check their status.
Common network problems, such as high network load or cable problems, can
also cause errors. To find the source of errors, you probably need to analyze your
networks using a network analyzer. In Building Operation, we recommend LOYTEC
Protocol Analyzer (LPA). LOYTEC offers a detailed guide for analyzing and
troubleshooting LonWorks networks with the LPA software. See the LOYTEC
website for more information.
59.5.1 LOYTEC Protocol Analyzer (LPA)
The LPA is a Windows-based tool for analyzing traffic on LonWorks networks.
Connected to the LonWorks network you can observe all network communication
on your PC.
Figure: The LOYTEC Protocol Analyzer
The LPA software processes and displays all data packets in an easy to understand
and intuitive form.
Technical 04-16006-04-en, March 2015
2120
59 LonWorks Maintenance and Operating
59.5 LonWorks Network Analysis
59.5.2 LPA in Building Operation
You can connect the LPA directly to a LOYTEC interface or to the built-in LonWorks
interface of the Automation Server.
LPA with Automation Server
Figure: LPA with Automation Server
To connect the LPA to the built-in LonWorks interface of an Automation Server, you
must first set it up in the LPA. You specify the address of the Automation Server in
the Remote LPA Assignment dialog box and then you assign/add it in the
Network Interface Selection list.
Note
• You need a USB service dongle with an LPA license to run the LPA tool and
you need the LConfig tool to register it.
04-16006-04-en, March 2015 Technical
2121
59 LonWorks Maintenance and Operating
59.5 LonWorks Network Analysis
LPA with Enterprise Server
Figure: LPA with Enterprise Server
To connect the LPA to an interface of an Enterprise Server, select an available MNI
interface from the same NIC device in the Network Interface Selection list.
Note
• You need a USB service dongle with an LPA license to run the LPA tool and
you need the LConfig tool to register it.
59.5.3 LPA Analysis Overview
When you have your LPA software installed and are connected to your Building
Operation networks, you can start analyzing the network traffic.
Detailed information can be found in the LPA manual and the LOYTEC
troubleshooting guide “Network Troubleshooting White Paper, AN008E”.
The following table lists some important questions and some hints on solutions.
Table: Analyzing with LPA
Analyze Solution
Network bandwidth utilization. Rate > 50%? • Check poll & update rates.
• Improve structure of network.
• Change Ack to UnAck for group
messages.
Network error rate. Rate > 2% • Check network termination.
• Check cabling (broken cables,
frequency converters, and shielding).
Technical 04-16006-04-en, March 2015
2122
59 LonWorks Maintenance and Operating
59.5 LonWorks Network Analysis
Continued
Analyze Solution
Missed preamble counter. Increasing fast • Check network termination.
(>10/sec.)?
• Check cabling (broken cables,
frequency converters, and shielding).
Alternate path packets. Are there AP • Check power supply.
packets?
• Check for installation errors
(inconsistent database and uninstalled
nodes).
04-16006-04-en, March 2015 Technical
2123
59 LonWorks Maintenance and Operating
59.6 LonWorks Device Diagnostics
59.6 LonWorks Device Diagnostics
Finding diagnostic data is important when reviewing or troubleshooting a LonWorks
network.
You can view traffic information for a device using WorkStation. For more
information, see section 59.7 “Viewing Diagnostic Data” on page 2123.
You can rebind a network if you suspect that bindings have become currupt. For
more information, see section 59.9 “Rebinding a LonWorks Network” on page
2125.
You can detect subnet/node conflicts if you suspect that device addresses are in
conflict. For more information, see section 59.10 “Detecting Subnet/Node
Conflicts” on page 2126.
Technical 04-16006-04-en, March 2015
2124
59 LonWorks Maintenance and Operating
59.7 Viewing Diagnostic Data
59.7 Viewing Diagnostic Data
You view diagnostic data about a device, or a local node, for reviewing or
troubleshooting purposes.
To view diagnostic data
1. In WorkStation, in the System Tree pane, select the device or local node.
2. In the Properties dialog box, click the Diagnostics tab.
04-16006-04-en, March 2015 Technical
2125
59 LonWorks Maintenance and Operating
59.8 Clearing Diagnostic Data
59.8 Clearing Diagnostic Data
You clear the diagnostic data about a device or a local node, to start a new
collection of diagnostic data.
To clear the diagnostic data
1. In WorkStation, in the System Tree pane, select the device or local node.
2. On the Actions menu, click Clear Status.
The diagnostic data for the device or local node is cleared.
Technical 04-16006-04-en, March 2015
2126
59 LonWorks Maintenance and Operating
59.9 Rebinding a LonWorks Network
59.9 Rebinding a LonWorks Network
You rebind a LonWorks network to clear and recreate all LonWorks bindings.
For more information, see section 154.3 “Corrupt LonWorks Bindings” on page
5560.
To rebind a LonWorks network
1. In WorkStation, in the System Tree pane, select the LonWorks network that
you want to rebind.
2. On the Actions menu, point to Advanced and then click Rebind.
3. Click Yes.
4. Click Close.
5. Decommission all devices in the LonWorks network. For more information, see
section 56.7 “Decommissioning a LonWorks Device” on page 2016.
6. Commission all devices in the LonWorks network. For more information, see
section 56.6 “Commissioning a LonWorks Device” on page 2014.
04-16006-04-en, March 2015 Technical
2127
59 LonWorks Maintenance and Operating
59.10 Detecting Subnet/Node Conflicts
59.10 Detecting Subnet/Node Conflicts
You detect conflicting devices so that you can recommission them with unique
addresses.
For more information, see section 154.2 “LonWorks Device Communication
Problems” on page 5559.
To detect subnet/node conflicts
1. In WorkStation, in the System Tree pane, select the LonWorks network that
you want to examine.
2. On the Actions menu, point to Advanced and then click Detect
Subnet/Node conflicts.
The command finds devices with conflicting addresses and displays their neuron
IDs. Decommission the conflicting device and commission it again to give it a new
and unique address.
Technical 04-16006-04-en, March 2015
2128
59 LonWorks Maintenance and Operating
59.11 LonWorks Operating
59.11 LonWorks Operating
LonWorks operating covers topics that describe how you use Building Operation to
supervise and manage an automation system based on the LonWorks fieldbus
standard.
59.11.1 LonWorks Offline Alarms
LonWorks nodes can be monitored to trigger alarms if they go offline. Offline alarms
are handled as system alarms in Building Operation. Offline detection can be
enabled or disabled for each LonWorks node. Also, the NIC-USB and NIC-IP ports
on the Enterprise Server can be monitored.
For more information, see section 59.12 “LonWorks Offline Alarms” on page 2128.
04-16006-04-en, March 2015 Technical
2129
59 LonWorks Maintenance and Operating
59.12 LonWorks Offline Alarms
59.12 LonWorks Offline Alarms
LonWorks nodes can be monitored to trigger alarms if they go offline. Offline alarms
are handled as system alarms in Building Operation. Offline detection can be
enabled or disabled for each LonWorks node. Also, the NIC-USB and NIC-IP ports
on the Enterprise Server can be monitored.
When activating offline detection, you can set the delay and priority.
The delay defines how long after a device is detected as offline, until an alarm is
sent. If you set the delay to 60 seconds, the system polls the device every 30
seconds. This means that the allowed delay actually is 30 to 60 seconds.
For example, the delay is set to 1 minute. The device goes offline just after minute 1,
but goes online again before the next poll (1:30), so no alarm is sent. Later the
device goes offline after minute 2 and this is detected at the next poll (2:30). At
minute 3 an alarm is sent.
Figure: Offline Detection
Technical 04-16006-04-en, March 2015
2130
60 LonWorks User Interface
Topics
LonWorks System Tree Icons
File Menu – LonWorks Import Submenu
Devices Shortcut Menu
LonWorks Interface Properties – Basic Tab
LonWorks Interface Properties – Advanced Tab
LonWorks Network Properties – Basic Tab
LonWorks Network Properties – Advanced Tab
Local Node Properties – Basic Tab
Local Node Properties – Offline Detection Tab
Local Node Properties – Diagnostics Tab
LonWorks Device Properties – Basic Tab
LonWorks Device Properties – Offline Detection Tab
LonWorks Device Properties – Diagnostics Tab
Update Monitor - Basic Tab
Propagation Trigger - Basic Tab
Device Tables Properties – Basic Tab
Device Tables Properties – Address Table Tab
Device Tables Properties – Domain Table Tab
Device Tables Properties – Selector Table Tab
Device Tables Properties – Alias Table Tab
Create Network Variable Wizard – Define Network Variable
Page
Create Network Variable Wizard – Input Variable
Parameters Page
Create Network Variable Wizard – Output Variable
Parameters Page
Functional Block Properties
Configuration Parameters and Network Variable
Properties – Basic Tab
Configuration Parameters and Network Variable
Properties – Variable Instance Settings Tab
Configuration Parameters and Network Variable
Properties – Extended Settings Tab
Variable Member Properties
Import Resource Files Wizard – Select Resource Kit
Directory Page
Import Resource Files Wizard – Importing DRF Kit Page
Import Resource Files Wizard – Committing the DRF Kit
Page
Import Device Template Wizard – Import Device Template Page
Import Device Template Wizard – Device Template Dialog Box
Import Device Template Wizard – Importing Device Template
Page
Neuron ID and Commission Settings Page
Lon Folder Properties
Add Missing Files Wizard – Searching for Missing Files Page
Add Missing Files Wizard – Select Directory to Search for XIF
and DRF Resources Page
Add Missing Files Wizard – Searching for Replacement Files
Page
Add Missing Files Wizard – Importing Replacement Files Page
LNS Plug-in Registration View
Configure Using LNS Plug-ins Wizard - Copying Device
Configuration to LNS Page
Configure Using LNS Plug-ins Wizard - Select LNS Plug-in Page
Configure Using LNS Plug-ins Wizard - Confirm LNS
Configuration Page
Configure Using LNS Plug-ins Wizard - Copying Device
Configuration from LNS Page
Lon Binding Properties
LonWorks Binding Profile Icons
LonWorks Binding Profile Properties – Basic Tab
LonWorks Binding Profile Properties – Advanced Tab
60 LonWorks User Interface
60.1 LonWorks System Tree Icons
60.1 LonWorks System Tree Icons
This table describes the icons in WorkStation that relate to LonWorks.
Table: LonWorks Icons in WorkStation
Icon Description
LonWorks Interface
Indicates a LonWorks interface.
LonWorks Network
Indicates a LonWorks network.
LonWorks Device or Local Node
Indicates a device or local node.
LonWorks Device or Local Node,
Database Mode
Indicates a device or local node in database
mode. For more information, see the
LonWorks Database Mode topic on
WebHelp.
LonWorks Device or Local Node,
Offline
Indicates a device or local node in offline
mode.
LonWorks Device or Local Node, Out
of sync
Indicates a device or local node that is out of
sync. For more information, see section
154.4 “LonWorks Device Out of Sync” on
page 5561.
LonWorks Device or Local Node,
Invalid
Indicates a device or local node with
unknown status. The node is not
commissioned or has been
decommissioned.
LonWorks Binding
Indicates LonWorks binding.
LonWorks Binding Profile
Indicates a LonWorks binding profile.
LonWorks Binding Profile, Default
Indicates the LonWorks binding profile,
currently set as default.
04-16006-04-en, March 2015 Technical
2135
60 LonWorks User Interface
60.1 LonWorks System Tree Icons
Continued
Icon Description
LonWorks Folder or Functional Block
Indicates a LonWorks folder or Functional
Block.
LonWorks Network Variable or
Configuration Property
Indicates a Network Variable or
Configuration Property.
LonWorks Network Variable or
Configuration Property, Offline
Indicates a Network Variable or
Configuration Property that is offline.
LonWorks Device Table
Indicates a LonWorks device table.
LonWorks Device Table, Offline
Indicates a LonWorks device table that is
offline.
Technical 04-16006-04-en, March 2015
2136
60 LonWorks User Interface
60.2 File Menu – LonWorks Import Submenu
60.2 File Menu – LonWorks Import Submenu
Use the commands on the LonWorks Import submenu to import device
templates, resource files, and to add missing files to existing templates and
resource files.
Figure: LonWorks import submenu
Table: LonWorks Import Submenu
Command Description
Device Template Click to import a LonWorks device template.
For more information, see section 56.13
“Importing a Device Template” on page
2024.
Recource Files Click to import a set of device resource files.
For more information, see section 56.15
“Importing Device Resource Files” on page
2027.
Add missing XIF/DRF files Click to add missing XIF/DRF files. For more
information, see section 56.32 “Adding
Missing XIF and DRF Files” on page 2059.
04-16006-04-en, March 2015 Technical
2137
60 LonWorks User Interface
60.3 Devices Shortcut Menu
60.3 Devices Shortcut Menu
Use the Devices shortcut menu in the Device Discovery to update and manage the
list of Neuron IDs.
Figure: Device shortcut menu
Table: Devices Shortcut Menu
Command Description
Activate listen to service pin Click to listen for service pins from devices
on the network. When a service pin is
received, it is displayed in the Device list.
Deactivate listen to service pin Click to stop listening for service pins.
Clear found devices Click to clear the list of Neuron IDs.
Advanced Click to open the Advanced submenu. For
more information, see the Actions Menu –
Advanced Submenu topic on WebHelp.
Technical 04-16006-04-en, March 2015
2138
60 LonWorks User Interface
60.4 LonWorks Interface Properties – Basic Tab
60.4 LonWorks Interface Properties – Basic
Tab
Use the Basic tab to view and edit basic information about the interface.
Figure: Basic tab
Table: Basic Tab
Component Description
State Displays the interface status: Online or
Offline.
Network interface name Displays the name of the network interface.
The name is automatically set when you
drag-and-drop the interface from the Device
Discovery tab.
Maximum number of concurrent Select the maximum number of messages to
messages be transmitted at the same time.
04-16006-04-en, March 2015 Technical
2139
60 LonWorks User Interface
60.5 LonWorks Interface Properties – Advanced Tab
60.5 LonWorks Interface Properties –
Advanced Tab
Use the Advanced tab to view and edit alarm settings for the interface.
Figure: Advanced tab
Table: Advanced Tab
Component Description
Priority Select the priority for the alarm.
Device name Displays the name of the interface.
Technical 04-16006-04-en, March 2015
2140
60 LonWorks User Interface
60.6 LonWorks Network Properties – Basic Tab
60.6 LonWorks Network Properties – Basic
Tab
Use the Basic tab to view and edit properties of the selected network.
Figure: Basic tab
04-16006-04-en, March 2015 Technical
2141
60 LonWorks User Interface
60.7 LonWorks Network Properties – Advanced Tab
60.7 LonWorks Network Properties –
Advanced Tab
Use the Advanced tab to view and edit domain properties and posssibly Xenta-
specific parts of the LonWorks network.
Figure: Advanced tab
Table: Domain Table for Network Interface
Component Description
Index Displays the location of the entry in the
domain table. The first item is 0.
ID (decimal) Displays the domain ID of which the device is
a member.
Domain ID lenght Displays the byte length of the domain ID.
Subnet Displays the subnet of which the device is a
member.
Node Displays the node ID of the device. The Local
Node is always node 1.
Technical 04-16006-04-en, March 2015
2142
60 LonWorks User Interface
60.7 LonWorks Network Properties – Advanced Tab
Continued
Component Description
Click to change domain ID.
Table: Xenta General
Component Description
Classic Operator Panel Support Select Yes to get support for classic OP
functionality, that is, the OP can be
connected to any Xenta device.
Network name in blueprint Displays the current name of the network.
System alarm priority Enter the priority of Xenta non-application
alarms.
Time synchronization interval (min) Enter the time interval between
synchronization of Xenta and the server
clocks. The default value is 10.
Heartbeat (s) Enter the time interval for the server
heartbeat on the LonWorks network. The
default value is 5 s.
Table: Xenta LACnet Settings
Component Description
Timeout (ms) Enter the amount of time in milliseconds until
Xenta communication should be considered
broken. The default is 40,000 ms.
Transmit timer (ms) Displays the time before Xenta
retransmission (if no answer).
Number of retries Enter the maximum number of attempts
before giving up. The default value is 6.
The Xenta LACnet parameters only apply to certain types of data transfer, such as
application download, fetching of trend logs, and alarms refresh.
04-16006-04-en, March 2015 Technical
2143
60 LonWorks User Interface
60.8 Local Node Properties – Basic Tab
60.8 Local Node Properties – Basic Tab
Use the Basic tab to view basic information about the local node. For more
information, visit the LonMarks website and the ISO website.
Figure: Basic tab
Table: Basic Tab
Component Description
Needs commissioning Displays True when the node needs to be
commissioned.
Needs device configuration download Displays True when the configuration has
changed and the node needs a configuration
download.
Program ID Displays the program ID for the node.
Non group receive timer Displays the receive timer for all traffic that
does not reach the node through the
address table.
Technical 04-16006-04-en, March 2015
2144
60 LonWorks User Interface
60.8 Local Node Properties – Basic Tab
Continued
Component Description
Use extended NMP Displays True if the node can use the
Extended Network Management Command
Set, ECS. For more information, see section
155.1 “LonTalk Addressing Overview” on
page 5567.
Model Displays the model.
Host based application Displays Yes if the application is host based.
04-16006-04-en, March 2015 Technical
2145
60 LonWorks User Interface
60.9 Local Node Properties – Offline Detection Tab
60.9 Local Node Properties – Offline
Detection Tab
Use the Offline Detection tab to view alarm settings for the node. For more
information, visit the LonMarks website and the ISO website.
Figure: Offline detection tab
Table: Offline Detection Tab
Component Description
Last communication Displays the time when the device/node last
communicated its status successfully.
Status Displays the status of the device/node:
Invalid, Offline or Online.
Technical 04-16006-04-en, March 2015
2146
60 LonWorks User Interface
60.10 Local Node Properties – Diagnostics Tab
60.10 Local Node Properties – Diagnostics
Tab
Use the Diagnostics tab to view traffic information and troubleshooting data for a
local node. For more information, visit the LonMarks website and the ISO website.
Figure: Diagnostics tab
04-16006-04-en, March 2015 Technical
2147
60 LonWorks User Interface
60.10 Local Node Properties – Diagnostics Tab
Continued
Component Description
Device state Displays the current known state of the
node:
• Unconfigured and Applicationless:
Application is not loaded or not in
working order and the node is not
configured.
• Unconfigured: The node is not
configured.
• Configured, Soft Offline: The node is
configured and offline, and returns to
online once it is reset.
• Configured, Hard Offline: The node is
configured and offline, and stays so
until deliberately put online.
• Configured, Online: The node is
configured and in normal operating
mode.
• Configured, Bypass Offline: The node is
configured and online, and does not
necessary observe go offline requests.
Packet errors Displays the number of CRC errors detected
during packet reception.
Transaction timeouts Displays the number of times that the node
failed to receive expected acknowledgments
or responses after retrying the configured
number of times.
Receive transaction full errors Displays the Receive Transaction Full Errors.
The number of times that an incoming
packet was discarded because there was no
room in the transaction database.
Lost messages Displays the number of times, since the last
device restart, that an incoming packet was
discarded because there was no application
buffer available.
Missed Messages Displays the number of times, since the last
device restart, that an incoming packet was
discarded because there was no network
buffer available.
Technical 04-16006-04-en, March 2015
2148
60 LonWorks User Interface
60.10 Local Node Properties – Diagnostics Tab
Continued
Component Description
Last reset cause Displays the cause of the last reset for this
node:
• Power-up: The node was powered up.
• External: The node was asked by
external source to reset.
• Watchdog: The internal watchdog
caused the reset.
• Software: The internal application
caused the reset.
• Cleared: The cause was cleared.
04-16006-04-en, March 2015 Technical
2149
60 LonWorks User Interface
60.11 LonWorks Device Properties – Basic Tab
60.11 LonWorks Device Properties – Basic
Tab
Use the Basic tab to view and edit basic information about the device. For more
information, visit the LonMarks website and the ISO website.
Figure: Basic tab
Table: Basic Tab
Component Description
Needs commissioning Displays True when the device needs to be
commissioned, for example after a SNVT
binding has been changed.
Needs device configuration download Displays True when the network
configuration has changed and the device
needs a configuration download.
Needs application download Displays True when the application has
changed and the device needs an
application download.
Technical 04-16006-04-en, March 2015
2150
60 LonWorks User Interface
60.11 LonWorks Device Properties – Basic Tab
Continued
Component Description
NeedsDownloadSchedules Displays True when the Xenta schedule has
changed and the device needs a schedule
download.
Program ID Displays the program ID for the node.
Neuron ID Displays the unique hardware ID for the
node.
Non group receive timer Displays the receive timer for all traffic that
does not reach the node through the
address table.
Use extended NMP Displays True when the node uses the
Extended Network Management Command
Set, ECS. For more information, see section
155.1 “LonTalk Addressing Overview” on
page 5567.
Model Displays the model name or number.
File directory index Displays the index of the NVT that specifies
the configuration file for CPTs implemented
with direct memory read/write access.
XIF Displays the used XIF files.
04-16006-04-en, March 2015 Technical
2151
60 LonWorks User Interface
60.12 LonWorks Device Properties – Offline Detection Tab
60.12 LonWorks Device Properties – Offline
Detection Tab
Use the Offline Detection tab to view and edit alarm settings for the device. For
more information, visit the LonMarks website and the ISO website.
Figure: Offline detection tab
Table: Offline Detection Tab
Component Description
Status Displays the offline status of the device:
Invalid, Offline, or Online.
Last communication Displays the time when the device last
communicated its status successfully.
Offline monitoring Select True to enable offline monitoring and
trigger an alarm when the device goes
offline.
Alarm Delay(s) Select the time, in seconds, between when
the device is detected as offline until an
alarm is sent.
Technical 04-16006-04-en, March 2015
2152
60 LonWorks User Interface
60.12 LonWorks Device Properties – Offline Detection Tab
Continued
Component Description
Priority Select the priority for the alarm.
04-16006-04-en, March 2015 Technical
2153
60 LonWorks User Interface
60.13 LonWorks Device Properties – Diagnostics Tab
60.13 LonWorks Device Properties –
Diagnostics Tab
Use the Diagnostics tab to view traffic information and troubleshooting data for a
device. For more information, visit the LonMarks website and the ISO website.
Figure: Diagnostics tab
Technical 04-16006-04-en, March 2015
2154
60 LonWorks User Interface
60.13 LonWorks Device Properties – Diagnostics Tab
Table: Diagnostics Tab
Component Description
Device state Displays the current known state of the
node:
• Unconfigured and Applicationless:
Application is not loaded or not in
working order and the node is not
configured.
• Unconfigured: The node is not
configured.
• Configured, Soft Offline: The node is
configured and offline, and returns to
online once it is reset.
• Configured, Hard Offline: The node is
configured and offline, and stays so
until deliberately put online.
• Configured, Online: The node is
configured and in normal operating
mode.
• Configured, Bypass Offline: The node is
configured and online, and does not
necessary observe go offline requests.
Packet errors Displays the number of CRC errors detected
during packet reception.
Transaction timeouts Displays the number of times that the node
failed to receive expected acknowledgments
or responses after retrying the configured
number of times.
Receive transaction full errors Displays the Receive Transaction Full Errors.
The number of times that an incoming
packet was discarded because there was no
room in the transaction database.
Lost messages Displays the number of times, since the last
device restart, that an incoming packet was
discarded because there was no application
buffer available.
Missed messages Displays the number of times, since the last
device restart, that an incoming packet was
discarded because there was no network
buffer available.
04-16006-04-en, March 2015 Technical
2155
60 LonWorks User Interface
60.13 LonWorks Device Properties – Diagnostics Tab
Continued
Component Description
Last reset cause Displays the cause of the last reset for this
node:
• Power-up: The node was powered up.
• External: The node was asked by
external source to reset.
• Watchdog: The internal watchdog
caused the reset.
• Software: The internal application
caused the reset.
• Cleared: The cause was cleared.
Firmware version number Displays the version number of the firmware
reported by the device.
Last error logged Displays the last encountered error. For
more information, see section 154.1 “Packet
Errors” on page 5557..
Neuron model Displays the type of chip reported by the
device.
Technical 04-16006-04-en, March 2015
2156
60 LonWorks User Interface
60.14 Update Monitor - Basic Tab
60.14 Update Monitor - Basic Tab
Use the Update Monitor - Basic tab to configure the update period for an input
network variable update monitor in a LonWorks network.
Figure: Update monitor - basic tab
Table: Update monitor
Component Description
Period Enter the amount of time between receiving
updates before the input network variable is
considered offline.
04-16006-04-en, March 2015 Technical
2157
60 LonWorks User Interface
60.15 Propagation Trigger - Basic Tab
60.15 Propagation Trigger - Basic Tab
Use the Propagation Trigger - Basic tab to configure the propagation trigger.
Figure: Propagation trigger - basic tab
Table: Propagation trigger
Component Description
Propagate network variable Select Yes to send the network variable as
one value rather than several values at
different times.
Technical 04-16006-04-en, March 2015
2158
60 LonWorks User Interface
60.16 Device Tables Properties – Basic Tab
60.16 Device Tables Properties – Basic Tab
Use the Basic tab to view and edit basic information for the device tables.
Figure: Basic tab
04-16006-04-en, March 2015 Technical
2159
60 LonWorks User Interface
60.17 Device Tables Properties – Address Table Tab
60.17 Device Tables Properties – Address
Table Tab
Use the Address Table tab to view the address table of the device or the local
node. For more information, visit the LonMarks website and the ISO website.
Figure: Address table tab
Table: Address Table Tab
Component Description
Index Displays the location of the entry in the
address table. The first entry is reserved for
the broadcast binding profile.
Type Displays the type of address.
Domain name Displays the first part of the group address
(Group/subnet is the second).
Member/Node Displays the member number of the target
device if the table entry is a fan-out binding,
or the node address of target device if the
entry is a point-to-point binding.
Technical 04-16006-04-en, March 2015
2160
60 LonWorks User Interface
60.17 Device Tables Properties – Address Table Tab
Continued
Component Description
Repetition interval Displays the interval (in seconds) in which the
message is resent if a number of Retries is
given.
Retries Displays the number of attempts to resend
the message.
Recieve timer Displays a timer interval for group messages.
If a message with the same transaction ID is
received before the receive timer expires, the
message is considered to be a retry of the
previous message.
Transaction timer Displays the time interval between retries
when acknowledged or request/response
service is used.
Group/Subnet Displays the group ID of the binding if the
table entry is a fan-out binding, or the subnet
node address of the target device if the table
entry is a point-to-point binding.
04-16006-04-en, March 2015 Technical
2161
60 LonWorks User Interface
60.18 Device Tables Properties – Domain Table Tab
60.18 Device Tables Properties – Domain
Table Tab
Use the Domain table tab to view and edit the domain table of the node. For more
information, visit the LonMarks website and the ISO website.
Figure: Domain table tab
Table: Domain Table for Network Interface
Component Description
Index Displays the location of the entry in the
domain table. The first item is 0.
ID (decimal) Displays the domain ID of which the device is
a member.
Domain ID lenght Displays the byte length of the domain ID.
Subnet Displays the subnet of which the device is a
member.
Node Displays the node ID of the device. The Local
Node is always node 1.
Technical 04-16006-04-en, March 2015
2162
60 LonWorks User Interface
60.18 Device Tables Properties – Domain Table Tab
Continued
Component Description
Click to change domain ID.
04-16006-04-en, March 2015 Technical
2163
60 LonWorks User Interface
60.19 Device Tables Properties – Selector Table Tab
60.19 Device Tables Properties – Selector
Table Tab
Use the Selector Table tab to view the selector table of the node. For more
information, visit the LonMarks website and the ISO website.
Figure: Selector Table tab
Table: Selector Table Tab
Component Description
Index Displays the location of the entry in the
selector table. The first item is 0.
Selector Displays the unique selector ID used to bind
the NVs.
Address index Displays the index of the variable in the
address table, to which the binding sends its
data. The first item is 0.
Priority Displays the priority for the binding. Defines
the order in which concurrent values are to
be sent.
Technical 04-16006-04-en, March 2015
2164
60 LonWorks User Interface
60.19 Device Tables Properties – Selector Table Tab
Continued
Component Description
Direction Displays the direction of the NV.
Service Displays the service type to use.
Turnaround Displays True when the selector is a part of
a turnaround binding.
Authentication Displays True when the receiver verifies the
sender's ID with an acknowledgement key.
04-16006-04-en, March 2015 Technical
2165
60 LonWorks User Interface
60.20 Device Tables Properties – Alias Table Tab
60.20 Device Tables Properties – Alias Table
Tab
Use the Alias Table tab to view the alias table of the node. For more information,
visit the LonMarks website and the ISO website.
Figure: Alias table tab
Table: Alias Table Tab
Component Description
Index Displays the location of the entry in the alias
table. The first item is 0.
Selector Displays the unique selector ID used to bind
the NVs.
Direction Displays the direction of the NV.
Priority Displays the priority for the binding. Defines
the order in which concurrent values are to
be sent.
Technical 04-16006-04-en, March 2015
2166
60 LonWorks User Interface
60.20 Device Tables Properties – Alias Table Tab
Continued
Component Description
Address index Displays the index of the variable in the
address table, to which the binding sends its
data. The first item is 0.
Authentication Displays True when the receiver verifies the
sender's ID with an acknowledgement key.
Primary Displays the selector index for which this
alias refers to.
Service Displays the service type to use for
connections containing this variable.
Turnaround Displays True when the selector is part of a
turnaround binding.
04-16006-04-en, March 2015 Technical
2167
60 LonWorks User Interface
60.21 Create Network Variable Wizard – Define Network Variable Page
60.21 Create Network Variable Wizard –
Define Network Variable Page
A network variable is created from predefined types in a resource files (DRF) kit. A
name and direction is needed to monitor and bind the variable.
Figure: Define network variable page
Table: Define Network Variable Page
Component Description
Resource files kit Select the resource files kit (DRF) which
contains the variable type to use.
Type Select the variable type.
Direction Select the direction for the variable.
Name Type a name for the variable.
Technical 04-16006-04-en, March 2015
2168
60 LonWorks User Interface
60.22 Create Network Variable Wizard – Input Variable Parameters Page
60.22 Create Network Variable Wizard – Input
Variable Parameters Page
An input variable is received by the device. You can set the variable to poll the
values at selected intervals, otherwise the values is received according to bindings.
Figure: Input variable parameters page
04-16006-04-en, March 2015 Technical
2169
60 LonWorks User Interface
60.23 Create Network Variable Wizard – Output Variable Parameters Page
60.23 Create Network Variable Wizard –
Output Variable Parameters Page
An output variable is transmitted from the device. You can set the variable value to
be sent at selected intervals, otherwise the value is sent according to bindings. You
can also set the variable name and its initial value.
Figure: The output variable parameters page
Technical 04-16006-04-en, March 2015
2170
60 LonWorks User Interface
60.24 Functional Block Properties
60.24 Functional Block Properties
Use the Functional Block Properties tab to view and edit properties of the
selected functional block.
Figure: Functional block properties
04-16006-04-en, March 2015 Technical
2171
60 LonWorks User Interface
60.25 Configuration Parameters and Network Variable Properties – Basic Tab
60.25 Configuration Parameters and Network
Variable Properties – Basic Tab
Use the Basic tab to view and edit general properties.
Figure: Basic tab
Table: Basic Tab
Component Description
Reference NVT name Displays the reference NVT name.
Is DMA Select True if the CPT is based on a Direct
Memory Read/Write Access.
Inherited Displays if the CPT inherits its type from an
associated network variable. Defined in the
device template or the resource files.
Is constant Constant property. Indicates that the
property cannot be changed by a network
tool.
Technical 04-16006-04-en, March 2015
2172
60 LonWorks User Interface
60.25 Configuration Parameters and Network Variable Properties – Basic Tab
Continued
Component Description
Is device specific Indicates that the property must be read
from the device, not from interface or
database.
Modify only during manufacturing Indicates a factory setting which should
normally not be changed, or may require a
password.
Is object disabled Indicates that the functional block must be
disabled before the value can be changed.
Is offline at change Indicates that the device must be offline
before the value can be changed.
Is reseting after change Indicates that the device must be restarted
after change of the value.
Default value Displays the default value of the
configuration property.
Minimum value Displays the minimum value of the
configuration property.
Maximum value Displays the maximum value of the
configuration property.
04-16006-04-en, March 2015 Technical
2173
60 LonWorks User Interface
60.26 Configuration Parameters and Network Variable Properties – Variable Instance Settings Tab
60.26 Configuration Parameters and Network
Variable Properties – Variable Instance
Settings Tab
Use the Variable Instance Settings tab to view and edit variable instance
settings. The variable instance settings define how the parameter/variable is to be
sent or received.
Figure: Variable instance settings tab
Table: Variable Instance Settings Tab
Component Description
Direction Displays the direction of the variable: Input
(receives) or Output (sends).
Polling enabled Select if an input variable is to be polled at
regular intervals or not. If the variable is not
polled, it needs to be read according to a
binding.
Poll rate (s) Enter the time in seconds for the poll rate.
Technical 04-16006-04-en, March 2015
2174
60 LonWorks User Interface
60.26 Configuration Parameters and Network Variable Properties – Variable Instance Settings Tab
Continued
Component Description
Sending enabled Select if an output variable is to be sent at
regular intervals or not. If the variable is not
sent at regular intervals, the variable needs
to be sent according to a binding.
Send rate (s) Enter the time in seconds for the send rate.
04-16006-04-en, March 2015 Technical
2175
60 LonWorks User Interface
60.27 Configuration Parameters and Network Variable Properties – Extended Settings Tab
60.27 Configuration Parameters and Network
Variable Properties – Extended Settings
Tab
Use the Extended Settings tab to view detailed information about the
parameter/variable.
Figure: Extended settings tab
Table: Extended Settings Tab
Component Description
XIF index Displays the index number for this variable in
the device template (XIF file).
Authentication Displays the authentication default for the
variable. Yes to use authentication by
default, No to not use authentication by
default.
Technical 04-16006-04-en, March 2015
2176
60 LonWorks User Interface
60.27 Configuration Parameters and Network Variable Properties – Extended Settings Tab
Continued
Component Description
Authentication changeable Displays whether the use of authentication
can be changed in the field. Yes if the use of
authentication can be changed, No if it
cannot.
Priority Displays the default use of priority for the
variable. Yes to use priority for the variable
by default, No if it cannot.
Priority changeable Displays whether the use of priority can be
changed in the field. Yes if the use of priority
can be changed, No if it cannot.
Default service type Displays the default service type to use for
connections containing this variable. 0 for
acknowledged, 1 for repeated, or 2 for
unacknowledged.
Changeable binding type Displays whether the binding type can be
changed in the field. Yes if the type can be
changed, No if it cannot.
Sync Displays the synchronized attribute of the
variable. No if the variable is not
synchronized, Yes if the variable is
synchronized (that is if all outputs are
transmitted and their order is preserved).
Config Displays the configuration attribute of the
variable. No for a non-configuration class
variable, Yes for a configuration class
variable.
Extension record Select Yes to store this variable in a
manufacturer-specific extension record in
the Network object.
Offline Displays whether the device should be taken
offline before updating the variable. No if the
variable can be updated when online or
offline, or Yes if it should be updated only
when offline.
Estimated maximum rate Displays the maximum rate estimate
specified as an encoded decimal string (0 –
250). Encoded as an unsigned decimal n,
where the rate estimate = 2(n/8)-5. Set to 0 if
the estimate is not specified.
Estimated average rate Displays the average rate estimate specified
as an encoded decimal string (0 – 250).
Encoded as an unsigned decimal n, where
the rate estimate = 2(n/8)-5. Set to 0 if the
estimate is not specified.
Network variable name Displays the network variable name.
04-16006-04-en, March 2015 Technical
2177
60 LonWorks User Interface
60.27 Configuration Parameters and Network Variable Properties – Extended Settings Tab
Continued
Component Description
Array index If the network variable is an array, only a
single array element can be the device
property. The Array Index index defines this
element.
Default service type changeable Displays whether the service type can be
changed in the field. Yes if the type can be
changed, No if it cannot.
Self documentation string Displays the variable’s self-documentation
string from the device template (XIF). If the
variable has no self-documentation, the field
contains a single asterisk.
Self documentation text Displays any optional text for the network
variable from the device template (XIF).
Technical 04-16006-04-en, March 2015
2178
60 LonWorks User Interface
60.28 Variable Member Properties
60.28 Variable Member Properties
Use the Variable Member Properties tab or dialog box to view detailed
information about network variable members or associated configuration
properties.
Figure: Basic tab
Table: Basic tab
Component Description
Default value Displays the default value for the variable.
Defined in the XIF file.
Value Enter the value of the variable.
Minimum value Displays the minimum value for the variable.
Defined in the DRF kit.
Maximum value Displays the maximum value for the variable.
Defined in the DRF kit.
Invalid value Displays the invalid value for the variable.
Defined in the DRF kit.
04-16006-04-en, March 2015 Technical
2179
60 LonWorks User Interface
60.29 Import Resource Files Wizard – Select Resource Kit Directory Page
60.29 Import Resource Files Wizard – Select
Resource Kit Directory Page
You import Device Resource Files, DRF kits, which contain a set of files that provide
profiles for functional blocks and used by device templates.
Figure: Select resource kit directory page
Technical 04-16006-04-en, March 2015
2180
60 LonWorks User Interface
60.30 Import Resource Files Wizard – Importing DRF Kit Page
60.30 Import Resource Files Wizard –
Importing DRF Kit Page
While the resource files are importing, the import status is displayed below the
progress bar. When the import is successful, the progress bar is green and
complete. If the import is not successful, the progress bar is red and complete.
Figure: Importing DRF kit page
04-16006-04-en, March 2015 Technical
2181
60 LonWorks User Interface
60.31 Import Resource Files Wizard – Committing the DRF Kit Page
60.31 Import Resource Files Wizard –
Committing the DRF Kit Page
When the resource files have been imported, they need to be committed to be
stored in the system. While the resource files are committed, the commit status is
displayed below the progress bar. When the commit is successful, the progress bar
is green and complete. If the commit is not successful, the progress bar is red and
complete.
Figure: Committing the DRF kit page
Technical 04-16006-04-en, March 2015
2182
60 LonWorks User Interface
60.32 Import Device Template Wizard – Import Device Template Page
60.32 Import Device Template Wizard –
Import Device Template Page
You import device templates stored in XIF files, which defines the functional profiles,
SNTVs, and SCPTs the device contains. If the XIF refers to functional profiles,
SNTVs, and SCPTs that do not exist in your system, you are prompted to import
matching Resource Files. For more information, see section 60.30 “Import
Resource Files Wizard – Importing DRF Kit Page” on page 2179.
Figure: Import device template page
04-16006-04-en, March 2015 Technical
2183
60 LonWorks User Interface
60.33 Import Device Template Wizard – Device Template Dialog Box
60.33 Import Device Template Wizard –
Device Template Dialog Box
When importing a device template, you can give it your own name to make it easier
to find it later (spaces and special characters are not allowed). The Program ID fields
displays the program ID from the XIF file.
Figure: Device template dialog box
Technical 04-16006-04-en, March 2015
2184
60 LonWorks User Interface
60.34 Import Device Template Wizard – Importing Device Template Page
60.34 Import Device Template Wizard –
Importing Device Template Page
When the device template is imported, it is analyzed and any errors are displayed. If
the device template uses functional profiles, SNTVs, and SCPTs that do not exist in
your system, you are prompted to import matching resource files and the XIF import
starts over.
The template can be successfully created even if errors are found or resource files
are missing. However, devices built on the template can have limited functionality
and their Complete Template flag is set to False.
Figure: Importing device template page
04-16006-04-en, March 2015 Technical
2185
60 LonWorks User Interface
60.35 Neuron ID and Commission Settings Page
60.35 Neuron ID and Commission Settings
Page
You use the Neuron ID and commission settings page to assign a neuron ID
to a device and set up how the configuration is handled when the device is
commissioned.
Figure: Neuron ID and commission settings page
Table: Neuron ID and Commission Settings Page
Component Description
Neuron ID Type the neuron ID for the device.
Service Pin Click to receive the neuron ID when it is sent
from the device.
Template Program ID Displays the program ID of the device
template (XIF file) for the selected device
type.
Received Program ID Displays the Program ID in the physical
device.
Application download Select to download the application that is
assigned to the device to the physical
device.
Commission Select to commission the device.
Keep current configuration in the Select to leave the configuration parameters
device in the physical device as is.
Technical 04-16006-04-en, March 2015
2186
60 LonWorks User Interface
60.35 Neuron ID and Commission Settings Page
Continued
Component Description
Download current configuration to Select to download the device configuration
device parameters to the physical device.
Download default configuration to Select to download the default configuration
device parameters from the device template for this
device type to the physical device.
Upload configuration from device Select to update the the server with the
current configuration parameters in the
physical device.
Xenta group Enter the group to which the device belongs
(Xenta devices only). For more information,
see section 62.18 “Xenta LonWorks Groups”
on page 2252.
Device application file Select to upgrade the device application for
the physical device. For more information,
see section 56.10 “LonWorks Application
Upgrade” on page 2019.
The Device application file check box is
not applicable to MNL LonWorks devices.
Files (*.nxe) Enter the NXE file that you want to upgrade
the device with.
Application download Select to transfer an application to the
physical device (Xenta devices only).
Files (*.mta) Enter the MTA file that you want to tranfer to
the device (Xenta devices only)
M1...n (IO modules) Type the neuron ID for the IO module if you
have not already associated it with the Xenta
device (Xenta devices only).
Service Pin Click to receive the neuron ID when it is sent
from the IO module (Xenta devices only).
04-16006-04-en, March 2015 Technical
2187
60 LonWorks User Interface
60.36 Lon Folder Properties
60.36 Lon Folder Properties
Use the Lon Folder Properties view or dialog box to configure and view the
general and object-reference properties. For more information, see the General
Properties – Basic Tab topic on WebHelp.
Figure: Lon folder properties
Technical 04-16006-04-en, March 2015
2188
60 LonWorks User Interface
60.37 Add Missing Files Wizard – Searching for Missing Files Page
60.37 Add Missing Files Wizard – Searching
for Missing Files Page
Use the Searching for Missing Files page to identify missing XIF and DRF files.
Figure: Searching for missing files page
04-16006-04-en, March 2015 Technical
2189
60 LonWorks User Interface
60.38 Add Missing Files Wizard – Select Directory to Search for XIF and DRF Resources Page
60.38 Add Missing Files Wizard – Select
Directory to Search for XIF and DRF
Resources Page
Use the Select Directory to Search for XIF and DRF Resources page to
select the folder where the missing files can be found. Subfolders are searched as
well.
Figure: Select directory to search for XIF and DRF resources page
Technical 04-16006-04-en, March 2015
2190
60 LonWorks User Interface
60.39 Add Missing Files Wizard – Searching for Replacement Files Page
60.39 Add Missing Files Wizard – Searching
for Replacement Files Page
Use the Searching for Replacement Files page to view and import the missing
files that have been found.
Figure: Searching for replacement files page
04-16006-04-en, March 2015 Technical
2191
60 LonWorks User Interface
60.40 Add Missing Files Wizard – Importing Replacement Files Page
60.40 Add Missing Files Wizard – Importing
Replacement Files Page
Use the Importing Replacement Files page to view the import result and to
commit the import.
Figure: Importing replacement files page
Technical 04-16006-04-en, March 2015
2192
60 LonWorks User Interface
60.41 LNS Plug-in Registration View
60.41 LNS Plug-in Registration View
Use the LNS Plug-in Registration view to register LNS Plug-ins. You register
LNS Plug-ins so that you can use manufacturer´s applications when configuring
LonWorks devices.
Figure: LNS Plug-in registration view
Table: LNS Plug-in Registration View
Component Description
Import device template in LNS
database
Enter the LNS Plug-in .exe file that you want
to make available.
Add all button
Click to register all LNS Plug-ins.
Add button
Click to register the selected LNS Plug-in.
Remove all button
Click to unregister all LNS Plug-ins.
Remove button
Click to unregister the selected LNS Plug-in.
Available LNS Plug-ins List of the LNS Plug-ins available.
Registered LNS Plug-ins List of the LNS Plug-ins that are registered.
04-16006-04-en, March 2015 Technical
2193
60 LonWorks User Interface
60.41 LNS Plug-in Registration View
Continued
Component Description
LNS Plug-in Information Displays the third party
information about LNS Plug-
ins, such as name,
description, manufacturer,
and version.
Technical 04-16006-04-en, March 2015
2194
60 LonWorks User Interface
60.42 Configure Using LNS Plug-ins Wizard - Copying Device Configuration to LNS Page
60.42 Configure Using LNS Plug-ins Wizard -
Copying Device Configuration to LNS
Page
Use the Copying Device Configuration to LNS page to match the device with
the correct LNS template, and copy the device configuration to the LNS database.
Figure: Copying device configuration to LNS page
04-16006-04-en, March 2015 Technical
2195
60 LonWorks User Interface
60.43 Configure Using LNS Plug-ins Wizard - Select LNS Plug-in Page
60.43 Configure Using LNS Plug-ins Wizard -
Select LNS Plug-in Page
Use the Select LNS Plug-in page to view, select, and launch available LNS Plug-
ins.
Figure: Select LNS Plug-in page
Table: LNS Device Wizard Configure Page
Property Description
Open LNS Plug-in
Click to open the selected LNS Plug-in.
LNS Plug-in List of the available LNS Plug-ins.
Description Description of the LNS Plug-in.
Technical 04-16006-04-en, March 2015
2196
60 LonWorks User Interface
60.44 Configure Using LNS Plug-ins Wizard - Confirm LNS Configuration Page
60.44 Configure Using LNS Plug-ins Wizard -
Confirm LNS Configuration Page
Use the Confirm LNS Configuration page to proceed with the configuration
after making sure that all changes have been applied.
Figure: Confirm LNS configuration page
04-16006-04-en, March 2015 Technical
2197
60 LonWorks User Interface
60.45 Configure Using LNS Plug-ins Wizard - Copying Device Configuration from LNS Page
60.45 Configure Using LNS Plug-ins Wizard -
Copying Device Configuration from LNS
Page
Use the Copying Device Configuration from LNS page to copy the device
configuration from the LNS database and finish the LNS Plug-in configuration.
Figure: Copying device configuration from LNS page
Technical 04-16006-04-en, March 2015
2198
60 LonWorks User Interface
60.46 Lon Binding Properties
60.46 Lon Binding Properties
Use the Lon Binding Properties dialog box to configure a LonWorks binding.
Figure: Lon binding properties
Table: Lon Binding Properties
Component Description
Binding profile Select a binding profile. For more
information, see section 58.3 “LonWorks
Binding Profiles ” on page 2096.
Initial Read Select to disable initial read. Disabling initial
read results in less communication load on
the network when restarting the Automation
Server.
04-16006-04-en, March 2015 Technical
2199
60 LonWorks User Interface
60.47 LonWorks Binding Profile Icons
60.47 LonWorks Binding Profile Icons
This table describes the LonWorks binding profile icons.
Table: LonWorks Binding Profile Icons
Icon Description
Indicates an Acknowledged binding profile.
Indicates an acknowledged binding profile
with retries.
Indicates an unacknowledged binding
profile.
Indicates an unacknowledged binding profile
with repeats.
Indicates a broadcast binding profile.
Indicates a broadcast binding profile with
repeats.
Technical 04-16006-04-en, March 2015
2200
60 LonWorks User Interface
60.48 LonWorks Binding Profile Properties – Basic Tab
60.48 LonWorks Binding Profile Properties –
Basic Tab
Use the Basic tab to view the basic properties of the binding profile.
Note
• The template is read only.
Figure: Basic tab
Table: Basic Tab
Component Description
Service type Displays the type of service to be used for
sending messages. Auto automatically
selects the service type according to the XIF
file.
Priority Displays if priority messaging is used. Auto
enables messaging when the devices on
both sides of the connection have priority
enabled.
04-16006-04-en, March 2015 Technical
2201
60 LonWorks User Interface
60.49 LonWorks Binding Profile Properties – Advanced Tab
60.49 LonWorks Binding Profile Properties –
Advanced Tab
Use the Advanced tab to view the advanced properties of the binding profile.
Note
• The template is read only.
Figure: Advanced tab
Table: Advanced Tab
Component Description
Suppress source address Displays True if it suppresses address table
and selector table updates for bindings using
this template. This function is used for
devices that use explicit addressing to get
around address table limitations. The source
device is responsible for managing the
destination addresses.
Use broadcast Displays if broadcast is enabled.
Transmit The transmit timer displays how long an
Acknowledged messaging binding should
wait for confirmation before resending the
message.
Repeat The repeat timer displays how long the
connection waits between repeats when
using Unacknowledged Repeat messaging.
Technical 04-16006-04-en, March 2015
2202
60 LonWorks User Interface
60.49 LonWorks Binding Profile Properties – Advanced Tab
Continued
Component Description
Receive The receive timer displays the time during
which the receiving end of the binding treats
messages from the same source with the
same message ID a duplicate messages.
Retry The retry count displays the number of times
a binding using Acknowledged messaging
should retry sending the message if no
confirmation is received.
Repeat The repeat count displays the number of
times a connection using Unacknowledged
Repeat messaging should repeat a
message.
04-16006-04-en, March 2015 Technical
2203
61 Xenta LonWorks Introduction
Topics
Xenta LonWorks Device Overview
Xenta LonWorks Engineering
LonWorks Interfaces
Xenta LonWorks Device Workflows
Create and then Discover Xenta LonWorks Device Workflow
Discover Xenta LonWorks Device Workflow
Create Xenta LonWorks Device Workflow
Configuring a LonWorks Network for Xenta Devices
Binding Xenta Network Variables
Xenta OP
61 Xenta LonWorks Introduction
61.1 Xenta LonWorks Device Overview
61.1 Xenta LonWorks Device Overview
The Xenta 280/300/401 LonWorks devices are a family of programmable, stand-
alone devices that provide Direct Digital Control of air handlers and systems as well
as individual terminal units.
Because these devices focus on individual units, they are often referred to as field
controllers. Xenta 280/300/401 LonWorks devices include local processing (Neuron
chip) and I/O hardware to process input data from sensors, execute a control task,
and control actuators.
TAC Xenta 280/300/401, product manual, PN 04-00067 and TAC Xenta 400 I/O
Modules, product manual, PN 0047771
61.1.1 Xenta LonWorks Devices
Xenta 280/300/401 LonWorks devices are configured as LonWorks devices with
SNVT handling. These devices also have non-standard enhancements, such as
support for TACNV, advanced alarm handling, time schedules, and extensive trend
logs.
For more information, see section 62.1 “Xenta LonWorks Devices” on page 2229.
61.1.2 Xenta LonWorks Engineering
Using Building Operation, you configure a LonWorks network that connects to an
Automation Server or an Enterprise Server. These servers collect information from
the devices on the LonWorks network(s) and display them on WorkStation.
For more information, see section 61.2 “Xenta LonWorks Engineering” on page
2206.
61.1.3 Xenta LonWorks Device Functions
Many of the functions and features of Xenta LonWorks devices are supported in
Building Operation, including trend logs, alarms, schedules, time functions, and the
ability to view Xenta variables from a Menta application.
For more information, see section 62.19 “Xenta LonWorks Device Functions” on
page 2253.
04-16006-04-en, March 2015 Technical
2207
61 Xenta LonWorks Introduction
61.2 Xenta LonWorks Engineering
61.2 Xenta LonWorks Engineering
Using Building Operation, you configure a LonWorks network that connects to an
Automation Server or an Enterprise Server. These servers collect information from
the devices on the LonWorks network(s) and display them on WorkStation.
WorkStation acts as the primary interface and allows you to configure, program,
and monitor the system. WorkStation uses any IP network to communicate with the
Automation Servers and Enterprise Servers. The Automation Servers are hardware
modules that reside at the IP-level and route information to and from the IP-level to
the LonWorks network.
For more information, see the Automation Servers topic on WebHelp.
For more information, see section 3.2 “Enterprise Server” on page 136.
Figure: LON devices, for example Xenta devices, in a Building Operation network
Technical 04-16006-04-en, March 2015
2208
61 Xenta LonWorks Introduction
61.2 Xenta LonWorks Engineering
The communication between the Automation Servers and Xenta 280/300/401
LonWorks devices allows the Xenta devices to create and manage alarms, trend
logs, time schedules, and share data with other controllers. Xenta 280/300/401
LonWorks devices support the LonTalk protocol to communicate with other
LonWorks devices. When talking to other Xenta 280/300/401 LonWorks devices,
LACnet, a proprietary protocol, is used.
In WorkStation, each Automation Server and associated Xenta 280/300/401
LonWorks devices are represented in the System Tree pane.
Figure: An Automation Server, a LonWorks network, and Xenta devices in the System
Tree
Xenta 280/300/401 LonWorks devices on a LonWorks network can be attached to
the Building Operation network in two basic ways:
• Connected to an Automation Server by means of a built-in network interface,
with a maximum of 30 Xenta 280/300/401 LonWorks devices.
• Connected to an Enterprise Server by means of a suitable Loytec network
interface, with a maximum of about 60 Xenta 280/300/401 LonWorks devices.
The configuration and commissioning of Xenta 280/300/401 LonWorks devices is
performed at WorkStation. After this, the associated Menta applications are running
in the physical Xenta devices. Public signals, SNVTs, and TACNVs are updated and
are available from WorkStation.
The Xenta 280/300/401 LonWorks devices communicate with each other over the
LonWorks network using TACNV and SNVT bindings. To ease the network
communication load, SNVTs can be bound to a local node associated with the
Automation Server. For more information, see section 57.9 “Network Variables and
Configuration Parameters” on page 2074.
61.2.1 Xenta LonWorks Device Workflow
There are three ways of creating and configuring a Xenta 280/300/401 LonWorks
device.
For more information, see section 61.4 “Xenta LonWorks Device Workflows” on
page 2211.
04-16006-04-en, March 2015 Technical
2209
61 Xenta LonWorks Introduction
61.2 Xenta LonWorks Engineering
61.2.2 LonWorks Interfaces
Building Operation servers connect to LonWorks networks through various
LOYTEC interfaces and communicate with LonWorks devices over EIA-709 (FT-10)
or EIA 852 (Ethernet).
For more information, see section 68.3 “LonWorks Interfaces” on page 2358.
61.2.3 Xenta LonWorks Groups
The Xenta Group is a logical group that is used to build a simple hierarchy of the
Xenta 280/300/401 LonWorks devices. In Building Operation, each Xenta Group is
collected in a separate folder.
For more information, see section 62.18 “Xenta LonWorks Groups” on page 2252.
61.2.4 Xenta LonWorks Device Commissioning
When you click Commission a number of tasks are performed on the Xenta
280/300/401 LonWorks device. The commission command may or may not include
an application download, depending on what you specify (if that option is available)
and on what has been changed since the previous commission and download.
For more information, see section 62.5 “Xenta LonWorks Device Commissioning”
on page 2236.
61.2.5 Xenta LonWorks Applications
The application in a Xenta LonWorks device contains the control logic used in the
device. Xenta LonWorks applications appear below the device object in the
System Tree pane and are edited in Menta Editor to configure the device to
different control and monitoring tasks.
For more information, see section 63.1 “Xenta LonWorks Applications” on page
2269.
Technical 04-16006-04-en, March 2015
2210
61 Xenta LonWorks Introduction
61.3 LonWorks Interfaces
61.3 LonWorks Interfaces
Building Operation servers connect to LonWorks networks through various
LOYTEC interfaces and communicate with LonWorks devices over EIA-709 (FT-10)
or EIA 852 (Ethernet).
Figure: LonWorks in Building Operation
04-16006-04-en, March 2015 Technical
2211
61 Xenta LonWorks Introduction
61.3 LonWorks Interfaces
61.3.1 LonWorks in the Automation Server
The Automation Server connects to LonWorks networks through a built-in LOYTEC
FT interface and communicates with LonWorks devices over EIA-709 (FT-10).
For more information, see section 55.4 “LonWorks in the Automation Server” on
page 1976.
61.3.2 LonWorks in the Enterprise Server
The Enterprise Server connects to LonWorks networks through various LOYTEC
NIC-interfaces and communicates with LonWorks devices over EIA-709 (FT-10) or
EIA-852 (Ethernet).
For more information, see section 55.5 “LonWorks in the Enterprise Server” on
page 1977.
61.3.3 Externally Managed LonWorks Network
You can connect an externally managed LonWorks network to Building Operation
through an Automation Server, in order to view and represent that same LonWorks
network data in WorkStation. The externally managed network is configured and
managed, through LNS, with an external LonWorks manager tool connected to the
network.
For more information, see section 55.11 “Externally Managed LonWorks Network”
on page 1991.
Technical 04-16006-04-en, March 2015
2212
61 Xenta LonWorks Introduction
61.4 Xenta LonWorks Device Workflows
61.4 Xenta LonWorks Device Workflows
There are three ways of creating and configuring a Xenta 280/300/401 LonWorks
device.
61.4.1 Create and then Discover Xenta LonWorks
Device Workflow
Use the Create and then Discover Xenta LonWorks Device workflow to create and
discover LonWorks devices online.
For more information, see section 61.5 “Create and then Discover Xenta LonWorks
Device Workflow” on page 2212.
61.4.2 Discover Xenta LonWorks Device Workflow
Use the Discover Xenta LonWorks Device workflow to discover and create Xenta
LonWorks devices online.
For more information, see section 61.6 “Discover Xenta LonWorks Device
Workflow” on page 2214.
61.4.3 Create Xenta LonWorks Device Workflow
Use the Create Xenta LonWorks Device Workflow to create Xenta LonWorks
devices offline in a project and to deploy and commission the devices and the local
node on an on-site server.
For more information, see section 61.7 “Create Xenta LonWorks Device Workflow”
on page 2216.
04-16006-04-en, March 2015 Technical
2213
61 Xenta LonWorks Introduction
61.5 Create and then Discover Xenta LonWorks Device Workflow
61.5 Create and then Discover Xenta
LonWorks Device Workflow
Use the Create and then Discover Xenta LonWorks Device workflow to create and
discover LonWorks devices online.
Figure: Deploy LonWorks project workflow
Technical 04-16006-04-en, March 2015
2214
61 Xenta LonWorks Introduction
61.5 Create and then Discover Xenta LonWorks Device Workflow
Create a LonWorks interface
In WorkStation, create a LonWorks interface in the server.
For more information, see section 55.12 “Creating a LonWorks Interface” on page
1993.
Create a LonWorks network
In WorkStation, create the LonWorks network on the LonWorks Interface.
For more information, see section 55.15 “Creating a LonWorks Network” on page
1996.
Create Xenta LonWorks devices
In WorkStation, create the Xenta LonWorks devices on the LonWorks network.
For more information, see section 62.2 “Creating a Programmable Xenta Device” on
page 2231.
Configure the Xenta LonWorks devices and Edit the Menta
Applications
In WorkStation, configure the Xenta LonWorks devices and edit and import the
Menta applications.
For more information, see section 62.4 “Configuring a Xenta LonWorks Device” on
page 2235.
For more information, see section 63.3 “Editing a Menta Application” on page 2271.
For more information, see section 63.4 “Importing a Menta Application to a Xenta
Device” on page 2272.
Connect the Xenta LonWorks devices
Physically connect the Xenta LonWorks devices to the on-site server.
Discover the Xenta LonWorks devices
In WorkStation, discover the Xenta LonWorks devices to obtain the Neuron ID and
create the devices.
For more information, see section 62.3 “Discovering a Xenta Device” on page 2233.
Create a local node and local node variables
In WorkStation, create a local node and local node variables by mirroring a device
network variable or manually creating.
For more information, see section 57.2 “Creating a Local Node” on page 2067.
For more information, see section 57.12 “Creating Network Variables Automatically”
on page 2078.
Commission the Xenta LonWorks devices
In WorkStation, commission the devices on the server.
For more information, see section 62.6 “Commissioning a Xenta Device” on page
2237.
04-16006-04-en, March 2015 Technical
2215
61 Xenta LonWorks Introduction
61.6 Discover Xenta LonWorks Device Workflow
61.6 Discover Xenta LonWorks Device
Workflow
Use the Discover Xenta LonWorks Device workflow to discover and create Xenta
LonWorks devices online.
Figure: Deploy LonWorks project workflow
Create a LonWorks interface
In WorkStation, create a Lonworks interface in the server.
For more information, see section 55.12 “Creating a LonWorks Interface” on page
1993.
Technical 04-16006-04-en, March 2015
2216
61 Xenta LonWorks Introduction
61.6 Discover Xenta LonWorks Device Workflow
Create a LonWorks network
In WorkStation, create the Lonworks network on the LonWorks Interface.
For more information, see section 55.15 “Creating a LonWorks Network” on page
1996.
Connect the Xenta LonWorks devices
Physically connect the Xenta LonWorks devices to the on-site server.
Discover the Xenta LonWorks devices
In WorkStation, discover the Xenta LonWorks devices to obtain the Neuron ID and
create the devices.
For more information, see section 62.3 “Discovering a Xenta Device” on page 2233.
Configure the Xenta LonWorks devices and Edit the Menta
Applications
In WorkStation, configure the Xenta LonWorks devices and edit and import the
Menta applications.
For more information, see section 62.4 “Configuring a Xenta LonWorks Device” on
page 2235.
For more information, see section 63.3 “Editing a Menta Application” on page 2271.
Create a local node and local node variables
In WorkStation, create a local node and local node variables by mirroring a device
network variable or manually creating.
For more information, see section 57.2 “Creating a Local Node” on page 2067.
For more information, see section 57.12 “Creating Network Variables Automatically”
on page 2078.
Commission the Xenta LonWorks devices
In WorkStation, commission the Xenta LonWorks devices on the server.
For more information, see section 62.6 “Commissioning a Xenta Device” on page
2237.
04-16006-04-en, March 2015 Technical
2217
61 Xenta LonWorks Introduction
61.7 Create Xenta LonWorks Device Workflow
61.7 Create Xenta LonWorks Device
Workflow
Use the Create Xenta LonWorks Device Workflow to create Xenta LonWorks
devices offline in a project and to deploy and commission the devices and the local
node on an on-site server.
Technical 04-16006-04-en, March 2015
2218
61 Xenta LonWorks Introduction
61.7 Create Xenta LonWorks Device Workflow
Figure: Deploy LonWorks project workflow
04-16006-04-en, March 2015 Technical
2219
61 Xenta LonWorks Introduction
61.7 Create Xenta LonWorks Device Workflow
Create a LonWorks interface
In WorkStation for Projects, create a LonWorks interface.
For more information, see section 55.12 “Creating a LonWorks Interface” on page
1993.
Create a LonWorks network
In WorkStation for Projects, create a LonWorks network on the LonWorks interface.
For more information, see section 55.15 “Creating a LonWorks Network” on page
1996.
Create Xenta LonWorks devices
In WorkStation for Projects, create the Xenta LonWorks devices in an Automation
Server necessary for the project on the LonWorks network.
For more information, see section 62.2 “Creating a Programmable Xenta Device” on
page 2231.
Import Menta applications to the devices
In WorkStation for Projects, open the Menta Editor and import Menta applications
to the devices.
For more information, see section 63.4 “Importing a Menta Application to a Xenta
Device” on page 2272.
Configure the Xenta LonWorks devices and Edit the Menta
Applications
In WorkStation for Projects, configure the Xenta LonWorks devices and edit and
import the Menta applications necessary.
Note
Xenta groups are not created automatically in WorkStation for Projects. After
deploy, a Xenta group is automatically created for every 30 Xenta devices.
For more information, see section 62.4 “Configuring a Xenta LonWorks Device” on
page 2235.
For more information, see section 63.3 “Editing a Menta Application” on page 2271.
Create a local node and local node variables
In WorkStation for Projects, create a Local Node and Local Node variables by
mirroring a device network variable or manually creating.
For more information, see section 57.2 “Creating a Local Node” on page 2067.
For more information, see section 57.12 “Creating Network Variables Automatically”
on page 2078.
Create Objects
In WorkStation for Projects, create all necessary objects, such as alarms, schedules
and trend logs.
For more information, see the Alarm Overview topic on WebHelp.
For more information, see the Schedules Overview topic on WebHelp.
Technical 04-16006-04-en, March 2015
2220
61 Xenta LonWorks Introduction
61.7 Create Xenta LonWorks Device Workflow
For more information, see the Trend Overview topic on WebHelp.
Update server communication parameters
In WorkStation for Projects, update the server communication parameters for all
servers.
For more information, see section 4.9 “Updating Project Configuration Server
Communication Parameters” on page 187.
Important
It is recommended to update the Enterprise Server communication parameter
before the deploy of the first Automation Server.
For more information, see section 4.4 “Updating Communication Parameters” on
page 179.
Deploy the Automation Servers
In WorkStation for Projects, deploy the Automation Server.
Caution
Ensure that you have created all domain devices and objects before the deploy of
an Automation Server. If you add devices and objects to the Automation Server
and deploy the server again, you first have to clear the database of the physical
Automation Server.
For more information, see section 6.8 “Deploy” on page 248.
For more information, see section 6.12 “Deploying a Server” on page 260.
Connect the Xenta LonWorks devices
Physically connect the Xenta LonWorks devices to the on-site server.
Commission the Xenta LonWorks devices
In WorkStation, commission the deployed devices on the on-site server.
For more information, see section 62.6 “Commissioning a Xenta Device” on page
2237.
Commission the local node
In WorkStation, commission the deployed local node on the on-site server.
For more information, see section 57.5 “Commissioning a Local Node” on page
2070.
Update server communication parameters
In WorkStation for Projects, update the server communication parameters for all
servers.
For more information, see section 4.9 “Updating Project Configuration Server
Communication Parameters” on page 187.
04-16006-04-en, March 2015 Technical
2221
61 Xenta LonWorks Introduction
61.7 Create Xenta LonWorks Device Workflow
Important
It is recommended to update all Automation Server communication parameters
before the deploy of the Enterprise Server.
For more information, see section 4.4 “Updating Communication Parameters” on
page 179.
Deploy the Enterprise Server
In WorkStation for Projects, deploy the Enterprise Server.
Important
Ensure that you have created all Automation Servers in the project before the
deploy of the Enterprise Server. You can only deploy to an empty Enterprise
Server. Any additional Automation Servers have to be created on the on-site
server.
For more information, see section 6.8 “Deploy” on page 248.
For more information, see section 6.12 “Deploying a Server” on page 260.
Technical 04-16006-04-en, March 2015
2222
61 Xenta LonWorks Introduction
61.8 Configuring a LonWorks Network for Xenta Devices
61.8 Configuring a LonWorks Network for
Xenta Devices
You configure the communication parameters for the Xenta devices in a LonWorks
network by editing the properties under the Xenta tab.
For more information, see section 61.2 “Xenta LonWorks Engineering” on page
2206.
To configure a LonWorks network for Xenta devices
1. In WorkStation, in the System Tree pane, select the network.
2. Click the Properties tab and then click the Xenta tab.
Continued on next page
04-16006-04-en, March 2015 Technical
2223
61 Xenta LonWorks Introduction
61.8 Configuring a LonWorks Network for Xenta Devices
3. Edit the Xenta network properties.
Component Description
Classic Operator Panel Support Select Yes to get support for classic OP
functionality, that is, the OP can be
connected to any Xenta device.
Network name in blueprint Displays the current name of the network.
System alarm priority Enter the priority of Xenta non-application
alarms.
Time synchronization interval (min) Enter the time interval between
synchronization of Xenta and the server
clocks. The default value is 10.
Heartbeat (s) Enter the time interval for the server
heartbeat on the LonWorks network. The
default value is 20 s.
Component Description
Timeout (ms) Enter the amount of time in milliseconds
until Xenta communication should be
considered broken. The default is 10,000
ms.
Transmit timer (ms) Displays the time before Xenta
retransmission (if no answer).
Number of retries Enter the maximum number of attempts
before giving up. The default value is 4.
Technical 04-16006-04-en, March 2015
2224
61 Xenta LonWorks Introduction
61.8 Configuring a LonWorks Network for Xenta Devices
4. Click OK to save the changes.
04-16006-04-en, March 2015 Technical
2225
61 Xenta LonWorks Introduction
61.9 Binding Xenta Network Variables
61.9 Binding Xenta Network Variables
In Building Operation Menta Editor, you bind TACNV signals to public signals of
other Xenta 280/300/401 LonWorks devices on the same network. TAC Menta
Technical Manual, 04-00030.
To bind Xenta network variables
1. In WorkStation, in the System Tree pane, select the Xenta 280/300/401
LonWorks device where you want to add the new TACNV signal.
2. On the Actions menu, click Edit.
3. In the Building Operation Menta Editor, add a suitable input or output block.
4. Select Public.
5. In the Identifier box, type an identity for the signal.
6. In the Unit box, select a unit, if applicable.
7. In the Description box, type an optional description.
8. Click Bind.
Continued on next page
Technical 04-16006-04-en, March 2015
2226
61 Xenta LonWorks Introduction
61.9 Binding Xenta Network Variables
9. Select Network Variable.
10. In theNetwork Address box, click the Browse button.
11. Select a public signal from the list of all public signals in the network.
12. Click Select.
13. In the Bind Analog Input dialog box, click OK.
14. Click OK.
You have created a public Xenta signal bound to another public Xenta signal. The
bound signal appears among the variables listed for the Xenta 280/300/401
LonWorks device.
04-16006-04-en, March 2015 Technical
2227
61 Xenta LonWorks Introduction
61.10 Xenta OP
61.10 Xenta OP
Xenta OP is an operator panel that can be used with Xenta 280/300/401 LonWorks
devices that are part of a Building Operation system. Xenta OP can be used in two
ways:
• As a LonWorks unit inspector of other LonWorks units and the SNVTs they
use.
• To monitor Xenta 280/300/401 LonWorks devices with a user defined OP tree,
and group hierarchy display.
In the latter case, Xenta OP can be set up to operate in one of three different
modes:
• INST: Xenta OP is permanently connected, electrically, to the LonWorks
network and is not portable. It gets its address from the network management
tool. It can see and inspect all LonWorks devices on the network and there is
no risk of address conflicts. This is the recommended mode for Xenta OP.
• MAN: Xenta OP is partly portable, and can be moved anywhere in the network.
It sets its own address but requires manual input of the current Domain ID. It
can see all LonWorks devices but can only inspect those devices that are
under the same router as the OP.
• TAC: Xenta OP is fully portable, and can be easily moved anywhere in the
network. It gets its address from the Xenta 280/300/401 LonWorks base unit.
It can see and inspect all LonWorks devices on the network. However, the OP
has a more complex underlying configuration structure. Although this mode is
useful, it should be used sparingly because there is a risk for address conflicts.
The standard menus and the operation of the operator panel are described in the
TAC Xenta OP Operating Manual (04-00065).
Technical 04-16006-04-en, March 2015
2228
62 Xenta LonWorks Devices
Topics
Xenta LonWorks Devices
Creating a Programmable Xenta Device
Discovering a Xenta Device
Configuring a Xenta LonWorks Device
Xenta LonWorks Device Commissioning
Commissioning a Xenta Device
Xenta LonWorks Daylight Savings Time Switchover
Xenta LonWorks Time Synchronization
Identifying a Xenta I/O Module
Checking the Neuron ID of a Xenta I/O Device
Xenta LonWorks Device Decommissioning
Decommissioning a Xenta Device
Replacing an Online Xenta Device
Downloading the Xenta Device Configuration
Uploading the Xenta Device Configuration
Replacing an Offline Xenta Device
Replacing a Xenta I/O Module
Xenta LonWorks Groups
Xenta LonWorks Device Functions
Trend Logs for Xenta LonWorks Devices
Configuring a Xenta Trend Log
Alarms for Xenta LonWorks Devices
Schedules for Xenta LonWorks Devices
Time Functions for Xenta LonWorks Devices
Xenta LonWorks Variables Display
Xenta LonWorks Device Restart
62 Xenta LonWorks Devices
62.1 Xenta LonWorks Devices
62.1 Xenta LonWorks Devices
Xenta 280/300/401 LonWorks devices are configured as LonWorks devices with
SNVT handling. These devices also have non-standard enhancements, such as
support for TACNV, advanced alarm handling, time schedules, and extensive trend
logs.
TAC Xenta 280/300/401, Product Manual (04-00067) and TAC Xenta 400 I/O
Modules, Product Manual (0047771)
Table: Models of Xenta LonWorks Devices and I/O Modules
Device Series Devices I/O Modules
Xenta 280 Series Xenta 281 LonWorks Device None
Xenta 282 LonWorks Device
Xenta 283 LonWorks Device
Xenta 301 Series Xenta 301 LonWorks Device Up to 2 I/O modules:
Xenta 302 LonWorks Device See models listed for Xenta
401 LonWorks Device
Xenta 301:C LonWorks Up to 4 I/O modules:
Device
See models listed for Xenta
Xenta 302:C LonWorks 401 LonWorks Device
Device
Xenta 401 Series Xenta 401 LonWorks Device Up to 10 I/O modules:
Xenta 411 I/O Module
Xenta 412 I/O Module
Xenta 421A I/O Module
Xenta 422A I/O Module
Xenta 451A I/O Module
Xenta 452A I/O Module
Xenta 471 I/O Module
Xenta 491 I/O Module
Xenta 492 I/O Module
Xenta 401:B LonWorks None
Device
Xenta 401:C LonWorks Up to 15 I/O modules:
Device
See models listed for Xenta
401 LonWorks Device
04-16006-04-en, March 2015 Technical
2231
62 Xenta LonWorks Devices
62.1 Xenta LonWorks Devices
Device Series Devices I/O Modules
62.1.1 Xenta OP
Xenta OP is an operator panel that can be used with Xenta 280/300/401 LonWorks
devices that are part of a Building Operation system. Xenta OP can be used in two
ways:
• As a LonWorks unit inspector of other LonWorks units and the SNVTs they
use.
• To monitor Xenta 280/300/401 LonWorks devices with a user defined OP tree,
and group hierarchy display.
For more information, see section 61.10 “Xenta OP” on page 2226.
62.1.2 Xenta LonWorks Device Restart
When you cold start or warm start a Xenta 280/300/401 LonWorks device, the
device is not indicated as offline and no alarm is generated.
For more information, see section 62.26 “Xenta LonWorks Device Restart” on page
2266.
Technical 04-16006-04-en, March 2015
2232
62 Xenta LonWorks Devices
62.2 Creating a Programmable Xenta Device
62.2 Creating a Programmable Xenta Device
You create programmable Xenta devices under the LonWorks network to connect
to physical Xenta 280/300/401 LonWorks devices.
To create a programmable Xenta device
1. In WorkStation, in the System Tree pane, select the LonWorks network or
LonWorks network folder where you want to create the programmable Xenta
device.
2. On the File menu, point to New and then click Device.
3. In the object type list, select ProgrammableXenta.
4. In the Name box, type a name for the device.
Tip
• The name of the programmable Xenta device must be unique in
the network, even for programmable Xenta devices in different
folders in the network.
5. In the Description box, type a description.
6. Click Next.
Continued on next page
04-16006-04-en, March 2015 Technical
2233
62 Xenta LonWorks Devices
62.2 Creating a Programmable Xenta Device
7. In the Neuron ID box, enter the Neuron ID for the device.
8. In the Files box, enter the Menta application (MTA) file.
9. Select Application download to download the application to the device.
10. Click Create.
Note
• Xenta I/O modules are not added in this way. As they are defined in the
Menta application program, they are automatically added to the I/O folder
when the Xenta application is downloaded.
Technical 04-16006-04-en, March 2015
2234
62 Xenta LonWorks Devices
62.3 Discovering a Xenta Device
62.3 Discovering a Xenta Device
You discover Xenta 280/300/401 LonWorks devices to create or configure the
programmable Xenta devices in the server. The Xenta 280/300/401 LonWorks
devices must be physically connected to the server field bus.
For more information, see section 56.16 “LonWorks Device Workflows” on page
2029.
To discover a Xenta device
1. In WorkStation, in the System Tree pane, select the server that is connected
to the device you want to discover.
2. Click the Device Discovery view.
3. In the Select device type box, select LonWorks.
4. Select the Devices folder.
5. On the Actions menu, click Activate listen to service pin.
6. Press the service pin on the physical device.
Continued on next page
04-16006-04-en, March 2015 Technical
2235
62 Xenta LonWorks Devices
62.3 Discovering a Xenta Device
7. In the Device Discovery view, ensure that the Xenta device is displayed in
the Devices folder. This may take up to 5 seconds.
8. On the Actions menu, click Deactivate listen to service pin.
9. Drag the discovered service pin (device) to the System Tree pane:
• Drag to an existing device to associate it with the discovered physical
device.
• Drag to the LonWorks network to create the device.
Tip
• To verify the device Neuron ID, select the device in the System
Tree pane, and then select Properties on the File menu. The
Neuron ID can be found on the Basic tab of the Device
Properties.
Technical 04-16006-04-en, March 2015
2236
62 Xenta LonWorks Devices
62.4 Configuring a Xenta LonWorks Device
62.4 Configuring a Xenta LonWorks Device
In WorkStation, you read the properties of a Xenta device under the Xenta tab.
For more information, see section 61.2 “Xenta LonWorks Engineering” on page
2206.
To configure a Xenta LonWorks device
1. In WorkStation, in the System Tree pane, select the Xenta device.
2. Click the Properties tab and then click the Xenta tab.
3. Edit the Xenta device properties.
Component Description
Xenta type Displays type as selected in Menta.
Group master Displays if this Xenta device is a group
master.
Member of group Displays the Xenta group to which a
device belongs.
Node number Displays the node number in the
LonWorks network.
Software version Displays the Xenta software (firmware)
version.
Hardware version Displays Xenta hardware version.
Boot version Displays the Xenta boot program version.
Local time Displays the local time in the Xenta
device. May be compared with the server
clock.
DST Last update Displays date and time for the last
Daylight Saving Time update.
4. Click Close to close the window.
04-16006-04-en, March 2015 Technical
2237
62 Xenta LonWorks Devices
62.5 Xenta LonWorks Device Commissioning
62.5 Xenta LonWorks Device Commissioning
When you click Commission you affect the Xenta 280/300/401 LonWorks device
in a number of ways. The commission command may or may not include an
application download, depending on what you specify (if that option is available)
and on what has been changed since the previous commission and download.
The following tasks are performed during the commissioning:
• Daylight Saving Time settings are downloaded to the physical Xenta
280/300/401 LonWorks device.
• The Xenta 280/300/401 LonWorks device clock is updated with the target
server time.
• Address tables, Selector tables, and domain tables are written to the physical
Xenta 280/300/401 LonWorks device.
• The physical Xenta 280/300/401 LonWorks device Neuron chip is set to
Configured Online.
• The physical Xenta 280/300/401 LonWorks device is restarted if the domain
table was updated.
• In certain cases the user may choose whether to download the application
image or not during the commissioning operation. See below.
There are two different conditions determining the setting for the download
application image option:
• Commission without application download: The application has not been
updated. If this is true the default selection is not to download the image.
• Commission with application download: The application has been updated, the
SNVT interface has been changed, or the image is new. If this is true, the
default selection is to download the image.
62.5.1 Xenta LonWorks Device Decommissioning
When you click Decommission you remove a Xenta 280/300/401 LonWorks
device from a LonWorks network.
For more information, see section 62.11 “Xenta LonWorks Device
Decommissioning” on page 2242.
62.5.2 Xenta Objects and Device Configuration
Parameters
You create and maintain Xenta objects in a Building Operation server (an Enterprise
Server or an Automation Server).
For more information, see section 64.1 “Xenta Objects and Device Configuration
Parameters” on page 2277.
Technical 04-16006-04-en, March 2015
2238
62 Xenta LonWorks Devices
62.6 Commissioning a Xenta Device
62.6 Commissioning a Xenta Device
You commission physical Xenta 280/300/401 LonWorks devices to make them
operational. The commission downloads the Menta application, gives the device a
subnet node address, and sets the device status to online. After a commission, the
device can communicate with other devices on the LonWorks network and execute
its application.
For more information, see section 64.1 “Xenta Objects and Device Configuration
Parameters” on page 2277.
To commission a Xenta device
1. In WorkStation, in the System Tree pane, select the device.
2. On the Actions menu, click Commission.
3. Select Application download to download the application program to the
device.
4. Under IO modules, type or retrieve the Neuron ID of the associated Xenta I/O
modules:
• Type the Neuron ID in the box.
• Click Service Pin and then press the service pin on the physical Xenta
I/O module to retrieve the Neuron ID.
5. Click Commission.
6. Click Close.
Tip
• The Xenta I/O Modules communication automatically begins
upon commissioning the Xenta 280/300/401 LonWorks device,
as long as the I/O module's Neuron ID was associated to the I/O
module prior to commissioning the Xenta 280/300/401
LonWorks device.
04-16006-04-en, March 2015 Technical
2239
62 Xenta LonWorks Devices
62.7 Xenta LonWorks Daylight Savings Time Switchover
62.7 Xenta LonWorks Daylight Savings Time
Switchover
The Building Operation server updates the upcoming Daylight Savings Time
switchovers (using DST data extracted from the server Time Zone settings) in the
physical Xenta 280/300/401 LonWorks devices in advance.
This is done by trying to send the switchover data to the Xenta 280/300/401
LonWorks devices.
• A first try is done 1 January 01.00.
• If it fails, a new try is done each week at the same time until the physical Xenta
DST is successfully updated.
• A property, DST Last update, on the Xenta 280/300/401 LonWorks device
object indicates the last time DST was successfully sent to the physical Xenta.
• If it indicates that the DST data was not successfully sent to the Xenta
280/300/401 LonWorks device the present year, and the remaining time to the
next DST switchover is less than 2 weeks, the Xenta device object tries to send
the DST data once again.
• If any sending of DST settings fails, the Xenta 280/300/401 LonWorks device is
indicated as out of sync.
The Daylight Saving Time is also set at the commissioning.
Technical 04-16006-04-en, March 2015
2240
62 Xenta LonWorks Devices
62.8 Xenta LonWorks Time Synchronization
62.8 Xenta LonWorks Time Synchronization
A Xenta device is time synchronized at the commissioning. After that, all Xenta
devices inherit their time zone settings (and DST rules where applicable) from the
Building Operation server to which they belong.
To achieve this the LonWorks network broadcasts time synchronization messages
to all Xentas beneath it with a period determined by a Xenta synchronization
interval.
Important
Make sure the following applies to the Building Operation server before the Xenta
device is commissioned:
• The correct time has been set.
• The time zone has been defined.
The Time synchronization interval is one of the properties under the Advanced tab in
the LonWorks Network object. The configurable Xenta broadcast period has a
default value of 10 minutes and allowed values between 10 minutes and one week.
04-16006-04-en, March 2015 Technical
2241
62 Xenta LonWorks Devices
62.9 Identifying a Xenta I/O Module
62.9 Identifying a Xenta I/O Module
You identify a Xenta I/O module to enable it to communicate with its associated
Xenta programmable device on the LonWorks Network.
To identify a Xenta I/O module
1. In WorkStation, in the System Tree pane, select the Xenta I/O module.
2. On the File menu, click Properties.
3. In the Neuron ID box, enter Neuron ID or click the Browse button to enable the
Service Pin procedure.
4. Click the Close button.
Note
The Xenta I/O module is automatically commissioned when you commission its
associated Xenta 280/300/401 LonWorks device.
Technical 04-16006-04-en, March 2015
2242
62 Xenta LonWorks Devices
62.10 Checking the Neuron ID of a Xenta I/O Device
62.10 Checking the Neuron ID of a Xenta I/O
Device
You check the Neuron ID of a Xenta I/O device to make sure that the device has
been identified by Building Operation.
To check the Neuron ID of a Xenta I/O device
1. In the System Tree pane, locate the IO folder belonging to the Xenta device.
2. In the List View, click on the specific I/O device.
3. On the Basic tab, in the Device information area, check that the Neuron
ID box shows a valid ID.
If the Neuron ID is 000000000000, the device needs to be commissioned. For more
information, see section 62.9 “Identifying a Xenta I/O Module” on page
2240.Commissioning a Xenta I/O Module
04-16006-04-en, March 2015 Technical
2243
62 Xenta LonWorks Devices
62.11 Xenta LonWorks Device Decommissioning
62.11 Xenta LonWorks Device
Decommissioning
When you click Decommission you remove a Xenta 280/300/401 LonWorks
device from a LonWorks network.
The following things are performed during the decommissioning:
• The domain table is set to Unused on the physical device, but not in the
database.
• The physical device is set to Unconfigured.
You can decommission a Xenta 280/300/401 LonWorks device in the network to
‘silence it’ temporarily.
Important
• Decommission a Xenta 280/300/401 LonWorks or LonWorks device before it
is removed from the network. Otherwise, the old network information may
cause problems if the device is used in another network.
Technical 04-16006-04-en, March 2015
2244
62 Xenta LonWorks Devices
62.12 Decommissioning a Xenta Device
62.12 Decommissioning a Xenta Device
In WorkStation, you remove a Xenta device from a LonWorks network and clear its
network configuration by a Decommission command.
For more information, see section 64.1 “Xenta Objects and Device Configuration
Parameters” on page 2277.
To decommission a Xenta device
1. In WorkStation, in the System Tree pane, select the Xenta device.
2. On the Actions menu, click Decommission.
04-16006-04-en, March 2015 Technical
2245
62 Xenta LonWorks Devices
62.13 Replacing an Online Xenta Device
62.13 Replacing an Online Xenta Device
You replace a physical Xenta 280/300/401 LonWorks device because of
malfunction issues, new requirements, or simply because of misplacement.
Important
Manually override essential equipment that is controlled by outputs of the device
or its I/O modules. Otherwise, this equipment will be turned on and off during the
application download.
Important
• Replace a device with a new device or a decommissioned device. Do not
install a commissioned device in a new network as the reused device might
contain an application or an address that can cause serious problems in the
new network.
To replace an online Xenta device
1. In WorkStation, in the System Tree pane, select the programmable Xenta
device that you want to replace.
Tip
• If the device configuration in the physical Xenta 280/300/401
LonWorks device is not synchronized with the configuration that
is stored in WorkStation, you can upload the device configuration
to WorkStation before you remove the Xenta 280/300/401
LonWorks device. For more information, see section 62.15
“Uploading the Xenta Device Configuration” on page 2247.
2. On the Actions menu, click Decommission.
3. Remove the old physical Xenta 280/300/401 LonWorks device.
4. Install the new physical Xenta 280/300/401 LonWorks device.
5. On the Actions menu, click Commission.
Continued on next page
Technical 04-16006-04-en, March 2015
2246
62 Xenta LonWorks Devices
62.13 Replacing an Online Xenta Device
6. In the Neuron ID box, type or retrieve the Neuron ID of the new Xenta
280/300/401 LonWorks device:
• Type the Neuron ID in the box.
• Click Service Pin and then press the service pin on the physical device
to retrieve the Neuron ID.
7. Select Application download.
8. Under IO modules, type or retrieve the Neuron ID of the associated Xenta
I/O modules:
• Type the Neuron ID in the box.
• Click Service Pin and then press the service pin on the physical Xenta
I/O module to retrieve the Neuron ID.
9. Click Commission.
10. Click Close.
Important
• Restore equipment that you manually overrode before you
replaced the device.
The Xenta 280/300/401 LonWorks device is replaced, the application is
downloaded, and the device is commissioned and activated.
04-16006-04-en, March 2015 Technical
2247
62 Xenta LonWorks Devices
62.14 Downloading the Xenta Device Configuration
62.14 Downloading the Xenta Device
Configuration
You download the device configuration from the server to update the configuration
parameters in the Xenta 280/300/401 LonWorks device.
Important
• Before downloading the device configuration from the server, carefully
consider the effects of overwriting the current device configuration in the
Xenta 280/300/401 LonWorks device.
For more information, see section 64.3 “Device Configuration Parameters” on page
2281.
To download the Xenta device configuration
1. In WorkStation, in the System Tree pane, select the Xenta 280/300/401
LonWorks device that you want to download the device configuration to.
2. On the Actions menu, click Download device configuration.
The configuration is downloaded to the Xenta 280/300/401 LonWorks device.
Technical 04-16006-04-en, March 2015
2248
62 Xenta LonWorks Devices
62.15 Uploading the Xenta Device Configuration
62.15 Uploading the Xenta Device
Configuration
You upload the device configuration from the Xenta 280/300/401 LonWorks
devices to update the configuration parameters in the server with local device
configuration changes, which have been made through, for example, an operator
panel.
Important
• Before uploading the device configuration from a device, carefully consider
the effects of overwriting the current device configuration in the server.
For more information, see section 64.3 “Device Configuration Parameters” on page
2281.
To upload the Xenta device configuration
1. In WorkStation, in the System Tree pane, select the Xenta 280/300/401
LonWorks device that you want to upload the device configuration from.
2. On the Actions menu, click Upload device configuration.
The device configuration is uploaded to the server.
04-16006-04-en, March 2015 Technical
2249
62 Xenta LonWorks Devices
62.16 Replacing an Offline Xenta Device
62.16 Replacing an Offline Xenta Device
You replace a physical Xenta 280/300/401 LonWorks device because of
malfunction issues, new requirements, or simply because of misplacement.
Important
• Replace a device with a new device or a decommissioned device. Do not
install a commissioned device in a new network as the reused device might
contain an application or an address that can cause serious problems in the
new network.
To replace an offline Xenta device
1. Remove the old physical Xenta 280/300/401 LonWorks device.
2. Install the new physical Xenta 280/300/401 LonWorks device.
3. On the Actions menu, click Commission.
4. In the Neuron ID box, type or retrieve the Neuron ID of the new Xenta
280/300/401 LonWorks device:
• Type the Neuron ID in the box.
• Click Service Pin and then press the service pin on the physical device
to retrieve the Neuron ID.
5. Select Application download.
6. Under IO modules, type or retrieve the Neuron ID of the associated Xenta
I/O modules:
• Type the Neuron ID in the box.
• Click Service Pin and then press the service pin on the physical Xenta
I/O module to retrieve the Neuron ID.
Continued on next page
Technical 04-16006-04-en, March 2015
2250
62 Xenta LonWorks Devices
62.16 Replacing an Offline Xenta Device
7. Click Commission.
8. Click Close.
The Xenta 280/300/401 LonWorks device is replaced, the application is
downloaded, and the device is commissioned and activated.
04-16006-04-en, March 2015 Technical
2251
62 Xenta LonWorks Devices
62.17 Replacing a Xenta I/O Module
62.17 Replacing a Xenta I/O Module
You replace a physical Xenta I/O module because of malfunction issues, new
requirements, or simply because of misplacement.
Important
• Manually override essential equipment that is controlled by outputs on I/O
modules. Otherwise, this equipment will be turned on and off during the
application download.
To replace a Xenta I/O module
1. Remove the old physical Xenta I/O module.
2. Install the new physical Xenta I/O module.
3. In the System Tree pane, select the programmable Xenta device to which
the Xenta I/O module belongs.
4. On the Actions menu, click Commission.
5. Verify the identity of the Xenta 280/300/401 LonWorks device by checking the
Neuron ID.
6. Select Application download.
Important
• Do not forget to select Application download before you
commission the device, otherwise the application will not be
downloaded properly.
Continued on next page
Technical 04-16006-04-en, March 2015
2252
62 Xenta LonWorks Devices
62.17 Replacing a Xenta I/O Module
7. Under IO modules, type or retrieve the Neuron ID of the new Xenta I/O
module:
• Type the Neuron ID in the box.
• Click Service Pin and then press the service pin on the physical Xenta
I/O module to retrieve the Neuron ID.
8. Click Commission.
9. Click Close.
Important
• Restore equipment that you manually overrode before you
replaced the device.
The green LED on the new I/O module flashes at a normal, low frequency rate. The
Out of sync icon is removed from the Xenta device in the System Tree pane.
04-16006-04-en, March 2015 Technical
2253
62 Xenta LonWorks Devices
62.18 Xenta LonWorks Groups
62.18 Xenta LonWorks Groups
The Xenta Group is a logical group that is used to build a simple hierarchy of the
Xenta 280/300/401 LonWorks devices. In Building Operation, each Xenta Group is
collected in a separate folder.
The use of Xenta Groups has two main purposes:
• To keep the Building Operation server updated, in an efficient way, on which
devices are online.
• To introduce a hierarchy in large networks, making the information in the
System Tree pane and operator panel easier to find and use.
The Building Operation server must be kept up-to-date on which devices are online
on the LonWorks network. To avoid having each device communicate with the
Building Operation server about this status, the group master periodically collects
online status for all members of the group and sends it to the server. Devices that
send a periodic heartbeat to the group master are considered online.
If the group master goes offline, the group members are pinged from the Building
Operation server to determine each member's online status.
62.18.1 XentaGroups and Group Indications
To handle the special requirements of Xenta Groups, Building Operation creates a
separate object called “XentaGroups” in the System Tree pane as soon as the first
Xenta 280/300/401 LonWorks device object is created.
Under the XentaGroups object, the automatically created Xenta groups are saved.
Each created group gets the same name as the folder in which the Xenta object
was created. In this way, wise usage of folders in the System Tree pane will reflect
the natural grouping of the Xenta devices. However, a Xenta that has been
assigned to a group remains a member of that group, even when moved to another
folder.
If a Xenta 280/300/401 LonWorks device is created directly under the LonWorks
Network, a group with the LonWorks Network name is created for this Xenta
280/300/401 LonWorks device.
62.18.2 Xenta Group Master
The Xenta group master is a Xenta 280/300/401 LonWorks device (in the Xenta
Group) that monitors the online and offline status of the group members. In Building
Operation, the first device in a group is automatically appointed group master for
the online/offline information exchange in Building Operation. The group master
forwards the online and offline information to the Building Operation server.
However, the online status of the group master is monitored with a ping
mechanism, like other LonWorks devices.
To let each member (including the group master) know who the other members of
the group are, the current group list must be downloaded to each device. This is
included in the so called blueprint for each device. For more information, see
section 64.4 “Synchronization of the Xenta LonWorks Device ” on page 2282.
Alarms and other information are always sent independently and directly to the
Building Operation server by each Xenta 280/300/401 LonWorks device.
Technical 04-16006-04-en, March 2015
2254
62 Xenta LonWorks Devices
62.19 Xenta LonWorks Device Functions
62.19 Xenta LonWorks Device Functions
Many of the functions and features of Xenta LonWorks devices are supported in
Building Operation, including trend logs, alarms, schedules, time functions, and the
ability to view Xenta variables from a Menta application.
62.19.1 Trend Logs for Xenta LonWorks Devices
Trend logs for Xenta 280/300/401 LonWorks devices are created in Menta Editor.
You then upload these trend logs to Building Operation. You can only log public
signals from within the same Xenta device.
For more information, see section 62.20 “Trend Logs for Xenta LonWorks Devices”
on page 2255.
62.19.2 Alarms for Xenta LonWorks Devices
Alarms for Xenta 280/300/401 LonWorks devices are created in Menta Editor. You
can view the Alarms in WorkStation.
For more information, see section 62.22 “Alarms for Xenta LonWorks Devices” on
page 2257.
62.19.3 Schedules for Xenta LonWorks Devices
Xenta 280/300/401 LonWorks device schedules are different from other Building
Operation schedules. The differences originate from legacy software
considerations. Xenta 280/300/401 LonWorks device schedules are created in the
TSCH block in Menta Editor and can be edited from the Xenta Schedule editor in
WorkStation.
For more information, see section 62.23 “Schedules for Xenta LonWorks Devices”
on page 2258.
62.19.4 Time Functions for Xenta LonWorks Devices
Time functions perform time-related operations in Xenta LonWorks Devices. They
include time synchronization between the Xenta LonWorks device and the server,
as well as the switchover for Daylight Savings Time.
For more information, see section 62.24 “Time Functions for Xenta LonWorks
Devices” on page 2260.
62.19.5 Xenta LonWorks Variables Display
In Building Operation, you can view Xenta variables from a Menta application in
several different ways (normal graphics not included).
04-16006-04-en, March 2015 Technical
2255
62 Xenta LonWorks Devices
62.19 Xenta LonWorks Device Functions
For more information, see section 62.25 “Xenta LonWorks Variables Display” on
page 2261.
Technical 04-16006-04-en, March 2015
2256
62 Xenta LonWorks Devices
62.20 Trend Logs for Xenta LonWorks Devices
62.20 Trend Logs for Xenta LonWorks Devices
Trend logs for Xenta 280/300/401 LonWorks devices are created in Menta Editor.
You then upload these trend logs to Building Operation. You can only log public
signals from within the same Xenta device.
Tip
When using Xenta 300/400, create a number of unused logs in Menta Editor.
These can then be configured in WorkStation if logging becomes necessary at a
later date.
There are two types of trend logs in the Xenta 280/300/401 LonWorks devices:
• Circular trend logs: new values overwrite old values when the buffer in the
Xenta 280/300/401 LonWorks device is filled.
• Non-circular trend logs: the logging stops when the buffer in the Xenta
280/300/401 LonWorks device has been filled.
The buffer size of the Xenta 280/300/401 LonWorks devices is limited by the
amount of memory in the device. To store more data, and on a higher level, you can
connect the Xenta trend log to an extended trend log in the server. At configurable
intervals, or according to a smart log algorithm, data are uploaded from the trend
log in the Xenta to the much bigger extended trend log in the server. In the
extended trend log the log data is available for backup, restore, and general data
treatment. For more information, see the Extended Trend Logs topic on WebHelp..
You edit the trend log parameters in WorkStation. For more information, see section
62.21 “Configuring a Xenta Trend Log” on page 2256.
04-16006-04-en, March 2015 Technical
2257
62 Xenta LonWorks Devices
62.21 Configuring a Xenta Trend Log
62.21 Configuring a Xenta Trend Log
You configure a Xenta trend log by editing its properties.
For more information, see section 62.20 “Trend Logs for Xenta LonWorks Devices”
on page 2255.
To configure a Xenta trend log
1. In WorkStation, in the System Tree pane, select the Xenta trend log that you
want to configure.
2. On the File menu, click Properties.
3. Edit the properties:
Component Description
Logged Signal Enter the name of a public signal in the
Xenta device in which the trend log
resides.
Log Interval Enter the time interval between the log
readings.
Log Space Enter the total time that you want log
readings for. The number of values will be
Log Space/Log Interval.
Circular Log Click True to select circular log.
Activate Select type of activation: Manual - Off,
Manual - On, or Automatic.
Start Time Type the date and time for the log to start.
Start Variable If you have set Activate to Automatic:
Enter the name of a public signal in the
Xenta device which will start the log
No stop if logically activated Select True to inhibit the stopping of a
log activated by a logical variable when
the variable is no longer true. The logging
continues until stopped manually, or the
log is full when the non-circular log option
is selected.
Clear log at start Select True to make sure the log buffer is
cleared at start.
4. Click OK.
Technical 04-16006-04-en, March 2015
2258
62 Xenta LonWorks Devices
62.22 Alarms for Xenta LonWorks Devices
62.22 Alarms for Xenta LonWorks Devices
Alarms for Xenta 280/300/401 LonWorks devices are created in Menta Editor. You
can view the Alarms in WorkStation.
Alarms for Xenta LonWorks devices are handled as Building Operation alarms, with
a few exceptions:
• Application alarms created in Menta Editor, using the Alarm Block and optional
Alarm Text table
• System alarms, which are mainly messages created by the system
• Offline alarms, which are alarms that concern the loss of communication with
one or several Xenta 280/300/401 LonWorks devices
62.22.1 Xenta LonWorks System Alarms
The Xenta non-application alarms are shown as system alarms in the Building
Operation Alarms pane.
For more information, see section 65.3 “Xenta LonWorks System Alarms” on page
2292.
62.22.2 Xenta LonWorks Offline Alarms
The Xenta offline alarms relate to these two cases:
• A Xenta group member goes offline
• A Xenta group master goes offline
In both cases the Xenta 280/300/401 LonWorks devices can be monitored by the
server to detect if one or more devices go offline.
For more information, see section 65.4 “Xenta LonWorks Offline Alarms” on page
2293.
04-16006-04-en, March 2015 Technical
2259
62 Xenta LonWorks Devices
62.23 Schedules for Xenta LonWorks Devices
62.23 Schedules for Xenta LonWorks Devices
Xenta 280/300/401 LonWorks device schedules are different from other Building
Operation schedules. The differences originate from legacy software
considerations. Xenta 280/300/401 LonWorks device schedules are created in the
TSCH block in Menta Editor and can be edited from the Xenta Schedule editor in
WorkStation.
For more information, see section 63.2 “Building Operation Menta Editor” on page
2270.
The main differences between Xenta Schedule Editor and Building Operation
Schedule Editor are summed up as follows:
• There are no priority levels for Xenta schedules.
• The number of scheduled events, weekly and exception, are set in the Menta
Editor and determine the number of possible separate events for a specific
Xenta 280/300/401 LonWorks device.
• On all day in a weekly event is selected from a drop-down menu in Xenta
Schedule Editor or can be entered as a time range. In the Building Operation
Schedule Editor, you select on/off from a drop-down menu (24:00 not being
allowed).
• Only one start-end time pair is possible for each event.
• For exception events, only Date range is available. Date, Calculated, or
Calendar events are not available.
• On (or off) all day in an exception event is selected from a drop-down menu in
Xenta Schedule Editor.
• In Xenta 280/300/401 LonWorks devices, an exception event overrides any
weekly events for the whole of that day, not only for the limited time defined by
the exception event.
• In Menta applications, the Xenta exception events can use specific days of the
week, Monday to Sunday. As selected, the indicated days of the week
determine valid days of events within the date range. Weekly events are
defined by the days of the week; in this case the days of the week are
displayed in the schedule editor, but cannot be changed.
• If an event has a start time later than the end time, this is treated as one
overnight event.
Note
You can copy and paste a Xenta 280/300/401 LonWorks device schedule.
However, any Xenta Central schedule reference will not be copied.
62.23.1 Number of Scheduled Events for Xenta
LonWorks Devices
The number of scheduled events for a Xenta 280/300/401 LonWorks device
application is set in the Time Schedule window, which is opened when you click
Edit in the Edit block TSCH window. For more information, see section 66.1
“Number of Scheduled Events for Xenta LonWorks Devices” on page 2297.
Technical 04-16006-04-en, March 2015
2260
62 Xenta LonWorks Devices
62.23 Schedules for Xenta LonWorks Devices
62.23.2 All-day Events for Xenta LonWorks Devices
All-day events have the same meaning, but are indicated differently in Menta Editor
and the schedule editor. For more information, see section 66.2 “All-Day Events for
Xenta LonWorks Devices” on page 2298.
62.23.3 Exception Events for Xenta LonWorks Devices
Exception events in Xenta 280/300/401 LonWorks device applications can only be
defined as a range of dates. For more information, see section 66.4 “Exception
Events for Xenta LonWorks Devices” on page 2300.
62.23.4 Weekly Events for Xenta LonWorks Devices
Weekly events in a Xenta 280/300/401 LonWorks device are specified with the
days of the week. For more information, see section 66.3 “Weekly Events for Xenta
LonWorks Devices” on page 2299.
62.23.5 Overnight Events for Xenta LonWorks Devices
Once an event has been defined, the selected days of the week are shown in the
schedule editor, but cannot be changed. The end time is interpreted as occurring
on the following day.
Overnight events are counted as single events, when the schedule editor calculates
the total number of events. This applies to both weekly and exception events.
62.23.6 Xenta Central Schedules
Xenta Central schedules are used to group Xenta 280/300/401 LonWorks device
schedules created in the TSCH block in Menta Editor. When you use a Central
schedule, you can change settings on whole Xenta schedule groups from a central
place.
For more information, see section 66.7 “Xenta Central Schedules” on page 2303.
04-16006-04-en, March 2015 Technical
2261
62 Xenta LonWorks Devices
62.24 Time Functions for Xenta LonWorks Devices
62.24 Time Functions for Xenta LonWorks
Devices
Time functions perform time-related operations in Xenta LonWorks Devices. They
include time synchronization between the Xenta LonWorks device and the server,
as well as the switchover for Daylight Savings Time.
62.24.1 Xenta LonWorks Time Synchronization
A Xenta device is time synchronized at the commissioning. After that, all Xenta
devices inherit their time zone settings (and DST rules where applicable) from the
Building Operation server to which they belong.
For more information, see section 62.8 “Xenta LonWorks Time Synchronization” on
page 2239.
62.24.2 Xenta LonWorks Daylight Savings Time
Switchover
The Building Operation server updates the upcoming Daylight Savings Time
switchovers (using DST data extracted from the server Time Zone settings) in the
physical Xenta 280/300/401 LonWorks devices in advance.
For more information, see section 62.7 “Xenta LonWorks Daylight Savings Time
Switchover” on page 2238.
Technical 04-16006-04-en, March 2015
2262
62 Xenta LonWorks Devices
62.25 Xenta LonWorks Variables Display
62.25 Xenta LonWorks Variables Display
In Building Operation, you can view Xenta variables from a Menta application in
several different ways (normal graphics not included).
Table: Xenta Variables View and the Value Updates
View Value Update
Properties view
Refresh button
Variables view Automatic
Watch pane Automatic
Depending on the status of the device, these values represent online or offline
values. For more information, see the Window Menu topic on WebHelp.
In Menta, values can be defined as read/write values or read-only values. If a value
is defined as a read/write value, you can enter a new manual value in the Properties
dialog box. In order to avoid overwrite of new online values from inputs/outputs, you
click Force value before you enter a manual value. For more information, see the
Forced Values topic on WebHelp..
Figure: Entering a manual value in ‘Forced’ mode
04-16006-04-en, March 2015 Technical
2263
62 Xenta LonWorks Devices
62.25 Xenta LonWorks Variables Display
The forced value is accepted only when the device is online, or goes online after it
has been offline.
62.25.1 Device: Online
An online value is displayed without any additional indication.
Figure: Properties dialog box, online value
Technical 04-16006-04-en, March 2015
2264
62 Xenta LonWorks Devices
62.25 Xenta LonWorks Variables Display
Figure: Variables view, online value
The selected variable (M3_U7) as one of three in the Watch pane. For more
information, see the Watch Pane topic on WebHelp.
Figure: Watch pane, online value
62.25.2 Device: Offline
An offline value is displayed with an offline indication (except in the Properties
dialog box).
04-16006-04-en, March 2015 Technical
2265
62 Xenta LonWorks Devices
62.25 Xenta LonWorks Variables Display
Figure: Properties dialog box, offline value
Figure: Variables view, offline value
The selected variable (M3_U7) as one of three in the Watch pane:
Technical 04-16006-04-en, March 2015
2266
62 Xenta LonWorks Devices
62.25 Xenta LonWorks Variables Display
Figure: Watch pane, offline value
04-16006-04-en, March 2015 Technical
2267
62 Xenta LonWorks Devices
62.26 Xenta LonWorks Device Restart
62.26 Xenta LonWorks Device Restart
When you cold start or warm start a Xenta 280/300/401 LonWorks device, the
device is not indicated as offline and no alarm is generated.
Table: Xenta Restart Modes
Mode Description
Warm start A warm start restarts the device without
clearing the RAM memory.
Cold start A cold start restarts the device and clears
the RAM memory.
For an explanation of warm start or cold start, refer to Xenta documentation.
appendix A of TAC Xenta 280/300/401, Product Manual (04-00067)
Technical 04-16006-04-en, March 2015
2268
63 Xenta LonWorks Applications
Topics
Xenta LonWorks Applications
Building Operation Menta Editor
Editing a Menta Application
Importing a Menta Application to a Xenta Device
63 Xenta LonWorks Applications
63.1 Xenta LonWorks Applications
63.1 Xenta LonWorks Applications
The application in a Xenta LonWorks device contains the control logic used in the
device. Xenta LonWorks applications appear below the device object in the
System Tree pane and are edited in Menta Editor to configure the device to
different control and monitoring tasks.
63.1.1 Building Operation Menta Editor
You use Menta Editor to create programs that you download to the Xenta
280/300/401 LonWorks device where these programs execute.
For more information, see section 63.2 “Building Operation Menta Editor” on page
2270.
63.1.2 Xenta LonWorks Application Alarms
Xenta application alarms have a few limitations compared to the ordinary Building
Operation alarms.
For more information, see section 65.1 “Xenta LonWorks Application Alarms” on
page 2289.
63.1.3 Synchronization of the Xenta LonWorks Device
A Xenta 280/300/401 LonWorks device is out of sync when it is not fully updated on
its object parts: its network surroundings, its device configuration, or its application.
For more information, see section 64.4 “Synchronization of the Xenta LonWorks
Device ” on page 2282.
04-16006-04-en, March 2015 Technical
2271
63 Xenta LonWorks Applications
63.2 Building Operation Menta Editor
63.2 Building Operation Menta Editor
You use Menta Editor to create programs that you download to the Xenta
280/300/401 LonWorks device where these programs execute.
The Menta Editor programming language is a graphical programming tool slightly
modified from the corresponding tool in the TAC Vista system.
TAC Menta Technical Manual (04-00030)
Example Program
This example Menta program includes a simple fan control program that turns a fan
on or off based upon a time schedule and occupancy.
Figure: An example Menta program for a Xenta device
Technical 04-16006-04-en, March 2015
2272
63 Xenta LonWorks Applications
63.3 Editing a Menta Application
63.3 Editing a Menta Application
You edit a Menta application to change the control logic for a Xenta 280/300/401
LonWorks device.
For more information, see section 63.2 “Building Operation Menta Editor” on page
2270.
To edit a Menta application
1. In WorkStation, in the System Tree pane, select the device that you want to
edit the Menta application for.
2. On the Actions menu, click Edit.
3. In Menta Editor, edit the application.
4. On the File menu, click Save.
Tip
• In Menta Editor, on the Options menu, click Simulate if you
want to validate the program and identify the location of errors in
the program.
Tip
• In simulation mode, on the Commands menu, click Generate
if you want to make sure that it is possible to generate the output
files, for example, binary files, OP menu tree files, and .XIF file, for
the program.
04-16006-04-en, March 2015 Technical
2273
63 Xenta LonWorks Applications
63.4 Importing a Menta Application to a Xenta Device
63.4 Importing a Menta Application to a
Xenta Device
You import an application file to the Xenta 280/300/401 LonWorks device so the
device is programmed with control logic.
For more information, see section 63.2 “Building Operation Menta Editor” on page
2270.
To import a Menta application to a Xenta device
1. In WorkStation, in the System Tree pane, select the device that you want to
import the application file to.
2. On the Actions menu, click Edit.
3. In Menta Editor, on the File menu, click Import.
4. Select the .MTA or .AUT file to be used as the application for the selected
device.
5. On the Options menu, click Device Specification.
6. In the Type box, select the Xenta device type that the application is designed
for.
7. In the System Version box, select blank so that no system version is
defined.
8. In the Hardware Version box, leave the default setting as is.
9. Select Add new network variables (SNVT) last in the XIF file.
Continued on next page
Technical 04-16006-04-en, March 2015
2274
63 Xenta LonWorks Applications
63.4 Importing a Menta Application to a Xenta Device
10. Add the required Xenta IO modules for this application.
11. Click OK.
12. On the File menu, click Save.
Tip
• In Menta Editor, on the Options menu, click Simulate if you
want to validate the program and identify the location of errors in
the program.
Tip
• In simulation mode, on the Commands menu, click Generate
if you want to make sure that it is possible to generate the output
files, for example, binary files, OP menu tree files, and .XIF file, for
the program.
04-16006-04-en, March 2015 Technical
2275
64 Xenta LonWorks Objects
Topics
Xenta Objects and Device Configuration Parameters
Xenta Object Parts
Device Configuration Parameters
Synchronization of the Xenta LonWorks Device
64 Xenta LonWorks Objects
64.1 Xenta Objects and Device Configuration Parameters
64.1 Xenta Objects and Device Configuration
Parameters
You create and maintain Xenta objects in a Building Operation server (an Enterprise
Server or an Automation Server).
A Xenta object consists of the following descriptive parts:
• Building Operation object description
• Network information: Bindings and subnet/node addresses
• Device application
• Device configuration
When the objects are created offline, you have to arrange for these parts to be
downloaded to the Xenta 280/300/401 LonWorks device itself when the system is
commissioned.
On the other hand, if some parameters in the device configuration have been fine-
tuned online in the device, these parameters should be uploaded back to the server
database for backup and maintenance purposes. In this way, you synchronize the
database for the Xenta object(s) and the device(s).
To copy all or some of these parts in one or the other direction, you use the
following commands:
• Commission with optional Download Application
• Upload/Download Device Configuration
The following graphic shows the Xenta object and some of the commands that you
can use. Device Config set A consists of semi-static configuration values, such as
setpoint values. Set B consists of dynamic or accumulated values, such as energy
meter values.
04-16006-04-en, March 2015 Technical
2279
64 Xenta LonWorks Objects
64.1 Xenta Objects and Device Configuration Parameters
Figure: The Xenta object and some of its associated commands
As the same information can reside in two or three different places at the same
time, the commands also help to keep the data synchronized. For more
information, see section 64.4 “Synchronization of the Xenta LonWorks Device ” on
page 2282.
64.1.1 Xenta Object Parts
When you create a Xenta object, the required descriptive parts are automatically
included. The parts include information that is necessary to administrate and
address the Xenta 280/300/401 LonWorks device; they also include the current
application and the parameters that belong to the application.
For more information, see section 64.2 “Xenta Object Parts” on page 2280.
64.1.2 Device Configuration Parameters
The device configuration parameters contain several types of parameters. The
parameters can be regarded as two separate sets, A and B, when information is
copied during the upload, download, and device application update procedures.
For more information, see section 64.3 “Device Configuration Parameters” on page
2281.
Technical 04-16006-04-en, March 2015
2280
64 Xenta LonWorks Objects
64.1 Xenta Objects and Device Configuration Parameters
64.1.3 Xenta LonWorks Database Mode
It is possible to set all Xenta 280/300/401 devices in database mode by one
Database Mode command.
For more information, see the Xenta LonWorks Database Mode topic on WebHelp.
04-16006-04-en, March 2015 Technical
2281
64 Xenta LonWorks Objects
64.2 Xenta Object Parts
64.2 Xenta Object Parts
When you create a Xenta object, the required descriptive parts are automatically
included. The parts include information that is necessary to administrate and
address the Xenta 280/300/401 LonWorks device; they also include the current
application and the parameters that belong to the application.
Object Description
The object description contains information on how to handle the Xenta object in
the System Tree pane. The object description is not used in the Xenta 280/300/401
LonWorks device, and so cannot be downloaded to the device.
Bindings and Subnet/Node Addresses
When the Xenta is used in a LonWorks network, the Xenta 280/300/401 LonWorks
device must have a network address. The use of SNVTs requires certain
information. This kind of data is collected in the Bindings, Subnet/node area. For
more information, see section 64.1 “Xenta Objects and Device Configuration
Parameters” on page 2277.
You can download the information to the Xenta 280/300/401 LonWorks device with
the Commission command. For more information, see section 64.4
“Synchronization of the Xenta LonWorks Device ” on page 2282.
Device Application
The actual function of the Xenta 280/300/401 LonWorks device is defined in a
Menta program. This program, together with some auxiliary files, is stored in the
device application. If you update the function in any of the servers, you have to
download the application to the Xenta 280/300/401 LonWorks device itself. For
more information, see section 64.4 “Synchronization of the Xenta LonWorks
Device ” on page 2282.
You download the information to the Xenta 280/300/401 LonWorks device by
selecting Download Application together with the Commission command.
Device Configuration
The parameters that define the behavior of the current Xenta application are
collected in the device configuration. During operation of the system, when some
experience is gained, some of these parameters may require adjustment. In most
cases you fine-tune the parameters in the device, using a Xenta Operator Panel. For
backup purposes, you should upload the parameters to the server database.
The device configuration parameters are of two kinds, which in some cases are
treated separately (set A and set B). For more information, see section 64.3 “Device
Configuration Parameters” on page 2281..
You can download the information to the Xenta 280/300/401 LonWorks device with
the Download Device Configuration command.
You can upload the device configuration from the Xenta 280/300/401 LonWorks
device to the server with the Upload Device Configuration command.
Technical 04-16006-04-en, March 2015
2282
64 Xenta LonWorks Objects
64.3 Device Configuration Parameters
64.3 Device Configuration Parameters
The device configuration parameters contain several types of parameters. The
parameters can be regarded as two separate sets, A and B, when information is
copied during the upload, download, and device application update procedures.
Set A: Semi-static configuration values, such as the set value.
• PVB, PVI, PVR block values
• Public constants
• Time schedule configuration
• Xenta alarm priority
• Trend log definition
The Trend log definitions include the following parameters:
• Logged signal
• Log interval
• Log space
• Log type (Circular or Non-circular)
• Activate
• Start time
• Start variable
• No stop if logically activated
• Clear log at start
Set B: Dynamic or accumulated values, such as energy meter values
• Public output values (with no input in Menta Editor) of ACCUM, INTEG, RT,
NCYC, FILT, RAMP, SHR, SHI, SHB, and RT blocks
04-16006-04-en, March 2015 Technical
2283
64 Xenta LonWorks Objects
64.4 Synchronization of the Xenta LonWorks Device
64.4 Synchronization of the Xenta LonWorks
Device
A Xenta 280/300/401 LonWorks device is out of sync when it is not fully updated on
its object parts: its network surroundings, its device configuration, or its application.
For more information, see section 156.1 “Xenta Device Out of Sync” on page 5579.
Depending on the case, the following is done to bring the Xenta 280/300/401
LonWorks device into sync.
64.4.1 Synchronization of the Application and the
Device Configuration Parameters
When a Xenta 280/300/401 LonWorks device has been commissioned, fine-tuned,
and perhaps stored a number of data, a careless download of the original device
configuration and/or application may overwrite some important pieces of
information.
Instead, you should update the original configuration and/or application with the
current values, which will then be used at the next download. For more information,
see section 64.1 “Xenta Objects and Device Configuration Parameters” on page
2277.
You update the device configuration parameters correctly by following these
general steps:
Table: Updating the Device Configuration Parameters
Step number Action
Upload the device configuration parameters
from the Xenta 280/300/401 LonWorks
device to the server.
Edit/Save the Menta application program in
the server.
Commission and download the application
file from the server to the Xenta 280/300/401
LonWorks device.
Download the device configuration
parameters from the server to the Xenta
280/300/401 LonWorks device. (Optional,
as these values are normally already there.)
The different synchronization steps can be summarized in an illustration:
Technical 04-16006-04-en, March 2015
2284
64 Xenta LonWorks Objects
64.4 Synchronization of the Xenta LonWorks Device
Figure: Using the current configuration parameters when editing the application file
The following device configuration parameters (Set A and B. For more information,
see section 64.3 “Device Configuration Parameters” on page 2281.) are involved in
the different steps, as shown above:
Table: Parameters Involved at Synchronization
Synchronization step Set A Set B
1 Upload Device Config Yes Yes
parameters
2a Edit the Menta application Yes -
2b Save the Menta Yes -
application
3 Commission and Yes Reset to their Initial values in
Download Application the physical device after a
Download Application.
4 Download Device Config Yes Yes
parameters
04-16006-04-en, March 2015 Technical
2285
64 Xenta LonWorks Objects
64.4 Synchronization of the Xenta LonWorks Device
Synchronization step Set A Set B
64.4.2 Synchronization of the Network Information
If the application has been changed so that NVs or SNVTs have been added or
removed, or if the network configuration has been changed, the Xenta 280/300/401
LonWorks device must be brought into sync.
In these cases it is the Bindings, Subnet/node part of the Xenta that must be
updated with a Commission (with optional download application) command.
The following items are involved:
• The Daylight Saving Time settings are transferred
• The Xenta 280/300/401 LonWorks device clock is updated with the target
server time
• Bindings and Address tables are written to the Xenta 280/300/401 LonWorks
device
• The physical Xenta 280/300/401 LonWorks device Neuron chip is set to
Configured Online
• The physical Xenta 280/300/401 LonWorks device is automatically restarted if
the domain table was updated
At the commissioning an application download is often mandatory, but in some
cases you can specify if you want it to be included with the commissioning. In the
latter case the Download Application box is made selectable; otherwise it is
dimmed and preselected.
Technical 04-16006-04-en, March 2015
2286
64 Xenta LonWorks Objects
64.4 Synchronization of the Xenta LonWorks Device
Figure: The Commission command after a change of the network configuration only, with
optional download of application
04-16006-04-en, March 2015 Technical
2287
65 Xenta LonWorks Alarms
Topics
Xenta LonWorks Application Alarms
Modifying a Menta Application Alarm Priority
Xenta LonWorks System Alarms
Xenta LonWorks Offline Alarms
Modifying the Xenta Offline Detection Parameters
65 Xenta LonWorks Alarms
65.1 Xenta LonWorks Application Alarms
65.1 Xenta LonWorks Application Alarms
Xenta application alarms have a few limitations compared to the ordinary Building
Operation alarms.
65.1.1 Alarm Priority Conversion
In Menta Editor, the alarm priority for Xenta alarms has a range of only 0–9, whereas
Building Operation uses the greater range 0–999. So, when the alarms of the Xenta
application are used in the server for presentation they are converted, the first time
only, according to this table:
Table: Alarm Priority Conversion
Menta Application Priority Building Operation Default Priority
0 0
1 100
2 200
3 300
4 400
5 500
6 600
7 700
8 800
9 900
You can then modify the Building Operation alarm priority as required for each
Xenta 280/300/401 LonWorks device, as for any other alarm. The modified value is
not overwritten. You can also modify the Menta Editor alarm priority for Xenta
alarms. For more information, see section 65.2 “Modifying a Menta Application
Alarm Priority” on page 2291.
65.1.2 Alarm Texts in Menta Editor
In Menta Editor, alarm texts are defined both for display in the server and on the
Xenta OP operator panel. You can see and edit all the different texts in the Menta
Editor alarm text table.
You can also edit the alarm texts for display on the server in the Building Operation
alarm properties. The OP text, however, cannot be edited in this way.
04-16006-04-en, March 2015 Technical
2291
65 Xenta LonWorks Alarms
65.1 Xenta LonWorks Application Alarms
65.1.3 Alarm Application Considerations
Unpredictable results may occur if the Menta application is changed and saved in
the Building Operation database, but not downloaded to the corresponding Xenta
280/300/401 LonWorks device.
For example, if an alarm block is removed in the Menta application, this alarm will
also disappear from the Alarms pane in WorkStation. Without downloading to the
Xenta 280/300/401 LonWorks device, however, the Xenta may still indicate an
alarm that cannot be viewed or acknowledged. If this happens you will receive an
"unhandled application alarm" message in the error log.
Important
If you make changes to a Menta application and save it in the Building Operation
database, remember to also download the application to the Xenta 280/300/401
LonWorks device.
However, as a reminder the Xenta 280/300/401 LonWorks device is indicated as
unsynced. For more information, see section 67.1 “Xenta Icons” on page 2331.
65.1.4 Xenta OP Acknowledge
Xenta application alarms can be acknowledged from the Xenta OP operator panel.
The acknowledge text on the OP is defined in the Menta Editor alarm text table, but
cannot be modified in the Building Operation alarm properties.
Technical 04-16006-04-en, March 2015
2292
65 Xenta LonWorks Alarms
65.2 Modifying a Menta Application Alarm Priority
65.2 Modifying a Menta Application Alarm
Priority
You modify an application alarm priority for a Xenta device. The original alarm
priority comes from the previously designed Menta application.
To modify a Menta application alarm priority
1. In WorkStation, in the System Tree pane, select the application for which
you want to modify the alarm priority.
2. Click the List View tab.
3. Select the Alarm for which you want to modify the priority.
4. On the File menu, point to Open.
5. Click the Xenta tab.
6. In the Priority box, type the new alarm priority, 0–9.
7. On the File menu, click Save.
The Menta application is updated with the new priority value the next time you open
the application.
04-16006-04-en, March 2015 Technical
2293
65 Xenta LonWorks Alarms
65.3 Xenta LonWorks System Alarms
65.3 Xenta LonWorks System Alarms
The Xenta non-application alarms are shown as system alarms in the Building
Operation Alarms pane.
This is applicable for alarms with the following system alarm IDs:
• System cold start
• System warm start
• New application program
• Parser failed
• Unit is locked
• Unit is unlocked
• Started logging
• Stopped logging
• Log stopped because it is full
• Log full
• Not enough RAM memory for log
• Too many log definitions
• Error in log definition
• Not enough flash memory for log
• Log variable error
• No valid BPF
You can modify the Xenta system alarm priority. The default is 90. The priority
applies to all Xenta system alarms from Xenta 280/300/401 LonWorks devices on
the network.
Technical 04-16006-04-en, March 2015
2294
65 Xenta LonWorks Alarms
65.4 Xenta LonWorks Offline Alarms
65.4 Xenta LonWorks Offline Alarms
The Xenta offline alarms relate to these two cases:
• A Xenta group member goes offline
• A Xenta group master goes offline
In both cases the Xenta 280/300/401 LonWorks devices can be monitored by the
server to detect if one or more devices go offline.
65.4.1 Independent Offline Detection
Independent offline detection is the detection of a Xenta LonWorks device's online
status directly by the Building Operation server, independent of involvement from
the group master.
As long as the group master is online, independent offline detection applies to the
group master only. If the group master goes offline, all the other members of the
group are then monitored directly by the server, using independent offline detection.
When a Xenta 280/300/401 LonWorks device is offline, all Xenta alarm commands
are disabled.
The three parameters related to independent offline detection can be set from the
Properties tab of each Xenta 280/300/401 LonWorks device in the group. These
parameters enable or disable offline monitoring, set the priority of an offline alarm,
and set the maximum delay time for the alarm.
65.4.2 Group Master Guided Offline Detection
As long as the group master of a Xenta group is online it reports the online/offline
status of all other members of the group.
The two parameters related to group master guided offline detection can be set
from the Properties tab of each Xenta 280/300/401 LonWorks device in the
group. These parameters enable or disable offline monitoring and set the priority of
an offline alarm. The alarm's maximum delay time cannot be set when using group
master guided offline detection.
Although the time needed for an offline alarm varies greatly with the different Xenta
280/300/401 LonWorks device models, when group master guided offline
detection is used it takes a maximum of 3 minutes and 45 seconds from the time
when the connection is disabled until a Xenta offline alarm is received in
WorkStation.
The resetting of the offline alarm takes a maximum of 90 seconds from the time
when the connection is restored.
04-16006-04-en, March 2015 Technical
2295
65 Xenta LonWorks Alarms
65.5 Modifying the Xenta Offline Detection Parameters
65.5 Modifying the Xenta Offline Detection
Parameters
You modify the offline detection parameters for a Xenta device to enable or disable
the offline alarm, change the delay time for the offline alarm, or change the priority
level of the offline alarm. Offline detection is handled differently depending on
whether the Xenta is a group master or a group member.
For more information, see section 65.4 “Xenta LonWorks Offline Alarms” on page
2293.
To modify the Xenta offline detection parameters
1. In WorkStation, in the System Tree pane, select the Xenta device for which
you want to modify the offline detection parameters.
2. Click the Variables tab and then the Offline Detection tab.
3. Enter the Alarm settings for the parameters that you want to modify.
4. On the File menu, click Save.
Technical 04-16006-04-en, March 2015
2296
66 Xenta LonWorks Schedules
Topics
Number of Scheduled Events for Xenta LonWorks Devices
All-Day Events for Xenta LonWorks Devices
Weekly Events for Xenta LonWorks Devices
Exception Events for Xenta LonWorks Devices
Creating a Schedule for a Xenta LonWorks Device
Editing a Schedule for a Xenta LonWorks Device
Xenta Central Schedules
Creating a Xenta Central Schedule
Adding a Weekly Event to a Xenta Schedule
Adding an Exception Event to a Xenta Schedule
Editing a Weekly Event in a Xenta Schedule
Editing an Exception Event in a Xenta Schedule
Deleting a Weekly Event from a Xenta Schedule
Deleting an Exception Event from a Xenta Schedule
Assigning a Xenta Central Schedule
Unassigning a Xenta Central Schedule
Assigning a Lead Xenta Central Schedule
Unassigning a Lead Xenta Central Schedule
Viewing a Xenta Central Schedule Reference
Viewing a Lead Xenta Central Schedule Reference
66 Xenta LonWorks Schedules
66.1 Number of Scheduled Events for Xenta LonWorks Devices
66.1 Number of Scheduled Events for Xenta
LonWorks Devices
The number of scheduled events for a Xenta 280/300/401 LonWorks device
application is set in the Time Schedule window, which is opened when you click
Edit in the Edit block TSCH window.
Figure: Specifying the number of scheduled events when editing the TSCH block
There is one entry for the maximum number of weekly events and one entry for the
maximum number of exception events.
04-16006-04-en, March 2015 Technical
2299
66 Xenta LonWorks Schedules
66.2 All-Day Events for Xenta LonWorks Devices
66.2 All-Day Events for Xenta LonWorks
Devices
All-day events have the same meaning, but are indicated differently in Menta Editor
and the Xenta Schedule Editor.
In Menta Editor and the Xenta Schedule Editor:
• You indicate On all day with a time interval 00-24.
• You indicate Off all day with a time interval 00-00.
Technical 04-16006-04-en, March 2015
2300
66 Xenta LonWorks Schedules
66.3 Weekly Events for Xenta LonWorks Devices
66.3 Weekly Events for Xenta LonWorks
Devices
Weekly events in a Xenta 280/300/401 LonWorks device are specified with the
days of the week.
Once an event has been defined in Menta Editor, the selected days of the week are
shown in the Xenta Schedule Editor, where it can be edited.
Figure: Xenta Schedule Editor weekly events
04-16006-04-en, March 2015 Technical
2301
66 Xenta LonWorks Schedules
66.4 Exception Events for Xenta LonWorks Devices
66.4 Exception Events for Xenta LonWorks
Devices
Exception events in Xenta 280/300/401 LonWorks device applications are defined
as a range of dates, weekday, or time pair. A one-day exception is indicated with
equal Start and End dates.
If the day of the week is unimportant, you specify all days of the week in the
exception event. If you have selected anything other than all days of the week, the
exception event applies for the selected weekdays.
If limited to certain days only, the indicated days of the week determine valid days of
the event within the date range.
Exception events can be defined to reoccur on the same dates every year. To
indicate reoccurence, you need to replace the year in Start date and End date with
an asterisk.
Figure: Xenta Schedule Editor exception event
Technical 04-16006-04-en, March 2015
2302
66 Xenta LonWorks Schedules
66.5 Creating a Schedule for a Xenta LonWorks Device
66.5 Creating a Schedule for a Xenta
LonWorks Device
You create a schedule for a Xenta device to control a Xenta 280/300/401
LonWorks device input or output in a Menta application.
For more information, see section 62.23 “Schedules for Xenta LonWorks Devices”
on page 2258.
To create a schedule for a Xenta LonWorks device
1. In WorkStation, in the System Tree pane, select the Xenta 280/300/401
LonWorks device.
2. On the Action menu, click Edit.
3. In Menta Editor, create a TSCH block and set the appropriate
configurations.
4. In the Parameter box, click Edit and set all appropriate parameters.
5. In the Time schedule dialog box, click OK.
6. In the Edit block dialog box, click OK.
7. Click Save.
8. Click Exit.
04-16006-04-en, March 2015 Technical
2303
66 Xenta LonWorks Schedules
66.6 Editing a Schedule for a Xenta LonWorks Device
66.6 Editing a Schedule for a Xenta
LonWorks Device
You edit a schedule for a Xenta device to change the input or output control
settings in a Xenta 280/300/401 LonWorks device in a Menta application.
For more information, see section 62.23 “Schedules for Xenta LonWorks Devices”
on page 2258.
To edit a schedule for a Xenta LonWorks device
1. In WorkStation, in the System Tree pane, select the Xenta 280/300/401
LonWorks device schedule.
2. On the Action menu, click Edit.
3. In Menta Editor, change the appropriate configurations.
4. In the Parameter box, click Edit and edit all appropriate parameters.
5. In the Time schedule dialog box, click OK.
6. In the Edit block dialog box, click OK.
7. Click Save.
8. Click Exit.
Important
You can reassign any Xenta Central schedule in the Xenta Schedule
Editor to ensure that you not have any synchronization problems.
Technical 04-16006-04-en, March 2015
2304
66 Xenta LonWorks Schedules
66.7 Xenta Central Schedules
66.7 Xenta Central Schedules
Xenta Central schedules are used to group Xenta 280/300/401 LonWorks device
schedules created in the TSCH block in Menta Editor. When you use a Central
schedule, you can change settings on whole Xenta schedule groups from a central
place.
In a first level, the Xenta Central schedule is referenced from a Xenta 280/300/401
LonWorks device schedule to override the schedule events set locally in the Xenta
280/300/401 LonWorks device. You can have two Xenta Central schedules
referenced from the same 280/300/401 LonWorks device schedule to override
both a weekly event and an exception event.
You can also use Xenta Central schedules in a second or more level located in
another server to override other Xenta Central schedules.
The number of events a Xenta Central schedule can have is determined by the
Menta application.
For more information, see section 62.23 “Schedules for Xenta LonWorks Devices”
on page 2258.
In WebStation, you can only read a Xenta Central schedule.
04-16006-04-en, March 2015 Technical
2305
66 Xenta LonWorks Schedules
66.7 Xenta Central Schedules
Figure: Xenta Central Schedule example flowchart
Technical 04-16006-04-en, March 2015
2306
66 Xenta LonWorks Schedules
66.7 Xenta Central Schedules
66.7.1 Xenta Central Schedule Synchronization
If a first level Xenta Central schedule is changed when the device is offline, the
device will be out of synchronization and you have to download the configuration to
the device when the device is back online again.
When you upload a Xenta 280/300/401 LonWorks device configuration to the
Automation Server, the configuration is propagated to the Xenta 280/300/401
LonWorks device schedule and not to the Xenta Central schedule.
For more information, see section 156.1 “Xenta Device Out of Sync” on page 5579.
It is possible to edit the Xenta 280/300/401 LonWorks device schedule in the Menta
Editor although it has an assigned Xenta Central schedule. However, you will have
to ensure that any assigned Xenta Central schedules are in sync with the Xenta
280/300/401 LonWorks device schedule settings.
For more information, see section 156.4 “Xenta Schedule Synchronization
Problems” on page 5583.
66.7.2 Xenta Central Schedule Group Editing
A second top level lead Xenta Central schedule uses a Lead-Shadow relationship to
propagate the changes, similar to other Building Operation schedules. Any changes
made to the lead schedule when the shadow schedule are offline is propagated to
the shadow schedule when the device is back online again.
To change a property within the shadow schedules, you make the change within
the lead schedule. The changes are then propagated in all of the shadow
schedules. Some properties in a lead schedule, such as name and description, are
unique to the lead schedule and are not propagated to the shadow schedules.
Note
Xenta Central schedule property changes may take up to one minute before they
are propagated to shadow Xenta schedules.
For more information, see the Lead and Shadow Relationship topic on WebHelp.
04-16006-04-en, March 2015 Technical
2307
66 Xenta LonWorks Schedules
66.8 Creating a Xenta Central Schedule
66.8 Creating a Xenta Central Schedule
You create a Xenta Central schedule for control of Xenta schedules, or other Xenta
Central schedules.
For more information, see section 66.7 “Xenta Central Schedules” on page 2303.
To create a Xenta Central schedule
1. In WorkStation, in the System Tree pane, select a folder.
2. On the File menu, point to New and click Schedule.
3. In the object type list, select Xenta Central Schedule.
4. In the Name box, type a name for the Xenta Central schedule.
5. In the Description box, type a description for the Xenta Central schedule.
6. Click Create.
Technical 04-16006-04-en, March 2015
2308
66 Xenta LonWorks Schedules
66.9 Adding a Weekly Event to a Xenta Schedule
66.9 Adding a Weekly Event to a Xenta
Schedule
You add weekly events to a Xenta schedule to determine when the event is to
regularly occur. Weekly events always occur regularly unless overridden by an
exception event.
Important
You cannot add, edit, or delete schedule events in a Xenta Schedule in
WorkStation when a Xenta Central schedule has been assigned to it.
The number of events a Xenta Central schedule can have is determined by the
Menta application.
For more information, see section 62.23 “Schedules for Xenta LonWorks Devices”
on page 2258.
To add a weekly event to a Xenta schedule
1. In WorkStation, in the System Tree pane, select the schedule to which you
want to add the weekly event.
Continued on next page
04-16006-04-en, March 2015 Technical
2309
66 Xenta LonWorks Schedules
66.9 Adding a Weekly Event to a Xenta Schedule
2. In the Xenta Schedule editor, click the New button for a weekly event.
Continued on next page
Technical 04-16006-04-en, March 2015
2310
66 Xenta LonWorks Schedules
66.9 Adding a Weekly Event to a Xenta Schedule
3. In the Time interval box, select the time range for the weekly event.
4. In the Start time box, enter the time when the weekly event starts.
5. In the End time box, enter the time when the weekly event ends.
6. Select the weekdays the weekly event is to be in service.
7. Click OK.
04-16006-04-en, March 2015 Technical
2311
66 Xenta LonWorks Schedules
66.10 Adding an Exception Event to a Xenta Schedule
66.10 Adding an Exception Event to a Xenta
Schedule
You add an exception event to configure an exception that is to apply instead of a
scheduled weekly event for a single date, date range, or a time pair.
Important
You cannot add, edit, or delete schedule events in a Xenta Schedule in
WorkStation when a Xenta Central schedule has been assigned to it.
The number of events a Xenta Central schedule can have is determined by the
Menta application.
Important
An added exception event overrides any weekly events for all of the selected
days.
For more information, see section 62.23 “Schedules for Xenta LonWorks Devices”
on page 2258.
To add an exception event to a Xenta schedule
1. In WorkStation, in the System Tree pane, select the schedule to which you
want to add the exception event.
Continued on next page
Technical 04-16006-04-en, March 2015
2312
66 Xenta LonWorks Schedules
66.10 Adding an Exception Event to a Xenta Schedule
2. In the Xenta Schedule editor, click the New button for an exception
event.
Continued on next page
04-16006-04-en, March 2015 Technical
2313
66 Xenta LonWorks Schedules
66.10 Adding an Exception Event to a Xenta Schedule
3. In the Time span box, select the time range the exception event is to be in
service.
4. In the Start date box, enter the date when the exception event starts.
5. In the End date box, enter the date when the exception event ends.
6. In the Start time box, enter the time when the exception event starts.
7. In the End time box, enter the time when the exception event ends.
8. Select the weekdays the exception event is to be in service.
9. Click OK.
Technical 04-16006-04-en, March 2015
2314
66 Xenta LonWorks Schedules
66.11 Editing a Weekly Event in a Xenta Schedule
66.11 Editing a Weekly Event in a Xenta
Schedule
You edit a weekly event to change the time range, start and stop time, or weekdays
of the weekly event.
Important
You cannot add, edit, or delete schedule events in a Xenta Schedule in
WorkStation when a Xenta Central schedule has been assigned to it.
The number of events a Xenta Central schedule can have is determined by the
Menta application.
For more information, see section 62.23 “Schedules for Xenta LonWorks Devices”
on page 2258.
To edit a weekly event in a Xenta schedule
1. In WorkStation, in the System Tree pane, select the schedule containing the
weekly event you want to edit.
Continued on next page
04-16006-04-en, March 2015 Technical
2315
66 Xenta LonWorks Schedules
66.11 Editing a Weekly Event in a Xenta Schedule
2. In the Xenta Schedule editor, in the weekly event table, select the event and
click the Edit button .
Continued on next page
Technical 04-16006-04-en, March 2015
2316
66 Xenta LonWorks Schedules
66.11 Editing a Weekly Event in a Xenta Schedule
3. In the Time interval box, select the time range the weekly event is to be in
service.
4. In the Start time box, enter the time when the weekly event starts.
5. In the End time box, enter the time when the weekly event ends.
6. Select the weekdays the weekly event starts.
7. Click OK.
04-16006-04-en, March 2015 Technical
2317
66 Xenta LonWorks Schedules
66.12 Editing an Exception Event in a Xenta Schedule
66.12 Editing an Exception Event in a Xenta
Schedule
You edit an exception event to change the time range, start and stop date, start and
stop time, or weekdays of an exception event.
Important
You cannot add, edit, or delete schedule events in a Xenta Schedule in
WorkStation when a Xenta Central schedule has been assigned to it.
The number of events a Xenta Central schedule can have is determined by the
Menta application.
For more information, see section 62.23 “Schedules for Xenta LonWorks Devices”
on page 2258.
To edit an exception event in a Xenta schedule
1. In WorkStation, in the System Tree pane, select the schedule containing the
exception event you want to edit.
Continued on next page
Technical 04-16006-04-en, March 2015
2318
66 Xenta LonWorks Schedules
66.12 Editing an Exception Event in a Xenta Schedule
2. In the Xenta Schedule editor, in the exception event table, select the event and
click the Edit button .
Continued on next page
04-16006-04-en, March 2015 Technical
2319
66 Xenta LonWorks Schedules
66.12 Editing an Exception Event in a Xenta Schedule
3. In the Time span box, select the time range the exception event is to be in
service.
4. In the Start date box, enter the date when the exception event starts.
5. In the End date box, enter the date when the exception event ends.
6. In the Start time box, enter the time when the exception starts.
7. In the End time box, enter the time when the exception ends.
8. Select the weekdays the exception event starts.
9. Click OK.
Technical 04-16006-04-en, March 2015
2320
66 Xenta LonWorks Schedules
66.13 Deleting a Weekly Event from a Xenta Schedule
66.13 Deleting a Weekly Event from a Xenta
Schedule
You delete a weekly event when the event is no longer to regularly occur.
Important
You cannot add, edit, or delete schedule events in a Xenta Schedule in
WorkStation when a Xenta Central schedule has been assigned to it.
The number of events a Xenta Central schedule can have is determined by the
Menta application.
For more information, see section 62.23 “Schedules for Xenta LonWorks Devices”
on page 2258.
To delete a weekly event from a Xenta schedule
1. In WorkStation, in the System Tree pane, select the schedule containing the
weekly event you want to delete.
2. In the Xenta Schedule editor, in the weekly event table, select the event and
click the Delete button .
04-16006-04-en, March 2015 Technical
2321
66 Xenta LonWorks Schedules
66.14 Deleting an Exception Event from a Xenta Schedule
66.14 Deleting an Exception Event from a
Xenta Schedule
You delete an exception event when you no longer need the exception to make an
exception from a weekly event.
Important
You cannot add, edit, or delete schedule events in a Xenta Schedule in
WorkStation when a Xenta Central schedule has been assigned to it.
The number of events a Xenta Central schedule can have is determined by the
Menta application.
For more information, see section 62.23 “Schedules for Xenta LonWorks Devices”
on page 2258.
To delete an exception event from a Xenta schedule
1. In WorkStation, in the System Tree pane, select the schedule containing the
exception event you want to delete.
Continued on next page
Technical 04-16006-04-en, March 2015
2322
66 Xenta LonWorks Schedules
66.14 Deleting an Exception Event from a Xenta Schedule
2. In the Xenta Schedule editor, in the exception event table, select the event and
click the Delete button .
04-16006-04-en, March 2015 Technical
2323
66 Xenta LonWorks Schedules
66.15 Assigning a Xenta Central Schedule
66.15 Assigning a Xenta Central Schedule
You assign a Xenta Central schedule to a Xenta Schedule to override the Xenta
schedule settings, in order to administrate the Xenta 280/300/401 LonWorks
device schedule in a central place, sending out schedule changes to the Xenta
280/300/401 LonWorks devices.
For more information, see section 66.7 “Xenta Central Schedules” on page 2303.
To assign a Xenta Central schedule
1. In WorkStation, in the System Tree pane, select the Xenta schedule to which
you want to assign a Xenta Central schedule.
2. In the Xenta Schedule editor, in the Central weekly schedule or Central
exceptions schedule box, enter the path to a Xenta Central schedule.
3. Click .
Technical 04-16006-04-en, March 2015
2324
66 Xenta LonWorks Schedules
66.16 Unassigning a Xenta Central Schedule
66.16 Unassigning a Xenta Central Schedule
You unassign a Xenta Central schedule in a Xenta schedule to use the Xenta
schedule event settings.
For more information, see section 66.7 “Xenta Central Schedules” on page 2303.
To unassign a Xenta Central schedule
1. In WorkStation, in the System Tree pane, select the Xenta schedule to which
you want to unassign a Xenta Central schedule.
2. In the Xenta Schedule editor, in the Central weekly schedule or Central
exceptions schedule box, delete the assigned Xenta Central schedule.
3. Click .
04-16006-04-en, March 2015 Technical
2325
66 Xenta LonWorks Schedules
66.17 Assigning a Lead Xenta Central Schedule
66.17 Assigning a Lead Xenta Central
Schedule
You assign a Xenta Central schedule to a another Xenta Central Schedule to
override the Xenta Central schedule settings, in order to administrate the Xenta
280/300/401 LonWorks device schedule in a central place, sending out schedule
changes to the Xenta 280/300/401 LonWorks devices.
For more information, see section 66.7 “Xenta Central Schedules” on page 2303.
To assign a lead Xenta Central schedule
1. In WorkStation, in the System Tree pane, select the Xenta Central schedule
to which you want to assign a lead Xenta Central schedule.
2. In the Xenta Schedule editor, in the Lead central schedule box, enter the
path to a Xenta Central schedule.
3. Click .
Technical 04-16006-04-en, March 2015
2326
66 Xenta LonWorks Schedules
66.18 Unassigning a Lead Xenta Central Schedule
66.18 Unassigning a Lead Xenta Central
Schedule
You unassign a lead Xenta Central schedule in a shadow Xenta Central schedule to
use the shadow Xenta Central schedule event settings.
For more information, see section 66.7 “Xenta Central Schedules” on page 2303.
To unassign a lead Xenta Central schedule
1. In WorkStation, in the System Tree pane, select the Xenta Central schedule
to which you want to unassign a lead Xenta Central schedule.
2. In Xenta Schedule editor, in the Lead central schedule box, delete the path
to the lead Xenta Central schedule.
3. Click .
04-16006-04-en, March 2015 Technical
2327
66 Xenta LonWorks Schedules
66.19 Viewing a Xenta Central Schedule Reference
66.19 Viewing a Xenta Central Schedule
Reference
You can view the path to a Xenta Central schedule referenced in a Xenta Schedule.
For more information, see section 66.7 “Xenta Central Schedules” on page 2303.
To view a Xenta Central schedule reference
1. In WorkStation, in the System Tree pane, select the Xenta schedule where
you want view the referenced Xenta Central schedule.
2. In Xenta Schedule editor, in the Central weekly schedule or Central
exceptions schedule box, view the referenced Xenta Central schedule
path.
Technical 04-16006-04-en, March 2015
2328
66 Xenta LonWorks Schedules
66.20 Viewing a Lead Xenta Central Schedule Reference
66.20 Viewing a Lead Xenta Central Schedule
Reference
You can view the referenced Xenta Central schedule in another Xenta Central
Schedule to check the reference path.
For more information, see section 66.7 “Xenta Central Schedules” on page 2303.
To view a lead Xenta Central schedule reference
1. In WorkStation, in the System Tree pane, select the Xenta Central schedule
where you want view the referenced lead Xenta Central schedule.
2. In Xenta Schedule editor, in the Lead central schedule box, view the
referenced lead Xenta Central schedule path.
04-16006-04-en, March 2015 Technical
2329
67 Xenta LonWorks Device User
Interface
Topics
Xenta Icons
Actions Menu – Advanced Commands Submenu
LonWorks Network Properties – Advanced Tab
ProgrammableXenta Properties – Xenta Tab
Menta Program Properties – Basic Tab
Menta Program Properties – Public Signals Tab
Menta Program Properties – Inputs Tab
Menta Program Properties – Outputs Tab
Xenta I/O Module Properties – Basic Tab
Xenta I/O Module Properties – Advanced Tab
Xenta Trend Log Properties
Xenta Schedule Editor
Xenta Schedule Dialog Box
Xenta Alarm Properties - Basic Tab
Xenta Alarm Properties - Advanced Tab
67 Xenta LonWorks Device User Interface
67.1 Xenta Icons
67.1 Xenta Icons
Use the Xenta device icons to check the device status.
Table: Xenta Device Icons
Icon Description
Programmable Xenta
Indicates that a Xenta device is a Group
master and is online.
Programmable Xenta
Indicates that a Xenta device is a Group
master and is online, but unsynced.
Programmable Xenta
Indicates that a Xenta device is a Group
master, and is offline.
Programmable Xenta
Indicates that a Xenta device is a Group
master, unsynced, and offline.
Programmable Xenta
Indicates that a Xenta device is a Group
member, unsynced, and invalid.
Xenta I/O Module
Indicates an online Xenta I/O module in the
IO folder. Also used for Xenta group
members.
(Menta object name)
Indicates the Menta application, listing the
Public Signals and Inputs/Outputs
associated with the Xenta device.
(Menta object name)
Indicates the Menta application in a device
which is offline.
(Menta Module name)
Indicates a Module defined in the Menta
application.
04-16006-04-en, March 2015 Technical
2333
67 Xenta LonWorks Device User Interface
67.1 Xenta Icons
Continued
Icon Description
Programmable Xenta
Indicates a Xenta device which is out of
sync.
Programmable Xenta
Indicates a Xenta device which is offline.
Programmable Xenta
Indicates an invalid Xenta device.
Technical 04-16006-04-en, March 2015
2334
67 Xenta LonWorks Device User Interface
67.2 Actions Menu – Advanced Commands Submenu
67.2 Actions Menu – Advanced Commands
Submenu
Use the Advanced Commands submenu to execute functions on the selected
LonWorks device or Xenta device.
Figure: The Actions menu - Advanced Commands submenu
Table: Advanced Commands Submenu
Command Description
Wink Click to generate a response from the
device, such as flashing the power LED.
Clear Status Click to clear the diagnostic data for the
device or local node. For more information,
see section 60.13 “LonWorks Device
Properties – Diagnostics Tab” on page
2152.
Warm Start Click to restart the device without clearing
the RAM memory. For more information, see
section 62.26 “Xenta LonWorks Device
Restart” on page 2266.
Cold Start Click to restart the device and clear the RAM
memory. For more information, see section
62.26 “Xenta LonWorks Device Restart” on
page 2266.
Alarm Refresh Click to transfer all alarms buffered in the
physical Xenta device to Building Operation.
For more information, see section 62.22
“Alarms for Xenta LonWorks Devices” on
page 2257.
04-16006-04-en, March 2015 Technical
2335
67 Xenta LonWorks Device User Interface
67.3 LonWorks Network Properties – Advanced Tab
67.3 LonWorks Network Properties –
Advanced Tab
Use the Advanced tab to view and edit domain properties and posssibly Xenta-
specific parts of the LonWorks network.
Figure: Advanced tab
Table: Domain Table for Network Interface
Component Description
Index Displays the location of the entry in the
domain table. The first item is 0.
ID (decimal) Displays the domain ID of which the device is
a member.
Domain ID lenght Displays the byte length of the domain ID.
Subnet Displays the subnet of which the device is a
member.
Node Displays the node ID of the device. The Local
Node is always node 1.
Technical 04-16006-04-en, March 2015
2336
67 Xenta LonWorks Device User Interface
67.3 LonWorks Network Properties – Advanced Tab
Continued
Component Description
Click to change domain ID.
Table: Xenta General
Component Description
Classic Operator Panel Support Select Yes to get support for classic OP
functionality, that is, the OP can be
connected to any Xenta device.
Network name in blueprint Displays the current name of the network.
System alarm priority Enter the priority of Xenta non-application
alarms.
Time synchronization interval (min) Enter the time interval between
synchronization of Xenta and the server
clocks. The default value is 10.
Heartbeat (s) Enter the time interval for the server
heartbeat on the LonWorks network. The
default value is 5 s.
Table: Xenta LACnet Settings
Component Description
Timeout (ms) Enter the amount of time in milliseconds until
Xenta communication should be considered
broken. The default is 40,000 ms.
Transmit timer (ms) Displays the time before Xenta
retransmission (if no answer).
Number of retries Enter the maximum number of attempts
before giving up. The default value is 6.
The Xenta LACnet parameters only apply to certain types of data transfer, such as
application download, fetching of trend logs, and alarms refresh.
04-16006-04-en, March 2015 Technical
2337
67 Xenta LonWorks Device User Interface
67.4 ProgrammableXenta Properties – Xenta Tab
67.4 ProgrammableXenta Properties – Xenta
Tab
Use the Xenta tab to view and edit properties of the selected Xenta device.
Figure: Xenta tab
Table: Xenta Tab
Component Description
Xenta type Displays type as selected in Menta.
Group master Displays if this Xenta device is a group
master.
Member of group Displays the Xenta group to which a device
belongs.
Software version Displays the Xenta software (firmware)
version.
Hardware version Displays Xenta hardware version.
Boot version Displays the Xenta boot program version.
Technical 04-16006-04-en, March 2015
2338
67 Xenta LonWorks Device User Interface
67.4 ProgrammableXenta Properties – Xenta Tab
Continued
Component Description
Local time Displays the local time in the Xenta device,
as adjusted to the client´s local time zone.
DST Last update Displays date and time for the last Daylight
Saving Time update, as adjusted to the
client´s local time zone.
04-16006-04-en, March 2015 Technical
2339
67 Xenta LonWorks Device User Interface
67.5 Menta Program Properties – Basic Tab
67.5 Menta Program Properties – Basic Tab
Use the Basic tab to view and edit properties of the selected Xenta application.
Figure: Basic tab
For more information, see the General Properties – Basic Tab topic on WebHelp..
Note
The same property tabs appear when you select a Module created in the Menta
program.
Technical 04-16006-04-en, March 2015
2340
67 Xenta LonWorks Device User Interface
67.6 Menta Program Properties – Public Signals Tab
67.6 Menta Program Properties – Public
Signals Tab
Use the Public Signals tab to view and edit the public signals of the selected
Xenta application.
Figure: Public signals tab
All public signals of the Xenta application, except the inputs and outputs, are listed
under this tab. Depending on the type of signal, values are displayed or open for
modification.
The contents depend on the Menta application.
Note
The same property tabs appear when you select a Module created in the Menta
program.
04-16006-04-en, March 2015 Technical
2341
67 Xenta LonWorks Device User Interface
67.7 Menta Program Properties – Inputs Tab
67.7 Menta Program Properties – Inputs Tab
Use the Inputs tab to view the input signals of the selected Xenta application.
Figure: Menta program properties - Inputs tab
All inputs of the Xenta application are listed under this tab. The values are displayed
according to the type of input.
The contents depend on the Menta application.
Note
The same property tabs appear when you select a Module created in the Menta
program.
Technical 04-16006-04-en, March 2015
2342
67 Xenta LonWorks Device User Interface
67.8 Menta Program Properties – Outputs Tab
67.8 Menta Program Properties – Outputs
Tab
Use the Outputs tab to view the output signals of the selected Xenta application.
Figure: Menta program properties - Outputs tab
All outputs of the Xenta application are listed under this tab. The values are
displayed according to the type of output.
The contents depend on the Menta application.
Note
The same property tabs appear when you select a Module created in the Menta
program.
04-16006-04-en, March 2015 Technical
2343
67 Xenta LonWorks Device User Interface
67.9 Xenta I/O Module Properties – Basic Tab
67.9 Xenta I/O Module Properties – Basic Tab
Use the Xenta I/O Module Basic tab to view and edit properties of the selected
Xenta I/O module in the IO folder.
Figure: Xenta I/O Module Properties - Basic tab
Table: Xenta I/O Basic Tab
Component Description
Neuron ID Displays the unique hardware ID for the
node.
Program ID Displays the program ID for the node.
Subnet Displays the assigned subnet number.
Node Displays the assigned node number.
Index Displays the assigned index number.
Technical 04-16006-04-en, March 2015
2344
67 Xenta LonWorks Device User Interface
67.10 Xenta I/O Module Properties – Advanced Tab
67.10 Xenta I/O Module Properties –
Advanced Tab
Use the Xenta I/O Module Advanced tab to view and edit advanced properties of
the selected Xenta I/O module in the IO folder.
Figure: Xenta I/O Module Properties - Advanced tab
Table: Xenta I/O Advanced Tab
Component Description
Manufacturer Displays the name of the manufacturer.
Model Displays the model name or number.
Version Displays the firmware version.
04-16006-04-en, March 2015 Technical
2345
67 Xenta LonWorks Device User Interface
67.11 Xenta Trend Log Properties
67.11 Xenta Trend Log Properties
Use the Xenta Trend Log properties dialog box to view and edit Xenta trend logs.
Figure: Xenta trend log properties
Table: Xenta Trend Log Properties
Component Description
Logged Signal Enter the name of a public signal in the Xenta
device in which the trend log resides.
Log Interval Enter the time interval between the log
readings.
Log Space Enter the total time that you want log
readings for. The number of values will be
Log Space/Log Interval.
Circular Log Click True to select circular log.
Activate Select type of activation: Manual - Off,
Manual - On, or Automatic.
Start Time Type the date and time for the log to start.
Technical 04-16006-04-en, March 2015
2346
67 Xenta LonWorks Device User Interface
67.11 Xenta Trend Log Properties
Continued
Component Description
Start Variable If you have set Activate to Automatic:
Enter the name of a public signal in the Xenta
device which will start the log
No stop if logically activated Select True to inhibit the stopping of a log
activated by a logical variable when the
variable is no longer true. The logging
continues until stopped manually, or the log
is full when the non-circular log option is
selected.
Clear log at start Select True to make sure the log buffer is
cleared at start.
04-16006-04-en, March 2015 Technical
2347
67 Xenta LonWorks Device User Interface
67.12 Xenta Schedule Editor
67.12 Xenta Schedule Editor
Use the Xenta Schedule Editor to view and configure weekly events and exception
events for a Xenta schedule.
Figure: Xenta Schedule editor
Table: Xenta Schedule Editor
Number Description
Weekly (Maximum) Displays the maximum number of weekly
events the schedule can have. For more
information, see section 66.1 “Number of
Scheduled Events for Xenta LonWorks
Devices” on page 2297.
Central weekly schedule/Central Enter a central weekly or exception schedule
exceptions schedule/Lead central reference, or enter a lead Xenta Central
schedule Schedule reference in a Xenta Central
schedule.
Lead central schedule Enter a lead Xenta Central Schedule
reference.
Technical 04-16006-04-en, March 2015
2348
67 Xenta LonWorks Device User Interface
67.12 Xenta Schedule Editor
Continued
Number Description
New
Click to open the Xenta Schedule dialog box,
where you can add an event. For more
information, see section 67.13 “Xenta
Schedule Dialog Box ” on page 2348.
Edit
Click to open the Xenta Schedule dialog box,
where you can edit an event. For more
information, see section 67.13 “Xenta
Schedule Dialog Box ” on page 2348.
Delete
Click to delete a selected event.
Weekly event table Displays the weekly events for the Xenta
schedule or Xenta Central schedule.
Exceptions (Maximum) Displays the maximum number of
exceptions events the schedule can have.
For more information, see section 66.1
“Number of Scheduled Events for Xenta
LonWorks Devices” on page 2297.
New
Click to open the Xenta Schedule dialog box,
where you can add an event. For more
information, see section 67.13 “Xenta
Schedule Dialog Box ” on page 2348.
Edit
Click to open the Xenta Schedule dialog box,
where you can edit an event. For more
information, see section 67.13 “Xenta
Schedule Dialog Box ” on page 2348.
Delete
Click to delete a selected event.
Exceptions event table Displays the exception events for the Xenta
schedule.
04-16006-04-en, March 2015 Technical
2349
67 Xenta LonWorks Device User Interface
67.13 Xenta Schedule Dialog Box
67.13 Xenta Schedule Dialog Box
Use the Xenta Schedule dialog box to edit the exception start and stop date, time
interval, and weekday of a weekly or exception event.
Figure: Xenta Schedule dialog box
Table: Xenta Schedule Editor
Preperty Description
[Time span/On all day/Off all day menu] Click to select the time range the schedule
should be in service, or select On all day or
Off all day.
Start date/Stop date Enter the date range when the schedule
should be in service.
Start time/Stop time Enter the time range when the schedule
should be in service.
Result Displays the result of the selected time
range.
[List of weekdays] Select the weekdays the schedule should be
in service.
Technical 04-16006-04-en, March 2015
2350
67 Xenta LonWorks Device User Interface
67.14 Xenta Alarm Properties - Basic Tab
67.14 Xenta Alarm Properties - Basic Tab
Use the Xenta Alarm Properties - Basic tab to set configuration settings on a
Xenta alarm.
Figure: Xenta Alarm Properties - Basic tab
Table: Xenta Alarm Properties - Basic tab
Property Description
Message when alarm Enter the alarm message.
Priority when alarm Enter the priority level.
Message when reset Enter the alarm message when reset.
Priority when reset Enter the Xenta alarm priority when reset.
Priority Enter the Xenta alarm priority.
OP alarm text Enter the OP alarm text.
Shunt variable Enter the shunt variable.
Alarm state Displays the current alarm state.
04-16006-04-en, March 2015 Technical
2351
67 Xenta LonWorks Device User Interface
67.15 Xenta Alarm Properties - Advanced Tab
67.15 Xenta Alarm Properties - Advanced Tab
Use the Xenta Alarm Properties - Advanced tab to configure the Advanced
properties of a Xenta alarm.
Figure: Xenta Alarm Properties - Advanced Tab
Table: Xenta Alarm Properties - Advanced tab
Property Description
Category Enter the alarm category.
Cause note group Enter the cause note group.
Action Note group Enter the action note group.
Checklist Enter the alarm checklist.
Checklist required Click True to require a checklist.
Audible alert Click True to select audible alert.
Technical 04-16006-04-en, March 2015
2352
67 Xenta LonWorks Device User Interface
67.15 Xenta Alarm Properties - Advanced Tab
Continued
Property Description
Flashing alert Click True to select flashing alert.
Alarm View source name prefix Type a prefix that is added to the beginning
of the source name property of an alarm
record.
Forced user action Displays all added forced user actions.
Add
Click to add a forced user action.
Edit
Click to edit a forced user action.
Delete
Click to delete a forced user action.
List of attachments Displays all added attachments.
Add
Click to add an attachment.
Edit
Click to edit an attachment.
Delete
Click to delete an attachment.
04-16006-04-en, March 2015 Technical
2353
68 MNL LonWorks Introduction
Topics
MNL LonWorks Device Overview
MNL LonWorks Engineering
LonWorks Interfaces
Standard MNL LonWorks Device Workflow
MNL-800 LonWorks Device Workflow
Bindings for MNL LonWorks Devices
Synchronize MNL LonWorks Devices after Server Restore
68 MNL LonWorks Introduction
68.1 MNL LonWorks Device Overview
68.1 MNL LonWorks Device Overview
MNL LonWorks devices are a family of programmable, stand-alone devices that
provide direct digital control in a building's environmental control system. MNL
LonWorks devices consist of standard MNL LonWorks devices and MNL-800
LonWorks devices. MNL devices are complemented by S-Link sensors, which are
designed specifically for use with these devices.
Standard MNL LonWorks devices provide direct-digital control of fan coil, heat
pump, roof top unit, and VAV applications. Standard MNL devices are based on
nine basic hardware platforms, and each contains a standardized LonMark HVAC
functional profile that defines the device's network image.
MNL-800 LonWorks devices are capable of greater control functions than standard
MNL devices through an expanded I/O point count and a programmable LonWorks
profile.
S-Link sensors are a family of digital sensors designed specifically for use with MNL
LonWorks devices. Each sensor has a network jack to support an optional twisted-
pair connection to the LonWorks network.
WorkPlace Tech Tool 4.0 Engineering Guide (F-27254)
68.1.1 MNL LonWorks Devices
In Building Operation documentation, the family of TAC I/A Series Lon controllers is
referred to as MNL LonWorks devices. These devices are further defined as
standard MNL LonWorks devices and MNL-800 LonWorks devices.
For more information, see section 69.1 “MNL LonWorks Devices” on page 2375.
68.1.2 MNL LonWorks Engineering
In Building Operation, you engineer a system of MNL LonWorks devices using a
variety of approaches. You can use an Automation Server to integrate a single-level
bus of MNL devices, or you can use an IP/Ethernet to FT-10 router to integrate
MNL devices with the IP/Ethernet backbone.
For more information, see section 68.2 “MNL LonWorks Engineering” on page
2356.
68.1.3 MNL LonWorks Device Functions
Many of the functions and features of MNL LonWorks devices are supported in
Building Operation. For example, Building Operation provides support for all NCIs,
NVIs, and NVOs specified in the MNL LonWorks devices' respective LonMark
profiles.
For more information, see section 69.8 “MNL LonWorks Device Functions” on page
2384.
04-16006-04-en, March 2015 Technical
2357
68 MNL LonWorks Introduction
68.2 MNL LonWorks Engineering
68.2 MNL LonWorks Engineering
In Building Operation, you engineer a system of MNL LonWorks devices using a
variety of approaches. You can use an Automation Server to integrate a single-level
bus of MNL devices, or you can use an IP/Ethernet to FT-10 router to integrate
MNL devices with the IP/Ethernet backbone.
68.2.1 LonWorks Interfaces
Building Operation servers connect to LonWorks networks through various
LOYTEC interfaces and communicate with LonWorks devices over EIA-709 (FT-10)
or EIA 852 (Ethernet).
For more information, see section 68.3 “LonWorks Interfaces” on page 2358.
68.2.2 Standard MNL LonWorks Device Workflow
For standard MNL LonWorks devices with firmware revision 4.1 and higher, use the
LonWorks procedures for creating, discovering, and commissioning.
For more information, see section 68.4 “Standard MNL LonWorks Device
Workflow” on page 2360.
68.2.3 MNL-800 LonWorks Device Workflow
For MNL-800 LonWorks devices with firmware revision 2.0 and higher, use the
MNL-800 LonWorks procedures for creating, discovering, and commissioning.
For more information, see section 68.5 “MNL-800 LonWorks Device Workflow” on
page 2365.
68.2.4 Older MNL LonWorks Device Workflow
Use this workflow for the following older MNL LonWorks devices and firmware
revisions:
• Standard MNL devices with firmware revision 4.0 and lower
• MNL-800 devices with firmware revision 1.x
For more information, see the Older MNL LonWorks Device Workflow topic on
WebHelp.
68.2.5 Commission MNL-800 LonWorks Devices
You commission an MNL LonWorks device to assign it an address and activate it in
the network.
For more information, see section 69.6 “Commission MNL-800 LonWorks Devices”
on page 2382.
Technical 04-16006-04-en, March 2015
2358
68 MNL LonWorks Introduction
68.2 MNL LonWorks Engineering
68.2.6 MNL LonWorks Applications
There are two types of MNL LonWorks devices, each with a different type of
application:
• Standard MNL LonWorks devices have standard LonMark network profiles.
• MNL-800 LonWorks devices have applications with network profiles that are
fully customizable, through the use of SNVTs.
For more information, see section 70.1 “MNL LonWorks Applications” on page
2391.
68.2.7 Synchronize MNL LonWorks Devices after
Server Restore
Whenever you restore a server database in a system containing MNL LonWorks
devices, you need to commission all the MNL devices and download the device
configurations. You may also need to synchronize the MNL device with the server
database if changes were made to the device's application or configuration since
the time when the database backup was created.
For more information, see section 68.7 “Synchronize MNL LonWorks Devices after
Server Restore” on page 2371.
68.2.8 Bindings for MNL LonWorks Devices
Bindings for MNL LonWorks devices are created and viewed using the Bindings
view, in WorkStation. Use Building Operation bindings for I/O points, S-Link sensor
points, and NCIs in MNL devices. Use LonWorks bindings for NVs in MNL devices.
For more information, see section 68.6 “Bindings for MNL LonWorks Devices” on
page 2370.
04-16006-04-en, March 2015 Technical
2359
68 MNL LonWorks Introduction
68.3 LonWorks Interfaces
68.3 LonWorks Interfaces
Building Operation servers connect to LonWorks networks through various
LOYTEC interfaces and communicate with LonWorks devices over EIA-709 (FT-10)
or EIA 852 (Ethernet).
Figure: LonWorks in Building Operation
Technical 04-16006-04-en, March 2015
2360
68 MNL LonWorks Introduction
68.3 LonWorks Interfaces
68.3.1 LonWorks in the Automation Server
The Automation Server connects to LonWorks networks through a built-in LOYTEC
FT interface and communicates with LonWorks devices over EIA-709 (FT-10).
For more information, see section 55.4 “LonWorks in the Automation Server” on
page 1976.
68.3.2 LonWorks in the Enterprise Server
The Enterprise Server connects to LonWorks networks through various LOYTEC
NIC-interfaces and communicates with LonWorks devices over EIA-709 (FT-10) or
EIA-852 (Ethernet).
For more information, see section 55.5 “LonWorks in the Enterprise Server” on
page 1977.
68.3.3 Externally Managed LonWorks Network
You can connect an externally managed LonWorks network to Building Operation
through an Automation Server, in order to view and represent that same LonWorks
network data in WorkStation. The externally managed network is configured and
managed, through LNS, with an external LonWorks manager tool connected to the
network.
For more information, see section 55.11 “Externally Managed LonWorks Network”
on page 1991.
04-16006-04-en, March 2015 Technical
2361
68 MNL LonWorks Introduction
68.4 Standard MNL LonWorks Device Workflow
68.4 Standard MNL LonWorks Device
Workflow
For standard MNL LonWorks devices with firmware revision 4.1 and higher, use the
LonWorks procedures for creating, discovering, and commissioning.
There are three ways of creating and configuring a standard MNL device.
68.4.1 Create and then Discover
Use the Create and then Discover Standard MNL LonWorks Device workflow to
create and discover standard MNL LonWorks devices online.
Create a LonWorks interface
In WorkStation, create a LonWorks interface in the Enterprise Server or Automation
Server. For more information, see section 55.12 “Creating a LonWorks Interface” on
page 1993.
Technical 04-16006-04-en, March 2015
2362
68 MNL LonWorks Introduction
68.4 Standard MNL LonWorks Device Workflow
Create a LonWorks network
In WorkStation, create the LonWorks network on the LonWorks interface. For more
information, see section 55.15 “Creating a LonWorks Network” on page 1996.
Create an MNL device
In WorkStation, create an MNL device on the LonWorks network. For more
information, see section 56.2 “Creating a LonWorks Device” on page 2007.
Create and edit an MNL application
In the Applications view, create and edit an MNL application, using WorkPlace
Tech Editor.
For more information, see section 70.7 “Creating an MNL LonWorks Application
Type” on page 2401.
For more information, see section 70.10 “Editing an MNL LonWorks Application
Type” on page 2408.
Assign MNL application to device
In the System Tree pane, assign the MNL application to the MNL device. For
more information, see section 70.12 “Assigning an MNL LonWorks Application ” on
page 2412.
Obtain Neuron ID and associate it with MNL device
Connect the physical MNL device to the Enterprise Server or Automation Server. In
WorkStation, use the Device Discovery view to find the device (service pin) and
its Neuron ID in the list of discovered devices. Drag the discovered device to the
System Tree pane to associate its Neuron ID with the MNL device. For more
information, see section 56.5 “Discovering a LonWorks Device” on page 2012.
Commission MNL device
Commission the MNL device. For more information, see section 56.6
“Commissioning a LonWorks Device” on page 2014.
Download MNL application to device
In the System Tree pane, download the MNL application to the MNL device. For
more information, see section 70.13 “Downloading an MNL LonWorks Application
Type” on page 2413.
68.4.2 Discover
Use the Discover Standard MNL LonWorks Device workflow to discover standard
MNL LonWorks devices online.
04-16006-04-en, March 2015 Technical
2363
68 MNL LonWorks Introduction
68.4 Standard MNL LonWorks Device Workflow
Create a LonWorks interface
In WorkStation, create a LonWorks interface in the Enterprise Server or Automation
Server. For more information, see section 55.12 “Creating a LonWorks Interface” on
page 1993.
Create a LonWorks network
In WorkStation, create the LonWorks network on the LonWorks interface. For more
information, see section 55.15 “Creating a LonWorks Network” on page 1996.
Obtain Neuron ID and create MNL device
Connect the physical MNL device to the Enterprise Server or Automation Server. In
WorkStation, use the Device Discovery view to find the device (service pin) and
its Neuron ID in the list of discovered devices. Drag the discovered device to the
LonWorks network in the System Tree pane to create the MNL device. For more
information, see section 56.5 “Discovering a LonWorks Device” on page 2012.
Create and edit an MNL application
In the Applications view, create and edit an MNL application, using WorkPlace
Tech Editor.
For more information, see section 70.7 “Creating an MNL LonWorks Application
Type” on page 2401.
Technical 04-16006-04-en, March 2015
2364
68 MNL LonWorks Introduction
68.4 Standard MNL LonWorks Device Workflow
For more information, see section 70.10 “Editing an MNL LonWorks Application
Type” on page 2408.
Assign MNL application to device
In the System Tree pane, assign the MNL application to the MNL device. For
more information, see section 70.12 “Assigning an MNL LonWorks Application ” on
page 2412.
Commission MNL device
Commission the MNL device. For more information, see section 56.6
“Commissioning a LonWorks Device” on page 2014.
Download MNL application to device
In the System Tree pane, download the MNL application to the MNL device. For
more information, see section 70.13 “Downloading an MNL LonWorks Application
Type” on page 2413.
68.4.3 Create
Use the Create Standard MNL LonWorks Device workflow to create standard MNL
LonWorks devices online.
04-16006-04-en, March 2015 Technical
2365
68 MNL LonWorks Introduction
68.4 Standard MNL LonWorks Device Workflow
Create a LonWorks interface
In WorkStation, create a LonWorks interface in the Enterprise Server or Automation
Server. For more information, see section 55.12 “Creating a LonWorks Interface” on
page 1993.
Create a LonWorks network
In WorkStation, create the LonWorks network on the LonWorks interface. For more
information, see section 55.15 “Creating a LonWorks Network” on page 1996.
Create an MNL device and enter its Neuron ID
In WorkStation, create an MNL device on the LonWorks network and then enter its
Neuron ID. For more information, see section 56.2 “Creating a LonWorks Device”
on page 2007.
Create and edit an MNL application
In the Applications view, create and edit an MNL application, using WorkPlace
Tech Editor.
For more information, see section 70.7 “Creating an MNL LonWorks Application
Type” on page 2401.
For more information, see section 70.10 “Editing an MNL LonWorks Application
Type” on page 2408.
Assign MNL application to device
In the System Tree pane, assign the MNL application to the MNL device. For
more information, see section 70.12 “Assigning an MNL LonWorks Application ” on
page 2412.
Commission MNL device
Connect the physical MNL device to the Enterprise Server or Automation Server
and then commission the device. For more information, see section 56.6
“Commissioning a LonWorks Device” on page 2014.
Download MNL application to device
In the System Tree pane, download the MNL application to the MNL device. For
more information, see section 70.13 “Downloading an MNL LonWorks Application
Type” on page 2413.
Technical 04-16006-04-en, March 2015
2366
68 MNL LonWorks Introduction
68.5 MNL-800 LonWorks Device Workflow
68.5 MNL-800 LonWorks Device Workflow
For MNL-800 LonWorks devices with firmware revision 2.0 and higher, use the
MNL-800 LonWorks procedures for creating, discovering, and commissioning.
There are three ways of creating and configuring an MNL-800 device.
68.5.1 Create and then Discover
Use the Create and then Discover MNL-800 LonWorks Device workflow to create
and discover MNL-800 LonWorks devices online.
Create a LonWorks interface
In WorkStation, create a LonWorks interface in the Enterprise Server or Automation
Server. For more information, see section 55.12 “Creating a LonWorks Interface” on
page 1993.
04-16006-04-en, March 2015 Technical
2367
68 MNL LonWorks Introduction
68.5 MNL-800 LonWorks Device Workflow
Create a LonWorks network
In WorkStation, create the LonWorks network on the LonWorks interface. For more
information, see section 55.15 “Creating a LonWorks Network” on page 1996.
Create an MNL-800 device
In WorkStation, create an MNL-800 device on the LonWorks network. For more
information, see section 69.2 “Creating an MNL-800 LonWorks Device” on page
2377.
Create and edit an MNL-800 application
In the Applications view, create and edit an MNL-800 application, using
WorkPlace Tech Editor.
For more information, see section 70.7 “Creating an MNL LonWorks Application
Type” on page 2401.
For more information, see section 70.10 “Editing an MNL LonWorks Application
Type” on page 2408.
Assign application to MNL-800 device
In the System Tree pane, assign the MNL application to the MNL-800 device. For
more information, see section 70.12 “Assigning an MNL LonWorks Application ” on
page 2412.
Obtain Neuron ID and associate it with MNL-800 device
Connect the physical MNL-800 device to the Enterprise Server or Automation
Server. In WorkStation, use the Device Discovery view to find the device (service
pin) and its Neuron ID in the list of discovered devices. Drag the discovered device
to the System Tree pane to associate its Neuron ID with the MNL-800 device. For
more information, see section 69.3 “Discovering an MNL-800 LonWorks Device” on
page 2378.
Commission MNL-800 device
Commission the MNL-800 device. Commissioning includes a partial download of
the application to give the device its device profile and program ID. For more
information, see section 69.7 “Commissioning an MNL-800 LonWorks Device” on
page 2383.
Download MNL application to device
In the System Tree pane, download the MNL application to perform a full
download of the application to the MNL-800 device. For more information, see
section 70.13 “Downloading an MNL LonWorks Application Type” on page 2413.
68.5.2 Discover
Use the Discover MNL-800 LonWorks Device workflow to discover MNL-800
LonWorks devices online.
Technical 04-16006-04-en, March 2015
2368
68 MNL LonWorks Introduction
68.5 MNL-800 LonWorks Device Workflow
Create a LonWorks interface
In WorkStation, create a LonWorks interface in the Enterprise Server or Automation
Server. For more information, see section 55.12 “Creating a LonWorks Interface” on
page 1993.
Create a LonWorks network
In WorkStation, create the LonWorks network on the LonWorks interface. For more
information, see section 55.15 “Creating a LonWorks Network” on page 1996.
Obtain Neuron ID and create MNL-800 device
Connect the physical MNL-800 device to the Enterprise Server or Automation
Server. In WorkStation, use the Device Discovery view to find the device (service
pin) and its Neuron ID in the list of discovered devices. Drag the discovered device
to LonWorks network in the System Tree pane to create the MNL-800 device. For
more information, see section 69.3 “Discovering an MNL-800 LonWorks Device” on
page 2378.
Create and edit an MNL-800 application
In the Applications view, create and edit an MNL-800 application, using
WorkPlace Tech Editor.
For more information, see section 70.7 “Creating an MNL LonWorks Application
Type” on page 2401.
04-16006-04-en, March 2015 Technical
2369
68 MNL LonWorks Introduction
68.5 MNL-800 LonWorks Device Workflow
For more information, see section 70.10 “Editing an MNL LonWorks Application
Type” on page 2408.
Assign application to MNL-800 device
In the System Tree pane, assign the MNL application to the MNL-800 device. For
more information, see section 70.12 “Assigning an MNL LonWorks Application ” on
page 2412.
Commission MNL-800 device
Commission the MNL-800 device. Commissioning includes a partial download of
the application to give the device its device profile and program ID. For more
information, see section 69.7 “Commissioning an MNL-800 LonWorks Device” on
page 2383.
Download MNL application to device
In the System Tree pane, download the MNL application to perform a full
download of the application to the MNL-800 device. For more information, see
section 70.13 “Downloading an MNL LonWorks Application Type” on page 2413.
68.5.3 Create
Use the Create MNL-800 LonWorks Device workflow to create MNL-800 LonWorks
devices online.
Technical 04-16006-04-en, March 2015
2370
68 MNL LonWorks Introduction
68.5 MNL-800 LonWorks Device Workflow
Create a LonWorks interface
In WorkStation, create a LonWorks interface in the Enterprise Server or Automation
Server. For more information, see section 55.12 “Creating a LonWorks Interface” on
page 1993.
Create a LonWorks network
In WorkStation, create the LonWorks network on the LonWorks interface. For more
information, see section 55.15 “Creating a LonWorks Network” on page 1996.
Create an MNL-800 device and enter its Neuron ID
In WorkStation, create an MNL-800 device on the LonWorks network and then
enter its Neuron ID. For more information, see section 69.2 “Creating an MNL-800
LonWorks Device” on page 2377.
Create and edit an MNL-800 application
In the Applications view, create and edit an MNL-800 application, using
WorkPlace Tech Editor.
For more information, see section 70.7 “Creating an MNL LonWorks Application
Type” on page 2401.
For more information, see section 70.10 “Editing an MNL LonWorks Application
Type” on page 2408.
Assign application to MNL-800 device
In the System Tree pane, assign the MNL application to the MNL-800 device. For
more information, see section 70.12 “Assigning an MNL LonWorks Application ” on
page 2412.
Commission MNL-800 device
Connect the physical MNL-800 device to the Enterprise Server or Automation
Server and then commission the device. Commissioning includes a partial
download of the application to give the device its device profile and program ID. For
more information, see section 69.7 “Commissioning an MNL-800 LonWorks
Device” on page 2383.
Download MNL application to device
In the System Tree pane, download the MNL application to perform a full
download of the application to the MNL-800 device. For more information, see
section 70.13 “Downloading an MNL LonWorks Application Type” on page 2413.
04-16006-04-en, March 2015 Technical
2371
68 MNL LonWorks Introduction
68.6 Bindings for MNL LonWorks Devices
68.6 Bindings for MNL LonWorks Devices
Bindings for MNL LonWorks devices are created and viewed using the Bindings
view, in WorkStation. Use Building Operation bindings for I/O points, S-Link sensor
points, and NCIs in MNL devices. Use LonWorks bindings for NVs in MNL devices.
Caution
EEPROM, where NCI data is stored in MNL devices, supports only a finite number
of write operations. Because of this, you should not bind these NCIs to frequently
changing values in Building Operation.
68.6.1 Bindings Overview
A binding is a connection between two or more variables for data exchange. In its
simplest form, a binding consists of a source and a destination. The source supplies
the value to the destination.
For more information, see section 15.1 “Bindings Overview” on page 411.
68.6.2 LonWorks Bindings
LonWorks bindings differ from other Building Operation bindings because you can
set LonWorks specific properties, such as LonWorks binding profiles.
For more information, see section 58.1 “LonWorks Bindings ” on page 2093.
Technical 04-16006-04-en, March 2015
2372
68 MNL LonWorks Introduction
68.7 Synchronize MNL LonWorks Devices after Server Restore
68.7 Synchronize MNL LonWorks Devices
after Server Restore
Whenever you restore a server database in a system containing MNL LonWorks
devices, you need to commission all the MNL devices and download the device
configurations. You may also need to synchronize the MNL device with the server
database if changes were made to the device's application or configuration since
the time when the database backup was created.
Important
Following a server restore, you cannot determine if you need to synchronize an
MNL device with the restored database by viewing the device's Application
status property. Instead, you must determine whether any changes were made
to the device's application or configuration since the last server backup.
Complete the tasks listed in the following flowchart. Related information can be
found in the sections after the flowchart.
Figure: Synchronize MNL LonWorks device flowchart
Commission the MNL device
Commission the MNL device and then select Download current configuration
to device to download the NCI values, which in the case of a VAV device include
flow balance calibration information, from the restored database to the device.
For more information, see section 56.6 “Commissioning a LonWorks Device” on
page 2014.
For more information, see section 69.7 “Commissioning an MNL-800 LonWorks
Device” on page 2383.
04-16006-04-en, March 2015 Technical
2373
68 MNL LonWorks Introduction
68.7 Synchronize MNL LonWorks Devices after Server Restore
For more information, see section 71.15 “Flow Balance Calibration Information” on
page 2454.
Download MNL LonWorks Application Type
If the MNL device’s application has changed since the last backup, download the
application to the device.
For more information, see section 70.13 “Downloading an MNL LonWorks
Application Type” on page 2413.
Download Configuration Properties
If the MNL device’s I/O point or S-Link configuration properties have changed since
the last backup, download the configuration properties to the device.
For more information, see section 69.5 “Downloading Configuration Properties to
an MNL LonWorks Device” on page 2381.
Backup or restore S-Link offsets
If the MNL device’s S-Link offsets information has changed since the last backup,
restore or back up the values you want to keep:
• If you want to keep the values from the restored database, restore the
information to the MNL device.
For more information, see section 71.6 “Restoring S-Link Sensor Offsets” on
page 2431.
• If you want to keep the information in the MNL device, then back up the
information to the database.
For more information, see section 71.5 “Backing Up S-Link Sensor Offsets” on
page 2430.
Technical 04-16006-04-en, March 2015
2374
69 MNL LonWorks Devices
Topics
MNL LonWorks Devices
Creating an MNL-800 LonWorks Device
Discovering an MNL-800 LonWorks Device
Resetting an MNL LonWorks Device
Downloading Configuration Properties to an MNL LonWorks
Device
Commission MNL-800 LonWorks Devices
Commissioning an MNL-800 LonWorks Device
MNL LonWorks Device Functions
Schedules for MNL LonWorks Devices
Trend Logs for MNL LonWorks Devices
Alarms for MNL LonWorks Devices
69 MNL LonWorks Devices
69.1 MNL LonWorks Devices
69.1 MNL LonWorks Devices
In Building Operation documentation, the family of TAC I/A Series Lon controllers is
referred to as MNL LonWorks devices. These devices are further defined as
standard MNL LonWorks devices and MNL-800 LonWorks devices.
Table: Models of MNL LonWorks Devices
Devices Model Numbers
Standard MNL LonWorks devices MNL-5Rxx, MNL-10Rxx, MNL-11RFx, MNL-
13RFx, MNL-15Rxx, MNL-20Rxx, MNL-
V1RVx, MNL-V2RVx, and MNL-V3RVx
MNL-800 LonWorks devices MNL-800
69.1.1 Device Templates
Building Operation provides preinstalled device templates for newer MNL devices.
For older MNL devices, you must import their device templates into Building
Operation.
Table: MNL LonWorks Devices and Device Templates
Firmware Revision Numbers Workflow
Standard MNL LonWorks devices, 4.1 and Use the LonWorks procedures for creating,
higher discovering, and commissioning.
For more information, see section 68.4
“Standard MNL LonWorks Device Workflow”
on page 2360.
Standard MNL LonWorks devices, 4.0 and Use the LonWorks procedures for importing
lower a device template, and creating, discovering,
and commissioning.
For more information, see the Older MNL
LonWorks Device Workflow topic on
WebHelp.
MNL-800 LonWorks devices, 2.0 and higher Use the MNL-800 LonWorks procedures for
creating, discovering, and commissioning.
For more information, see section 68.5
“MNL-800 LonWorks Device Workflow” on
page 2365.
MNL-800 LonWorks devices, 1.x Use the LonWorks procedures for importing
a device template, and creating, discovering,
and commissioning.
For more information, see the Older MNL
LonWorks Device Workflow topic on
WebHelp.
04-16006-04-en, March 2015 Technical
2377
69 MNL LonWorks Devices
69.1 MNL LonWorks Devices
Firmware Revision Numbers Workflow
69.1.2 MNL Device Model and Firmware Revision
When viewing MNL LonWorks devices in the Device Discovery view, extended
information is displayed.
Figure: MNL LonWorks device information
Model Number
The model number of the MNL device, which identifies the device's hardware
platform, LonMark profile type, and profile version number, for example, "MNL-
V2RV3."
Firmware Revision
The revision number of the MNL device's firmware, for example, "Rev 4.1."
Unconfigured MNL Device
If an MNL device's information does not include the model number or the firmware
revision, this indicates that the MNL device is in an unconfigured state. Adding the
device to the system depends on the device type.
• For standard MNL devices with firmware revisions 4.1 and later, use the Create
method of the device workflow to add the device to the system.
For more information, see section 68.4 “Standard MNL LonWorks Device
Workflow” on page 2360.
• For MNL-800 devices with firmware revisions 2.0 and later, you can add the
device to the system using any of the methods described in the MNL-800
workflow, even when the device is in an unconfigured state.
For more information, see section 68.5 “MNL-800 LonWorks Device Workflow”
on page 2365.
Technical 04-16006-04-en, March 2015
2378
69 MNL LonWorks Devices
69.2 Creating an MNL-800 LonWorks Device
69.2 Creating an MNL-800 LonWorks Device
You create MNL-800 LonWorks devices under the LonWorks network to connect
to physical MNL LonWorks devices.
To create an MNL-800 LonWorks device
1. In WorkStation, in the System Tree pane, select the LonWorks network
where you want to create the device.
2. On the File menu, point to New and then click Device.
3. In the object type list, select MNL-800.
4. In the Name box, type a name for the device.
5. In the Description box, type a description for the device.
6. Click Create.
You now assign an application to the MNL-800 LonWorks device and then
commission the device.
04-16006-04-en, March 2015 Technical
2379
69 MNL LonWorks Devices
69.3 Discovering an MNL-800 LonWorks Device
69.3 Discovering an MNL-800 LonWorks
Device
You discover MNL-800 LonWorks devices to create or configure the MNL devices
in the Building Operation server. The MNL devices must be physically connected to
the Building Operation server fieldbus.
To discover MNL-800 LonWorks devices
1. In WorkStation, in the System Tree pane, select the server that is connected
to the devices that you want to discover.
2. Click the Device Discovery view.
3. In the Select device type box, select LonWorks.
4. Select the Devices folder.
5. On the Actions menu, click Activate listen to service pin.
6. Briefly press the service pin on the device.
Caution
Do not press the service pin for 8 seconds or longer. Pressing the
service pin for 8 seconds or longer causes the MNL device to
become unconfigured.
7. In the Device Discovery view, ensure that the MNL device is displayed in the
Devices folder. This may take up to 5 seconds.
Note
If a discovered device does not show its model number and firmware
revision, the device is unconfigured. Configure the device and then
repeat the device discovery process.
For more information, see section 69.1 “MNL LonWorks Devices” on
page 2375.
Continued on next page
Technical 04-16006-04-en, March 2015
2380
69 MNL LonWorks Devices
69.3 Discovering an MNL-800 LonWorks Device
8. On the Actions menu, click Deactivate listen to service pin.
9. Drag the discovered MNL device from the Device Discovery view to the
MNL device in the System Tree pane.
Note
To verify the Neuron ID of the device, select the device in the
System Tree pane and then select Properties on the File menu.
You will find the Neuron ID on the Basic tab of the device properties
view.
04-16006-04-en, March 2015 Technical
2381
69 MNL LonWorks Devices
69.4 Resetting an MNL LonWorks Device
69.4 Resetting an MNL LonWorks Device
You reset an MNL LonWorks device to clear values written to RAM in WorkPlace
Tech Monitor. Resetting a device also implements changes you have made to the
sensor type property of an analog input point in an MNL-800 LonWorks device.
To reset an MNL LonWorks device
1. In WorkStation, in the System Tree pane, select the MNL LonWorks device.
2. On the Actions menu, point to MNL and then click Reset device.
Caution
Resetting an MNL LonWorks device causes its outputs to cycle off
and its application to restart.
3. Click Yes.
Technical 04-16006-04-en, March 2015
2382
69 MNL LonWorks Devices
69.5 Downloading Configuration Properties to an MNL LonWorks Device
69.5 Downloading Configuration Properties
to an MNL LonWorks Device
You download configuration properties to an MNL LonWorks device to update the
device with changes to the configuration properties of I/O points and S-Link sensor
points.
This can be useful when you want to update only the device configuration in the
MNL device or the Application object in the database, without affecting the device
configuration in the application type.
For more information, see section 70.3 “Application Status” on page 2395.
To download configuration properties to an MNL LonWorks
device
1. In WorkStation, in the System Tree pane, select the MNL device that you
want to download configuration properties to.
2. On the Actions menu, point to MNL and then click Download
configuration properties.
The configuration properties in the MNL LonWorks device are now synchronized
with the corresponding properties in the Building Operation database.
04-16006-04-en, March 2015 Technical
2383
69 MNL LonWorks Devices
69.6 Commission MNL-800 LonWorks Devices
69.6 Commission MNL-800 LonWorks
Devices
You commission an MNL LonWorks device to assign it an address and activate it in
the network.
Commissioning an MNL-800 device is the same as commissioning any LonWorks
device, with two exceptions.
• In order for the Commissioning command to be enabled, you must first
assign an application to the MNL-800 device.
• When you start the commissioning process, the system first initializes the MNL-
800 by downloading a portion of the application to the device. This is done to
ensure that the MNL-800 has a device profile and program ID that will match
the application, which is downloaded later in the process.
For more information, see section 69.7 “Commissioning an MNL-800 LonWorks
Device” on page 2383.
Technical 04-16006-04-en, March 2015
2384
69 MNL LonWorks Devices
69.7 Commissioning an MNL-800 LonWorks Device
69.7 Commissioning an MNL-800 LonWorks
Device
You commission the physical MNL-800 LonWorks devices to give them their
addresses, which are defined in the MNL-800 LonWorks devices in the Building
Operation server. The commission enables the devices to communicate on the
LonWorks network.
For more information, see section 69.6 “Commission MNL-800 LonWorks Devices”
on page 2382.
To commission an MNL-800 LonWorks device
1. In WorkStation, in the System Tree pane, select the MNL-800 device.
2. On the Actions menu, click Commission.
3. In the Neuron ID box, make sure that the correct Neuron ID is entered.
4. Select Commission.
5. Select which configuration to use:
• Select Keep current configuration in the device to leave the
configuration in the device as is.
• Select Download current configuration to device to use the current
configuration and download it to the device upon commission.
• Select Download default configuration to device to use the default
configuration from the device template.
• Select Upload configuration from device to use the current
configuration in the device.
6. Click Commission.
04-16006-04-en, March 2015 Technical
2385
69 MNL LonWorks Devices
69.8 MNL LonWorks Device Functions
69.8 MNL LonWorks Device Functions
Many of the functions and features of MNL LonWorks devices are supported in
Building Operation. For example, Building Operation provides support for all NCIs,
NVIs, and NVOs specified in the MNL LonWorks devices' respective LonMark
profiles.
In Building Operation, standard MNL LonWorks devices and MNL-800 LonWorks
devices have the following additional functions:
• In the MNL application, select properties of I/O point objects connected to I/O
resource tags are exposed without the need to connect SNVTs for that
purpose.
• Configuration of I/O points. For more information, see section 71.1 “MNL
LonWorks Objects” on page 2421.
• Configuration changes to individual I/O objects can be applied without the
need to recompile and download the entire MNL device application.
• Values of select I/O points can be forced. For more information, see section
71.10 “Forceable MNL I/O Point Properties” on page 2436.
• Support for public types, which allow one application to be applied to multiple
MNL devices.
• I/O points related to S-Link sensors can be configured.
• Inclusion of the associated application when an MNL device object is copied,
moved, imported, or exported.
• On-site storage of WorkPlace Tech Editor application drawings, in the Building
Operation server databases.
MNL-800 LonWorks devices in Building Operation have the following additional
functions:
• Calculation and enforcement of unique program IDs for the MNL-800
applications. The program ID is no longer defined by the the user.
69.8.1 Alarms for MNL LonWorks Devices
Building Operation alarms for MNL LonWorks devices are created and viewed in
WorkStation.
For more information, see section 69.11 “Alarms for MNL LonWorks Devices” on
page 2388.
69.8.2 Trend Logs for MNL LonWorks Devices
Building Operation trend logs for MNL LonWorks devices are created and viewed in
WorkStation.
For more information, see section 69.10 “Trend Logs for MNL LonWorks Devices”
on page 2387.
Technical 04-16006-04-en, March 2015
2386
69 MNL LonWorks Devices
69.8 MNL LonWorks Device Functions
69.8.3 Schedules for MNL LonWorks Devices
You can create schedules for MNL LonWorks devices two ways.
For more information, see section 69.9 “Schedules for MNL LonWorks Devices” on
page 2386.
69.8.4 Properties of MNL LonWorks Objects
You configure the properties of various MNL LonWorks objects to set or change the
behavior of these objects.
For more information, see section 71.7 “Properties of MNL LonWorks Objects” on
page 2432.
04-16006-04-en, March 2015 Technical
2387
69 MNL LonWorks Devices
69.9 Schedules for MNL LonWorks Devices
69.9 Schedules for MNL LonWorks Devices
You can create schedules for MNL LonWorks devices two ways.
• Use WorkStation to create, view, and modify Building Operation schedules for
MNL LonWorks devices. You use LonWorks bindings to associate Building
Operation schedules with NVIs and NVOs in the MNL devices.
• You can use WorkPlace Tech Editor to create built-in schedules that reside
locally in MNL LonWorks devices. Built-in schedules are used as fallback
schedules at times when communication is lost between the MNL devices and
the Automation Server. By creating a built-in schedule in an application type,
the schedule becomes available in all application objects of this type.
WorkPlace Tech Tool 4.0 Users Guide (F-27255)
WorkPlace Tech Tool 4.0 Engineering Guide (F-27254)
Technical 04-16006-04-en, March 2015
2388
69 MNL LonWorks Devices
69.10 Trend Logs for MNL LonWorks Devices
69.10 Trend Logs for MNL LonWorks Devices
Building Operation trend logs for MNL LonWorks devices are created and viewed in
WorkStation.
The MNL devices do not contain trend logs. Instead, you use bindings to associate
the Building Operation trend logs with NVs or I/O points in the MNL LonWorks
devices.
For more information, see the How Trends Work topic on WebHelp.
69.10.1 Trend Logs from NVs
You can use LonWorks bindings to associate Building Operation trends with NVIs
and NVOs in the MNL devices.
WorkPlace Tech Editor and Monitor Engineering Guide Supplement (F-27745)
69.10.2 Trend Logs from I/O Points
You can use Building Operation bindings to associate Building Operation trends
with I/O points in the MNL devices.
04-16006-04-en, March 2015 Technical
2389
69 MNL LonWorks Devices
69.11 Alarms for MNL LonWorks Devices
69.11 Alarms for MNL LonWorks Devices
Building Operation alarms for MNL LonWorks devices are created and viewed in
WorkStation.
The MNL devices do not contain alarms. Instead, you use LonWorks bindings to
associate the Building Operation alarms with NVIs and NVOs in the MNL LonWorks
devices.
Technical 04-16006-04-en, March 2015
2390
70 MNL LonWorks Applications
Topics
MNL LonWorks Applications
Changes to Applications
Application Status
WorkPlace Tech Overview
WorkPlace Tech Editor
Viewing an MNL LonWorks Application Type
Creating an MNL LonWorks Application Type
Importing a Single MNL LonWorks Application Type
Importing Multiple MNL LonWorks Application Types
Editing an MNL LonWorks Application Type
Removing an MNL LonWorks Application Type
Assigning an MNL LonWorks Application
Downloading an MNL LonWorks Application Type
Editing an MNL LonWorks Application Type in a Device
WorkPlace Tech Monitor
Monitoring an MNL LonWorks Application
Import and Export of MNL LonWorks Solutions
70 MNL LonWorks Applications
70.1 MNL LonWorks Applications
70.1 MNL LonWorks Applications
There are two types of MNL LonWorks devices, each with a different type of
application:
• Standard MNL LonWorks devices have standard LonMark network profiles.
• MNL-800 LonWorks devices have applications with network profiles that are
fully customizable, through the use of SNVTs.
WorkPlace Tech Editor and Monitor Engineering Guide Supplement (F-27745)
In Building Operation, applications exist as application types and Application
objects (instances).
Application types contain the control logic used in an MNL device. You can view the
MNL application types that are available in Building Operation in the Applications
view.
For example, you can view an application type compatible with MNL-20RS4
devices, named mnl-20rs4-BasicIO, in the Applications view, together with other
MNL application types that have been created in, or imported into, Building
Operation.
Figure: MNL application type
When you assign an application type to an MNL device, an Application object is
created in the System Tree pane.
For example, when you assign “mnl-20rs4-BasicIO” to a compatible device, such
as MNL-20RS4, Application is created in the System Tree pane.
04-16006-04-en, March 2015 Technical
2393
70 MNL LonWorks Applications
70.1 MNL LonWorks Applications
Figure: Application object in System Tree pane
At the device level, each MNL device has an application that contains a variety of
objects, including physical I/O point objects, S-Link objects, and SNVT objects.
Important
In Building Operation, use WorkStation to download MNL device applications. Do
not use WorkPlace Tech Tool 5.x to download an MNL device that has already
been assigned an application in Building Operation.
70.1.1 Changes to Applications
When you save changes to an MNL LonWorks application type in WorkPlace Tech
Editor, the changes are automatically made to all the Application objects that
were created from that type.
In the System Tree pane, the affected MNL LonWorks devices have an icon that
indicates they need an application download.
For more information, see section 70.2 “Changes to Applications” on page 2394.
70.1.2 Application Status
Applications in MNL LonWorks devices can have any one of five statuses, as
indicated in the Advanced properties tab of the MNL device.
For more information, see section 70.3 “Application Status” on page 2395.
Technical 04-16006-04-en, March 2015
2394
70 MNL LonWorks Applications
70.1 MNL LonWorks Applications
70.1.3 WorkPlace Tech Overview
The WorkPlace Tech component of Building Operation WorkStation consists of two
graphical tools: WorkPlace Tech Monitor and WorkPlace Tech Editor. With these
tools you can view, examine, and program MNL LonWorks device applications.
For more information, see section 70.4 “WorkPlace Tech Overview” on page 2396.
70.1.4 Import and Export of MNL LonWorks
Applications
In Building Operation there are two ways to import and export MNL LonWorks
applications.
Import and Export Using WorkStation
In Building Operation, you can use WorkStation to export MNL LonWorks devices
and Application objects as solutions. A solution can be imported any number of
times in other Building Operation servers where needed, thus reducing duplication
of effort.
For more information, see section 70.17 “Import and Export of MNL LonWorks
Solutions” on page 2418.
Import and Export Using WorkPlace Tech Editor
You can use WorkPlace Tech Editor to export an MNL LonWorks application as a
Visio drawing. Once the Visio drawing is created, it can be imported into other
Building Operation servers as an application type, using WorkPlace Tech Editor.
For more information, see section 70.8 “Importing a Single MNL LonWorks
Application Type” on page 2403.
For more information, see section 70.9 “Importing Multiple MNL LonWorks
Application Types” on page 2406.
WorkPlace Tech Editor and Monitor Engineering Guide Supplement (F-27745)
04-16006-04-en, March 2015 Technical
2395
70 MNL LonWorks Applications
70.2 Changes to Applications
70.2 Changes to Applications
When you save changes to an MNL LonWorks application type in WorkPlace Tech
Editor, the changes are automatically made to all the Application objects that
were created from that type.
For each of those devices, you must download the application to the physical
device so that the changes take effect.
MNL-800 Applications
For the most part, the propagation of changes from MNL-800 application types to
their associated Application objects is automated, as is the case with standard
MNL devices. However, MNL-800 applications have customizable network profiles
that require additional steps whenever you save changes that alter an MNL-800
application type’s network profile:
• Changes to SNVT names
• Changes to NV indexes
• Additions or deletions of SNVT objects or tags
If you save changes to an MNL-800 application type’s profile, the system assigns a
new program ID to the application. When the application type has associated
Application objects, the type’s program ID no longer matches the program ID of
those objects. To synchronize the program IDs, you must download the affected
MNL devices and then commission them.
Another consequence of saving changes to an application type’s profile is that by
propagating those changes to the Application objects, you could affect the
external LonWorks network bindings that come from those Application objects.
Technical 04-16006-04-en, March 2015
2396
70 MNL LonWorks Applications
70.3 Application Status
70.3 Application Status
Applications in MNL LonWorks devices can have any one of five statuses, as
indicated in the Advanced properties tab of the MNL device.
• Normal: The application is synchronized with the server.
• Application download required: No application is assigned to the MNL
LonWorks device, or an application has been assigned or modified since the
last download to this device.
• Reset required: Configuration changes have been made to the application.
The device needs to be reset for these changes to take effect.
• Configuration properties download required: Configuration changes
have been made to the application. The configuration properties need to be
downloaded for these changes to take effect.
• Config properties download and reset required: Configuration changes
have been made to the application. The configuration properties need to be
downloaded and then the device needs to be reset for these changes to take
effect.
04-16006-04-en, March 2015 Technical
2397
70 MNL LonWorks Applications
70.4 WorkPlace Tech Overview
70.4 WorkPlace Tech Overview
The WorkPlace Tech component of Building Operation WorkStation consists of two
graphical tools: WorkPlace Tech Monitor and WorkPlace Tech Editor. With these
tools you can view, examine, and program MNL LonWorks device applications.
Both tools are installed when you select the WorkPlace Tech check box on the
Choose Components page of the WorkStation installation wizard.
70.4.1 WorkPlace Tech Editor
You use WorkPlace Tech Editor to program, modify, and compile control
applications for MNL LonWorks devices.
For more information, see section 70.5 “WorkPlace Tech Editor” on page 2397.
70.4.2 MNL LonWorks Objects
MNL LonWorks objects are translated into Building Operation I/O points, Sensor
object, and S-Link sensor points.
For more information, see section 71.1 “MNL LonWorks Objects” on page 2421.
70.4.3 WorkPlace Tech Monitor
You use WorkPlace Tech Monitor to verify and troubleshoot control applications for
MNL LonWorks devices in real time.
For more information, see section 70.15 “WorkPlace Tech Monitor” on page 2415.
Technical 04-16006-04-en, March 2015
2398
70 MNL LonWorks Applications
70.5 WorkPlace Tech Editor
70.5 WorkPlace Tech Editor
You use WorkPlace Tech Editor to program, modify, and compile control
applications for MNL LonWorks devices.
WorkPlace Tech Editor uses a Microsoft Visio drawing interface, and can be used
with Visio 2010 SP1, Visio 2007 SP2, or Visio 2003 SP3. In WorkPlace Tech Editor,
you create new applications, modify and compile existing applications, import
applications into Building Operation, and export applications as Visio files.
Figure: The WorkPlace Tech Editor interface
Important
When Visio 2007 is installed on a Windows Server 2012 system or a Windows
Server 2012 R2 system, you must add .NET Framework 3.5 in order to ensure
the proper function of WorkPlace Tech Editor and Monitor.
WorkPlace Tech Editor and Monitor Engineering Guide Supplement (F-27745) for
a procedure for installing Visio 2007 on Windows Server 2012.
Important
Where multiple versions of Microsoft Visio are installed, the last-run version of
Visio must be compatible with the version of WorkPlace Tech Editor or Monitor
you wish to start. If WorkPlace Tech Editor or Monitor does not start, close any
sessions of Visio that are open. Next, open and then close a compatible version
of Visio, and then start WorkPlace Tech Editor or Monitor. To identify the version
of Visio or WorkPlace Tech Editor or Monitor you are running, click the
appropriate About option in the Help menu.
WorkPlace Tech Editor and Monitor Engineering Guide Supplement (F-27745) for
a troubleshooting procedure addressing the inability of WorkPlace Tech Editor or
Monitor to start due to an incompatible version of Visio.
70.5.1 Hardware Configuration
You use the Hardware Wizard to modify an application’s hardware configuration.
WorkPlace Tech Tool 4.0 Engineering Guide (F-27254)
04-16006-04-en, March 2015 Technical
2399
70 MNL LonWorks Applications
70.5 WorkPlace Tech Editor
WorkPlace Tech Tool 4.0 Users Guide (F-27255)
70.5.2 Applications
Applications are displayed in the Visio interface as control logic drawings (also
known as application drawings) that represent an MNL device's control logic. For
more information, see section 70.1 “MNL LonWorks Applications” on page 2391.
70.5.3 I/O Control Objects and Tags
You construct the control logic by linking various Visio shapes that function as
I/O points, control objects, and tags.
Monitor tags are not active in WorkPlace Tech Editor. To view real-time data on
monitor tags, you open the control logic drawing in WorkPlace Tech Monitor.
WorkPlace Tech Editor and Monitor Engineering Guide Supplement (F-27745)
70.5.4 Application Import
You use the Import Wizard to import existing WorkPlace Tech applications into the
Building Operation system. This allows you to reuse previously created applications,
saving engineering time and effort.
Important
Applications must be from WorkPlace Tech version 4.0 or later, in order to be
imported into Building Operation.
WorkPlace Tech Editor and Monitor Engineering Guide Supplement (F-27745)
70.5.5 Application Compile
When you have finished creating or editing an application in WorkPlace Tech Editor,
you compile the control logic drawing. A compiled application can be used in one or
more devices of the same type.
WorkPlace Tech Editor and Monitor Engineering Guide Supplement (F-27745)
70.5.6 Application Export
You can save a copy of an MNL device application drawing as a Microsoft Visio file.
This makes the drawing available for use in WorkPlace Tech, outside the Building
Operation environment.
WorkPlace Tech Editor and Monitor Engineering Guide Supplement (F-27745)
Technical 04-16006-04-en, March 2015
2400
70 MNL LonWorks Applications
70.6 Viewing an MNL LonWorks Application Type
70.6 Viewing an MNL LonWorks Application
Type
You view an MNL LonWorks application type in WorkPlace Tech Editor to see the
application's sequence of operation.
To view an MNL LonWorks application type
1. In WorkStation, on the Tools menu, click Control Panel.
2. On the Control Panel toolbar, select the server.
3. Click WorkPlace Tech Editor.
Continued on next page
04-16006-04-en, March 2015 Technical
2401
70 MNL LonWorks Applications
70.6 Viewing an MNL LonWorks Application Type
4. In the Applications view, double-click the application type that you want to
view.
You can now view and edit the application type in WorkPlace Tech Editor.
Caution
Do not open more than 10 applications concurrently in WorkPlace Tech Editor.
Opening more than 10 applications concurrently can cause an exception error,
and unsaved changes may be lost.
Technical 04-16006-04-en, March 2015
2402
70 MNL LonWorks Applications
70.7 Creating an MNL LonWorks Application Type
70.7 Creating an MNL LonWorks Application
Type
You use WorkPlace Tech Editor to create an MNL LonWorks application type so
the new application type is available to assign to MNL LonWorks devices.
For more information, see section 70.5 “WorkPlace Tech Editor” on page 2397.
To create an MNL LonWorks application type
1. In WorkStation, on the Tools menu, click Control Panel.
2. On the Control Panel toolbar, select the server.
3. Click WorkPlace Tech Editor.
Continued on next page
04-16006-04-en, March 2015 Technical
2403
70 MNL LonWorks Applications
70.7 Creating an MNL LonWorks Application Type
4. Click the Add an Application button .
5. In the MNL device list box, select the MNL device model.
6. In WorkPlace Tech Editor, create a new application.
7. On the File menu, click Save.
8. In the Enter a name for this application box, type a name for the
application.
9. In the Enter a description for this application box, type a description for
the application.
10. In the Enter a category for this application box, type a category for the
application.
11. Click OK.
You can view the new application type in the WorkPlace Tech Applications view in
WorkStation. The application type is now available to assign to MNL LonWorks
devices.
Technical 04-16006-04-en, March 2015
2404
70 MNL LonWorks Applications
70.8 Importing a Single MNL LonWorks Application Type
70.8 Importing a Single MNL LonWorks
Application Type
You use WorkPlace Tech Editor to import an MNL LonWorks application type into
the Building Operation database so the new application type is available to assign
to MNL LonWorks devices.
Important
Applications must be from WorkPlace Tech version 4.0 or later, in order to be
imported into the Building Operation database.
For more information, see section 70.5 “WorkPlace Tech Editor” on page 2397.
To import a single MNL LonWorks application type
1. In WorkStation, on the Tools menu, click Control Panel.
2. On the Control Panel toolbar, select the server.
3. Click WorkPlace Tech Editor.
Continued on next page
04-16006-04-en, March 2015 Technical
2405
70 MNL LonWorks Applications
70.8 Importing a Single MNL LonWorks Application Type
4. Click the Add an Application button .
5. In the MNL device list box, select the MNL device model.
6. In WorkPlace Tech Editor, on the Application menu, click Import Wizard.
7. On the Input File Selection page, read the information and then click Next.
8. In the Select WorkPlace Tech File to Import dialog box, select the
application (.vsd) file to be imported.
9. Click Open.
10. On the Application menu, click Hardware Wizard.
11. In the Hardware Wizard, on the Controller Selection page, make sure the
correct hardware type is selected.
Important
In WorkPlace Tech Editor, you can only change the hardware type of
a new application before saving the application to the Building
Operation database.
Tip
If you have saved the new application and then want to change the
hardware type, first create a copy of the application by selecting
Copy Application on the Application menu, and then select a
different hardware type.
12. On the File menu, click Save.
Continued on next page
Technical 04-16006-04-en, March 2015
2406
70 MNL LonWorks Applications
70.8 Importing a Single MNL LonWorks Application Type
13. In the Enter a name for this application box, type a name for the
application.
14. In the Enter a description for this application box, type a description for
the application.
15. In the Enter a category for this application box, type a category for the
application.
16. Click OK.
You can view the new application type in the WorkPlace Tech Applications view in
WorkStation. The application type is now available to assign to MNL LonWorks
devices.
04-16006-04-en, March 2015 Technical
2407
70 MNL LonWorks Applications
70.9 Importing Multiple MNL LonWorks Application Types
70.9 Importing Multiple MNL LonWorks
Application Types
You use WorkPlace Tech Editor to import two or more MNL LonWorks application
types into the Building Operation database so the new application types are
available to assign to MNL LonWorks devices.
Important
Applications must be from WorkPlace Tech version 4.0 or later, in order to be
imported into the Building Operation database.
For more information, see section 70.5 “WorkPlace Tech Editor” on page 2397.
To import multiple MNL LonWorks application types
1. In WorkStation, on the Tools menu, click Control Panel.
2. On the Control Panel toolbar, select the server.
3. Click WorkPlace Tech Editor.
Continued on next page
Technical 04-16006-04-en, March 2015
2408
70 MNL LonWorks Applications
70.9 Importing Multiple MNL LonWorks Application Types
4. Click the Add an Application button .
5. In the MNL device list box, select the MNL device model.
6. In WorkPlace Tech Editor, on the Application menu, click Import Wizard.
7. On the Input File Selection page, read the information and then click Next.
8. In the Select WorkPlace Tech File to Import dialog box, select the
application (.vsd) files to be imported.
Important
Application file names may only contain digits 1 through 9,
uppercase letters A through Z, lowercase letters a through z, hyphen
(-) and underscore (_), in order to be imported into the Building
Operation database.
Note
Duplicate application names are appended with an underscore
followed by a number when imported into the Building Operation
database.
9. Click Open.
10. On the Ready to Import page, verify the number of files that will be imported
and then click Next.
Note
If the Import Wizard pauses and displays a message during the
import process, click OK to proceed.
11. Review the import log file and then click Finish.
You can view the new application types in the WorkPlace Tech Applications view in
WorkStation. The application types are now available to assign to MNL LonWorks
devices.
04-16006-04-en, March 2015 Technical
2409
70 MNL LonWorks Applications
70.10 Editing an MNL LonWorks Application Type
70.10 Editing an MNL LonWorks Application
Type
You edit an MNL LonWorks application type from the Applications view when you
want to modify the application's sequence of operation and you don't know which
MNL LonWorks devices use that application type.
To edit an MNL LonWorks application type
1. In WorkStation, in the Tools menu, click Control Panel.
2. On the Control Panel toolbar, select the server.
3. Click WorkPlace Tech Editor.
Continued on next page
Technical 04-16006-04-en, March 2015
2410
70 MNL LonWorks Applications
70.10 Editing an MNL LonWorks Application Type
4. In the Applications view, select the application type.
5. Click the Edit an application button.
6. In WorkPlace Tech Editor, edit and save the application type.
For more information, see section 70.5 “WorkPlace Tech Editor” on page
2397.
For each device that uses the edited application type, you now download the
application type to the physical device so that the changes take effect.
04-16006-04-en, March 2015 Technical
2411
70 MNL LonWorks Applications
70.11 Removing an MNL LonWorks Application Type
70.11 Removing an MNL LonWorks
Application Type
You remove an MNL LonWorks application type from the system when you no
longer need the application.
To remove an MNL LonWorks application type
1. In WorkStation, in the System Tree pane, delete any Application objects
that are associated with the application type you want to delete.
2. On the Tools menu, click Control Panel.
3. On the Control Panel toolbar, select the server.
4. Click WorkPlace Tech Editor.
Continued on next page
Technical 04-16006-04-en, March 2015
2412
70 MNL LonWorks Applications
70.11 Removing an MNL LonWorks Application Type
5. In the Applications view, select the application type.
6. Click the Remove an Application button .
04-16006-04-en, March 2015 Technical
2413
70 MNL LonWorks Applications
70.12 Assigning an MNL LonWorks Application
70.12 Assigning an MNL LonWorks Application
You assign an application to an MNL LonWorks device to specify which application
type the device will use.
For more information, see section 70.1 “MNL LonWorks Applications” on page
2391.
To assign an MNL LonWorks application
1. In WorkStation, in the System Tree pane, select an MNL LonWorks device.
2. On the Actions menu, point to MNL and then click Assign application.
3. When assigning an MNL-800 application, select Only show MNL-800
applications with the same program ID as the selected device to
make it easier to select an application that is appropriate for an MNL-800
device.
4. In the list of applications, select an application.
5. In the Description box, type a description of the application.
6. Click Assign.
Technical 04-16006-04-en, March 2015
2414
70 MNL LonWorks Applications
70.13 Downloading an MNL LonWorks Application Type
70.13 Downloading an MNL LonWorks
Application Type
You download an application type to an MNL LonWorks device to load the device
with its assigned application.
Important
In Building Operation, use WorkStation to download MNL device applications. Do
not use WorkPlace Tech Tool 5.x to download an MNL device that has already
been assigned an application in Building Operation.
To download an MNL LonWorks application type
1. In WorkStation, in the System Tree pane, select the MNL LonWorks device
that you want to download the application to.
Warning
Prior to application download, manually override any critical
equipment that is controlled by outputs on the affected field devices.
When the download completes, the devices are reset and all outputs
are turned off until the application restarts, removing any software
overrides (forced values) that were in effect before the download.
Such overrides may be in place while service is being performed on
the equipment, and their inadvertent removal can result in personal
injury or equipment damage.
2. On the Actions menu, point to MNL and then click Download application.
04-16006-04-en, March 2015 Technical
2415
70 MNL LonWorks Applications
70.14 Editing an MNL LonWorks Application Type in a Device
70.14 Editing an MNL LonWorks Application
Type in a Device
You edit an application type in an MNL LonWorks device object when you want to
modify the application's sequence of operation and you know a device that uses
the application type.
To edit an MNL LonWorks application type in a device
1. In WorkStation, in the System Tree pane, expand an MNL device that
contains the application you want to edit.
2. Select Application.
3. On the Actions menu, click Edit.
4. In WorkPlace Tech Editor, edit and save the application.
For more information, see section 70.5 “WorkPlace Tech Editor” on page
2397.
For each device that uses the edited application type, you now download the
application type to the physical MNL device so that the changes take effect.
Technical 04-16006-04-en, March 2015
2416
70 MNL LonWorks Applications
70.15 WorkPlace Tech Monitor
70.15 WorkPlace Tech Monitor
You use WorkPlace Tech Monitor to verify and troubleshoot control applications for
MNL LonWorks devices in real time.
WorkPlace Tech Monitor uses a Microsoft Visio drawing interface, and can be used
with Visio 2010 SP1, Visio 2007 SP2, or Visio 2003 SP3. When you open an
application in WorkPlace Tech Monitor, you are automatically connected to the
MNL device. You can view real-time values with monitor tags and temporarily write
fixed values to the device's RAM, using constant tags. Using WorkPlace Tech
Monitor, you can also monitor multiple devices simultaneously.
Figure: The WorkPlace Tech Monitor interface
Important
When Visio 2007 is installed on a Windows Server 2012 system or a Windows
Server 2012 R2 system, you must add .NET Framework 3.5 in order to ensure
the proper function of WorkPlace Tech Editor and Monitor.
WorkPlace Tech Editor and Monitor Engineering Guide Supplement (F-27745) for
a procedure for installing Visio 2007 on Windows Server 2012.
Important
Where multiple versions of Microsoft Visio are installed, the last-run version of
Visio must be compatible with the version of WorkPlace Tech Editor or Monitor
you wish to start. If WorkPlace Tech Editor or Monitor does not start, close any
sessions of Visio that are open. Next, open and then close a compatible version
of Visio, and then start WorkPlace Tech Editor or Monitor. To identify the version
of Visio or WorkPlace Tech Editor or Monitor you are running, click the
appropriate About option in the Help menu.
WorkPlace Tech Editor and Monitor Engineering Guide Supplement (F-27745) for
a troubleshooting procedure addressing the inability of WorkPlace Tech Editor or
Monitor to start due to an incompatible version of Visio.
04-16006-04-en, March 2015 Technical
2417
70 MNL LonWorks Applications
70.15 WorkPlace Tech Monitor
70.15.1 Monitor Tags
In WorkPlace Tech Monitor, you can use monitor tags to view real-time data and
use that information to verify or troubleshoot an application. Monitor tags you add in
WorkPlace Tech Monitor are not saved with the application. If you wish to add and
save monitor tags with the application drawing, you must do so in WorkPlace Tech
Editor.
WorkPlace Tech Editor and Monitor Engineering Guide Supplement (F-27745)
70.15.2 Write to RAM
In WorkPlace Tech Monitor, you can temporarily write fixed values to the MNL
device's RAM, using constant tags. Using write-to-RAM, you can quickly make
these changes while connected to the MNL device, without having to recompile or
download the entire application. Using monitor tags, you can then view the results
of the revised constants to verify whether the expected effects were achieved. This
can be useful when diagnosing an application online. Constant tags you add or
modify in WorkPlace Tech Monitor are not saved with the drawing.
Important
Values written to RAM are only temporarily retained in the MNL device. Such
values are cleared when the MNL device is reset, or its application is downloaded.
To make permanent changes, use WorkPlace Tech Editor.
WorkPlace Tech Editor and Monitor Engineering Guide Supplement (F-27745)
Technical 04-16006-04-en, March 2015
2418
70 MNL LonWorks Applications
70.16 Monitoring an MNL LonWorks Application
70.16 Monitoring an MNL LonWorks
Application
You use WorkPlace Tech Monitor to view an application in an MNL LonWorks
device and monitor its output values in real time, or to write to fixed-value inputs
using the write-to-RAM function. You can view multiple applications simultaneously.
For more information, see section 70.15 “WorkPlace Tech Monitor” on page 2415.
Monitoring an MNL LonWorks application
1. In WorkStation, in the System Tree pane, select an MNL LonWorks device
with the application that you want to monitor.
2. On the Actions menu, point to MNL and then click Launch WorkPlace
Tech Monitor.
You can now use WorkPlace Tech Monitor to view and monitor the application, or
perform the write-to-RAM function.
04-16006-04-en, March 2015 Technical
2419
70 MNL LonWorks Applications
70.17 Import and Export of MNL LonWorks Solutions
70.17 Import and Export of MNL LonWorks
Solutions
In Building Operation, you can use WorkStation to export MNL LonWorks devices
and Application objects as solutions. A solution can be imported any number of
times in other Building Operation servers where needed, thus reducing duplication
of effort.
For more information, see section 18.1 “Import and Export Overview” on page 557.
70.17.1 Exporting an MNL LonWorks Solution
You use WorkStation to export an MNL LonWorks device or Application object as
an MNL LonWorks solution so that it can be reused in other Building Operation
servers. When you export an MNL LonWorks Application object, the corresponding
MNL LonWorks application type is automatically included in the solution file.
For more information, see section 18.3 “Exporting a Solution” on page 561.
70.17.2 Importing an MNL LonWorks Solution
You use WorkStation to import an MNL LonWorks solution that was created or
modified on another Building Operation server.
For more information, see section 18.27 “Importing a Solution” on page 594.
Caution
If a name conflict occurs during the import process, proceed with caution. It is
possible that the existing application type and the application type in the solution
file are not identical. In such a case, the Application objects that are created
during import may not contain all the attributes of the original Application
objects on the source server.
For more information, see section 158.21 “Name Conflicts During MNL LonWorks
Solution Import” on page 5619.
Caution
If a name conflict occurs during the import process, and the MNL device model
number is different between the existing application type and the application type
in the solution file, do not proceed with the import. Instead, use WorkPlace Tech
Editor to import the original application type from which the solution was created
and then save it with a different name.
For more information, see section 70.8 “Importing a Single MNL LonWorks
Application Type” on page 2403.
WorkPlace Tech Editor and Monitor Engineering Guide Supplement (F-27745)
Technical 04-16006-04-en, March 2015
2420
71 MNL LonWorks Objects
Topics
MNL LonWorks Objects
I/O Points
S-Link Sensors
Calibrating S-Link Sensors
Backing Up S-Link Sensor Offsets
Restoring S-Link Sensor Offsets
Properties of MNL LonWorks Objects
NCI Values
Reverting to the Application Value for NCI Downloads
Forceable MNL I/O Point Properties
Displayed Value of Forced MNL I/O Point
Not Active (NA) Property Values
Not Active (NA) SNVT Values For MNL LonWorks Devices
Point Object Name
Flow Balance Calibration Information
Backing Up Flow Balance Calibration
Restoring Flow Balance Information
Enumerations for FanModes
Enumerations for HvacModes
71 MNL LonWorks Objects
71.1 MNL LonWorks Objects
71.1 MNL LonWorks Objects
MNL LonWorks objects are translated into Building Operation I/O points, Sensor
object, and S-Link sensor points.
In Building Operation, you can view the MNL LonWorks object name for a Building
Operation point in the System Tree pane, and also in the title bar of the point's
properties dialog box. You can view the Building Operation I/O point type in the
Object ID.
WorkPlace Tech Editor and Monitor Engineering Guide Supplement (F-27745)
71.1.1 I/O Points
MNL LonWorks I/O point objects are translated into Building Operation I/O points.
For more information, see section 71.2 “I/O Points” on page 2422.
71.1.2 S-Link Sensors
The sensor configuration pages and tabs of the WorkPlace Tech Editor Hardware
Wizard are translated into corresponding Building Operation S-Link sensor objects.
For more information, see section 71.3 “S-Link Sensors” on page 2426.
04-16006-04-en, March 2015 Technical
2423
71 MNL LonWorks Objects
71.2 I/O Points
71.2 I/O Points
MNL LonWorks I/O point objects are translated into Building Operation I/O points.
WorkPlace Tech Tool 4.0 Engineering Guide (F-27254)
Table: Building Operation I/O points
WorkPlace Tech Editor Building Operation I/O Comments
Object Point
Analog Input AnalogInM Provides a means to
interface the application to
For more information, see various types of physical
section 72.3 “AnalogIn analog input hardware.
Properties – Basic Tab” on
page 2467. Created when the Analog
Input object's Input Sensor
Type property is set to
Milliamps.
Analog Input AnalogInR Provides a means to
interface the application to
For more information, see various types of physical
section 72.3 “AnalogIn analog input hardware.
Properties – Basic Tab” on
page 2467. Created when the Analog
Input object's Input Sensor
Type property is set to
Resistance 1k or Resistance
10k.
Analog Input AnalogInTC and Provides a means to
AnalogInTF interface the application to
various types of physical
For more information, see analog input hardware.
section 72.3 “AnalogIn
Properties – Basic Tab” on Created when the Analog
page 2467. Input object's Input Sensor
Type property is set to
Thermistor (10k), Balco, or
Platinum. AnalogInTC is
created when the units used
by the MNL device are set to
Metric, and AnalogInTF is
created when the units are
set to English.
Analog Input AnalogInV Provides a means to
interface the application to
For more information, see various types of physical
section 72.3 “AnalogIn analog input hardware.
Properties – Basic Tab” on
page 2467. Created when the Analog
Input object's Input Sensor
Type property is set to Volts.
Analog Output AnalogOut Provides a means to
interface the application to a
For more information, see physical analog output point
section 72.7 “AnalogOut and on an MNL device.
AnalogOutPri Properties –
Basic Tab” on page 2475.
Technical 04-16006-04-en, March 2015
2424
71 MNL LonWorks Objects
71.2 I/O Points
Continued
WorkPlace Tech Editor Building Operation I/O Comments
Object Point
Analog Output Priority AnalogOutPri Same as the Analog Output
object but features four
For more information, see prioritized inputs.
section 72.7 “AnalogOut and
AnalogOutPri Properties –
Basic Tab” on page 2475.
Binary Input BinaryIn Provides a means to
interface the application to
For more information, see any physical input point on
section 72.9 “BinaryIn an MNL device that accepts
Properties – Basic Tab” on a digital input signal.
page 2479.
Created when the Binary
Input object's Binary Type
property is set to Direct or
Reverse.
Binary Input BinaryInPls Provides a means to
interface the application to
For more information, see any physical input point on
section 72.11 “BinaryInPls an MNL device that supports
Properties – Basic Tab” on the monitoring of a pulse
page 2483. train device, such as a flow
meter or demand meter.
Created when the Binary
Input object's Binary Type
property is set to Pulse.
Binary Output BinaryOut Provides a means to
interface the application to a
For more information, see physical digital output point
section 72.13 “BinaryOut on an MNL device.
Properties – Basic Tab” on
page 2487.
DUI Expander DUI Digital Universal Input (DUI)
object. Provides support for
For more information, see up to five digital inputs, using
section 72.15 “DUI a single physical universal
Properties – Basic Tab” on input on the MNL device.
page 2489.
Event Indicator EventInd A special-purpose I/O point
with a physical hardware
For more information, see address for a digital output
section 72.17 “EventInd point. Operates like a
Properties – Basic Tab” on BinaryOut I/O point but can
page 2493. also generate an interrupting
pulse (flick) used to signal an
approaching event.
04-16006-04-en, March 2015 Technical
2425
71 MNL LonWorks Objects
71.2 I/O Points
Continued
WorkPlace Tech Editor Building Operation I/O Comments
Object Point
Fan Speed FanSpeed1 The Fan Speed object
provides sequenced control
For more information, see of up to three physical digital
section 72.19 “FanSpeed1 outputs.
Properties – Basic Tab” on
page 2496. Created when the Fan Speed
object's Number of Speeds
property is set to Single
Speed.
Fan Speed FanSpeed2 The Fan Speed object
provides sequenced control
For more information, see of up to three physical digital
section 72.21 “FanSpeed2 outputs.
Properties – Basic Tab” on
page 2499. Created when the Fan Speed
object's Number of Speeds
property is set to Two
Speed.
Fan Speed FanSpeed3 The Fan Speed object
provides sequenced control
For more information, see of up to three physical digital
section 72.23 “FanSpeed3 outputs.
Properties – Basic Tab” on
page 2503. Created when the Fan Speed
object's Number of Speeds
property is set to Three
Speed.
Floating Actuator FloatingAct Used to control a floating
type actuator, using two
For more information, see physical digital outputs on
section 72.24 “FloatingAct the MNL device.
and FloatingActPri
Properties – Basic Tab” on
page 2505.
For more information, see
section 72.25 “FloatingAct
and FloatingActPri
Properties – Advanced Tab”
on page 2507.
Floating Actuator Priority FloatingActPri Same as the Floating
Actuator object but features
For more information, see four prioritized inputs.
section 72.24 “FloatingAct
and FloatingActPri
Properties – Basic Tab” on
page 2505.
Momentary Start/Stop MomenSS Provides timed start and
stop pulses, using two
For more information, see physical digital outputs on
section 72.26 “MomenSS the MNL device.
Properties – Basic Tab” on
page 2509.
Technical 04-16006-04-en, March 2015
2426
71 MNL LonWorks Objects
71.2 I/O Points
Continued
WorkPlace Tech Editor Building Operation I/O Comments
Object Point
Pressure Transducer PressureTransInH2O Supports the onboard
velocity-pressure transducer
For more information, see of an MNL VAV device.
section 72.28
“PressureTransInH20 and Created when the units used
PressureTransPa by the MNL device are set to
Properties – Basic Tab” on English. Velocity pressure is
page 2513. expressed in inches of water
column.
Pressure Transducer PressureTransPa Supports the onboard
velocity-pressure transducer
For more information, see of an MNL VAV device.
section 72.28
“PressureTransInH20 and Created when the units used
PressureTransPa by the MNL device are set to
Properties – Basic Tab” on Metric. Velocity pressure is
page 2513. expressed in Pascals.
PWM PWMMin Provides a physical hardware
address for a digital output
For more information, see that behaves as a pulse
section 72.30 “PWMMin, width modulator.
PWMPriMin, PWMSec, and
PWMPriSec Properties – Created when the Time
Basic Tab” on page 2517. Select property of the PWM
object is set to Minutes.
PWM PWMSec Provides a physical hardware
address for a digital output
For more information, see that behaves as a pulse
section 72.30 “PWMMin, width modulator.
PWMPriMin, PWMSec, and
PWMPriSec Properties – Created when the Time
Basic Tab” on page 2517. Select property of the PWM
object is set to Seconds.
PWM Priority PWMPriMin Same as the PWM object but
features four prioritized
For more information, see inputs.
section 72.30 “PWMMin,
PWMPriMin, PWMSec, and Created when the Time
PWMPriSec Properties – Select property of the PWM
Basic Tab” on page 2517. object is set to Minutes.
PWM Priority PWMPriSec Same as the PWM object but
features four prioritized
For more information, see inputs.
section 72.30 “PWMMin,
PWMPriMin, PWMSec, and Created when the Time
PWMPriSec Properties – Select property of the PWM
Basic Tab” on page 2517. object is set to Seconds.
VAV Actuator VAVActuator Used to control a VAV
terminal box damper
For more information, see actuator.
section 72.32 “VAVActuator
Properties – Basic Tab” on
page 2521.
04-16006-04-en, March 2015 Technical
2427
71 MNL LonWorks Objects
71.3 S-Link Sensors
71.3 S-Link Sensors
The sensor configuration pages and tabs of the WorkPlace Tech Editor Hardware
Wizard are translated into corresponding Building Operation S-Link sensor objects.
WorkPlace Tech Tool 4.0 Engineering Guide (F-27254)
Table: S-Link Sensor in Building Operation
WorkPlace Tech Editor Building Operation S- Comments
Hardware Wizard Link Sensor Object Type
Controller Configuration Sensor object Supports the temperature,
Page humidity, pushbutton
For more information, see override, and emergency
section 72.43 “Sensor heat properties of the S-Link
Object Properties – Basic sensor. When you select an
Tab” on page 2538. S-Link sensor in the
Hardware Wizard, a Sensor
object is created in Building
Operation.
Display Tab Display1 to Display4 Supports the monitored
sensor points values you can display at the
LCD screen of the S-Link
For more information, see sensor that is connected to
section 72.40 “Display the MNL device. Each
Properties – Basic Tab” on monitored value you
page 2533. configure in the Hardware
Wizard results in a
corresponding Display S-
Link sensor point in Building
Operation.
The name of the Display S-
Link sensor point in
WorkStation matches the
monitor name entered in the
Hardware Wizard.
Fan1 Tab FanMode1 sensor point Supports the ability to
monitor and control a fan
For more information, see directly from the S-Link
section 72.34 “FanMode1 sensor. When you use the
and FanMode2 Properties – Fan1 tab of the Hardware
Basic Tab” on page 2525. Wizard in WorkPlace Tech
Editor to enable Fan1, a
FanMode1 S-Link sensor
point is created in Building
Operation.
The name of the FanMode1
S-Link sensor point in
WorkStation is always
FanMode1, even though
the name of the Fan1 sensor
tag can be edited in the
Hardware Wizard.
Technical 04-16006-04-en, March 2015
2428
71 MNL LonWorks Objects
71.3 S-Link Sensors
Continued
WorkPlace Tech Editor Building Operation S- Comments
Hardware Wizard Link Sensor Object Type
Fan2 Tab FanMode2 sensor point Supports the ability to
monitor and control a
For more information, see second fan directly from the
section 72.34 “FanMode1 S-Link sensor. When you
and FanMode2 Properties – use the Fan2 tab of the
Basic Tab” on page 2525. Hardware Wizard in
WorkPlace Tech Editor to
enable Fan2, a FanMode2
S-Link sensor point is
created in Building
Operation.
The name of the FanMode2
S-Link sensor point in
WorkStation is always
FanMode2, even though
the name of the Fan2 sensor
tag can be edited in the
Hardware Wizard.
If you enable Fan2 in the
Hardware Wizard, make sure
you also enable Fan1. If you
enable Fan2 but not Fan1,
no FanMode S-Link sensor
points are created in Building
Operation.
Mode1 Tab HvacMode1 sensor point Supports the first mode you
can access at the S-Link
For more information, see sensor, by which you can
section 72.36 “HvacMode1 monitor and control the
and HvacMode2 heating and cooling modes
Properties – Basic Tab” on of a system. When you
page 2527. use the Mode1 tab of the
Hardware Wizard to enable
(HVAC) Mode1, an
HvacMode1 S-Link sensor
point is created in Building
Operation.
The name of the
HvacMode1 S-Link sensor
point in WorkStation is
always HvacMode1, even
though the name of the
HVAC Mode1 sensor tag can
be edited in the Hardware
Wizard.
04-16006-04-en, March 2015 Technical
2429
71 MNL LonWorks Objects
71.3 S-Link Sensors
Continued
WorkPlace Tech Editor Building Operation S- Comments
Hardware Wizard Link Sensor Object Type
Mode2 Tab HvacMode2 sensor point Supports the second mode
you can access at the S-Link
For more information, see sensor, by which you can
section 72.36 “HvacMode1 monitor and control the
and HvacMode2 heating and cooling modes
Properties – Basic Tab” on of a system. When you
page 2527. use the Mode1 tab of the
Hardware Wizard to enable
(HVAC) Mode1, an
HvacMode1 S-Link sensor
point is created in Building
Operation.
The name of the
HvacMode2 S-Link sensor
point in WorkStation is
always HvacMode2, even
though the name of the
HVAC Mode2 sensor tag can
be edited in the Hardware
Wizard.
If you enable Mode 2 in the
Hardware Wizard, make sure
you also enable Mode 1. If
you enable Mode 2 but not
Mode 1, no HvacMode S-
Link sensor points are
created in Building
Operation.
Setpoint Tab Setpoint1 to Setpoint4 Supports the setpoints you
sensor points can access at the S-Link
sensor that is connected to
For more information, see the MNL device. Each
section 72.38 “Setpoint setpoint you configure in the
Properties – Basic Tab” on Hardware Wizard results in a
page 2529. corresponding Setpoint S-
Link sensor point in Building
Operation.
The name of the Setpoint
S-Link sensor point in
WorkStation matches the
setpoint name entered in the
Hardware Wizard.
Technical 04-16006-04-en, March 2015
2430
71 MNL LonWorks Objects
71.4 Calibrating S-Link Sensors
71.4 Calibrating S-Link Sensors
You calibrate an S-Link sensor's offset values to adjust for sensor measurement
errors.
To calibrate S-Link sensors
1. In WorkStation, in the System Tree pane, select the MNL LonWorks device.
2. Click the Advanced tab.
3. In the Temperature offset box, enter a value to calibrate the temperature
reading of the S-Link sensor.
4. In the Humidity offset box, enter a value to calibrate the humidity reading of
the S-Link sensor.
You can now download the configuration properties to the device. For more
information, see section 69.5 “Downloading Configuration Properties to an MNL
LonWorks Device” on page 2381.
04-16006-04-en, March 2015 Technical
2431
71 MNL LonWorks Objects
71.5 Backing Up S-Link Sensor Offsets
71.5 Backing Up S-Link Sensor Offsets
You back up S-Link sensor offsets from MNL LonWorks devices to copy the values
into the Building Operation database for future reference.
To back up S-Link sensor offsets
1. In WorkStation, in the System Tree pane, select the MNL LonWorks device
you want to back up.
2. On the Actions menu, point to MNL and then click Backup S-Link
offsets.
The S-Link sensor offsets are now backed up in the properties of the MNL device
object, so that they can be restored to the MNL device when needed. For more
information, see section 71.6 “Restoring S-Link Sensor Offsets” on page 2431.
Technical 04-16006-04-en, March 2015
2432
71 MNL LonWorks Objects
71.6 Restoring S-Link Sensor Offsets
71.6 Restoring S-Link Sensor Offsets
You restore S-Link sensor offsets to an MNL LonWorks device to load that device
with S-Link sensor offsets from a previous backup.
To restore S-Link sensor offsets
1. In WorkStation, in the System Tree pane, select the MNL device that you
want to restore S-Link sensor offsets to.
2. On the Actions menu, point to MNL and then click Restore S-Link
offsets.
The S-Link sensor offsets are now restored to the MNL device.
04-16006-04-en, March 2015 Technical
2433
71 MNL LonWorks Objects
71.7 Properties of MNL LonWorks Objects
71.7 Properties of MNL LonWorks Objects
You configure the properties of various MNL LonWorks objects to set or change the
behavior of these objects.
71.7.1 NCI Values
In Building Operation, NCI objects represent NCIs in an MNL LonWorks device.
Initial NCI values are defined in an MNL device's WorkPlace Tech Editor application,
and the current values are stored in Building Operation NCI objects.
For more information, see section 71.8 “NCI Values” on page 2434.
71.7.2 Forceable I/O Point Properties
In WorkStation, when you want to perform an override, you force the value of an I/O
point property.
For more information, see section 71.10 “Forceable MNL I/O Point Properties” on
page 2436.
71.7.3 Not Active (NA) Property Values
In WorkPlace Tech, undefined data is represented as a special NA, or not active,
value.
For more information, see section 71.12 “Not Active (NA) Property Values” on page
2445.
71.7.4 Not Active (NA) SNVT Values For MNL
LonWorks Devices
SNVTs in MNL LonWorks devices have LonMark or MNL defined invalid values.
Some MNL SNVTs have LonMark defined invalid values. However, SNVTs without
LonMark defined invalid values have alternate invalid values defined for MNL
devices. When an NVI or NCI in an MNL device receives its LonMark or MNL
defined invalid value, the output of the SNVT in MNL device is set to NA depending
on the configuration of the SNVT in the MNL device's application. When the input of
an NVO in an MNL device is NA, the NVO sends the defined invalid value when
bound or polled depending on the configuration of the NVO in the MNL device's
application.
For more information, see section 71.13 “Not Active (NA) SNVT Values For MNL
LonWorks Devices” on page 2446.
71.7.5 Point Object Name
Each I/O point or S-Link sensor point has an Object Name property.
Technical 04-16006-04-en, March 2015
2434
71 MNL LonWorks Objects
71.7 Properties of MNL LonWorks Objects
For more information, see section 71.14 “Point Object Name” on page 2453.
71.7.6 Flow Balance Calibration Information
You flow balance a terminal box that is controlled by an MNL LonWorks VAV
device, using the MicroNet VAV Flow Balance software (MNL-FLOW-BAL). After
you flow balance the terminal box, you back up the calibration information from the
MNL device into Building Operation.
For more information, see section 71.15 “Flow Balance Calibration Information” on
page 2454.
71.7.7 Enumerations for FanModes
The Value property of a FanMode1 or FanMode2 S-Link sensor point is an
enumeration.
For more information, see section 71.18 “Enumerations for FanModes” on page
2458.
71.7.8 Enumerations for HvacModes
The Value property of an HvacMode1 or HvacMode2 S-Link sensor point is an
enumeration.
For more information, see section 71.19 “Enumerations for HvacModes” on page
2459.
04-16006-04-en, March 2015 Technical
2435
71 MNL LonWorks Objects
71.8 NCI Values
71.8 NCI Values
In Building Operation, NCI objects represent NCIs in an MNL LonWorks device.
Initial NCI values are defined in an MNL device's WorkPlace Tech Editor application,
and the current values are stored in Building Operation NCI objects.
In Building Operation, MNL devices use flags to indicate which NCI values will be
downloaded with the application:
• The NCI values from the NCI objects in WorkStation (flag set)
• The NCI values from the WorkPlace Tech application (flag not set)
At the time an application is downloaded, the system examines the flag of each NCI
object to determine whether or not the flag has been set, and then downloads the
appropriate NCI values. In the System Tree pane, you can see the status of an
NCI object.
For more information, see section 72.48 “MNL LonWorks System Tree Icons” on
page 2547.
For more information, see section 70.13 “Downloading an MNL LonWorks
Application Type” on page 2413.
When a device is first created in WorkStation, all its NCI flags are clear (not set).
If you are connected to a server and use the Properties pane in WorkStation to
modify the value of an NCI object, the corresponding NCI value is updated, in both
the MNL device and in the database, and the NCI object’s flag is set. Because the
flag is set, any future downloads will also use the NCI value from the object in the
database.
Note
If you modify an NCI value and then decide that you want to revert to the value
from the MNL application, you can use the Revert to application value
command.
For more information, see section 71.9 “Reverting to the Application Value for NCI
Downloads” on page 2435.
Flow Balance NCIs
One use of NCIs in Building Operation is to contain the flow balance calibration
values in MNL VAV devices. Whenever flow balance information is uploaded from,
or downloaded to, the device, the flag of each flow balance NCI object is set so that
subsequent application downloads will use the values from the flow balance NCI
objects.
Technical 04-16006-04-en, March 2015
2436
71 MNL LonWorks Objects
71.9 Reverting to the Application Value for NCI Downloads
71.9 Reverting to the Application Value for
NCI Downloads
You use an NCI value from the device application when downloading the device
configuration (NCI values) to the MNL LonWorks device. This can be useful if you
set an NCI value and then decide that you want to revert to the value from the MNL
application instead.
For more information, see section 71.8 “NCI Values” on page 2434.
To revert to the application value for NCI downloads
1. In WorkStation, in the System Tree pane, select the NCI.
2. On the Actions menu, click Revert to application value.
3. In the System Tree pane, select the MNL device that contains the NCI.
4. On the Actions menu, point to MNL and then click Download application.
The NCI value in the MNL device is updated to use the value from the application,
and future downloads will use the NCI value from the MNL application.
04-16006-04-en, March 2015 Technical
2437
71 MNL LonWorks Objects
71.10 Forceable MNL I/O Point Properties
71.10 Forceable MNL I/O Point Properties
In WorkStation, when you want to perform an override, you force the value of an I/O
point property.
Forcing the value disables the input or output point from receiving values from either
the MNL LonWorks device or the WorkPlace Tech application.
71.10.1 Forceable MNL I/O Points
The following MNL input and output points allow their values to be forced.
Table: Forceable MNL I/O Points
Input Points Output Points
AnalogInM AnalogOut
AnalogInR AnalogOutPri
AnalogInTC BinaryOut
AnalogInTF EventInd
AnalogInV PWMMin
BinaryIn PWMSec
BinaryInPls PWMPriMin
PressureTransInH20 PWMPriSec
PressureTransPa Sensor (Temperature)
71.10.2 Forced and Unforced Value Properties
Each I/O point has a Value output property that reflects the current value of that
point. In I/O points that support the force feature, you can view the forced value as
well as the unforced value.
Important
Secondary protection that is part of an output object, such as Minimum On Time,
is overridden when forcing values.
For more information, see the Forced Values topic on WebHelp.
Value Property
The Value property displays the current value associated with the I/O point. This
will either be the calculated value based on the application, or the forced value if it is
currently in a forced state.
Technical 04-16006-04-en, March 2015
2438
71 MNL LonWorks Objects
71.10 Forceable MNL I/O Point Properties
Unforced Value Property
The Unforced value property displays the value that the system will return to
when the force condition is removed. When not in a force condition, the displayed
value is the last known value that was received.
For more information, see the Viewing an Unforced Value topic on WebHelp.
Important
When you force the Value property of certain input I/O points, the Unforced
value property indicates "32768" (NA) rather than the actual unforced value. This
applies to the following I/O points:
• AnalogIn series
• BinaryIn
• BinaryInPls
• DUI
• PressureTransInH20
• PressureTransPa
71.10.3 Displayed Value of Forced MNL I/O Point
In Building Operation, the value of the Value property of an MNL I/O point, whether
forced or unforced, is displayed in three places:
• The I/O pont's Basic property tab
• WorkPlace Tech Monitor, on the MNL application drawing itself, where a
monitor tag is connected to the object's output
• The Watch pane, when you drag the Value there from the property page
The displayed value in these three places can either agree or disagree, depending
on whether the I/O point is associated with an MNL input object or MNL output
object, and whether the value is forced or unforced.
For more information, see section 71.11 “Displayed Value of Forced MNL I/O Point”
on page 2439.
71.10.4 Pocket I/A Software and Overrides
The use of TAC I/A Series Pocket I/A software with Building Operation is not
recommended. Pocket I/A is designed to be installed on a handheld PC and used
onsite to perform various monitoring and maintenance tasks on MNL LonWorks
devices. Although it is possible to connect Pocket I/A to an MNL device that is part
of a Building Operation system, using Pocket I/A to apply or clear overrides to the
MNL device can result in operational problems in Building Operation.
Warning
Avoid using TAC I/A Series Pocket I/A to clear an override that was set from
within Building Operation. Such overrides are often set to calibrate or diagnose
equipment operation. Clearing the override using Pocket I/A could unintentionally
restore normal operation, resulting in damage to the equipment.
04-16006-04-en, March 2015 Technical
2439
71 MNL LonWorks Objects
71.10 Forceable MNL I/O Point Properties
Note
When you set or clear overrides with TAC I/A Series Pocket I/A, it may take one
minute or longer for the override status icon in WorkStation to update. To avoid
confusion over the actual status of the override, use WorkStation, not Pocket I/A,
to perform overrides.
Technical 04-16006-04-en, March 2015
2440
71 MNL LonWorks Objects
71.11 Displayed Value of Forced MNL I/O Point
71.11 Displayed Value of Forced MNL I/O
Point
In Building Operation, the value of the Value property of an MNL I/O point, whether
forced or unforced, is displayed in three places:
• The I/O pont's Basic property tab
• WorkPlace Tech Monitor, on the MNL application drawing itself, where a
monitor tag is connected to the object's output
• The Watch pane, when you drag the Value there from the property page
The displayed value in these three places can either agree or disagree, depending
on whether the I/O point is associated with an MNL input object or MNL output
object, and whether the value is forced or unforced.
The display of MNL I/O point values is dependent on the sources from which those
values are obtained. Overrides of MNL devices are performed by forcing the I/O
point at the hardware level, through the use of a hardware input tag or hardware
output tag on the MNL application drawing. In the case of MNL input objects, the
I/O hardware input tag is connected to the input of the MNL input object, which
allows the override to be seen by that object. In the case of an MNL output object,
the hardware output tag is connected to the output of the object, and so the object
has no awareness of the forced condition.
71.11.1 Display of Forced MNL Input Object Value
In WorkStation, forcing the Value of an I/O point associated with an MNL input
object acts on a hardware input tag connected to the object's input, so that the
object processes the input and then provides an output. When you force this type
of input value, the displayed value is the same when viewed in these three places:
• On the I/O point's Basic property tab
• At the input object's output, as displayed on a monitor tag connected to this
output on the application drawing
• In the Watch pane, when you drag the Value there from the property page
04-16006-04-en, March 2015 Technical
2441
71 MNL LonWorks Objects
71.11 Displayed Value of Forced MNL I/O Point
Figure: Forced Value in MNL Input Object – All Displayed Values Are the Same
Important
When you force the Value property of an input object in WorkStation, the
displayed value on the Basic tab may revert to the previous value, even though
the Value output in the application updates correctly. This behavior is limited to
the displayed value on the Basic tab. To display the current forced value on the
Basic tab, refresh the display.
Technical 04-16006-04-en, March 2015
2442
71 MNL LonWorks Objects
71.11 Displayed Value of Forced MNL I/O Point
71.11.2 Display of Unforced and Forced MNL Output
Object Value
In WorkStation, forcing the Value property of an I/O point associated with an MNL
output object acts directly on the object's output side, at a hardware output tag
connected to the object's hardware output. Because the forcing action is applied at
the hardware output, and not the object's Output property, the forced value
bypasses the processing normally performed by the object.
When Value Property is Unforced
When the Value property of an I/O point is unforced, the values displayed on the
Basic property tab, in the application drawing, and in the Watch pane are all in
agreement.
04-16006-04-en, March 2015 Technical
2443
71 MNL LonWorks Objects
71.11 Displayed Value of Forced MNL I/O Point
Figure: Unforced Value in MNL Output Object – All Displayed Values Are the Same
When Value Property is Forced
When the Value property is forced, some of the displayed values no longer agree,
as seen on the I/O point's Basic property tab, in the application drawing, and in the
Watch pane:
• In the Watch pane, the displayed value of the I/O point is the same as the
forced value displayed on the I/O point's Basic property tab
• In the Watch pane, the displayed value of the SNVT object attached to the
Output of the I/O point object is different from the forced value displayed on
the I/O point's Basic property tab
Technical 04-16006-04-en, March 2015
2444
71 MNL LonWorks Objects
71.11 Displayed Value of Forced MNL I/O Point
• On the application drawing, the value at the output object's Output property,
as displayed on a monitor tag connected to this output, is different from the
forced value displayed on the I/O point's Basic property tab
Figure: Forced Value in MNL Output Object – Output Property Displayed Value Is Different
04-16006-04-en, March 2015 Technical
2445
71 MNL LonWorks Objects
71.11 Displayed Value of Forced MNL I/O Point
Note
To avoid the inconsistent display values for forced MNL output objects, alter the
application so that it is not dependent on the Output property, alone, for passing
the value to other logic or points. After making changes to the application, save
the changes and then download the application to the MNL device.
For more information, see section 70.14 “Editing an MNL LonWorks Application
Type in a Device” on page 2414.
WorkPlace Tech Editor and Monitor Engineering Guide Supplement (F-27745) for
a procedure detailing how to edit an application that is assigned to MNL-800
LonWorks devices.
Technical 04-16006-04-en, March 2015
2446
71 MNL LonWorks Objects
71.12 Not Active (NA) Property Values
71.12 Not Active (NA) Property Values
In WorkPlace Tech, undefined data is represented as a special NA, or not active,
value.
WorkPlace Tech Tool 4.0 Engineering Guide (F-27254)
In an MNL LonWorks device within Building Operation, certain properties use
designated values to signify NA. Such properties can be identified by a tool tip that
appears when you hover your mouse pointer over them. This tool tip displays the
property’s designated value for NA:
• A value of 32768 represents NA: Used with properties that have no units (either
configurable or nonconfigurable), as well as the units %, %RH, minutes,
seconds, mA, Ω (ohms), and volts.
• A value greater than 16383 represents NA: Used with properties having the
units ft3/min (CFM), liters/sec, in. H2O, Pa, °C, or °F.
04-16006-04-en, March 2015 Technical
2447
71 MNL LonWorks Objects
71.13 Not Active (NA) SNVT Values For MNL LonWorks Devices
71.13 Not Active (NA) SNVT Values For MNL
LonWorks Devices
SNVTs in MNL LonWorks devices have LonMark or MNL defined invalid values.
Some MNL SNVTs have LonMark defined invalid values. However, SNVTs without
LonMark defined invalid values have alternate invalid values defined for MNL
devices. When an NVI or NCI in an MNL device receives its LonMark or MNL
defined invalid value, the output of the SNVT in MNL device is set to NA depending
on the configuration of the SNVT in the MNL device's application. When the input of
an NVO in an MNL device is NA, the NVO sends the defined invalid value when
bound or polled depending on the configuration of the NVO in the MNL device's
application.
The table below gives invalid values in US customary and SI units of measure. Use
these values when you want to set the output of an NVI or NCI to NA in an MNL
device. When setting the value using WorkStation, the value to use (US or SI)
depends on the units system of the PC that WorkStation is running on. When
setting the value using a binding from an output of a program object, the value to
use depends on the engineering unit configuration of the bound property of the
program object.
WorkPlace Tech Tool 4.0 Engineering Guide (F-27254)
The table lists the SNVT types in alphabetical order.
Table: Not Active (NA) SNVT Values for MNL LonWorks Devices
SNVT Type SNVT Element US Customary SI Value
System Value
SNVT_amp Electric current 3276.68 A 3276.68 A
SNVT_amp_ac Amperage in 65535 A 65535 A
alternating current
SNVT_amp_f Electric current 2.00E+38 A 2.00E+38 A
SNVT_amp_mil Electric current 3276.69 mA 3276.69 mA
SNVT_angle Angular distance 3754.879 deg 65.535 rad
SNVT_angle_deg Angular distance 655.34 deg 655.34 deg
SNVT_angle_f Angular distance 1.90E+40 deg 2.00E+38 rad
SNVT_angle_vel Angular velocity 3276.69 rad/s 3276.69 rad/s
SNVT_angle _vel_f Angular velocity 2.00E+38 rad/s 2.00E+38 rad/s
SNVT_area Area 20315.89 feet2 13.107 m2
SNVT_btu_f Thermal energy 1.99E+38 Btu 2.10E+41 J
SNVT_btu_kilo Thermal energy 65535 kBtu 69143085324.31 J
SNVT_btu_mega Thermal energy 65535 kBtu 69,143,085,324,309
J
Technical 04-16006-04-en, March 2015
2448
71 MNL LonWorks Objects
71.13 Not Active (NA) SNVT Values For MNL LonWorks Devices
Continued
SNVT Type SNVT Element US Customary SI Value
System Value
SNVT_char_ascii ASCII character Not possible to set to Not possible to set to
NA NA
SNVT_chlr_status Alarm flag Not possible to set to Not possible to set to
NA NA
SNVT_chlr_status Chiller-water-flow Not possible to set to Not possible to set to
flag NA NA
SNVT_chlr_status Condenser-water- Not possible to set to Not possible to set to
flow flag NA NA
SNVT_chlr_status Limited-condition flag Not possible to set to Not possible to set to
NA NA
SNVT_chlr_status Locally-controlled Not possible to set to Not possible to set to
flag NA NA
SNVT_chlr_status Run-enabled flag Not possible to set to Not possible to set to
NA NA
SNVT_chlr_status Chiller operating HVAC_NULL HVAC_NULL
mode
SNVT_chlr_status Chiller run mode CHLR_NULL CHLR_NULL
SNVT_config_scr Configuration source CFG_NUL (255) CFG_NUL (255)
SNVT_count Absolute count 65535 65535
SNVT_count_f Absolute count 2.00E+38 2.00E+38
SNVT_count_inc Increment count 32767 32767
SNVT_count_inc_f Increment count 2.00E+38 2.00E+38
SNVT_date_day Day of week DAY_NUL DAY_NUL
SNVT_defr_mode Defrost mode DFM_NUL DFM_NUL
SNVT_defr_state Defrost state DFS_NUL DFS_NUL
SNVT_defr_term Defrost termination DFT_NUL DFT_NUL
SNVT_density Density 1.1838 lb/in3 32767.5 kg/m3
SNVT_density_f Density 1.22E+34 lb/in3 2.00E+38 kg/m3
SNVT_elapsed_tm Day 65535 days 65535 days
SNVT_elapsed_tm Hour NA if Days is NA. NA if Days is NA.
SNVT_elapsed_tm Millisecond NA if Days is NA. NA if Days is NA.
SNVT_elapsed_tm Minute NA if Days is NA. NA if Days is NA.
04-16006-04-en, March 2015 Technical
2449
71 MNL LonWorks Objects
71.13 Not Active (NA) SNVT Values For MNL LonWorks Devices
Continued
SNVT Type SNVT Element US Customary SI Value
System Value
SNVT_elapsed_tm Second NA if Days is NA. NA if Days is NA.
SNVT_elec_kwh Electric energy 65535 kWh 65535 kWh
SNVT_elec_whr Electric energy 6553.5 Wh 6553.5 Wh
SNVT_elec_whr_f Electric energy 2.00E+38 Wh 2.00E+38 Wh
SNVT_evap_state Evaporator state EVAP_NUL EVAP_NUL
SNVT_flow Flow volume 138860.801015545 65535 l/s
ft3/min
SNVT_flow_f Flow volume 4.2.00E+38 ft3/min 2.00E+38 l/s
SNVT_flow_mil Flow volume 138.860801015545 65535 ml/s
ft3/min
SNVT_freq_f Frequency 2.00E+38 Hz 2.00E+38 Hz
SNVT_freq_hz Frequency 6553.5 Hz 6553.5 Hz
SNVT_freq_kilohz Frequency 6553.5 kHz 6553.5 kHz
SNVT_freq_milhz Frequency 6553.5 kHz 6553.5 kHz
SNVT_grammage Grammag 6553.5 g/m2 6553.5 g/m2
SNVT_grammage_f Grammag 2.00E+38 g/m2 2.00E+38 g/m2
SNVT_hvac_emerg HVAC emergency EMERG_NUL EMERG_NUL
mode
SNVT_havc_mode HVAC mode HVAC_NUL HVAC_NUL
SNVT_hvac_overid Flow 138860.801015545 65535 l/s
ft3/min
SNVT_hvac_overid State HVO_NUL HVO_NUL
SNVT_hvac_overid Percent 163.83 % 163.83 %
SNVT_hvac_status Cooling output 163.835 % 163.835 %
SNVT_hvac_status Economizer output 163.835 % 163.835 %
SNVT_hvac_status Fan output 163.835 % 163.835 %
SNVT_hvac_status HVAC status mode HVAC_NUL (255) HVAC_NUL (255)
SNVT_hvac_status Alarm state 255 255
SNVT_hvac_status Primary heat output 163.835 % 163.835 %
SNVT_hvac_status Secondary heat 163.835 % 163.835 %
output
Technical 04-16006-04-en, March 2015
2450
71 MNL LonWorks Objects
71.13 Not Active (NA) SNVT Values For MNL LonWorks Devices
Continued
SNVT Type SNVT Element US Customary SI Value
System Value
SNVT_hvac_type HVAC unit type HVT_NUL HVT_NUL
SNVT_length Length 21500.9 ft 6553.5 m
SNVT_length_f Length 6.50E+38 ft 2.00E+38 m
SNVT_length_kilo Length 21500984 ft 6553.5 km
SNVT_length_micr Length 0.0215009 ft 6553.5 um
SNVT_length_mil Length 21.5009 ft 6553.5 mm
SNVT_lev_cont Continuous level Not possible to set to Not possible to set to
NA NA
SNVT_lev_cont_f Continuous level Not possible to set to Not possible to set to
NA NA
SNVT_lev_disc Percentage level ST_NUL ST_NUL
SNVT_lev_percent Level percent 163.835 % 163.835 %
SNVT_lux Illumination 65535 lux 65535 lux
SNVT_mass Mass 14.4479 lb 6553.5 g
SNVT_mass_f Mass 4.4E+35 lb 2.00E+38 g
SNVT_mass_kilo Mass 14447.9 lb 6553.5 kg
SNVT_mass_mega Mass 14447994 lb 6553.5 Mg
SNVT_mass_mil Mass 0.0144479 lb 6553.5 mg
SNVT_muldiv Divisor 65535 65535
SNVT_muldiv Multiplier 65535 65535
SNVT_multiplier Multiplier 32.767501 32.767501
SNVT_occupancy Occupancy OC_NULL OC_NULL
SNVT_override Override code OV_NULL OV_NULL
SNVT_ph Acidity 32.7669 pH 32.7669 pH
SNVT_ph_f Acidity 2.00E+38 pH 2.00E+38 pH
SNVT_power Power 6553.5 W 6553.5 W
SNVT_power_f Power 2.00E+38 W 2.00E+38 W
SNVT_power_kilo Power 6553.5 kW 6553.5 kW
SNVT_ppm Concentration 65535 ppm 65535 ppm
04-16006-04-en, March 2015 Technical
2451
71 MNL LonWorks Objects
71.13 Not Active (NA) SNVT Values For MNL LonWorks Devices
Continued
SNVT Type SNVT Element US Customary SI Value
System Value
SNVT_ppm_f Concentration 2.00E+38 ppm 2.00E+38 ppm
SNVT_press Pressure (gauge) 475.24 psi 3276.69 kPa
SNVT_press_f Pressure (gauge) 2.90E+34 psi 2.90E+34 pa
SNVT_press_p Pressure (gauge) 4.75245157 psi 32767 Pa
SNVT_pwr_fact Power factor Not possible to set to Not possible to set to
NA NA
SNVT_pwr_fact_f Power factor Not possible to set to Not possible to set to
NA NA
SNVT_res Electric resistance 6553.5 ohm 6553.5 ohm
SNVT_res_f Electric resistance 2.00E+38 ohm 2.00E+38 ohm
SNVT_res_kilo Electric resistance 6553500 ohm 6553.5 kohm
SNVT_rpm Angular velocity 65535 RPM 65535 RPM
SNVT_smo_obscur Smoke obscuration 65.535 % 65.535 %
SNVT_sound_db Sound level 327.67 dB (SPL) 327.67 dB (SPL)
SNVT_sound_db_f Sound level 2.00E+38 dB (SPL) 2.00E+38 dB (SPL)
SNVT_speed Linear velocity 21500.9 ft/s 6553.5 m/s
SNVT_speed_f Linear velocity 7.00E+38 ft/s 2.00e+38 m/s
SNVT_speed_mil Linear velocity 215.009 ft/s 65.535 m/s
SNVT_state State bit (all states) Not possible to set to Not possible to set to
NA NA
SNVT_switch State -1 -1
SNVT_switch Value Not possible to set to Not possible to set to
NA NA
SNVT_telcom Telecomm states TEL_NUL TEL_NUL
SNVT_temp Temperature 11335.1 deg F 6279.5 deg C
SNVT_temp_f Temperature 4.00E+38 2.00E+38 deg C
SNVT_temp_p Temperature 621.8 deg F 327.67 deg C
SNVT_temp_ror Temperature 29490.3 deg F/min 16383.5 deg C/min
SNVT_temp_setpt Occupied cooling 621.8 deg F 327.67 deg C
setpoint
Technical 04-16006-04-en, March 2015
2452
71 MNL LonWorks Objects
71.13 Not Active (NA) SNVT Values For MNL LonWorks Devices
Continued
SNVT Type SNVT Element US Customary SI Value
System Value
SNVT_temp_setpt Occupied heating 621.8 deg F 327.67 deg C
setpoint
SNVT_temp_setpt Standby cooling 621.8 deg F 327.67 deg C
setpoint
SNVT_temp_setpt Standby heating 621.8 deg F 327.67 deg C
setpoint
SNVT_temp_setpt Unoccupied cooling 621.8 deg F 327.67 deg C
setpoint
SNVT_temp_setpt Unoccupied heating 621.8 deg F 327.67 deg C
setpoint
SNVT_therm_mode Thermostat mode THERM_NUL THERM_NUL
SNVT_time_f Elapsed time 2.00E+38 s 2.00E+38 s
SNVT_time_hour Elapsed time 65535 h 65535 h
SNVT_time_min Elapsed time 65535 min 65535 min
SNVT_time_sec Elapsed time 6553.5 s 6553.5 s
SNVT_tod_event Occupancy, current OC_NUL OC_NUL
SNVT_tod_event Occupancy, next OC_NUL OC_NUL
SNVT_tod_event Time to next state 65535 min 65535 min
SNVT_turbidity Turbidity 65.535 NTU 65.535 NTU
SNVT_turbidity_ f Turbidity 2.00E+38 NTU 2.00E+38 NTU
SNVT_vol Volume 399919 in3 6553.5 litre
SNVT_vol_f Volume 1.2E+40 in3 2.00E+38 litre
SNVT_vol_kilo Volume 399919106 in3 6553.5 klitre
SNVT_vol_mil Volume 399.919 in3 6553.5 mlitre
SNVT_volt Electric voltage 3276.69 V 3276.69 V
SNVT_volt_ac Electric voltage 65535 V 65535 V
SNVT_volt_dbmv Electric voltage 327.67 dBuV 327.67 dBuV
SNVT_volt_f Electric voltage 2.00E+38 V 2.00E+38 V
SNVT_volt_kilo Electric voltage 3276.69 kV 3276.69 kV
SNVT_volt_mil Electric voltage 3276.69 mV 3276.69 mV
SNVT_zerospan Span-factor 32.77 32.77
04-16006-04-en, March 2015 Technical
2453
71 MNL LonWorks Objects
71.13 Not Active (NA) SNVT Values For MNL LonWorks Devices
Continued
SNVT Type SNVT Element US Customary SI Value
System Value
SNVT_zerospan Zero-term 163.835 163.835
Technical 04-16006-04-en, March 2015
2454
71 MNL LonWorks Objects
71.14 Point Object Name
71.14 Point Object Name
Each I/O point or S-Link sensor point has an Object Name property.
A point object’s name in WorkStation is the same as the Object Name assigned in
WorkPlace Tech Editor. You must configure the Object Name in WorkPlace Tech
Editor because you cannot edit the object name from WorkStation.
WorkPlace Tech Tool 4.0 Engineering Guide (F-27254)
WorkPlace Tech Tool 4.0 Users Guide (F-27255)
When renaming I/O points and S-Link sensor points, be sure to consider the
following:
• The names of I/O points and S-Link sensor points cannot be changed in
WorkStation. Use WorkPlace Tech Editor to make these changes.
Building Operation WorkPlace Tech Editor and Monitor Engineering Guide
Supplement (F-27745)
• When you change the name of an I/O point or an S-Link sensor point, the
bindings are deleted and you need to recreate them.
For more information, see section 68.6 “Bindings for MNL LonWorks Devices”
on page 2370.
• Building Operation allows the use of certain special characters in the names of
MNL LonWorks point objects.
Building Operation WorkPlace Tech Editor and Monitor Engineering Guide
Supplement (F-27745), where you can find details on the characters allowed in
names of created and uploaded MNL LonWorks Objects
• When you revise the name of an I/O point or an S-Link sensor point in
WorkPlace Tech Editor and then save the application, this change is copied
from that application type to all the application objects created from that type.
For more information, see section 70.2 “Changes to Applications” on page
2394.
04-16006-04-en, March 2015 Technical
2455
71 MNL LonWorks Objects
71.15 Flow Balance Calibration Information
71.15 Flow Balance Calibration Information
You flow balance a terminal box that is controlled by an MNL LonWorks VAV
device, using the MicroNet VAV Flow Balance software (MNL-FLOW-BAL). After
you flow balance the terminal box, you back up the calibration information from the
MNL device into Building Operation.
TAC I/A Series MicroNet VAV Flow Balance User’s Guide (F-26421)
For more information, see section 71.16 “Backing Up Flow Balance Calibration” on
page 2456.
In WorkStation, you can view an MNL VAV device’s flow balance information on the
Advanced tab, in the Flow Balance Information property group. You can also
view the time at which the last backup was completed, displayed as Last flow
balance backup time. For more information, see section 72.46 “MNL LonWorks
Device Properties – Advanced Tab” on page 2543.
You can write the backed up flow balance information to the MNL VAV device
whenever it becomes necessary to restore or replace the device. For more
information, see section 71.17 “Restoring Flow Balance Information” on page 2457.
71.15.1 Data Backups and Flow Balance NCIs
Six NCIs contain the flow balance calibration values in MNL VAV devices:
• nciHighFlowCal: The high flow calibration value, in liters/sec (ft3/min). This value
is the terminal box flow rate at a velocity pressure of 249 Pa (1.0 in. w.g.).
• nciLowFlowCal: The low flow calibration value, in liters/sec (ft3/min). This value
is the terminal box flow rate at a velocity pressure of 24.9 Pa (0.1 in. w.g.).
• nciRotation: The MNL VAV device’s direction of rotation to close or open the
terminal box damper.
• nciMaxFlow: The maximum flow setpoint, in liters/sec (ft3/min). This is the
maximum flow control point used by the MNL VAV device.
• nciMinFlow: The minimum flow setpoint, in liters/sec (ft3/min). This is the
minimum flow control point used by the MNL VAV device.
• nciMinFlowHeat: The heating minimum flow setpoint, in liters/sec (ft3/min). This
is the minimum flow control point used by the MNL VAV device during reheat
conditions.
When you perform a backup of flow balance calibration information from an MNL
VAV device, the preceding NCI values are copied to the Building Operation
database.
71.15.2 Data Restore
When you restore flow balance calibration information to an MNL VAV device,
Building Operation downloads the values from the Flow Balance Information
property group to the device.
Technical 04-16006-04-en, March 2015
2456
71 MNL LonWorks Objects
71.15 Flow Balance Calibration Information
In WorkStation, you can view the time at which the last restore was performed,
displayed as Last flow balance restore time, part of the Flow Balance
Information property group on the MNL VAV device’s Advanced tab. For more
information, see section 72.46 “MNL LonWorks Device Properties – Advanced Tab”
on page 2543.
71.15.3 Flow Balance Data Backups
Once the flow balance information is backed up to the server database, it can be
included as part of Building Operation’s system backups.
For more information, see the Archiving Overview topic on WebHelp.
For more information, see section 8.1 “Backup and Restore Overview” on page
279.
71.15.4 Flow Balance Text Report
In WorkStation, you can use the text report, I/A Series Flow Balance Report, to view
flow balance information for an MNL VAV device.
For more information, see section 128.1 “Text Reports Overview” on page 5325.
04-16006-04-en, March 2015 Technical
2457
71 MNL LonWorks Objects
71.16 Backing Up Flow Balance Calibration
71.16 Backing Up Flow Balance Calibration
You back up flow balance information of MNL LonWorks VAV devices to copy the
values into the Building Operation database for future reference.
To back up flow balance calibration
1. Ensure that the MNL VAV device is flow balanced.
For more information, see section 71.15 “Flow Balance Calibration
Information” on page 2454.
2. In WorkStation, in the System Tree pane, select the VAV device.
3. On the Actions menu, point to MNL and then click Backup flow balance
information.
The flow balance information is now backed up into the Building Operation
database.
Technical 04-16006-04-en, March 2015
2458
71 MNL LonWorks Objects
71.17 Restoring Flow Balance Information
71.17 Restoring Flow Balance Information
You restore flow balance information to an MNL LonWorks VAV device to load that
device with flow balance information from a previous backup. Restoring the flow
balance information is often sufficient to calibrate the replacement device, and in
cases where some additional calibration is needed, the restored data can be used
as a starting point.
To restore flow balance information
1. In WorkStation, in the System Tree pane, select the MNL VAV device.
2. On the Actions menu, point to MNL and then click Restore flow balance
information.
The flow balance values are now written to the MNL VAV device.
04-16006-04-en, March 2015 Technical
2459
71 MNL LonWorks Objects
71.18 Enumerations for FanModes
71.18 Enumerations for FanModes
The Value property of a FanMode1 or FanMode2 S-Link sensor point is an
enumeration.
For each enumeration, text that describes the status of the point is displayed in
WorkStation. Each textual enumeration name has a corresponding numeric
enumeration value.
Table: Numeric Values and Textual Names of Enumerations
Textual Name Numeric Value
Auto 1
Off 100
On 101
Low 133
Medium 166
High 200
You can use these numeric values in other Building Operation applications such as
graphics, script programs, and function block programs.
Technical 04-16006-04-en, March 2015
2460
71 MNL LonWorks Objects
71.19 Enumerations for HvacModes
71.19 Enumerations for HvacModes
The Value property of an HvacMode1 or HvacMode2 S-Link sensor point is an
enumeration.
For each enumeration, text that describes the status of the point is displayed in
WorkStation. Each textual enumeration name has a corresponding numeric
enumeration value.
Table: Numeric Values and Textual Names of Enumerations
Textual Name Numeric Value
Auto 0
Heat 1
Cool 3
Off 6
You can use these numeric values in other Building Operation applications such as
graphics, script programs, and function block programs.
04-16006-04-en, March 2015 Technical
2461
72 MNL LonWorks User Interface
Topics
Properties of I/O Points, Sensor Object, and S-Link Sensor
Points – Basic Tab
Properties of I/O Points, Sensor Object, and S-Link Sensor
Points – Advanced Tab
AnalogIn Properties – Basic Tab
AnalogInM and AnalogInV Properties – Advanced Tab
AnalogInR Properties – Advanced Tab
AnalogInTC and AnalogInTF Properties – Advanced Tab
AnalogOut and AnalogOutPri Properties – Basic Tab
AnalogOut and AnalogOutPri Properties – Advanced Tab
BinaryIn Properties – Basic Tab
BinaryIn Properties – Advanced Tab
BinaryInPls Properties – Basic Tab
BinaryInPls Properties – Advanced Tab
BinaryOut Properties – Basic Tab
BinaryOut Properties – Advanced Tab
DUI Properties – Basic Tab
DUI Properties – Advanced Tab
EventInd Properties – Basic Tab
EventInd Properties – Advanced Tab
FanSpeed1 Properties – Basic Tab
FanSpeed1 Properties – Advanced Tab
FanSpeed2 Properties – Basic Tab
FanSpeed2 and FanSpeed3 Properties – Advanced Tab
FanSpeed3 Properties – Basic Tab
FloatingAct and FloatingActPri Properties – Basic Tab
FloatingAct and FloatingActPri Properties – Advanced Tab
MomenSS Properties – Basic Tab
MomenSS Properties – Advanced Tab
PressureTransInH20 and PressureTransPa Properties –
Basic Tab
PressureTransInH20 and PressureTransPa Properties –
Advanced Tab
PWMMin, PWMPriMin, PWMSec, and PWMPriSec
Properties – Basic Tab
PWMMin, PWMPriMin, PWMSec, and PWMPriSec
Properties – Advanced Tab
VAVActuator Properties – Basic Tab
VAVActuator Properties – Advanced Tab
FanMode1 and FanMode2 Properties – Basic Tab
FanMode1 and FanMode2 Properties – Advanced Tab
HvacMode1 and HvacMode2 Properties – Basic Tab
HvacMode1 and HvacMode2 Properties – Advanced Tab
Setpoint Properties – Basic Tab
Setpoint Properties – Advanced Tab
Display Properties – Basic Tab
Applications View
Assign Application Wizard - Naming the Object Page
Sensor Object Properties – Basic Tab
Sensor Object Properties – Advanced Tab
MNL Device Application Properties – Basic Tab
MNL LonWorks Device Properties – Advanced Tab
Actions Menu – MNL Submenu
MNL LonWorks System Tree Icons
72 MNL LonWorks User Interface
72.1 Properties of I/O Points, Sensor Object, and S-Link Sensor Points – Basic Tab
72.1 Properties of I/O Points, Sensor Object,
and S-Link Sensor Points – Basic Tab
Use the Basic tab to view and edit basic information about I/O points, the Sensor
object, and S-Link sensor points.
04-16006-04-en, March 2015 Technical
2467
72 MNL LonWorks User Interface
72.2 Properties of I/O Points, Sensor Object, and S-Link Sensor Points – Advanced Tab
72.2 Properties of I/O Points, Sensor Object,
and S-Link Sensor Points – Advanced
Tab
Use the Advanced tab to view or edit configuration properties associated with I/O
points, the Sensor object, and S-Link sensor points.
Technical 04-16006-04-en, March 2015
2468
72 MNL LonWorks User Interface
72.3 AnalogIn Properties – Basic Tab
72.3 AnalogIn Properties – Basic Tab
Use the Basic tab of an AnalogIn I/O point to view and edit basic information about
AnalogIn.
For more information, see section 71.1 “MNL LonWorks Objects” on page 2421.
Figure: AnalogIn properties – Basic tab
Table: AnalogIn Properties – Basic Tab
Property Description
Object ID Displays the object ID. The object ID is
composed of three parts: the name of the
attached hardware I/O tag (resource tag) in
WorkPlace Tech Editor, the Building
Operation I/O point type, and the object
name assigned in WorkPlace Tech Editor.
Value Enter an output value for the AnalogIn I/O
point.
Corresponds to the Output property of the
Analog Input object in WorkPlace Tech
Editor.
04-16006-04-en, March 2015 Technical
2469
72 MNL LonWorks User Interface
72.3 AnalogIn Properties – Basic Tab
Continued
Property Description
Status Displays the status of the AnalogIn I/O point.
Corresponds to the Status property of the
Analog Input object in WorkPlace Tech
Editor.
Technical 04-16006-04-en, March 2015
2470
72 MNL LonWorks User Interface
72.4 AnalogInM and AnalogInV Properties – Advanced Tab
72.4 AnalogInM and AnalogInV Properties –
Advanced Tab
Use the Advanced tab of the AnalogInM or AnalogInV I/O point to view or edit
configuration properties associated with AnalogInM or AnalogInV.
For more information, see section 71.1 “MNL LonWorks Objects” on page 2421.
Figure: AnalogInM and AnalogInV properties – Advanced tab
Table: AnalogInM and AnalogInV Properties – Advanced Tab
Property Description
Input low value Enter the input low value, where the Value
output equals the Scaled low value.
Corresponds to the Input Low Value
property of the Analog Input object in
WorkPlace Tech Editor.
Scaled low value Enter the value you want the Value output
to have when the hardware input equals the
Input low value.
Corresponds to the Scaled Low Value
property of the Analog Input object in
WorkPlace Tech Editor.
04-16006-04-en, March 2015 Technical
2471
72 MNL LonWorks User Interface
72.4 AnalogInM and AnalogInV Properties – Advanced Tab
Continued
Property Description
Input high value Enter the input high value, where the Value
output equals the Scaled high value.
Corresponds to the Input High Value
property of the Analog Input object in
WorkPlace Tech Editor.
Scaled high value Enter the value you want the Value output
to have when the hardware input equals the
Input high value.
Corresponds to the Scaled High Value
property of the Analog Input object in
WorkPlace Tech Editor.
Filter constant Enter the filter constant or filter factor applied
to the input, where maximum filter is at 0.01
and minimum filter is at 0.99.
Corresponds to the Filter Constant property
of the Analog Input object in WorkPlace
Tech Editor.
Offset calibration Enter the value to be added to or subtracted
from the calculated output value prior to
placing this value at the Value output.
Corresponds to the Offset property of the
Analog Input object in WorkPlace Tech
Editor.
Sensor type default Displays the default sensor type connected
to the hardware.
Corresponds to the Input Sensor Type
property of the Analog Input object in
WorkPlace Tech Editor.
Input low value default Displays the default value for the Input low
value property.
Scaled low value default Displays the default value for the Scaled
low value property.
Input high value default Displays the default value for the Input high
value property.
Scaled high value default Displays the default value for the Scaled
high value property.
Filter constant default Displays the default value for the Filter
constant property.
Offset calibration default Displays the default value for the Offset
calibration property.
Technical 04-16006-04-en, March 2015
2472
72 MNL LonWorks User Interface
72.5 AnalogInR Properties – Advanced Tab
72.5 AnalogInR Properties – Advanced Tab
Use the Advanced tab of the AnalogInR I/O point to view or edit configuration
properties associated with AnalogInR.
For more information, see section 71.1 “MNL LonWorks Objects” on page 2421.
Figure: AnalogInR properties – Advanced tab
Table: AnalogInR Properties – Advanced Tab
Property Description
Sensor type Select the type of sensor that is connected
to the hardware.
Filter constant Enter the filter constant or filter factor applied
to the input, where maximum filter is at 0.01
and minimum filter is at 0.99.
Corresponds to the Filter Constant property
of the Analog Input object in WorkPlace
Tech Editor.
04-16006-04-en, March 2015 Technical
2473
72 MNL LonWorks User Interface
72.5 AnalogInR Properties – Advanced Tab
Continued
Property Description
Offset calibration Enter the resistance value to be added to or
subtracted from the calculated output value
prior to placing this value at the Value
output.
Corresponds to the Offset Value property of
the Analog Input object in WorkPlace Tech
Editor.
Sensor type default Displays the default sensor type connected
to the hardware.
Corresponds to the Input Sensor Type
property of the Analog Input object in
WorkPlace Tech Editor.
Filter constant default Displays the default value for the Filter
constant property.
Offset calibration default Displays the default value for the Offset
calibration property.
Technical 04-16006-04-en, March 2015
2474
72 MNL LonWorks User Interface
72.6 AnalogInTC and AnalogInTF Properties – Advanced Tab
72.6 AnalogInTC and AnalogInTF
Properties – Advanced Tab
Use the Advanced tab of the AnalogInTC or AnalogInTF I/O point to view or edit
configuration properties associated with AnalogInTC or AnalogInTF.
For more information, see section 71.1 “MNL LonWorks Objects” on page 2421.
Figure: AnalogInTC and AnalogInTF properties – Advanced tab
Table: AnalogInTC and AnalogInTF Properties – Advanced Tab
Property Description
Sensor type Select the type of sensor that is connected
to the hardware.
Filter constant Enter the filter constant or filter factor applied
to the input, where maximum filter is at 0.01
and minimum filter is at 0.99.
Corresponds to the Filter Constant property
of the Analog Input object in WorkPlace
Tech Editor.
04-16006-04-en, March 2015 Technical
2475
72 MNL LonWorks User Interface
72.6 AnalogInTC and AnalogInTF Properties – Advanced Tab
Continued
Property Description
Offset calibration Enter the temperature value that is added to
or subtracted from the calculated output
value prior to placing this value at the Value
output.
Corresponds to the Offset property of the
Analog Input object in WorkPlace Tech
Editor.
Sensor type default Displays the default sensor type connected
to the hardware.
Corresponds to the Input Sensor Type
property of the Analog Input object in
WorkPlace Tech Editor.
Filter constant default Displays the default value for the Filter
constant property.
Offset calibration default Displays the default value for the Offset
calibration property.
Technical 04-16006-04-en, March 2015
2476
72 MNL LonWorks User Interface
72.7 AnalogOut and AnalogOutPri Properties – Basic Tab
72.7 AnalogOut and AnalogOutPri
Properties – Basic Tab
Use the Basic tab of an AnalogOut or AnalogOutPri I/O point to view and edit basic
information about AnalogOut or AnalogOutPri.
For more information, see section 71.1 “MNL LonWorks Objects” on page 2421.
Figure: AnalogOut and AnalogOutPri properties – Basic tab
Table: AnalogOut and AnalogOutPri Properties – Basic Tab
Property Description
Object ID Displays the object ID. The object ID is
composed of three parts: the name of the
attached hardware I/O tag (resource tag) in
WorkPlace Tech Editor, the Building
Operation I/O point type, and the object
name assigned in WorkPlace Tech Editor.
04-16006-04-en, March 2015 Technical
2477
72 MNL LonWorks User Interface
72.7 AnalogOut and AnalogOutPri Properties – Basic Tab
Continued
Property Description
Value Enter the calculated output value. The
output value is a percentage of the input
range established by the Scaled low value
and Scaled high value.
Corresponds to the Output property of the
Analog Output or Analog Output Priority
object in WorkPlace Tech Editor.
Control level Displays the priority input value.
Corresponds to the CtrlLvl property of the
Analog Output Priority object in WorkPlace
Tech Editor.
Technical 04-16006-04-en, March 2015
2478
72 MNL LonWorks User Interface
72.8 AnalogOut and AnalogOutPri Properties – Advanced Tab
72.8 AnalogOut and AnalogOutPri
Properties – Advanced Tab
Use the Advanced tab of the AnalogOut or AnalogOutPri I/O point to view or edit
configuration properties associated with AnalogOut or AnalogOutPri.
For more information, see section 71.1 “MNL LonWorks Objects” on page 2421.
Figure: AnalogOut and AnalogOutPri properties – Advanced tab
Table: AnalogOut and AnalogOutPri Properties – Advanced Tab
Property Description
Output low value Enter the hardware output current that is to
be produced when the input value equals
the Scaled low value.
Corresponds to the Output Low Value
property of the Analog Output or Analog
Output Priority object in WorkPlace Tech
Editor.
04-16006-04-en, March 2015 Technical
2479
72 MNL LonWorks User Interface
72.8 AnalogOut and AnalogOutPri Properties – Advanced Tab
Continued
Property Description
Scaled low value Enter the value you want the I/O point input
to be when the hardware output equals the
value assigned to the Output low value
(and the Value output equals 0.0 %).
Corresponds to the Scaled Low Value
property of the Analog Output or Analog
Output Priority object in WorkPlace Tech
Editor.
Output high value Enter the hardware output current that is to
be produced when the input value equals
the Scaled high value.
Corresponds to the Output High Value
property of the Analog Output or Analog
Output Priority object in WorkPlace Tech
Editor.
Scaled high value Enter the value you want the I/O point input
to be when the hardware output equals the
value assigned to the Output high value
(and the Value output equals 100.0 %).
Corresponds to the Scaled High Value
property of the Analog Output or Analog
Output Priority object in WorkPlace Tech
Editor.
Output low value default Displays the default value for the Output
low value property.
Scaled low value default Displays the default value for the Scaled
low value property.
Output high value default Displays the default value for the Output
high value property.
Scaled high value default Displays the default value for the Scaled
high value property.
Technical 04-16006-04-en, March 2015
2480
72 MNL LonWorks User Interface
72.9 BinaryIn Properties – Basic Tab
72.9 BinaryIn Properties – Basic Tab
Use the Basic tab of a BinaryIn I/O point to view and edit basic information about
BinaryIn.
For more information, see section 71.1 “MNL LonWorks Objects” on page 2421.
Figure: BinaryIn properties – Basic tab
Table: BinaryIn Properties – Basic Tab
Property Description
Object ID Displays the object ID. The object ID is
composed of three parts: the name of the
attached hardware I/O tag (resource tag) in
WorkPlace Tech Editor, the Building
Operation I/O point type, and the object
name assigned in WorkPlace Tech Editor.
Value Displays the value at the point's output.
When forcing this value, select On.
Corresponds to the Output property of the
Binary Input object in WorkPlace Tech
Editor.
04-16006-04-en, March 2015 Technical
2481
72 MNL LonWorks User Interface
72.9 BinaryIn Properties – Basic Tab
Continued
Property Description
Count Displays the total status changes seen at the
hardware input.
Corresponds to the Count property of the
Binary Input object in WorkPlace Tech
Editor.
Technical 04-16006-04-en, March 2015
2482
72 MNL LonWorks User Interface
72.10 BinaryIn Properties – Advanced Tab
72.10 BinaryIn Properties – Advanced Tab
Use the Advanced tab of a BinaryIn I/O point to view or edit configuration
properties associated with BinaryIn.
For more information, see section 71.1 “MNL LonWorks Objects” on page 2421.
Figure: BinaryIn properties – Advanced tab
Table: BinaryIn Properties – Advanced Tab
Property Description
Binary action Click the property box and then select
whether the type of contact or device that is
connected to the MNL device's hardware is
direct-acting or reverse-acting. This correctly
configures the condition at BinaryIn's Value
property.
Corresponds to the Binary Type property of
the Binary Input object in WorkPlace Tech
Editor.
04-16006-04-en, March 2015 Technical
2483
72 MNL LonWorks User Interface
72.10 BinaryIn Properties – Advanced Tab
Continued
Property Description
Reset count Click the property box and then select On to
enable the count. Off resets the count and
holds it at zero.
Corresponds to the Reset property of the
Binary Input object in WorkPlace Tech
Editor.
Binary action default Displays the default value for the Binary
action property.
Reset count default Displays the default value for the Reset
count property.
Technical 04-16006-04-en, March 2015
2484
72 MNL LonWorks User Interface
72.11 BinaryInPls Properties – Basic Tab
72.11 BinaryInPls Properties – Basic Tab
Use the Basic tab of a BinaryInPls I/O point to view and edit basic information
about BinaryInPls.
For more information, see section 71.1 “MNL LonWorks Objects” on page 2421.
Figure: BinaryInPls properties – Basic tab
Table: BinaryInPls Properties – Basic Tab
Property Description
Object ID Displays the object ID. The object ID is
composed of three parts: the name of the
attached hardware I/O tag (resource tag) in
WorkPlace Tech Editor, the Building
Operation I/O point type, and the object
name assigned in WorkPlace Tech Editor.
Pulse rate Displays the pulse rate value at output,
which is calculated as (Pulse constant) x
(pulses per second at input). When forcing
this value, enter a value for the pulse rate
output.
Corresponds to the Output property of the
Binary Input object in WorkPlace Tech Editor
(when configured for pulse input).
04-16006-04-en, March 2015 Technical
2485
72 MNL LonWorks User Interface
72.11 BinaryInPls Properties – Basic Tab
Continued
Property Description
Pulse count Displays the total number of pulses detected
at the hardware input.
Corresponds to the Count property of the
Binary Input object (configured for pulse
input) in WorkPlace Tech Editor.
Technical 04-16006-04-en, March 2015
2486
72 MNL LonWorks User Interface
72.12 BinaryInPls Properties – Advanced Tab
72.12 BinaryInPls Properties – Advanced Tab
Use the Advanced tab of a BinaryInPls I/O point to view or edit configuration
properties associated with BinaryInPls.
For more information, see section 71.1 “MNL LonWorks Objects” on page 2421.
Figure: BinaryInPls properties – Advanced tab
Table: BinaryInPls Properties – Advanced Tab
Property Description
Pulse constant Enter the pulse scaling value used by the
pulse algorithm when calculating a pulses-
per-second frequency Pulse rate value.
Corresponds to the Pulse property of the
Binary Input object in WorkPlace Tech Editor
(when configured for pulse input).
04-16006-04-en, March 2015 Technical
2487
72 MNL LonWorks User Interface
72.12 BinaryInPls Properties – Advanced Tab
Continued
Property Description
Reset outputs Click the property box and then select On to
cause both the Pulse rate and the Pulse
count outputs to be reset and held at zero.
Select Off to enable both Pulse rate and
the Pulse count outputs.
Corresponds to the Reset property of the
Binary Input object in WorkPlace Tech Editor
(when configured for pulse input).
Pulse constant default Displays the default value for the Pulse
constant property.
Reset outputs default Displays the default value for the Reset
outputs property.
Technical 04-16006-04-en, March 2015
2488
72 MNL LonWorks User Interface
72.13 BinaryOut Properties – Basic Tab
72.13 BinaryOut Properties – Basic Tab
Use the Basic tab of a BinaryOut I/O point to view and edit basic information about
BinaryOut.
For more information, see section 71.1 “MNL LonWorks Objects” on page 2421.
Figure: BinaryOut properties – Basic tab
Table: BinaryOut Properties – Basic Tab
Property Description
Object ID Displays the object ID. The object ID is
composed of three parts: the name of the
attached hardware I/O tag (resource tag) in
WorkPlace Tech Editor, the Building
Operation I/O point type, and the object
name assigned in WorkPlace Tech Editor.
Value Select On to turn the device on when
Binary action is set to Direct.
Corresponds to the Ouptut property of the
Binary Output object in WorkPlace Tech
Editor.
04-16006-04-en, March 2015 Technical
2489
72 MNL LonWorks User Interface
72.14 BinaryOut Properties – Advanced Tab
72.14 BinaryOut Properties – Advanced Tab
Use the Advanced tab of a BinaryOut I/O point to view or edit configuration
properties associated with BinaryOut.
For more information, see section 71.1 “MNL LonWorks Objects” on page 2421.
Figure: BinaryOut properties – Advanced tab
Table: BinaryOut Properties – Advanced Tab
Property Description
Binary action Click the property box and then select
Direct to send the monitored input value
directly to the output. Reverse sends the
inverse of the monitored input value to the
output.
Corresponds to the Binary Action property of
the Binary Output object in WorkPlace Tech
Editor.
Binary action default Displays the default value for the Binary
action property.
Technical 04-16006-04-en, March 2015
2490
72 MNL LonWorks User Interface
72.15 DUI Properties – Basic Tab
72.15 DUI Properties – Basic Tab
Use the Basic tab of a DUI I/O point to view and edit basic information for DUI.
For more information, see section 71.1 “MNL LonWorks Objects” on page 2421.
Figure: DUI properties – Basic tab
Table: DUI Properties – Basic Tab
Property Description
Object ID Displays the object ID. The object ID is
composed of three parts: the name of the
attached hardware I/O tag (resource tag) in
WorkPlace Tech Editor, the Building
Operation I/O point type, and the object
name assigned in WorkPlace Tech Editor.
Output 1 Displays the state of Input 1 on the R2R
resistor network.
Output 2 Displays the state of Input21 on the R2R
resistor network.
Output 3 Displays the state of Input31 on the R2R
resistor network.
04-16006-04-en, March 2015 Technical
2491
72 MNL LonWorks User Interface
72.15 DUI Properties – Basic Tab
Continued
Property Description
Output 4 Displays the state of Input41 on the R2R
resistor network.
Output 5 Displays the state of Input51 on the R2R
resistor network.
Input status Displays the status of the input.
Technical 04-16006-04-en, March 2015
2492
72 MNL LonWorks User Interface
72.16 DUI Properties – Advanced Tab
72.16 DUI Properties – Advanced Tab
Use the Advanced tab of a DUI I/O point to view or edit configuration properties
associated with DUI.
For more information, see section 71.1 “MNL LonWorks Objects” on page 2421.
Figure: DUI properties – Advanced tab
Table: DUI Properties – Advanced Tab
Property Description
Binary action 1 Click the property box and then select the
action for Output 1 (Basic tab).
Binary action 2 Click the property box and then select the
action for Output 2 (Basic tab).
Binary action 3 Click the property box and then select the
action for Output 3 (Basic tab).
Binary action 4 Click the property box and then select the
action for Output 4 (Basic tab).
Binary action 5 Click the property box and then select the
action for Output 5 (Basic tab).
04-16006-04-en, March 2015 Technical
2493
72 MNL LonWorks User Interface
72.16 DUI Properties – Advanced Tab
Continued
Property Description
Binary action 1 default Displays the default selection for the Binary
action 1 property.
Binary action 2 default Displays the default selection for the Binary
action 2 property.
Binary action 3 default Displays the default selection for the Binary
action 3 property.
Binary action 4 default Displays the default selection for the Binary
action 4 property.
Binary action 5 default Displays the default selection for the Binary
action 5 property.
Technical 04-16006-04-en, March 2015
2494
72 MNL LonWorks User Interface
72.17 EventInd Properties – Basic Tab
72.17 EventInd Properties – Basic Tab
Use the Basic tab of an EventInd I/O point to view and edit basic information about
EventInd.
For more information, see section 71.1 “MNL LonWorks Objects” on page 2421.
Figure: EventInd properties – Basic tab
Table: EventInd Properties – Basic Tab
Property Description
Object ID Displays the object ID. The object ID is
composed of three parts: the name of the
attached hardware I/O tag (resource tag) in
WorkPlace Tech Editor, the Building
Operation I/O point type, and the object
name assigned in WorkPlace Tech Editor.
Value Select On to turn on the point's output
whenever the Input value is greater than 0
(zero) and an event indication sequence (flick
action) is not in progress.
Corresponds to the Output property of the
Event Indicator object in WorkPlace Tech
Editor.
04-16006-04-en, March 2015 Technical
2495
72 MNL LonWorks User Interface
72.18 EventInd Properties – Advanced Tab
72.18 EventInd Properties – Advanced Tab
Use the Advanced tab of the EventInd I/O point to view or edit configuration
properties associated with EventInd.
For more information, see section 71.1 “MNL LonWorks Objects” on page 2421.
Figure: EventInd properties – Advanced tab
Table: EventInd Properties – Advanced Tab
Property Description
Event time Enter the value which, when matched at the
point's input, starts an event indication
sequence (flick action).
Corresponds to the Event Time property of
the Event Indicator object in WorkPlace Tech
Editor.
Event duration Enter the time duration for the event
indication (flick action).
Corresponds to the Event Duration property
of the Event Indicator object in WorkPlace
Tech Editor.
Technical 04-16006-04-en, March 2015
2496
72 MNL LonWorks User Interface
72.18 EventInd Properties – Advanced Tab
Continued
Property Description
Event time default Displays the default value for the Event
time property.
Event duration default Displays the default value for the Event
duration property.
04-16006-04-en, March 2015 Technical
2497
72 MNL LonWorks User Interface
72.19 FanSpeed1 Properties – Basic Tab
72.19 FanSpeed1 Properties – Basic Tab
Use the Basic tab of a FanSpeed1 I/O point to view and edit basic information
about FanSpeed1.
For more information, see section 71.1 “MNL LonWorks Objects” on page 2421.
Figure: FanSpeed1 properties – Basic tab
Table: FanSpeed1 Properties – Basic Tab
Property Description
Object ID Displays the object ID. The object ID is
composed of three parts: the name of the
attached hardware I/O tag (resource tag) in
WorkPlace Tech Editor, the Building
Operation I/O point type, and the object
name assigned in WorkPlace Tech Editor.
Value Displays On when the fan is operating.
Technical 04-16006-04-en, March 2015
2498
72 MNL LonWorks User Interface
72.20 FanSpeed1 Properties – Advanced Tab
72.20 FanSpeed1 Properties – Advanced Tab
Use the Advanced tab of the FanSpeed1 I/O point to view or edit configuration
properties associated with FanSpeed1.
For more information, see section 71.1 “MNL LonWorks Objects” on page 2421.
Figure: Fanspeed1 properties – Advanced tab
Table: FanSpeed1 Properties – Advanced Tab
Property Description
Minimum on time Enter the minimum time that a digital output
remains on when that particular output or
speed is activated.
Corresponds to the Minimum On Time
property of the Fan Speed object in
WorkPlace Tech Editor.
Purge time Enter the amount of time that an output
remains active after the algorithm sets all
outputs to Off or 0.0 %.
Corresponds to the Purge Time property of
the Fan Speed object in WorkPlace Tech
Editor.
04-16006-04-en, March 2015 Technical
2499
72 MNL LonWorks User Interface
72.20 FanSpeed1 Properties – Advanced Tab
Continued
Property Description
Minimum on time default Displays the default value for the Minimum
on time property.
Purge time default Displays the default value for the Purge
time property.
Technical 04-16006-04-en, March 2015
2500
72 MNL LonWorks User Interface
72.21 FanSpeed2 Properties – Basic Tab
72.21 FanSpeed2 Properties – Basic Tab
Use the Basic tab of a FanSpeed2 I/O point to view and edit basic information
about FanSpeed2.
For more information, see section 71.1 “MNL LonWorks Objects” on page 2421.
Figure: FanSpeed2 properties – Basic tab
Table: FanSpeed2 Properties – Basic Tab
Property Description
Object ID Displays the object ID. The object ID is
composed of three parts: the name of the
attached hardware I/O tag (resource tag) in
WorkPlace Tech Editor, the Building
Operation I/O point type, and the object
name assigned in WorkPlace Tech Editor.
In the case of FanSpeed2, the hardware I/O
tag is attached to the Fan Speed object's
Physical Address High output.
Value Displays the operating mode of the fan.
04-16006-04-en, March 2015 Technical
2501
72 MNL LonWorks User Interface
72.21 FanSpeed2 Properties – Basic Tab
Continued
Property Description
Low speed output Displays Off when low speed operation is
inactive.
Corresponds to the Low Speed property of
the Fan Speed object in WorkPlace Tech
Editor.
High speed output Displays On when high speed operation is
active.
Corresponds to the High Speed property of
the Fan Speed object in WorkPlace Tech
Editor.
Variable speed Displays the calculated speed value.
Corresponds to the Variable Speed property
of the Fan Speed object in WorkPlace Tech
Editor.
Technical 04-16006-04-en, March 2015
2502
72 MNL LonWorks User Interface
72.22 FanSpeed2 and FanSpeed3 Properties – Advanced Tab
72.22 FanSpeed2 and FanSpeed3 Properties –
Advanced Tab
Use the Advanced tab of the FanSpeed2 or FanSpeed3 I/O point to view or edit
configuration properties associated with FanSpeed2 or FanSpeed3.
For more information, see section 71.1 “MNL LonWorks Objects” on page 2421.
Figure: FanSpeed2 and FanSpeed3 properties – Advanced tab
Table: FanSpeed2 and FanSpeed3 Properties – Advanced Tab
Property Description
Kick time Enter a time greater than 1.0 to enable a kick
start (kick time) sequence. This time value
determines how long the kick sequence is in
effect.
Corresponds to the Kick Time property of
the Fan Speed object in WorkPlace Tech
Editor.
04-16006-04-en, March 2015 Technical
2503
72 MNL LonWorks User Interface
72.22 FanSpeed2 and FanSpeed3 Properties – Advanced Tab
Continued
Property Description
Minimum on time Enter the minimum time that a digital output
remains on when that particular output or
speed is activated.
Corresponds to the Minimum On Time
property of the Fan Speed object in
WorkPlace Tech Editor.
Purge time Enter the amount of time that an output
remains active after the algorithm sets all
outputs to Off or 0.0 %.
Corresponds to the Purge Time property of
the Fan Speed object in WorkPlace Tech
Editor.
Kick time default Displays the default value for the Kick time
property.
Minimum on time default Displays the default value for the Minimum
on time property.
Purge time default Displays the default value for the Purge
time property.
Technical 04-16006-04-en, March 2015
2504
72 MNL LonWorks User Interface
72.23 FanSpeed3 Properties – Basic Tab
72.23 FanSpeed3 Properties – Basic Tab
Use the Basic tab of a FanSpeed3 I/O point to view and edit basic information
about FanSpeed3.
For more information, see section 71.1 “MNL LonWorks Objects” on page 2421.
Figure: FanSpeed3 properties – Basic tab
Table: FanSpeed3 Properties – Basic Tab
Property Description
Object ID Displays the object ID. The object ID is
composed of three parts: the name of the
attached hardware I/O tag (resource tag) in
WorkPlace Tech Editor, the Building
Operation I/O point type, and the object
name assigned in WorkPlace Tech Editor.
In the case of FanSpeed3, the hardware I/O
tag is attached to the Fan Speed object's
Physical Address High output.
Value Displays the operating mode of the fan.
04-16006-04-en, March 2015 Technical
2505
72 MNL LonWorks User Interface
72.23 FanSpeed3 Properties – Basic Tab
Continued
Property Description
Low speed output Displays the status of the output for low
speed operation.
Corresponds to the Low Speed property of
the Fan Speed object in WorkPlace Tech
Editor.
Medium speed output Displays the status of the output for medium
speed operation.
Corresponds to the Medium Speed property
of the Fan Speed object in WorkPlace Tech
Editor.
High speed output Displays the status of the output for high
speed operation.
Corresponds to the High Speed property of
the Fan Speed object in WorkPlace Tech
Editor.
Variable speed Displays the calculated speed value.
Corresponds to the Variable Speed property
of the Fan Speed object in WorkPlace Tech
Editor.
Technical 04-16006-04-en, March 2015
2506
72 MNL LonWorks User Interface
72.24 FloatingAct and FloatingActPri Properties – Basic Tab
72.24 FloatingAct and FloatingActPri
Properties – Basic Tab
Use the Basic tab of a FloatingAct or FloatingActPri I/O point to view and edit basic
information about FloatingAct or FloatingActPri.
For more information, see section 71.1 “MNL LonWorks Objects” on page 2421.
Figure: FloatingAct and FloatingActPri properties – Basic tab
Table: FloatingAct and FloatingActPri Properties – Basic Tab
Property Description
Object ID Displays the object ID. The object ID is
composed of three parts: the name of the
attached hardware I/O tag (resource tag) in
WorkPlace Tech Editor, the Building
Operation I/O point type, and the object
name assigned in WorkPlace Tech Editor.
04-16006-04-en, March 2015 Technical
2507
72 MNL LonWorks User Interface
72.24 FloatingAct and FloatingActPri Properties – Basic Tab
Continued
Property Description
Value Displays the position of the floating actuator
as either a calculated position or the actual
value.
Corresponds to the Output property of the
Floating Actuator or Floating Actuator Priority
object in WorkPlace Tech Editor.
Control level Displays the priority number of the currently
active input.
Corresponds to the Control Level property of
the Floating Actuator Priority object in
WorkPlace Tech Editor.
Drive open output Displays On to indicate that the floating
actuator is actively driving towards the open
(100.0 %) position.
Corresponds to the Drive Open property of
the Floating Actuator Priority object in
WorkPlace Tech Editor.
Drive close output Displays On to indicate that the floating
actuator is actively driving towards the
closed (0.0 %) position.
Corresponds to the Drive Close property of
the Floating Actuator Priority object in
WorkPlace Tech Editor.
Technical 04-16006-04-en, March 2015
2508
72 MNL LonWorks User Interface
72.25 FloatingAct and FloatingActPri Properties – Advanced Tab
72.25 FloatingAct and FloatingActPri
Properties – Advanced Tab
Use the Advanced tab of a FloatingAct or FloatingActPri I/O point to view or edit
configuration properties associated with FloatingAct or FloatingActPri.
For more information, see section 71.1 “MNL LonWorks Objects” on page 2421.
Figure: FloatingAct and FloatingActPri properties – Advanced tab
Table: FloatingAct and FloatingActPri Properties – Advanced Tab
Property Description
Drift compensation enable Select On to enable the drift compensation
function.
Corresponds to the Drift Compensation
Enable property of the Floating Actuator or
Floating Actuator Priority object in
WorkPlace Tech Editor.
Drive time Enter the full stroke travel time of the
actuator.
Corresponds to the Drive Time property of
the Floating Actuator or Floating Actuator
Priority object in WorkPlace Tech Editor.
04-16006-04-en, March 2015 Technical
2509
72 MNL LonWorks User Interface
72.25 FloatingAct and FloatingActPri Properties – Advanced Tab
Continued
Property Description
Deadband Enter the deadband range within which the
active output drive is not permitted.
Corresponds to the Deadband property of
the Floating Actuator or Floating Actuator
Priority object in WorkPlace Tech Editor.
Force open input Select On to force the actuator to a full open
condition.
Corresponds to the Force Open property of
the Floating Actuator or Floating Actuator
Priority object in WorkPlace Tech Editor.
Force close input Select On to force the actuator to a full
closed condition. The actuator is driven
closed for the full value of Drive time.
Corresponds to the Force Close property of
the Floating Actuator or Floating Actuator
Priority object in WorkPlace Tech Editor.
Drive mode default Displays the default value for the Drive
mode property.
Drift compensation enable default Displays the default value for the Drift
compensation enable property.
Drive time default Displays the default value for the Drive time
property.
Deadband default Displays the default value for the Deadband
property.
Force open input default Displays the default value for the Force
open input property.
Force close input default Displays the default value for the Force
close input property.
Technical 04-16006-04-en, March 2015
2510
72 MNL LonWorks User Interface
72.26 MomenSS Properties – Basic Tab
72.26 MomenSS Properties – Basic Tab
Use the Basic tab of a MomenSS I/O point to view and edit basic information
about MomenSS.
For more information, see section 71.1 “MNL LonWorks Objects” on page 2421.
Figure: MomenSS properties – Basic tab
Table: MomenSS Properties – Basic Tab
Property Description
Object ID Displays the object ID. The object ID is
composed of three parts: the name of the
attached hardware I/O tag (resource tag) in
WorkPlace Tech Editor, the Building
Operation I/O point type, and the object
name assigned in WorkPlace Tech Editor.
Value Displays the operating mode of the start or
stop pulse for motor control, or the on or off
pulse for some other use.
Corresponds to the Input property of the
Momentary Start/Stop object in WorkPlace
Tech Editor.
04-16006-04-en, March 2015 Technical
2511
72 MNL LonWorks User Interface
72.26 MomenSS Properties – Basic Tab
Continued
Property Description
Start output Display changes from Off to On to indicate
that the start pulse sequence has begun.
This property remains On for the duration of
the start pulse sequence, as defined by
Start pulse duration, and then returns to
Off.
Corresponds to the Output Start property of
the Momentary Start/Stop object in
WorkPlace Tech Editor.
Stop output Display changes from Off to On to indicate
that the stop pulse sequence has begun.
This property remains On for the duration of
the stop pulse sequence, as defined by
Stop pulse duration, and then returns to
Off.
Corresponds to the Output Stop property of
the Momentary Start/Stop object in
WorkPlace Tech Editor.
Technical 04-16006-04-en, March 2015
2512
72 MNL LonWorks User Interface
72.27 MomenSS Properties – Advanced Tab
72.27 MomenSS Properties – Advanced Tab
Use the Advanced tab of a MomenSS I/O point to view or edit configuration
properties associated with MomenSS.
For more information, see section 71.1 “MNL LonWorks Objects” on page 2421.
Figure: MomenSS properties – Advanced tab
Table: MomenSS Properties – Advanced Tab
Property Description
Start pulse duration Enter the On pulse duration for a start pulse
sequence.
Corresponds to the On Pulse property of the
Momentary Start/Stop object in WorkPlace
Tech Editor.
Stop pulse duration Enter the Off pulse duration for a stop pulse
sequence.
Corresponds to the Off Pulse property of the
Momentary Start/Stop object in WorkPlace
Tech Editor.
Start pulse duration default Displays the default value for the Start
pulse duration property.
04-16006-04-en, March 2015 Technical
2513
72 MNL LonWorks User Interface
72.27 MomenSS Properties – Advanced Tab
Continued
Property Description
Stop pulse duration default Displays the default value for the Stop
pulse duration property.
Technical 04-16006-04-en, March 2015
2514
72 MNL LonWorks User Interface
72.28 PressureTransInH20 and PressureTransPa Properties – Basic Tab
72.28 PressureTransInH20 and
PressureTransPa Properties – Basic Tab
Use the Basic tab of a PressureTransInH20 or PressureTransPa I/O point to view
and edit basic information about PressureTransInH20 and PressureTransPa.
For more information, see section 71.1 “MNL LonWorks Objects” on page 2421.
Figure: PressureTransInH20 and PressureTransPa properties – Basic tab
Table: PressureTransInH20 and PressureTransPa Properties – Basic Tab
Property Description
Object ID Displays the object ID. The object ID is
composed of three parts: the name of the
attached hardware I/O tag (resource tag) in
WorkPlace Tech Editor, the Building
Operation I/O point type, and the object
name assigned in WorkPlace Tech Editor.
04-16006-04-en, March 2015 Technical
2515
72 MNL LonWorks User Interface
72.28 PressureTransInH20 and PressureTransPa Properties – Basic Tab
Continued
Property Description
Value Enter the output flow value. The output flow
value is based on the Velocity pressure
and flow rate values at the High flow
calibration and Low flow calibration
inputs.
Corresponds to the Flow property of the
Pressure Transducer object in WorkPlace
Tech Editor.
Velocity pressure Displays the actual velocity pressure value
measured by the pressure transducer on the
MNL VAV device.
Corresponds to the Velocity Pressure
property of the Pressure Transducer object
in WorkPlace Tech Editor.
Flow calibration Displays the current value at the High flow
calibration input.
Corresponds to the Flow Calibration Output
property of the Pressure Transducer object
in WorkPlace Tech Editor.
Status Displays a non-zero value whenever an error
condition is determined by the Pressure
Transducer algorithm.
Corresponds to the Status Flags property of
the Pressure Transducer object in
WorkPlace Tech Editor.
Technical 04-16006-04-en, March 2015
2516
72 MNL LonWorks User Interface
72.29 PressureTransInH20 and PressureTransPa Properties – Advanced Tab
72.29 PressureTransInH20 and
PressureTransPa Properties – Advanced
Tab
Use the Advanced tab of a PressureTransInH20 or PressureTransPa I/O point to
view or edit configuration properties associated with PressureTransInH20 and
PressureTransPa.
For more information, see section 71.1 “MNL LonWorks Objects” on page 2421.
Figure: PressureTransInH20 and PressureTransPa properties – Advanced tab
Table: PressureTransInH20 and PressureTransPa Properties – Advanced Tab
Property Description
High flow calibration Enter the equivalent input flow at differential
pressure of 1.0 in., H2O, or 249 Pa.
Corresponds to the High Flow Calibration
property of the Pressure Transducer object
in WorkPlace Tech Editor.
04-16006-04-en, March 2015 Technical
2517
72 MNL LonWorks User Interface
72.29 PressureTransInH20 and PressureTransPa Properties – Advanced Tab
Continued
Property Description
Low flow calibration Enter the equivalent input flow at differential
pressure of 0.1 in., H2O, or 24.9 Pa.
Corresponds to the Low Flow Calibration
property of the Pressure Transducer object
in WorkPlace Tech Editor.
High flow calibration default Displays the default value for the High flow
calibration property.
Low flow calibration default Displays the default value for the Low flow
calibration property.
Technical 04-16006-04-en, March 2015
2518
72 MNL LonWorks User Interface
72.30 PWMMin, PWMPriMin, PWMSec, and PWMPriSec Properties – Basic Tab
72.30 PWMMin, PWMPriMin, PWMSec, and
PWMPriSec Properties – Basic Tab
Use the Basic tab of a PWMMin, PWMSec, PWMPriMin, or PWMPriSec I/O point
to view and edit basic information about PWMMin, PWMSec, PWMPriMin, or
PWMPriSec.
For more information, see section 71.1 “MNL LonWorks Objects” on page 2421.
Figure: PWMMin, PWMSec, PWMPriMin, and PWMPriSec properties – Basic tab
Table: PWMMin, PWMSec, PWMPriMin, and PWMPriSec Properties – Basic tab
Property Description
Object ID Displays the object ID. The object ID is
composed of three parts: the name of the
attached hardware I/O tag (resource tag) in
WorkPlace Tech Editor, the Building
Operation I/O point type, and the object
name assigned in WorkPlace Tech Editor.
04-16006-04-en, March 2015 Technical
2519
72 MNL LonWorks User Interface
72.30 PWMMin, PWMPriMin, PWMSec, and PWMPriSec Properties – Basic Tab
Continued
Property Description
Value Select On to set the current digital output
state.
Corresponds to the Output property of the
PWM or PWM Priority object in WorkPlace
Tech Editor.
Control level Displays the currently active input by
providing the priority number of the related
input, that is 1, 2, 3, or 4.
Corresponds to the Control Level property of
the PWM Priority object in WorkPlace Tech
Editor.
Technical 04-16006-04-en, March 2015
2520
72 MNL LonWorks User Interface
72.31 PWMMin, PWMPriMin, PWMSec, and PWMPriSec Properties – Advanced Tab
72.31 PWMMin, PWMPriMin, PWMSec, and
PWMPriSec Properties – Advanced Tab
Use the Advanced tab of a PWMMin, PWMSec, PWMPriMin, or PWMPriSec I/O
point to view or edit configuration properties associated with PWMMin, PWMSec,
PWMPriMin, or PWMPriSec.
For more information, see section 71.1 “MNL LonWorks Objects” on page 2421.
Figure: PWMMin, PWMSec, PWMPriMin, and PWMPriSec properties – Advanced tab
Table: PWMMin, PWMSec, PWMPriMin, and PWMPriSec Properties – Advanced
Tab
Property Description
Period Enter the period or total time of each
complete pulse width modulation cycle. A 0
(zero), negative, or "not active" (NA) holds
the Value output (hardware) Off.
Corresponds to the Period property of the
PWM or PWM Priority object in WorkPlace
Tech Editor.
04-16006-04-en, March 2015 Technical
2521
72 MNL LonWorks User Interface
72.31 PWMMin, PWMPriMin, PWMSec, and PWMPriSec Properties – Advanced Tab
Continued
Property Description
On time Enter the minimum On time value, based on
the Time select default property. A
negative value or NA disables this property.
Corresponds to the On time property of the
PWM or PWM Priority object in WorkPlace
Tech Editor.
Off time Enter the minimum Off time value, based on
the Time select default property. A
negative value or NA disables this property.
Corresponds to the Off time property of the
PWM or PWM Priority object in WorkPlace
Tech Editor.
Time select default Displays the default unit of time.
Period default Displays the default value for the Period
property.
On time default Displays the default value for the On time
property.
Off time default Displays the default value for the Off time
property.
Technical 04-16006-04-en, March 2015
2522
72 MNL LonWorks User Interface
72.32 VAVActuator Properties – Basic Tab
72.32 VAVActuator Properties – Basic Tab
Use the Basic tab of a VAVActuator I/O point to view and edit basic information
about VAVActuator.
For more information, see section 71.1 “MNL LonWorks Objects” on page 2421.
Figure: VAVActuator properties – Basic tab
Table: VAVActuator Properties – Basic Tab
Property Description
Object ID Displays the object ID. The object ID is
composed of three parts: the name of the
attached hardware I/O tag (resource tag) in
WorkPlace Tech Editor, the Building
Operation I/O point type, and the object
name assigned in WorkPlace Tech Editor.
Drive A output Displays On when the actuator is driving
towards the Drive A position.
Corresponds to the Drive A property of the
VAV Actuator object in WorkPlace Tech
Editor.
04-16006-04-en, March 2015 Technical
2523
72 MNL LonWorks User Interface
72.32 VAVActuator Properties – Basic Tab
Continued
Property Description
Drive B output Displays On when the actuator is driving
towards the Drive B position.
Corresponds to the Drive B property of the
VAV Actuator object in WorkPlace Tech
Editor.
Technical 04-16006-04-en, March 2015
2524
72 MNL LonWorks User Interface
72.33 VAVActuator Properties – Advanced Tab
72.33 VAVActuator Properties – Advanced
Tab
Use the Advanced tab of a VAVActuator I/O point to view or edit configuration
properties associated with VAVActuator.
For more information, see section 71.1 “MNL LonWorks Objects” on page 2421.
Figure: VAVActuator properties – Advanced tab
Table: VAVActuator Properties – Advanced Tab
Property Description
Drive time Enter the actuator’s full-stroke drive time.
Corresponds to the Drive Time property of
the VAV Actuator object in WorkPlace Tech
Editor.
Actuator action Select Drive A closes to have Drive A close
the damper and Drive B open the damper.
Corresponds to the Action property of the
VAV Actuator object in WorkPlace Tech
Editor.
04-16006-04-en, March 2015 Technical
2525
72 MNL LonWorks User Interface
72.33 VAVActuator Properties – Advanced Tab
Continued
Property Description
Force open input Select On to cause the actuator to drive
towards the full open condition for the time
duration set in Drive time.
Corresponds to the Force Open property of
the VAV Actuator object in WorkPlace Tech
Editor.
Force close input Select On to cause the actuator to drive
towards the full closed condition for the time
duration set in Drive time.
Corresponds to the Force Close property of
the VAV Actuator object in WorkPlace Tech
Editor.
Drive time default Displays the default value for the Drive time
property.
Actuator action default Displays the default value for the Actuator
action property.
Force open input default Displays the default value for the Force
open input property.
Force close input default Displays the default value for the Force
close input property.
Technical 04-16006-04-en, March 2015
2526
72 MNL LonWorks User Interface
72.34 FanMode1 and FanMode2 Properties – Basic Tab
72.34 FanMode1 and FanMode2 Properties –
Basic Tab
Use the Basic tab of the FanMode1 or FanMode2 S-Link sensor point to view and
edit basic information about FanMode1 or FanMode2.
For more information, see section 71.1 “MNL LonWorks Objects” on page 2421.
Figure: FanMode1 and FanMode2 properties – Basic tab
Table: FanMode1 and FanMode2 Properties – Basic Tab
Property Description
Value Displays the fan's operating mode, entered
at the S-Link sensor.
Corresponds to the Value property of the
Fan1 or Fan2 sensor tag in WorkPlace Tech
Editor.
Mode input number Displays the fan number.
Corresponds to the fan number in the
WorkPlace Tech Editor Hardware Wizard.
04-16006-04-en, March 2015 Technical
2527
72 MNL LonWorks User Interface
72.35 FanMode1 and FanMode2 Properties – Advanced Tab
72.35 FanMode1 and FanMode2 Properties –
Advanced Tab
Use the Advanced tab of a FanMode1 or FanMode2 S-Link sensor point to view
or edit configuration properties associated with FanMode1 or FanMode2.
For more information, see section 71.1 “MNL LonWorks Objects” on page 2421.
Figure: FanMode1 and FanMode2 properties – Advanced tab
Table: FanMode1 and FanMode2 Properties – Advanced Tab
Property Description
Fan mode Select the fan's operating mode. The modes
that are available here depend on the fan
type that was selected in WorkPlace Tech
Editor Hardware wizard.
Corresponds to the fan's operating mode,
selected at the S-Link sensor.
Fan mode default Displays the default value for the Fan mode
property.
Technical 04-16006-04-en, March 2015
2528
72 MNL LonWorks User Interface
72.36 HvacMode1 and HvacMode2 Properties – Basic Tab
72.36 HvacMode1 and HvacMode2
Properties – Basic Tab
Use the Basic tab of the HvacMode1 or HvacMode2 S-Link sensor point to view
and edit basic information about HvacMode1 or HvacMode2.
For more information, see section 71.1 “MNL LonWorks Objects” on page 2421.
Figure: HvacMode1 and HvacMode2 properties – Basic tab
Table: HvacMode1 and HvacMode2 Properties – Basic Tab
Property Description
Value Displays the HVAC operating mode entered
at the S-Link sensor.
Corresponds to the output of the HVAC
Mode1 or HVAC Mode2 sensor tag in
WorkPlace Tech Editor.
Mode input number Displays the HVAC mode number.
Corresponds to the HVAC mode number in
the WorkPlace Tech Editor Hardware
Wizard.
04-16006-04-en, March 2015 Technical
2529
72 MNL LonWorks User Interface
72.37 HvacMode1 and HvacMode2 Properties – Advanced Tab
72.37 HvacMode1 and HvacMode2
Properties – Advanced Tab
Use the Advanced tab of an HvacMode1 or HvacMode2 S-Link sensor point to
view or edit configuration properties associated with HvacMode1 or HvacMode2.
For more information, see section 71.1 “MNL LonWorks Objects” on page 2421.
Figure: HvacMode1 and HvacMode2 properties – Advanced tab
Table: HvacMode1 and HvacMode2 Properties – Advanced Tab
Property Description
HVAC mode Click the property box and then select the
HVAC operating mode.
Corresponds to the HVAC operating mode
selected at the S-Link sensor.
HVAC mode default Displays the default value for the HVAC
mode property.
Technical 04-16006-04-en, March 2015
2530
72 MNL LonWorks User Interface
72.38 Setpoint Properties – Basic Tab
72.38 Setpoint Properties – Basic Tab
Use the Basic tab of the Setpoint S-Link sensor point to view and edit basic
information about Setpoint.
For more information, see section 71.1 “MNL LonWorks Objects” on page 2421.
Figure: Setpoint properties – Basic tab
Table: Setpoint Properties – Basic Tab
Property Description
Value Displays the setpoint entered at the S-Link
Sensor.
Corresponds to the output of the Setpoint
sensor tag in WorkPlace Tech Editor.
Setpoint number Displays the Setpoint number.
Corresponds to the order in which the
Setpoint appears in the WorkPlace Tech
Editor Hardware Wizard.
04-16006-04-en, March 2015 Technical
2531
72 MNL LonWorks User Interface
72.38 Setpoint Properties – Basic Tab
Continued
Property Description
Icons enabled Displays which mode or occupancy icon is
enabled for the setpoint at the S-Link
sensor.
Corresponds to the icons you selected in the
WorkPlace Tech Editor Hardware Wizard.
Technical 04-16006-04-en, March 2015
2532
72 MNL LonWorks User Interface
72.39 Setpoint Properties – Advanced Tab
72.39 Setpoint Properties – Advanced Tab
Use the Advanced tab of a Setpoint S-Link sensor point to view or edit
configuration properties associated with Setpoint.
For more information, see section 71.1 “MNL LonWorks Objects” on page 2421.
Figure: Setpoint properties – Advanced tab
Table: Setpoint Properties – Advanced Tab
Property Description
Setpoint Enter a value for the setpoint.
Corresponds to the setpoint value at the S-
Link sensor.
Enable limits Click the property box and then select On to
enable limits for the setpoint adjustment
range.
Corresponds to the check box, Limit the
setpoint value to, in the WorkPlace Tech
Editor Hardware Wizard.
04-16006-04-en, March 2015 Technical
2533
72 MNL LonWorks User Interface
72.39 Setpoint Properties – Advanced Tab
Continued
Property Description
Minimum limit Enter a minimum limit for the setpoint
adjustment.
Corresponds to the Min setpoint limit setting
in the WorkPlace Tech Editor Hardware
Wizard.
Maximum limit Enter a maximum limit for the setpoint
adjustment.
Corresponds to the Max setpoint limit setting
in the WorkPlace Tech Editor Hardware
Wizard.
Setpoint default Displays the default value for the Setpoint
property.
Enable limits default Displays the default value for the Enable
limits property.
Minimum limit default Displays the default value for the Minimum
limit property.
Maximum limit default Displays the default value for the Maximum
limit property.
Technical 04-16006-04-en, March 2015
2534
72 MNL LonWorks User Interface
72.40 Display Properties – Basic Tab
72.40 Display Properties – Basic Tab
Use the Basic tab of the Display S-Link sensor point to view and edit basic
information about Display.
For more information, see section 71.1 “MNL LonWorks Objects” on page 2421.
Figure: Display properties – Basic tab
Table: Display Properties – Basic Tab
Property Description
Value Displays the monitored value you can view at
the S-Link sensor.
Corresponds to the input value at the Display
sensor tag in WorkPlace Tech Editor.
Display number Displays the Display number.
Corresponds to the order in which the
display appears in the WorkPlace Tech
Editor Hardware Wizard.
04-16006-04-en, March 2015 Technical
2535
72 MNL LonWorks User Interface
72.40 Display Properties – Basic Tab
Continued
Property Description
Icons enabled Displays which mode or occupancy icon is
enabled for display at the S-Link sensor.
Corresponds to the selections made for
Select the mode icon that will display and
Select the occupancy icon that will display in
the WorkPlace Tech Editor Hardware
Wizard.
Technical 04-16006-04-en, March 2015
2536
72 MNL LonWorks User Interface
72.41 Applications View
72.41 Applications View
Use the Applications view to view a list of applications that are available for
assignment to MNL LonWorks devices, or to add, edit, or delete an MNL
application.
Figure: Applications view
Table: Applications View
Component Description
Add an application
Click to open WorkPlace Tech Editor, where
you create or import a new application to
add to Building Operation.
Edit an application
Click to open the selected application for
editing in WorkPlace Tech Editor.
Remove an application
Click to remove the selected application
from the list of available applications in
WorkPlace Tech Editor.
Application name Displays the name of the application.
Device type Displays the type of MNL LonWorks device
in which the application is used.
Profile Displays the LonMark profile of the
application.
Category Displays the category that was defined for
the application.
Size Displays the size of the application, in bytes.
Last modified Displays the date and time when the
application was last modified.
04-16006-04-en, March 2015 Technical
2537
72 MNL LonWorks User Interface
72.41 Applications View
Continued
Component Description
Modified by Displays the user who last modified the
application.
Technical 04-16006-04-en, March 2015
2538
72 MNL LonWorks User Interface
72.42 Assign Application Wizard - Naming the Object Page
72.42 Assign Application Wizard - Naming the
Object Page
Use the Naming the object page to choose and assign an application to the MNL
LonWorks device. For more information, see section 70.12 “Assigning an MNL
LonWorks Application ” on page 2412.
Figure: Assign Application wizard – Naming the object page
Table: Assign Application Wizard – Naming the Object Page
Property Description
(application list) Select the type of application you want to
create.
Name Type the name of the object.
Instance Path Displays the path to the application.
Description Type a description for the application.
Type Path Not used.
Only show MNL-800 applications ... Select this check box to filter the application
list and make it easier to select an
application that is appropriate for the MNL-
800 device. Available only with MNL-800
devices.
04-16006-04-en, March 2015 Technical
2539
72 MNL LonWorks User Interface
72.43 Sensor Object Properties – Basic Tab
72.43 Sensor Object Properties – Basic Tab
Use the Basic tab of a Sensor object to view or edit properties associated with
Sensor.
Figure: Sensor object properties – Basic tab
Table: Sensor Object Properties – Basic Tab
Properties Description
Object ID Displays the object ID. The object ID is
composed of three parts: the name of the
attached hardware I/O tag (resource tag) in
WorkPlace Tech Editor, the Building
Operation I/O point type, and the object
name assigned in WorkPlace Tech Editor.
Temperature Displays the current room temperature, read
from the S-Link sensor connected to the
MNL device.
Corresponds to the value at the RoomTemp
sensor tag in WorkPlace Tech Editor.
Technical 04-16006-04-en, March 2015
2540
72 MNL LonWorks User Interface
72.43 Sensor Object Properties – Basic Tab
Continued
Properties Description
Humidity Displays the current room humidity, read
from the S-Link sensor connected to the
MNL device.
Corresponds to the value at the RelHumidity
sensor tag in WorkPlace Tech Editor.
Emergency heat pushbutton Displays On under either of these two
conditions:
• The sensor's emergency heat key is
pressed.
• In the WorkPlace Tech application, an
On value is received at either the
EmerIconStat or EmerSwitch output
sensor tag.
Override state Displays On when the sensor's override key
has been pressed and the sensor is in
occupancy override mode.
Corresponds to the value at the
PBOccMode sensor tag in WorkPlace Tech
Editor.
Time remaining Displays the amount of time remaining in the
active occupancy override mode.
Corresponds to the value at the
OvrdTimeRemain sensor tag in WorkPlace
Tech Editor.
04-16006-04-en, March 2015 Technical
2541
72 MNL LonWorks User Interface
72.44 Sensor Object Properties – Advanced Tab
72.44 Sensor Object Properties – Advanced
Tab
Use the Advanced tab of a Sensor object to view or edit configuration properties
associated with Sensor.
Figure: Sensor object properties – Advanced tab
Table: Sensor Object Properties – Basic Tab
Properties Description
Override time Enter the length of the override period that
starts when the S-Link sensor's override key
is pressed.
Corresponds to the value at the OvrdTime
sensor tag in WorkPlace Tech Editor.
Override time default Displays the default value for Override
time.
Technical 04-16006-04-en, March 2015
2542
72 MNL LonWorks User Interface
72.45 MNL Device Application Properties – Basic Tab
72.45 MNL Device Application Properties –
Basic Tab
In WorkStation, use the Basic tab of an MNL LonWorks device application to view
basic information about the application.
Figure: MNL LonWorks device application properties – Basic tab
Table: MNL LonWorks Device Application Properties – Basic Tab
Property Description
Drawing Displays the file name of the MNL device
application.
Device type Displays the type of MNL device in which the
application is used.
VSD written by Displays the user name of the user who
created the application drawing.
VSD last write time Displays the date and time at which values
were last written to the application.
Object size Displays the size of the application, in bytes.
04-16006-04-en, March 2015 Technical
2543
72 MNL LonWorks User Interface
72.45 MNL Device Application Properties – Basic Tab
Continued
Property Description
Application category Displays a category, if this optional property
was defined for the application in the Import
Wizard. This property makes it possible, in
list views, to sort applications based on their
function or some other criteria.
Application description Displays a description, if this optional
property was entered in the Import Wizard. A
description can be used to more easily
differentiate between applications that have
similar names.
Program ID Displays a unique, alphanumeric
identification for the application's network
profile.
WorkPlace Tech Editor and Monitor
Engineering Guide Supplement (F-27745)
Technical 04-16006-04-en, March 2015
2544
72 MNL LonWorks User Interface
72.46 MNL LonWorks Device Properties – Advanced Tab
72.46 MNL LonWorks Device Properties –
Advanced Tab
Use the Advanced tab of an MNL LonWorks device to view or edit configuration
properties associated with the device or the connected S-Link sensor, and in the
case of VAV devices, the flow balance calibration.
Figure: MNL LonWorks device properties – Advanced tab
Table: MNL LonWorks Device Properties – Advanced Tab
Property Description
Application status Displays the status of the application in the
MNL device.
For more information, see section 70.3
“Application Status” on page 2395.
04-16006-04-en, March 2015 Technical
2545
72 MNL LonWorks User Interface
72.46 MNL LonWorks Device Properties – Advanced Tab
Continued
Property Description
Sensor model Displays the model number of the S-Link
sensor that is defined by the application in
the MNL device.
Temperature Displays the temperature that is being read
by the S-Link sensor connected to the MNL
device.
Humidity Displays the humidity that is being read by
the S-Link sensor connected to the MNL
device.
Active temperature offset Displays the temperature offset, read from
the MNL device.
Active humidity offset Displays the humidity offset, read from the
MNL device.
Temperature offset Enter a value to calibrate the temperature
reading of the S-Link sensor.
Humidity offset Enter a value to calibrate the humidity
reading of the S-Link sensor.
High flow calibration Displays the terminal flow rate, determined at
a velocity pressure of 249 Pa (1.0 in. w.g).
Low flow calibration Displays the terminal box flow rate,
determined at a velocity pressure of 24.9 Pa
(0.1 in. w.g.).
Rotation action Displays the action configuration of the VAV
device. Displays Drive A closes when
Drive A is set to close the damper and Drive
B is set to open it.
Maximum flow setpoint Displays the maximum flow control point
used by the MNL VAV device.
Minimum flow setpoint Displays the minimum flow control point
used by the MNL VAV device.
Heating minimum flow setpoint Displays the minimum flow control point
used by the MNL VAV device during reheat
conditions.
Last flow balance backup time Displays the most recent time at which the
flow balance information in the MNL VAV
device was backed up.
Last flow balance restore time Displays the most recent time at which the
backup flow balance information was
restored to the MNL VAV device.
Technical 04-16006-04-en, March 2015
2546
72 MNL LonWorks User Interface
72.47 Actions Menu – MNL Submenu
72.47 Actions Menu – MNL Submenu
Use the MNL submenu to open WorkPlace Tech Monitor or to perform a task on
an MNL LonWorks device.
Figure: MNL submenu when an MNL device is selected
Table: MNL Submenu
Command Description
Download application Click to download the application of the
selected MNL LonWorks device. For more
information, see section 70.3 “Application
Status” on page 2395.
Launch WorkPlace Tech Monitor Click to open WorkPlace Tech Monitor. For
more information, see section 70.15
“WorkPlace Tech Monitor” on page 2415.
Assign application Click to open the Assign Application Wizard,
where you assign an application to the
selected MNL device. For more information,
see section 72.42 “Assign Application
Wizard - Naming the Object Page” on page
2537.
Reset device Click to reset the selected MNL device.
Backup flow balance information Click to copy the MNL VAV device's flow
balance calibration information to the
Building Operation database. For more
information, see section 71.15 “Flow
Balance Calibration Information” on page
2454.
Restore flow balance information Click to write the flow balance calibration
information contained in the Flow Balance
Information property group, from the
Building Operation database to the MNL
VAV device. For more information, see
section 71.15 “Flow Balance Calibration
Information” on page 2454.
Backup S-Link offsets Click to copy the MNL device's Active
temperature offset and Active
humidity offset values to the
Temperature offset and Humidity
offset properties.
04-16006-04-en, March 2015 Technical
2547
72 MNL LonWorks User Interface
72.47 Actions Menu – MNL Submenu
Continued
Command Description
Restore S-Link offsets Click to write the Temperature offset and
Humidity offset values to the MNL device.
Download configuration properties Click to download configuration properties
to the selected MNL device. For more
information, see section 70.3 “Application
Status” on page 2395.
Technical 04-16006-04-en, March 2015
2548
72 MNL LonWorks User Interface
72.48 MNL LonWorks System Tree Icons
72.48 MNL LonWorks System Tree Icons
The following table describes System Tree icons that are specific to MNL
LonWorks devices.
Table: MNL LonWorks System Tree Icons
Icon Description
Application
Indicates an Application object that is
assigned to an MNL device, created from a
compatible MNL application type.
For more information, see section 70.1
“MNL LonWorks Applications” on page
2391.
MNL LonWorks Device Requires
Action
Indicates that action is required to
synchronize the physical MNL device with its
application in the database.
For more information, see section 70.3
“Application Status” on page 2395.
nci (flag not set)
Indicates that the system uses the NCI value
from the WorkPlace Tech application. Future
application downloads to the MNL device
will also use the NCI value from the
WorkPlace Tech application.
For more information, see section 71.8 “NCI
Values” on page 2434.
nci (flag set)
Indicates that the system uses the NCI value
from the Building Operation database.
Future application downloads to the MNL
device will also use the NCI value from the
Building Operation database.
For more information, see section 71.8 “NCI
Values” on page 2434.
04-16006-04-en, March 2015 Technical
2549
73 BACnet Overview
Topics
BACnet Overview
BACnet Interface
Creating a BACnet Interface
BACnet Folders in the BACnet Interface
Automatically Discovering BACnet Subnetworks
BACnet Communications
BACnet References and System References
Interface Required Identification Properties
BACnet System Configuration Workflows
BACnet System Off-site Configuration Workflow
BACnet System On-site Configuration Workflow
73 BACnet Overview
73.1 BACnet Overview
73.1 BACnet Overview
Building Operation is a native BACnet system with features that enable you to
create and manage an interoperable BACnet building automation system according
to the ASHRAE Standard. Building Operation features and components support the
BACnet services in all five of the BACnet interoperability areas.
Interoperability Building Operation Example
Area
Data sharing • View and modify the properties of BACnet objects
• Monitor and control the values of BACnet objects
• Modify and control setpoints and parameters
For more information, see section 73.7 “BACnet References and
System References” on page 2562.
Alarm and event • Create and define the conditions for algorithmic and intrinsic
management alarming
• Acknowledge alarms and events
• Create and define BACnet notifications and device recipients
For more information, see section 79.6 “BACnet Alarms” on page
2898.
For more information, see section 79.1 “BACnet Notifications” on
page 2879.
Scheduling • Create and modify schedules
• Create and modify exception events for schedules
• Control the start and stop time of schedules
For more information, see section 80.1 “BACnet Schedules” on
page 2935.
Trending • Create and define trend logs for algorithmic and intrinsic
reporting
• Create and modify extended trend logs
• Display trended data
For more information, see section 75.29 “Extended Logging for
External BACnet Trend Logs Workflow” on page 2640.
Device and network • Discover and display information about devices on the BACnet
management internetwork
• Discover and display information about objects in the BACnet
internetwork
• Backup and restore BACnet devices
For more information, see section 75.2 “BACnet Device Discovery”
on page 2606.
For more information, see section 75.39 “BACnet Backup and
Restore” on page 2653.
http://www.bacnet.org/
04-16006-04-en, March 2015 Technical
2553
73 BACnet Overview
73.1 BACnet Overview
73.1.1 BACnet Interface
A BACnet Interface is the BACnet device object of a local server and enables
BACnet communication in Building Operation. In a BACnet internetwork, each
BACnet device maintains one device object whose properties represent the BACnet
device. As the device object of a local server, the BACnet Interface is the BACnet
representation of a server in a BACnet internetwork.
For more information, see section 73.2 “BACnet Interface” on page 2554.
73.1.2 BACnet Networks
Building Operation supports IP networks and MS/TP networks. As a result, you can
host BACnet devices that reside on each type of network.
When you create a BACnet Interface for an Automation Server or an Enterprise
Server, an IP network is automatically created. You can create an MS/TP network in
the BACnet interface of an Automation Server.
For more information, see section 74.1 “BACnet Networks” on page 2573.
73.1.3 BACnet Device Management
BACnet device management is a collection of services that perform administrative,
maintenance, and troubleshooting tasks on a BACnet device.
For more information, see section 75.1 “BACnet Device Management” on page
2603.
73.1.4 BACnet Objects and Properties
You can create BACnet objects in Automation Servers, Enterprise Servers, and
BACnet devices in the Building Operation database.
For more information, see section 76.1 “BACnet Objects and Properties” on page
2663.
73.1.5 BACnet Download and Upload
You can download and upload the properties of a single object or BACnet device,
or the full contents and properties of a BACnet device.
For more information, see section 78.1 “BACnet Download and Upload” on page
2863.
Technical 04-16006-04-en, March 2015
2554
73 BACnet Overview
73.1 BACnet Overview
73.1.6 BACnet System Configuration Workflows
When engineering a BACnet system off-site, you can use WorkStation for Projects
to configure and then deploy a configuration project to an online Enterprise Server
or Automation Server. When on-site, you can then use WorkStation to fine-tune the
configuration on the online server(s), or configure the entire system on-site.
For more information, see section 73.9 “BACnet System Configuration Workflows”
on page 2564.
04-16006-04-en, March 2015 Technical
2555
73 BACnet Overview
73.2 BACnet Interface
73.2 BACnet Interface
A BACnet Interface is the BACnet device object of a local server and enables
BACnet communication in Building Operation. In a BACnet internetwork, each
BACnet device maintains one device object whose properties represent the BACnet
device. As the device object of a local server, the BACnet Interface is the BACnet
representation of a server in a BACnet internetwork.
You create only one BACnet Interface for a server. The server can be an
Automation Server or an Enterprise Server. When you create a BACnet Interface,
the system automatically creates the Application and IP network folders within the
BACnet Interface folder on the System Tree. If you create a BACnet Interface for an
Automation Server, you can optionally create an MS/TP network. For more
information, see section 74.1 “BACnet Networks” on page 2573.
Figure: BACnet Interface in the System Tree
The Application folder of the BACnet Interface is where you create BACnet server
objects. For more information, see section 76.1 “BACnet Objects and Properties”
on page 2663.
The IP network and MS/TP network are the BACnet networks where you add
BACnet devices when you want to host a BACnet device. For more information, see
section 74.1 “BACnet Networks” on page 2573.
73.2.1 BACnet Communications
A BACnet Interface is the mechanism by which you enable BACnet communication
in Building Operation.
For more information, see section 73.6 “BACnet Communications” on page 2561.
73.2.2 BACnet References and System References
In Building Operation, BACnet devices and objects use references to make a
connection between two or more variables for data exchange. For example, you
can create a reference for a setpoint property in a device.
For more information, see section 73.7 “BACnet References and System
References” on page 2562.
Technical 04-16006-04-en, March 2015
2556
73 BACnet Overview
73.2 BACnet Interface
73.2.3 Interface Required Identification Properties
BACnet objects have required identification properties that are defined by the
ASHRAE Standard.
For more information, see section 73.8 “Interface Required Identification Properties”
on page 2563.
73.2.4 BACnet Folders in the BACnet Interface
Use folders within the BACnet Interface to organize the devices and objects into
logical groupings in WorkStation.
For more information, see section 73.4 “BACnet Folders in the BACnet Interface”
on page 2558.
04-16006-04-en, March 2015 Technical
2557
73 BACnet Overview
73.3 Creating a BACnet Interface
73.3 Creating a BACnet Interface
You create the BACnet Interface to enable the BACnet communications port on an
Enterprise Server or Automation Server.
For more information, see section 73.2 “BACnet Interface” on page 2554.
To create a BACnet Interface
1. In WorkStation, in the System Tree, select the location where you want to
create the BACnet Interface.
2. On the File menu, point to New and then click Interface.
3. In the object type list, select BACnet Interface.
4. In the Name box, type a name for the BACnet Interface.
5. In the Description box, type a description for the BACnet Interface.
6. Click Next.
7. Under Instance ID, generate or enter a BACnet Instance ID:
• Click Automatically generated to have the server generate a BACnet
Instance ID for you (Recommended).
• Click Manually entered to manually enter a BACnet Instance ID, and
then type an appropriate Instance ID for the BACnet interface.
Note
• If you enter an Instance ID manually, you must ensure that it is
globally unique among all the BACnet devices on the
internetwork (that is, among all the devices that it can
communicate with).
Continued on next page
Technical 04-16006-04-en, March 2015
2558
73 BACnet Overview
73.3 Creating a BACnet Interface
8. In the BACnet name box, type a name for the BACnet interface. Do not type
a name if you want it assigned for you.
9. In the Network ID box, enter 1, which is the universal standard for all BACnet
IP communications.
10. Click Create.
04-16006-04-en, March 2015 Technical
2559
73 BACnet Overview
73.4 BACnet Folders in the BACnet Interface
73.4 BACnet Folders in the BACnet Interface
Use folders within the BACnet Interface to organize the devices and objects into
logical groupings in WorkStation.
Figure: BACnet devices and objects grouped into folders
You can create folders in three places: a BACnet network, the Application folder of
a BACnet device, and within another folder.
73.4.1 BACnet Network Folders
Use folders in the BACnet network to locate objects by category, such as function
or location. For example, organize all the air-handling units hosted by an
Automation Server into one AHU folder.
For more information, see section 74.1 “BACnet Networks” on page 2573.
Technical 04-16006-04-en, March 2015
2560
73 BACnet Overview
73.4 BACnet Folders in the BACnet Interface
73.4.2 BACnet Device Application Folders
Use folders in the Device Application folder to make it easier for operators to locate
objects by category, such as object type or unit. For example, organize all the
sensors for an air handler into one AHU Sensors folder. You can also use the
Application folders to copy an application that includes graphics and other objects
executed by the Automation Server or Enterprise Server to another BACnet device.
Note
Generally, IDs are assigned by a device during an upload, or by the system during
a download. If you copy and paste folders containing BACnet objects to other
devices, the object names and IDs can remain the same. However, the IDs of
BACnet objects must be unique to each device. If duplicate IDs are detected in
the target destination, the system displays an error message and cancels the
copy command.
73.4.3 Folders within a Folder
Use folders within a folder to organize devices and objects into smaller groups. For
example, create subfolders for sensors, outputs, programs, alarms, and graphics
within an air-handler folder.
73.4.4 Best Practices for Using Folders
To save engineering time, create all the necessary BACnet and Building Operation
objects and folders in one BACnet device first. Then, use this device as the basis for
creating (cloning) additional, similar devices. In WorkStation, follow these steps:
Step Description
1 Upload the device to the Building Operation database.
2 Create folders as needed on the device.
3 Create and configure the BACnet objects and place them into the designated
folders.
4 Create and configure the Building Operation objects and place them into the
designated folders.
5 Export the configured device to preserve the bindings.
6 Import (clone) the configured device as many times as needed.
7 Associate the cloned devices with their respective online devices on the network.
For more information, see the Creating a Folder topic on WebHelp.
04-16006-04-en, March 2015 Technical
2561
73 BACnet Overview
73.5 Automatically Discovering BACnet Subnetworks
73.5 Automatically Discovering BACnet
Subnetworks
You use auto discovery to control the detection of BACnet subnetworks during
BACnet device discovery.
For more information, see section 75.2 “BACnet Device Discovery” on page 2606.
To automatically discover BACnet subnetworks
1. In WorkStation, in the System Tree, select BACnet Interface.
2. On the File menu, click Properties.
3. Click the Basic tab.
4. In the Auto-discover sub-networks box, select one of the following
options:
• Select Yes if you want Building Operation to discover the BACnet devices
on subnetworks during device discovery.
• Select No if you do not want Building Operation to discover the BACnet
devices on subnetworks during device discovery.
5. Click OK.
Technical 04-16006-04-en, March 2015
2562
73 BACnet Overview
73.6 BACnet Communications
73.6 BACnet Communications
A BACnet Interface is the mechanism by which you enable BACnet communication
in Building Operation.
After you create a BACnet Interface, you can perform the following operations in
WorkStation:
• View BACnet devices and their objects.
• Discover BACnet devices. For more information, see section 75.2 “BACnet
Device Discovery” on page 2606.
• Create and configure BACnet objects in the server. For more information, see
section 76.1 “BACnet Objects and Properties” on page 2663.
• Host BACnet devices. For more information, see section 75.21 “Device
Communication and Diagnostics” on page 2631.
• Create and configure BACnet objects in BACnet devices. For more
information, see section 76.1 “BACnet Objects and Properties” on page 2663.
For more information, see section 82.5 “Creating a BACnet Interface” on page
3261.
In the BACnet internetwork, BACnet devices interoperate with the Enterprise Server
and Automation Server. For example, operators can perform the following
operations using a BACnet workstation:
• View the server as a BACnet device.
• View the objects and properties of the server.
• Create and configure BACnet analog, digital, and multistate values in the
server.
• Create and configure BACnet objects, such as trend logs and notifications, in
the server.
• View the properties of BACnet IO points created for IO modules that are
connected to an Automation Server.
04-16006-04-en, March 2015 Technical
2563
73 BACnet Overview
73.7 BACnet References and System References
73.7 BACnet References and System
References
In Building Operation, BACnet devices and objects use references to make a
connection between two or more variables for data exchange. For example, you
can create a reference for a setpoint property in a device.
There are two ways to configure a reference on a network:
• System reference: Use this standard method to create a path-based
reference to an object or property that is currently located on the server.
• BACnet reference: Use this method to create a reference that uses the
elements of a property value (Device instance number, Object type, or Object
instance number) to identify a BACnet object or property that is not currently
on the server but may be uploaded or imported to the server later. You can
also use this method to reference a BACnet object or property on an external
device.
After you create the reference, the system automatically fills in the available
information. If any information is missing in the BACnet reference, you may need to
download or upload the device. For more information, see section 78.1 “BACnet
Download and Upload” on page 2863.
Figure: System reference and BACnet reference examples
Technical 04-16006-04-en, March 2015
2564
73 BACnet Overview
73.8 Interface Required Identification Properties
73.8 Interface Required Identification
Properties
BACnet objects have required identification properties that are defined by the
ASHRAE Standard.
The properties include the object identifier, object name, and object type, which are
required to be unique within the device and the BACnet internetwork.
• Object identifier is the BACnet instance number that identifies a BACnet
device.
To meet this requirement, you need to specify an object identifier for the
BACnet Interface. When you create a BACnet Interface, you can specify an
instance number or use the instance number generated by the server. It is
recommended that you use the number generated by the server.
In Building Operation, Object ID is the equivalent of the object identifier
property, However, the property includes the object type as well as the
instance number of the object, for example, device, 2151234.
• Object name is the BACnet name of an object.
To meet this requirement, you need to specify an object name for the BACnet
Interface. When you create a BACnet Interface, you can specify an object
name or use the default object name. The default name is AS_nnnn or
ES_nnnn where AS is assigned for an Automation Server, ES is assigned for an
Enterprise Server, and _nnnn is the instance number of the server.
In Building Operation, BACnet name is the equivalent of the object name
property.
• Object type is the BACnet object class of an object, for example, device,
notification class, or analog input.
In Building Operation, BACnet type is the equivalent of the object type
property. The object type of a BACnet Interface is device, which displays in
both the Object ID property and the BACnet type property.
04-16006-04-en, March 2015 Technical
2565
73 BACnet Overview
73.9 BACnet System Configuration Workflows
73.9 BACnet System Configuration
Workflows
When engineering a BACnet system off-site, you can use WorkStation for Projects
to configure and then deploy a configuration project to an online Enterprise Server
or Automation Server. When on-site, you can then use WorkStation to fine-tune the
configuration on the online server(s), or configure the entire system on-site.
73.9.1 BACnet System Off-site Configuration
Workflow
Use the BACnet System Off-site Configuration Workflow to deploy a BACnet
project that contains programmable devices, external devices, or a combination of
both, to an Enterprise Server or Automation Server.
For more information, see section 73.10 “BACnet System Off-site Configuration
Workflow” on page 2565.
73.9.2 BACnet System On-site Configuration
Workflow
Use the BACnet System On-site Configuration Workflow to fine-tune BACnet
networks, programmable devices, and external devices on an online Enterprise
Server or Automation Server. Alternately, you can configure an entire system on-site
on the online servers.
For more information, see section 73.11 “BACnet System On-site Configuration
Workflow” on page 2568.
Technical 04-16006-04-en, March 2015
2566
73 BACnet Overview
73.10 BACnet System Off-site Configuration Workflow
73.10 BACnet System Off-site Configuration
Workflow
Use the BACnet System Off-site Configuration Workflow to deploy a BACnet
project that contains programmable devices, external devices, or a combination of
both, to an Enterprise Server or Automation Server.
In WorkStation for Projects, follow this sequence.
Figure: BACnet off-site system configuration workflow
04-16006-04-en, March 2015 Technical
2567
73 BACnet Overview
73.10 BACnet System Off-site Configuration Workflow
Create BACnet networks
Create and configure the networks for the BACnet system:
• IP network. For more information, see section 74.3 “Creating an Additional
BACnet IP Network” on page 2579.
• MS/TP network. For more information, see section 83.3 “Creating a BACnet
MS/TP Network” on page 3272.
• Remote network. For more information, see section 74.9 “Creating a BACnet
Remote Network ” on page 2587.
Create offline BACnet devices
Create and configure the BACnet devices for each network:
• BACnet devices. For more information, see section 75.4 “Creating a BACnet
Device” on page 2608.
• IA Series BACnet devices. For more information, see section 75.5 “Creating an
I/A Series (MNB) BACnet Device” on page 2610.
• BBMD devices. For more information, see section 75.31 “Creating a BBMD”
on page 2645.
Create BACnet objects
Create and configure BACnet objects on each network:
• BACnet points. For more information, see section 76.10 “Creating a BACnet
Point in a Server” on page 2675.
• BACnet values. For more information, see section 76.24 “Creating a BACnet
Value” on page 2756.
• BACnet trend logs. For more information, see section 76.43 “Creating a
BACnet Trend Log” on page 2825.
• BACnet schedules. For more information, see section 80.6 “Creating a BACnet
Schedule” on page 2945.
Import third-party devices
Import one or more external device configurations that originated outside of Building
Operation, such as Viconics or bCX. Then, configure one of the devices to use as a
template for creating additional devices of that type. After deployment to an online
system, you can discover and then associate the devices on the network.
For more information, see section 18.27 “Importing a Solution” on page 594.
Create offline third-party devices
Create and configure third-party devices that act as placeholders in the BACnet
system. After deployment to an online system, you can discover and then associate
the devices on the network.
For more information, see section 75.4 “Creating a BACnet Device” on page 2608.
Deploy the Automation Servers
Deploy the Automation Servers to the on-site server.
Technical 04-16006-04-en, March 2015
2568
73 BACnet Overview
73.10 BACnet System Off-site Configuration Workflow
Caution
Ensure that you have created all domain devices and objects before the deploy of
an Automation Server. If you add devices and objects to the Automation Server
and deploy the server again, you first have to clear the database of the physical
Automation Server. For more information, see section 6.8 “Deploy” on page 248.
For more information, see section 6.12 “Deploying a Server” on page 260.
Update server communication parameters
In WorkStation for Projects, update the server communication parameters for all
servers.
For more information, see section 4.9 “Updating Project Configuration Server
Communication Parameters” on page 187.
Important
It is recommended that you update the Enterprise Server communication
parameters before the deploy of the first Automation Server.
For more information, see section 4.9 “Updating Project Configuration Server
Communication Parameters” on page 187.
Deploy Enterprise Server
In WorkStation for Projects, deploy the Enterprise Server.
Important
Ensure that you have created all Automation Servers in the project before the
deploy of the Enterprise Server. You can only deploy to an empty Enterprise
Server. Any additional Automation Servers have to be created on the on-site
server.
For more information, see section 6.8 “Deploy” on page 248.
For more information, see section 6.12 “Deploying a Server” on page 260.
04-16006-04-en, March 2015 Technical
2569
73 BACnet Overview
73.11 BACnet System On-site Configuration Workflow
73.11 BACnet System On-site Configuration
Workflow
Use the BACnet System On-site Configuration Workflow to fine-tune BACnet
networks, programmable devices, and external devices on an online Enterprise
Server or Automation Server. Alternately, you can configure an entire system on-site
on the online servers.
In WorkStation, follow this sequence.
Figure: BACnet on-site system configuration workflow
Discover BACnet devices
Use Device Discovery to identify installed Building Operation server hardware and
BACnet devices in the BACnet network.
For more information, see section 75.3 “Discovering a BACnet Device” on page
2607.
Associate BACnet devices
Associate a BACnet instance number to a deployed device. The association with an
instance number enables the device to go online.
For more information, see section 75.6 “Associating a BACnet Instance Number
with a Device ” on page 2611.
Technical 04-16006-04-en, March 2015
2570
73 BACnet Overview
73.11 BACnet System On-site Configuration Workflow
Download devices
Download the configuration data from the online server to each deployed device to
update all of the objects and properties of the device.
For more information, see section 78.5 “Downloading the Contents of a BACnet
Device” on page 2868.
Upload external devices
Upload the configuration data from each external device to the server to update all
of the objects and properties of the device to the Building Operation server's
database.
For more information, see section 78.12 “Uploading the Contents of a BACnet
Device” on page 2876.
Download networks
Download the contents of a BACnet network from the Building Operation server's
database to update all of the devices, objects, and properties of the network.
• For more information, see section 78.6 “Downloading an IP Network” on page
2869.
• For more information, see section 78.7 “Downloading an MSTP Network” on
page 2870.
• For more information, see section 78.8 “Downloading a Remote Network” on
page 2871.
04-16006-04-en, March 2015 Technical
2571
74 BACnet Networks
Topics
BACnet Networks
IP Network
Creating an Additional BACnet IP Network
Configuring a BACnet IP Network
MS/TP Network
Creating a BACnet MS/TP Network
Configuring a BACnet MS/TP Network
Remote Network
Creating a BACnet Remote Network
Configuring a BACnet Remote Network
BACnet Internetwork
Best Practices for Multiple IP Networks and BBMDs
Diagnosing Polled Variables on a BACnet Network
Optimizing System Performance Using BACnet Polling
Intervals
BACnet Gateway
74 BACnet Networks
74.1 BACnet Networks
74.1 BACnet Networks
Building Operation supports IP networks, MS/TP networks, Remote networks, and
the Internetwork. As a result, you can host BACnet devices that reside on each type
of network.
74.1.1 IP Network
Automation Servers and Enterprise Servers communicate with BACnet devices
over IP networks. The system automatically creates an initial IP network when you
create a BACnet Interface. However, you can create additional IP networks to join
one or more subnetworks to the BACnet network.
For more information, see section 74.2 “IP Network” on page 2576.
74.1.2 MS/TP Network
Create a MS/TP network in the BACnet Interface of an Automation Server when you
want to host BACnet devices that can communicate with the server, such as b3
BACnet devices.
For more information, see section 74.5 “MS/TP Network” on page 2581.
74.1.3 Remote Network
A remote network is a BACnet network that is not directly connected to an
Automation Server or Enterprise Server. Devices created on remote networks use
BACnet routers to communicate to other devices in the BACnet internetwork.
For more information, see section 74.8 “Remote Network” on page 2585.
74.1.4 BACnet Internetwork
A BACnet Internetwork comprises all the different networks including IP, MS/TP,
and Remote, which are set up to communicate with each other.
For more information, see section 74.11 “BACnet Internetwork” on page 2590.
74.1.5 Poll Interval
A poll interval is the interval at which the system reads a variable, such as one-half
second (500 ms). A polling delay or lag is the difference between the time
WorkStation scheduled a poll of a variable from a BACnet object and when the
variable was actually polled. A high number, such as 10,000 milliseconds, may
indicate the system is under a greater load than the network can process in a timely
manner. For example, if you set a poll on a variable property in WorkStation for
4:00:00 PM, but the system actually polls the property at 4:00:10 PM, the delay is
10 seconds (10,000 milliseconds).
04-16006-04-en, March 2015 Technical
2575
74 BACnet Networks
74.1 BACnet Networks
Note
Lag depends upon the type of network. For example, an IP network runs faster
than an MS/TP network. Furthermore, a network of b3s running in enhanced
MS/TP mode runs faster than one running in non-enhanced mode. For more
information, see section 83.4 “Configuring the MS/TP Network for b3
Communication” on page 3274.
In Building Operation, a large number of polled variables may directly affect system
response time. However, you can optimize system performance of polled BACnet
variables by (1) reducing the number of polled variables in a graphic or Watch pane,
(2) fine-tuning the BACnet polling interval settings, or (3) both. For more information,
see section 161.1 “System Performance Diagnostics” on page 5637.
74.1.6 BACnet Gateway
When your installation includes non-BACnet devices and networks, you can employ
a BACnet Gateway to expose the foreign objects and devices as BACnet objects
and devices. To provide communication, interconnectivity, and visibility, a BACnet
gateway can bridge the primary BACnet network to the non-standard networks.
The two widely used approaches for implementing a BACnet Gateway are BACnet
device and Router to Virtual BACnet devices.
For more information, see section 74.15 “BACnet Gateway” on page 2598.
74.1.7 Summary
Devices and objects in a BACnet network conform to the requirements published
by ASHRAE, the American Society of Heating, Refrigerating, and Air-Conditioning
Engineers. The ASHRAE Standard is a data communication protocol for building
and automation control networks.
The following illustration provides an overview of BACnet.
Technical 04-16006-04-en, March 2015
2576
74 BACnet Networks
74.1 BACnet Networks
Figure: BACnet system overview
04-16006-04-en, March 2015 Technical
2577
74 BACnet Networks
74.2 IP Network
74.2 IP Network
Automation Servers and Enterprise Servers communicate with BACnet devices
over IP networks. The system automatically creates an initial IP network when you
create a BACnet Interface. However, you can create additional IP networks to join
one or more subnetworks to the BACnet network.
Figure: IP Network
Technical 04-16006-04-en, March 2015
2578
74 BACnet Networks
74.2 IP Network
74.2.1 Multiple BACnet IP Networks
You can create multiple IP networks in the BACnet system as long as each network
has a unique identifier (network Id and name) and UDP/IP port number. The unique
identifier and port number ensures that there is a single communication path
between any two devices, which is required by BACnet. For more information, see
section 74.3 “Creating an Additional BACnet IP Network” on page 2579.
Figure: Multiple BACnet IP networks in the BACnet Internetwork
For more information, see section 74.4 “Configuring a BACnet IP Network” on page
2580.
04-16006-04-en, March 2015 Technical
2579
74 BACnet Networks
74.2 IP Network
74.2.2 Best Practices for Multiple IP Networks and
BBMDs
There are guidelines for configuring multiple BACnet IP networks or BBMDs to
ensure that the communication channels are distinct in the BACnet system.
For more information, see section 74.12 “Best Practices for Multiple IP Networks
and BBMDs” on page 2592.
Technical 04-16006-04-en, March 2015
2580
74 BACnet Networks
74.3 Creating an Additional BACnet IP Network
74.3 Creating an Additional BACnet IP
Network
You create another IP network to set up a communication channel that is distinct
from another IP network installed on the same server.
For more information, see section 74.2 “IP Network” on page 2576.
To create an additional BACnet IP Network
1. In WorkStation, in the System Tree, select the BACnet Interface.
2. On the File menu, point to New and then click IP Network.
3. In the Name box, type a name for the IP network.
4. In the Description box, type a description for the IP network.
5. Click Next.
6. In the Network ID box, enter a unique number between 1 and 65534.
7. Select the Defer ID assignment check box to assign a network ID after the
network is created.
8. Click Create.
You can now maintain multiple IP networks on the same server.
04-16006-04-en, March 2015 Technical
2581
74 BACnet Networks
74.4 Configuring a BACnet IP Network
74.4 Configuring a BACnet IP Network
You configure a BACnet IP network to change the IP address, IP port, or Network
ID. By default, all BACnet IP devices use UDP/IP port 47808.
For more information, see section 74.2 “IP Network” on page 2576.
To configure a BACnet IP network
1. In WorkStation, in the System Tree, expand BACnet Interface.
2. On the List View, select the IP network that you want to modify.
3. On the File menu, click Properties.
4. In the Description box, type a description for the BACnet device.
5. Edit the properties.
Property Description
Online Displays True when the Building Operation server is available
on the BACnet IP network.
Reliability Displays any error status for a network that is configured as a
foreign device.
Out Of Service Set to True to disable the IP network from the BACnet
system.
IP address Displays the IP address of the server represented by the
BACnet Interface.
IP port number Displays the IP port number of the server represented by
the BACnet Interface.
Network ID Displays the Network ID of the BACnet IP network.
Maximum APDU Displays the maximum size of a message that a device on the
length accepted network can accept.
IP broadcast Displays the IP address used to send broadcast messages on
address a BACnet IP network.
BBMD IP address Type the IP address of the BBMD to register the network as a
foreign device with the BBMD.
BBMD port Enter the port number of the BBMD to register the network as
number a foreign device with the BBMD.
6. Click OK.
Technical 04-16006-04-en, March 2015
2582
74 BACnet Networks
74.5 MS/TP Network
74.5 MS/TP Network
Create a MS/TP network in the BACnet Interface of an Automation Server when you
want to host BACnet devices that can communicate with the server, such as b3
BACnet devices.
Figure: MS/TP Network
04-16006-04-en, March 2015 Technical
2583
74 BACnet Networks
74.6 Creating a BACnet MS/TP Network
74.6 Creating a BACnet MS/TP Network
You create an MS/TP network in order to connect a b3 BACnet device or other
BACnet device to an Automation Server.
For more information, see section 74.1 “BACnet Networks” on page 2573.
To create a BACnet MS/TP network
1. In WorkStation, in the System Tree, select the BACnet Interface.
2. On the File menu, point to New and then click MSTP Network.
3. In the Name box, type a name for the MS/TP network.
4. In the Description box, type a description for the MS/TP network.
5. Click Next.
Continued on next page
Technical 04-16006-04-en, March 2015
2584
74 BACnet Networks
74.6 Creating a BACnet MS/TP Network
6. In the Network ID box, enter a unique number between 1 and 65534.
7. Select the Defer ID assignment check box to assign a network ID after the
MS/TP network is created.
8. In the MAC address box, enter the number that represents the Automation
Server's address on the MS/TP network.
9. In the RS-485 port box, enter the location of the serial port RS485-COMA
or RS485-COMB.
10. Click Create.
04-16006-04-en, March 2015 Technical
2585
74 BACnet Networks
74.7 Configuring a BACnet MS/TP Network
74.7 Configuring a BACnet MS/TP Network
You configure a BACnet MS/TP network to change the MAC address, MSTP baud
rate, or Maximum information frames.
For more information, see section 74.5 “MS/TP Network” on page 2581.
To configure a BACnet MS/TP network
1. In WorkStation, in the System Tree, expand BACnet Interface of the
Automation Server.
2. In List View, select the MS/TP Network you want to modify.
3. On the File menu, click Properties.
4. Edit the properties.
Property Description
Online Displays True when the Building Operation server is
available on the BACnet MS/TP network.
Network ID View or enter the Network ID of the MS/TP network.
Enter a number from 1 to 65534 that uniquely identifies the
network over the entire BACnet internetwork.
RS-485 port View or enter the path to the serial port on the Automation
Server.
MAC address View or enter the MS/TP MAC address of the Automation
Server. Enter a number between 0 and 127. Most
installations use 0.
MSTP baud rate View or select the MS/TP baud rate.
Enhanced mode Select True to improve throughput when used with b3
devices. Enhanced mode allocates more bandwidth to the
Automation Server. This setting has no effect on other
(non-b3) MS/TP devices.
Select False if you anticipate heavy communication among
the MS/TP devices, or if strict BACnet compliance is
required.
Maximum master Enter the highest used address of the master nodes on the
MS/TP network. Enter a number between 0 and 127.
Maximum Enter the maximum number of information frames that can
information frames be sent before the BACnet device is required to pass a
token on the MS/TP network.
Maximum APDU Displays the maximum size of a message that a device on
length accepted the network can accept.
5. Click OK.
Technical 04-16006-04-en, March 2015
2586
74 BACnet Networks
74.8 Remote Network
74.8 Remote Network
A remote network is a BACnet network that is not directly connected to an
Automation Server or Enterprise Server. Devices created on remote networks use
BACnet routers to communicate to other devices in the BACnet internetwork.
Figure: BACnet Network
For example, you hosted BACnet device_208808 that serves as a router to BACnet
device_10925. In this scenario, BACnet device_10925 is on a network that is not
directly connected to the server. To host the device, you create the BACnet
network for the device, and then host the device. For more information, see section
74.9 “Creating a BACnet Remote Network ” on page 2587.
04-16006-04-en, March 2015 Technical
2587
74 BACnet Networks
74.8 Remote Network
Figure: BACnet network in System Tree
Technical 04-16006-04-en, March 2015
2588
74 BACnet Networks
74.9 Creating a BACnet Remote Network
74.9 Creating a BACnet Remote Network
You create a BACnet remote network when you connect to a BACnet device that
resides on a network not directly connected to the server.
For more information, see section 74.8 “Remote Network” on page 2585.
To create a BACnet remote network
1. In WorkStation, in the System Tree, expand BACnet Interface, and
expand IP Network or MSTP Network.
2. Select the BACnet device.
3. On the File menu, point to New and click BACnet network.
4. In the Name box, type a name for the BACnet network.
5. In the Description box, type a description for the BACnet network.
6. Click Next.
Continued on next page
04-16006-04-en, March 2015 Technical
2589
74 BACnet Networks
74.9 Creating a BACnet Remote Network
7. In the Network ID box, enter a network ID for the BACnet network.
8. Click Create.
Technical 04-16006-04-en, March 2015
2590
74 BACnet Networks
74.10 Configuring a BACnet Remote Network
74.10 Configuring a BACnet Remote Network
You configure a BACnet remote network to add a description or note.
For more information, see section 74.8 “Remote Network” on page 2585.
To configure a BACnet remote network
1. In WorkStation, in the System Tree, expand BACnet Interface, and then
expand the IP Network or MSTP Network where the BACnet device
resides.
2. Expand the BACnet device and select the BACnet network you want to
modify.
3. On the File menu, click Properties.
4. In the Description box, type a description for the network.
5. In the Note box, type text that you want to display in a graphic or use when
searching for the object.
6. Click OK.
04-16006-04-en, March 2015 Technical
2591
74 BACnet Networks
74.11 BACnet Internetwork
74.11 BACnet Internetwork
A BACnet Internetwork comprises all the different networks including IP, MS/TP,
and Remote, which are set up to communicate with each other.
Figure: BACnet Internetwork
In the BACnet internetwork, BACnet devices interoperate with the Enterprise Server
and Automation Server. For example, operators can perform the following
operations using a BACnet workstation:
• View the server as a BACnet device.
• View the objects and properties of the server.
• Create and configure BACnet analog, digital, and multistate values in the
server.
Technical 04-16006-04-en, March 2015
2592
74 BACnet Networks
74.11 BACnet Internetwork
• Create and configure BACnet objects, such as trend logs and notifications, in
the server.
• View the properties of BACnet IO points created for IO modules that are
connected to an Automation Server.
Tip
The Device Discovery view displays all BACnet devices and objects discovered in
the BACnet internetwork. For more information, see section 75.2 “BACnet Device
Discovery” on page 2606.
04-16006-04-en, March 2015 Technical
2593
74 BACnet Networks
74.12 Best Practices for Multiple IP Networks and BBMDs
74.12 Best Practices for Multiple IP Networks
and BBMDs
There are guidelines for configuring multiple BACnet IP networks or BBMDs to
ensure that the communication channels are distinct in the BACnet system.
Once the IP networks or BBMDs are configured, you can use Device Discovery to
locate devices on all the IP subnets in the BACnet network.
74.12.1 Multiple IP Networks
Since BACnet requires a single communication path between any two devices,
consider the following points when setting up one or more IP networks in a BACnet
system:
• Network Id. Configure a unique network ID for each IP network installed on
the same server. If you defer assigning an ID when creating an IP network, you
can add the network ID later. For more information, see section 81.30 “BACnet
IP Network Properties – Basic Tab” on page 3008.
• Network name. Define a unique network name for each IP network installed
on the same server. As a precaution, the system automatically appends a
number to the default name to avoid duplication. For more information, see
section 74.4 “Configuring a BACnet IP Network” on page 2580.
• Additional network. To avoid routing loops, use a UDP/IP port number that
is not being used by another Building Operation server or BACnet device when
opening up an additional network. By default, all BACnet IP devices use
UDP/IP port 47808. For more information, see section 160.7 “Routing Loops”
on page 5633.
For more information, see section 74.2 “IP Network” on page 2576.
74.12.2 BBMDs and IP Networks
Generally, you create a BBMD if you want to register a foreign device that resides
on a solitary IP subnet, or to set up communication with other BBMDs in the
BACnet system. For example, IP Network-A includes a BBMD, IP Network-B
includes a BBMD, and IP Network-C includes a foreign device. If registered, a
Building Operation server can also serve as a foreign device in the BACnet system.
Consider the following points when configuring BBMDs or foreign devices:
• Network Id. Configure a unique IP network ID for each BBMD installed on the
same Building Operation server. For more information, see section 81.30
“BACnet IP Network Properties – Basic Tab” on page 3008.
• BBMD to register server. Create a BBMD if you want to register a foreign
device that resides on a solitary IP subnet to allow the device to join the
BACnet system. For more information, see section 75.31 “Creating a BBMD”
on page 2645.
• Multiple BBMDs. Configure each BBMD with a different UDP/IP port if you
plan to install multiple BBMDs on the same BACnet IP network to prevent
broadcast storms. For more information, see section 160.8 “Broadcast
Storms” on page 5634.
Technical 04-16006-04-en, March 2015
2594
74 BACnet Networks
74.12 Best Practices for Multiple IP Networks and BBMDs
• Register server as foreign device. Register a Building Operation server as
a foreign device with a BBMD to allow the server (and its BACnet/IP devices) to
join the BACnet system. For more information, see section 75.33 “Registering
a Building Operation Server as a Foreign Device” on page 2647.
For more information, see section 75.30 “BBMDs and Foreign Devices” on page
2642.
04-16006-04-en, March 2015 Technical
2595
74 BACnet Networks
74.13 Diagnosing Polled Variables on a BACnet Network
74.13 Diagnosing Polled Variables on a
BACnet Network
You diagnose polled variables on a BACnet network to observe the various polling
times on each network. The system calculates these polling values every five
minutes of server operation, and then the values are reset. You can also determine
how many properties use the more efficient BACnet COV service instead of the
explicit read-property polling.
For more information, see section 74.1 “BACnet Networks” on page 2573.
To diagnose polled variables on a BACnet network
1. In WorkStation, in the System Tree, expand System folder.
2. Expand the Modules folder, BACnet devices, and then Diagnostics.
Objects in the Diagnostics folder vary with the server, for example, an
Automation Server may also include MS/TP diagnostic objects (if installed).
Continued on next page
Technical 04-16006-04-en, March 2015
2596
74 BACnet Networks
74.13 Diagnosing Polled Variables on a BACnet Network
3. Select a diagnostic object for a BACnet network containing a large number of
polled objects.
Continued on next page
04-16006-04-en, March 2015 Technical
2597
74 BACnet Networks
74.13 Diagnosing Polled Variables on a BACnet Network
4. View the following read-only polling statistics, which are reset for every five
minutes of server operation:
Property Description
Average polling delay Displays the average lag between the time
WorkStation scheduled a poll of a variable from a
BACnet object and when the variable was actually
polled.
Minimum polling delay Displays the minimum polling lag between the time
WorkStation scheduled a poll of a variable from a
BACnet object and when the variable was actually
polled.
Maximum polling delay Displays the maximum polling lag between the time
WorkStation scheduled a poll of a variable from a
BACnet object and when the variable was actually
polled.
Number of polled Displays the total number of polled variables on the
variables BACnet network.
Number of COV Displays the total number of Change Of Value variables
variables on the BACnet network. A zero (0) indicates that there
are no variables present.
5. View the number of COV variables, if available.
6. Drag and drop one or more diagnostic variables to the Watch pane.
7. Set up the Watch pane to view the CPU usage and System memory usage of
the server.
Now you can set up the Watch pane to view the CPU usage and System memory
usage of the server. For more information, see section 3.25 “Displaying CPU and
System Memory Usage” on page 169.
Technical 04-16006-04-en, March 2015
2598
74 BACnet Networks
74.14 Optimizing System Performance Using BACnet Polling Intervals
74.14 Optimizing System Performance Using
BACnet Polling Intervals
To improve system performance, you can fine-tune the polling intervals for an
installed BACnet network that contains graphics containing numerous polled
objects.
For more information, see section 74.1 “BACnet Networks” on page 2573.
To optimize system performance using BACnet polling
intervals
1. In WorkStation, in the System Tree, select the BACnet Interface of the server
that you want to diagnose.
2. On the File menu, point to Properties.
3. Click the Advanced tab and scroll down to the bottom of the page.
4. In the Minimum polling interface for local IP network box, enter the
number of milliseconds for the polling interval for all the installed IP networks,
for example, 1000 (1 second).
5. In the Minimum polling interface for remote network box, enter the
number of milliseconds for an installed remote BACnet network, for example,
1000.
6. In the Minimum polling interface for MSTPA network box, enter the
number of milliseconds (on an Automation Server only) for an installed MS/TP
COMA network, for example, 1000.
7. In the Minimum polling interface for MSTPB network box, enter the
number of milliseconds (on an Automation Server only) for an installed MS/TP
COMB network, for example, 1000.
8. Click OK.
9. In the Watch pane, monitor any change in the CPU or system memory usage.
Keep in mind that the fine-tuning only affects the polled intervals of BACnet objects
that reside on BACnet networks. These polling interval settings override the default
system interval, which is one-half second (500 ms). For example, you can adjust the
polling interval from zero (default) to one second (1000 ms) to adjust the polling
interval frequency of the BACnet objects on IP networks.
04-16006-04-en, March 2015 Technical
2599
74 BACnet Networks
74.15 BACnet Gateway
74.15 BACnet Gateway
When your installation includes non-BACnet devices and networks, you can employ
a BACnet Gateway to expose the foreign objects and devices as BACnet objects
and devices. To provide communication, interconnectivity, and visibility, a BACnet
gateway can bridge the primary BACnet network to the non-standard networks.
The two widely used approaches for implementing a BACnet Gateway are BACnet
device and Router to Virtual BACnet devices.
74.15.1 BACnet Gateway as BACnet Device
BACnet Gateways may represent non-BACnet objects as BACnet objects in a
BACnet device. The non-BACnet source objects may reside on the BACnet
Gateway, or on a non-BACnet device and network connected to the BACnet
Gateway.
Figure: BACnet Gateway as BACnet device
The BACnet device method isolates the source objects from the primary BACnet
network to ensure that the primary BACnet network never directly communicates
with the source object.
Technical 04-16006-04-en, March 2015
2600
74 BACnet Networks
74.15 BACnet Gateway
74.15.2 BACnet Gateway as Router to Virtual BACnet
Devices
BACnet Gateways represent non-BACnet devices or logical groups of objects that
are on (or connected to and hosted by) a BACnet Gateway as “virtual” BACnet
devices. For example, there is a group of wireless lighting controllers on a ZigBee
network. On the BACnet network, the gateway represents the lighting controllers as
virtual BACnet devices. Although the devices share the same IP address, they
independently respond to BACnet messages. However, each device requires a
unique BACnet instance number as defined by the BACnet Standard.
Figure: BACnet Gateway as router
Note
A BACnet Gateway that routes to virtual BACnet devices may not necessarily be
a device. Therefore, a gateway that is not a device has no properties or objects of
its own. For more information, see section 81.18 “BACnet Gateway Properties –
Basic Tab” on page 2992.
04-16006-04-en, March 2015 Technical
2601
75 BACnet Device Management
Topics
BACnet Device Management
BACnet Device Discovery
Discovering a BACnet Device
Creating a BACnet Device
Creating an I/A Series (MNB) BACnet Device
Associating a BACnet Instance Number with a Device
BACnet Time Synchronization
Configuring a Server as a Time Sync Master for Local Time
Configuring a Server as a Time Sync Master for UTC Time
Configuring a BACnet Device as a Time Sync Master for
Local Time
Editing a Device Recipient
Manually Triggering the Time Recipients List of a Server
Manually Synchronizing an IP Network to Local Time
Manually Synchronizing an IP Network to UTC Time
Manually Synchronizing an MSTP Network to Local Time
Manually Synchronizing an MSTP Network to UTC Time
Manually Synchronizing a Remote Network to Local Time
Manually Synchronizing a Remote Network to UTC Time
Manually Synchronizing a BACnet Device to Local Time
Manually Synchronizing a BACnet Device to UTC Time
Device Communication and Diagnostics
Enabling BACnet Device Communication
Disabling BACnet Device Communication
Disabling Initiation of BACnet Device Communication
Enabling BACnet Interface Communication
Disabling BACnet Interface Communication
Disabling Initiation of BACnet Interface Communication
Refreshing COV Subscriptions
Extended Logging for External BACnet Trend Logs Workflow
BBMDs and Foreign Devices
Creating a BBMD
Configuring a BBMD
Registering a Building Operation Server as a Foreign Device
Teaching a BBMD Configuration to Other BBMDs
Learning a BBMD Configuration from one BBMD to Another
Device Cold Start and Warm Start
Warm Starting a BACnet Device
Cold Starting a BACnet Device
BACnet Backup and Restore
Backing Up a BACnet Device
Restoring a BACnet Device
75 BACnet Device Management
75.1 BACnet Device Management
75.1 BACnet Device Management
BACnet device management is a collection of services that perform administrative,
maintenance, and troubleshooting tasks on a BACnet device.
75.1.1 BACnet Device Discovery
You discover BACnet devices when you want to identify the BACnet devices on a
BACnet network and then add the BACnet devices to the Automation Server or
Enterprise Server.
For more information, see section 75.2 “BACnet Device Discovery” on page 2606.
75.1.2 Hosted I/A Series BACnet (MNB) Devices and
Properties
In Building Operation, I/A Series BACnet devices are simplified versions of generic
BACnet devices. When hosted on an Automation Server or Enterprise Server, these
devices help improve the engineering and runtime performance of I/A Series
BACnet (MNB-70, MNB-300, MNB-V1, MNB-V2 and MNB- 1000) devices.
Hosted I/A Series BACnet devices only include the features supported by their
corresponding I/A Series devices. For example, these simplified devices do not
support intrinsic alarming, and the present value is not commandable for most I/A
Series value objects. Therefore, these objects do not have priority array or relinquish
default properties. Removal of the unsupported features from the I/A Series BACnet
devices improves the object upload time because the server does not try to read
the unsupported properties.
The following tale lists the supported objects and properties.
Table: Supported Objects and Properties for Hosted I/A Series BACnet Devices
General Object Type I/A Series Object Value Commandable Forceable
Type
BACnet Analog Value I/A Analog Value R/W – –
I/A Analog COV R/W – X
Client
I/A Analog Monitor R – –
I/A Analog Setpoint R/W – X
I/A Analog Setpoint R/W X X
Priority
04-16006-04-en, March 2015 Technical
2605
75 BACnet Device Management
75.1 BACnet Device Management
Continued
General Object Type I/A Series Object Value Commandable Forceable
Type
BACnet Binary Value I/A Binary Value R/W – –
I/A Binary COV R/W – X
Client
I/A Binary Monitor R – –
I/A Binary Setpoint R/W – X
I/A Binary Setpoint R/W X X
Priority
BACnet Multistate I/A Multistate Value R/W – –
BACnet Analog Input I/A Analog Input R – X
BACnet Analog Output I/A Analog Output R/W X X
BACnet Multistate I/A Multistate Output R/W X X
Output
To improve system performance, you can create I/A Series BACnet devices that
operate more efficiently than generic BACnet devices. For more information, see
section 75.5 “Creating an I/A Series (MNB) BACnet Device” on page 2610.
75.1.3 BACnet Download and Upload
You can download and upload the properties of a single object or BACnet device,
or the full contents and properties of a BACnet device.
For more information, see section 78.1 “BACnet Download and Upload” on page
2863.
75.1.4 BACnet Time Synchronization
You can synchronize the time clocks of BACnet devices, and networks of BACnet
devices. Generally, BACnet devices and networks run in the local time of the server
where they reside. However, some BACnet devices or networks located in different
time zones may require synchronization to the UTC time of the server.
For more information, see section 75.7 “BACnet Time Synchronization” on page
2612.
75.1.5 Device Cold Start and Warm Start
Building Operation supports the BACnet Reinitialize Device service that controls a
warm start and cold start of a BACnet device.
Technical 04-16006-04-en, March 2015
2606
75 BACnet Device Management
75.1 BACnet Device Management
For more information, see section 75.36 “Device Cold Start and Warm Start” on
page 2650.
75.1.6 Device Communication and Diagnostics
Building Operation supports the BACnet Communication Control service that
controls the ability of a BACnet device to communicate with other devices in the
BACnet internetwork. You use the service primarily for diagnostic purposes.
For more information, see section 75.21 “Device Communication and Diagnostics”
on page 2631.
75.1.7 BACnet Backup and Restore
The BACnet backup and restore commands back up and restore BACnet devices.
For more information, see section 75.39 “BACnet Backup and Restore” on page
2653.
75.1.8 BBMDs and Foreign Devices
BACnet Broadcast Management Devices (BBMDs) allow BACnet to operate
through IP routers. A foreign device is a BACnet device that has an IP subnet
address different from those comprising the BACnet/IP network, which the device
seeks to join.
For more information, see section 75.30 “BBMDs and Foreign Devices” on page
2642.
75.1.9 Extended Logging for External BACnet Trend
Logs Workflow
You configure extended logging for a BACnet trend log to transfer records from an
external BACnet trend log to the Building Operation server. Be sure to create the
extended trend log on the same server that hosts the BACnet device and its trend
log to ensure that they remain synchronized in the event the server needs to be
restored.
For more information, see section 75.29 “Extended Logging for External BACnet
Trend Logs Workflow” on page 2640.
04-16006-04-en, March 2015 Technical
2607
75 BACnet Device Management
75.2 BACnet Device Discovery
75.2 BACnet Device Discovery
You discover BACnet devices when you want to identify the BACnet devices on a
BACnet network and then add the BACnet devices to the Automation Server or
Enterprise Server.
When you drag the discovered device from the Device Discovery view to the
System Tree, you create the BACnet device in the Building Operation database.
You then upload the contents of the device to create the objects in the Building
Operation database. For example, you discover a BACnet device called
ACC_3316023 and then drag the device to the IP Network folder in the System
Tree. You then upload the contents of this device.
Figure: Device Discovery View
You can discover BACnet devices and objects on a directly connected network, or
on subnetworks in the BACnet Interface. For more information, see section 73.5
“Automatically Discovering BACnet Subnetworks” on page 2560.
Technical 04-16006-04-en, March 2015
2608
75 BACnet Device Management
75.3 Discovering a BACnet Device
75.3 Discovering a BACnet Device
You discover BACnet devices in order to create BACnet devices in the Building
Operation server.
For more information, see section 75.2 “BACnet Device Discovery” on page 2606.
To discover a BACnet device
1. In WorkStation, in the System Tree, select the server where you want to
discover the BACnet device.
2. Click the Device Discovery view.
3. In the Select device type box, select BACnet devices.
4. Drag the BACnet device to IP Network or MSTP Network. Use the same
network where the actual BACnet device resides.
5. In the Information dialog box, click OK.
Now that you have discovered the BACnet device, you upload the contents of
the device. For more information, see section 78.12 “Uploading the Contents
of a BACnet Device” on page 2876.
04-16006-04-en, March 2015 Technical
2609
75 BACnet Device Management
75.4 Creating a BACnet Device
75.4 Creating a BACnet Device
You create a BACnet device when you want to create a new device on the network.
For more information, see section 75.21 “Device Communication and Diagnostics”
on page 2631.
To create a BACnet device
1. In WorkStation, in the System Tree, expand BACnet Interface and then
select the network where you want to create a BACnet device.
2. On the File menu, point to New and then click BACnet device.
3. In the Name box, type a name for the BACnet device.
4. In the Description box, type a description for the BACnet device.
5. Click Next.
Continued on next page
Technical 04-16006-04-en, March 2015
2610
75 BACnet Device Management
75.4 Creating a BACnet Device
6. Click Download to BACnet device.
Enter an Instance ID if you know it, or leave this blank if you want to
associate the ID with the physical device after the object has been created.
7. In the BACnet name box, type a BACnet name for the device. Do not type a
name if you want a name to be assigned for you.
8. Select Upload from BACnet device to upload the properties of an object in
the BACnet device.
9. Click Create.
04-16006-04-en, March 2015 Technical
2611
75 BACnet Device Management
75.5 Creating an I/A Series (MNB) BACnet Device
75.5 Creating an I/A Series (MNB) BACnet
Device
You create an I/A BACnet Series device object to host an external I/A device o)n the
BACnet network.
For more information, see section 75.1 “BACnet Device Management” on page
2603.
To create an I/A Series (MNB) BACnet device
1. In WorkStation, in the System Tree, expand BACnet Interface and then
select the network where you want to host an external I/A device.
2. On the File menu, point to New and then click IA Series Device.
3. In the Name box, type a name for the device.
4. In the Description box, type a description for the device.
5. Click Next.
6. Click Download to BACnet device.
Enter an Instance ID if you know it, or leave this blank if you want to
associate the ID with the physical device after the object is created.
7. In the BACnet name box, leave the field blank.
8. Select Upload from BACnet device to upload the properties of an object in
the BACnet device.
9. Click Create.
Technical 04-16006-04-en, March 2015
2612
75 BACnet Device Management
75.6 Associating a BACnet Instance Number with a Device
75.6 Associating a BACnet Instance Number
with a Device
You use the Associate with device command in situations where you created a
BACnet device, but did not assign a BACnet instance number to the device. For
example, you may have created a device, but did not know the instance number at
the time. When you use the command, you type the BACnet instance number of
the external BACnet device that you want to associate with the device. After you
complete the procedure, the device is associated with the external BACnet device.
The command cannot be used to change or update an instance number of a
device.
To associate a BACnet instance number with a device
1. In WorkStation, in the System Tree, expand BACnet Interface, then
expand the network where the device resides.
2. Select the device.
3. On the Actions menu, point to Device and then click Associate with
device.
4. In the Device Id box, type the BACnet instance number of the external
BACnet device that you want to associate with the device.
5. Click OK.
04-16006-04-en, March 2015 Technical
2613
75 BACnet Device Management
75.7 BACnet Time Synchronization
75.7 BACnet Time Synchronization
You can synchronize the time clocks of BACnet devices, and networks of BACnet
devices. Generally, BACnet devices and networks run in the local time of the server
where they reside. However, some BACnet devices or networks located in different
time zones may require synchronization to the UTC time of the server.
You can designate a Building Operation server or BACnet device as a time server to
read the actual time from a reference clock, such as time.nist.gov. In BACnet, a
time server is referred to as a master time controller or time sync master.
Figure: Synchronization of BACnet devices and networks using master time controllers
Using BACnet time synchronization, the following BACnet objects can act as
master time controllers by sending time updates every hour to their recipients:
• BACnet Interface, which is the data portal to the Building Operation server, can
send time synch messages to any BACnet device or network.
• BACnet Device, which supports the time-sync master functionality, can send
time synch messages to any BACnet device or network.
For example, you can configure a router to send time-sync messages to a
remote MS/TP network if the router supports time-sync master functionality.
To do this, you add the router to the recipients list of the server’s BACnet
Interface. For more information, see section 75.10 “Configuring a BACnet
Device as a Time Sync Master for Local Time” on page 2619.
Technical 04-16006-04-en, March 2015
2614
75 BACnet Device Management
75.7 BACnet Time Synchronization
75.7.1 Local and UTC
In Building Operation, there are two configurable time synchronization settings:
• Use local time to configure BACnet devices and networks located in the same
time zone as the local server, which avoids the need for periodic clock resets,
such as Daylight Savings.
• Use UTC to configure BACnet devices and networks located in different time
zones, or BACnet devices that do not have local time synchronization services.
75.7.2 Automatic Time Sync
Using a master time controller, you can automatically synchronize the time clocks of
BACnet networks and BACnet devices using the following BACnet objects:
• BACnet Interface (server)
For more information, see section 75.8 “Configuring a Server as a Time Sync
Master for Local Time” on page 2615.
For more information, see section 75.9 “Configuring a Server as a Time Sync
Master for UTC Time” on page 2617.
• BACnet device
For more information, see section 75.10 “Configuring a BACnet Device as a
Time Sync Master for Local Time” on page 2619.
Tip
You can force a server to send out time sync notifications that are automatically
synchronized periodically. For more information, see section 75.12 “Manually
Triggering the Time Recipients List of a Server” on page 2622.
75.7.3 Manual Time Sync
You can manually synchronize the time clocks of BACnet networks and BACnet
devices to the following server times:
• Local time
For more information, see section 75.13 “Manually Synchronizing an IP
Network to Local Time” on page 2623.
For more information, see section 75.15 “Manually Synchronizing an MSTP
Network to Local Time” on page 2625.
For more information, see section 75.17 “Manually Synchronizing a Remote
Network to Local Time” on page 2627.
For more information, see section 75.19 “Manually Synchronizing a BACnet
Device to Local Time” on page 2629.
• UTC time
For more information, see section 75.14 “Manually Synchronizing an IP
Network to UTC Time” on page 2624.
04-16006-04-en, March 2015 Technical
2615
75 BACnet Device Management
75.7 BACnet Time Synchronization
For more information, see section 75.16 “Manually Synchronizing an MSTP
Network to UTC Time” on page 2626.
For more information, see section 75.18 “Manually Synchronizing a Remote
Network to UTC Time” on page 2628.
For more information, see section 75.20 “Manually Synchronizing a BACnet
Device to UTC Time” on page 2630.
Technical 04-16006-04-en, March 2015
2616
75 BACnet Device Management
75.8 Configuring a Server as a Time Sync Master for Local Time
75.8 Configuring a Server as a Time Sync
Master for Local Time
You add recipients to a BACnet Interface to synchronize the time clocks of BACnet
devices (and networks of BACnet devices) that reside in the same time zone to the
local time of the server. Acting as a time sync master, the server synchronizes the
other BACnet devices using the timeSynchronization service.
For more information, see section 75.7 “BACnet Time Synchronization” on page
2612.
To configure a server as a time sync master for local time
1. In WorkStation, in the System Tree, select the server and click the Date &
Time tab.
2. Verify that the time zone of the server, which the BACnet Interface inherits, is
correct.
3. Select the BACnet Interface.
4. Click the Time Synchronization Recipients tab.
5. In the Time sync MSTP networks box, select True if the server supports
an MS/TP network.
6. Click to add a device recipient that you want to receive time updates
based on the local time of the server.
Continued on next page
04-16006-04-en, March 2015 Technical
2617
75 BACnet Device Management
75.8 Configuring a Server as a Time Sync Master for Local Time
7. Configure the device recipient.
Property Description
Reference Click to identify the device recipient by referencing the device.
Device ID Click to identify the device recipient by the instance number of
the BACnet device.
MAC address Click to identify the device recipient by the network of the device.
Use a MAC and network address when you want to identify
objects not included in the Building Operation database.
Recipient Enter the reference to a BACnet device.
device object
reference
Recipient Enter the BACnet instance number of the device.
device identifier
Network ID Choose one of the following options:
• Type a specific Network ID number.
• Select Global broadcast to send messages to all
networks in the BACnet system.
• Select Local Network to send a message to a device on
a directly connected network (IP or MS/TP).
Local Network, the initial IP network created by the BACnet
Interface wizard, has a network ID of zero (0). Any additional
installed IP network must have a distinct ID number in the
BACnet network.
MS/TP Enter a number between 0 and 254 for the MS/TP address of
the device recipient on the network.
IP Enter the IP address and port number for the IP address of the
device recipient.
Raw Enter the hexadecimal address for the device recipient.
(hexadecimal)
Broadcast Click to send the message to all devices on the network.
8. Click OK.
9. Click Save.
Technical 04-16006-04-en, March 2015
2618
75 BACnet Device Management
75.9 Configuring a Server as a Time Sync Master for UTC Time
75.9 Configuring a Server as a Time Sync
Master for UTC Time
You add recipients to a BACnet Interface to synchronize the time clocks of third-
party BACnet devices that do not support the local time sync service (or BACnet
devices and networks that reside in a different time zone) to the UTC time of the
local server. Acting as a time sync master, the server synchronizes the other
BACnet devices using the utcTimeSynchronization service.
For more information, see section 75.7 “BACnet Time Synchronization” on page
2612.
To configure a server as a time sync master for UTC time
1. In WorkStation, in the System Tree, select the BACnet Interface.
2. Click the Time Synchronization Recipients tab.
3. In the Time sync MSTP networks box, select True if the server supports
an MS/TP network.
4. Click to add a device recipient that you want to receive time updates
based on the UTC time of the server.
Continued on next page
04-16006-04-en, March 2015 Technical
2619
75 BACnet Device Management
75.9 Configuring a Server as a Time Sync Master for UTC Time
5. Configure the device recipient.
Property Description
Reference Click to identify the device recipient by referencing the device.
Device ID Click to identify the device recipient by the instance number of
the BACnet device.
MAC address Click to identify the device recipient by the network of the device.
Use a MAC and network address when you want to identify
objects not included in the Building Operation database.
Recipient Enter the reference to a BACnet device.
device object
reference
Recipient Enter the BACnet instance number of the device.
device identifier
Network ID Choose one of the following options:
• Type a specific Network ID number.
• Select Global broadcast to send messages to all
networks in the BACnet system.
• Select Local Network to send a message to a device on
a directly connected network (IP or MS/TP).
Local Network, the initial IP network created by the BACnet
Interface wizard, has a network ID of zero (0). Any additional
installed IP network must have a distinct ID number in the
BACnet network.
MS/TP Enter a number between 0 and 254 for the MS/TP address of
the device recipient on the network.
IP Enter the IP address and port number for the IP address of the
device recipient.
Raw Enter the hexadecimal address for the device recipient.
(hexadecimal)
Broadcast Click to send the message to all devices on the network.
6. Click OK.
7. Click Save.
Technical 04-16006-04-en, March 2015
2620
75 BACnet Device Management
75.10 Configuring a BACnet Device as a Time Sync Master for Local Time
75.10 Configuring a BACnet Device as a Time
Sync Master for Local Time
You can add time synch recipients to a BACnet device to synchronize them with its
time clock. Acting as a time sync master, the BACnet device synchronizes the other
BACnet devices using the timeSynchronization service.
For more information, see section 75.7 “BACnet Time Synchronization” on page
2612.
To configure a BACnet device as a time sync master for local
time
1. In WorkStation, in the System Tree, expand the BACnet Interface where
the BACnet device resides.
2. Select the BACnet device that you want to configure.
3. Click the Time Synchronization Recipients tab.
4. Click to add a device recipient that you want to receive time updates
based on the time clock of the BACnet device.
Continued on next page
04-16006-04-en, March 2015 Technical
2621
75 BACnet Device Management
75.10 Configuring a BACnet Device as a Time Sync Master for Local Time
5. Configure the device recipient.
Property Description
Reference Click to identify the device recipient by referencing the device.
Device ID Click to identify the device recipient by the instance number of
the BACnet device.
MAC address Click to identify the device recipient by the network of the device.
Use a MAC and network address when you want to identify
objects not included in the Building Operation database.
Recipient Enter the reference to a BACnet device.
device object
reference
Recipient Enter the BACnet instance number of the device.
device identifier
Network ID Choose one of the following options:
• Type a specific Network ID number.
• Select Global broadcast to send messages to all
networks in the BACnet system.
• Select Local Network to send a message to a device on
a directly connected network (IP or MS/TP).
Local Network, the initial IP network created by the BACnet
Interface wizard, has a network ID of zero (0). Any additional
installed IP network must have a distinct ID number in the
BACnet network.
MS/TP Enter a number between 0 and 254 for the MS/TP address of
the device recipient on the network.
IP Enter the IP address and port number for the IP address of the
device recipient.
Raw Enter the hexadecimal address for the device recipient.
(hexadecimal)
Broadcast Click to send the message to all devices on the network.
6. Click OK.
7. Click Save.
Technical 04-16006-04-en, March 2015
2622
75 BACnet Device Management
75.11 Editing a Device Recipient
75.11 Editing a Device Recipient
You configure a device recipient by specifying a reference, device ID, or MAC
address.
For more information, see section 75.1 “BACnet Device Management” on page
2603.
To edit a device recipient
1. Edit the properties.
Property Description
Reference Click to identify the device recipient by referencing the device.
Device ID Click to identify the device recipient by the instance number of
the BACnet device.
MAC address Click to identify the device recipient by the network of the device.
Use a MAC and network address when you want to identify
objects not included in the Building Operation database.
Recipient Enter the reference to a BACnet device.
device object
reference
Recipient Enter the BACnet instance number of the device.
device identifier
Network ID Choose one of the following options:
• Type a specific Network ID number.
• Select Global broadcast to send messages to all
networks in the BACnet system.
• Select Local Network to send a message to a device on
a directly connected network (IP or MS/TP).
Local Network, the initial IP network created by the BACnet
Interface wizard, has a network ID of zero (0). Any additional
installed IP network must have a distinct ID number in the
BACnet network.
MS/TP Enter a number between 0 and 254 for the MS/TP address of
the device recipient on the network.
IP Enter the IP address and port number for the IP address of the
device recipient.
Raw Enter the hexadecimal address for the device recipient.
(hexadecimal)
Broadcast Click to send the message to all devices on the network.
2. Click OK.
04-16006-04-en, March 2015 Technical
2623
75 BACnet Device Management
75.12 Manually Triggering the Time Recipients List of a Server
75.12 Manually Triggering the Time Recipients
List of a Server
You can manually force the server to send out time synch notifications to all the
configured recipients.
For more information, see section 75.7 “BACnet Time Synchronization” on page
2612.
To manually trigger the time recipients list of a server
1. In WorkStation, in the System Tree, select BACnet Interface.
2. On the Actions menu, click Send time sync now.
Technical 04-16006-04-en, March 2015
2624
75 BACnet Device Management
75.13 Manually Synchronizing an IP Network to Local Time
75.13 Manually Synchronizing an IP Network
to Local Time
You synchronize an IP network to local time when the network is out of sync with
the local server.
For more information, see section 75.7 “BACnet Time Synchronization” on page
2612.
To manually synchronize an IP network to local time
1. In WorkStation, in the System Tree, expand BACnet Interface.
2. Select the IP Network that you want to synchronize with the server.
3. On the Actions menu, point to Time sync and then click Local.
04-16006-04-en, March 2015 Technical
2625
75 BACnet Device Management
75.14 Manually Synchronizing an IP Network to UTC Time
75.14 Manually Synchronizing an IP Network
to UTC Time
You synchronize an IP network to UTC time to synchronize the network to the UTC
time of the local server.
For more information, see section 75.7 “BACnet Time Synchronization” on page
2612.
To manually synchronize an IP network to UTC time
1. In WorkStation, in the System Tree, expand BACnet Interface.
2. Select the IP Network that you want to synchronize to UTC time.
3. On the Actions menu, point to Time sync and then click UTC.
Technical 04-16006-04-en, March 2015
2626
75 BACnet Device Management
75.15 Manually Synchronizing an MSTP Network to Local Time
75.15 Manually Synchronizing an MSTP
Network to Local Time
You synchronize an MSTP network to local time when the network is out of sync
with the local Automation Server.
For more information, see section 75.7 “BACnet Time Synchronization” on page
2612.
To manually synchronize an MSTP network to local time
1. In WorkStation, in the System Tree, expand BACnet Interface.
2. Select the MSTP Network that you want to synchronize with the server.
3. On the Actions menu, point to Time sync and then click Local.
04-16006-04-en, March 2015 Technical
2627
75 BACnet Device Management
75.16 Manually Synchronizing an MSTP Network to UTC Time
75.16 Manually Synchronizing an MSTP
Network to UTC Time
You synchronize an MSTP network to UTC time to synchronize the network to the
UTC time of the local Automation Server.
For more information, see section 75.7 “BACnet Time Synchronization” on page
2612.
To manually synchronize an MSTP network to UTC time
1. In WorkStation, in the System Tree, expand BACnet Interface.
2. Select the MSTP Network that you want to synchronize to UTC time.
3. On the Actions menu, point to Time sync and then click UTC.
Technical 04-16006-04-en, March 2015
2628
75 BACnet Device Management
75.17 Manually Synchronizing a Remote Network to Local Time
75.17 Manually Synchronizing a Remote
Network to Local Time
You synchronize a remote network to local time when the network is out of sync
with the local server.
For more information, see section 75.7 “BACnet Time Synchronization” on page
2612.
To manually synchronize a remote network to local time
1. In WorkStation, in the System Tree, expand BACnet Interface.
2. Select the Remote Network that you want to synchronize with the server.
3. On the Actions menu, point to Time sync and then click Local.
04-16006-04-en, March 2015 Technical
2629
75 BACnet Device Management
75.18 Manually Synchronizing a Remote Network to UTC Time
75.18 Manually Synchronizing a Remote
Network to UTC Time
You synchronize a remote network to UTC time to synchronize the network to the
UTC time of the local server.
For more information, see section 75.7 “BACnet Time Synchronization” on page
2612.
To manually synchronize a remote network to UTC time
1. In WorkStation, in the System Tree, expand BACnet Interface.
2. Select the Remote Network that you want to synchronize to UTC time.
3. On the Actions menu, point to Time sync and then click UTC.
Technical 04-16006-04-en, March 2015
2630
75 BACnet Device Management
75.19 Manually Synchronizing a BACnet Device to Local Time
75.19 Manually Synchronizing a BACnet
Device to Local Time
You synchronize a BACnet device to local time when the device is out of sync with
the server.
For more information, see section 75.7 “BACnet Time Synchronization” on page
2612.
To manually synchronize a BACnet device to local time
1. In WorkStation, in the System Tree, select the BACnet device that you want
to synchronize with the server.
2. On the Actions menu, point to Device and then click Time sync.
3. On the Time sync submenu, click Local to synchronize the time of the
BACnet device with the local time of the server.
04-16006-04-en, March 2015 Technical
2631
75 BACnet Device Management
75.20 Manually Synchronizing a BACnet Device to UTC Time
75.20 Manually Synchronizing a BACnet
Device to UTC Time
You synchronize BACnet devices located in different time zones, or BACnet devices
that do not have local time services, to UTC time.
For more information, see section 75.7 “BACnet Time Synchronization” on page
2612.
To manually synchronize a BACnet device to UTC time
1. In WorkStation, in the System Tree, select the device that you want to
synchronize with UTC time.
2. On the Actions menu, point to Device and then click Time sync.
3. On the Time sync submenu, click UTC to synchronize the time of the device
with UTC time.
Technical 04-16006-04-en, March 2015
2632
75 BACnet Device Management
75.21 Device Communication and Diagnostics
75.21 Device Communication and Diagnostics
Building Operation supports the BACnet Communication Control service, which
controls the ability of a Building Operation server to communicate with BACnet
networks and devices in the BACnet system. This service also controls the ability of
a BACnet device to communicate with other networks and devices in the BACnet
internetwork. You use the service primarily for diagnostic purposes.
75.21.1 BACnet Interface
You can perform the following diagnostic tasks on the BACnet Interface:
• Enable communication, which instructs the BACnet Interface to clear disable
conditions and resume communication with other BACnet subnetworks and
devices in the BACnet system. For more information, see section 75.25
“Enabling BACnet Interface Communication” on page 2636.
• Disable communication, which instructs the BACnet Interface not to
communicate on the BACnet system. For more information, see section 75.26
“Disabling BACnet Interface Communication” on page 2637.
• Disable initiation of communication, which instructs the BACnet Interface to
respond to requests, but not to initiate new requests on the BACnet system.
For more information, see section 75.27 “Disabling Initiation of BACnet
Interface Communication” on page 2638.
75.21.2 BACnet Device
You can perform the following diagnostic tasks on a BACnet device:
• Enable communication, which instructs a BACnet device to clear disable
conditions and resume communication with other devices on the BACnet
internetwork. For more information, see section 75.22 “Enabling BACnet
Device Communication” on page 2633.
While a device is disabled, the device can still respond to communication
control requests, and requests for warm and cold starts if supported by the
device. To enable device communication following a disable, you can use
Enable communication, or perform a warm start or cold start of the device.
• Disable communication, which instructs a BACnet device not to communicate
on the BACnet internetwork. For more information, see section 75.23
“Disabling BACnet Device Communication” on page 2634.
• Disable initiation of communication, which instructs a BACnet device to
respond to requests, but not to initiate new requests on the BACnet
internetwork. For more information, see section 75.24 “Disabling Initiation of
BACnet Device Communication” on page 2635.
The following table lists the device communication control commands and their
corresponding properties.
04-16006-04-en, March 2015 Technical
2633
75 BACnet Device Management
75.21 Device Communication and Diagnostics
Table: Device Communication Control Commands
Communication Control Time Duration Password (if required)
Command
Device Disable X X
Device Disable Initiation X X
Device Enable – X
BACnet Interface Disable X –
BACnet Interface Disable X –
Initiation
BACnet Interface Enable – –
For more information, see section 81.162 “BACnet Device Communication Dialog
Box” on page 3245.
75.21.3 COV Subscriptions
You can immediately refresh COV subscriptions when a BACnet device goes offline
unexpectedly, for example, during a network disconnect or power outage. This
command overrides the system’s five-minute refresh interval for COV variables. For
more information, see section 75.28 “Refreshing COV Subscriptions” on page
2639.
You can view the number of properties using the BACnet COV service as well as
the various polling times on each network. For more information, see section 74.13
“Diagnosing Polled Variables on a BACnet Network” on page 2594.
Technical 04-16006-04-en, March 2015
2634
75 BACnet Device Management
75.22 Enabling BACnet Device Communication
75.22 Enabling BACnet Device
Communication
You enable a BACnet device to resume communication with devices on the BACnet
internetwork.
For more information, see section 75.21 “Device Communication and Diagnostics”
on page 2631.
To enable BACnet device communication
1. In WorkStation, in the System Tree, expand BACnet Interface.
2. Expand the network where the device resides.
3. Select the disabled BACnet device.
4. On the Actions menu, point to Device and then click Communication.
5. On the Communication submenu, click Enable.
6. In the Password box, type the vendor-supplied password of the device, or
leave the box empty if a password is not required.
7. Click OK.
04-16006-04-en, March 2015 Technical
2635
75 BACnet Device Management
75.23 Disabling BACnet Device Communication
75.23 Disabling BACnet Device
Communication
You disable the communication of a BACnet device to other devices on the BACnet
internetwork when you want to identify problems with the device. Disabled devices
can still receive device communication control requests. If supported by the device,
the disabled device can also receive warm start and cold start requests.
For more information, see section 75.21 “Device Communication and Diagnostics”
on page 2631.
To disable BACnet device communication
1. In WorkStation, in the System Tree, expand BACnet Interface.
2. Expand the network where the BACnet device resides.
3. Select the BACnet device that you want to troubleshoot.
4. On the Actions menu, point to Device and then click Communication.
5. On the Communication submenu, click Disable.
6. In the Time Duration box, enter 0 (indefinite) to disable the device until the
device receives an Enable communication request.
7. In the Password box, enter the vendor-supplied password of the device, or
leave the box empty if a password is not required.
8. Click OK.
Technical 04-16006-04-en, March 2015
2636
75 BACnet Device Management
75.24 Disabling Initiation of BACnet Device Communication
75.24 Disabling Initiation of BACnet Device
Communication
You disable the ability of a BACnet device to initiate communication with other
BACnet devices on the internetwork when you want to identify or troubleshoot
problems with the device.
For more information, see section 75.21 “Device Communication and Diagnostics”
on page 2631.
To disable initiation of BACnet device communication
1. In WorkStation, in the System Tree, expand BACnet Interface.
2. Expand the network where the BACnet device resides.
3. Select the BACnet device that you want to troubleshoot.
4. On the Actions menu, point to Device and then click Communication.
5. On the Communication submenu, click Disable initiation.
6. In the Time Duration box, enter 0 (indefinite) to disable the BACnet device
until the device receives an Enable communication request.
7. In the Password box, enter the vendor-supplied password of the device, or
leave the box empty if a password is not required.
8. Click OK.
04-16006-04-en, March 2015 Technical
2637
75 BACnet Device Management
75.25 Enabling BACnet Interface Communication
75.25 Enabling BACnet Interface
Communication
You enable the BACnet Interface to resume communication with devices and
networks in a BACnet system.
For more information, see section 75.21 “Device Communication and Diagnostics”
on page 2631.
To enable BACnet Interface communication
1. In WorkStation, in the System Tree, select BACnet Interface.
2. On the Actions menu, point to Device communication control and then
click Enable.
Technical 04-16006-04-en, March 2015
2638
75 BACnet Device Management
75.26 Disabling BACnet Interface Communication
75.26 Disabling BACnet Interface
Communication
You disable the communication of the BACnet Interface to other devices and
networks in the BACnet system when you want to identify problems with the
interface.
For more information, see section 75.21 “Device Communication and Diagnostics”
on page 2631.
To disable BACnet Interface communication
1. In WorkStation, in the System Tree, select BACnet Interface.
2. On the Actions menu, point to Device communication control and then
click Disable.
3. In the Time Duration box, enter 0 (indefinite) to disable the interface until the
interface receives an Enable communication request.
4. Click OK.
04-16006-04-en, March 2015 Technical
2639
75 BACnet Device Management
75.27 Disabling Initiation of BACnet Interface Communication
75.27 Disabling Initiation of BACnet Interface
Communication
You disable the ability of the BACnet Interface to initiate communication with other
BACnet devices and networks when you want to identify or troubleshoot problems
with the interface.
For more information, see section 75.21 “Device Communication and Diagnostics”
on page 2631.
To disable initiation of BACnet Interface communication
1. In WorkStation, in the System Tree, select BACnet Interface.
2. On the Actions menu, point to Device Communication control and then
click Disable initiation.
3. In the Time Duration box, enter 0 (indefinite) to disable the BACnet interface
until the interface receives an Enable communication request.
4. Click OK.
Technical 04-16006-04-en, March 2015
2640
75 BACnet Device Management
75.28 Refreshing COV Subscriptions
75.28 Refreshing COV Subscriptions
You can immediately refresh COV subscriptions when a BACnet device goes offline
unexpectedly due to a network disconnect or power outage. This command
overrides the system generated five-minute refresh interval for polled COV variables.
For more information, see section 75.21 “Device Communication and Diagnostics”
on page 2631.
To refresh COV subscriptions
1. In WorkStation, in the System Tree, expand BACnet Interface.
2. Expand the network where the BACnet device resides.
3. Select the device in the System Tree.
4. On the Actions menu, point to Device and then click Renew COV
subscriptions.
04-16006-04-en, March 2015 Technical
2641
75 BACnet Device Management
75.29 Extended Logging for External BACnet Trend Logs Workflow
75.29 Extended Logging for External BACnet
Trend Logs Workflow
You configure extended logging for a BACnet trend log to transfer records from an
external BACnet trend log to the Building Operation server. Be sure to create the
extended trend log on the same server that hosts the BACnet device and its trend
log to ensure that they remain synchronized in the event the server needs to be
restored.
Use this workflow for configuring BACnet trend logs in external BACnet devices.
Figure: BACnet trend log in external BACnet device configuration workflow
Create a BACnet trend log
Create a BACnet trend log in an external device. For more information, see section
76.45 “Creating a BACnet Trend Log (Generic)” on page 2831.
Configure an intrinsic buffer ready alarm?
If an external device supports intrinsic events and notifications in trend logs, you can
configure the reporting properties in the device itself rather than configuring a
separate alarm. To do so, complete these tasks:
• Create a BACnet trend log. For more information, see section 76.43 “Creating
a BACnet Trend Log” on page 2825.
• Configure the intrinsic reporting properties in the external device. For more
information, see section 76.46 “Configuring a BACnet Trend Log (Generic)” on
page 2833.
In Building Operation, this optional feature is supported in some external devices
but not in bCX or b3 devices.
Technical 04-16006-04-en, March 2015
2642
75 BACnet Device Management
75.29 Extended Logging for External BACnet Trend Logs Workflow
Create a buffer ready alarm?
If an external device does not support intrinsic events and notifications in trend logs,
you create and configure a separate buffer ready alarm. To do so, complete these
tasks:
• Create a BACnet buffer ready alarm. For more information, see section 79.14
“Creating a BACnet Alarm (Generic)” on page 2917.
• Create a BACnet notification to deliver notifications to the server. For more
information, see section 79.4 “Creating a BACnet Notification (Generic)” on
page 2889.
• Configure the BACnet notification to specify the device recipients and to
determine how the events and acknowledgements are handled. For more
information, see section 79.3 “Configuring a BACnet Notification” on page
2882.
Tip
Set the buffer ready alarm threshold parameter to 10% of the trend log buffer size
to ensure that it works most efficiently with extended trend logs. For example, if
the trend log buffer size is 100, the buffer ready threshold should be 10.
Create an extended trend log
Create an extended trend log in the Application folder of the external device to
monitor the trend log in Building Operation. For more information, see the Creating
an Extended Trend Log topic on WebHelp.
Note
For local BACnet trend logs, you create an extended trend log in the Application
folder of the BACnet interface. For more information, see the Creating an
Extended Trend Log topic on WebHelp.
04-16006-04-en, March 2015 Technical
2643
75 BACnet Device Management
75.30 BBMDs and Foreign Devices
75.30 BBMDs and Foreign Devices
BACnet Broadcast Management Devices (BBMDs) allow BACnet to operate
through IP routers. A foreign device is a BACnet device that has an IP subnet
address different from those comprising the BACnet/IP network, which the device
seeks to join.
75.30.1 BBMDs
The BBMD's primary purpose is to redistribute the essential broadcast messages
that BACnet requires, such as who is/I am broadcasts used for Device Discovery. In
some cases, however, there may be devices on the BACnet/IP internetwork that
are transient. For example, these devices may reside on a subnet where it is not
economical to install, configure, and maintain a BBMD, or where there are no other
BACnet nodes. In this case, BBMDs can enable transient devices to associate
themselves with a BACnet/IP internetwork, which is essential for establishing
communication with them in the BACnet system.
75.30.2 Foreign Devices
A Foreign device may be a full-time node on the foreign subnet or a part-time
participant. There are no restrictions on where foreign devices reside or how they
gain access to the Internet. For example, a foreign device can be a workstation on a
full-time Internet subnet or a laptop at a home office accessing the Internet by way
of an Internet Service Provider. To establish a connection with a Building Operation
server that is outside of the BACnet network, you create a BBMD and then register
the server as a foreign device with the BBMD. For more information, see section
75.33 “Registering a Building Operation Server as a Foreign Device” on page 2647.
Note
BBMDs and foreign devices are mutually exclusive so you either create a BBMD
or a foreign device (or neither) on a particular IP subnet.
In the following illustration, a workstation, which is registered with a BBMD,
becomes a member of the BACnet/IP internetwork and receives broadcast
messages on its behalf. The foreign device can directly communicate with any
BACnet device without registration. However, the foreign device will only receive
broadcasts if the registration process is successful.
Technical 04-16006-04-en, March 2015
2644
75 BACnet Device Management
75.30 BBMDs and Foreign Devices
Figure: Foreign Devices in the BACnet system
75.30.3 BBMD Configuration
BBMD includes a Broadcast Distribution table (BTD) that lists the BACnet devices
that are included in the message distribution. To save configuration time, you can
choose one of the following options:
• Teach. Write one BBMD configuration to all other BBMDs in the BACnet
system. For more information, see section 75.34 “Teaching a BBMD
Configuration to Other BBMDs ” on page 2648.
• Learn. Read a BBMD installed on another IP subnet to update a selected
BBMD. For more information, see section 75.35 “Learning a BBMD
Configuration from one BBMD to Another” on page 2649.
04-16006-04-en, March 2015 Technical
2645
75 BACnet Device Management
75.30 BBMDs and Foreign Devices
Note
There are no known practical limits on the number of Broadcast Distribution Table
(BDT) entries for the Enterprise Server or Automation Server. For more
information, see the Architectural Guidelines datasheet.
Technical 04-16006-04-en, March 2015
2646
75 BACnet Device Management
75.31 Creating a BBMD
75.31 Creating a BBMD
You create a BBMD on a Building Operation server to redistribute essential
broadcast messages over the BACnet IP network, which enables Device Discovery.
As a result, the server becomes a BBMD, which contains a Broadcast Distribution
Table (BDT) that lists all the devices to which the BBMD sends broadcast
messages.
For more information, see section 75.30 “BBMDs and Foreign Devices” on page
2642.
To create a BBMD
1. In WorkStation, in the System Tree, expand the BACnet Interface on
the server.
2. Select the IP Network where you want to create a BBMD.
3. On the File menu, point to New and then click BBMD.
4. In the Name box, type a name for the BBMD.
5. In the Description box, type a description for the BBMD.
6. Click Create.
The server is now a BBMD. You can view or edit the BDT properties of the BBMD.
For more information, see section 81.27 “BBMD BDT Entry Properties – Basic Tab”
on page 3005.
04-16006-04-en, March 2015 Technical
2647
75 BACnet Device Management
75.32 Configuring a BBMD
75.32 Configuring a BBMD
You configure a BBMD to specify the IP subnetwork settings of the BBMD, which
stores the changes as an enty in the Broadcast Distribution Table (BDT).
For more information, see section 75.30 “BBMDs and Foreign Devices” on page
2642.
To configure a BBMD
1. In WorkStation, in the System Tree, expand the BACnet Interface of the
server.
2. Expand the IP Network where the BBMD resides.
3. In List View, double click on the BBMD that you want to modify.
4. Double click on the BDT entry within the BBMD.
5. In the IP address box, type the IP address of the BBMD on the subnet.
6. In the IP port number box, type the IP port of the BBMD on the subnet.
7. In the Broadcast distribution mask, type the distribution mask that
specifies how the broadcast messages are distributed on the subnet.
8. Click OK.
The BDT is now configured. You can view or edit the BDT properties. For more
information, see section 81.27 “BBMD BDT Entry Properties – Basic Tab” on page
3005.
Tip
To save configuration time, you can use the Teach or Learn commands to update
multiple BBMDs in the BACnet system.
Technical 04-16006-04-en, March 2015
2648
75 BACnet Device Management
75.33 Registering a Building Operation Server as a Foreign Device
75.33 Registering a Building Operation Server
as a Foreign Device
If a Building Operation server and a BBMD are located on different BACnet IP
subnets, you can register the server as a foreign device with the BBMD. Once the
connection is established, the server (and all BACnet/IP devices installed on its
subnet) can receive BACnet broadcasts forwarded from the BBMD. The subnet
also joins the BACnet internetwork.
For more information, see section 75.30 “BBMDs and Foreign Devices” on page
2642.
To register a Building Operation server as a foreign device
1. In WorkStation, in the System Tree, select the BACnet IP Network of
the server that you want to register as a foreign device.
2. On the File menu, click Properties.
3. Click the Basic tab.
4. Verify that the server is located on a different IP subnet than the BBMD to
avoid a routing loop or broadcast storm.
5. In the BBMD IP address box, type the IP address of the BBMD.
6. In the BBMD port number box, enter the port number of the BBMD.
7. Click OK.
The server is now a member of the BACnet/IP internetwork and receives forwarded
broadcast messages from the BBMD when they are available. You can now use
Device Discovery to locate the BACnet devices on the subnet where the registered
server resides. For more information, see section 75.2 “BACnet Device Discovery”
on page 2606.
04-16006-04-en, March 2015 Technical
2649
75 BACnet Device Management
75.34 Teaching a BBMD Configuration to Other BBMDs
75.34 Teaching a BBMD Configuration to
Other BBMDs
Using the Teach command, you can send a BBMD configuration table (BDT) to
update all other BBMDs in the system.
For more information, see section 75.30 “BBMDs and Foreign Devices” on page
2642.
To teach a BBMD configuration to other BBMDs
1. In WorkStation, in the System Tree, expand the BACnet Interface of the
server where the BBMD resides.
2. Expand the IP Network.
3. Right click on the BBMD and click Teach.
All the BBMDs in the system are now configured. You can view the individual BBMD
configurations. For more information, see section 81.27 “BBMD BDT Entry
Properties – Basic Tab” on page 3005.
Technical 04-16006-04-en, March 2015
2650
75 BACnet Device Management
75.35 Learning a BBMD Configuration from one BBMD to Another
75.35 Learning a BBMD Configuration from
one BBMD to Another
To save configuration time, you can copy one BBMD configuration to another using
the Learn BDT Table command.
For more information, see section 75.30 “BBMDs and Foreign Devices” on page
2642.
To learn a BBMD configuration from one BBMD to another
1. In WorkStation, in the System Tree, expand the BACnet Interface on the
server where the BBMD is installed.
2. Expand the IP Network.
3. Right click on the BBMD and point to Learn BDT Table.
4. In the IP Address box, type the IP address of the BBMD from which you
want to copy the configuration.
5. In the Port Number box, type the port of the BBMD.
6. Click OK.
The BBMD is now configured. You can view the BDT configuration. For more
information, see section 81.27 “BBMD BDT Entry Properties – Basic Tab” on page
3005.
04-16006-04-en, March 2015 Technical
2651
75 BACnet Device Management
75.36 Device Cold Start and Warm Start
75.36 Device Cold Start and Warm Start
Building Operation supports the BACnet Reinitialize Device service that controls a
warm start and cold start of a BACnet device.
In WorkStation, you use the following menu options to invoke the Reinitialize Device
service:
• Cold start, which instructs a BACnet device to reboot itself.
With a cold start, some devices retain the object database, the object list, and
configuration information; however, depending on vendor implementation,
some devices do not retain the object list. The run-time data is usually not
preserved. For more information, see section 75.38 “Cold Starting a BACnet
Device” on page 2652.
• Warm start, which instructs a BACnet device to reset itself to a predefined
initial state.
With a warm start, the device retains all configuration data, run-time data, and
the values of objects. For more information, see section 75.37 “Warm Starting
a BACnet Device” on page 2651.
When you use the Warm start or Cold start menu option, you are prompted to enter
a vendor-supplied device password. Not all devices, however, are password
protected. If the device does not require a password, you can click OK to continue.
For more information, see section 81.163 “BACnet Password Dialog Box” on page
3246.
Technical 04-16006-04-en, March 2015
2652
75 BACnet Device Management
75.37 Warm Starting a BACnet Device
75.37 Warm Starting a BACnet Device
You warm start a BACnet device when you want the device to reset itself. When
you warm start a device, the device retains all configuration data, run time data, and
the values of objects. You use the Warm start command to direct the device to
reset itself.
To warm start a BACnet device
1. In WorkStation, in the System Tree, expand BACnet Interface, then
expand the network where the BACnet device resides.
2. Select the BACnet device.
3. On the Actions menu, point to Device and then click Restart.
4. On the Restart submenu, click Warm start.
5. In the Password box, enter the vendor-supplied password of the device, or
leave the box empty if a password is not required.
6. Click OK.
04-16006-04-en, March 2015 Technical
2653
75 BACnet Device Management
75.38 Cold Starting a BACnet Device
75.38 Cold Starting a BACnet Device
You cold start a BACnet device when you want to reboot the device. Some devices
retain the object database, the object list, and configuration information. However,
some devices do not retain the object list depending on vendor implementation.
The run-time data is usually not preserved. You use the Cold start command to
reboot a BACnet device.
To cold start a BACnet device
1. In WorkStation, in the System Tree, expand BACnet Interface, then
expand the network where the BACnet device resides.
2. Selet the BACnet device.
3. On the Actions menu, point to Device and then click Restart.
4. On the Restart submenu, click Cold start.
5. In the Password box, enter the vendor-supplied password of the device, or
leave the box empty if a password is not required.
6. Click OK.
Technical 04-16006-04-en, March 2015
2654
75 BACnet Device Management
75.39 BACnet Backup and Restore
75.39 BACnet Backup and Restore
The BACnet backup and restore commands back up and restore BACnet devices.
Figure: Comparison of Building Operation and BACnet backup methods
When you back up a device, Building Operation creates a backup file, which is
stored in the file system of the local server. One backup file per device is created
and saved, and only one file can exist at a time. When you run the backup again,
the previous file is overwritten. The content in the backup file varies according to the
device. For instance, some BACnet devices support the backup of configuration
properties only, while other devices support the backup of all the objects in a
device, such as trends and alarms.
Online and offline
A backup only operates when a device is online. Conversely, a restore only
operates when a device is offline. In most cases, the device automatically goes
back online once the restore is completed.
75.39.1 BACnet Backup and Restore Services
BACnet Backup and Restore services are required for backing up and restoring
BACnet devices. Therefore, verify that these devices support the following BACnet
services: ReinitializeDevice, ReadProperty, WriteProperty, AtomicWriteFile,
AtomicReadFile, and CreateObject (optional, not required).
04-16006-04-en, March 2015 Technical
2655
75 BACnet Device Management
75.39 BACnet Backup and Restore
75.39.2 BACnet Backup and Restore Properties
You can find BACnet backup and restore information on b3, bCX, and BACnet
device properties, and BACnet Interface properties.
The following table lists the BACnet backup and restore properties and where they
are located.
Property BACnet device – BACnet Interface –
Advanced Tab Basic Tab
Backup path X –
Backup configuration files X –
Last restore time X –
Last backup time X –
Backup and restore state – X
Backup failure timeout X X
Backup preparation time – X
Restore preparation time – X
Restore completion time – X
75.39.3 b3 BACnet Devices
Before backing up or restoring b3 devices, first determine how the b3 devices are
configured in your system. If the b3s are connected:
• Either to a bCX controller or third-party router device, use the BACnet backup
and restore commands.
For more information, see section 75.40 “Backing Up a BACnet Device” on
page 2655.
For more information, see section 75.41 “Restoring a BACnet Device” on page
2657.
• To an Automation Server that functions as a controller or a router, use the
Building Operation (server) backup and restore commands.
For more information, see the Backing Up Servers Manually topic on WebHelp.
For more information, see the Restoring a Server topic on WebHelp.
Technical 04-16006-04-en, March 2015
2656
75 BACnet Device Management
75.40 Backing Up a BACnet Device
75.40 Backing Up a BACnet Device
You back up a BACnet device using BACnet backup commands if the device
supports the BACnet Backup and Restore services.
To back up a BACnet device
1. In WorkStation, in the System Tree, expand BACnet Interface.
2. Expand the network where the BACnet device resides.
3. Select the BACnet device that you want to back up.
4. On the Actions menu, point to Device and then click Backup.
5. In the Password box, type the vendor supplied password, or leave the box
empty if a password is not required.
6. Click OK.
Continued on next page
04-16006-04-en, March 2015 Technical
2657
75 BACnet Device Management
75.40 Backing Up a BACnet Device
7. In Progress view, click Close when the backup finishes.
Technical 04-16006-04-en, March 2015
2658
75 BACnet Device Management
75.41 Restoring a BACnet Device
75.41 Restoring a BACnet Device
You restore a BACnet device using BACnet backup commands if the device
supports the BACnet Backup and Restore services.
To restore a BACnet device
1. In WorkStation, in the System Tree, expand BACnet Interface.
2. Expand the network where the BACnet device resides.
3. Select the BACnet device.
4. On the Actions menu, point to Device and then click Restore.
5. In the Password box, type the vendor supplied password, or leave the box
empty if a password is not required.
6. Click OK.
Continued on next page
04-16006-04-en, March 2015 Technical
2659
75 BACnet Device Management
75.41 Restoring a BACnet Device
7. In Progress view, click Close when the restore finishes.
Technical 04-16006-04-en, March 2015
2660
76 BACnet Objects and Properties
Topics
BACnet Objects and Properties
Supported BACnet Object Types
Table of Supported Object Types
BACnet Object Properties
BACnet Reliability Property
BACnet Device Object Indicator – Executed By
BACnet Configuration Properties
Updating the Object List of a BACnet Device
BACnet Status Flags
Creating a BACnet Point in a Server
Configuring a BACnet Analog Input Point
Configuring a BACnet Digital Input Point
Configuring a BACnet Multistate Input Point
Configuring a BACnet Analog Output Point
Configuring a BACnet Digital Output Point
Configuring a BACnet Multistate Output Point
Creating a BACnet Point (Generic)
Configuring a BACnet Analog Input Point (Generic)
Configuring a BACnet Digital Input Point (Generic)
Configuring a BACnet Multistate Input Point (Generic)
Configuring a BACnet Analog Output Point (Generic)
Configuring a BACnet Digital Output Point (Generic)
Configuring a BACnet Multistate Output Point (Generic)
Creating a BACnet Value
Configuring a BACnet Analog Value
Configuring a BACnet Digital Value
Configuring a BACnet Multistate Value
Creating a BACnet Value (Generic)
Configuring a BACnet Analog Value (Generic)
Configuring a BACnet Digital Value (Generic)
Configuring a BACnet Multistate Value (Generic)
Creating a BACnet Accumulator (Generic)
Configuring a BACnet Accumulator (Generic)
Creating a BACnet Averaging (Generic)
Configuring a BACnet Averaging (Generic)
Creating a BACnet Command (Generic)
Configuring a BACnet Command (Generic)
Creating a BACnet Load Control (Generic)
Configuring a BACnet Load Control (Generic)
Creating a BACnet Pulse Converter (Generic)
Configuring a BACnet Pulse Converter (Generic)
Changing a BACnet String
Creating a BACnet Trend Log
Configuring a BACnet Trend Log
Creating a BACnet Trend Log (Generic)
Configuring a BACnet Trend Log (Generic)
Configuring Extended Logging for a Local BACnet Trend Log
Creating a BACnet Loop
Creating a BACnet Loop (Generic)
Creating a BACnet File (Generic)
Creating a BACnet Program (Generic)
76 BACnet Objects and Properties
76.1 BACnet Objects and Properties
76.1 BACnet Objects and Properties
You can create BACnet objects in Automation Servers, Enterprise Servers, and
BACnet devices in the Building Operation database.
When you create an object in a device, you need to perform one of the following
operations:
• Download to a device to update all of the objects and properties in the BACnet
device. For more information, see section 78.5 “Downloading the Contents of a
BACnet Device” on page 2868.
• Upload from a device to upload all the objects and properties from a BACnet
device into Building Operation. For more information, see section 78.12
“Uploading the Contents of a BACnet Device” on page 2876.
For example, if an external client modifies an object in a device, that object needs to
be uploaded in order to synchronize it with Building Operation. If Building Operation
modifies an object offline when communicating with the device, that object is also
out of synch and must be downloaded.
Server objects operate the server, while objects in other devices are owned by
those devices. To differentiate a server object from a device object, the system
adds the term, generic, to the end of the device name. For example, the name of an
input installed on a server is a BACnet Analog Input while an input installed on a
device is a BACnet Analog Input (Generic). In addition, there is support for
specialized devices, such as a Continuum Workstation.
Server objects do not need to be uploaded or downloaded. Instead, these objects
are used to publish data so that data can be exposed to external clients through the
Building Operation server.
Tip
While you can create Script and Function Block programs in the Application
folder, they are not visible to external BACnet clients.
76.1.1 Supported BACnet Object Types
As of BACnet protocol revision 6, Building Operation supports all BACnet object
types.
For more information, see section 76.2 “Supported BACnet Object Types” on page
2665.
76.1.2 BACnet Object Properties
BACnet objects and devices have a variety of required and optional properties that
are used for the purposes of identification, reliability indication, and configuration of
the object or device, and for prioritization of write requests.
For more information, see section 76.4 “BACnet Object Properties” on page 2667.
04-16006-04-en, March 2015 Technical
2665
76 BACnet Objects and Properties
76.1 BACnet Objects and Properties
76.1.3 BACnet Command Priorities
A building automation system may include objects that are manipulated and written
to by other objects, operators, or applications. However, conflicts may arise when
these different entities try to write to the same commandable value property of a
BACnet object, such as a digital output.
For more information, see section 77.1 “BACnet Command Priorities” on page
2849.
76.1.4 BACnet Device Object Indicator – Executed By
To make it easier to locate objects, you can differentiate BACnet device objects
executed by a BACnet device from those executed by a Building Operation server.
For more information, see section 76.6 “BACnet Device Object Indicator –
Executed By” on page 2670.
76.1.5 BACnet String
For BACnet objects that support BACnet strings, you can enter text that displays as
readable text to users. For example, you can display a message that the room
temperature reached the configured setpoint.
Note
The BACnet string does not support intrinsic reporting and Present Value is not
commandable.
For more information, see section 76.42 “Changing a BACnet String” on page
2824.
Technical 04-16006-04-en, March 2015
2666
76 BACnet Objects and Properties
76.2 Supported BACnet Object Types
76.2 Supported BACnet Object Types
As of BACnet protocol revision 6, Building Operation supports all BACnet object
types.
76.2.1 Table of Supported Object Types
In Building Operation, an object type comprises both device and server objects.
For more information, see section 76.3 “Table of Supported Object Types” on page
2666.
76.2.2 BACnet Notifications
A BACnet notification is the Building Operation equivalent of a BACnet notification
class. A BACnet notification defines what devices to notify when a transition from
one event state to another has occurred, such as a to-normal event has
transitioned to a to-fault event.
For more information, see section 79.1 “BACnet Notifications” on page 2879.
76.2.3 BACnet Alarms
A BACnet alarm is the Building Operation equivalent of an Event Enrollment. A
BACnet alarm defines the conditions of an event and identifies the property to be
monitored.
For more information, see section 79.6 “BACnet Alarms” on page 2898.
76.2.4 BACnet Schedules
A BACnet schedule controls a writable property of an object by writing a value at a
specified time and date.
For more information, see section 80.1 “BACnet Schedules” on page 2935.
04-16006-04-en, March 2015 Technical
2667
76 BACnet Objects and Properties
76.3 Table of Supported Object Types
76.3 Table of Supported Object Types
In Building Operation, an object type comprises both device and server objects.
The following table lists the device types that you can install at the server or device
level.
Table: Supported Object Types
Object type Server Device (Generic)
Accumulator – X
Analog Input X X
Analog Output X X
Analog Value X X
Averaging – X
Binary Input X X
Binary Output X X
Binary Value X X
Calendar X X
Command – X
Device X X
Event Enrollment X X
File – X
Load Control – X
Loop X X
Multistate Input X X
Multistate Output X X
Multistate Value X X
Notification Class X X
Program – X
Pulse Converter – X
Schedule X X
Trend Log X X
Technical 04-16006-04-en, March 2015
2668
76 BACnet Objects and Properties
76.4 BACnet Object Properties
76.4 BACnet Object Properties
BACnet objects and devices have a variety of required and optional properties that
are used for the purposes of identification, reliability indication, and configuration of
the object or device, and for prioritization of write requests.
76.4.1 Required BACnet Identification Properties
BACnet devices and objects have required properties as defined by the ASHRAE
Standard. BACnet devices and objects have to support required properties.
Optional properties are also defined by the ASHRAE Standard. However,
manufacturers can determine whether to support the optional properties in their
devices and objects.
Required BACnet Building Operation Description
Identification Property Property
Object Identifier Object ID Object ID is equivalent to
Object identifier. However,
Object ID includes the object
type as well as the instance
number of the object.
Object name BACnet name BACnet name is equivalent
to Object name.
Object type BACnet type BACnet type is equivalent to
Object type.
76.4.2 BACnet Reliability Property
A number of BACnet object types have a property called Reliability that indicates
the reliability of the Value property or the operation of the BACnet object.
For more information, see section 76.5 “BACnet Reliability Property” on page 2669.
76.4.3 BACnet Configuration Properties
You can download and upload the configuration properties of a BACnet device.
Configuration properties include such items as Daylight savings status, UTC offset,
and APDU timeout.
For more information, see section 76.7 “BACnet Configuration Properties” on page
2671.
76.4.4 BACnet Command Priorities
A building automation system may include objects that are manipulated and written
to by other objects, operators, or applications. However, conflicts may arise when
these different entities try to write to the same commandable value property of a
BACnet object, such as a digital output.
04-16006-04-en, March 2015 Technical
2669
76 BACnet Objects and Properties
76.4 BACnet Object Properties
For more information, see section 77.1 “BACnet Command Priorities” on page
2849.
76.4.5 BACnet Status Flags
Status flags indicate a change in the normal state of a BACnet object or device, and
can be used to trigger alarms and notifications. However, the various status
properties must be included in a BACnet object or device before the system can
display the corresponding status flags.
For more information, see section 76.9 “BACnet Status Flags” on page 2673.
Technical 04-16006-04-en, March 2015
2670
76 BACnet Objects and Properties
76.5 BACnet Reliability Property
76.5 BACnet Reliability Property
A number of BACnet object types have a property called Reliability that indicates
the reliability of the Value property or the operation of the BACnet object.
The following table lists the possible values for this property.
Table: BACnet Reliability Properties
Value Description
no fault detected The present value is reliable.
no sensor No sensor is connected to the input object.
over range A sensor connected to the input is reading a value higher than the
normal operating range. This is possible if the object is a binary
input and the binary state is derived from an analog sensor or a
binary input equipped with electrical loop supervision circuits.
under range A sensor connected to the input is reading a value lower than the
normal operating range. This is possible if the object is a binary
input and the binary input is actually a binary state calculated from
an analog sensor.
open loop The connection between the defined object and the physical
device provides a value specifying an open circuit condition.
shorted loop The connection between the defined object and the physical
device provides a value specifying a short circuit condition.
no output No physical device is connected to the output object.
multistate fault The present value of the multistate object is equal to one of the
states in the Is fault value property.
configuration error The object's properties are not in a consistent state.
unreliable other The controller has detected that the present value is unreliable.
However, none of the other conditions describe the problem. A
generic fault, other than those listed here, has been detected. For
example, a binary input is not cycling as expected.
04-16006-04-en, March 2015 Technical
2671
76 BACnet Objects and Properties
76.6 BACnet Device Object Indicator – Executed By
76.6 BACnet Device Object Indicator –
Executed By
To make it easier to locate objects, you can differentiate BACnet device objects
executed by a BACnet device from those executed by a Building Operation server.
To do this, you add the Executed by column in the List View of the Application
folder of an external BACnet device. Use this column to view, group, and sort the
objects. There are two values for Executed by: BACnet device and no entry
(blank). BACnet device indicates the object is executed by a BACnet device. An
empty field indicates the object is executed by an Automation Server or Enterprise
Server. For example, a BACnet Digital Value displays BACnet device while a
Building Operation Trend Chart remains blank.
Figure: Executed by column in List View
For more information, see the Columns in Views and Panes topic on WebHelp.
Technical 04-16006-04-en, March 2015
2672
76 BACnet Objects and Properties
76.7 BACnet Configuration Properties
76.7 BACnet Configuration Properties
You can download and upload the configuration properties of a BACnet device.
Configuration properties include such items as Daylight savings status, UTC offset,
and APDU timeout.
76.7.1 BACnet Download
You download data when you want to use the data in the Building Operation server
rather than the data that is in the physical device. For example, you can download
the properties of a single object or the entire contents of a BACnet device.
For more information, see section 78.2 “BACnet Download” on page 2864.
76.7.2 BACnet Upload
You upload data when you want to use the data that is in the physical device rather
than the data in the Building Operation server. For example, you can upload the
properties of a single object or the full contents of a BACnet device.
For more information, see section 78.9 “BACnet Upload” on page 2872.
04-16006-04-en, March 2015 Technical
2673
76 BACnet Objects and Properties
76.8 Updating the Object List of a BACnet Device
76.8 Updating the Object List of a BACnet
Device
You use the Update object list command when you want to view an up-to-date
list of objects in a BACnet device that resides in the Hardware folder.
To update the object list of a BACnet device
1. In WorkStation, in the System Tree, expand Hardware, expand BACnet
devices.
2. Expand the network where the BACnet device resides, then expand the
BACnet device.
3. Select Application.
4. On the Actions menu, click Update object list.
5. Click the Refresh button .
Technical 04-16006-04-en, March 2015
2674
76 BACnet Objects and Properties
76.9 BACnet Status Flags
76.9 BACnet Status Flags
Status flags indicate a change in the normal state of a BACnet object or device, and
can be used to trigger alarms and notifications. However, the various status
properties must be included in a BACnet object or device before the system can
display the corresponding status flags.
Figure: BACnet alarm and fault status flags for an open loop before and after configuration
The following table lists the BACnet status flags and their states.
Table: BACnet Status Flags
Status Flag Description
In alarm Displays a check when the Event state has a condition other than
Normal, such as Off-normal. For more information, see section
79.1 “BACnet Notifications” on page 2879.
The box remains unchecked if intrinsic alarming is not supported
by the object. For more information, see section 79.6 “BACnet
Alarms” on page 2898.
Fault This flag is supported by BACnet objects, for example, multistate
inputs and values, trend logs, and loops. Fault is also associated
with the Reliability property. If supported, the system displays a
check when a fault is detected, such as an open loop. For more
information, see section 76.5 “BACnet Reliability Property” on
page 2669.
Overridden This flag is not supported by Building Operation servers. However,
there may be other devices in the BACnet network that have
override switches, for example, b3920s, b3810s, and b3814s as
well as some xP modules that are attached to b3 devices. If
supported, a check displays when the switch is in the manual
position on the device. When a manual override occurs, the device
goes out of service.
04-16006-04-en, March 2015 Technical
2675
76 BACnet Objects and Properties
76.9 BACnet Status Flags
Continued
Status Flag Description
Out of service Displays a check if one of the following conditions occur:
• The Out of service property is set to True.
• An override switch is in the manual position on the device.
• The point is not configured with a valid I/O channel on the
Building Operation server.
• There is a break or decoupling in the connection between the
Associated value and the Value property on the Building
Operation server.
Technical 04-16006-04-en, March 2015
2676
76 BACnet Objects and Properties
76.10 Creating a BACnet Point in a Server
76.10 Creating a BACnet Point in a Server
You create a BACnet analog, digital, or multistate point in a local server so you can
then configure the BACnet point for a non-BACnet device, such as an Automation
Server IO module or LON device. BACnet points that are configured for a non-
BACnet device are visible to other workstations and devices in the BACnet
internetwork.
For more information, see section 76.1 “BACnet Objects and Properties” on page
2663.
To create a BACnet point in a server
1. In WorkStation, in the System Tree, expand BACnet Interface and then
select Application.
2. On the File menu, point to New and then click Point.
3. In the object type list, select the type of point that you want to create.
4. In the Name box, type a name for the point.
5. In the Description box, type a description for the point.
6. Click Next.
Continued on next page
04-16006-04-en, March 2015 Technical
2677
76 BACnet Objects and Properties
76.10 Creating a BACnet Point in a Server
7. In the Instance ID box, choose one of the following options:
• Automatically generated: The server generates a BACnet instance ID.
• Manually entered: Enter an Instance ID.
8. In the BACnet name box, type a BACnet name for the point.
Do not type a name if you want a name to be assigned for you.
9. In the Command priority retain level box, select one of the following
options to configure the warm start and cold start settings for a command
priority array:
• Warm start: The variable retains the last value set by a user or
application. However, the variable reverts to the default value for a cold
start.
• Cold start: The variable retains the last value set by a user or application
for a warm start or cold start.
• No: The variable reverts to the default value upon a restart.
10. Click Create.
Technical 04-16006-04-en, March 2015
2678
76 BACnet Objects and Properties
76.11 Configuring a BACnet Analog Input Point
76.11 Configuring a BACnet Analog Input
Point
You configure a BACnet analog input point to associate the value of an analog input
point on an Automation Server IO module with the BACnet analog input point. You
associate the points to derive the value from the input point of the IO module. You
can also configure an intrinsic alarm for the point if supported by the device.
To configure a BACnet analog input point
1. In WorkStation, in the System Tree, expand BACnet Interface and then
select Application.
2. In List View, select the analog input point that you want to configure.
3. On the File menu, click Properties.
4. Click the Basic tab.
5. Under Status Information, click the Configure button for the Value
property.
6. Edit the properties.
Property Description
Type Displays the object type. Read-only
Unit Select the Unit check box and enter the unit that matches the
unit of the point on the Automation Server IO module. For more
information, see the Units topic on WebHelp.
Init value Displays the initial value, if defined. Read-only.
Reference Enter the Value property of the point that you want to reference.
Forceable Select to make the value forcible. For more information, see the
Forced Values topic on WebHelp.
Retain level Select how to handle values for warm start, cold start, system
events, and system activities. For more information, see the
Retain Level topic on WebHelp.
7. Click OK to close the Value dialog box and return to the Basic tab.
8. Under Configuration Settings, click the Configure button for the
Associated value property.
Continued on next page
04-16006-04-en, March 2015 Technical
2679
76 BACnet Objects and Properties
76.11 Configuring a BACnet Analog Input Point
9. Edit the properties.
Property Description
Type Displays the object type. Read-only
Unit Select the Unit check box and enter the unit that matches the
unit of the point on the Automation Server IO module. For more
information, see the Units topic on WebHelp.
Init value Displays the initial value, if defined. Read-only.
Reference Enter the Value property of the point that you want to reference.
Forceable Select to make the value forcible. For more information, see the
Forced Values topic on WebHelp.
Retain level Select how to handle values for warm start, cold start, system
events, and system activities. For more information, see the
Retain Level topic on WebHelp.
10. Click OK to to close the Associated value dialog box and return to the
Basic tab.
Continued on next page
Technical 04-16006-04-en, March 2015
2680
76 BACnet Objects and Properties
76.11 Configuring a BACnet Analog Input Point
11. Edit the properties.
Property Description
Value Displays an orange button if the Associated value is not
configured. When configured, displays the current value for the
point under the following conditions:
• Unforce. Displays a forced value. Enter a forced value or
click to release the value.
• Force. Displays a non-forced value. Click to force the value.
For all BACnet inputs, a Forced condition is the same as out of
service. For more information, see the Forced Values topic on
WebHelp.
For BACnet outputs and values, which are commandable, a
Forced status may also include a priority level setting. For more
information, see section 77.7 “Forced Priority Level” on page
2857.
Status flags Displays the condition or status of the BACnet point. For more
information, see section 76.9 “BACnet Status Flags” on page
2673.
Out of service Set to True to decouple the Value from the associated property.
If the associated property is not configured, this property is True
and cannot be changed.
Event state Displays Off Normal when intrinsic alarming has been
configured and the point is in an alarm state.
Alarm state Displays a Building Operation alarm state that provides additional
information about an intrinsic alarm or algorithmic alarm
configured for an object. For more information, see the Alarm
States topic on WebHelp.
Associated Displays the value of the referenced property.
value
COV increment Enter the minimum change in the Value property that causes a
COV notification to be sent.
12. Click OK.
Continued on next page
04-16006-04-en, March 2015 Technical
2681
76 BACnet Objects and Properties
76.11 Configuring a BACnet Analog Input Point
13. Click the Advanced tab.
Continued on next page
Technical 04-16006-04-en, March 2015
2682
76 BACnet Objects and Properties
76.11 Configuring a BACnet Analog Input Point
14. Edit the properties.
Property Description
Object ID Displays the BACnet object type and instance number of the
device.
BACnet name
BACnet type Displays the type, which is always device.
Acknowledged Displays whether acknowledgements for to-off-normal, to-
transitions fault, or to-normal transitions have been received.
To-off-normal Displays the date and time of the last to-off-normal transition.
time
To-fault time Displays the date and time of the last to-fault transition.
To-normal time Displays the date and time of the last to-normal transition.
Time delay Enter the minimum number of seconds required before a to-off-
normal event, or to-normal event is generated.
BACnet Choose the method for referencing the intrinsic alarm object
notification that you want to use to generate event notifications:
• Select System reference to define a path-based
reference to an object or property that is currently located
on the server. When selected, only the Path field becomes
editable. All the other fields become non-editable.
• Select BACnet reference to define a reference that
uses the elements of a property value (Device instance
number, Object type, or Object instance number) to
identify a BACnet object or property that is not currently on
the server but may be uploaded or imported to the server
later. You can also use this method to reference a BACnet
object or property on an external device.
For more information, see section 73.7 “BACnet References
and System References” on page 2562.
Alarm handling Select the data source for alarm handling and presentation
and presentation information. The alarm presentation settings display as three
tabs (User Action, Attachment, and Presentation) on the alarm
sources (value) as well as in the notification class. For more
information, see section 79.6 “BACnet Alarms” on page 2898.
Notify type Select the type of BACnet event notification to be generated:
• Select alarm to define the event as a BACnet alarm and
to display the event in Alarm View.
• Select event to define the event as a BACnet event and to
display the event in Event View.
Event enable Select the flags to enable the reporting of to-off-normal and
to-normal events. to-fault reporting is not supported by
Building Operation BACnet devices.
Upper limit Enter a limit that Value is required to exceed before a to-off-
normal event is generated.
Continued on next page
04-16006-04-en, March 2015 Technical
2683
76 BACnet Objects and Properties
76.11 Configuring a BACnet Analog Input Point
Continued
Property Description
Lower limit Enter a limit that Value is required to fall below before a to-off-
normal event is generated.
The system generates a to-off-normal event based on Value
and the boundaries defined by the Upper Limit, Lower limit, and
Deadband. For example, if you enter 5 seconds and the Value
remains outside the Upper limit and Lower limit boundaries for a
minimum of 5 seconds, the system generates a to-off-normal
event.
Deadband Enter a range that is an offset from the low-level and high-level
limits, which defines the range where a to-normal event can be
generated. To generate a to-normal event, the value must be
above the low limit and below the high limit, minus the
deadband. For generic objects, this property is present only in
analog objects from external devices that support intrinsic
reporting.
Limit enable Select Low limit enable to enable the reporting of Lower
limit off-normal events and to-normal events. Select High
limit enable to enable the reporting of Upper limit off-normal
events and to-normal events.
Alarm message Enter the text that you want to display in the Alarm View for the
corresponding alarm state. The configured text is also sent to
Reset message any external BACnet clients configured as alarm recipients in
Fault message the BACnet notification.
For more information, see the Alarms Pane and Alarm View
topic on WebHelp.
15. Click OK.
Technical 04-16006-04-en, March 2015
2684
76 BACnet Objects and Properties
76.12 Configuring a BACnet Digital Input Point
76.12 Configuring a BACnet Digital Input
Point
You configure a BACnet digital input point to associate the value of a digital input
point on an Automation Server IO module with the BACnet digital input point. You
associate the points in order to derive the value from the input point of the IO
module. You can also configure an intrinsic alarm for the point.
To configure a BACnet digital input point
1. In WorkStation, in the System Tree, expand BACnet Interface and then
select Application.
2. In List View, select the digital input point that you want to configure.
3. On the File menu, click Properties.
4. Click the Basic tab.
5. Under Configuration Settings, click the Configure button for the
Associated value property.
6. Edit the properties.
Property Description
Type Displays the object type. Read-only
Unit Select the Unit check box and enter the unit that matches the
unit of the point on the Automation Server IO module. For more
information, see the Units topic on WebHelp.
Init value Displays the initial value, if defined. Read-only.
Reference Enter the Value property of the point that you want to reference.
Forceable Select to make the value forcible. For more information, see the
Forced Values topic on WebHelp.
Retain level Select how to handle values for warm start, cold start, system
events, and system activities. For more information, see the
Retain Level topic on WebHelp.
04-16006-04-en, March 2015 Technical
2685
76 BACnet Objects and Properties
76.12 Configuring a BACnet Digital Input Point
7. Click OK to close the Value dialog box and return to the Basic tab.
Continued on next page
Technical 04-16006-04-en, March 2015
2686
76 BACnet Objects and Properties
76.12 Configuring a BACnet Digital Input Point
8. Edit the properties.
Property Description
Value Displays an orange button if the Associated value is not
configured. When configured, displays the current value for the
point under the following conditions:
• Unforce. Displays a forced value. Enter a forced value or
click to release the value.
• Force. Displays a non-forced value. Click to force the value.
For all BACnet inputs, a Forced condition is the same as out of
service. For more information, see the Forced Values topic on
WebHelp.
For BACnet outputs and values, which are commandable, a
Forced status may also include a priority level setting. For more
information, see section 77.7 “Forced Priority Level” on page
2857.
Status flags Displays the condition or status of the BACnet point. For more
information, see section 76.9 “BACnet Status Flags” on page
2673.
Out of service Set to True to decouple the Value from the associated property.
If the associated property is not configured, this property is True
and cannot be changed.
Event state Displays Off Normal when intrinsic alarming has been
configured and the point is in an alarm state.
Alarm state Displays a Building Operation alarm state that provides additional
information about an intrinsic alarm or algorithmic alarm
configured for an object. For more information, see the Alarm
States topic on WebHelp.
Associated Displays the value of the referenced property.
value
Polarity Select one of the following options to control the relationship
between the BACnet point and the point of the Automation
Server IO module:
• Normal if you want the Associated value of True to
equal Active.
• Reverse if you want the Associated value of False to
equal Active.
Inactive text Type the text that explains the Inactive state of the value, such as
Pump_Basement_Off. This text is used as an enumeration text
for the Value property and related priority array values. It is visible
in graphics, in the Watch pane, and in the Properties pane.
If you leave this box empty, the default (Inactive) is used instead.
Active text Type the text that explains the Active state of the value, such as
Pump_Basement_On. This text is used as an enumeration text
for the Value property and related priority array values. It is visible
in graphics, in the Watch pane, and in the Properties pane.
If you leave this box empty, the default (Active) is used instead.
Continued on next page
04-16006-04-en, March 2015 Technical
2687
76 BACnet Objects and Properties
76.12 Configuring a BACnet Digital Input Point
Continued
9. Click OK.
10. Click the Advanced tab.
Continued on next page
Technical 04-16006-04-en, March 2015
2688
76 BACnet Objects and Properties
76.12 Configuring a BACnet Digital Input Point
11. Edit the properties.
Property Description
Object ID Displays the BACnet object type and instance number of the
device.
BACnet name View the name of the BACnet object or type a new name to
change the name.
BACnet type Displays the type, which is always device.
Acknowledged Displays whether acknowledgements for to-off-normal, to-
transitions fault, or to-normal transitions have been received.
To-off-normal Displays the date and time of the last to-off-normal transition.
time
To-fault time Displays the date and time of the last to-fault transition.
To-normal time Displays the date and time of the last to-normal transition.
Time delay Enter the minimum number of seconds required before a to-off-
normal event, or to-normal event is generated.
BACnet Choose the method for referencing the intrinsic alarm object
notification that you want to use to generate event notifications:
• Select System reference to define a path-based
reference to an object or property that is currently located
on the server. When selected, only the Path field becomes
editable. All the other fields become non-editable.
• Select BACnet reference to define a reference that
uses the elements of a property value (Device instance
number, Object type, or Object instance number) to
identify a BACnet object or property that is not currently on
the server but may be uploaded or imported to the server
later. You can also use this method to reference a BACnet
object or property on an external device.
For more information, see section 73.7 “BACnet References
and System References” on page 2562.
Alarm handling Select the data source for alarm handling and presentation
and presentation information. The alarm presentation settings display as three
tabs (User Action, Attachment, and Presentation) on the alarm
sources (value) as well as in the notification class. For more
information, see section 79.6 “BACnet Alarms” on page 2898.
Notify type Select the type of BACnet event notification to be generated:
• Select alarm to define the event as a BACnet alarm and
to display the event in Alarm View.
• Select event to define the event as a BACnet event and to
display the event in Event View.
Event enable Select the flags to enable the reporting of to-off-normal and
to-normal events. to-fault reporting is not supported by
Building Operation BACnet devices.
Upper limit Enter a limit that Value is required to exceed before a to-off-
normal event is generated.
Continued on next page
04-16006-04-en, March 2015 Technical
2689
76 BACnet Objects and Properties
76.12 Configuring a BACnet Digital Input Point
Continued
Property Description
Lower limit Enter a limit that Value is required to fall below before a to-off-
normal event is generated.
The system generates a to-off-normal event based on Value
and the boundaries defined by the Upper Limit, Lower limit, and
Deadband. For example, if you enter 5 seconds and the Value
remains outside the Upper limit and Lower limit boundaries for a
minimum of 5 seconds, the system generates a to-off-normal
event.
Deadband Enter a range that is an offset from the low-level and high-level
limits, which defines the range where a to-normal event can be
generated. To generate a to-normal event, the value must be
above the low limit and below the high limit, minus the
deadband. For generic objects, this property is present only in
analog objects from external devices that support intrinsic
reporting.
Limit enable Select Low limit enable to enable the reporting of Lower
limit off-normal events and to-normal events. Select High
limit enable to enable the reporting of Upper limit off-normal
events and to-normal events.
Alarm message Enter the text that you want to display in the Alarm View for the
corresponding alarm state. The configured text is also sent to
Reset message any external BACnet clients configured as alarm recipients in
Fault message the BACnet notification.
For more information, see the Alarms Pane and Alarm View
topic on WebHelp.
Note
• The system generates a to-off-normal event based on Value
and the boundaries defined by the Upper Limit, Lower limit,
and Deadband. For example, if you enter 5 seconds and the
Value remains outside the Upper limit and Lower limit
boundaries for a minimum of 5 seconds, the system generates a
to-off-normal event.
12. Click OK.
Technical 04-16006-04-en, March 2015
2690
76 BACnet Objects and Properties
76.13 Configuring a BACnet Multistate Input Point
76.13 Configuring a BACnet Multistate Input
Point
You configure a BACnet multistate input point to associate the value of a multistate
input point on an Automation Server IO module with the BACnet multistate input
point. You associate the points to derive the value from the input point of the IO
module. You can also configure an intrinsic alarm for the point if supported by the
device.
To configure a BACnet multistate input point
1. In WorkStation, in the System Tree, expand BACnet Interface and then
select Application.
2. In List View, select the multistate input point that you want to configure.
3. On the File menu, click Open.
4. Click the State Configuration tab.
5. In the Number of states box, enter the number of states that you want to
create, for example, enter 3 if you want to create 3 states.
6. In the Label column, click the text and then type a description for the state
number, such as Unoccupied, Standby, or Warmup.
Repeat this step for each state that you created.
7. Click the Save button .
Continued on next page
04-16006-04-en, March 2015 Technical
2691
76 BACnet Objects and Properties
76.13 Configuring a BACnet Multistate Input Point
8. Click the Properties tab and then click the Basic tab.
Continued on next page
Technical 04-16006-04-en, March 2015
2692
76 BACnet Objects and Properties
76.13 Configuring a BACnet Multistate Input Point
9. Edit the properties.
Property Description
Value Displays an orange button if the Associated value is not
configured. When configured, displays the current value for the
point under the following conditions:
• Unforce. Displays a forced value. Enter a forced value or
click to release the value.
• Force. Displays a non-forced value. Click to force the value.
For all BACnet inputs, a Forced condition is the same as out of
service. For more information, see the Forced Values topic on
WebHelp.
For BACnet outputs and values, which are commandable, a
Forced status may also include a priority level setting. For more
information, see section 77.7 “Forced Priority Level” on page
2857.
Status flags Displays the condition or status of the BACnet point. For more
information, see section 76.9 “BACnet Status Flags” on page
2673.
Out of service Set to True to decouple the Value from the associated property.
If the associated property is not configured, this property is True
and cannot be changed.
Event state Displays Off Normal when intrinsic alarming has been
configured and the point is in an alarm state.
Alarm state Displays a Building Operation alarm state that provides additional
information about an intrinsic alarm or algorithmic alarm
configured for an object. For more information, see the Alarm
States topic on WebHelp.
Reliability Displays the reliability of the point.
Associated Displays the value of the referenced property.
value
Associated Enter an offset value, which is a combination of the Associated
value offset value and Associated offset value.
10. Click the Save button .
Continued on next page
04-16006-04-en, March 2015 Technical
2693
76 BACnet Objects and Properties
76.13 Configuring a BACnet Multistate Input Point
11. Click the Advanced tab.
Continued on next page
Technical 04-16006-04-en, March 2015
2694
76 BACnet Objects and Properties
76.13 Configuring a BACnet Multistate Input Point
12. Edit the properties.
Property Description
Object ID Displays the BACnet object type and instance number of the
device.
BACnet name View the name of the BACnet object or type a new name to
change the name.
BACnet type Displays the type, which is always device.
Acknowledged Displays whether acknowledgements for to-off-normal, to-
transitions fault, or to-normal transitions have been received.
To-off-normal Displays the date and time of the last to-off-normal transition.
time
To-fault time Displays the date and time of the last to-fault transition.
To-normal time Displays the date and time of the last to-normal transition.
Time delay Enter the minimum number of seconds required before a to-off-
normal event, or to-normal event is generated.
BACnet Choose the method for referencing the intrinsic alarm object
notification that you want to use to generate event notifications:
• Select System reference to define a path-based
reference to an object or property that is currently located
on the server. When selected, only the Path field becomes
editable. All the other fields become non-editable.
• Select BACnet reference to define a reference that
uses the elements of a property value (Device instance
number, Object type, or Object instance number) to
identify a BACnet object or property that is not currently on
the server but may be uploaded or imported to the server
later. You can also use this method to reference a BACnet
object or property on an external device.
For more information, see section 73.7 “BACnet References
and System References” on page 2562.
Alarm handling Select the data source for alarm handling and presentation
and presentation information. The alarm presentation settings display as three
tabs (User Action, Attachment, and Presentation) on the alarm
sources (value) as well as in the notification class. For more
information, see section 79.6 “BACnet Alarms” on page 2898.
Notify type Select the type of BACnet event notification to be generated:
• Select alarm to define the event as a BACnet alarm and
to display the event in Alarm View.
• Select event to define the event as a BACnet event and to
display the event in Event View.
Event enable Select the flags to enable the reporting of to-off-normal and
to-normal events. to-fault reporting is not supported by
Building Operation BACnet devices.
State Id Enter the State Id for which you want to set an alarm or fault
alarm.
Continued on next page
04-16006-04-en, March 2015 Technical
2695
76 BACnet Objects and Properties
76.13 Configuring a BACnet Multistate Input Point
Continued
Property Description
Is alarm value Select Yes or No to assign an alarm to the State Id. If you
select Yes, select No for Is fault value.
Is fault value Select Yes or No to assign a fault alarm to the State Id. If you
select Yes, select No for Is alarm value.
Click to add an alarm or fault State Id to the list of alarm and
fault values.
Click to open the Properties dialog box where you can edit
the alarm or fault configuration for a selected State Id. For
more information, see section 81.62 “BACnet Multistate Alarm
Properties Dialog Box” on page 3069.
Click to remove the State Id from the list of alarm or fault
values.
Alarm message Enter the text that you want to display in the Alarm View for the
corresponding alarm state. The configured text is also sent to
Reset message any external BACnet clients configured as alarm recipients in
Fault message the BACnet notification.
For more information, see the Alarms Pane and Alarm View
topic on WebHelp.
13. Click to create a multistate alarm.
14. Type a name for the alarm and click Create.
15. Repeat the process until you have the desired number of alarms.
Continued on next page
Technical 04-16006-04-en, March 2015
2696
76 BACnet Objects and Properties
76.13 Configuring a BACnet Multistate Input Point
16. Select an alarm from the list and click to modify an alarm.
17. Edit the properties.
Property Description
State Id Enter the state that you want to configure for the multistate
point or value.
Is alarm value Select Yes to assign an alarm to the State Id. Then, select No
for Is fault value.
Is fault value Select Yes to assign a fault alarm to the State Id. Then, select
No for Is alarm value.
18. Click OK to return to the Advanced tab.
19. Repeat the steps to modify another alarm.
20. Click the Save button .
04-16006-04-en, March 2015 Technical
2697
76 BACnet Objects and Properties
76.14 Configuring a BACnet Analog Output Point
76.14 Configuring a BACnet Analog Output
Point
You configure a BACnet analog output point to associate the value of the point on
an Automation Server IO module with the BACnet analog output point. You
associate the points to control the value of the IO module point. You can also
configure an intrinsic alarm for the point if supported by the device.
To configure a BACnet analog output point
1. In WorkStation, in the System Tree, expand BACnet Interface and then
select Application.
2. In List View, select the analog output point that you want to configure.
3. On the File menu, click Properties.
4. Click the Basic tab.
5. Under Status Information, click the Configure button for the Value
property.
6. Edit the properties.
Property Description
Type Displays the object type. Read-only
Unit Select the Unit check box and enter the unit that matches the
unit of the point on the Automation Server IO module. For more
information, see the Units topic on WebHelp.
Init value Displays the initial value, if defined. Read-only.
Reference Enter the Value property of the point that you want to reference.
Forceable Select to make the value forcible. For more information, see the
Forced Values topic on WebHelp.
Retain level Select how to handle values for warm start, cold start, system
events, and system activities. For more information, see the
Retain Level topic on WebHelp.
Technical 04-16006-04-en, March 2015
2698
76 BACnet Objects and Properties
76.14 Configuring a BACnet Analog Output Point
7. Click OK to close the Value dialog box and return to the Basic tab.
Continued on next page
04-16006-04-en, March 2015 Technical
2699
76 BACnet Objects and Properties
76.14 Configuring a BACnet Analog Output Point
8. Edit the properties.
Property Description
Value Displays an orange button if the Associated value is not
configured. When configured, displays the current value for the
point under the following conditions:
• Unforce. Displays a forced value. Enter a forced value or
click to release the value.
• Force. Displays a non-forced value. Click to force the value.
For all BACnet inputs, a Forced condition is the same as out of
service. For more information, see the Forced Values topic on
WebHelp.
For BACnet outputs and values, which are commandable, a
Forced status may also include a priority level setting. For more
information, see section 77.7 “Forced Priority Level” on page
2857.
Status flags Displays the condition or status of the BACnet point. For more
information, see section 76.9 “BACnet Status Flags” on page
2673.
Out of service Set to True to decouple the Value from the associated property.
If the associated property is not configured, this property is True
and cannot be changed.
Event state Displays Off Normal when intrinsic alarming has been
configured and the point is in an alarm state.
Alarm state Displays a Building Operation alarm state that provides additional
information about an intrinsic alarm or algorithmic alarm
configured for an object. For more information, see the Alarm
States topic on WebHelp.
Associated Displays the value of the referenced property.
value
COV increment Enter the minimum change in the Value property that causes a
COV notification to be sent.
9. Click OK.
Continued on next page
Technical 04-16006-04-en, March 2015
2700
76 BACnet Objects and Properties
76.14 Configuring a BACnet Analog Output Point
10. Click the Advanced tab.
Continued on next page
04-16006-04-en, March 2015 Technical
2701
76 BACnet Objects and Properties
76.14 Configuring a BACnet Analog Output Point
11. Edit the properties.
Property Description
Object ID Displays the BACnet object type and instance number of the
device.
BACnet name View the name of the BACnet object or type a new name to
change the name.
BACnet type Displays the type, which is always device.
Acknowledged Displays whether acknowledgements for to-off-normal, to-
transitions fault, or to-normal transitions have been received.
To-off-normal Displays the date and time of the last to-off-normal transition.
time
To-fault time Displays the date and time of the last to-fault transition.
To-normal time Displays the date and time of the last to-normal transition.
Time delay Enter the minimum number of seconds required before a to-off-
normal event, or to-normal event is generated.
BACnet Choose the method for referencing the intrinsic alarm object
notification that you want to use to generate event notifications:
• Select System reference to define a path-based
reference to an object or property that is currently located
on the server. When selected, only the Path field becomes
editable. All the other fields become non-editable.
• Select BACnet reference to define a reference that
uses the elements of a property value (Device instance
number, Object type, or Object instance number) to
identify a BACnet object or property that is not currently on
the server but may be uploaded or imported to the server
later. You can also use this method to reference a BACnet
object or property on an external device.
For more information, see section 73.7 “BACnet References
and System References” on page 2562.
Alarm handling Select the data source for alarm handling and presentation
and presentation information. The alarm presentation settings display as three
tabs (User Action, Attachment, and Presentation) on the alarm
sources (value) as well as in the notification class. For more
information, see section 79.6 “BACnet Alarms” on page 2898.
Notify type Select the type of BACnet event notification to be generated:
• Select alarm to define the event as a BACnet alarm and
to display the event in Alarm View.
• Select event to define the event as a BACnet event and to
display the event in Event View.
Event enable Select the flags to enable the reporting of to-off-normal and
to-normal events. to-fault reporting is not supported by
Building Operation BACnet devices.
Upper limit Enter a limit that Value is required to exceed before a to-off-
normal event is generated.
Continued on next page
Technical 04-16006-04-en, March 2015
2702
76 BACnet Objects and Properties
76.14 Configuring a BACnet Analog Output Point
Continued
Property Description
Lower limit Enter a limit that Value is required to fall below before a to-off-
normal event is generated.
The system generates a to-off-normal event based on Value
and the boundaries defined by the Upper Limit, Lower limit, and
Deadband. For example, if you enter 5 seconds and the Value
remains outside the Upper limit and Lower limit boundaries for a
minimum of 5 seconds, the system generates a to-off-normal
event.
Deadband Enter a range that is an offset from the low-level and high-level
limits, which defines the range where a to-normal event can be
generated. To generate a to-normal event, the value must be
above the low limit and below the high limit, minus the
deadband. For generic objects, this property is present only in
analog objects from external devices that support intrinsic
reporting.
Limit enable Select Low limit enable to enable the reporting of Lower
limit off-normal events and to-normal events. Select High
limit enable to enable the reporting of Upper limit off-normal
events and to-normal events.
Alarm message Enter the text that you want to display in the Alarm View for the
corresponding alarm state. The configured text is also sent to
Reset message any external BACnet clients configured as alarm recipients in
Fault message the BACnet notification.
For more information, see the Alarms Pane and Alarm View
topic on WebHelp.
Note
• The system generates a to-off-normal event based on Value
and the boundaries defined by the Upper Limit, Lower limit,
and Deadband. For example, if you enter 5 seconds and the
Value remains outside the Upper limit and Lower limit
boundaries for a minimum of 5 seconds, the system generates a
to-off-normal event.
12. Click OK.
13. Click the Command tab.
Continued on next page
04-16006-04-en, March 2015 Technical
2703
76 BACnet Objects and Properties
76.14 Configuring a BACnet Analog Output Point
14. Edit the properties.
Property Description
Relinquish Enter the value to be used by the Value property when all values in
default the priority array are set to Null.
Active Specifies the priority level (1-16) currently controlling the present
command value. The present value is the highest priority with a non-Null value.
priority
Priority 6 This priority is reserved for timer-based algorithms that are not
currently supported. (Read-only)
Priority x Enter a priority value or Null.
15. Click OK.
Technical 04-16006-04-en, March 2015
2704
76 BACnet Objects and Properties
76.15 Configuring a BACnet Digital Output Point
76.15 Configuring a BACnet Digital Output
Point
You configure a BACnet digital output point to associate the value of a digital output
point on an Automation Server IO module with the BACnet digital output point. You
associate the points in order to control the value of the IO module point.
To configure a BACnet digital output point
1. In WorkStation, in the System Tree, expand BACnet Interface and then
select Application.
2. In List View, select the digital output point that you want to configure.
3. On the File menu, click Properties.
4. Click the Basic tab.
5. Under Status Information, click the Configure button for the Value
property.
6. Edit the properties.
Property Description
Type Displays the object type. Read-only
Unit Select the Unit check box and enter the unit that matches the
unit of the point on the Automation Server IO module. For more
information, see the Units topic on WebHelp.
Init value Displays the initial value, if defined. Read-only.
Reference Enter the Value property of the point that you want to reference.
Forceable Select to make the value forcible. For more information, see the
Forced Values topic on WebHelp.
Retain level Select how to handle values for warm start, cold start, system
events, and system activities. For more information, see the
Retain Level topic on WebHelp.
04-16006-04-en, March 2015 Technical
2705
76 BACnet Objects and Properties
76.15 Configuring a BACnet Digital Output Point
7. Click OK to close the Value dialog box and return to the Basic tab.
Continued on next page
Technical 04-16006-04-en, March 2015
2706
76 BACnet Objects and Properties
76.15 Configuring a BACnet Digital Output Point
8. Edit the properties.
Property Description
Value Displays an orange button if the Associated value is not
configured. When configured, displays the current value for the
point under the following conditions:
• Unforce. Displays a forced value. Enter a forced value or
click to release the value.
• Force. Displays a non-forced value. Click to force the
value.
For all BACnet inputs, a Forced condition is the same as out of
service. For more information, see the Forced Values topic on
WebHelp.
For BACnet outputs and values, which are commandable, a
Forced status may also include a priority level setting. For more
information, see section 77.7 “Forced Priority Level” on page
2857.
Status flags Displays the condition or status of the BACnet point. For more
information, see section 76.9 “BACnet Status Flags” on page
2673.
Out of service Select True to disassociate the Value from the physical output.
Out of service is primarily used for testing purposes.
Event state Displays one of the following active event states associated with
the point:
• Normal when the point is not in an alarm state.
• Off Normal when the Intrinsic Alarm is configured and the
point is in an alarm state.
Associated value Displays the read-only value of the property that is associated
with the BACnet point.
Polarity Select one of the following options to control the relationship
between the BACnet point and the point of the Automation
Server IO module:
• Normal if you want the Associated value of True to
equal Active.
• Reverse if you want the Associated value of False to
equal Active.
Inactive text Type the text that explains the Inactive state of the value, such
as Pump_Basement_Off. This text is used as an enumeration
text for the Value property and related priority array values. It is
visible in graphics, in the Watch pane, and in the Properties
pane.
If you leave this box empty, the default (Inactive) is used instead.
Active text Type the text that explains the Active state of the value, such as
Pump_Basement_On. This text is used as an enumeration text
for the Value property and related priority array values. It is
visible in graphics, in the Watch pane, and in the Properties
pane.
If you leave this box empty, the default (Active) is used instead.
Continued on next page
04-16006-04-en, March 2015 Technical
2707
76 BACnet Objects and Properties
76.15 Configuring a BACnet Digital Output Point
Continued
9. Click OK.
10. Click the Advanced tab.
11. Edit the properties.
Property Description
Object ID Displays the BACnet object type and instance number of the
device.
BACnet name View the name of the BACnet object or type a new name to
change the name.
BACnet type Displays the type, which is always device.
12. Click OK.
Continued on next page
Technical 04-16006-04-en, March 2015
2708
76 BACnet Objects and Properties
76.15 Configuring a BACnet Digital Output Point
13. Click the Command tab.
14. Edit the properties.
Property Description
Relinquish Enter the value to be used by the Value property when all values in
default the priority array are set to Null.
Active Specifies the priority level (1-16) currently controlling the present
command value. The present value is the highest priority with a non-Null value.
priority
Priority 6 This priority is reserved for timer-based algorithms that are not
currently supported. (Read-only)
Priority x Enter a priority value or Null.
15. Click OK.
04-16006-04-en, March 2015 Technical
2709
76 BACnet Objects and Properties
76.16 Configuring a BACnet Multistate Output Point
76.16 Configuring a BACnet Multistate Output
Point
You configure a BACnet multistate output point to associate the value of a
multistate output point on an Automation Server IO module with the BACnet
multistate output point. You associate the points in order to control the value of the
IO module point. You can also enter a value for the Relinquish default property.
To configure a BACnet multistate output point
1. In WorkStation, in the System Tree, expand BACnet Interface and select
Application.
2. In List View, select the multistate output point that you want to configure.
3. On the File menu, click Open.
4. Click the State Configuration tab.
5. In the Number of states box, enter the number of states that you want to
create, for example, enter 3 if you want to create 3 states.
Use the up arrow to enter the number.
6. In the Label column, click the text and then type a description for the state
number, such as Unoccupied, Standby, or Warmup.
Repeat this step for each state that you created.
7. Click the Save button .
8. Click the Properties tab and then click the Basic tab.
9. Under Status Information, click the Configure button for the Value
property.
Continued on next page
Technical 04-16006-04-en, March 2015
2710
76 BACnet Objects and Properties
76.16 Configuring a BACnet Multistate Output Point
10. Edit the properties.
Property Description
Type Displays the object type. Read-only
Unit Select the Unit check box and enter the unit that matches the
unit of the point on the Automation Server IO module. For more
information, see the Units topic on WebHelp.
Init value Displays the initial value, if defined. Read-only.
Reference Enter the Value property of the point that you want to reference.
Forceable Select to make the value forcible. For more information, see the
Forced Values topic on WebHelp.
Retain level Select how to handle values for warm start, cold start, system
events, and system activities. For more information, see the
Retain Level topic on WebHelp.
11. Click OK to return to the Basic tab.
Continued on next page
04-16006-04-en, March 2015 Technical
2711
76 BACnet Objects and Properties
76.16 Configuring a BACnet Multistate Output Point
12. Edit the properties.
Property Description
Value Displays an orange button if the Associated value is not
configured. When configured, displays the current value for the
point under the following conditions:
• Unforce. Displays a forced value. Enter a forced value or
click to release the value.
• Force. Displays a non-forced value. Click to force the value.
For all BACnet inputs, a Forced condition is the same as out of
service. For more information, see the Forced Values topic on
WebHelp.
For BACnet outputs and values, which are commandable, a
Forced status may also include a priority level setting. For more
information, see section 77.7 “Forced Priority Level” on page
2857.
Status flags Displays the condition or status of the BACnet point. For more
information, see section 76.9 “BACnet Status Flags” on page
2673.
Out of service Set to True to decouple the Value from the associated property.
If the associated property is not configured, this property is True
and cannot be changed.
Event state Displays Off Normal when intrinsic alarming has been
configured and the point is in an alarm state.
Associated Displays the value to be read by the referenced property.
value
Associated Enter an offset value, which is a combination of the Associated
value offset value and Associated offset value.
13. Click the Save button .
14. Click the Advanced tab.
15. In the BACnet name box, type a name for the multistate point.
16. Click the Save button .
Continued on next page
Technical 04-16006-04-en, March 2015
2712
76 BACnet Objects and Properties
76.16 Configuring a BACnet Multistate Output Point
17. Click the Command tab.
18. Edit the properties.
Property Description
Relinquish Enter the value to be used by the Value property when all values in
default the priority array are set to Null.
Active Specifies the priority level (1-16) currently controlling the present
command value. The present value is the highest priority with a non-Null value.
priority
Priority 6 This priority is reserved for timer-based algorithms that are not
currently supported. (Read-only)
Priority x Enter a priority value or Null.
19. Click the Save button .
04-16006-04-en, March 2015 Technical
2713
76 BACnet Objects and Properties
76.17 Creating a BACnet Point (Generic)
76.17 Creating a BACnet Point (Generic)
You create an analog, digital, or multistate BACnet point (generic) for a device when
you want to view and configure a BACnet point in an external BACnet device.
For more information, see section 75.21 “Device Communication and Diagnostics”
on page 2631.
When you create the BACnet point (generic), you need to perform one of the
following operations:
• Download to a device to create a point in an external BACnet device. For more
information, see section 76.7 “BACnet Configuration Properties” on page
2671.
• Upload from a device to upload the properties of a point from a BACnet device
into Building Operation.
After you create the point, you can use WorkStation to configure and modify the
point, and perform additional BACnet interoperable tasks with the object.
To create a BACnet point (generic)
1. In WorkStation, in the System Tree, expand BACnet Interface, expand
the network where the device resides, then expand the device.
2. Select Application.
3. On the File menu, point to New and then click Point.
4. In the object type list, select the type of point that you want to create.
5. In the Name box, type a name for the point.
6. In the Description box, type a description for the point.
Continued on next page
Technical 04-16006-04-en, March 2015
2714
76 BACnet Objects and Properties
76.17 Creating a BACnet Point (Generic)
7. Click Next.
8. Click Download to BACnet device and then manually enter an Instance ID
now if you want. Otherwise, click to have the ID automatically generated. Once
created, be aware that you cannot change the object’s Instance ID.
9. In the BACnet name box, type a BACnet name for the point. Do not type a
name if you want a name to be assigned for you.
10. Click Upload from BACnet device if you want to upload the properties of
the point from the BACnet device into Building Operation.
11. Click Create.
04-16006-04-en, March 2015 Technical
2715
76 BACnet Objects and Properties
76.18 Configuring a BACnet Analog Input Point (Generic)
76.18 Configuring a BACnet Analog Input
Point (Generic)
You configure a BACnet analog input (generic) to configure the properties of an
analog input point in an external BACnet device. You can also configure an intrinsic
alarm for the point.
To configure a BACnet analog input point (generic)
1. In WorkStation, in the System Tree, expand BACnet Interface, and then
expand the appropriate network.
2. Expand the device where the external analog input point resides and select
Application.
3. In List View, select the analog input point (generic) that you want to
configure.
4. On the File menu, click Properties.
5. Click the Basic tab.
6. Under Status Information, click the Configure button for the Value
property.
7. Edit the properties.
Property Description
Type Displays the object type. Read-only
Unit Select the Unit check box and enter the unit that matches the
unit of the point on the Automation Server IO module. For more
information, see the Units topic on WebHelp.
Init value Displays the initial value, if defined. Read-only.
Reference Enter the Value property of the point that you want to reference.
Forceable Select to make the value forcible. For more information, see the
Forced Values topic on WebHelp.
Retain level Select how to handle values for warm start, cold start, system
events, and system activities. For more information, see the
Retain Level topic on WebHelp.
Technical 04-16006-04-en, March 2015
2716
76 BACnet Objects and Properties
76.18 Configuring a BACnet Analog Input Point (Generic)
8. Click OK to close the Value dialog box and return to the Basic tab.
Continued on next page
04-16006-04-en, March 2015 Technical
2717
76 BACnet Objects and Properties
76.18 Configuring a BACnet Analog Input Point (Generic)
9. Edit the properties.
Property Description
Value Displays an orange button if the Associated value is not
configured. When configured, displays the current value for the
point under the following conditions:
• Unforce. Displays a forced value. Enter a forced value or
click to release the value.
• Force. Displays a non-forced value. Click to force the value.
For all BACnet inputs, a Forced condition is the same as out of
service. For more information, see the Forced Values topic on
WebHelp.
For BACnet outputs and values, which are commandable, a
Forced status may also include a priority level setting. For more
information, see section 77.7 “Forced Priority Level” on page
2857.
Status flags Displays the condition or status of the BACnet point. For more
information, see section 76.9 “BACnet Status Flags” on page
2673.
Out of service Set to True to decouple the Value from the associated property.
If the associated property is not configured, this property is True
and cannot be changed.
Event state Displays Off Normal when intrinsic alarming has been
configured and the point is in an alarm state.
Alarm state Displays a Building Operation alarm state that provides additional
information about an intrinsic alarm or algorithmic alarm
configured for an object. For more information, see the Alarm
States topic on WebHelp.
COV increment Enter the minimum change in the Value property that causes a
COV notification to be sent.
Update interval Displays the maximum amount of time between updates to the
Value property when the input is not Overridden and Out of
service is False. The time value is hundredths of a second.
Minimum value Enter the lowest value that can be reliably derived for the Value
property.
Maximum value Enter the highest value that can be reliably derived for the Value
property.
Resolution Displays the smallest recognizable change in the Value property.
Device type Type a description of the device that is either connected to or
represented by the object. For example, the text could describe
the type of sensor connected to an analog input or the type of
sensor represented by an accumulator.
10. Click OK.
Continued on next page
Technical 04-16006-04-en, March 2015
2718
76 BACnet Objects and Properties
76.18 Configuring a BACnet Analog Input Point (Generic)
11. Click the Advanced tab.
Continued on next page
04-16006-04-en, March 2015 Technical
2719
76 BACnet Objects and Properties
76.18 Configuring a BACnet Analog Input Point (Generic)
12. Edit the properties.
Property Description
Object ID Displays the BACnet object type and instance number of the
device.
BACnet name View the name of the BACnet object or type a new name to
change the name.
BACnet type Displays the type, which is always device.
Profile name Displays the unique name of the profile that describes additional
characteristics of the object, such as additional properties,
behaviors, or requirements.
Acknowledged Displays whether acknowledgements for to-off-normal, to-
transitions fault, or to-normal transitions have been received.
To-off-normal Displays the BACnet timestamp of the last to-off-normal
time transition.
To-fault time Displays the BACnet timestamp of the last to-fault transition.
To-normal time Displays the BACnet timestamp of the last to-normal
transition.
Time delay Enter the minimum number of seconds required before a to-off-
normal event, or to-normal event is generated.
BACnet Choose the method for referencing the intrinsic alarm object
notification that you want to use to generate event notifications:
• Select System reference to define a path-based
reference to an object or property that is currently located
on the server. When selected, only the Path field becomes
editable. All the other fields become non-editable.
• Select BACnet reference to define a reference that
uses the elements of a property value (Device instance
number, Object type, or Object instance number) to
identify a BACnet object or property that is not currently on
the server but may be uploaded or imported to the server
later. You can also use this method to reference a BACnet
object or property on an external device.
For more information, see section 73.7 “BACnet References
and System References” on page 2562.
Notify type Select the type of BACnet event notification to be generated:
• Select alarm to define the event as a BACnet alarm and
to display the event in Alarm View.
• Select event to define the event as a BACnet event and to
display the event in Event View.
Event enable Select the flags to enable the reporting of to-off-normal and
to-normal events. to-fault reporting is not supported by
Building Operation BACnet devices.
Upper limit Enter a limit that Value is required to exceed before a to-off-
normal event is generated.
Continued on next page
Technical 04-16006-04-en, March 2015
2720
76 BACnet Objects and Properties
76.18 Configuring a BACnet Analog Input Point (Generic)
Continued
Property Description
Lower limit Enter a limit that Value is required to fall below before a to-off-
normal event is generated.
The system generates a to-off-normal event based on Value
and the boundaries defined by the Upper Limit, Lower limit, and
Deadband. For example, if you enter 5 seconds and the Value
remains outside the Upper limit and Lower limit boundaries for a
minimum of 5 seconds, the system generates a to-off-normal
event.
Deadband Enter a range that is an offset from the low-level and high-level
limits, which defines the range where a to-normal event can be
generated. To generate a to-normal event, the value must be
above the low limit and below the high limit, minus the
deadband. For generic objects, this property is present only in
analog objects from external devices that support intrinsic
reporting.
Limit enable Select Low limit enable to enable the reporting of Lower
limit off-normal events and to-normal events. Select High
limit enable to enable the reporting of Upper limit off-normal
events and to-normal events.
Alarm message Enter the text that you want to display in the Alarm View for the
corresponding alarm state. The configured text is also sent to
Reset message any external BACnet clients configured as alarm recipients in
Fault message the BACnet notification.
For more information, see the Alarms Pane and Alarm View
topic on WebHelp.
Tip
Message text received from an external device displays in the Alarm
text field instead of the configured text.
13. Click OK.
04-16006-04-en, March 2015 Technical
2721
76 BACnet Objects and Properties
76.19 Configuring a BACnet Digital Input Point (Generic)
76.19 Configuring a BACnet Digital Input
Point (Generic)
You configure a BACnet digital input (generic) to configure the properties of a digital
input point in a BACnet device. You can also configure an intrinsic alarm for the
point.
To configure a BACnet digital input point (generic)
1. In WorkStation, in the System Tree, expand BACnet Interface, and then
expand the appropriate network.
2. Expand the device where the digital input point (generic) resides and select
Application.
3. In List View, select the digital input point (generic) that you want to configure.
4. On the File menu, click Properties.
5. Click the Basic tab.
6. Click the Configure button for the Value property.
7. Edit the properties.
Property Description
Type Displays the object type. Read-only
Unit Select the Unit check box and enter the unit that matches the
unit of the point on the Automation Server IO module. For more
information, see the Units topic on WebHelp.
Init value Displays the initial value, if defined. Read-only.
Reference Enter the Value property of the point that you want to reference.
Forceable Select to make the value forcible. For more information, see the
Forced Values topic on WebHelp.
Retain level Select how to handle values for warm start, cold start, system
events, and system activities. For more information, see the
Retain Level topic on WebHelp.
Technical 04-16006-04-en, March 2015
2722
76 BACnet Objects and Properties
76.19 Configuring a BACnet Digital Input Point (Generic)
8. Click OK to return to the Basic tab.
Continued on next page
04-16006-04-en, March 2015 Technical
2723
76 BACnet Objects and Properties
76.19 Configuring a BACnet Digital Input Point (Generic)
9. Edit the properties.
Property Description
Value Displays an orange button if the Associated value is not
configured. When configured, displays the current value for
the point under the following conditions:
• Unforce. Displays a forced value. Enter a forced value
or click to release the value.
• Force. Displays a non-forced value. Click to force the
value.
For all BACnet inputs, a Forced condition is the same as out
of service. For more information, see the Forced Values topic
on WebHelp.
For BACnet outputs and values, which are commandable, a
Forced status may also include a priority level setting. For
more information, see section 77.7 “Forced Priority Level” on
page 2857.
Status flags Displays the condition or status of the BACnet point. For
more information, see section 76.9 “BACnet Status Flags” on
page 2673.
Out of service Set to True to decouple the Value from the associated
property. If the associated property is not configured, this
property is True and cannot be changed.
Reliability Displays the reliability of the point.
Event state Displays Off Normal when intrinsic alarming has been
configured and the point is in an alarm state.
Alarm state Displays a Building Operation alarm state that provides
additional information about an intrinsic alarm or algorithmic
alarm configured for an object. For more information, see the
Alarm States topic on WebHelp.
Change of state Displays the reliability of the point.
time
Change of state Displays how often the Value property has changed state
count since the Change of state count was last set to 0. The
Change of state count increments when the Value
property has a change of state based on an event that alters
the Value property.
Enter 0 if you want to reset the Change of state count.
Time of state count Displays the date and time when the Change of state
reset count was last set to 0.
Elapsed active time Displays the number of seconds that the Value property
was Active since the Elapsed active time was last set to
0.
Enter 0 if you want to reset the Elapsed active time.
Time of active time Displays the date and time when Elapsed active time was
reset last set to 0.
Continued on next page
Technical 04-16006-04-en, March 2015
2724
76 BACnet Objects and Properties
76.19 Configuring a BACnet Digital Input Point (Generic)
Continued
Property Description
Polarity Select Normal or Reverse to control the relationship
between the physical state of the point and the Value
property. When Out of service is set to False, the
Polarity property causes a change to the Value property.
Inactive text Type the text that explains the Inactive state of the value,
such as Pump_Basement_Off. This text is used as an
enumeration text for the Value property and related priority
array values. It is visible in graphics, in the Watch pane, and
in the Properties pane.
If you leave this box empty, the default (Inactive) is used
instead.
Active text Type the text that explains the Active state of the value, such
as Pump_Basement_On. This text is used as an enumeration
text for the Value property and related priority array values. It
is visible in graphics, in the Watch pane, and in the Properties
pane.
If you leave this box empty, the default (Active) is used
instead.
Device type Type a description of the device that is either connected to or
represented by the object. For example, the text could
describe the type of sensor connected to an analog input or
the type of sensor represented by an accumulator.
10. Click OK.
Continued on next page
04-16006-04-en, March 2015 Technical
2725
76 BACnet Objects and Properties
76.19 Configuring a BACnet Digital Input Point (Generic)
11. Click the Advanced tab.
Continued on next page
Technical 04-16006-04-en, March 2015
2726
76 BACnet Objects and Properties
76.19 Configuring a BACnet Digital Input Point (Generic)
12. Edit the properties.
Property Description
Object ID Displays the BACnet object type and instance number of the
device.
BACnet name View the name of the BACnet object or type a new name to
change the name.
BACnet type Displays the type, which is always device.
Profile name Displays the unique name of the profile that describes additional
characteristics of the object, such as additional properties,
behaviors, or requirements.
Acknowledged Displays whether acknowledgements for to-off-normal, to-
transitions fault, or to-normal transitions have been received.
To-off-normal Displays the date and time of the last to-off-normal transition.
time
To-fault time Displays the date and time of the last to-fault transition.
To-normal time Displays the date and time of the last to-normal transition.
Time delay Enter the minimum number of seconds required before a to-off-
normal event, or to-normal event is generated.
BACnet Choose the method for referencing the intrinsic alarm object
notification that you want to use to generate event notifications:
• Select System reference to define a path-based
reference to an object or property that is currently located
on the server. When selected, only the Path field becomes
editable. All the other fields become non-editable.
• Select BACnet reference to define a reference that
uses the elements of a property value (Device instance
number, Object type, or Object instance number) to
identify a BACnet object or property that is not currently on
the server but may be uploaded or imported to the server
later. You can also use this method to reference a BACnet
object or property on an external device.
For more information, see section 73.7 “BACnet References
and System References” on page 2562.
Alarm handling Select the data source for alarm handling and presentation
and presentation information. The alarm presentation settings display as three
tabs (User Action, Attachment, and Presentation) on the alarm
sources (value) as well as in the notification class. For more
information, see section 79.6 “BACnet Alarms” on page 2898.
Notify type Select the type of BACnet event notification to be generated:
• Select alarm to define the event as a BACnet alarm and
to display the event in Alarm View.
• Select event to define the event as a BACnet event and to
display the event in Event View.
Event enable Select the flags to enable the reporting of to-off-normal and
to-normal events. to-fault reporting is not supported by
Continued on next page
04-16006-04-en, March 2015 Technical
2727
76 BACnet Objects and Properties
76.19 Configuring a BACnet Digital Input Point (Generic)
Continued
Property Description
Building Operation BACnet devices.
Alarm value Select the state that Value requires before an off-normal event
is triggered.
Alarm message Enter the text that you want to display in the Alarm View for the
corresponding alarm state. The configured text is also sent to
Reset message any external BACnet clients configured as alarm recipients in
Fault message the BACnet notification.
For more information, see the Alarms Pane and Alarm View
topic on WebHelp.
Tip
Message text received from the external device displays in the Alarm
text field instead of the configured text.
13. Click OK.
Technical 04-16006-04-en, March 2015
2728
76 BACnet Objects and Properties
76.20 Configuring a BACnet Multistate Input Point (Generic)
76.20 Configuring a BACnet Multistate Input
Point (Generic)
You configure a BACnet multistate input (generic) to configure the properties of a
multistate input point in an external BACnet device. You can also configure an
intrinsic alarm for the point if supported by the device.
To configure a BACnet multistate input point (generic)
1. In WorkStation, in the System Tree, expand BACnet Interface, and then
expand the appropriate network.
2. Expand the device where the multistate input point (generic) resides and select
Application.
3. In List View, select the multistate input point (generic) that you want to
configure.
4. On the File menu, click Open.
5. Click the State Configuration tab.
6. In the Number of states box, enter the number of states that you want to
create, for example, enter 3 if you want to create 3 states.
Use the up arrow to enter the number.
7. In the Label column, click the text and then type a description for the state
number, such as Unoccupied, Standby, or Warmup.
Repeat this step for each state that you created.
8. Click the Save button .
9. Click the Properties tab and then click the Basic tab.
10. Click the Configure button for the Out of service property.
Continued on next page
04-16006-04-en, March 2015 Technical
2729
76 BACnet Objects and Properties
76.20 Configuring a BACnet Multistate Input Point (Generic)
11. Edit the properties.
Property Description
Type Displays the object type. Read-only
Unit Select the Unit check box and enter the unit that matches the
unit of the point on the Automation Server IO module. For more
information, see the Units topic on WebHelp.
Init value Displays the initial value, if defined. Read-only.
Reference Enter the Value property of the point that you want to reference.
Forceable Select to make the value forcible. For more information, see the
Forced Values topic on WebHelp.
Retain level Select how to handle values for warm start, cold start, system
events, and system activities. For more information, see the
Retain Level topic on WebHelp.
12. Click OK to return to the Basic tab.
Continued on next page
Technical 04-16006-04-en, March 2015
2730
76 BACnet Objects and Properties
76.20 Configuring a BACnet Multistate Input Point (Generic)
13. Edit the properties.
Property Description
Value Displays an orange button if the Associated value is not
configured. When configured, displays the current value for
the point under the following conditions:
• Unforce. Displays a forced value. Enter a forced value
or click to release the value.
• Force. Displays a non-forced value. Click to force the
value.
For all BACnet inputs, a Forced condition is the same as out
of service. For more information, see the Forced Values topic
on WebHelp.
For BACnet outputs and values, which are commandable, a
Forced status may also include a priority level setting. For
more information, see section 77.7 “Forced Priority Level” on
page 2857.
Status flags Displays the condition or status of the BACnet point. For
more information, see section 76.9 “BACnet Status Flags” on
page 2673.
Out of service Set to True to decouple the Value from the associated
property. If the associated property is not configured, this
property is True and cannot be changed.
Event state Displays Off Normal when intrinsic alarming has been
configured and the point is in an alarm state.
Alarm state Displays a Building Operation alarm state that provides
additional information about an intrinsic alarm or algorithmic
alarm configured for an object. For more information, see the
Alarm States topic on WebHelp.
Device type Type a description of the device that is either connected to or
represented by the object. For example, the text could
describe the type of sensor connected to an analog input or
the type of sensor represented by an accumulator.
14. Click the Save button .
Continued on next page
04-16006-04-en, March 2015 Technical
2731
76 BACnet Objects and Properties
76.20 Configuring a BACnet Multistate Input Point (Generic)
15. Click the Advanced tab.
Continued on next page
Technical 04-16006-04-en, March 2015
2732
76 BACnet Objects and Properties
76.20 Configuring a BACnet Multistate Input Point (Generic)
16. Edit the properties.
Property Description
Object ID Displays the BACnet object type and instance number of the
device.
BACnet name View the name of the BACnet object or type a new name to
change the name.
BACnet type Displays the type, which is always device.
Profile name Displays the unique name of the profile that describes additional
characteristics of the object, such as additional properties,
behaviors, or requirements.
Acknowledged Displays whether acknowledgements for to-off-normal, to-
transitions fault, or to-normal transitions have been received.
To-off-normal Displays the date and time of the last to-off-normal transition.
time
To-fault time Displays the date and time of the last to-fault transition.
To-normal time Displays the date and time of the last to-normal transition.
Time delay Enter the minimum number of seconds required before a to-off-
normal event, or to-normal event is generated.
BACnet Choose the method for referencing the intrinsic alarm object
notification that you want to use to generate event notifications:
• Select System reference to define a path-based
reference to an object or property that is currently located
on the server. When selected, only the Path field becomes
editable. All the other fields become non-editable.
• Select BACnet reference to define a reference that
uses the elements of a property value (Device instance
number, Object type, or Object instance number) to
identify a BACnet object or property that is not currently on
the server but may be uploaded or imported to the server
later. You can also use this method to reference a BACnet
object or property on an external device.
For more information, see section 73.7 “BACnet References
and System References” on page 2562.
Notify type Select the type of BACnet event notification to be generated:
• Select alarm to define the event as a BACnet alarm and
to display the event in Alarm View.
• Select event to define the event as a BACnet event and to
display the event in Event View.
Event enable Select the flags to enable the reporting of to-off-normal and
to-normal events. to-fault reporting is not supported by
Building Operation BACnet devices.
State Id Enter the State Id for which you want to set an alarm or fault
alarm.
Continued on next page
04-16006-04-en, March 2015 Technical
2733
76 BACnet Objects and Properties
76.20 Configuring a BACnet Multistate Input Point (Generic)
Continued
Property Description
Is alarm value Select Yes or No to assign an alarm to the State Id. If you
select Yes, select No for Is fault value.
Is fault value Select Yes or No to assign a fault alarm to the State Id. If you
select Yes, select No for Is alarm value.
Click to add an alarm or fault State Id to the list of alarm and
fault values.
Click to open the Properties dialog box where you can edit
the alarm or fault configuration for a selected State Id. For
more information, see section 81.62 “BACnet Multistate Alarm
Properties Dialog Box” on page 3069.
Click to remove the State Id from the list of alarm or fault
values.
Alarm message Enter the text that you want to display in the Alarm View for the
corresponding alarm state. The configured text is also sent to
Reset message any external BACnet clients configured as alarm recipients in
Fault message the BACnet notification.
For more information, see the Alarms Pane and Alarm View
topic on WebHelp.
Tip
Message text received from the external device displays in the Alarm
text field instead of the configured text.
17. Click to create a multistate alarm.
18. Type a name for the alarm and click Create.
19. Repeat the process until you have the desired number of alarms.
Continued on next page
Technical 04-16006-04-en, March 2015
2734
76 BACnet Objects and Properties
76.20 Configuring a BACnet Multistate Input Point (Generic)
20. Select an alarm from the list and click to modify an alarm.
21. Edit the properties.
Property Description
State Id Enter the state that you want to configure for the multistate
point or value.
Is alarm value Select Yes to assign an alarm to the State Id. Then, select No
for Is fault value.
Is fault value Select Yes to assign a fault alarm to the State Id. Then, select
No for Is alarm value.
22. Click OK to return to the Advanced tab.
23. Repeat the steps to modify another alarm.
24. Click the Save button .
04-16006-04-en, March 2015 Technical
2735
76 BACnet Objects and Properties
76.21 Configuring a BACnet Analog Output Point (Generic)
76.21 Configuring a BACnet Analog Output
Point (Generic)
You configure a BACnet analog output (generic) to configure the properties of an
analog output point in an external BACnet device. You can also configure an
intrinsic alarm for the point if supported by the device.
To configure a BACnet analog output point (generic)
1. In WorkStation, in the System Tree, expand BACnet Interface, and then
expand the appropriate network.
2. Expand the external device where the analog output point resides and select
Application.
3. In List View, select the analog output point (generic) that you want to
configure.
4. On the File menu, click Properties.
5. Click the Basic tab.
6. Under Status Information, click the Configure button for the Value
property.
7. Edit the properties.
Property Description
Type Displays the object type. Read-only
Unit Select the Unit check box and enter the unit that matches the
unit of the point on the Automation Server IO module. For more
information, see the Units topic on WebHelp.
Init value Displays the initial value, if defined. Read-only.
Reference Enter the Value property of the point that you want to reference.
Forceable Select to make the value forcible. For more information, see the
Forced Values topic on WebHelp.
Retain level Select how to handle values for warm start, cold start, system
events, and system activities. For more information, see the
Retain Level topic on WebHelp.
Technical 04-16006-04-en, March 2015
2736
76 BACnet Objects and Properties
76.21 Configuring a BACnet Analog Output Point (Generic)
8. Click OK to return to the Basic tab.
Continued on next page
04-16006-04-en, March 2015 Technical
2737
76 BACnet Objects and Properties
76.21 Configuring a BACnet Analog Output Point (Generic)
9. Edit the properties.
Property Description
Value Displays an orange button if the Associated value is not
configured. When configured, displays the current value for the
point under the following conditions:
• Unforce. Displays a forced value. Enter a forced value or
click to release the value.
• Force. Displays a non-forced value. Click to force the
value.
For all BACnet inputs, a Forced condition is the same as out of
service. For more information, see the Forced Values topic on
WebHelp.
For BACnet outputs and values, which are commandable, a
Forced status may also include a priority level setting. For more
information, see section 77.7 “Forced Priority Level” on page
2857.
Status flags Displays the condition or status of the BACnet point. For more
information, see section 76.9 “BACnet Status Flags” on page
2673.
Out of service Select True to disassociate the Value from the physical output.
Out of service is primarily used for testing purposes.
Event state Displays one of the following active event states associated with
the point:
• Normal when the point is not in an alarm state.
• Off Normal when the Intrinsic Alarm is configured and the
point is in an alarm state.
Alarm state Displays a Building Operation alarm state that provides
additional information about an intrinsic alarm or algorithmic
alarm configured for an object. For more information, see the
Alarm States topic on WebHelp.
Reliability Displays the reliability of the point.
COV increment Enter the minimum change in the Value property that causes a
COV notification to be sent. The default COV increment is .10.
Minimum value Enter the lowest value that can be reliably used for the Value
property.
Maximum value Enter the highest value that can be reliably used for the Value
property.
Resolution Displays the smallest recognizable change in the Value
property.
Device type Type a description of the device that is either connected to or
represented by the object. For example, the text could describe
the type of sensor connected to an analog input or the type of
sensor represented by an accumulator.
Technical 04-16006-04-en, March 2015
2738
76 BACnet Objects and Properties
76.21 Configuring a BACnet Analog Output Point (Generic)
10. Click OK.
11. Click the Advanced tab.
Continued on next page
04-16006-04-en, March 2015 Technical
2739
76 BACnet Objects and Properties
76.21 Configuring a BACnet Analog Output Point (Generic)
12. Edit the properties.
Property Description
Object ID Displays the BACnet object type and instance number of the
device.
BACnet name View the name of the BACnet object or type a new name to
change the name.
BACnet type Displays the type, which is always device.
Profile name Displays the unique name of the profile that describes additional
characteristics of the object, such as additional properties,
behaviors, or requirements.
Acknowledged Displays whether acknowledgements for to-off-normal, to-
transitions fault, or to-normal transitions have been received.
To-off-normal Displays the BACnet timestamp of the last to-off-normal
time transition.
To-fault time Displays the BACnet timestamp of the last to-fault transition.
To-normal time Displays the BACnet timestamp of the last to-normal
transition.
Time delay (s) Select the minimum number of seconds required before a to-
off-normal event, or to-normal event is generated.
BACnet Choose the method for referencing the intrinsic alarm object
notification that you want to use to generate event notifications:
• Select System reference to define a path-based
reference to an object or property that is currently located
on the server. When selected, only the Path field becomes
editable. All the other fields become non-editable.
• Select BACnet reference to define a reference that
uses the elements of a property value (Device instance
number, Object type, or Object instance number) to
identify a BACnet object or property that is not currently on
the server but may be uploaded or imported to the server
later. You can also use this method to reference a BACnet
object or property on an external device.
For more information, see section 73.7 “BACnet References
and System References” on page 2562.
Notify type Select whether you want to report the event as an alarm or
event in WorkStation.
Event enable Select the flags to enable the reporting of to-off-normal, to-
fault, and to-normal events.
Upper limit Enter a limit that Value is required to exceed before an event is
generated.
Lower limit Enter a limit that Value is required to fall below before an event
is generated.
Deadband Enter the deadband which is the range the value must stay
within before a to-normal event is generated.
Continued on next page
Technical 04-16006-04-en, March 2015
2740
76 BACnet Objects and Properties
76.21 Configuring a BACnet Analog Output Point (Generic)
Continued
Property Description
Limit enable Select one or more flags to enable the reporting of off-normal
events and the return to to-normal events based on the lower
limit value or upper limit value.
Alarm message Enter the text that you want to display in the Alarm text field in
the Alarm View for the corresponding alarm state.
Reset message If a message text is received from the external device, that text
is displayed in the Alarm text field instead of the configured text.
Fault message
Tip
Message text received from the external device displays in the Alarm
text field instead of the configured text.
13. Click OK.
14. Click the Command tab.
Continued on next page
04-16006-04-en, March 2015 Technical
2741
76 BACnet Objects and Properties
76.21 Configuring a BACnet Analog Output Point (Generic)
15. Edit the properties.
Property Description
Relinquish Enter the value to be used by the Value property when all values
default in the priority array are set to Null.
Active command Specifies the priority level (1-16) currently controlling the present
priority value. The present value is the highest priority with a non-Null
value.
Priority 6 This priority is reserved for timer-based algorithms that are not
currently supported. (Read-only)
Priority x Enter a priority value or Null.
16. Click OK.
Technical 04-16006-04-en, March 2015
2742
76 BACnet Objects and Properties
76.22 Configuring a BACnet Digital Output Point (Generic)
76.22 Configuring a BACnet Digital Output
Point (Generic)
You configure the properties of a generic BACnet digital output in an external
BACnet device. You can also configure an intrinsic alarm for the point if supported
by the device.
To configure a BACnet digital output point (generic)
1. In WorkStation, in the System Tree, expand BACnet Interface, and then
expand the appropriate network.
2. Expand the external device where the digital output point resides and select
Application.
3. In List View, select the digital output point (generic) that you want to
configure.
4. On the File menu, click Properties.
Continued on next page
04-16006-04-en, March 2015 Technical
2743
76 BACnet Objects and Properties
76.22 Configuring a BACnet Digital Output Point (Generic)
5. Click the Basic tab.
Continued on next page
Technical 04-16006-04-en, March 2015
2744
76 BACnet Objects and Properties
76.22 Configuring a BACnet Digital Output Point (Generic)
6. Edit the properties.
Property Description
Value Displays an orange button if the Associated value is not
configured. When configured, displays the current value for
the point under the following conditions:
• Unforce. Displays a forced value. Enter a forced value
or click to release the value.
• Force. Displays a non-forced value. Click to force the
value.
For all BACnet inputs, a Forced condition is the same as out
of service. For more information, see the Forced Values topic
on WebHelp.
For BACnet outputs and values, which are commandable, a
Forced status may also include a priority level setting. For
more information, see section 77.7 “Forced Priority Level” on
page 2857.
Status flags Displays the condition or status of the BACnet point. For
more information, see section 76.9 “BACnet Status Flags” on
page 2673.
Out of service Set to True to decouple the Value from the associated
property. If the associated property is not configured, this
property is True and cannot be changed.
Reliability Displays the reliability of the point.
Event state Displays Off Normal when intrinsic alarming has been
configured and the point is in an alarm state.
Alarm state Displays a Building Operation alarm state that provides
additional information about an intrinsic alarm or algorithmic
alarm configured for an object. For more information, see the
Alarm States topic on WebHelp.
Change of state Displays the reliability of the point.
time
Change of state Displays how often the Value property has changed state
count since the Change of state count was last set to 0. The
Change of state count increments when the Value
property has a change of state based on an event that alters
the Value property.
Enter 0 if you want to reset the Change of state count.
Time of state count Displays the date and time when the Change of state
reset count was last set to 0.
Elapsed active time Displays the number of seconds that the Value property
was Active since the Elapsed active time was last set to
0.
Enter 0 if you want to reset the Elapsed active time.
Time of active time Displays the date and time when Elapsed active time was
reset last set to 0.
Continued on next page
04-16006-04-en, March 2015 Technical
2745
76 BACnet Objects and Properties
76.22 Configuring a BACnet Digital Output Point (Generic)
Continued
Property Description
Polarity Select Normal or Reverse to control the relationship
between the physical state of the point and the Value
property. When Out of service is set to False, the
Polarity property causes a change to the Value property.
Inactive text Type the text that explains the Inactive state of the value,
such as Pump_Basement_Off. This text is used as an
enumeration text for the Value property and related priority
array values. It is visible in graphics, in the Watch pane, and
in the Properties pane.
If you leave this box empty, the default (Inactive) is used
instead.
Active text Type the text that explains the Active state of the value, such
as Pump_Basement_On. This text is used as an enumeration
text for the Value property and related priority array values. It
is visible in graphics, in the Watch pane, and in the Properties
pane.
If you leave this box empty, the default (Active) is used
instead.
Device type Type a description of the device that is either connected to or
represented by the object. For example, the text could
describe the type of sensor connected to an analog input or
the type of sensor represented by an accumulator.
Minimum off time Enter the minimum number of seconds that you want the
Value property to remain Inactive following a write to the
Value property that causes the Inactive state.
Minimum on time Enter the minimum number of seconds that you want the
Value property to remain Active following a write to the
Value property that causes the Active state.
7. Click OK.
Continued on next page
Technical 04-16006-04-en, March 2015
2746
76 BACnet Objects and Properties
76.22 Configuring a BACnet Digital Output Point (Generic)
8. Click the Advanced tab.
Continued on next page
04-16006-04-en, March 2015 Technical
2747
76 BACnet Objects and Properties
76.22 Configuring a BACnet Digital Output Point (Generic)
9. Edit the properties.
Property Description
Object ID Displays the BACnet object type and instance number of the
device.
BACnet name View the name of the BACnet object or type a new name to
change the name.
BACnet type Displays the type, which is always device.
Profile name Displays the unique name of the profile that describes additional
characteristics of the object, such as additional properties,
behaviors, or requirements.
Acknowledged Displays whether acknowledgements for to-off-normal, to-
transitions fault, or to-normal transitions have been received.
To-off-normal Displays the date and time of the last to-off-normal transition.
time
To-fault time Displays the date and time of the last to-fault transition.
To-normal time Displays the date and time of the last to-normal transition.
Time delay Enter the minimum number of seconds required before a to-off-
normal event, or to-normal event is generated.
BACnet Choose the method for referencing the intrinsic alarm object
notification that you want to use to generate event notifications:
• Select System reference to define a path-based
reference to an object or property that is currently located
on the server. When selected, only the Path field becomes
editable. All the other fields become non-editable.
• Select BACnet reference to define a reference that
uses the elements of a property value (Device instance
number, Object type, or Object instance number) to
identify a BACnet object or property that is not currently on
the server but may be uploaded or imported to the server
later. You can also use this method to reference a BACnet
object or property on an external device.
For more information, see section 73.7 “BACnet References
and System References” on page 2562.
Notify type Select the type of BACnet event notification to be generated:
• Select alarm to define the event as a BACnet alarm and
to display the event in Alarm View.
• Select event to define the event as a BACnet event and to
display the event in Event View.
Event enable Select the flags to enable the reporting of to-off-normal and
to-normal events. to-fault reporting is not supported by
Building Operation BACnet devices.
Feedback value Displays the state that is required to be different from the Value
property before a to-off-normal event is generated. You can
view this state in the Alarms pane or an alarm view.
Continued on next page
Technical 04-16006-04-en, March 2015
2748
76 BACnet Objects and Properties
76.22 Configuring a BACnet Digital Output Point (Generic)
Continued
Property Description
For more information, see the Add/Remove Columns Dialog
Box (Alarms) topic on WebHelp.
Alarm message Enter the text that you want to display in the Alarm View for the
corresponding alarm state. The configured text is also sent to
Reset message any external BACnet clients configured as alarm recipients in
Fault message the BACnet notification.
For more information, see the Alarms Pane and Alarm View
topic on WebHelp.
Tip
Message text received from the external device displays in the Alarm
text field instead of the configured text.
10. Click OK.
11. Click the Command tab.
Continued on next page
04-16006-04-en, March 2015 Technical
2749
76 BACnet Objects and Properties
76.22 Configuring a BACnet Digital Output Point (Generic)
12. Edit the properties.
Property Description
Relinquish Enter the value to be used by the Value property when all values in
default the priority array are set to Null.
Active Specifies the priority level (1-16) currently controlling the present
command value. The present value is the highest priority with a non-Null value.
priority
Priority 6 This priority is reserved for timer-based algorithms that are not
currently supported. (Read-only)
Priority x Enter a priority value or Null.
13. Click OK.
Technical 04-16006-04-en, March 2015
2750
76 BACnet Objects and Properties
76.23 Configuring a BACnet Multistate Output Point (Generic)
76.23 Configuring a BACnet Multistate Output
Point (Generic)
You configure a generic BACnet multistate output point in an external BACnet
device. You can also configure an intrinsic alarm for the point if supported by the
device.
To configure a BACnet multistate output point (generic)
1. In WorkStation, in the System Tree, expand BACnet Interface, and then
expand the appropriate network.
2. Expand the external device where the multistate output point resides and
select Application.
3. In List View, select the multistate output point (generic) that you want to
configure.
4. On the File menu, click Open.
5. Click the State Configuration tab.
6. In the Number of states box, enter the number of states that you want to
create, for example, enter 3 if you want to create 3 states. Use the up arrow to
enter the number.
7. In the Label column, click the text and then type a description for the state
number, such as Unoccupied, Standby, or Warmup.
Repeat this step for each state that you created.
8. Click the Save button .
9. Click the Properties tab.
Continued on next page
04-16006-04-en, March 2015 Technical
2751
76 BACnet Objects and Properties
76.23 Configuring a BACnet Multistate Output Point (Generic)
10. Click the Basic tab.
Continued on next page
Technical 04-16006-04-en, March 2015
2752
76 BACnet Objects and Properties
76.23 Configuring a BACnet Multistate Output Point (Generic)
11. Edit the properties.
Property Description
Value Displays an orange button if the Associated value is not
configured. When configured, displays the current value for
the point under the following conditions:
• Unforce. Displays a forced value. Enter a forced value
or click to release the value.
• Force. Displays a non-forced value. Click to force the
value.
For all BACnet inputs, a Forced condition is the same as out
of service. For more information, see the Forced Values topic
on WebHelp.
For BACnet outputs and values, which are commandable, a
Forced status may also include a priority level setting. For
more information, see section 77.7 “Forced Priority Level” on
page 2857.
Status flags Displays the condition or status of the BACnet point. For
more information, see section 76.9 “BACnet Status Flags” on
page 2673.
Out of service Set to True to decouple the Value from the associated
property. If the associated property is not configured, this
property is True and cannot be changed.
Event state Displays Off Normal when intrinsic alarming has been
configured and the point is in an alarm state.
Alarm state Displays a Building Operation alarm state that provides
additional information about an intrinsic alarm or algorithmic
alarm configured for an object. For more information, see the
Alarm States topic on WebHelp.
Device type Type a description of the device that is either connected to or
represented by the object. For example, the text could
describe the type of sensor connected to an analog input or
the type of sensor represented by an accumulator.
12. Click the Save button .
Continued on next page
04-16006-04-en, March 2015 Technical
2753
76 BACnet Objects and Properties
76.23 Configuring a BACnet Multistate Output Point (Generic)
13. Click the Advanced tab.
Continued on next page
Technical 04-16006-04-en, March 2015
2754
76 BACnet Objects and Properties
76.23 Configuring a BACnet Multistate Output Point (Generic)
14. Edit the properties.
Property Description
Object ID Displays the BACnet object type and instance number of the
device.
BACnet name View the name of the BACnet object or type a new name to
change the name.
BACnet type Displays the type, which is always device.
Profile name Displays the unique name of the profile that describes additional
characteristics of the object, such as additional properties,
behaviors, or requirements.
Acknowledged Displays whether acknowledgements for to-off-normal, to-
transitions fault, or to-normal transitions have been received.
To-off-normal Displays the date and time of the last to-off-normal transition.
time
To-fault time Displays the date and time of the last to-fault transition.
To-normal time Displays the date and time of the last to-normal transition.
Time delay Enter the minimum number of seconds required before a to-off-
normal event, or to-normal event is generated.
BACnet Choose the method for referencing the intrinsic alarm object
notification that you want to use to generate event notifications:
• Select System reference to define a path-based
reference to an object or property that is currently located
on the server. When selected, only the Path field becomes
editable. All the other fields become non-editable.
• Select BACnet reference to define a reference that
uses the elements of a property value (Device instance
number, Object type, or Object instance number) to
identify a BACnet object or property that is not currently on
the server but may be uploaded or imported to the server
later. You can also use this method to reference a BACnet
object or property on an external device.
For more information, see section 73.7 “BACnet References
and System References” on page 2562.
Notify type Select the type of BACnet event notification to be generated:
• Select alarm to define the event as a BACnet alarm and
to display the event in Alarm View.
• Select event to define the event as a BACnet event and to
display the event in Event View.
Event enable Select the flags to enable the reporting of to-off-normal and
to-normal events. to-fault reporting is not supported by
Building Operation BACnet devices.
Feedback value Displays the state that is required to be different from the Value
property before a to-off-normal event is generated. You can
view this state in the Alarms pane or an alarm view.
Continued on next page
04-16006-04-en, March 2015 Technical
2755
76 BACnet Objects and Properties
76.23 Configuring a BACnet Multistate Output Point (Generic)
Continued
Property Description
For more information, see the Add/Remove Columns Dialog
Box (Alarms) topic on WebHelp.
Alarm message Enter the text that you want to display in the Alarm View for the
corresponding alarm state. The configured text is also sent to
Reset message any external BACnet clients configured as alarm recipients in
Fault message the BACnet notification.
For more information, see the Alarms Pane and Alarm View
topic on WebHelp.
Tip
Message text received from the external device displays in the Alarm
text field instead of the configured text.
15. Click the Save button .
16. Click the Command tab.
Continued on next page
Technical 04-16006-04-en, March 2015
2756
76 BACnet Objects and Properties
76.23 Configuring a BACnet Multistate Output Point (Generic)
17. Edit the properties.
Property Description
Relinquish Enter the value to be used by the Value property when all values in
default the priority array are set to Null.
Active Specifies the priority level (1-16) currently controlling the present
command value. The present value is the highest priority with a non-Null value.
priority
Priority 6 This priority is reserved for timer-based algorithms that are not
currently supported. (Read-only)
Priority x Enter a priority value or Null.
18. Click the Save button .
04-16006-04-en, March 2015 Technical
2757
76 BACnet Objects and Properties
76.24 Creating a BACnet Value
76.24 Creating a BACnet Value
You create a BACnet analog, digital, or multistate value in a local server so you can
then configure a control system parameter for the server. The server can be an
Automation Server or an Enterprise Server. The BACnet values that you create are
visible to other workstations and devices in the BACnet internetwork. You create
BACnet values for a server in the Application folder of the server's BACnet Interface.
For more information, see section 76.1 “BACnet Objects and Properties” on page
2663.
To create a BACnet value
1. In WorkStation, in the System Tree, expand the BACnet Interface and then
select Application.
2. On the File menu, point to New and then click Value.
3. In the object type list, select the type of BACnet value that you want to create.
Do not select String Value or Time Stamp Value, which are not BACnet
object types.
4. In the Name box, type a name for the value.
5. In the Description box, type a description for the value.
6. Click Next.
Continued on next page
Technical 04-16006-04-en, March 2015
2758
76 BACnet Objects and Properties
76.24 Creating a BACnet Value
7. Under Instance ID, generate or enter a BACnet Instance ID:
• Click Automatically generated to have the server generate a BACnet
Instance ID for you.
• Click Manually entered to manually enter a BACnet Instance ID, and
then type an appropriate Instance ID for the BACnet object.
8. In the BACnet name box, type a BACnet name for the value. Do not type a
name if you want a name to be assigned for you.
9. In the Command priority retain level box, select one of the following
options to configure the warm start and cold start settings for a command
priority array:
• Warm start: The variable retains the last value set by a user or
application. However, the variable reverts to the default value for a cold
start.
• Cold start: The variable retains the last value set by a user or application
for a warm start or cold start.
• No: The variable reverts to the default value upon a restart.
10. Click Create.
04-16006-04-en, March 2015 Technical
2759
76 BACnet Objects and Properties
76.25 Configuring a BACnet Analog Value
76.25 Configuring a BACnet Analog Value
You configure a BACnet analog value to define a control system parameter for an
Automation Server or Enterprise Server. You can also create an intrinsic alarm for
the analog value and enter a value for the Relinquish default property.
To configure a BACnet analog value
1. In WorkStation, in the System Tree, expand the BACnet Interface and then
select Application.
2. In the List View, select the analog value that you want to configure.
3. On the File menu, click Properties.
4. Click the Basic tab.
5. For Value, click the Configure button .
Continued on next page
Technical 04-16006-04-en, March 2015
2760
76 BACnet Objects and Properties
76.25 Configuring a BACnet Analog Value
6. Select the Unit check box.
7. In the Unit box, enter the unit that matches the unit of the input and output
points on the Automation Server IO module.
8. Click OK to return to the Basic tab.
9. In the Value box, enter the value to be used as a control system parameter for
the device.
10. In the Out of service box, select False.
Continued on next page
04-16006-04-en, March 2015 Technical
2761
76 BACnet Objects and Properties
76.25 Configuring a BACnet Analog Value
11. In the COV increment box, enter the minimum change in the Value
property that causes a COV notification to be sent.
The default COV increment is 0.10.
Continued on next page
Technical 04-16006-04-en, March 2015
2762
76 BACnet Objects and Properties
76.25 Configuring a BACnet Analog Value
12. Click the Advanced tab.
13. Under Intrinsic Alarm Configuration, in the Time delay (s) box, enter
the minimum number of seconds that the value is inside or outside the
specified limits before a to-off-normal event, or to-normal event is
generated.
14. In the BACnet notification box, select the type of BACnet notification for
generating event notifications for this object:
• Select System reference to define a path-based reference to an object
or property that is currently located on the server. When selected, only the
Path field becomes editable. All the other fields become non-editable.
• Select BACnet reference to define a reference that uses the elements
of a property value (Device instance number, Object type, or Object
instance number) to identify a BACnet object or property that is not
currently on the server but may be uploaded or imported to the server
later.
15. In the Alarm handling and presentation box, choose whether the alarm
presentation is determined by its BACnet notification object or the alarm
source itself (intrinsic). For more information, see section 79.6 “BACnet
Alarms” on page 2898.
Continued on next page
04-16006-04-en, March 2015 Technical
2763
76 BACnet Objects and Properties
76.25 Configuring a BACnet Analog Value
16. In the Notify type box, select the type of BACnet event notification to be
generated:
• Select alarm to define the event as a BACnet alarm.
• Select event to define the event as a BACnet event.
17. In the Event enable box, select the flags to enable the reporting of to-off-
normal and to-normal events. to-fault reporting is not supported by
BACnet devices.
18. In the Upper limit box, enter a limit that Value is required to exceed before a
to-off-normal event is generated.
19. In the Lower limit box, enter a limit that Value is required to fall below
before a to-off-normal event is generated.
20. In the Deadband box, enter a value to create a range between the Upper
limit and Lower limit values where the Value property is required to remain
before a to-normal event is generated.
21. In the Limit enable box, select one or both of the following options:
• Select Low limit enable to enable the reporting of Lower limit off-
normal events and to-normal events.
• Select High limit enable to enable the reporting of Upper limit off-
normal events and to-normal events.
22. In the Alarm message, Reset message and Fault message boxes, enter
the text that you want to display in the Alarm text field in the Alarm View for
the corresponding alarm state. The configured text is also sent to any external
BACnet clients configured as alarm recipients in the BACnet notification.
23. Click the Command tab.
24. In the Relinquish default box, enter the value to be used by the Value
property when all values in the priority array are set to Null.
25. In the Priority x box, set the value at a priority level, such as Active.
Priority 6 is reserved for timer-based algorithms that are not currently
supported. (Read only)
26. Click OK.
Technical 04-16006-04-en, March 2015
2764
76 BACnet Objects and Properties
76.26 Configuring a BACnet Digital Value
76.26 Configuring a BACnet Digital Value
You configure a BACnet digital value to define a control system parameter for an
Automation Server or an Enterprise Server. You can also configure an intrinsic alarm
for the point if supported by the device.
To configure a BACnet digital value
1. In WorkStation, in the System Tree, expand BACnet Interface and then
select Application.
2. In List View, select the digital value that you want to configure.
3. On the File menu, click Properties.
4. Click the Basic tab.
Continued on next page
04-16006-04-en, March 2015 Technical
2765
76 BACnet Objects and Properties
76.26 Configuring a BACnet Digital Value
5. Edit the properties.
Property Description
Value Enter the value to be used as the control system parameter under
the following conditions:
• Unforce. Displays a forced value. Enter a forced value or
click to release the value.
• Force. Displays a non-forced value. Click to force the value.
For all BACnet inputs, a Forced condition is the same as out of
service. For more information, see the Forced Values topic on
WebHelp.
For BACnet outputs and values, which are commandable, a
Forced status may also include a priority level setting. For more
information, see section 77.7 “Forced Priority Level” on page
2857.
Status flags Displays the condition or status of the BACnet value. For more
information, see section 76.9 “BACnet Status Flags” on page
2673.
Out of service Set to True to decouple the Value from the associated property.
If the associated property is not configured, this property is True
and cannot be changed.
Event state Displays Off Normal when intrinsic alarming has been
configured and the point is in an alarm state.
Inactive text Type the text that explains the Inactive state of the value, such as
Pump_Basement_Off. This text is used as an enumeration text
for the Value property and related priority array values. It is visible
in graphics, in the Watch pane, and in the Properties pane.
If you leave this box empty, the default (Inactive) is used instead.
Active text Type the text that explains the Active state of the value, such as
Pump_Basement_On. This text is used as an enumeration text
for the Value property and related priority array values. It is visible
in graphics, in the Watch pane, and in the Properties pane.
If you leave this box empty, the default (Active) is used instead.
6. Click OK.
Continued on next page
Technical 04-16006-04-en, March 2015
2766
76 BACnet Objects and Properties
76.26 Configuring a BACnet Digital Value
7. Click the Advanced tab.
Continued on next page
04-16006-04-en, March 2015 Technical
2767
76 BACnet Objects and Properties
76.26 Configuring a BACnet Digital Value
8. Edit the properties.
Property Description
Object ID Displays the BACnet object type and instance number of the
device.
BACnet name View the name of the BACnet object or type a new name to
change the name.
BACnet type Displays the type, which is always device.
Acknowledged Displays whether acknowledgements for to-off-normal, to-
transitions fault, or to-normal transitions have been received.
To-off-normal Displays the date and time of the last to-off-normal transition.
time
To-fault time Displays the date and time of the last to-fault transition.
To-normal time Displays the date and time of the last to-normal transition.
Time delay Enter the minimum number of seconds required before a to-off-
normal event, or to-normal event is generated.
BACnet Choose the method for referencing the intrinsic alarm object
notification that you want to use to generate event notifications:
• Select System reference to define a path-based
reference to an object or property that is currently located
on the server. When selected, only the Path field becomes
editable. All the other fields become non-editable.
• Select BACnet reference to define a reference that
uses the elements of a property value (Device instance
number, Object type, or Object instance number) to
identify a BACnet object or property that is not currently on
the server but may be uploaded or imported to the server
later. You can also use this method to reference a BACnet
object or property on an external device.
For more information, see section 73.7 “BACnet References
and System References” on page 2562.
Alarm handling Select the data source for alarm handling and presentation
and presentation information. The alarm presentation settings display as three
tabs (User Action, Attachment, and Presentation) on the alarm
sources (value) as well as in the notification class. For more
information, see section 79.6 “BACnet Alarms” on page 2898.
Notify type Select the type of BACnet event notification to be generated:
• Select alarm to define the event as a BACnet alarm and
to display the event in Alarm View.
• Select event to define the event as a BACnet event and to
display the event in Event View.
Event enable Select the flags to enable the reporting of to-off-normal and
to-normal events. to-fault reporting is not supported by
Building Operation BACnet devices.
Alarm value Select the state that Value requires before an off-normal event
is triggered.
Continued on next page
Technical 04-16006-04-en, March 2015
2768
76 BACnet Objects and Properties
76.26 Configuring a BACnet Digital Value
Continued
Property Description
Alarm message Enter the text that you want to display in the Alarm View for the
corresponding alarm state. The configured text is also sent to
Reset message any external BACnet clients configured as alarm recipients in
Fault message the BACnet notification.
For more information, see the Alarms Pane and Alarm View
topic on WebHelp.
9. Click OK.
10. Click the Command tab.
Continued on next page
04-16006-04-en, March 2015 Technical
2769
76 BACnet Objects and Properties
76.26 Configuring a BACnet Digital Value
11. Edit the properties.
Property Description
Relinquish Enter the value to be used by the Value property when all values in
default the priority array are set to Null.
Active Specifies the priority level (1-16) currently controlling the present
command value. The present value is the highest priority with a non-Null value.
priority
Priority 6 This priority is reserved for timer-based algorithms that are not
currently supported. (Read-only)
Priority x Enter a priority value or Null.
12. Click OK.
Technical 04-16006-04-en, March 2015
2770
76 BACnet Objects and Properties
76.27 Configuring a BACnet Multistate Value
76.27 Configuring a BACnet Multistate Value
You configure a BACnet multistate value to define a control system parameter for
an Automation Server or an Enterprise Server. You can also configure an intrinsic
alarm for the point if supported by the device.
To configure a BACnet multistate value
1. In WorkStation, in the System Tree, expand BACnet Interface and then
select Application.
2. In List View, select the multistate value that you want to configure.
3. On the File menu, click Open.
4. Click the State Configuration tab.
5. In the Number of states box, enter the number of states that you want to
create, for example, enter 3 if you want to create 3 states.
Use the up arrow to enter the number.
6. In the Label column, click the text and then type a description for the state
number, such as Unoccupied, Standby, or Warmup.
Repeat this step for each state that you created.
7. Click the Save button .
Continued on next page
04-16006-04-en, March 2015 Technical
2771
76 BACnet Objects and Properties
76.27 Configuring a BACnet Multistate Value
8. Click the Properties tab and then click the Basic tab.
Continued on next page
Technical 04-16006-04-en, March 2015
2772
76 BACnet Objects and Properties
76.27 Configuring a BACnet Multistate Value
9. Edit the properties.
Property Description
Value Enter the value to be used as the control system parameter under
the following conditions:
• Unforce. Displays a forced value. Enter a forced value or
click to release the value.
• Force. Displays a non-forced value. Click to force the value.
For all BACnet inputs, a Forced condition is the same as out of
service. For more information, see the Forced Values topic on
WebHelp.
For BACnet outputs and values, which are commandable, a
Forced status may also include a priority level setting. For more
information, see section 77.7 “Forced Priority Level” on page
2857.
Status flags Displays the condition or status of the BACnet value. For more
information, see section 76.9 “BACnet Status Flags” on page
2673.
Out of service Set to True to decouple the Value from the associated property.
If the associated property is not configured, this property is True
and cannot be changed.
Event state Displays Off Normal when intrinsic alarming has been
configured and the point is in an alarm state.
Alarm state Displays a Building Operation alarm state that provides additional
information about an intrinsic alarm or algorithmic alarm
configured for an object. For more information, see the Alarm
States topic on WebHelp.
Reliability Displays one of the following descriptions to indicate the reliability
of the Value property:
• no fault detected
• multistate fault
10. Click the Save button .
Continued on next page
04-16006-04-en, March 2015 Technical
2773
76 BACnet Objects and Properties
76.27 Configuring a BACnet Multistate Value
11. Click the Advanced tab.
Continued on next page
Technical 04-16006-04-en, March 2015
2774
76 BACnet Objects and Properties
76.27 Configuring a BACnet Multistate Value
12. Edit the properties.
Property Description
Object ID Displays the BACnet object type and instance number of the
device.
BACnet name View the name of the BACnet object or type a new name to
change the name.
BACnet type Displays the type, which is always device.
Acknowledged Displays whether acknowledgements for to-off-normal, to-
transitions fault, or to-normal transitions have been received.
To-off-normal Displays the date and time of the last to-off-normal transition.
time
To-fault time Displays the date and time of the last to-fault transition.
To-normal time Displays the date and time of the last to-normal transition.
Time delay Enter the minimum number of seconds required before a to-off-
normal event, or to-normal event is generated.
BACnet Choose the method for referencing the intrinsic alarm object
notification that you want to use to generate event notifications:
• Select System reference to define a path-based
reference to an object or property that is currently located
on the server. When selected, only the Path field becomes
editable. All the other fields become non-editable.
• Select BACnet reference to define a reference that
uses the elements of a property value (Device instance
number, Object type, or Object instance number) to
identify a BACnet object or property that is not currently on
the server but may be uploaded or imported to the server
later. You can also use this method to reference a BACnet
object or property on an external device.
For more information, see section 73.7 “BACnet References
and System References” on page 2562.
Alarm handling Select the data source for alarm handling and presentation
and presentation information. The alarm presentation settings display as three
tabs (User Action, Attachment, and Presentation) on the alarm
sources (value) as well as in the notification class. For more
information, see section 79.6 “BACnet Alarms” on page 2898.
Notify type Select the type of BACnet event notification to be generated:
• Select alarm to define the event as a BACnet alarm and
to display the event in Alarm View.
• Select event to define the event as a BACnet event and to
display the event in Event View.
Event enable Select the flags to enable the reporting of to-off-normal and
to-normal events. to-fault reporting is not supported by
Building Operation BACnet devices.
State Id Enter the State Id for which you want to set an alarm or fault
alarm.
Continued on next page
04-16006-04-en, March 2015 Technical
2775
76 BACnet Objects and Properties
76.27 Configuring a BACnet Multistate Value
Continued
Property Description
Is alarm value Select Yes or No to assign an alarm to the State Id. If you
select Yes, select No for Is fault value.
Is fault value Select Yes or No to assign a fault alarm to the State Id. If you
select Yes, select No for Is alarm value.
Click to add an alarm or fault State Id to the list of alarm and
fault values.
Click to open the Properties dialog box where you can edit
the alarm or fault configuration for a selected State Id. For
more information, see section 81.62 “BACnet Multistate Alarm
Properties Dialog Box” on page 3069.
Click to remove the State Id from the list of alarm or fault
values.
Alarm message Enter the text that you want to display in the Alarm View for the
corresponding alarm state. The configured text is also sent to
Reset message any external BACnet clients configured as alarm recipients in
Fault message the BACnet notification.
For more information, see the Alarms Pane and Alarm View
topic on WebHelp.
13. Click the Save button .
14. Click to create a multistate alarm.
15. Type a name for the alarm and click Create.
16. Repeat the process until you have the desired number of alarms.
Continued on next page
Technical 04-16006-04-en, March 2015
2776
76 BACnet Objects and Properties
76.27 Configuring a BACnet Multistate Value
17. Select an alarm from the list and click to modify an alarm.
18. Edit the properties.
Property Description
State Id Enter the state that you want to configure for the multistate
point or value.
Is alarm value Select Yes to assign an alarm to the State Id. Then, select No
for Is fault value.
Is fault value Select Yes to assign a fault alarm to the State Id. Then, select
No for Is alarm value.
19. Click OK.
20. Repeat the steps to modify another alarm.
21. Click the Save button .
Continued on next page
04-16006-04-en, March 2015 Technical
2777
76 BACnet Objects and Properties
76.27 Configuring a BACnet Multistate Value
22. Click the Command tab.
23. Edit the properties.
Property Description
Relinquish Enter the value to be used by the Value property when all values in
default the priority array are set to Null.
Active Specifies the priority level (1-16) currently controlling the present
command value. The present value is the highest priority with a non-Null value.
priority
Priority 6 This priority is reserved for timer-based algorithms that are not
currently supported. (Read-only)
Priority x Enter a priority value or Null.
24. Click the Save button .
Technical 04-16006-04-en, March 2015
2778
76 BACnet Objects and Properties
76.28 Creating a BACnet Value (Generic)
76.28 Creating a BACnet Value (Generic)
You create an analog, digital, or multistate value (generic) for a device when you
want to view and configure a BACnet value in an external BACnet device from
WorkStation.
For more information, see section 75.21 “Device Communication and Diagnostics”
on page 2631.
When you create the BACnet value (generic), you need to perform one of the
following operations:
• Download to a device to create a value in an external BACnet device. For more
information, see section 76.7 “BACnet Configuration Properties” on page
2671.
• Upload from a device to upload the properties of a value from a BACnet
device.
To create a BACnet value (generic)
1. In WorkStation, in the System Tree, expand BACnet Interface and
expand the network where the device resides.
2. Expand the device and select Application.
3. On the File menu, point to New and then click Value.
4. In the object type list, select the type of value that you want to create. Do not
select String Value or Time Stamp Value, which are not BACnet value
types.
5. In the Name box, type a name for the value.
6. In the Description box, type a description for the value.
Continued on next page
04-16006-04-en, March 2015 Technical
2779
76 BACnet Objects and Properties
76.28 Creating a BACnet Value (Generic)
7. Click Next.
8. Click Download to BACnet device and then manually enter an Instance
ID now if you want. Otherwise, click to have the ID automatically generated.
Once created, be aware that you cannot change the object’s Instance ID.
9. In the BACnet name box, type a BACnet name for the value.
Do not type a name if you want a name to be assigned for you.
10. Click Upload from BACnet device if you want to upload the properties of
the point from the BACnet device.
11. Click Create.
Technical 04-16006-04-en, March 2015
2780
76 BACnet Objects and Properties
76.29 Configuring a BACnet Analog Value (Generic)
76.29 Configuring a BACnet Analog Value
(Generic)
You configure the properties of a generic BACnet analog value in an external
BACnet device. You can also configure an intrinsic alarm for the point if supported
by the device.
To configure a BACnet analog value (generic)
1. In WorkStation, in the System Tree, expand BACnet Interface, and then
expand the appropriate network.
2. Expand the external device where the analog value resides and select
Application.
3. In List View, select the analog value (generic) that you want to configure.
4. On the File menu, click Properties.
5. Click the Basic tab.
6. Click the Configure button for the Value property.
Property Description
Type Displays the object type. Read-only
Unit Select the Unit check box and enter the unit that matches the
unit of the point on the Automation Server IO module. For more
information, see the Units topic on WebHelp.
Init value Displays the initial value, if defined. Read-only.
Reference Enter the Value property of the point that you want to reference.
Forceable Select to make the value forcible. For more information, see the
Forced Values topic on WebHelp.
Retain level Select how to handle values for warm start, cold start, system
events, and system activities. For more information, see the
Retain Level topic on WebHelp.
04-16006-04-en, March 2015 Technical
2781
76 BACnet Objects and Properties
76.29 Configuring a BACnet Analog Value (Generic)
7. Click OK to return to the Basic tab.
Continued on next page
Technical 04-16006-04-en, March 2015
2782
76 BACnet Objects and Properties
76.29 Configuring a BACnet Analog Value (Generic)
8. Edit the properties.
Property Description
Value Enter the value to be used as the control system parameter under
the following conditions:
• Unforce. Displays a forced value. Enter a forced value or
click to release the value.
• Force. Displays a non-forced value. Click to force the value.
For all BACnet inputs, a Forced condition is the same as out of
service. For more information, see the Forced Values topic on
WebHelp.
For BACnet outputs and values, which are commandable, a
Forced status may also include a priority level setting. For more
information, see section 77.7 “Forced Priority Level” on page
2857.
Status flags Displays the condition or status of the BACnet value. For more
information, see section 76.9 “BACnet Status Flags” on page
2673.
Out of service Set to True to decouple the Value from the associated property.
If the associated property is not configured, this property is True
and cannot be changed.
Event state Displays Off Normal when intrinsic alarming has been
configured and the point is in an alarm state.
Alarm state Displays a Building Operation alarm state that provides additional
information about an intrinsic alarm or algorithmic alarm
configured for an object. For more information, see the Alarm
States topic on WebHelp.
COV increment Enter the minimum change in the Value property that causes a
COV notification to be sent.
9. Click OK.
Continued on next page
04-16006-04-en, March 2015 Technical
2783
76 BACnet Objects and Properties
76.29 Configuring a BACnet Analog Value (Generic)
10. Click the Advanced tab.
Continued on next page
Technical 04-16006-04-en, March 2015
2784
76 BACnet Objects and Properties
76.29 Configuring a BACnet Analog Value (Generic)
11. Edit the properties.
Property Description
Object ID Displays the BACnet object type and instance number of the
device.
BACnet name View the name of the BACnet object or type a new name to
change the name.
BACnet type Displays the type, which is always device.
Profile name Displays the unique name of the profile that describes additional
characteristics of the object, such as additional properties,
behaviors, or requirements.
Acknowledged Displays whether acknowledgements for to-off-normal, to-
transitions fault, or to-normal transitions have been received.
To-off-normal Displays the date and time of the last to-off-normal transition.
time
To-fault time Displays the date and time of the last to-fault transition.
To-normal time Displays the date and time of the last to-normal transition.
Time delay Enter the minimum number of seconds required before a to-off-
normal event, or to-normal event is generated.
BACnet Choose the method for referencing the intrinsic alarm object
notification that you want to use to generate event notifications:
• Select System reference to define a path-based
reference to an object or property that is currently located
on the server. When selected, only the Path field becomes
editable. All the other fields become non-editable.
• Select BACnet reference to define a reference that
uses the elements of a property value (Device instance
number, Object type, or Object instance number) to
identify a BACnet object or property that is not currently on
the server but may be uploaded or imported to the server
later. You can also use this method to reference a BACnet
object or property on an external device.
For more information, see section 73.7 “BACnet References
and System References” on page 2562.
Notify type Select the type of BACnet event notification to be generated:
• Select alarm to define the event as a BACnet alarm and
to display the event in Alarm View.
• Select event to define the event as a BACnet event and to
display the event in Event View.
Event enable Select the flags to enable the reporting of to-off-normal and
to-normal events. to-fault reporting is not supported by
Building Operation BACnet devices.
Upper limit Enter a limit that Value is required to exceed before a to-off-
normal event is generated.
Lower limit Enter a limit that Value is required to fall below before a to-off-
Continued on next page
04-16006-04-en, March 2015 Technical
2785
76 BACnet Objects and Properties
76.29 Configuring a BACnet Analog Value (Generic)
Continued
Property Description
normal event is generated.
The system generates a to-off-normal event based on Value
and the boundaries defined by the Upper Limit, Lower limit, and
Deadband. For example, if you enter 5 seconds and the Value
remains outside the Upper limit and Lower limit boundaries for a
minimum of 5 seconds, the system generates a to-off-normal
event.
Deadband Enter a range that is an offset from the low-level and high-level
limits, which defines the range where a to-normal event can be
generated. To generate a to-normal event, the value must be
above the low limit and below the high limit, minus the
deadband. For generic objects, this property is present only in
analog objects from external devices that support intrinsic
reporting.
Limit enable Select Low limit enable to enable the reporting of Lower
limit off-normal events and to-normal events. Select High
limit enable to enable the reporting of Upper limit off-normal
events and to-normal events.
Alarm message Enter the text that you want to display in the Alarm View for the
corresponding alarm state. The configured text is also sent to
Reset message any external BACnet clients configured as alarm recipients in
Fault message the BACnet notification.
For more information, see the Alarms Pane and Alarm View
topic on WebHelp.
Tip
Message text received from the external device displays in the Alarm
text field instead of the configured device.
12. Click OK.
Continued on next page
Technical 04-16006-04-en, March 2015
2786
76 BACnet Objects and Properties
76.29 Configuring a BACnet Analog Value (Generic)
13. Click the Command tab.
14. Edit the properties.
Property Description
Relinquish Enter the value to be used by the Value property when all values in
default the priority array are set to Null.
Active Specifies the priority level (1-16) currently controlling the present
command value. The present value is the highest priority with a non-Null value.
priority
Priority 6 This priority is reserved for timer-based algorithms that are not
currently supported. (Read-only)
Priority x Enter a priority value or Null.
15. Click OK.
04-16006-04-en, March 2015 Technical
2787
76 BACnet Objects and Properties
76.30 Configuring a BACnet Digital Value (Generic)
76.30 Configuring a BACnet Digital Value
(Generic)
You configure a BACnet digital value (generic) to configure the properties of a digital
value in an external BACnet device. You can also configure an intrinsic alarm for the
point if supported by the device.
To configure a BACnet digital value (generic)
1. In WorkStation, in the System Tree, expand BACnet Interface, and then
expand the appropriate network.
2. Expand the external device where the digital value resides and select
Application.
3. In List View, select the digital value (generic) that you want to configure.
4. On the File menu, click Properties.
5. Click the Basic tab.
Continued on next page
Technical 04-16006-04-en, March 2015
2788
76 BACnet Objects and Properties
76.30 Configuring a BACnet Digital Value (Generic)
6. Edit the properties.
Property Description
Value Enter the value to be used as the control system parameter
under the following conditions:
• Unforce. Displays a forced value. Enter a forced value
or click to release the value.
• Force. Displays a non-forced value. Click to force the
value.
For all BACnet inputs, a Forced condition is the same as out
of service. For more information, see the Forced Values topic
on WebHelp.
For BACnet outputs and values, which are commandable, a
Forced status may also include a priority level setting. For
more information, see section 77.7 “Forced Priority Level” on
page 2857.
Status flags Displays the condition or status of the BACnet value. For
more information, see section 76.9 “BACnet Status Flags” on
page 2673.
Out of service Set to True to decouple the Value from the associated
property. If the associated property is not configured, this
property is True and cannot be changed.
Reliability Displays the reliability of the point.
Event state Displays Off Normal when intrinsic alarming has been
configured and the point is in an alarm state.
Alarm state Displays a Building Operation alarm state that provides
additional information about an intrinsic alarm or algorithmic
alarm configured for an object. For more information, see the
Alarm States topic on WebHelp.
Change of state Displays the reliability of the point.
time
Change of state Displays how often the Value property has changed state
count since the Change of state count was last set to 0. The
Change of state count increments when the Value
property has a change of state based on an event that alters
the Value property.
Enter 0 if you want to reset the Change of state count.
Time of state count Displays the date and time when the Change of state
reset count was last set to 0.
Elapsed active time Displays the number of seconds that the Value property
was Active since the Elapsed active time was last set to
0.
Enter 0 if you want to reset the Elapsed active time.
Time of active time Displays the date and time when Elapsed active time was
reset last set to 0.
Inactive text Type the text that explains the Inactive state of the value,
Continued on next page
04-16006-04-en, March 2015 Technical
2789
76 BACnet Objects and Properties
76.30 Configuring a BACnet Digital Value (Generic)
Continued
Property Description
such as Pump_Basement_Off. This text is used as an
enumeration text for the Value property and related priority
array values. It is visible in graphics, in the Watch pane, and
in the Properties pane.
If you leave this box empty, the default (Inactive) is used
instead.
Active text Type the text that explains the Active state of the value, such
as Pump_Basement_On. This text is used as an enumeration
text for the Value property and related priority array values. It
is visible in graphics, in the Watch pane, and in the Properties
pane.
If you leave this box empty, the default (Active) is used
instead.
Minimum off time Enter the minimum number of seconds that you want the
Value property to remain Inactive following a write to the
Value property that causes the Inactive state.
Minimum on time Enter the minimum number of seconds that you want the
Value property to remain Active following a write to the
Value property that causes the Active state.
7. Click OK.
Continued on next page
Technical 04-16006-04-en, March 2015
2790
76 BACnet Objects and Properties
76.30 Configuring a BACnet Digital Value (Generic)
8. Click the Advanced tab.
Continued on next page
04-16006-04-en, March 2015 Technical
2791
76 BACnet Objects and Properties
76.30 Configuring a BACnet Digital Value (Generic)
9. Edit the properties.
Property Description
Object ID Displays the BACnet object type and instance number of the
device.
BACnet name View the name of the BACnet object or type a new name to
change the name.
BACnet type Displays the type, which is always device.
Profile name Displays the unique name of the profile that describes additional
characteristics of the object, such as additional properties,
behaviors, or requirements.
Acknowledged Displays whether acknowledgements for to-off-normal, to-
transitions fault, or to-normal transitions have been received.
To-off-normal Displays the date and time of the last to-off-normal transition.
time
To-fault time Displays the date and time of the last to-fault transition.
To-normal time Displays the date and time of the last to-normal transition.
Time delay Enter the minimum number of seconds required before a to-off-
normal event, or to-normal event is generated.
BACnet Choose the method for referencing the intrinsic alarm object
notification that you want to use to generate event notifications:
• Select System reference to define a path-based
reference to an object or property that is currently located
on the server. When selected, only the Path field becomes
editable. All the other fields become non-editable.
• Select BACnet reference to define a reference that
uses the elements of a property value (Device instance
number, Object type, or Object instance number) to
identify a BACnet object or property that is not currently on
the server but may be uploaded or imported to the server
later. You can also use this method to reference a BACnet
object or property on an external device.
For more information, see section 73.7 “BACnet References
and System References” on page 2562.
Alarm handling Select the data source for alarm handling and presentation
and presentation information. The alarm presentation settings display as three
tabs (User Action, Attachment, and Presentation) on the alarm
sources (value) as well as in the notification class. For more
information, see section 79.6 “BACnet Alarms” on page 2898.
Notify type Select the type of BACnet event notification to be generated:
• Select alarm to define the event as a BACnet alarm and
to display the event in Alarm View.
• Select event to define the event as a BACnet event and to
display the event in Event View.
Event enable Select the flags to enable the reporting of to-off-normal and
to-normal events. to-fault reporting is not supported by
Continued on next page
Technical 04-16006-04-en, March 2015
2792
76 BACnet Objects and Properties
76.30 Configuring a BACnet Digital Value (Generic)
Continued
Property Description
Building Operation BACnet devices.
Alarm value Select the state that Value requires before an off-normal event
is triggered.
Alarm message Enter the text that you want to display in the Alarm View for the
corresponding alarm state. The configured text is also sent to
Reset message any external BACnet clients configured as alarm recipients in
Fault message the BACnet notification.
For more information, see the Alarms Pane and Alarm View
topic on WebHelp.
Tip
Message text received from the external device displays in the Alarm
text field instead of the configured text.
10. Click OK.
11. Click the Command tab.
Continued on next page
04-16006-04-en, March 2015 Technical
2793
76 BACnet Objects and Properties
76.30 Configuring a BACnet Digital Value (Generic)
12. Edit the properties.
Property Description
Relinquish Enter the value to be used by the Value property when all values in
default the priority array are set to Null.
Active Specifies the priority level (1-16) currently controlling the present
command value. The present value is the highest priority with a non-Null value.
priority
Priority 6 This priority is reserved for timer-based algorithms that are not
currently supported. (Read-only)
Priority x Enter a priority value or Null.
13. Click OK.
Technical 04-16006-04-en, March 2015
2794
76 BACnet Objects and Properties
76.31 Configuring a BACnet Multistate Value (Generic)
76.31 Configuring a BACnet Multistate Value
(Generic)
You configure a generic BACnet multistate value to configure the properties of a
multistate value in an external BACnet device. You can also create an intrinsic alarm
if supported by the device.
To configure a BACnet multistate value (generic)
1. In WorkStation, in the System Tree, expand BACnet Interface and then
expand the appropriate network.
2. Expand the external device where the multistate value resides and select
Application.
3. In List View, select the multistate value (generic) that you want to configure.
4. On the File menu, click Open.
5. Click the State Configuration tab.
6. In the Number of states box, enter the number of states that you want to
create, for example, enter 128.
7. In the Label column, click the text and then type a description for the state
number, such as Unoccupied, Standby, or Warmup.
Repeat this step for each state that you created.
8. Click the Save button .
Continued on next page
04-16006-04-en, March 2015 Technical
2795
76 BACnet Objects and Properties
76.31 Configuring a BACnet Multistate Value (Generic)
9. Click the Properties tab and then click the Basic tab.
Continued on next page
Technical 04-16006-04-en, March 2015
2796
76 BACnet Objects and Properties
76.31 Configuring a BACnet Multistate Value (Generic)
10. Edit the properties.
Property Description
Value Enter the value to be used as the control system parameter
under the following conditions:
• Unforce. Displays a forced value. Enter a forced value
or click to release the value.
• Force. Displays a non-forced value. Click to force the
value.
For all BACnet inputs, a Forced condition is the same as out
of service. For more information, see the Forced Values topic
on WebHelp.
For BACnet outputs and values, which are commandable, a
Forced status may also include a priority level setting. For
more information, see section 77.7 “Forced Priority Level” on
page 2857.
Status flags Displays the condition or status of the BACnet value. For
more information, see section 76.9 “BACnet Status Flags” on
page 2673.
Out of service Set to True to decouple the Value from the associated
property. If the associated property is not configured, this
property is True and cannot be changed.
Reliability Displays the reliability of the point.
Event state Displays Off Normal when intrinsic alarming has been
configured and the point is in an alarm state.
Alarm state Displays a Building Operation alarm state that provides
additional information about an intrinsic alarm or algorithmic
alarm configured for an object. For more information, see the
Alarm States topic on WebHelp.
11. Click the Save button .
Continued on next page
04-16006-04-en, March 2015 Technical
2797
76 BACnet Objects and Properties
76.31 Configuring a BACnet Multistate Value (Generic)
12. Click the Advanced tab.
Continued on next page
Technical 04-16006-04-en, March 2015
2798
76 BACnet Objects and Properties
76.31 Configuring a BACnet Multistate Value (Generic)
13. Edit the properties.
Property Description
Object ID Displays the BACnet object type and instance number of the
device.
BACnet name View the name of the BACnet object or type a new name to
change the name.
BACnet type Displays the type, which is always device.
Profile name Displays the unique name of the profile that describes additional
characteristics of the object, such as additional properties,
behaviors, or requirements.
Acknowledged Displays whether acknowledgements for to-off-normal, to-
transitions fault, or to-normal transitions have been received.
To-off-normal Displays the date and time of the last to-off-normal transition.
time
To-fault time Displays the date and time of the last to-fault transition.
To-normal time Displays the date and time of the last to-normal transition.
Time delay Enter the minimum number of seconds required before a to-off-
normal event, or to-normal event is generated.
BACnet Choose the method for referencing the intrinsic alarm object
notification that you want to use to generate event notifications:
• Select System reference to define a path-based
reference to an object or property that is currently located
on the server. When selected, only the Path field becomes
editable. All the other fields become non-editable.
• Select BACnet reference to define a reference that
uses the elements of a property value (Device instance
number, Object type, or Object instance number) to
identify a BACnet object or property that is not currently on
the server but may be uploaded or imported to the server
later. You can also use this method to reference a BACnet
object or property on an external device.
For more information, see section 73.7 “BACnet References
and System References” on page 2562.
Alarm handling Select the data source for alarm handling and presentation
and presentation information. The alarm presentation settings display as three
tabs (User Action, Attachment, and Presentation) on the alarm
sources (value) as well as in the notification class. For more
information, see section 79.6 “BACnet Alarms” on page 2898.
Notify type Select the type of BACnet event notification to be generated:
• Select alarm to define the event as a BACnet alarm and
to display the event in Alarm View.
• Select event to define the event as a BACnet event and to
display the event in Event View.
Event enable Select the flags to enable the reporting of to-off-normal and
to-normal events. to-fault reporting is not supported by
Continued on next page
04-16006-04-en, March 2015 Technical
2799
76 BACnet Objects and Properties
76.31 Configuring a BACnet Multistate Value (Generic)
Continued
Property Description
Building Operation BACnet devices.
State Id Enter the State Id for which you want to set an alarm or fault
alarm.
Is alarm value Select Yes or No to assign an alarm to the State Id. If you
select Yes, select No for Is fault value.
Is fault value Select Yes or No to assign a fault alarm to the State Id. If you
select Yes, select No for Is alarm value.
Click to add an alarm or fault State Id to the list of alarm and
fault values.
Click to open the Properties dialog box where you can edit
the alarm or fault configuration for a selected State Id. For
more information, see section 81.62 “BACnet Multistate Alarm
Properties Dialog Box” on page 3069.
Click to remove the State Id from the list of alarm or fault
values.
Alarm message Enter the text that you want to display in the Alarm View for the
corresponding alarm state. The configured text is also sent to
Reset message any external BACnet clients configured as alarm recipients in
Fault message the BACnet notification.
For more information, see the Alarms Pane and Alarm View
topic on WebHelp.
14. Click to create a multistate alarm.
15. Type a name for the alarm and click Create.
16. Repeat the process until you have the desired number of alarms.
Continued on next page
Technical 04-16006-04-en, March 2015
2800
76 BACnet Objects and Properties
76.31 Configuring a BACnet Multistate Value (Generic)
17. Select an alarm from the list and click to modify the alarm.
18. Edit the properties.
Property Description
State Id Enter the state that you want to configure for the multistate
point or value.
Is alarm value Select Yes to assign an alarm to the State Id. Then, select No
for Is fault value.
Is fault value Select Yes to assign a fault alarm to the State Id. Then, select
No for Is alarm value.
19. Click OK to return to the Advanced tab.
20. Repeat the steps to modify another alarm.
21. Click the Save button .
Continued on next page
04-16006-04-en, March 2015 Technical
2801
76 BACnet Objects and Properties
76.31 Configuring a BACnet Multistate Value (Generic)
22. Click the Command tab.
23. Edit the properties.
Property Description
Relinquish Enter the value to be used by the Value property when all values in
default the priority array are set to Null.
Active Specifies the priority level (1-16) currently controlling the present
command value. The present value is the highest priority with a non-Null value.
priority
Priority 6 This priority is reserved for timer-based algorithms that are not
currently supported. (Read-only)
Priority x Enter a priority value or Null.
24. Click the Save button .
Technical 04-16006-04-en, March 2015
2802
76 BACnet Objects and Properties
76.32 Creating a BACnet Accumulator (Generic)
76.32 Creating a BACnet Accumulator
(Generic)
You create a BACnet accumulator (generic) when you want to monitor an
accumulated quantity being precisely measured over time, such as electric power,
water, or natural gas usage.
To create a BACnet accumulator (generic)
1. In WorkStation, in the System Tree, expand BACnet Interface and
expand the network where the device resides.
2. Expand the device and select Application.
3. On the File menu, point to New and then click Point.
4. In the object type list, select BACnet Accumulator (Generic).
5. In the Name box, type a name for the accumulator (generic).
6. In the Description box, type a description.
Continued on next page
04-16006-04-en, March 2015 Technical
2803
76 BACnet Objects and Properties
76.32 Creating a BACnet Accumulator (Generic)
7. Click Next.
8. Click Download to BACnet device and then manually enter an Instance ID
now if you want. Otherwise, click to have the ID automatically generated.
Once created, be aware that you cannot change the object’s Instance ID.
9. In the BACnet name box, type a BACnet name for the schedule.
Do not type a name if you want a name to be assigned for you.
10. Click Upload from BACnet device if you want to upload the properties of
the point from the BACnet device into Building Operation.
11. Click Create.
Technical 04-16006-04-en, March 2015
2804
76 BACnet Objects and Properties
76.33 Configuring a BACnet Accumulator (Generic)
76.33 Configuring a BACnet Accumulator
(Generic)
You configure a BACnet accumulator (generic) when you want to configure or
modify the intrinsic alarming properties of an accumulator object in a BACnet
device.
To configure a BACnet accumulator (generic)
1. In WorkStation, in the System Tree, expand BACnet Interface, and then
expand the appropriate network.
2. Expand the device where the accumulator (generic) resides and select
Application.
3. In List View, select the accumulator (generic) that you want to configure.
4. On the File menu, click Properties.
5. Click the Advanced tab.
Continued on next page
04-16006-04-en, March 2015 Technical
2805
76 BACnet Objects and Properties
76.33 Configuring a BACnet Accumulator (Generic)
6. In the Time delay (s) box, enter the minimum number of seconds that Pulse
rate is required to remain outside of the range specified by the Upper limit
and Lower limit before a to-off-normal event is generated. The value also
specifies the number of seconds that Pulse rate is required to remain within
the range of Upper limit and Lower limit before a to-normal event is
generated.
7. In the BACnet notification box, select the type of BACnet notification for
generating the event:
• Select System reference to define a path-based reference to an object
or property that is currently located on the server. When selected, only the
Path field becomes editable. All the other fields become non-editable.
• Select BACnet reference to define a reference that uses the elements
of a property value (Device instance number, Object type, or Object
instance number) to identify a BACnet object or property that is not
currently on the server but may be uploaded or imported to the server
later.
8. In the Notify type box, select one of the following options:
• Select alarm if you want the generated event to be reported as an Alarm
• Select event if you want the generated event to be reported as an Event.
9. In the Event enable box, select the appropriate boxes to enable the
reporting of to-off-normal, to-fault, and to-normal events.
10. In the Upper limit box, enter a value that Pulse rate is required to exceed
before an an event is generated.
11. In the Lower limit box, enter a value that Pulse rate is required to fall below
before an an event is generated.
12. In the Limit monitoring interval (s) box, enter the number of seconds
during which the value of the Pulse rate can be determined.
13. In the Limit enable box, select the appropriate box to perform one or both of
the following operations:
• Select Low limit enable to enable the reporting of off-normal events
and the return to to-normal events based on the Lower limit value.
• Select High limit enable to enable the reporting of off-normal events
and the return to-normal events based on the Upper limit value.
14. In the Alarm message, Reset message and Fault message boxes, enter
the text that you want to display in the Alarm text field in the Alarm View for
the corresponding alarm state.
Tip
If a message text is received from the external device, that text is
displayed in the Alarm text field instead of the configured text.
15. Click OK.
Technical 04-16006-04-en, March 2015
2806
76 BACnet Objects and Properties
76.34 Creating a BACnet Averaging (Generic)
76.34 Creating a BACnet Averaging (Generic)
You create a BACnet averaging (generic) when you want to capture electrical
consumption data that provides a sampling of minimum, maximum, and average
values of a referenced property.
To create a BACnet averaging (generic)
1. In WorkStation, in the System Tree, expand BACnet Interface, expand
the network where the device resides, and then expand the device.
2. Select Application.
3. On the File menu, point to New and then click Program.
4. In the object type list, select BACnet Averaging (Generic).
5. In the Name box, type a name for the averaging (generic).
6. In the Description box, type a description.
Continued on next page
04-16006-04-en, March 2015 Technical
2807
76 BACnet Objects and Properties
76.34 Creating a BACnet Averaging (Generic)
7. Click Next.
8. Click Download to BACnet device and then manually enter an Instance ID
now if you want. Otherwise, click to have the ID automatically generated.
Once created, be aware that you cannot change the object’s Instance ID.
9. In the BACnet name box, type a BACnet name for the schedule.
Do not type a name if you want a name to be assigned for you.
10. Click Upload from BACnet device if you want to upload the properties of
the point from the BACnet device into Building Operation.
11. Click Create.
Technical 04-16006-04-en, March 2015
2808
76 BACnet Objects and Properties
76.35 Configuring a BACnet Averaging (Generic)
76.35 Configuring a BACnet Averaging
(Generic)
You configure a BACnet averaging (generic) to configure the properties of an
averaging object in a BACnet device.
For more information, see section 76.1 “BACnet Objects and Properties” on page
2663.
To configure a BACnet averaging (generic)
1. In WorkStation, in the System Tree, expand BACnet Interface, and then
expand the appropriate network.
2. Expand the device where the averaging (generic) resides and select
Application.
3. In List View, select the averaging (generic) that you want to configure.
4. On the File menu, click Properties.
5. Click the Basic tab.
Continued on next page
04-16006-04-en, March 2015 Technical
2809
76 BACnet Objects and Properties
76.35 Configuring a BACnet Averaging (Generic)
6. In the Object property reference box, enter the property whose value is
sampled during the time specified by the Window interval property:
• System reference: Defines a path to a property or object reference
located on the server (including hosted objects, if available). When
selected, only the Path field becomes editable. All the other fields become
non-editable.
• Protocol reference (Advanced): Using the BACnet standard method,
defines a path to a property or object reference located anywhere on the
network. When selected, the Device, Object type, and Object instance
fields become editable (except for notification-class objects) and the Path
field becomes non-editable.
• Path: Select the path to the reference on the file system.
• Device: Type the device number associated with the device.
• Object type: Select the object class of an object, such as analog input.
• Object instance: Type the object instance number associated with the
referenced object.
• Property: Enter the property identifier associated with the value.
The system automatically fills in the device, object type, and object instance
fields for either reference path, where available.
7. In the Window interval box, enter the number of seconds during which the
values for the Minimum value, Maximum value, and Average value are
calculated.
8. In the Window samples box, enter a number (greater than zero) to indicate
how many samples that you want to be taken during the time specified by the
Windows interval property.
9. Click OK.
10. Click the Advanced tab.
11. In the BACnet name box, type a new name to rename the averaging object.
12. Click OK.
Technical 04-16006-04-en, March 2015
2810
76 BACnet Objects and Properties
76.36 Creating a BACnet Command (Generic)
76.36 Creating a BACnet Command (Generic)
You create a BACnet command (generic) when you want to specify an action code
for the object in a BACnet device.
For more information, see section 76.1 “BACnet Objects and Properties” on page
2663.
To create a BACnet command (generic)
1. In WorkStation, in the System Tree, expand BACnet Interface, expand
the network where the device resides, and then expand the device.
2. Select Application.
3. On the File menu, point to New and then click Program.
4. In the object type list, select BACnet Command (Generic).
5. In the Name box, type a name for the command (generic).
6. In the Description box, type a description.
Continued on next page
04-16006-04-en, March 2015 Technical
2811
76 BACnet Objects and Properties
76.36 Creating a BACnet Command (Generic)
7. Click Next.
8. Click Download to BACnet device and then manually enter an Instance ID
now if you want. Otherwise, click to have the ID automatically generated.
Once created, be aware that you cannot change the object’s Instance ID.
9. In the BACnet name box, type a BACnet name for the schedule.
Do not type a name if you want a name to be assigned for you.
10. Click Upload from BACnet device if you want to upload the properties of
the point from the BACnet device into Building Operation.
11. Click Create.
Technical 04-16006-04-en, March 2015
2812
76 BACnet Objects and Properties
76.37 Configuring a BACnet Command (Generic)
76.37 Configuring a BACnet Command
(Generic)
You configure a BACnet command (generic) when you want to specify the number
of the action list that you want generated when the command object runs.
To configure a BACnet command (generic)
1. In WorkStation, in the System Tree, expand BACnet Interface, and then
expand the appropriate network.
2. Expand the device where the command (generic) resides and select
Application.
3. In List View, select the command (generic) that you want to configure.
4. On the File menu, click Properties.
5. Click the Basic tab.
6. In the Value box, enter the number of the action list that you want generated
when the command object runs.
7. Click OK.
8. Click the Advanced tab only if you want to rename the command object.
Continued on next page
04-16006-04-en, March 2015 Technical
2813
76 BACnet Objects and Properties
76.37 Configuring a BACnet Command (Generic)
9. In the BACnet name box, type a new name if you want to rename the
command object.
10. Click OK.
Technical 04-16006-04-en, March 2015
2814
76 BACnet Objects and Properties
76.38 Creating a BACnet Load Control (Generic)
76.38 Creating a BACnet Load Control
(Generic)
You create a BACnet load control (generic) when you want to manage the shedding
of electrical loads to reduce peak consumption.
To create a BACnet load control (generic)
1. In WorkStation, in the System Tree, expand BACnet Interface, expand
the network where the device resides.
2. Expand the device and select Application.
3. On the File menu, point to New and then click Program.
4. In the object type list, select BACnet Load Control (Generic).
5. In the Name box, type a name for the load control (generic).
6. In the Description box, type a description.
Continued on next page
04-16006-04-en, March 2015 Technical
2815
76 BACnet Objects and Properties
76.38 Creating a BACnet Load Control (Generic)
7. Click Next.
8. Click Download to BACnet device and then manually enter an Instance ID
now if you want. Otherwise, click to have the ID automatically generated.
Once created, be aware that you cannot change the object’s Instance ID.
9. In the BACnet name box, type a BACnet name for the schedule.
Do not type a name if you want a name to be assigned for you.
10. Click Upload from BACnet device if you want to upload the properties of
the point from the BACnet device into Building Operation.
11. Click Create.
Technical 04-16006-04-en, March 2015
2816
76 BACnet Objects and Properties
76.39 Configuring a BACnet Load Control (Generic)
76.39 Configuring a BACnet Load Control
(Generic)
You configure a BACnet load control (generic) when you want to configure or
modify the intrinsic alarming properties of a load control object in an external
BACnet device.
To configure a BACnet load control (generic)
1. In WorkStation, in the System Tree, expand BACnet Interface, and then
expand the appropriate network.
2. Expand the device where the load control (generic) resides.
3. Select Application.
4. In List View, select the load control (generic) that you want to configure.
5. On the File menu, click Properties.
Continued on next page
04-16006-04-en, March 2015 Technical
2817
76 BACnet Objects and Properties
76.39 Configuring a BACnet Load Control (Generic)
6. Click the Advanced tab.
7. In the Time delay (s) box, enter a minimum number of seconds that the
Value property is required to be shed non-compliant before a to-off-
normal event is generated, or a state other than shed non-compliant before
a to-normal event is generated.
Continued on next page
Technical 04-16006-04-en, March 2015
2818
76 BACnet Objects and Properties
76.39 Configuring a BACnet Load Control (Generic)
8. In the BACnet notification box, select the type of BACnet notification for
generating the event:
• Select System reference to define a path-based reference to an object
or property that is currently located on the server. When selected, only the
Path field becomes editable. All the other fields become non-editable.
• Select BACnet reference to define a reference that uses the elements
of a property value (Device instance number, Object type, or Object
instance number) to identify a BACnet object or property that is not
currently on the server but may be uploaded or imported to the server
later.
9. In the Notify type box, select one of the following options:
• Select event if want the generated event to be reported as an event.
• Select alarm if want the generated event to be reported as an alarm.
10. In the Event enable box, select the appropriate boxes to enable the
reporting of to-off-normal, to-fault, and to-normal events.
11. In the Alarm message, Reset message and Fault message boxes, enter
the text that you want to display in the Alarm text field in the Alarm View for
the corresponding alarm state.
Tip
If a message text is received from the external device, that text is
displayed in the Alarm text field instead of the configured text.
12. Click OK.
04-16006-04-en, March 2015 Technical
2819
76 BACnet Objects and Properties
76.40 Creating a BACnet Pulse Converter (Generic)
76.40 Creating a BACnet Pulse Converter
(Generic)
You create a BACnet pulse converter (generic) when you want to monitor
approximate information about an accumulated quantity being measured over time,
such as electric power consumption, water consumption, or natural gas usage.
To create a BACnet pulse converter (generic)
1. In WorkStation, in the System Tree, expand BACnet Interface, expand
the network where the device resides.
2. Expand the device and select Application.
3. On the File menu, point to New and then click Point.
4. In the object type list, select BACnet Pulse Converter (Generic).
5. In the Name box, type a name for the pulse converter (generic).
6. In the Description box, type a description.
Continued on next page
Technical 04-16006-04-en, March 2015
2820
76 BACnet Objects and Properties
76.40 Creating a BACnet Pulse Converter (Generic)
7. Click Next.
8. Click Download to BACnet device and then manually enter an Instance ID
now if you want. Otherwise, click to have the ID automatically generated.
Once created, be aware that you cannot change the object’s Instance ID.
9. In the BACnet name box, type a BACnet name for the schedule.
Do not type a name if you want a name to be assigned for you.
10. Click Upload from BACnet device if you want to upload the properties of
the point from the BACnet device into Building Operation.
11. Click Create.
04-16006-04-en, March 2015 Technical
2821
76 BACnet Objects and Properties
76.41 Configuring a BACnet Pulse Converter (Generic)
76.41 Configuring a BACnet Pulse Converter
(Generic)
You configure a BACnet pulse converter (generic) to configure the properties of a
pulse converter in a BACnet device. An additional configuration task includes
configuring an intrinsic alarm for the object.
To configure a pulse converter (generic)
1. In WorkStation, in the System Tree, expand BACnet Interface, and then
expand the appropriate network.
2. Expand the device where the pulse converter (generic) resides and select
Application.
3. In List View, select the pulse converter (generic) that you want to configure.
4. On the File menu, click Properties.
Continued on next page
Technical 04-16006-04-en, March 2015
2822
76 BACnet Objects and Properties
76.41 Configuring a BACnet Pulse Converter (Generic)
5. Click the Basic tab.
6. In the Input reference box, select the type of BACnet notification for
defining the property whose value is sampled during the time specified by the
Window interval property:
• Select System reference to define a path-based reference to an object
or property that is currently located on the server. When selected, only the
Path field becomes editable. All the other fields become non-editable.
• Select BACnet reference to define a reference that uses the elements
of a property value (Device instance number, Object type, or Object
instance number) to identify a BACnet object or property that is not
currently on the server but may be uploaded or imported to the server
later.
Continued on next page
04-16006-04-en, March 2015 Technical
2823
76 BACnet Objects and Properties
76.41 Configuring a BACnet Pulse Converter (Generic)
7. In the COV increment box, enter the minimum change in the Value property
that causes a COV notification to be sent.
8. Click OK.
9. Click the Advanced tab.
10. In the BACnet name box, type a new name to rename the pulse converter
object.
11. In the Time delay (s) box, enter the minimum number of seconds that the
Value property is required to remain outside of the range specified by the
Upper limit and Lower limit before a to-off-normal event is generated. The
value also specifies the minimum number of seconds that the Value property
is required to remain within the range of Upper limit, Lower limit, and
Deadband before a to-normal event is generated.
Continued on next page
Technical 04-16006-04-en, March 2015
2824
76 BACnet Objects and Properties
76.41 Configuring a BACnet Pulse Converter (Generic)
12. In the BACnet notification box, select the type of BACnet notification for
generating the event:
• Select System reference to define a path-based reference to an object
or property that is currently located on the server. When selected, only the
Path field becomes editable. All the other fields become non-editable.
• Select BACnet reference to define a reference that uses the elements
of a property value (Device instance number, Object type, or Object
instance number) to identify a BACnet object or property that is not
currently on the server but may be uploaded or imported to the server
later.
13. In the Notify type box, select one of the following categories to identify the
event when an event is generated by the object:
• Select alarm to report the event as an alarm.
• Select event to report the event as an event.
14. In the Event enable box, select one or more flags to enable the reporting of
to-off-normal, to-fault, and to-normal events.
15. In the Upper limit box, enter a value that the Value property is required to
exceed before an an event is generated. The Value property is required to
exceed the Upper limit value for the minimum time specified in the Time
delay (s) property.
16. In the Lower limit box, enter a value that the Value property is required to
fall below before an an event is generated. The Value property is required to
fall below the Lower limit value for the minimum time specified in the Time
delay (s) property.
17. In the Deadband box, enter a value to create a range between the Upper
limit and Lower limit values. The Value property is required to remain
within the range before a to-normal event is generated based on various
conditions. For more information, see section 81.97 “BACnet Pulse Converter
Properties (Generic) – Advanced Tab” on page 3142.
18. In the Limit enable box, do one of the following actions:
• Select Low limit enable to enable the reporting of Lower limit off-
normal events and to-normal events.
• Select High limit enable to enable the reporting of Upper limit off-
normal events and to-normal events.
19. In the Alarm message, Reset message and Fault message boxes, enter
the text that you want to display in the Alarm text field in the Alarm View for
the corresponding alarm state.
Tip
If a message text is received from the external device, that text is
displayed in the Alarm text field instead of the configured text.
20. Click OK.
04-16006-04-en, March 2015 Technical
2825
76 BACnet Objects and Properties
76.42 Changing a BACnet String
76.42 Changing a BACnet String
You can change a BACnet string, if supported in a BACnet device.
For more information, see section 76.1 “BACnet Objects and Properties” on page
2663.
To change a BACnet string
1. In WorkStation, in the System Tree, expand BACnet Interface.
2. Expand the BACnet network where the external device resides.
3. Expand the external BACnet device and select the BACnet string that you
want to configure.
4. On the File menu, click Properties.
5. Click the Basic tab.
6. In the Value box, type the text that you want to display.
Technical 04-16006-04-en, March 2015
2826
76 BACnet Objects and Properties
76.43 Creating a BACnet Trend Log
76.43 Creating a BACnet Trend Log
You create a BACnet trend log with intrinsic reporting so you can monitor and
record the trends in the value of a monitored property.
To create a BACnet trend log
1. In WorkStation, in the System Tree, expand BACnet Interface and then
select Application.
2. On the File menu, point to New and then click Trend.
3. In the object type list, select BACnet Trend Log.
4. In the Name box, type a name for the trend log.
5. In the Description box, type a description for the trend log.
6. Click Next.
Continued on next page
04-16006-04-en, March 2015 Technical
2827
76 BACnet Objects and Properties
76.43 Creating a BACnet Trend Log
7. In the Instance ID box, click:
• Automatically generated to have the server generate a BACnet
instance ID for you.
• Manually entered if you want and then enter an Instance ID yourself.
8. In the BACnet name box, type a BACnet name for the trend log. Do not type
a name if you want a name to be assigned for you.
9. Click Create.
Technical 04-16006-04-en, March 2015
2828
76 BACnet Objects and Properties
76.44 Configuring a BACnet Trend Log
76.44 Configuring a BACnet Trend Log
You configure a BACnet trend log with intrinsic reporting so you can monitor and
record the trends in the value of a monitored property. Before you use this
procedure, create and configure a BACnet notification.
To configure a BACnet trend log
1. In WorkStation, in the System Tree, expand BACnet Interface, and then
expand the appropriate network.
2. Expand the device where the BACnet trend log resides and select
Application.
3. In List View, select the BACnet trend log that you want to configure.
4. On the File menu, click Properties.
5. Click the Basic tab.
Continued on next page
04-16006-04-en, March 2015 Technical
2829
76 BACnet Objects and Properties
76.44 Configuring a BACnet Trend Log
6. In the Log enable box, select True to enable logging of the monitored
property referenced by Log device object property.
7. In the Start time box, enter the date and time to start trending.
8. In the Stop time box, enter the date and time to stop trending.
9. In the Stop when full box, select True if you want trending to stop when the
log buffer reaches the maximum Buffer size.
10. In the Buffer size box, enter the maximum number of records the buffer can
hold.
11. In the Log device object property box, enter the property to be trended:
• System reference: Defines a path to a property or object reference
located on the server (including hosted objects, if available). When
selected, only the Path field becomes editable. All the other fields become
non-editable.
• BACnet reference: Using the BACnet standard method, defines a path
to a property or object reference located anywhere on the network. When
selected, the Device, Object type, and Object instance fields become
editable (except for notification-class objects) and the Path field becomes
non-editable.
• Path: Select the path to the reference on the file system.
• Device instance number: Type the device number associated with the
device.
• Object type: Select the object class of an object, such as analog input.
• Object instance number: Type the object instance number associated
with the referenced object.
• Property: Enter the property identifier associated with the variable.
The system automatically fills in the device, object type, and object instance
fields for either reference path, where available.
12. In the Logging type box, select one of the following options:
• Select Change of Value if you want Building Operation to add an entry
to the trend log only when the value of the monitored property changes. If
you select Change of value, you also
• Select Interval if you want Building Operation to poll the monitored
property at time intervals, and then add the trend entry to the trend log.
13. In the Log interval box, do one of the following actions:
• Enter how often you want the trend log to poll for a value if you selected
Interval for Logging type. The frequency is days, hours, minutes,
seconds, hundredths of seconds.
• Enter 0 for each interval if you selected Change of value for Logging
type.
14. In the Delta box, enter a value if you are trending the COV increment of an
object, and want the Delta value to be used.
Delta is the difference between the value of the current COV increment. and
the last log value. To log a variable according to the time interval, use a delta of
zero.
Continued on next page
Technical 04-16006-04-en, March 2015
2830
76 BACnet Objects and Properties
76.44 Configuring a BACnet Trend Log
15. In the COV resubscription interval box, enter the number of seconds that
you want the trend log to request a COV subscription from the device.
16. Click the Advanced tab.
17. In the Notification threshold box, enter the number of records required to
accumulate in the trend log before BACnet devices are notified by the BACnet
notification. Set the number to equal 10% of the maximum Buffer size.
Continued on next page
04-16006-04-en, March 2015 Technical
2831
76 BACnet Objects and Properties
76.44 Configuring a BACnet Trend Log
18. In the BACnet notification box, select the type of BACnet notification for
defining when the number of records specified by the Notification
threshold property has been reached.
• Select System reference to define a path-based reference to an object
or property that is currently located on the server. When selected, only the
Path field becomes editable. All the other fields become non-editable.
• Select BACnet reference to define a reference that uses the elements
of a property value (Device instance number, Object type, or Object
instance number) to identify a BACnet object or property that is not
currently on the server but may be uploaded or imported to the server
later.
19. In the Notify type box, select the type of BACnet notification to be
generated:
• Select alarm to define the event as a BACnet alarm and to display the
event in Alarm View.
• Select event to define the event as a BACnet event and to display the
event in Event View.
20. In the Event enable box, select to-normal. Then, select to-offnormal to
enable the reporting of to-offnormal events.
21. Click OK.
Create and configure an extended trend log to enable extended logging. For
more information, see the Creating an Extended Trend Log topic on WebHelp.
Technical 04-16006-04-en, March 2015
2832
76 BACnet Objects and Properties
76.45 Creating a BACnet Trend Log (Generic)
76.45
You might also like
- EcoStruxure Building Operation - System Reference GuideNo ratings yetEcoStruxure Building Operation - System Reference Guide1,922 pages
- Creating and Configuring Alarms Tutorial GuideNo ratings yetCreating and Configuring Alarms Tutorial Guide78 pages
- StruxureWare - Building - Operation IT Ref GuideNo ratings yetStruxureWare - Building - Operation IT Ref Guide768 pages
- Workstationst Alarm Viewer: Instruction GuideNo ratings yetWorkstationst Alarm Viewer: Instruction Guide118 pages
- EcoStruxure Building Operation - Technical Reference GuideNo ratings yetEcoStruxure Building Operation - Technical Reference Guide8,330 pages
- Securing ChatGPT: Best Practices for Protecting Sensitive Data in AI Language ModelsFrom EverandSecuring ChatGPT: Best Practices for Protecting Sensitive Data in AI Language ModelsNo ratings yet
- System Reference Guide - Biblia Software SmartStruxureNo ratings yetSystem Reference Guide - Biblia Software SmartStruxure1,676 pages
- Installation Manual: Struxureware Data Center ExpertNo ratings yetInstallation Manual: Struxureware Data Center Expert24 pages
- The Linux Terminal for Advanced Users - The Command Line Made Easy: First EditionFrom EverandThe Linux Terminal for Advanced Users - The Command Line Made Easy: First EditionNo ratings yet
- Cybersecurity for Executives: A Guide to Protecting Your BusinessFrom EverandCybersecurity for Executives: A Guide to Protecting Your BusinessNo ratings yet
- Power SCADA Operation 2021 - IT RequirementsNo ratings yetPower SCADA Operation 2021 - IT Requirements85 pages
- User Guide - PowerChute™ Network ShutdownNo ratings yetUser Guide - PowerChute™ Network Shutdown71 pages
- Proces-Um001 - En-P PlantPax Distribuited Control System User ManualNo ratings yetProces-Um001 - En-P PlantPax Distribuited Control System User Manual316 pages
- Netmon Appliance Installation and Configuration Guide: December 21, 2020No ratings yetNetmon Appliance Installation and Configuration Guide: December 21, 202020 pages
- Patrol Central Infrastructure Best Practices GuideNo ratings yetPatrol Central Infrastructure Best Practices Guide104 pages
- Netmon Appliance Installation and Configuration Guide: January 6, 2020No ratings yetNetmon Appliance Installation and Configuration Guide: January 6, 202020 pages
- OpenScape Business V2, OpenScape Business S, Installation Guide, Issue 3No ratings yetOpenScape Business V2, OpenScape Business S, Installation Guide, Issue 384 pages
- Factorytalk Assetcentre Getting Results GuideNo ratings yetFactorytalk Assetcentre Getting Results Guide112 pages
- Ethernid™ Administrator'S Guide: For The Ethernid™ Ee Ethernid™ Ge Metronid™ Te Metronid™ Te-RNo ratings yetEthernid™ Administrator'S Guide: For The Ethernid™ Ee Ethernid™ Ge Metronid™ Te Metronid™ Te-R166 pages
- Automation Server Specification Sheet - SmartStruxure SolutionNo ratings yetAutomation Server Specification Sheet - SmartStruxure Solution6 pages
- CAN Bus for Beginners: A Practical Guide to Automotive NetworkingFrom EverandCAN Bus for Beginners: A Practical Guide to Automotive NetworkingNo ratings yet
- Installation and Quick Start: Rack Automatic Transfer Switch (ATS)No ratings yetInstallation and Quick Start: Rack Automatic Transfer Switch (ATS)30 pages
- Configuration Guide-3Com-Switch 4210 FamilyNo ratings yetConfiguration Guide-3Com-Switch 4210 Family567 pages
- Installation & Maintenance Guide For Co-Resident Server100% (1)Installation & Maintenance Guide For Co-Resident Server3,226 pages
- Wonderware Operations Integration - Supervisory SNMP OI Server G-2.1 (Version 1.4) Help PDFNo ratings yetWonderware Operations Integration - Supervisory SNMP OI Server G-2.1 (Version 1.4) Help PDF36 pages
- UPS and VMwareESXi6.x_2022_990-4595I-EN-VMwareNo ratings yetUPS and VMwareESXi6.x_2022_990-4595I-EN-VMware152 pages
- StruxureWare Building Expert - User Interface GuideNo ratings yetStruxureWare Building Expert - User Interface Guide48 pages
- Blog Smarter, Not Harder: SEO, Blogging, and AI Strategies to Skyrocket Your TrafficFrom EverandBlog Smarter, Not Harder: SEO, Blogging, and AI Strategies to Skyrocket Your TrafficNo ratings yet
- Schneider Electric_EcoStruxure-Building-Operation-Software_SXWSWESDBMS001No ratings yetSchneider Electric_EcoStruxure-Building-Operation-Software_SXWSWESDBMS0011 page
- Microsoft PracticeTest 98-365 v2019-07-30 by - Laura - 227qNo ratings yetMicrosoft PracticeTest 98-365 v2019-07-30 by - Laura - 227q131 pages
- What Is Pega Introduction To Pega PRPC - HKRNo ratings yetWhat Is Pega Introduction To Pega PRPC - HKR7 pages
- Network Adapters Disappear From Network Adapters List and Cluster Server Stops RespondingNo ratings yetNetwork Adapters Disappear From Network Adapters List and Cluster Server Stops Responding1 page
- Cisco Software Manager Server 4.0 Administration GuideNo ratings yetCisco Software Manager Server 4.0 Administration Guide12 pages
- Training - Consulting - Complete Range of ServicesNo ratings yetTraining - Consulting - Complete Range of Services31 pages
- CNT4603 System Administration and MaintenanceNo ratings yetCNT4603 System Administration and Maintenance3 pages
- SAP Live Access - Setup Guide: HA400 Collection 16No ratings yetSAP Live Access - Setup Guide: HA400 Collection 164 pages
- User Manual of HikCentral Professional Control ClientNo ratings yetUser Manual of HikCentral Professional Control Client271 pages
- Adobe Connect Installation and Configuration GuideNo ratings yetAdobe Connect Installation and Configuration Guide64 pages
