EC GfxProgram UG
Uploaded by
Jason KuykendallEC GfxProgram UG
Uploaded by
Jason KuykendallEC-gfxProgram
User Guide
1. Version 6.0 - June 2016: Added information for Emulator connection method, updated Resource
Configuration information
2. Version 6.1 - November 2017: Added the nLight offline programming information
3. Version 6.2 - June 2018: Added the Remote Devices/Points, and the BLE Room Device and M-
Bus Device blocks
4. Version 6.3 - November 2018: Added Custom Image and Language support for BLE Room
Devices, and updated Modbus block, Resource Configuration Information, and Block Actions.
5. Version 6.3a - November 2018: Added information on how to configure the myDC Control applica-
tion and the HORYZON displays using the Lcd Screen block.
6. Version 6.4 - April 2019: Added Color Encoder, Color Decoder, EnOcean Device, nLight Channel,
nLight Channel Calculator, and Generic nLight Channel blocks, updated Light Output (ECB & ECY
Series expansion modules) block (added Color port) and Configure the Light Output section;
updated BLE Room Device block (added Custom Actions ports and Custom Actions configura-
tion); updated Modbus Device (ECY Series) block (added Resource Binding section and Data
Units field; updated Scale and Offset fields); updated Wireless Sensor for ECB and ECL series
(replaced module with sensor; updated Learn window); updated Supported Wireless Receivers
and Supported Wireless Sensor Profiles section; updated Limit block (ports).
7. Version 6.X - XXXXXX 2019: Updated Light Output (ECB & ECY Series expansion modules) block
(Dali Reliability field)
8. Version 6.5 - December 2019: New BLE room devices input/output ports (remote support); Proj-
ect’s configuration and compile code separately now available for ECY; Renumbering resource
objects; Updated the Unused Resources screenshot; added a new Selector block; Collapse/
expand block added to the right-click on block menu; New Reset and Set Value commands added
to the right-click on block menu for time blocks; drag multiple resource blocks on the programming
sheet using the CTRL key; Renumbering/Swapping resource objects.
9. Version 6.6 - April 2020: Adding controller specific configurations for Network Objects and
EnOcean devices, project identifier, and a synchronization option to reinitialize controller specific
configurations
10. Version 6.6a - January 2021: Adding RSSI feature for EC-Multi-Sensor-BLE and UNIWAVE
11. Version 6.7 - June 2021: Adding APEX and ECY-STAT support
EC-gfxProgram_UG_67_EN
©, Distech Controls Inc., 2019. All rights reserved.
While all efforts have been made to verify the accuracy of information in this manual, Distech Controls
is not responsible for damages or claims arising from the use of this manual. Persons using this man-
ual are assumed to be trained HVAC professionals and are responsible for using the correct wiring
procedures, correct override methods for equipment control and maintaining safe working conditions in
fail-safe environments. Distech Controls reserves the right to change, delete or add to the information
in this manual at any time without notice.
Distech Controls, the Distech Controls logo, and Innovative Solutions for Greener Buildings are regis-
tered trademarks of Distech Controls, Inc. BACnet is a registered trademark of ASHRAE. All other
trademarks are property of their respective owners.
TABLE OF CONTENTS
CHAPTER 1
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Introduction to EC-gfxProgram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
About this user guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Conventions used in this document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
CHAPTER 2
Quick Start Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Creating a new project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Developing a control sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Synchronizing a project with a device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Debugging a project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
CHAPTER 3
User Interface Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Overview of the user interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Ribbons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
File menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Resource Report Print Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Print Preview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Page Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Print Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Connection Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
EC-gfxProgram Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Home ribbon. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Auto increment (ECP & ECL Series and EBC Series controllers only) . . . . . . . . . . . . . . . . . 65
Auto increment (ECY Series controllers only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Project buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Text documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Project Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Debugging buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Resources button (ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Drawing ribbon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Alignment button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Distribution buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Size button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
View ribbon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Zoom buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Show/Hide buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Panes button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Tools ribbon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Tools button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Controller connection and debugging status indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Programming sheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Resizing the programming sheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Tabs to access programming sheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Adding another document to the programming sheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Reopening a closed document. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Reordering documents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Removing a document from the programming sheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
EC-gfxProgram 1
Table of Contents
Shortcuts to switch between documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Showing multiple documents in the same view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Thumbnail. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Utility panes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
Pane dynamics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
Opening and closing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Auto-hiding and pinning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Moving and docking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Pane types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Toolbox. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Code Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Project Explorer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Output. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Error List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Resource Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Search Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Task Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Watch List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Favorites List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
CHAPTER 4
Resources Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
Adding resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Renumbering/Swapping Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Configuration Variable Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
Resources Summary view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Configuring properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Blocks that are configured in the Resources Configuration window. . . . . . . . . . . . . . . . . . 171
Configuring a resource block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
Trending (ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
ENVYSION Data Tree (ECY Series). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Adding resources to the ENVYSION Data Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Cleaning up unused resources in a project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
CHAPTER 5
Using EC-gfxProgram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Dragging and dropping blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Connecting blocks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
Connection rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
Connection types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
Build sequencing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
RAM usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Data processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Data types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
ECP Series controllers data processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Data type conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
Persistent values (ECP Series controllers). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
ECL, ECB & ECY Series controller data processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Out-of-Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
Data type conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
2 EC-gfxProgram
Table of Contents
Persistent values (ECL, ECB & ECY Series controllers) . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
Digital block inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
Numeric data types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
Significant digits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
Reliability property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
LONWORKS network description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
Network variable object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
Configuration properties (CPs and NCIs) object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
Communication services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
Priority levels in LONWORKS (ECL Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
BACnet objects, services, and data priority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
Object and properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
Commandable object priority array levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
How commandable object priority levels work . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Edit priority values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Relinquish default. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
CHAPTER 6
Block Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Overview of block objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
Block objects description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
Collapsed blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
Common block properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
ByteLight. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
ByteLight Group (ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
Comparators. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
Between . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
Equal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
Greater or Equal. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
Greater Than . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
Is Null (ECL, ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
Less or Equal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
Less Than . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
Not Equal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
Constants and variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
Internal constant. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
Internal variable (ECL, ECB & ECY Series). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
Null value (ECL, ECB & ECY Series). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
ECP Series specific blocks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
Constant Enum (ECP Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
Constant Numeric (ECP Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
Variable Enum (ECP Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Variable Numeric (ECP Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
ECL Series specific constant and variable blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
Boolean Constant (ECL Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
Boolean Value (ECL Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
Enum Constant (ECL Series). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
Enum Value (ECL Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
Numeric Constant (ECL Series). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
Numeric Value (ECL Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
Setpoint Constant (ECL Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
ECB & ECY Series specific blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
EC-gfxProgram 3
Table of Contents
Commandable and non-commandable values (ECB & ECY Series controllers) . . . . . . . . 279
Constants and variables supported by ECB & ECY Series controllers . . . . . . . . . . . . . . . 280
Analog Value (ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
Binary Value (ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
Multi State Value (ECB & ECY Series). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
Custom . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
Creating project code in a custom document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
Adding exported inputs and exported outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
About exported input and output formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
Making an exported input automatic, optional, or mandatory . . . . . . . . . . . . . . . . . . . . . . . 296
Show in Containing Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
Converting selected project code in a custom block/conditional custom block shortcut . . 298
Conditional Custom Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
Custom block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
For Loop (ECL, ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
Loop Info (ECL, ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
Color Decoder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
Color Encoder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
Count Down . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
Count Up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
Device Info (ECL Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
Device Info (ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
Digital Fault. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
Dual Pid (ECP Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
Falling Edge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
Hysteresis. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
Latch. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335
Lcd Screen (ECL, ECB & ECY Series). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337
Limit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
Linear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
Notification Class (ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352
Numeric Fault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354
Pid (ECP Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357
Pid Loop (ECL Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363
Pid Loop (ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375
Ramp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384
Rising Edge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388
Startup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389
Toggle. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391
Weather (ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394
Generics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399
Generic Analog Value (ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400
Generic Binary Value (ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402
Generic Boolean Value (ECL Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405
Generic ComSensor Condition (ECL, ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . 406
Generic ComSensor Value (ECL, ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . 407
Generic Internal Variable (ECL, ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
Generic Boolean Constant (ECL Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409
Generic Enum Constant (ECL Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409
Generic Enum Value (ECL Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410
Generic Floating Output (ECL Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412
Generic Floating Output (ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413
Generic Hardware Input (ECL Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414
4 EC-gfxProgram
Table of Contents
Generic Hardware Input (ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417
Generic Hardware Output (ECL Series). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420
Generic Hardware Output (ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422
Generic Network Value (ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426
Generic Network Variable Input (ECL Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428
Generic Network Variable Output (ECL Series). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432
Generic Numeric Constant (ECL Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435
Generic nLight Channel (ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436
Generic Multi State Value (ECB & ECY Series). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438
Generic Numeric Value (ECL Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440
Generic Pid Loop (ECL, ECB & ECY Series). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442
Generic Timer (ECL Series). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443
Generic Timer (ECB & ECY Series). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444
HVAC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445
Analog Stages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446
Digital Stages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449
Digital Stages + Delay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452
Optimum Start/Stop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454
Smart Stages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459
Stages With Modulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462
Thermostat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464
Inputs and Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469
BLE Room Device (ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471
BLE Room Device (ECY-STAT Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499
ComSensor (ECL Series). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523
ComSensor (ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
ComSensor Condition (ECL, ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 596
ComSensor Condition Selector (ECL, ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . 597
ComSensor Value (ECL, ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598
ComSensor Value Selector (ECL, ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
EnOcean Device (ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600
Floating Output (ECP Series). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 608
Floating Output (ECL Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615
Floating Output (ECB & ECY Series). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625
Hardware Input (ECP Series). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 637
Hardware Input (ECL Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 651
Hardware Input (ECB & ECY Series). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 676
Hardware Output (ECP Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 702
Hardware Output (ECL Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 707
Hardware Output (ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 721
Led Output (ECP Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 735
Light Output (ECL Series expansion modules) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 736
Light Output (ECB & ECY Series expansion modules) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 741
Light Sunblind Input (ECL Series expansion modules) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 747
Light Sunblind Input (ECB & ECY Series expansion modules) . . . . . . . . . . . . . . . . . . . . . . 749
M-Bus Device (ECY Series). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 751
Modbus Device (ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 764
Multi Sensor (ECL Series expansion module) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 773
Multi Sensor (ECB & ECY Series expansion modules) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 780
Network Value (ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 787
Discovering Remote Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 800
Network Variable Input (ECP Series). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 806
Network Variable Input (ECL Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 812
Network Variable Output (ECP Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 824
EC-gfxProgram 5
Table of Contents
Network Variable Output (ECL Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 827
SmartSensor Module (ECP Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 833
Space Comfort Controller (ECL Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 838
Subnet Extension (ECL Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 841
Subnet Extension (ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 852
Sunblind Output (ECL Series expansion module) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 861
Sunblind Output (ECB & ECY Series expansion module) . . . . . . . . . . . . . . . . . . . . . . . . . 878
Wireless Module (ECP Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 893
Wireless Sensor (ECL Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 899
Wireless Sensor (ECB Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 906
LONMARK Objects (ECL Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 915
Unit Heater Profile LONMARK Object #8550 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 916
Wall Unit Profile LONMARK Object #8540 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 920
Roof Top Unit Profile LONMARK Object #8504 and Space Comfort Controller AHU Profile LON-
MARK Object #8508 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 926
Hardwired Gas Detection Profile LONMARK Object #4310 . . . . . . . . . . . . . . . . . . . . . . . . . 929
Hardwired Fire Alarm Profile LONMARK Object #4311 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 931
Hardwired Reticulation Profile LONMARK Object #4312 . . . . . . . . . . . . . . . . . . . . . . . . . . . 933
Hardwired Full Ventilation Profile LONMARK Object #4313. . . . . . . . . . . . . . . . . . . . . . . . . 935
Hardwired Safety Instrumented System (SIS) Profile LONMARK Object #4314 . . . . . . . . . 937
Logic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 941
And . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 942
Multiplexer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 943
Not . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 945
Or . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 946
Selector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 947
Switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 950
Xor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 951
Logic (Binary) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 953
Bitwise And (ECL, ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 954
Bitwise Or (ECL, ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 955
Left Bit Shift (ECL, ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 956
Right Bit Shift (ECL, ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 957
Math . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 958
Avoid Overflow and Underflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 959
Entering Floating-Point numbers and Null values in a dialog box . . . . . . . . . . . . . . . . . . . 959
Absolute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 960
Add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 961
Average . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 962
Cosine (ECL, ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 964
Divide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 965
Inverse Cosine (ECL, ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 966
Inverse Sine (ECL, ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 967
Inverse Tangent (ECL, ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 968
Ln (ECL, ECB & ECY Series). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 969
Log (ECL, ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 970
Maximum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 971
Min/Max/Average . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 973
Minimum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 975
Modulus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 976
MulDiv. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 978
Multiply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 979
Power (ECL, ECB & ECY Series). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 980
Sine (ECL, ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 981
6 EC-gfxProgram
Table of Contents
Square Root . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 982
Subtract . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 984
Summation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 985
Tangent (ECL, ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 987
nLight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 989
nLight Channel (ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 989
nLight Channel Calculator (ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 999
nLight Device (ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1002
nLight Profile (ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1014
Psychrometric. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1018
Actual Vapor Pressure (ECL, ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1019
Air Density (ECL, ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1020
Dew Point (ECL, ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1022
Enthalpy (ECL, ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1024
Heat Index (ECL, ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1026
Humidity Ratio (ECL, ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1027
Relative Humidity (ECL, ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1029
Saturation Vapor Pressure (ECL, ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . 1031
Wet Bulb (ECL, ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1032
SNVT Conversions (ECP Series specific blocks) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1034
SNVT_scene Demux (ECP Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1035
SNVT_scene Mux (ECP Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1037
SNVT_state Demux (ECP Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1038
SNVT_state Mux (ECP Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1040
SNVT_switch Demux (ECP Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1042
SNVT_switch Mux (ECP Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1043
Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1044
Calendar (ECL Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1045
Calendar (ECB & ECY Series). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1055
Min Off Time. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1069
Min On Off Time. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1071
Min On Time. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1073
Real Time Clock (ECP Series). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1077
Real Time Clock (ECL Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1078
Real Time Clock (ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1081
Schedule (ECP Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1089
Schedule (ECL Series). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1091
Schedule (ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1106
Start Delay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1121
Start Stop Delay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1124
Stop Delay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1126
Timer (ECP Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1128
Timer (ECL Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1129
Timer (ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1131
Tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1134
Live Trend Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1135
Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1141
Reference Hub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1142
Reference Target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1143
Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1144
VAV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1147
Actuator Control (ECL Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1148
Actuator Control (ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1150
Damper Control (ECP Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1152
EC-gfxProgram 7
Table of Contents
Diff Pressure (ECL Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1157
Diff Pressure (ECB Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1158
VAV Differential Pressure (ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1159
Flow Calculation (ECL Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1160
Flow Calculation (ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1163
Flow Sensor (ECP Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1166
Internal Actuator (ECL Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1176
Internal Actuator (ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1179
CHAPTER 7
Block Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1183
Advanced configuration windows overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1184
Opening a block action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1185
Set Constant (ECL Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1186
Set Value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1187
View content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1188
Format Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1189
Creating and using enumerations (8-Bit) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1192
Format editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1192
Setting an enumeration range (ECY Series controllers). . . . . . . . . . . . . . . . . . . . . . . . . . 1196
Importing and exporting enumerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1197
Creating and using enumerations (ECP Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1197
Creating and using enumerations (ECL Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1199
Format editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1200
Setting an enumeration range . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1202
Importing and exporting enumerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1202
Enumeration Picker (ECP & ECL Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1203
Format Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1204
Edit Value (ECP Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1206
Edit Mode and Value (ECP Series). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1206
Emergency override and emergency auto (ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . 1207
Override and auto . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1208
Find All References (ECL, ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1211
Copy From . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1211
Configure Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1212
Show/Hide Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1215
Set and reset timer (ECY series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1217
Replacing blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1218
Network Properties Configuration window (ECL, ECB & ECY Series) . . . . . . . . . . . . . . . . . . 1218
Network properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1219
BACnet network properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1222
Change Type (ECP & ECL Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1224
Alarms (ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1227
Dynamic alarm activation thresholds adjust . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1229
AlarmInhibit input (ECY Series controllers) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1230
Binary value block and digital input alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1231
Digital and pulse hardware output alarm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1233
Analog/Pulse input alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1235
Multi state value block and multilevel input alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1237
Notification message configuration (ECY Series controllers) . . . . . . . . . . . . . . . . . . . . . . 1239
Configuring alarm recipients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1241
BACnet notification class configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1241
About alarms with the EC-Net platform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1243
8 EC-gfxProgram
Table of Contents
Configuring a notification class to send email alerts (ECY Series) . . . . . . . . . . . . . . . . . . 1244
Viewing a trend log (ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1251
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1252
CHAPTER 8
The Toolbox Builder Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1253
Toolbox tool overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1254
Overview of the toolbox builder user interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1255
Toolbox builder main menu toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1256
Using toolboxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1258
Creating a new toolbox. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1260
Creating a new toolbox with the toolbox builder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1262
Toolbox troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1268
CHAPTER 9
Calendar and Schedule Tool (ECL, ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1269
Using schedules and calendars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1270
Calendar and schedules configuration overview (ECL, ECB & ECY Series) . . . . . . . . . . . . . . 1271
Getting started on the calendar and schedule tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1272
Overview of the calendar and schedule user interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1275
File menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1277
Home ribbon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1280
Current view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1284
Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1285
Schedule/Calendar instance selector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1286
About the calendar and scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1287
Configuring a schedule (calendar and schedule tool) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1290
Configuring a calendar (Calendar and Schedule tool) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1303
CHAPTER 10
Scheduler Configuration Tool (ECP Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1309
Quick start guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1310
Calendar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1313
Week schedules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1315
Special day schedules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1318
Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1320
Data Manage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1327
Object Manage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1329
Message Logger. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1331
CHAPTER 11
Real Time Clock Configuration Tool (ECP Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1333
Daylight Saving Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1334
Object Manage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1337
CHAPTER 12
EC-Net Platform Support Pack Features for ECP & ECL Series Controllers . . . . . . . . . . . . . . . . . 1339
Typical controller internal points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1340
Automatic generation of control points from EC-gfxProgram code . . . . . . . . . . . . . . . . . . . . . 1345
Manual creation of internal control points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1350
EC-gfxProgram 9
Table of Contents
Internal control points actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1359
Linking, building, and trimming LONWORKS component objects in EC-Net . . . . . . . . . . . . . . . 1362
Linking the LONWORKS component objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1362
Removing the binding between two controllers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1367
Trimming LONWORKS component objects in EC-Net . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1369
Building LONWORKS component objects in EC-Net . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1369
Sending weather information to a controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1371
CHAPTER 13
EC-Net Platform Support Pack Features for ECB & ECY Series Controllers . . . . . . . . . . . . . . . . . 1385
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1386
Automatic generation of control points from EC-gfxProgram code . . . . . . . . . . . . . . . . . . . . . 1387
Hide/Show point actions (ECB & ECY Series) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1390
Configuring weather information for controllers with an operator interface. . . . . . . . . . . . . . . 1391
CHAPTER 14
Configuration Assistant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1399
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1400
Typical configuration assistant window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1401
Configuration Assistant toolbar. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1402
Configuration Assistant menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1402
Configuration Assistant configuration parameters and tabs . . . . . . . . . . . . . . . . . . . . . . . 1403
Steps to Create a Configuration Assistant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1403
Creating a configuration variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1404
Creating a configuration variable directly from a configuration parameter . . . . . . . . . . . . 1405
Creating a configuration variable to later associate it with a configuration parameter . . . 1406
Configuring a configuration variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1408
Once a binding has been made . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1415
Creating live configuration variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1417
Creating a live configuration variable directly from a resource block . . . . . . . . . . . . . . . . 1417
Creating a live configuration variable to later associate it with a resource block . . . . . . . 1418
Configuring a live configuration variable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1419
Creating a configuration assistant sheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1427
Configuration assistant ribbon. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1428
Creating the configuration assistant sheet layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1430
Configuration assistant configuration parameters and tabs . . . . . . . . . . . . . . . . . . . . . . . 1430
Setting a variable’s presentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1434
Writing a Javascript expression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1437
Adding a logo to the Configuration Assistant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1441
Setting the Configuration Assistant’s properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1442
Validating the Configuration Assistant sheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1443
Reorder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1443
Configuration Assistant scheme management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1444
Created schemes appear in the configuration assistant synchronization. . . . . . . . . . . . . 1446
Download to multiple devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1447
Initiating Configuration Assistant synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1447
CHAPTER 15
EC-gfxProgram vs Line-by-Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1449
Example description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1450
Wiring diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1452
Line-by-line code. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1453
10 EC-gfxProgram
Table of Contents
Defining the Room Final Setpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1453
Schedule Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1453
Defining Room Low Limit and High Limit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1453
Start and Stop of the Fan Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1453
Defining the Heating and Cooling Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1454
Variable of Cooling Stages and Dampers Variables Equation. . . . . . . . . . . . . . . . . . . . . . 1454
Heating and Cooling Stages Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1455
EC-gfxProgram code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1458
CHAPTER 16
Air Physics Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1461
Air physics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1462
CHAPTER 17
Tuning a PID Loop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1465
Tuning a PID loop. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1466
CHAPTER 18
Supported EnOcean Wireless Sensor Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1469
Supported Wireless Receivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1470
Supported Wireless Sensor Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1471
CHAPTER 19
Thermistor Resistance Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1477
10kilohm Type II Thermistor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1478
10kilohm Type III Thermistor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1485
Platinum RTD Sensor: Pt1000 (1kilohm) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1492
Nickel RTD Sensor: Ni1000 (1kilohm) @ 0ºC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1499
Nickel RTD Sensor: Ni1000 (1kilohm) @ 21ºC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1506
EC-gfxProgram 11
Table of Contents
12 EC-gfxProgram
Introduction
CHAPTER 1
Introduction
This chapter introduces EC-gfxProgram’s Graphical Programming Interface.
Is also summarizes its features, and provides an overview of the user guide.
Topics
Introduction to EC-gfxProgram
About this user guide
Conventions used in this document
EC-gfxProgram 13
Introduction to EC-gfxProgram
The Graphical Programming Interface makes Building Automation System
(BAS) programming effortless by providing users with the building blocks nec-
essary to meet their needs. By “dragging and dropping” a few block objects
from the program’s vast library and connecting them with a simple “click, drag,
and release” technique, users can quickly and easily assemble a customized
program.
EC-gfxProgram is designed for programming compatible controllers, and sup-
ports the configuration of a line of wireless battery-less devices as well as
Communicating Sensors.
EC-gfxProgram can be used by LNS®-based software or multi-protocol plat-
form software supporting LONWORKS® and BACnet® devices and powered by
the EC-Net Framework®.
EC-gfxProgram can be launched remotely through a web-browser when used
with an embedded EC-Net Framework.
Developed with Windows® User Interface (UI) standards using Visual
Basic.Net®, EC-gfxProgram provides users an intuitive programming environ-
ment. With dynamic menu windows that can be moved, docked, and hidden,
users can make this tool their own. The programming area is where users can
“illustrate” their project code and when several codes need to be managed,
new programming sheets can always be created and layered relative to each
other. Coupled with a standard ribbon layout along with a project explorer
pane, users have all the tools needed to keep their codes well-organized and
accessible.
EC-gfxProgram’s block object Toolbox supplies users with an ample collection
of components and functions that can be used to create simple and more
complex control sequences. If users wish to design innovative codes, they
can easily create their own custom blocks. Block objects not only make cod-
ing clean and easy, but they also reduce basic errors that may arise when
writing project code conventionally. Furthermore, EC-gfxProgram’s smart
code compiling, Error List pane, and live debugger enable users to execute
their codes, view input/output values, and troubleshoot errors in real-time.
System performance can be charted with the live trend pane to monitor the
effect of tuning of a PID loop has on a system, for example.
EC-gfxProgram supports powerful features that allow for lean, efficient, and
cost effective system design. For example, the For Loop can be used to auto-
mate the comparison of multiple network values between each other at once,
to find the average, highest/lowest value, etc. Schedules can be used to save
energy and resources, and can also be bound to receive information from a
BAS for optimum start sequencing. Many other features including a real-time
clock, persistent values, and PID loops, make EC-gfxProgram a complete
BAS programming package.
14 EC-gfxProgram
Introduction
About this user guide
Purpose of the This user guide is intended to provide information and instructions on using
user guide EC-gfxProgram to program controllers managed by a LNS-based network
management tool or with EC-Net. For IP controllers, a network management
tool is optional. Information on installing and configuring EC-gfxProgram is
found in the Getting Started User Guide. This guide is not intended to instruct
the user on how to use the network management tool software or programma-
ble controllers and therefore it is assumed that the user already has prior
knowledge of said software and controllers.
WARNING: This user guide does not explain hardware installation or how to
wire a controller. Please refer to individual device installation
guides for specific hardware installation information.
This user guide does not provide and does not intend to provide
instructions for safe wiring practices. It is the user’s responsibility
to adhere to the safety codes, safe wiring guidelines and safe
working practices of the local area. This user guide does not
intend to provide all the information and knowledge of an experi-
enced HVAC technician or engineer.
Context- Help is context sensitive. Select a block and press F1 on the keyboard to go
sensitive help directly to the documentation about the block. To access the regular help sys-
tem, press Ctrl+F1 on the keyboard.
Intended This user guide is intended for system designers, integrators, and field techni-
audience cians who have experience with control systems. It is recommended that any-
one installing and configuring the devices specified in this user guide have
prior training in the usage of these devices.
EC-gfxProgram 15
Conventions used in this document
Notes NOTE: This is an example of Note text. Provides a time-saving tip or a refer-
ence to associated information of interest.
Warnings WARNING: This is an example of Warning text, which draws your attention to
an important safety concern or to the risk that a given action, if
done improperly, might have a drastic effect on the device, equip-
ment, and/or network.
Conventions for
using the mouse
Convention Description
Click the item.
Click, drag, and release the item as shown. In this
example, in a left-to-right motion.
Acronyms and
abbreviations
used in this Acronym Definition
document
AI Analog Imput
AO Analog Output
AV Analog Value
APDU Application layer Protocol Data unit
B-AAC BACnet Advanced Application Controller
BACnet Building Automation and Control Networking Protocol
BAS Building Automation System
B-ASC BACnet Application Specific Controller
BC Boolean Constant
B-BC BACnet Building Controller
BI Binary Input / Boolean Input (BACnet / LonWorks)
BIBBS BACNet Interoperability Building Blocks
BMS Building Management System
BO Binary Output / Boolean Output (BACnet / LonWorks)
B-OWS BACnet Operator Workstation Software
BV Binary Value / Boolean Value (BACnet / LonWorks)
16 EC-gfxProgram
Introduction
Acronym Definition
CCW Counter-Clockwise
CFM Cubic Feet per Minute
COV Change of Value
CP Configuration Property
CSV Comma Separated Value
CW Clockwise
DALI Digital Addressable Lighting Interface
DRF Device Resource File
EC Enumeration Constant
EEP EnOcean Equipment Profiles
EEPROM Electronically Erasable Programmable Read-Only
Memory
EV Enumeration Variable
GD Derivable Gain
GI Integral Gain
GP Proportional Gain
HOA Hand-Off-Automatic
HMI Human Machine Interface
HVAC Heating, Ventilation, and Air Conditioning
HWI Hardware Input
HWO Hardware Output
ID Identity
IO Input/Output
ISP Internet Service Provider
LCD Liquid Crystal Display
LED Light Emitting Diode
LON Local Operating Network
LNS LonWorks Network Services
MAC Media Access Control
MSI Multi State Input
MS/TP Master-Slave/Token-Passing
EC-gfxProgram 17
Acronym Definition
MSV Multi State Value
NC Numeric Constant
NCI Network Constant Input
NV Network Variable / Numeric Value
NVI Network Variable Input
NVO Network Variable Output
OAT Outdoor Air Temperature
PB Proportional Band
PC Personal Computer
PD Differential Pressure
PF Pilot Factor
PI Proportional Integral Control
PID Proportional Integral Derivative Control
PIR Passive Infrared Sensor
PTU Powered Terminal Unit
PWM Pulse Width Modulation
RAM Random Access Memory
RH Relative Humidity
RSSI Received Signal Strength Indication
RTC Real Time Clock
SCPT Standard Configuration Parameter Type
SI International System of Units (the Metric System)
SNVT Standard Network Variable Type
SP Setpoint
TD Derivative Time
TI Integral Time
UCPT User Configuration Property Type
UI User Interface
UNVT User Network Variable Type
UTC Coordinated Universal Time
VAV Variable Air Volume
18 EC-gfxProgram
Introduction
Acronym Definition
VVT Variable Volume Temperature
ZIP Compressed file extension name
EC-gfxProgram 19
20 EC-gfxProgram
Quick Start Guide
CHAPTER 2
Quick Start Guide
This Quick Start Guide provides a brief overview of how EC-gfxProgram
works. Its purpose is to help you get accustomed to some of the typical proce-
dures that are necessary to know when working with EC-gfxProgram.
Through a simple example, this guide broadly covers the process of creating
a new project, developing a basic control sequence, synchronizing a project
with a device, and debugging a project.
For the purposes of this guide, it is already assumed that the EC-gfxProgram
software has been installed, connected to a device, and launched.
Topics
Creating a new project
Developing a control sequence
Synchronizing a project with a device
Debugging a project
EC-gfxProgram 21
Creating a new project
When launched from a blank controller, EC-gfxProgram displays an empty
Programming sheet, where the control sequence will be assembled.
Figure 1: New project
To set up the new project:
1. Open the Project Explorer pane by clicking Project Explorer on the edge
of the programming sheet or in the View ribbon, or pressing F6 on the
keyboard.
2. Select a project.
Figure 2: Project explorer pane
22 EC-gfxProgram
Quick Start Guide
3. Open the Properties Pane by pressing F4 on the keyboard and enter
information about the project.
a. Select the (Name) field and enter the name of the project.
b. Select the MeasurementSystem field and indicate whether the proj-
ect is in Metric or US units. This affects values and units within the
current project.
NOTE: EC-gfxProgram has a separate measurement system that only affects
the tool. This system can be configured in the EC-gfxProgram Options
window, opened from the File menu.
When EC-gfxProgram is first started, its measurement system is taken
from the host PC. Similarly, when a new project is created, the project
measurement system is taken from EC-gfxProgram.
Figure 3: Project properties configuration (options vary according to controller
models)
c. Select the Author, ControllerType, Description, Location, and/or
Version fields to enter the name of the author of the project, the type
of controller for which the project is created, a description of the proj-
ect, the location of the device, and the version number of the project.
EC-gfxProgram 23
Developing a control sequence
This section uses a simple free cooling control sequence as an example of
how to create a control sequence. This example consists of:
• an outdoor air temperature sensor (Hardware Input 1 block),
• a comparator (Less or Equal block),
• a free cooling setpoint (Internal constant block),
• and a fresh air damper actuator (Hardware Output 1 block).
To create a control sequence:
1. Add a Hardware Input block
2. Add a Less Or Equal block
3. Add a Hardware Output block
Add a Hardware 1. Open the Toolbox pane and select the Inputs and Outputs category.
Input block
1. Drag and drop the Hardware Input block on the programming sheet (see
Dragging and dropping blocks).
Figure 4: Dragging and dropping the Hardware Input block
24 EC-gfxProgram
Quick Start Guide
2. With the Hardware Input block selected, enter the name of the block in
the Properties pane.
Figure 5: Naming Hardware Input 1 block
3. Resize the block to fit its name by clicking and dragging a resize handle
(the red dot on either side of the block).
Figure 6: Resizing a block
4. Open the Resource Configuration window for the Hardware Input block by
selecting the Configure link in the Properties pane, or right-clicking and
selecting Configure in the drop-down menu.
Figure 7: Opening the Hardware Input Configuration window
EC-gfxProgram 25
5. Configure a standard 10kΩ type II thermistor with a range of 32°F-122°F.
Figure 8: Configuring hardware input block (options vary according to controller
models)
6. For ECL series controllers, select the SNVT_temp_p network type. Click
OK.
Figure 9: Changing the network variable type
Add a Less Or 1. From the Toolbox, drag and drop the Less Or Equal block (under Com-
Equal block parators) on the programing sheet.
2. Open the Configure Ports window by right-clicking the Less Or Equal
block and selecting Configure Ports.
26 EC-gfxProgram
Quick Start Guide
3. Select the Output port and click Format.
a. Select the Boolean format.
i. Set the True text to Economizer.
ii. Set the False text to Makeup.
Figure 10: Formatting the output port of the Less or Equal block
4. Connect the two blocks on the programming sheet by clicking on the Out-
put port of the Hardware Input block, dragging the connector, and
releasing it once it locks on the Input port of the Less Or Equal block
(see Simple connection).
Figure 11: Connecting the Hardware Input block to the Less Or Equal block
5. Add an Internal Constant block to the programming sheet by right-click-
ing the linkable part of the Input2 port (the cursor changes to the connec-
tion symbol ) on the Less Or Equal block and selecting Link To from
the drop-down menu.
Figure 12: Adding an Internal Constant block
EC-gfxProgram 27
6. Give the Internal Constant block a value of 70 in the value field of the
Link To Internal Constant window or of the block’s Properties pane.
Figure 13: Entering the value of the internal constant block
7. Open the Configure Ports window by right-clicking the Internal Con-
stant block and selecting Configure Ports.
Figure 14: Formatting the output port of the Internal Constant block
8. Select the Output port and click Format.
a. Select the Engeneering Units option.
b. Select ºF for the Units.
NOTE: When a controller is equipped with an operator interface or is con-
nected to an ECx-Display, the format must be correctly configured for
28 EC-gfxProgram
Quick Start Guide
the value’s unit to be correctly shown on the LCD screen. See LCD
interface supported units.
Figure 15: Selecting the units for a port
Add a Hardware 1. From the Toolbox, add a Hardware Output block to the programming
Output block sheet.
2. Open the Resource Configuration window for the hardware output block
by selecting the Configure link in the Properties pane, or right-clicking
and selecting Configure in the drop-down menu.
3. Select Digital in the Signal type field and Inactive in the Default field.
Figure 16: Configuring the Hardware Output block
EC-gfxProgram 29
4. Monitor the Output of the Hardware Output block by right-clicking the
output port and selecting Link To > Monitor from the drop-down menu.
Figure 17: Adding a Monitor block
5. Connect the Input of the Hardware Output block to the Output port of
the Less Or Equal block.
Figure 18: Completed control sequence
30 EC-gfxProgram
Quick Start Guide
Synchronizing a project with a device
Once the control sequence is created, it must be synchronized with the device
to be put in effect. Synchronization builds the code from the control sequence
and sends the code to the device.
NOTE: For an explanation of all the Project Synchronization window options,
see Project Synchronization.
To synchronize a project with a device:
1. Click on the Home ribbon or press F9 on the keyboard.
2. Select Download to Device, and set the synchronization options as
shown in the image below. For more information, see Download to device
and download to multiple devices synchronization options.
Figure 19: Synchronization options (may vary according to controller model)
3. Click Next.
EC-gfxProgram 31
NOTE: When synchronizing for the first time, always select bot the Reinitial-
ize non-controller specific values and constants and Reinitialize
controller specific values and constants options. See also Control-
ler specific values and device synchronization options (ECL, ECB &
ECY Series).
4. Allow the download to complete.
Figure 20: Synchronization progress
5. Click Next and then Finish.
32 EC-gfxProgram
Quick Start Guide
As your project is synchronized with the device, information about your code
can be viewed in various panes at the bottom of EC-gfxProgram.
1. To open each pane, click the corresponding tab on the bottom edge of the
programming sheet or the corresponding button in the View ribbon.
The Output pane shows the progress of the build of the control sequence and
displays the steps involved.
Figure 21: The Output pane
The Statistics pane presents the memory used, the compilation time, and the
resources allocated to the build by the device.
Figure 22: The Statistics pane
EC-gfxProgram 33
The Error List pane highlights any errors that may have occurred in the
assembly of the sequence.
Figure 23: Error List pane
To highlight an error in the programming sheet:
1. Double-click the error message.
A tooltip points to the input, output, or block that is the source of the error
on the programming sheet.
Figure 24: Highlighted error
The Resource Viewer pane displays information about all the inputs, outputs,
constants, and variables available in the device.
Figure 25: The pane (options vary according to controller model)
34 EC-gfxProgram
Quick Start Guide
Debugging a project
Once the control sequence is synchronized with the device, the debugging
can be run and the Present Values viewed. This is useful to view the execu-
tion of the sequence and to spot any anomalies or errors in the control logic.
Figure 26: Control sequence to debug
To start debugging the control sequence when both the LNS/Server and Con-
troller Connection Status Indicators are green (see Controller Connection and
Debugging Status Indicators):
1. Click in the Debugging group of the Home ribbon or press F5 on the
keyboard.
The debugging activity status indicators should be flashing green. For
more information, see Controller connection and debugging status indica-
tors.
During debugging, blocks can be moved around on the programming sheet;
however you cannot add or delete a block. If you change the relative order of
code on the programming sheet, you may have to re-synchronize the project
with the device before you can debug the code again.
WARNING: When the project is debugging, it is using some network band-
width and as a result may affect network communication perfor-
mance. As a precaution, no more than two devices should be
debugged simultaneously.
ECL, ECB & ECY Series controllers send debug values only
every few code execution cycles so as to reduce the amount of
network bandwidth necessary for debugging. On networks that
carry a lot of traffic, debugging may result in irregular updates to
debug values and poor overall network performance.
EC-gfxProgram 35
36 EC-gfxProgram
User Interface Overview
CHAPTER 3
User Interface Overview
This chapter describes the EC-gfxProgram user interface, including the differ-
ent ribbons and utility panes.
Topics
Overview of the user interface
Ribbons
Project Synchronization
Drawing ribbon
View ribbon
Tools ribbon
Help
Controller connection and debugging status indicators
Shortcuts
Programming sheet
Utility panes
EC-gfxProgram 37
Overview of the user interface
The EC-gfxProgram user interface (UI) was developed to follow Windows UI
standards. It employs a number of easy-to-use ribbons, and the utility panes
can be moved, docked, and/or hidden to suit your needs.
Figure 27: The EC-gfxProgram user interface
Item Description Item Description
1 Programming sheet 8 Resource Viewer and
Favorites List
2 Ribbons 9 Search Results
3 Toolbox 10 Watch List
4 Code Library 11 Controller connection and
debugging status indicators
5 Output 12 Task Viewer
6 Error List 13 Project Explorer
7 Statistics 14 Properties
38 EC-gfxProgram
User Interface Overview
Ribbons
The ribbons are situated at the top of the EC-gfxProgram UI. They contain the
commands and options that are needed to manage and use EC-gfxProgram.
File menu
This menu contains the essential functions for starting, saving, and managing
a project. It also provides access to the EC-gfxProgram Options.
Figure 28: The File menu
Parameter Description
Recent Projects Displays the most recently opened projects. To open a
project from the list, click a project from the list. Click
Clear List to empty the list.
New Project Starts a new project.
Close Project Closes the current document of the current project. The
current document can also be closed by pressing
Ctrl+F4 on the keyboard. Closing a document does not
modify or remove the code. The project doesn’t need to
be saved before closing a document. A document is a
view on top of the actual document that is managed by
the project.
The document can be reopened through the Project
Explorer pane.
EC-gfxProgram 39
Parameter Description
Save Save Project saves the current project in the device’s
database. In the case of an ECY Series controller,
saves the current project in the controller itself.
The current project can also be saved by pressing
Ctrl+S on the keyboard.
NOTE: The current project only pertains to the device
associated with the project. When EC-gfxPro-
gram is started from the same device, the proj-
ect associated with that device appears.
Save to File exports the project to the PC as a project
file. This opens the Save As window.
NOTE: EC-gfxProgram versions 4.2 or higher save a
project in a new file format that should not be
opened by versions 4.1 or earlier. Since proj-
ects cannot be saved in the old file format,
always upgrade all PCs used to program con-
trollers to the latest version of EC-gfxProgram.
The advantage of this new file format is that once the
project has been saved in the building controller’s
database, the file can later be copied from the building
controller and opened by using the Import From File
feature (see below). Also, the format makes more
efficient use of storage as the file is more compact.
For ECL Series and ECB Series Controllers only: The
project can be saved to the device by selecting
Backup To Device. This creates a backup of the
project in the device that can be retrieved in event the
database is lost. This should always be done once the
project is complete (the download to the device can
take a few minutes to complete).
40 EC-gfxProgram
User Interface Overview
Parameter Description
Import (ECP & Imports a project in EC-gfxProgram. An existing project
ECL Series and can be imported from one of two locations:
ECB Series
• If a project is saved on the PC as a project file
controllers
(from any EC-gfxProgram version), it can be
imported by selecting Import > Import From File
or by pressing Ctrl+O on the keyboard. The Open
window opens.
• If a project is saved in the device’s backup mem-
ory, it can be imported by selecting Import >
Import From Device. This is useful to recover a
project when you no longer have the project code
for the device on your PC. The project must have
previously been backed up with Export Project,
Export To Device (see below), or through Project
Synchronization when Backup code to device is
selected.
After importing a project, the project code and
configuration must be synchronized with the device
before the project code can be executed.
NOTE: When importing a project code that was created
for another controller, blocks that have no direct
equivalent in the current programming environ-
ment are flagged with “The object “[object
name]” is not supported by the current
device.” errors in the Error List. If this occurs,
see Object not supported by the current device.
Convert Project Converts a project to the current controller type, as
best as possible. When project code is opened from a
different type of controller, this applies conversion rules
to currently unsupported blocks to exchange them for
similar blocks that are supported by the current
controller model. This facilitates project code reuse
from other controller models. See Object not supported
by the current device.
EC-gfxProgram 41
Parameter Description
Print Print or Ctrl+P on the keyboard opens the Print
window.
Print Resource Report prints a detailed report of the
resources used in the current project. See Resource
Report Print Options.
NOTE: The Resource Viewer is printed with the con-
tent shown (visible content?). To fetch values
from the network and override the ones in the
project, click Refresh All or Refresh Selected in
the resource viewer to ensure that data is up-
to-date.
Print Preview opens a preview window that allows you
to make changes to pages before printing. See Print
Preview.
Page Setup is used to configure the page size and
printing options. See Page Setup.
Connect To Opens a controller connected to a building controller so
Server it can be configured. This opens the Connect To
Server window. For more information, press F1 on the
keyboard while this window is open. See also
Connection Methods below.
EC-gfxProgram The Options window is used to define application
Options defaults, such as the measurement system, whether
projects are saved automatically when they are
downloaded to a device, etc. See EC-gfxProgram
Options.
Exit Exits EC-gfxProgram. If there is any unsaved work in
the project, a prompt window appears to ask if the
project should be saved.
Object not When importing a project code that was created from an incompatible version
supported by the (for example, opening project code originally created for a ECP Series con-
current device troller in a ECL Series controller), some blocks have no direct equivalent in
the current programming environment. These blocks are flagged with “The
object “[object name]” is not supported by the current device.” errors in
the error list. These errors can be solved as follows:
1. To automatically convert incompatible blocks, use the option File > Con-
vert Project.
Blocks that could not automatically be converted to an equivalent in the
new controller model remain flagged as unsupported by the current
device. In that case:
• Double-click the error to locate the unsupported blocks, and delete
them.
42 EC-gfxProgram
User Interface Overview
• Create new project code adapted to the current programming envi-
ronment to replace the role of the deleted blocks.
After the conversion, you may need to modify the configuration parameters for
certain blocks to make them compatible with the current controller model. For
example: When the project code for a network value on an ECB Series con-
troller is configured for a local broadcast and this project code is converted for
an ECY Series controller, the local broadcast is for all subnets which will sig-
nificantly increase network traffic unless the configuration parameter is
changed. For more information, see Error List.
When importing a project code that has more floating pair outputs than can be
supported by the current controller, save your project to remove these floating
pair outputs.
If the unavailable block is from a Code Library that is currently uninstalled on
your PC, see Unavailable block.
Resource Report Print Options
The Resource Report Print Options window is used to set the resource report
printing options such as which resources (hardware inputs and outputs, wire-
less inputs, SmartSensor outputs, network variables, constants, and vari-
ables) and resource properties (number, name, description, etc.) will be
printed, as well as what other items to include in the printed report such as a
title, Project properties, date, etc.
Figure 29: The Resource Report Print Options window (options vary according to
controller model)
EC-gfxProgram 43
Report options
Parameter Description
Include title Check to include a title in the report. Use the textbox
next to this option to specify the title.
Include project Check to include project properties in the report.
properties
Include date Check to include the current date (as specified in the
PC settings) in the report.
Include device Check to include the device name in the report. The
name device name is specified by the user when it is added
to the network.
Include page Check to include page numbers in the report.
numbers
Start each table Check to start each table selected in the Select Tables
on new page frame on a new page in the report.
Table options
Parameter Description
Print grid Check to include borders/lines in the tables of the
report.
Repeat header Check to repeat the header of a table on each page if
on each page the table is laid out over multiple pages.
Scale to fit Check to scale down the tables to fit on one page.
Column Width Select the column width of the tables:
• Same as Resource Viewer specifies that the col-
umns should be the same width as was set in the
Resource Viewer.
• Auto adjust column width to text activates the
Maximum width textbox where you can specify a
column width in number of characters.
Table selection
options
Parameter Description
Select Tables Check the tables to include in the report. The list is
automatically updated to reflect content of the
Resource Viewer.
Select All Checks all the fields in the Select Tables frame.
44 EC-gfxProgram
User Interface Overview
Column
selection
options Parameter Description
Select [Table Check the columns (Number, Name, Description, etc.)
Name] Columns to include in the selected table. The fields in this frame
are automatically updated based on the fields selected
in the Select Tables frame.
Select All Checks all the fields in the Select [Table Name]
Columns frame.
Setup and print
options
Parameter Description
Page Setup Opens the Page Setup window.
Print Preview Opens the Print Preview window.
Print Opens the Print window.
Cancel Cancels all changes and exits the window.
Print Preview
The Print Preview window is used to preview how the project will look when
printed.
Figure 30: The Print Preview window
EC-gfxProgram 45
File menu Figure 31: Print Preview window - File menu
Parameter Description
Print Opens the Print window. This window can also be
opened by pressing Ctrl+P on the keyboard.
Exit Exist the Print Preview window. This window can also
be closed by clicking the Close button on the Standard
toolbar.
View menu Figure 32: Print Preview window - View menu
Parameter Description
Thumbnails Thumbnails or on the Standard toolbar displays
the Thumbnail pane. This pane displays each
document as a thumbnail for quick navigation and an
overall view.
Zoom In Zoom In or on the Standard toolbar zooms in on
the preview. Every time you click this command, the
zoom percentage increases to a pre-defined amount.
Zoom Out Zoom Out or on the Standard toolbar zooms out of
the preview. Every time you click this command, the
zoom percentage decreases to a pre-defined amount.
46 EC-gfxProgram
User Interface Overview
Parameter Description
Zoom Zoom or on the Standard toolbar is
used to set the zoom percentage of the preview.
Choose a value from the drop-down list or enter the
desired zoom percentage in the textbox.
Figure 33: Print Preview window - Zoom
Page Width Page Width or on the Standard toolbar scales the
preview so the entire page width is visible in the
window.
Margin Width
Margin Width or on the Standard toolbar scales
the preview so the entire page width within the margins
is visible in the window.
Whole Page Whole Page or on the Standard toolbar scales the
preview so the entire page is visible in the window.
EC-gfxProgram 47
Parameter Description
Go To Provides access to a variety of commands used to
navigate through the pages and views.
Figure 34: Print Preview window - Go To
First Page or on the View toolbar displays the first
page of the preview.
Previous Page or on the View toolbar displays the
previous page of the preview.
Next Page or on the View toolbar displays the next
page of the preview.
Last Page or on the View toolbar displays the last
page of the preview.
NOTE: In addition to the above navigation functions,
users can navigate directly to a specific page
by entering its number in
on the View tool-
bar.
If the view of the preview has been changed in any way
(zooming, dragging with the Hand Tool, navigating,
etc.), users can use Previous View ( on the View
toolbar) or Next View ( on the View toolbar) to
return to reapply the previous or next zoom
percentage, displayed page, etc.
NOTE: Next View is only available after Previous
View has been used.
48 EC-gfxProgram
User Interface Overview
Tools menu Figure 35: Print Preview window - Tools menu
Parameter Description
Hand Tool
Hand Tool, on the Standard toolbar, or Ctrl+H on
the keyboard is used to move the page in the preview.
When this command is enabled, left-click and hold
anywhere on the page, and move the cursor to drag the
page to the desired position.
• If there is more than one page visible in the pre-
view, the hand tool can be used to scroll up and
down through the pages. This can also be done by
rolling the mouse wheel (if available) up and down.
• If only a portion of the page is visible, the hand tool
can be used to move the page in any direction to
view any other portion. This can also be done by
pressing and holding the mouse wheel (if available)
and then moving the mouse.
Snapshot Tool Snapshot Tool or on the Standard toolbar is used
to select and copy the entire view or a portion of it.
When this command is enabled:
• left-click anywhere in the preview to select and
copy the entire view to the clipboard, or
• left-click and drag a box around an area of the
page to select and copy only that portion to the
clipboard.
The copied selection can then be pasted in other appli-
cations, documents, etc.
Dynamic Zoom Dynamic Zoom Tool or on the Standard toolbar is
Tool
used to zoom in or out of a specific in the preview.
When this command is enabled:
• left-click and hold anywhere on the page, and
move the cursor up to zoom in or down to zoom
out, or
• roll the mouse wheel (if available) up to zoom in or
down to zoom out.
EC-gfxProgram 49
Parameter Description
Zoom In Tool Zoom In Tool or on the Standard toolbar is used to
zoom in on a specific location in the preview.
When this command is enabled:
• left-click anywhere on the page to zoom in on that
location by a pre-defined percentage, or
• left-click and drag a box around an area of the
page to zoom in on that specific location.
To switch to the Zoom Out Tool, press and hold Ctrl
on the keyboard while you click on the page.
Zoom Out Tool Zoom Out Tool or on the Standard toolbar is used
to zoom out of a specific location in the preview.
When this command is enabled:
• left-click anywhere on the page to zoom out of that
location by a pre-defined percentage, or
• left-click and drag a box around an area of the
page to zoom out to include that specific location.
To switch to the Zoom In Tool, press and hold Ctrl on
the keyboard while you click on the page.
Page Setup
The Page Setup window is used to define the size and orientation of the doc-
uments in the project, as well as how they are printed. The size and orienta-
tion of the document is displayed in the bottom-right corner of the window.
50 EC-gfxProgram
User Interface Overview
Print Setup Figure 36: Page Setup window - Print Setup
Parameter Description
Printer Select the name of the printer to use from the drop-
down list.
Paper Select the pre-defined Size of the paper
Margins Specify the size of each margin (Left, Right, Top, and
Bottom).
NOTE: The measurement unit (displayed between
parentheses) depends on the tool settings,
which can be modified in the EC-gfxProgram
Options.
Orientation Select whether the page orientation should be Portrait
or Landscape.
EC-gfxProgram 51
Page Size Figure 37: Page Setup window - Page Size
Parameter Description
Size Select and set the Size of the document in the project:
• Same as printer size uses the printer paper size
set in the Page Setup tab.
• Pre-defined size uses the size selected from the
drop-down list.
• Custom size uses the size defined by the user.
NOTE: The measurement unit (displayed between
parentheses) depends on the tool settings,
which can be modified in the EC-gfxProgram
Options.
Print Zoom Select how the document size is to be adjusted on the
printed page:
• Adjust to scales the document to the percentage
specfied from the drop-down list.
• Fit to one page scales the entire document up or
down so it fists on a single printed page.
Orientation Select whether the page orientation should be Portrait
or Landscape.
52 EC-gfxProgram
User Interface Overview
Print Project
This window allows you to print:
• One or more worksheet from the current project
• A resources report
• A cover page with an image (e.g., a logo)
Figure 38: The Print Project window
EC-gfxProgram 53
Parameter Description
Select Lists the current project’s worksheets.
worksheets to
Check the worksheets to be printed or right-click a
node to access selection/deselection options that act
on the selected node and its subnodes only. Subnodes
represent worksheets for Conditional Custom Block,
Custom block, and For Loop (ECL, ECB & ECY Series)
blocks
Figure 39: Right-click a node for selection/deselection options
Select All: the selected node and all subnodes are to
be printed.
Deselect All: the selected node and all subnodes are
not to be printed.
Select All Unique: the selected node and all subnodes
are to be printed, however duplicate nodes will only be
printed once.
Print Resources Check to include a Resources Report in the print job.
Report Click Resources Report Option to set which
parameters are to be included in the report. See
Resource Report Print Options.
Print Cover Check to include a cover page with a title, a
Page description, and an image (e.g., a logo). Click Browse
to select an image on your file system to be used a
cover page graphic.
Page Setup Click to define the size and orientation of the printed
documents. See Page Setup.
Print Click to print the project.
Print Preview Click to preview how the project will look when printed.
See Print Preview.
54 EC-gfxProgram
User Interface Overview
Connection Methods
When you open EC-gfxProgram, you are prompted to choose one of four
methods to connect to a server. For more information on these methods,
press F1 when the Connect To Server window is active.
NOTE: For ECLYPSE controllers, if you are using the admin default password
(Username: admin, Password: admin), you will have insufficient privi-
leges to access certain features for security reasons. You must
change your password to a strong password for the admin account to
protect access to the controller. This can be done in two ways:
• Connect to the controller via the web interface. You will be
prompted to change the default admin password upon login.
• Connect to the controller via XpressNetwork Utility and then click
Admin Password to change the default admin password.
In the Connect To Server window, use the Server type drop-down menu to
select the connection method to use. Choose:
• BACnet Niagara to connect to a network through EC-NetAX or EC-Net 4.
• Lon Niagara to connect to a LONWORKS network through EC-NetAX or
EC-Net 4.
EC-gfxProgram 55
56 EC-gfxProgram
User Interface Overview
• REST to directly connect to an IP server or controller.
• Emulator to program and test your code without the need for a real con-
troller and/or an EC-Net station. This simulates the programming and
debugging environment of any ECB & ECY Series controller.
EC-gfxProgram Options
The Options window is used to define application defaults such as the default
measurement system, whether the interface automatically saves projects
when they are downloaded to a device, etc.
EC-gfxProgram 57
General tab Figure 40: Options window - General tab
Parameter Description
Default Select Metric or US as the default measurement
measurement system. This setting affects the measurement units
system used by the tool when creating a new project (for
example, the units used for Psychrometric blocks).
NOTE: On initial start, the measurement system of the
PC is used as the default. Similarly, when a
new project is created, the default measure-
ment system is used for the project. To change
this value for a project, see Project properties.
Number of Specify the number of formats to be kept in recent
recent formats formats lists (for example, under the Format button in
the Configure Ports window) by clicking the up and
down arrows, or by entering the amount manually.
Number of Specify the number of projects to be saved in the
recent projects Recent Projects list found in the File menu by clicking
the up and down arrows, or by entering the amount
manually.
Number of undo Specify the number of undo levels to be kept in the
levels undo history. The maximum configurable number of
undo levels is 50.
NOTE: Undo operations are stored in your PC’s RAM
for each individual programming sheet. Setting
a high number of undo levels can thus increase
memory usage requirements.
58 EC-gfxProgram
User Interface Overview
Parameter Description
Open all When checked, all documents within a project are
documents opened when this project is opened. When unchecked,
when opening a only the first document in the project is opened.
project
NOTE: Opening all documents in large projects with
many pages may be time-consuming.
Automatically When checked, projects are automatically saved when
save project the project code is built and sent to the device. If
when sending unchecked, projects are only saved when the save
code to the command is used.
device
Project name When checked, the name given to the project is the
follows the name same as the name given to the project file if the project
of exported files is exported to the PC. If unchecked, the project can be
given a name that is different than that of the exported
file.
Assign tag name When checked, linking to a Reference Hub block will
to linked automatically assign the name of the source object to
Reference Hub the Reference Hub block (when linked to an Output
port, it will use the block’s name only; any other port will
use the combination of the block’s name and the port’s
name).
If the name of the reference hub already exists, an
automatically incremented number is added to the end
of the block name.
Show When checked, errors are shown in real-time. As you
compilation connect objects to make valid code, errors are
errors in real- removed from the Error List pane.
time
NOTE:
Build and send When checked, no warning message is displayed
project even if when you Build and Send a project while tasks are still
tasks are still pending.
pending
EC-gfxProgram 59
Network tab The Network tab configuration parameters only apply to ELP & ECL Series
controllers.
Figure 41: Options window - Network tab
Parameter Description
Automatically When this option is checked and you are using:
rename network
• An LNS Network management tool, the associated
variable when
network variable is renamed when the block name
changing a block
in changed in EC-gfxProgram.
name
• EC-Net, this name is written in the DisplayName
field of the network variable when the block name
is changed in EC-gfxProgram. See also Automatic
generation of control points from EC-gfxProgram
code.
Add nvi or nvo When checked, network variables that are exported to
prefix to network LNS or EC-Net are automatically given a prefix of nvi or
variable name nvo for network variable inputs and network variable
outputs respectively.
60 EC-gfxProgram
User Interface Overview
View tab Figure 42: Options window - View tab
Parameter Description
Clear debug When checked, debug values are automatically cleared
values when when debugging mode is stopped. If unchecked, the
debugging is last debug values remain displayed after debugging
stopped mode is stopped.
Display debug When checked, debug values are shown at both ends
values in inputs of a link when possible (space permitting). This is
useful when projects include long links, making it
difficult to see the debug value shown at the source
object.
Display error When checked, double-clicking an error message in
tooltips on the Error List pane shows a tooltip that points to the
programming input, output, or object the is the source of the error on
sheet the programming sheet. This feature shows you exactly
where the error is located.
Default Page This sets the page size of any programming sheet
Size added to the project. The default page size is set n the
Default Page Size window (see below).
EC-gfxProgram 61
Default Page The Default Page Size window is used to set the page size of any program-
Size ming sheet added to the project. The size and orientation of the document is
displayed in the bottom-right corner of the window.
Figure 43: Options window - Default Page Size
Parameter Description
Size Pre-defined size sets the document to the size selected
from the drop-down list.
Custom size sets the document to the size defined by
the user.
NOTE: The measurement unit (displayed between
parentheses) depends on the tool settings,
which can be modified in the EC-gfxProgram
Options.
Orientation Select whether the document orientation should be
Portrait or Landscape.
Home ribbon
This ribbon has buttons for Clipboard, Editing, Project, and Debugging com-
mands.
Figure 44: Home ribbon
62 EC-gfxProgram
User Interface Overview
The Home ribbon has the following categories:
Category See
Clipboard Clipboard buttons
Editing Editing buttons
Project Project buttons
Debugging Debugging buttons
Resources (ECY Resources button (ECY Series)
Series only)
Clipboard
buttons
Parameter Description
Copies a selected block or portion of text and keeps it
or temporarily in memory so it can be added to another
Ctrl+C on the location of the project. Use the Paste command to add
keyboard the copied content to the new location.
The Copy function does not work between different
instances of EC-gfxProgram.
NOTE: The block’s configuration and properties are
kept when it is copied and pasted.
Removes a selected block or portion of text and keeps
or it temporarily in memory so it can be added to another
Ctrl+X on the location in the project. Use the Paste command to add
keyboard the cut content to the new location.
The Copy function does not work between different
instances of EC-gfxProgram.
NOTE: The block’s configuration and properties are
kept when it is cut and pasted.
Used in conjunction with either the Copy or Cut
or command. After selection the new location for the
Ctrl+V on the copied/cut content, use the Paste command to place it
keyboard in the new location.
When a resource block is pasted, its numbering
changes according to the Auto Increment setting. See
Auto increment (ECP & ECL Series and EBC Series
controllers only) or Auto increment (ECY Series
controllers only).
EC-gfxProgram 63
Editing buttons
Parameter Description
Reverses an action.
or
Ctrl+Z on the NOTE: Some operations cannot be undone with this
keyboard command: changes made to the configuration
screen, for instance.
Undo operations are related to each individual
document. That is, if you have two documents, they
each hold a stack (history) of operations to undo. Even
if a document is closed and reopened, the stack of
undo operations are still available.
The maximum number of operations that can be
undone is set in the EC-gfxProgram Options.
Re-applies an action. Normally used after an action is
or accidentally undone (through the Undo command).
Ctrl+Y on the
The stack of operations that can be redone is cleared
keyboard
each time you perform a new action. For example, if
you undo 4 actions and then place a new block on the
sheet, the stack of 4 operations to redo is cleared.
Deletes a selected block or portion of text from the
or programming sheet of the project.
Delete on the
keyboard
Opens the Duplicate window. This window is used to
or make multiple copies of a selected block or portion of
Ctrl+D on the text.
keyboard
NOTE: The block’s configuration and properties are
kept when it is cut and pasted.
Figure 45: Duplicate window
Number of copies: enter the number of copies to
duplicate in the textbox.
Select all blocks on the programming sheet of the
or current document of the project.
Ctrl+A on the
keyboard
64 EC-gfxProgram
User Interface Overview
Parameter Description
Auto Increment See Auto increment (ECP & ECL Series and EBC
Series controllers only) or Auto increment (ECY Series
controllers only).
Searches for blocks, objects, inputs, outputs, and
object properties. Set your search parameters in the
Find object and replace object dialog. Search results
are shown in the Search Results pane.
Replaces the searched text with new text. Set your
search parameters in the Find object and replace
object dialog. Search results are shown in the Search
Results pane.
Auto increment (ECP & ECL Series and EBC Series
controllers only)
Auto increment applies to countable resources found in the Resource Viewer,
such as Pid, Hardware Input, Hardware Output, Schedule, Timer, etc.
These blocks have a Number in their properties.
Figure 46: Block number property
Block numbering changes according to how the block is added to the pro-
gramming sheet and according to the current Auto Increment setting. See:
• Copying & pasting or duplicating blocks currently on the programming
sheet
• Dragging a snippet from the code library on the programming sheet
• Dragging a block from the toolbox on the programming sheet
EC-gfxProgram 65
Copying & The Auto Increment mode controls the way the resource block number is
pasting or automatically incremented when block(s) currently on the Programming Sheet
duplicating are copied & pasted or duplicated.
blocks currently
on the Option Description
programming
sheet Auto Increment The block number is not incremented, but rather
Cleared remains the same every time a block of the same type
is copied & pasted or duplicated on the programming
sheet.
Not incrementing block numbers and using multiple
copies of the same block with the same number can be
beneficial and can simplify programming in some
cases. For instance, having multiple instances of a
Variable Numeric 1 block in the project code permits
the reuse of the same value throughout the project
wherever necessary. Also, changing the current value
in one of the Variable Numeric 1 blocks instantly
changes the value everywhere this block is used in the
code.
Auto Increment The block number is automatically incremented to the
Set first available number that is greater than the currently
selected block type every time a block of the same type
is copied & pasted or duplicated on the programming
sheet.
The number wraps around to 1 when the maximum
resource number is reached and there are no unused
resources found by the auto increment function.
To copy the configuration from another block instance, right-click the block
and select Copy From.
The Auto Increment mode can also be toggled by pressing Ctrl+Shift+A on
the keyboard.
NOTE: The Floating Output, Wireless Sensor, and Wireless Module (ECP
Series) blocks also have a limited number of instances that are sup-
ported by the device. However, they are not affected by this function
(they are created dynamically).
There is only one instance of the following blocks: Led Output (ECP
Series), SmartSensor Module (ECP Series), Real Time Clock (ECP
Series), Real Time Clock (ECL Series), Real Time Clock (ECB & ECY
Series), Damper Control (ECP Series), and Flow Sensor (ECP
Series). These blocks do not have a block number to increment.
For more information about the supported quantity for each type of
block, see Block Objects.
66 EC-gfxProgram
User Interface Overview
Dragging a A code snippet can include numbered blocks. The block numbering when the
snippet from the code snippet is dragged on the programming sheet from the Code Library is
code library on affected by whether Auto Increment is enabled, and by a setting made when
the the code snippet is saved.
programming
• The Keep numbers setting was cleared when saving the code snippet
sheet
(see Saving a code snippet) and the Auto Increment option is enabled:
dragging a code snippet that uses numbered blocks from the Code
Library on the programming sheet reassigns the numbered blocks in the
snippet’s code to the first available one.
• The Keep numbers setting was set when saving the code snippet (see
Saving a code snippet) and the Auto Increment option is enabled or dis-
abled: dragging a code snippet that uses numbered blocks from the Code
Library on the programming sheet keeps the same block numbers as the
ones specified in the original design of the code snippet.
When the code snippet is dragged on the programming sheet from the Code
Library, you can choose to overwrite the current configuration with the config-
uration from the code snippet, or to keep the current configuration. See Add-
ing a snippet to a programming sheet.
Dragging a block When a block is dragged from the Toolbox pane on the programming sheet,
from the toolbox the block number is always incremented to the first available unused number
on the regardless of the current Auto Increment option.
programming
sheet Dragging a resource block from the Toolbox pane on the programming sheet
never overwrites the block’s configuration previously set in the Resources
Configuration window.
To copy the configuration from another block instance, right-click the block
and select Copy From.
NOTE: There is only one instance of the following blocks: Real Time Clock
(ECB & ECY Series), Actuator Control (ECB & ECY Series), VAV Dif-
ferential Pressure (ECY Series), Flow Calculation (ECB & ECY
Series), and Internal Actuator (ECB & ECY Series). These blocks do
not have a block number to increment.
For more information about the supported quantity for each type of
block, see Block Objects.
EC-gfxProgram 67
Auto increment (ECY Series controllers only)
Auto increment applies to countable resources found in the Resource Viewer,
such as Analog Value, Pid, Hardware Input, Hardware Output, Schedule,
Timer, etc. These blocks have a Number in their properties.
Figure 47: Block number property
When programming ECY Series controllers, you can add and configure the
parameters of a resource block in the Resources Configuration window
before creating the resource on the programming sheet. See Resources Con-
figuration.
Block numbering changes according to how the block is added to the pro-
gramming sheet and the current Auto Increment setting. See:
• Copying and pasting blocks currently on the programming sheet
• Dragging a snippet form the code library on the programming sheet
• Dragging a block from the toolbox on the programming sheet
Copying and The Auto Increment mode controls the way the resource block number is
pasting blocks automatically incremented when block(s) currently on the Programming Sheet
currently on the are copied & pasted or duplicated.
programming
sheet Parameter Description
No Auto The block number is not incremented, but rather
Increment remains the same every time a block of the same type
is copied & pasted or duplicated on the programing
sheet.
Not incrementing block numbers and using multiple
copies of the same block with the same number can be
beneficial and can simplify programming in some
cases. For instance, having multiple instances of a
Variable Numeric 1 block in the project code permits
the reuse of the same value throughout the project
wherever necessary. Also, changing the current value
in one of the Variable Numeric 1 blocks instantly
changes the value everywhere this block is used in the
code.
68 EC-gfxProgram
User Interface Overview
Parameter Description
Auto Increment The block number is automatically incremented to the
(To Next) first available number that is greater than the currently
selected block type every time a block of the same type
is copied & pasted or duplicated on the programming
sheet.
The number wraps around to 1 when the maximum
resource number is reached and there are no unused
resources found by the auto increment function.
Auto Increment The block number is automatically incremented to the
(To New) first available number that has no current configuration
in the Resources Configuration window every time a
block of the same type is copied & pasted or duplicated
on the programming sheet.
The number wraps around to 1 when the maximum
resource number is reached and there are no unused
resources found by the auto increment function.
Copying & pasting or duplicating a block currently on the programming sheet
never overwrites the block’s configuration previously set in the Resources
Configuration window. See Resources Configuration.
To copy the configuration from another block instance, right-click the block
and select Copy From.
The Auto Increment mode can also be toggled by pressing Ctrl+Shift+A on
the keyboard.
NOTE: The Auto Increment (To Next) option behaves like the Auto Incre-
ment (To New) option with the Floating Output block.
There is only one instance of the following blocks: Real Time Clock
(ECB & ECY Series), Actuator Control (ECB & ECY Series), VAV Dif-
ferential Pressure (ECY Series), Flow Calculation (ECB & ECY
Series), and Internal Actuator (ECB & ECY Series). These blocks do
not have a block number to increment.
For more information about the supported quantity for each type of
block, see Block Objects.
EC-gfxProgram 69
Dragging a A code snippet can include numbered blocks. The block numbering when the
snippet form the code snippet is dragged on the programming sheet from the Code Library is
code library on affected by whether Auto Increment is enabled, and by a setting made when
the the code snippet is saved.
programming
• The Keep numbers setting was cleared when saving the code snippet
sheet
(see Saving a code snippet) and either the Auto Increment (To Next) or
Auto Increment (To New) option is enabled: dragging a code snippet
that uses numbered blocks from the Code Library on the programming
sheet reassigns the numbered blocks in the snippet’s code to the first
available one (unused block instance with To Next or unconfigured block
instance with To New).
• The Keep numbers setting was set when saving the code snippet (see
Saving a code snippet) and the Auto Increment option is set: dragging a
code snippet that uses numbered blocks from the Code Library on the
programming sheet keeps the same block numbers as the ones specified
in the original design of the code snippet.
When the code snippet is dragged on the programming sheet from the Code
Library, you can choose to overwrite the current configuration with the config-
uration from the code snippet, or to keep the current configuration. See Add-
ing a snippet to a programming sheet.
Dragging a block When a block is dragged from the Toolbox pane on the programming sheet,
from the toolbox the block number is always incremented to the first available unused number
on the regardless of the current Auto Increment option.
programming
sheet Dragging a resource block from the Toolbox pane on the programming sheet
never overwrites the block’s configuration previously set in the Resources
Configuration window.
To copy the configuration from another block instance, right-click the block
and select Copy From.
NOTE: There is only one instance of the following blocks: Real Time Clock
(ECB & ECY Series), Actuator Control (ECB & ECY Series), VAV Dif-
ferential Pressure (ECY Series), Flow Calculation (ECB & ECY
Series), and Internal Actuator (ECB & ECY Series). These blocks do
not have a block number to increment.
For more information about the supported quantity for each type of
block, see Block Objects.
70 EC-gfxProgram
User Interface Overview
Project buttons
Parameter Description
Adds a Programming Sheet (Ctrl+N on the
keyboard), Text Document, or Configuration
Assistant Sheet to the current project.
Programming sheets, text documents, and
configuration assistant sheets can also be added by
right-clicking the project in the Project Explorer pane.
Compiles the project and verifies the code for errors
(displayed in the Error List pane, if any). You must
follow a few rules to build code successfully. For a list
and explanation of these rules, see the Connection
or
rules section.
Ctrl+Shift+B on
the keyboard If a change is made to the project code by adding a
new block, moving blocks around on the programming
sheet relative to each other, or creating a new
connection, the project must be rebuilt before the code
can be executed.
When the controller is online, configurations are sent to
it every time a change is made (for example, setting the
value of a Constant Numeric block, configuring a
Hardware Input block, inputting the parameters of a
Pid block, etc.).
If you are making many changes to your project, and it
is unnecessary to synchronize every change you make
in real time, you can work offline. To do so, set Work
Offline by pressing F10 on the keyboard. The
connection status to the device is shown in the lower
right corner.
NOTE: Your project must be synchronized when you
return to online mode. See Project Synchroni-
zation.
EC-gfxProgram 71
Parameter Description
Compiles the project, verifies the code for errors, and, if
everything is valid, complies the code and downloads it
to the device. Note that configurations, such as
advanced block configuration from the block’s
or
properties, units, etc. are only downloaded to ECY
Ctrl+Shift+B on
Series controllers.
the keyboard
NOTE: When you delete a block, its points may remain
available (on the controller’s color LCD screen
or ECx-Display, for example), even if you build
and send the code to the device. In this case,
you must synchronize your project with the con-
troller. See below.
Performs a comparison between the device’s database
and that on the computer. Opens the Project
Synchronization window. For more information, see
or Project Synchronization.
F9 on the
keyboard
The Work Offine > with tracking mode suspends
communication with a device to eliminate the delays
experienced when configuration is sent to the device in
real time. This is ideal when you are in the design
or F10 phase of a project and you are creating many inputs,
on the keyboard outputs, SmartSensor Modules, and Wireless Modules
at once (which are synchronized to the device in real
time).
When you return to online mode, all tracked
configuration changes will be sent to the device. You
can then synchronize your project code and start the
debug mode to view live values and verify correct
program operations.
The connection status to the device is shown in the
lower right corner.
The Work Offine > without tracking mode does not
track configuration changes. This mode is used
especially while renumbering resource objects, which
can affect what is currently running in the controller as
well as other devices or tools that are reading/writing
from objects being renumbered. See Renumbering/
Swapping Resources for more information.
72 EC-gfxProgram
User Interface Overview
Text documents
A text document can be used to document your project code by providing a
detailed sequence of operation. Content can be copied from design docu-
ments (created in a word-processing program) including pictures (created in a
drawing program) and pasted into the Text Document. The formatting of
pasted text will be preserved as best as possible, especially when the source
text comes from a word-processing program that supports rich text format.
Since pictures take a lot of memory space on controllers, do not add too many
pictures to text documents, especially if you intend to backup the project code
to a controller. Another solution is to first reduce the size of the images with
the compress pictures feature (if available) in your word-processing program
before copying the content to the Text Document.
NOTE: When the Backup code to device option is selected during the project
synchronization, all Text Document content, including images, is
backed up to the controller.
EC-gfxProgram 73
Project Synchronization
The Project Synchronization window is used to synchronize the project code
and configurations between the device and PC by either downloading from
the PC to one or more devices or uploading from a device to the PC. The
information being transferred can include configurations, modes, and values
of blocks. See Synchronizing a project with a device for a practical step-by-
step example of how to synchronize your project. A project may need to be
synchronized for a number of reasons:
• To send a project and its configuration that has been imported from a file
to a controller.
• To send a project to more than one controller at a time.
• When returning to online mode from offline mode, you will need to syn-
chronize your project.
• When you change the project’s units (from Metric to US, for example).
Figure 48: Project Synchronization window (options vary according to controller
model)
During the Selection step, the Synchronization Mode and Options are set.
In the next step, the Status of the synchronization can be followed. Finally, in
the Finish step, the success or failure of the synchronization is displayed.
NOTE: Clicking Cancel during synchronization is not always responsive, as
certain synchronization actions cannot be interrupted.
74 EC-gfxProgram
User Interface Overview
When any of the following Synchronization Options are selected, the cur-
rent project code will be backed up in the database:
• Project's Configuration
• ECL Series Controllers: Reinitialize non-controller specific values and
constants
• ECL Series Controllers: Reinitialize controller specific values and con-
stants
• ECB & ECY Series controllers: Reinitialize non-controller specific values
• ECB & ECY Series controllers: Reinitialize controller specific values
• Send Schedule's configuration
• Save Code to the database
• Compile code and send it to device
During project synchronization, if you only select Synchronization Options
other than those listed above, then the current project code will not be backed
up in the database.
Synchronization Select one of the following synchronization modes.
mode
Parameter Description
Download to Sends the information selected under
device Synchronization Options from the PC to the device.
See Download to device and download to multiple
devices synchronization options.
Upload from Uploads the actual values from the device into the
device current project code objects. This is useful, for
example, to view the controller’s current value when
the network has updated an internal value.
NOTE: Upload from device does not upload the proj-
ect from the controller. To upload the project,
select Import > Import From Device from the
The EC-gfxProgram File Menu menu.
See Upload from device and upload from multiple
devices synchronization options.
Download to Sends the information selected under
multiple devices Synchronization Options from the PC to two or more
devices at a time. A screen allows you to select the
target devices on which the project code will be
compiled and downloaded. See Download to device
and download to multiple devices synchronization
options and Controller specific values and device
synchronization options (ECL, ECB & ECY Series).
EC-gfxProgram 75
Parameter Description
Upload from Uploads the actual values from to two or more devices
multiple devices at a time into the respective device’s database. See
Upload from device and upload from multiple devices
synchronization options.
Download to Synchronization options vary by controller model.
device and
download to
multiple devices
synchronization
options
This Applies to:
Parameter ECP ECL ECB ECY Description
Series Series Series Series
Project’s This downloads the project’s
Configuration configuration from the EC-gfxProgram
project to the controller. These
configurations include advanced
configuration to the device, such as
configuration from the Block’s
properties pane, units, etc.
WARNING: When Download to multi-
ple devices is set, it is rec-
ommended to only select
this setting for the first time
the device is synchro-
nized. See Controller spe-
cific values and device
synchronization options
(ECL, ECB & ECY Series).
For example, if this is
selected and you select
Download to multiple
devices, this will overwrite
the hardware input offset
calibration.
76 EC-gfxProgram
User Interface Overview
This Applies to:
Parameter ECP ECL ECB ECY Description
Series Series Series Series
Force When this option is selected, the
ENVYSION ENVYSION data tree contained in the
data tree EC-gfxProgram project is sent to the
override ECY Series controller and overrides any
modifications made to the data tree
outside of EC-gfxProgram (in
ENVYSION for instance).
When the option is not selected, the
ENVYSION data tree is sent only if it
has not been modified outside of EC-
gfxProgram.
NOTE: This option can only be selected
if the Program and configura-
tion option is selected as well.
Send When this option is selected, sends all
schedule’s calendar and schedule instances that
configuration were saved in the project file to the ECY
Series controller.
NOTE: This option can only be selected
if the Program and configura-
tion option is selected as well.
NOTE: To include calendar and sched-
ule instances in the project, you
must save them to the database
in the EC-Schedule tool (see
File menu for more details).
EC-gfxProgram 77
This Applies to:
Parameter ECP ECL ECB ECY Description
Series Series Series Series
Reinitialize This downloads the project’s
non-controller configuration from the EC-gfxProgram
specific values project to the controller, the Initial value
and constants of Boolean Value (ECL Series), Boolean
Constant (ECL Series), Enum Value
(ECL Series), Enum Constant (ECL
Series), Numeric Value (ECL Series),
Setpoint Constant, and Numeric
Constant (ECL Series) instances not
flagged as Controller Specific to their
initial value. This will also clear any
override mode on these points.
When a Network Variable Input (ECL
Series) block’s Mode is set to Non-
controller-specific Configuration, this
pushes the Initial Value set in the
controller’s SCPT network variable. See
Network Variable Input Configuration
window to set this property.
Reinitialize This downloads the project’s
controller configuration from the EC-gfxProgram
specific values project to the controller, the Initial value
and constants of Boolean Value (ECL Series), Boolean
Constant (ECL Series), Enum Value
(ECL Series), Enum Constant (ECL
Series), Numeric Value (ECL Series),
Setpoint Constant, and Numeric
Constant (ECL Series) instances
flagged as Controller Specific to their
initial value.
When a Network Variable Input (ECL
Series) block’s Mode is set to
Controller-specific Configuration,
this pushes the Initial Value set in the
controller’s SCPT network variable. See
Network Variable Input Configuration
window to set this property.
78 EC-gfxProgram
User Interface Overview
This Applies to:
Parameter ECP ECL ECB ECY Description
Series Series Series Series
Reinitialize This downloads the project’s
non-controller configuration from the EC-gfxProgram
specific values project to the controller, the
present_value of Non-commandable
Analog Value, Binary Value, and Multi
State Value instances not flagged as
Controller Specific to their initial value.
This will also clear any override mode
on these points.
For all Analog Value, Binary Value,
and Multi State Value instances not
flagged as Controller Specific in
Resources Configuration, this writes
NULL in the priority array at level 16 to
relinquish this priority level and remove
any value that was used by project code
at the default priority level 16. See
Commandable object priority array
levels.
Reinitialize This downloads the project’s
controller configuration from the EC-gfxProgram
specific values project to the controller, the
present_value of Non-commandable
Analog Value, Binary Value, and Multi
State Value instances flagged as
Controller Specific to their initial value.
For all Analog Value, Binary Value,
and Multi State Value instances
flagged as Controller Specific in
Resources Configuration, this writes
NULL in the priority array at level 16 to
relinquish this priority level and remove
any value that was used by project code
at the default priority level 16. See
Commandable object priority array
levels.
EC-gfxProgram 79
This Applies to:
Parameter ECP ECL ECB ECY Description
Series Series Series Series
Reinitialize For all Network Object instances
controller flagged as Controller Specific in
specific Resources Configuration, this
configurations reinitializes the Device Instance, Object
(Network Instance and Operation with the values
objects, in the project.
EnOcean)
For all EnOcean instances flagged as
Controller Specific in Resources
Configuration, this reinitializes the
Device ID with the values in the project.
Reinitialize This resets the persistency of all EC-
persistency gfxProgram objects that use
persistency. For example, Internal
variable (ECL, ECB & ECY Series),
Timers, Count Up, Count Down, Latch,
etc.
Clear object’s WARNING: This option can erase all
values and locally set values such as a
overrides VAV’s K-Factor.
This clears all objects values such as
Constants, Values, Network Variable
Inputs, and Timers.
For commandable objects: this writes
NULL in all levels of the priority array
(level 1 to 16). See Commandable
object priority array levels.
For non-commandable objects: this
resets the Present value with the
Default value.
This writes NULL in all levels of the
priority array (level 1 to 16). See
Commandable object priority array
levels.
Send This sends the current project’s
schedule’s calendar and schedule configurations to
configuration the controller.
For ECB Series controllers: This also
stops exposing Calendar or Schedule
Blocks to the BACnet network when you
have removed a Calendar or Schedule
Block from the programming sheet. See
Calendar (ECB & ECY Series) and
Schedule (ECB & ECY Series).
80 EC-gfxProgram
User Interface Overview
This Applies to:
Parameter ECP ECL ECB ECY Description
Series Series Series Series
Reset PIDs During runtime, the PID loop input
values can be modified through a
network property or through project
code (by linking project code to a PID
block’s ProportionalBand,
IntegralTime, or DerivativeTime input
ports).
When an input port is linked to with
other programming code, the
corresponding network property is set to
Read Only. If the input port is later
disconnected, the controller must be
rebooted or the option Reset PIDs
selected to make the associated
network property writable again.
See also Pid Loop (ECL Series) and Pid
Loop (ECB & ECY Series).
Reboot This soft reboots the controller(s) and
controller any connected ECx-400 Series
Extension Modules once the
synchronization is complete. For
example, use this option to trigger a
startup or initialization sequence in your
project code with the Startup block.
This has the same effect as power-
cycling the controller(s).
Constants’ This synchronizes the values of the
values Constant Enum (ECP Series) and
Constant Numeric (ECP Series) blocks
between the PC and device.
WARNING: When Download to multi-
ple devices is set, it is rec-
ommended to only select
this setting for the first time
the device is synchro-
nized. See Controller spe-
cific values and device
synchronization options
(ECL, ECB & ECY Series).
EC-gfxProgram 81
This Applies to:
Parameter ECP ECL ECB ECY Description
Series Series Series Series
Manual modes This synchronizes the point modes
and values (manual or automatic) and values (used
in Variable Enum (ECP Series),
Variable Numeric (ECP Series),
Hardware Input (ECP Series),
Hardware Output (ECP Series),
Floating Output (ECP Series),
SmartSensor Module (ECP Series), and
Wireless Module (ECP Series))
between the PC and device.
WARNING: When Download to multi-
ple devices is set, it is rec-
ommended to only select
this setting for the first time
the device is synchro-
nized. See Controller spe-
cific values and device
synchronization options
(ECL, ECB & ECY Series).
VAV This synchronizes the calibration
controllers: parameters specific to a VAV device
VAV such as K factor, damper response,
parameters damper rotation (CW, CCW), etc.
WARNING: When Download to multi-
ple devices is set, it is rec-
ommended to only select
this setting for the first time
the device is synchro-
nized. See Controller spe-
cific values and device
synchronization options
(ECL, ECB & ECY Series).
Backup code to This backs up the project into the
device controller’s backup memory. When a
project has been saved in the device’s
backup memory, it can be imported into
EC-gfxProgram. This is useful to
recover a project when you no longer
have the project code for the device on
your PC. See File menu.
82 EC-gfxProgram
User Interface Overview
This Applies to:
Parameter ECP ECL ECB ECY Description
Series Series Series Series
Compile code This compiles the current project code
and send it to and sends it to the device.
device
This option is the final step performed
only after any other selected
Synchronization Options have
completed.
If deselected, the project code is not
compiled after synchronization.
Upload from Uploads the actual values from the device into the current project code
device and objects. This may be necessary to view the current controller values that can
upload from change due to inputs from network variables, or from controller human inter-
multiple devices faces (for example, from the ComSensor).
synchronization
When the Upload from Multiple Devices option is selected, a screen allows
options
you to select the devices from which the project code will be uploaded. See
Figure 50. Synchronization options vary by controller model.
This Applies to:
ECP ECL ECB ECY
Parameter Description
Series Series Series Series
Project’s This uploads the project’s
Configuration configuration CPs from the controller
to the EC-gfxProgram project
(including the ComSensor). These
Configuration configurations include advanced
properties configuration to the device, such as
configuration from the Block’s
properties pane, units, etc.
Constants’ When selected, this uploads from the
values controller to the EC-gfxProgram
project the values of the Constant
Enum and Constant Numeric blocks.
EC-gfxProgram 83
This Applies to:
ECP ECL ECB ECY
Parameter Description
Series Series Series Series
Manual modes This uploads from the controller
and values to the EC-gfxProgram project the
point modes (manual or automatic)
and values (used in Variable Enum
(ECP Series), Variable Numeric
(ECP Series), Hardware Input (ECP
Series), Hardware Output (ECP
Series), Floating Output (ECP
Series), SmartSensor Module (ECP
Series), and Wireless Module (ECP
Series)) between the PC and device.
Update non- This uploads from the controller to
controller specific the EC-gfxProgram project the Initial
values and value of Boolean Value (ECL Series),
constants Boolean Constant (ECL Series),
Enum Value (ECL Series), Enum
Constant (ECL Series), Numeric
Value (ECL Series), and Numeric
Constant (ECL Series) instances not
flagged as Controller Specific to
their initial value.
Update controller This uploads from the controller to
specific values the EC-gfxProgram project the Initial
and constants value of Boolean Value (ECL Series),
Boolean Constant (ECL Series),
Enum Value (ECL Series), Enum
Constant (ECL Series), Numeric
Value (ECL Series), and Numeric
Constant (ECL Series) instances
flagged as Controller Specific to
their initial value.
Update non- This uploads from the controller to
controller specific the EC-gfxProgram project the
values present_value of Non-commandable
Analog Value, Binary Value, and
Multi State Value instances not
flagged as Controller Specific to
their initial value.
Update controller This uploads from the controller to
specific values the EC-gfxProgram project the
present_value of Non-commandable
Analog Value, Binary Value, and
Multi State Value instances flagged
as Controller Specific to their initial
value.
84 EC-gfxProgram
User Interface Overview
This Applies to:
ECP ECL ECB ECY
Parameter Description
Series Series Series Series
Upload PID loops This uploads from the controller to
parameters the EC-gfxProgram project the
current PID loop configuration
parameters.
WARNING: When a controller is
equipped with an opera-
tor interface or it is con-
nected to an ECx-
Display, PID loop val-
ues can be changed
locally on screen. You
can use this feature to
upload the controller’s
current PID loop config-
uration parameters to
the EC-gfxProgram’s
code.
Compile code This compiles the current project
and send it to code and sends it to the device.
device
This option is the final step
performed only after any other
selected Synchronization Options
have completed, such as Upload
from device.
If deselected, the project code is not
compiled after synchronization.
Upload Update the EC-gfxProgram project
configuration with any changes made to the
values from controller’s BACnetobjects that were
device made by another non-EC-
gfxProgram source. For example,
changes made to the controller’s
BACnet objects through EC-Net or
ENVYSION.
EC-gfxProgram 85
This Applies to:
ECP ECL ECB ECY
Parameter Description
Series Series Series Series
Update default For Analog Value, Binary Value,
value of non- and Multi State Value instances that
controller specific have Persist value 16 set and are
values from not flagged as Controller Specific,
priority 16 this copies the object’s current
priority 16 value to the object’s
relinquish default value in both the
controller and in EC-gfxProgram.
This backs up the priority level 16
values of all objects. This is useful for
example, when in the future the
controller is swapped out and is
reloaded with its project code, priority
level 16 values such as K-Factor are
saved.
Update default For Analog Value, Binary Value,
value of and Multi State Value instances
controller specific flagged as Controller Specific, this
values from copies the object’s current priority 16
priority 16 value to the object’s relinquish
default value in both the controller
and in EC-gfxProgram.
This backs up the priority level 16
values of all objects. This is useful for
example, when in the future the
controller is swapped out and is
reloaded with its project code, priority
level 16 values such as K-Factor are
saved.
Controller This is a feature that allows you to conserve constant values and VAV calibra-
specific values tion parameters that have been previously set in the controller from being
and device over-written by the values currently set in the project code (for example, the
synchronization minimum air flow set point or K factor). By setting the constant and value
options (ECL, block instances as Controller Specific, you have the choice to overwrite these
values or not with the two following synchronization options: Reinitialize non-
ECB & ECY
controller specific values and constants and Reinitialize controller spe-
Series)
cific values and constants.
86 EC-gfxProgram
User Interface Overview
Figure 49: Setting a controller specific to true in a block’s Properties pane
For ECL, ECB & ECY Series controllers, a block can be set to be controller
specific in the Resources Configuration window.
The following blocks can be set as controller specific.
Blocks for ECP & ECL Series Blocks for ECB & ECY Series
Controllers Controllersa
Boolean Constant (ECL Series) Analog Value (ECB & ECY Series)
Boolean Value (ECL Series)
Enum Constant (ECL Series) Binary Value (ECB & ECY Series)
Enum Value (ECL Series)
Numeric Constant (ECL Series) Multi State Value (ECB & ECY Series)
Numeric Value (ECL Series)
Setpoint Constant (ECL Series)
a Applies to non-commandable instances of these blocks only. See Command-
able and non-commandable values (ECB & ECY Series controllers).
For example, two or more VAVs have been balanced and you want to down-
load updated project code to them. In doing so, you do not want to over write
the controller-specific constant values such as the K Factor and VAV calibra-
tion parameters currently saved in the controllers. To avoid doing so, when
creating project code for controller specific constants, ensure that Controller
Specific is set to True in the properties pane for these blocks. During synchro-
nization, in the Project Synchronization window, ensure to:
• Select Reinitialize controller specific values and constants the first
time the controller is synchronized so that the Initial value set in the proj-
ect code will be written to the controller during synchronization.
• Deselect Reinitialize controller specific values and constants for sub-
sequent controller synchronizations so as to preserve controller specific
constants stored in the controller.
To reset controller specific constants to those used in your code, select Reini-
tialize controller specific values and constants during synchronization.
WARNING: When you download to multiple devices and you deselect Update
non-controller specific values and constants or Update con-
EC-gfxProgram 87
troller specific values and constants, the values of the current
project for these options are written to the database for all
selected devices. However the Update non-controller specific
values and constants or Update controller specific values
and constants are not written to the actual devices themselves.
To see the actual device values, open the project for that device
and perform a Project Synchronization again with Upload
from device and Update non-controller specific values and
constants or Update controller specific values and constants
set.
Information If you select a device for synchronization that is different than the current
about device type, the synchronization process may fail during compilation (for
synchronization example, trying to push an air handling unit project code into a VAV device
that has fewer IOs).
Compilation errors are shown in the Details screen, Compilation Errors tab of
the Report screen once synchronization is complete. In this case, the configu-
ration will have been written to the device even though the compilation fails.
You can select non-commissioned of offline devices for synchronization. In
this case, the application will only save the project to the database for this
device. The device can be synchronized once it has been commissioned.
The status is also displayed in the device selection of EC-gfxProgram. Non-
commissioned devices are shown in grey and commissioned devices are
shown in green.
Figure 50: Device status in EC-gfxProgram - Commissionned devices are shown in
green
Debugging buttons
The Debugging buttons are used to debug the project after it has been built.
When in debugging mode, the controller executes the project code and EC-
gfxProgram displays debug Present Values on each block’s output and
optionally on the block’s input (depending on whether the Display debug val-
88 EC-gfxProgram
User Interface Overview
ues on inputs option in the EC-gfxProgram Options window is set). Debug-
ging is useful to verify the expected project code behavior by observing debug
values progress in time. To know if debugging is currently available, see Con-
troller connection and debugging status indicators.
You do not have to start debugging for the controller to run its control
sequence. Debugging simply enables the reading of values from the control-
ler.
WARNING: When the project is debugging, it is using some network band-
width and as a result may affect network communication perfor-
mance. As a precaution, no more than two devices should be
debugged simultaneously.
ECL, ECB & ECY Series controllers send debug values only
every few project code execution cycles so as to reduce the
amount of network bandwidth necessary for debugging. On net-
works that carry a lot of traffic, debugging may result in irregular
updates to debug values and poor overall network performance.
NOTE: When the project is debugging:
• The debugging activity Controller connection and debugging status indi-
cators should be flashing green.
• The project code cannot be modified in any way except port configuration
and advanced configurations, for example, by setting the value of an Ana-
log Value (ECB & ECY Series) block, a Constant Numeric (ECP Series)
block, configuring a Hardware Input block, inputting the parameters of a
Pid block, etc.
• Blocks can be moved around on the programming sheet.
Should you change the relative order of blocks on the programming
sheet, you may have to rebuild the project code before it can be executed
again. See Build sequencing.
• No debug values will appear when debugging if the Generate Debug
Messages feature in the Home ribbon ribbon, Debugging buttons com-
mand is not enabled.
Figure 51: Debug value (126) is shown on the connection line
• If debugging a Conditional Custom Block, debug values will only appear
when the block is enabled. If the project code in the Conditional Custom
Block is not currently being executed, a message in the bottom-left cor-
ner of the screen indicates this.
EC-gfxProgram 89
Parameter Description
Start Starts debugging mode. Debugging mode will continue
to run until it is stopped by using the Stop command.
Debugging mode can also be started by clicking the
Start button on the Home ribbon or by pressing F5 on
the keyboard.
A project can be debugged at any time without
rebuilding the project code and resending it, as long as
the current project code in EC-gfxProgram matches the
project code in device. If there is a difference between
the project code in EC-gfxProgram and the project
code that is running in the device, you will receive a
warning with the option to build and send the project to
the device.
NOTE: Debugging increases controller’s code execu-
tion time.
Stop Stops debugging mode. Debugging mode can also be
stopped by pressing Shift+F5 on the keyboard.
The controllers will stop debugging by themselves after
few seconds if EC-gfxProgramquits or exits.
NOTE: Depending on the Clear debug values when
stop debugging option in the EC-gfxProgram
Options window, the last debug values will
either remain displayed or be cleared when
debugging mode is stopped.
Generate Debug Generates debug messages while the project is being
Messages (for built. These messages are then used during debugging
ECP & ECL process to display values on all the outputs of the
Series and ECB blocks. This feature consumes between 10 to 20% of
Series total code space and increases code execution time if
controllers only) enabled.
If deselected the debug mode can be activated after
the project is built, but no values will appear on the
outputs of the blocks. This is useful to allow an
application to execute as quickly as possible.
Round Debug This limits the number of digits to be shown after the
Values decimal place to better show the available significant
digits.
Clear Debug Clears all debug values that were generated during
Values debugging mode.
90 EC-gfxProgram
User Interface Overview
Resources button (ECY Series)
Parameter Description
Open Opens the Resources Configuration window. See
Configuration Resources Configuration.
EC-gfxProgram 91
Drawing ribbon
This ribbon has drawing buttons help to better organize and clean up a proj-
ect’s work space.
Figure 52: Drawing ribbon
The Drawing ribbon has the following categories.
Category See
Alignment Alignment button
Distribution Distribution buttons
Size Size button
Alignment button
These buttons align two or more selected blocks on the Programming Sheet.
NOTE: When aligning blocks, the last block selected will be the reference
block (highlighted in red).This means that all the other blocks selected
(highlighted in gray) will be aligned to the reference block. The refer-
ence block can be changed once the blocks are selected by clicking
the block you want to be the new reference block (release the ctrl and
shift keys). As long as you click objects that are already selected, the
selection will stay intact, only the reference block will change.
Parameter Description
Bottom Aligns two or more blocks along their bottom sides.
Center Aligns two or more blocks along their centers.
Left Aligns two or more blocks along their left sides.
Middle Aligns two or more blocks along their top-to-bottom
centers.
Right Aligns two or more blocks along their right sides.
Top Aligns two or more blocks along their top sides.
92 EC-gfxProgram
User Interface Overview
Distribution buttons
These buttons make the space between three or more selected blocks equi-
distant from each other.
Parameter Description
Horizontally Makes the spacing of block equidistant on the
horizontal axis.
Vertically Makes the spacing of block equidistant on the vertical
axis.
Size button
These buttons make two or more selected blocks equal in width
NOTE: When resizing blocks, the last block selected will be the reference
block (highlighted in red).This means that all the other blocks selected
(highlighted in gray) will be resized to match the width of the reference
block. The reference block can be changed once the blocks are
selected by clicking the block you want to be the new reference block
(release the ctrl and shift keys). As long as you click objects that are
already selected, the selection will stay intact, only the reference block
will change..
Parameter Description
Same width Makes two or more selected blocks equal in width.
EC-gfxProgram 93
View ribbon
This ribbon has buttons for setting the zoom of the current view and for select-
ing the utility panes (Project Explorer, etc.), thumbnail, and gridlines to be dis-
played.
Figure 53: View ribbon
The View ribbon has the following categories.
Category See
Zoom Zoom buttons
Show/Hide Show/Hide buttons
Panes Panes button
Zoom buttons
Parameter Description
Zoom In Zooms in on the Programming Sheet. Every time you
click this command, the zoom percentage increases by
25%. The Programming Sheet can also be zoomed into
by pressing Ctrl+Shift+I on the keyboard or by
pressing Ctrl and rolling the mouse wheel up (if a
wheel-mouse is available).
94 EC-gfxProgram
User Interface Overview
Parameter Description
Zoom Used to set the zoom percentage of the Programming
Sheet. Choose a value from the drop-down list, Fit
Selection to zoom to the selected objects, Whole
Page to view the whole Programming Sheet, or
Custom to set a zoom percentage.
Figure 54: Zoom
Zoom Out Zooms out of the Programming Sheet. Every time you
click this command, the zoom percentage decreases
by 25%. The Programming Sheet can also be zoomed
out of by pressing Ctrl+Shift+O on the keyboard or by
pressing Ctrl and rolling the mouse wheel down (if a
wheel-mouse is available).
Full Screen Maximizes EC-gfxProgram to occupy the entire screen.
Full Screen can be toggled by pressing F11 on the
keyboard.
EC-gfxProgram 95
Show/Hide buttons
Parameter Description
Thumbnail Shows or hides the Programming Sheet thumbnail.
Figure 55: Programming Sheet Thumbnail
See also Thumbnail.
Gridlines Shows or hides the Programming Sheet gridlines.
Panes button
Parameter Description
Toolbox Displays and selects the Toolbox pane. This pane can
also be displayed and selected by selecting the
Toolbox pane or by pressing F7 on the keyboard.
Code Library Displays and selects the Code Library pane. This pane
can also be displayed and selected by selecting the
Code Library pane or by pressing F8 on the keyboard.
Properties Displays and selects the Properties pane. This pane
can also be displayed and selected by selecting the
Properties Pane or by pressing F4 on the keyboard.
Error List Displays and selects the Error List pane. This pane can
also be displayed and selected by selecting the Error
List pane or by pressing F12 on the keyboard.
Output Opens the Output pane.
Project Explorer Displays and selects the Project Explorer pane. This
pane can also be displayed and selected by selecting
the Project Explorer pane or by pressing F6 on the
keyboard.
Watch List Displays and selects the Watch List pane.
Statistics Displays and selects the Statistics pane. This pane can
also be displayed and selected by selecting the
Statistics pane.
Resource Displays and selects the Resource Viewer pane. This
Viewer pane can also be displayed and selected by selecting
the Resource Viewer pane or by pressing F3 on the
keyboard.
96 EC-gfxProgram
User Interface Overview
Parameter Description
Messages Opens the Messages history window.
History
Task Viewer Opens the Task Viewer window.
Messages The Messages History window lists all system or network errors.
history
Figure 56: Messages History window
EC-gfxProgram 97
Tools ribbon
This ribbon manages EC-gfxProgram applications.
Figure 57: Tools ribbon
Tools button
Parameter Description
Toolbox Builder The Toolbox Builder is a tool that allows you to create
your own blocks from project code snippets that can be
distributed to your colleagues in a toolbox. This allows
you to:
• Standardize and reuse project code in your organi-
zation by sharing toolboxes.
• Complete jobs faster and simplify field support by
providing technicians with tested, non-modifiable,
application-specific blocks that are known to work.
• Centralize the maintenance of a block’s logic and
updates to be easily applied to user’s code.
See The Toolbox Builder Tool.
Select Device Opens the Select device window. Select the device on
the network to connect to for programming and
debugging purposes.
Device Opens the Device information window.
Information
NOTE: This information is only available if the device is
connected and online.
Upgrade Upgrade the firmware of devices that are online on the
Firmware ECL, network. See Upgrade firmware (for ECL Series or
ECB & ECY ECB Series controllers only) and Upgrade firmware (for
Series ECY Series controllers).
controllers only
Export to EDE Allows you to export the project’s BACnet Objects into
an Engineering Data Exchange (EDE) file format,
which is a standard format that uses a collection of .csv
files to share information about BACnet controllers
between vendors.
98 EC-gfxProgram
User Interface Overview
Select device The Select Device window displays the devices available on the current net-
work and allows one to be selected so as to open it in an application for pro-
gramming and debugging purposes.
Figure 58: Select Devices window
Clear Show only current device type to show all devices available on the
network.
Device The Device Information window displays device information according to the
information type of controller that is currently connected. This includes the date and time,
user name, and on which computer the last build and backup was performed
for this project among other information.
Figure 59: Device Information window
EC-gfxProgram 99
The Device Extensions tab displays information about hardware connected to
the controller.
Figure 60: Device Information window
Upgrade Upgrade the firmware of one or more compatible ECL Series or ECB Series
firmware (for devices, ECx-400 Series Extension Modules, operator interface modules,
ECL Series or ECx-Display, Multi Sensor, or ComSensors with the Firmware Upgrade wiz-
ECB Series ard. This sends a firmware file across the network to one or more controllers.
controllers only)
The ECx-400 Series Extension Module, operator interface module, ECx-Dis-
play, Multi Sensor, or ComSensor firmware upgrade files are separate from
controller firmware upgrade files. As such, they must be sent to the controller
by running the Upgrade Firmware tool for each firmware upgrade file to be
sent to the controller. For example, should a controller and its attached ECx-
400 Series Extension Module (or ComSensor) require firmware upgrades,
both firmware upgrade files must be sent to the controller by running the
Upgrade Firmware tool twice: The first time to upgrade the controller with the
controller firmware upgrade, and a second time to send to the controller the
ECx-400 Series Extension Module (or ComSensor) firmware upgrade.
In the case of ECx-400 Series Extension Module, operator interface module,
ECx-Display, Multi Sensor, or ComSensor firmware upgrade, the controller
then sends the upgrade file onto any connected ECx-400 Series Extension
Module(s), operator interface module, ECx-Display, Multi Sensor, or ComSen-
sor(s) which then self-upgrade. Once the file has been downloaded and it has
been transferred to its final destination, the device’s operation is interrupted
while the new firmware is swapped into place. For controller firmware
100 EC-gfxProgram
User Interface Overview
upgrade, it is normal that the controller’s STATUS led blinks during this opera-
tion. Do not disconnect communication wiring or remove power from the con-
troller, ECx-400 Series Extension Module(s), Multi Sensor, or ComSensor(s)
during a firmware upgrade.
There is no harm to upgrade a controller with an ECx-400 Series Extension
Module(s), operator interface module, ECx-Display, Multi Sensor, or ComSen-
sor(s) firmware upgrade file when there are no ECx-400 Series Extension
Modules, operator interface module, ECx-Display, Multi Sensor, or ComSen-
sors connected to the controller. The firmware that an ECx-400 Series Exten-
sion Module, Multi Sensor, or ComSensor uses is always loaded from the
controller when it is first connected to the controller. Therefore, the ECx-400
Series Extension Module’s or ComSensor’s firmware version is always the
same as the firmware version stored in its associated controller.
Upgrade the firmware for each type of device (controller, ECx-400 Series
Extension Modules, Multi Sensor, or ComSensors), one type of device at a
time as follows.
1. EC-gfxProgram must not be in Debugging mode (see Controller connec-
tion and debugging status indicators). Click the Stop button on the Home
ribbon, Debugging buttons.
2. Select Upgrade Firmware from the Tools ribbon.
3. Select the available devices to upgrade on the network. Clear Show only
current device type to show all compatible devices on the network. Click
Next.
Figure 61: Select the devices to upgrade
EC-gfxProgram 101
4. Click to select the firmware file to download to the device. Click Open.
Figure 62: Select the firmware file to use for the upgrade
5. From your PC’s filesystem, select the firmware file to upload. Click Open.
A summary screen shows if the selected firmware file is compatible with
the controller model and the firmware file is not corrupt (CRC check is
sucessful).
6. Set Upgrade firmware regardless of current device firmware version
to allow a firmware down-grade on the controller with an earlier firmware
version.
Figure 63: Firmware file status
102 EC-gfxProgram
User Interface Overview
7. Click Next. Allow the download and upgrade to complete.
Figure 64: Firmware upgrade progress
An upgrade report shows if the upgrade was sucessful.
8. Click Next and then Finish.
Upgrade Firmware for Subnet extensions used by the Subnet Extension (ECL
firmware for Series) and Subnet Extension (ECB & ECY Series) blocks can also be
Subnet upgraded by sending the firmware for the Subnet extension to the con-
extensions troller which will then send the upgrade on to the Subnet extension. How-
ever, the controller is only able to internally save the firmware for one
Subnet extension at a time (only the last Subnet extension firmware will
be kept in the controller). Because of this, to upgrade the firmware for two
different types of Subnet extensions, proceed as follows:
1. Upgrade the firmware on the controller for the first Subnet extension. See
Upgrade firmware (for ECL Series or ECB Series controllers only).
2. Wait for the controller to upgrade the Subnet extension’s firmware.
3. Upgrade the firmware on the controller for the second Subnet extension.
See Upgrade firmware (for ECL Series or ECB Series controllers only).
Upgrade Upgrade the firmware of one or more compatible ECY Series controllers and
firmware (for related modules. This opens the controller’s web interface through which the
ECY Series firmware files can be uploaded to the controller. See the ECLYPSE User
controllers) Guide for more information.
EC-gfxProgram 103
Help
These buttons are used to access EC-gfxProgram‘s help file, as well as the
version and build number in About.
Figure 65: Help and software information
Parameter Description
Help: Opens EC-gfxProgram’s Help system table of
Contents
contents.
About Shows the version and build number.
104 EC-gfxProgram
User Interface Overview
Controller connection and debugging status indica-
tors
The connection status indicators show the current EC-gfxProgram’s connec-
tion status to the network management software (and database) and to the
controller itself.
Figure 66: Connection and debugging status with EC-Net
Server’s IP Server’s Path to the
Address Controller
Debugging EC-Net 4 Server’s Controller’s
Activity Connection Status Connection
Status
NOTE: When the LNS / EC-Net Server and Controller’s Connection Status
indicators are green, the Debugging Activity status indicator is shown
only when debugging has been started. To start debugging, see
Debugging buttons.
Figure 67: Connection and debugging status with LNS
LNS’sConnection Path to the
Port Controller
Debugging LNS’s Connection Controller’s
Activity Status Connection
Status
Interpret the LNS / EC-Net server status indicators as follows.
LNS / EC-Net
Server’s
Description
Connection
Status
Connected Connection to LNS or EC-Net server has been
Green established and is online.
Disconnected There is no connection to the LNS or to EC-Net server.
Red Verify your IP connection to the server.
EC-gfxProgram 105
Interpret the controller’s connection status indicators as follows.
Controller’s
Connection Description
Status
Connected The controller is commissioned and online. Full EC-
Green gfxProgram functionality is available. Project code can
be sent to the controller and live debugging values can
be viewed.
Disconnected The controller is commissioned but is unreachable.
Red Project code can be created and saved into the
network database if the LNS / EC-Net server status is
Connected.
Verify that the controller’s TX and RX LEDs show
communication activity. Refer to the controller’s
installation guide for more troubleshooting tips.
Uncommissioned The controller is in the database but it is
Grey uncommissioned.
Commission the controller in LNS or in EC-Net.
When debugging is available (the LNS / EC-Net Server and Controller’s Con-
nection Status indicators are green) and has been started (see Debugging
buttons), interpret the debugging status indicator as follows.
Debugging
Description
Activity
Debugging is The controller is online. Full EC-gfxProgram
Active functionality is available. Project code can be sent to
the controller and live debugging values can be viewed.
Green Blink
Debugging Debugging values are sporadically being received.
information is Debugging values shown in EC-gfxProgram may not
intermittent be reliable.
Yellow Fast The network may be saturated with traffic. Verify that
Blink the controller’s TX and RX LEDs show communication
activity.
Debugging is EC-gfxProgram has not received any debugging values
Unavailable from the controller. Debugging values shown in EC-
gfxProgram are unreliable.
Red Fast
Blink The network may be saturated with traffic. Verify that
the controller’s TX and RX LEDs show communication
activity.
106 EC-gfxProgram
User Interface Overview
Debugging
Description
Activity
No Indicator: Debugging has been stopped or debugging has timed
Debugging is out due to a persistent communication failure with the
stopped controller. When communication has been re-
established with the controller, start debugging again.
EC-gfxProgram 107
Shortcuts
Several commands have a keyboard shortcuts associated with them for more
rapid use. The table below shows the most useful keyboard shortcuts.
Description Shortcut
Save Ctrl+S
Close the currently viewed document Ctrl+F4
Print Ctrl+P
Work Offline F10
Undo Ctrl+Z
Redo Ctrl+Y
Cut Ctrl+X
Copy Ctrl+C
Paste Ctrl+V
Duplicate Ctrl+D
Delete Delete
Encapsulate into a Custom block (Encapsulate Ctrl+E
shortcut)
Select All Ctrl+A
Find object (Find object and replace object) Ctrl+F
Add Monitor blocks to all unconnected output Ctrl+space
ports of one or more selected blocks
Auto Increment Block Numbers (Auto increment Ctrl+Shift+A
(ECP & ECL Series and EBC Series controllers
only) or AAuto increment (ECY Series controllers
only))
View Project Explorer (Project Explorer) F6
View Properties (Properties) F4
View Error List (Error List) F12
View Toolbox (Toolbox) F7
View Code Library (Code Library) F8
View Resource Viewer (Resource Viewer) F3
Zoom In Ctrl+Shift+I
Zoom Out Ctrl+Shift+O
108 EC-gfxProgram
User Interface Overview
Description Shortcut
View Full Screen F11
Build Project Ctrl+B
Build And Send To Device Ctrl+Shift+B
Project Synchronization F9
Start Debugging F5
Stop Debugging Shift+F5
Move selected block(s) up ↑
In the Resources Configuration window, move the
Resource Tree selection to the item above the
currently selected item
Move selected block(s) down ↓
In the Resources Configuration window, move the
Resource Tree selection to the item below the
currently selected item
Move selected block(s) left ←
In the Resources Configuration window, collapse
the selected branch in the Resource Tree
In the Trend Log Viewer, scroll left
Move selected block(s) right →
In the Resources Configuration window, expand
the selected branch in the Resource Tree
In the Trend Log Viewer, scroll right
Autolinking ports between blocks Ctrl+q (quick link)
l (lower case L) while
the block is being
moved
EC-gfxProgram 109
Programming sheet
This is the main section of the user interface and is where device program-
ming is done. Block objects are dragged and dropped from the Toolbox pane
onto the programming sheet and then linked together using a “click, drag, and
release” technique.
The programming sheet contains a grid background and an automatic “snap”
function that allows for easier sizing and aligning of blocks on the sheet.
The programming sheet is everything shown in a tab. EC-gfxProgram
expands the view automatically for the content you place of the sheet, but not
the page size. The page size represents the white part of the view. It is also
the portion of the drawing that will be printed (blocks outside the page will be
cut off when printed). Placing blocks outside the white area is not a problem to
coding a program. However, the Thumbnail view only displays the page part
of the Programming Sheet.
Figure 68: Programming sheet
Resizing the programming sheet
The programming sheet can be resized to match the desired size of the block
coding on the sheet through the Page Setup window. This window can be
accessed either by:
• Right-clicking an empty spot on the programming sheet and selecting
Properties from the drop-down menu, click the button in the Page-
110 EC-gfxProgram
User Interface Overview
Size field of the Properties pane (next to Page Size), or right-click the pro-
gramming sheet in the project explorer and select properties.
Figure 69: Accessing the Page Setup window through the Properties pane
• Clicking the File menu, Print then Page Setup. See Page Setup.
EC-gfxProgram 111
Tabs to access programming sheets
A project can have more than one document of block coding. By default EC-
gfxProgram will display the first document of the project when started. The
other documents are shown as tabs in the upper left corner of the Program-
ming Sheet.
Figure 70: Programming sheet document tabs
To access the other documents simply click on the desired document tab. The
other documents will also be displayed in the Project Explorer pane.
Adding another document to the programming
sheet
As described in Tabs to access programming sheets it is possible for a project
to have more than one document. Add another document as follows:
• In the Home ribbon, select Add in Project buttons and then click Pro-
gramming Sheet.
• Right-click the project name in the Project Explorer and select Add, Pro-
gramming Sheet.
A new document tab will appear in the upper left corner of the Programming
sheet as shown in the above figure.
Reopening a closed document
If a tab is closed by having clicked , reopen it by double-clicking the docu-
ment name in the Project Explorer.
Figure 71: Closing a document tab
112 EC-gfxProgram
User Interface Overview
Reordering documents
There are two ways to reorder documents:
• Reorder documents in the Project Explorer by dragging a document it to a
new position. The document tabs are not reordered as a result of this
operation. When the project is saved and reopened, the document tabs
will be in the order set in the Project Explorer.
• A document tab can be reordered by dragging it to a new tab position.
This reordering is temporary and is not saved with the project.
Removing a document from the programming
sheet
Remove a document as follows:
1. Right-click the document in the Project Explorer and select Delete.
NOTE: Undo (Ctrl+Z) is not available to restore a deleted document.
Shortcuts to switch between documents
You can switch between opened documents by pressing Ctrl+Tab.
Figure 72: Selecting an open document (press Ctrl+Tab)
EC-gfxProgram 113
Showing multiple documents in the same view
You can display multiple documents in the same view at the same time by
splitting the screen in two or more regions by dragging the tab over the pro-
gramming sheet.
Figure 73: Displaying multiple documents in the same view
When you drag and drop a tab on the programming sheet, the following
options are shown.
Figure 74: Tab options
Parameter Description
New Horizontal Place the tab into a new horizontal tab window.
Tab Group
Move to Next Moves the tab into the horizontal tab window.
Tab Group
114 EC-gfxProgram
User Interface Overview
Thumbnail
The srogramming sheet employs a dynamic Thumbnail display in the upper
right corner. The Thumbnail displays the current view of the Programming
Sheet (marked by the purple box) with a miniature representation of the block
layout. The purple box can also be used to move the view to another part of
the Programming Sheet simply by clicking and dragging the box around the
Thumbnail display.
Figure 75: Thumbnail
The thumbnail can be disabled by deselecting Thumbnail in the View ribbon.
See Show/Hide buttons.
EC-gfxProgram 115
Utility panes
EC-gfxProgram contains several utility panes. These panes serve to provide
tools for control sequence development, organization, configuration, and
monitoring. Furthermore, these panes are dynamic and can be arranged any-
way the user wants.
Figure 76: Recommended layout
Pane dynamics
All the utility panes have dynamic properties. These properties affect how
these panes are displayed, moved, and selected. The following is a list of the
dynamic properties of utility panes:
• Opening and closing
• Auto-hiding and pinning
• Moving and docking
116 EC-gfxProgram
User Interface Overview
Opening and closing
When EC-gfxProgram is first launched, all the utility panes are open by
default. If for some reason a utility pane is closed, it can be opened by one of
the following methods:
• From the View ribbon, Panes button, click the utility pane that is to be
opened.
• Press the shortcut button of the utility pane that is to be opened. For
example, Press F7 to open the Toolbox pane. See Shortcuts for a list of
available shortcuts.
A utility pane can be closed by one of the following methods:
• Click the in the top-right corner of the pane.
• Right-click the title area of the pane and check the Hide option.
Auto-hiding and pinning
The auto-hiding feature allows the utility panes to appear when they are
needed and move aside when they are not used. This allows the maximum
amount of the programming sheet to be visible at all times.
The way this works is that when the mouse pointer is placed over a utility
pane, it will open and remain open until the mouse pointer moves off of the
utility pane. If a utility pane is left-clicked anywhere on the pane by the mouse
pointer, it will open and remain open until the mouse pointer left-clicks any-
where off of the utility pane.
Figure 77: Auto-hide feature
EC-gfxProgram 117
The pinning feature does the opposite of the auto-hiding feature and allows
the utility panes to remain displayed on EC-gfxProgram even if it is not being
used at the moment. This keeps all the usability of the utility panes immedi-
ately available to the user; however this reduces the available space for view-
ing code.
Figure 78: Pinning feature
The auto-hiding and pinning features can be enabled in one of the following
ways:
• Click the pin in the top-right corner of the pane. means the auto-hiding
feature is enabled and means the utility pane is held open (pinning fea-
ture is enabled).
• Right-click the title area of the pane and check the Auto Hide option to
enable the auto-hiding feature or deselect it to enable the pinning feature.
Moving and docking
When EC-gfxProgram is first launched, all the utility panes are already
docked to certain sides of the user interface. However, the panes can be
moved and docked anywhere on the interface. This way, the users can cus-
tomize their development environment anyway they want.
To move a utility pane:
1. Display the pane.
2. Pin the pane ( ).
3. With the mouse, left-click and hold the title area of the pane.
4. Drag the pane to the desired location and release the left button of the
mouse.
When a pane is moved, it can either be left floating (on a second monitor, if
you PC has one) or it can be docked. To leave it floating:
• Simply drag and drop the pane to some location.
• Right-click the title area of the pane and check the Floating option.
118 EC-gfxProgram
User Interface Overview
When a pane is being moved, certain indicators appear on the user interface.
If a pane is dragged over one of these indicators, it is docked to a certain spot
on the interface, depending on which indicator is selected.
Figure 79: Docking indicators
Outer docking If a pane is docked using one of the outer indicators, it will use up the maxi-
indicators mum space of the user interface and “push” other panes out of the way.
Figure 80: Outer docking
EC-gfxProgram 119
Inner docking The inner docking indicators move with the selected pane. What this means is
indicators that if the selected pane is held over the Programming Sheet, the inner dock-
ing indicators will appear and apply to the Programming Sheet. Likewise, if
the selected pane is held over some other displayed utility pane, the inner
docking indicators will appear and apply to the displayed utility pane.
Figure 81: Inner docking indicators location
120 EC-gfxProgram
User Interface Overview
If a pane is docked using one of the inner arrow indicators, it will use up the
maximum space within the area in which the inner indicators are located and
will not “push” other panes out of the way.
Figure 82: Inner docking
EC-gfxProgram 121
If a pane is docked using the middle inner indicator, it will create a tab for the
pane within the area in which the inner indicators are located. When a tab is
created, all the tabs in the same area are grouped together. Thus pinning or
moving operations are done on all panes that are tabbed together.
Figure 83: Tab docking
122 EC-gfxProgram
User Interface Overview
Pane types
The following utility panes are used for a variety of purposes. The following is
a list of these panes:
• Toolbox
• Code Library
• Project Explorer
• Properties Pane
• Output
• Error List
• Statistics
• Resource Viewer
• Search Results
• Task Viewer
• Watch List
Toolbox
The Toolbox pane is where the block object library can be found. Blocks are
dragged and dropped from the Toolbox pane onto the programming sheet for
you to connect them together to form working code.
NOTE: Programming code / code snippets cannot be dragged into a Text
Document or Configuration Assistant sheet.
The blocks are divided into 14 different categories. For more information on
the block object categories and the block objects themselves, refer to the
Block Objects section.
EC-gfxProgram 123
To help you find a block in any toolbox, use the search tool: Type the name of
a block and the search results are shown in real time.
Figure 84: Toolbox pane showing the search feature at the top
Figure 85: Toolbox pane
Custom A standard library of blocks is provided with the installation. A custom toolbox
toolboxes can contain predefined blocks for the specific needs of a designer that makes
coding more efficient and standardized.
Toolbox blocks are template driven. This means that by updating a custom
toolbox block and installing the toolbox on all design PCs, the project code in
a project that uses the updated blocks will automatically adopt the update and
apply the new project code’s behavior. This is unlike a snippet, where updat-
ing a snippet does not update snippets that have already been added to a
programming sheet.
Toolbox blocks cannot be modified and the project code for a block cannot be
viewed by a user.
124 EC-gfxProgram
User Interface Overview
Information about the selected toolbox (including the version) can be viewed
by clicking .
For more information about how to create a toolbox, see The Toolbox Builder
Tool.
Code Library
The Code Library pane contains saved applications, projects, codes, or parts
of codes (snippets) that can be dragged and dropped onto the Programming
Sheet.
Figure 86: Code library pane
Right-click on a code library folder to open a drop-down menu that has func-
tions to populate the pane with folders, projects, and code snippets.
Figure 87: Code library right-click selection menu
EC-gfxProgram 125
Parameter Description
Add Adds a new folder, a code snippet saved on the PC, or
a project saved on the PC. Selecting New Folder
creates a new folder in the Code Library which helps to
keep projects and code snippets organized. New
folders can be created within existing folders and can
be renamed.
Selecting Code Snippet From File opens the Open
window where one or more snippet files can be opened
and added to the Code Library. These snippets can
then be dragged and dropped onto the programming
sheet to be integrated within the existing code.
Selecting Project From File opens the Open window
where a project file can be opened and added to the
Code Library. These projects can then be opened by
dragging and dropping them onto the Programming
Sheet.
NOTE: Dragging and dropping a project from the Code
Library will close any open project on the Pro-
gramming Sheet.
By default, the Code Library and all folders,
code snippet files and project files within the
Code Library are saved on the PC. Use the
Open Containing Folder option to see where
these files are located. It is easy to share proj-
ects, code snippets or an entire Code Library
by simply copying or sending the respective
project files, snippet files, or Code Library fold-
ers from one PC to another.
Export to file Saves the selected code library content including
subfolders to an archive file (using the Zip compression
format). The resulting Zip file can then be shared with
others by decompressing it on another PC in the
CodeLibrary directory: Use the Open Containing
Folder option to see where these files are located.
Delete Removes the selected folder, snippet or project from
the Code Library and from the PC. Selected folders,
snippets, and projects can also be removed by
pressing Delete on the keyboard. Deleted files are sent
to the Windows Recycle Bin.
Rename Makes the name of the selected folder, snippet or
project editable.
Open Containing Opens a Microsoft Windows® file explorer in the
Folder directory where the Code Library file / directory is
located on your PC.
126 EC-gfxProgram
User Interface Overview
Right-click on a project in the Code Library to open a drop-down menu and
export the project to a file on the PC.
Figure 88: Code library drop-down menu - Project
Parameter Description
Open Opens the project. The project can also be opened by
dragging and dropping it onto the programming sheet.
NOTE: When importing a project code that was created
for another controller using blocks that have no
direct equivalent in the current programming
environment, these blocks are flagged with
“The object “[object name]” is not sup-
ported by the current device.” errors in the
Error List. If this occurs, see Object not sup-
ported by the current device.
Export To File Exports the selected project to the PC as a project file.
This opens the Save As window.
Delete Removes the selected project from the Code Library
and from the PC. Selected projects can also be
removed by pressing Delete on the keyboard.
Rename Makes the name of the selected project editable.
Open Containing Opens a Microsoft Windows® file explorer in the
Folder directory where the Code Library file is located on your
PC.
Right-click on a code snippet in the Code Library to open a drop-down and
export the code snippet to a file on the PC.
Figure 89: Code library drop-down menu - Code snippet
Parameter Description
Export To File Exports the selected code snippet to the PC as a
snippet file. This opens the Save As window.
EC-gfxProgram 127
Parameter Description
Delete Removes the selected code snippet from the Code
Library and from the PC. Selected code snippets can
also be removed by pressing Delete on the keyboard.
Rename Makes the name of the selected code snippet editable.
Open Containing Opens a Microsoft Windows® file explorer in the
Folder directory where the Code Snippet file is located on your
PC.
Adding projects A project file, code snippet file, or a directory containing these file types can
and code be added to the Code Library by dragging the files or directory from Windows
snippets from Explorer and dropping them onto the Code Library pane.
Windows
Explorer to the
code library
Saving a code Code snippets are an excellent way of saving a code, section of project code
snippet or Custom block so that it can be used again in either the same project or any
other one. This way if there is a certain function, process, or block that does
not exist in the Toolbox pane, it can be created and saved in the Code Library
as a code snippet.
Code Snippets save the configuration parameters of the individual blocks that
are used to make the Code Snippet.
To save a code snippet:
1. Select all the blocks that are to be saved.
Figure 90: Selecting blocks to be saved as a code snippet
128 EC-gfxProgram
User Interface Overview
2. Right-click one of the selected blocks and select Save As Code Snippet.
The Add To Library window will open.
Figure 91: Saving as a code snippet
3. Enter the name of the code snippet and where it should be stored in the
Code Library by selecting the desired folder from the Create in drop-
down list or click Create new folder to create a new folder in the currently
selected folder. Once you click OK, the code snippet will appear in the
Code Library and a snippet file will be saved in the default location. About
the Keep numbers option:
• Set Keep numbers to force an override of the Auto Increment fea-
ture (see Auto increment (ECP & ECL Series and EBC Series control-
lers only) or Auto increment (ECY Series controllers only)) in the
target project: The block numbers used in the current project code for
the snippet are the ones that will be imposed when the code snippet
is used in a future target project, regardless of whether Auto Incre-
ment is enabled or not in the target project.
• Clear Keep numbers to allow the Auto Increment feature (when
enabled) to reassign the code snippet’s block numbers to the first
ones available in the target project when the code snippet is used in a
target project. If the Auto Increment feature is not enabled in the tar-
get project, the current block numbers are maintained when the code
snippet is used in a target project.
Figure 92: Naming a code snippet
EC-gfxProgram 129
Figure 93: Code snippet in code library
Adding a snippet To add a snippet to a programming sheet, click a snippet in the Code Library,
to a drag, and drop it on to the Programming Sheet.
programming
sheet TIP: You can press and hold the Shift key as you drag a code snippet on the
Programming Sheet to insert it in its original location.
When you add a snippet to the Programming Sheet from the Code Library
that contains Input, Output, Constant, or Variable blocks, a popup asks if the
current configuration should be overwritten.
Figure 94: Override project resources dialog
Click Yes to have the block configuration parameters from the snippet over-
write the block configuration parameters used in the current project.
For example, when the Code Snippet was created, the configuration parame-
ters of the individual blocks that are used to make the Code Snippet were
saved in the Code Snippet. By clicking Yes, the settings saved in the Code
Snippet will override the current settings of the same blocks used in the proj-
ect. This applies to countable resources found in the Resource Viewer or in
the Resources Configuration window such as Pid, Hardware Input, Analog
Value (ECB & ECY Series), Constant Enum (ECP Series), Constant Numeric
(ECP Series), Variable Enum (ECP Series), Variable Numeric (ECP Series),
Network Variable Input, Hardware Output, Network Variable output,
ComSensor, Schedule, Timer, etc.
Click No to keep the block configuration parameters used in the project.
NOTE: When importing a snippet that was created for another controller using
blocks that have no direct equivalent in the current programming envi-
ronment, these blocks will be flagged with “The object “[object
name]” is not supported by the current device.” errors in the Error
List. If this occurs, see Object not supported by the current device.
130 EC-gfxProgram
User Interface Overview
Project Explorer
The Project Explorer pane employs a tree-view list that allows for easy navi-
gation through the documents and blocks of a project.
Figure 95: Project Explorer pane
Double-clicking a block displayed in the Project Explorer pane highlights it on
the programming sheet (the block will have a blinking highlight around it) and
loads its properties in the Properties Pane. Double-clicking a document opens
it.
EC-gfxProgram 131
Right-click on the project name or an empty space in the Project Explorer to
open a drop-down menu containing functions that pertain to the management
of the project.
Figure 96: Project Explorer drop-down menu - Project
Parameter Description
Add Adds a programming sheet, Text Document, or
Configuration Assistant Sheet tab to the current project.
A new Programming Sheet can also be added by
selecting Add, then Programming Sheet from the File
menu menu or by pressing Ctrl+N on the keyboard. A
new document tab is added to the upper left corner of
the Programming Sheet.
The different open documents of the project can be
navigated through by the Project Explorer pane or by
selecting the desired document tab from the
Programming Sheet
Figure 97: Add Programming Sheet, Text Document, or
Configuration Assistant
See also Text documents.
Rename Makes the name of the current project editable.
Properties Opens the Properties Pane to display the properties of
the project. This pane can also be displayed by clicking
the Properties button on the View ribbon in Panes
button, or by pressing F4 on the keyboard.
132 EC-gfxProgram
User Interface Overview
Project The project Properties Pane allows the measurement system of the project to
properties be set and contains information about the project file.
Figure 98: Project Properties
Parameter Description
(Name) Enter the name of the project.
Enumeration Place your mouse cursor over this field and click the
System
button to open the Enumeration Configuration
window. This allows you to add or modify the
enumerations available in this project. For ECL, ECB &
ECY Series controllers, you can also import the
enumerations previously saved from another project or
export the enumeration from this project. See Creating
and using enumerations (ECP Series), Creating and
using enumerations (ECL Series), or Creating and
using enumerations (8-Bit).
EC-gfxProgram 133
Parameter Description
Measurement Select Metric or US as the measurement system of the
System project. This setting affects the measurement units
used by the project, not EC-gfxProgram (for example,
the units to be used with the Psychrometric blocks).
Depending on the blocks that are in the code, when
you change the measurement system, the project code
may have to be synchronized with the controller. A
message will inform you of this the next time you start
the debug mode.
NOTE: On initial start of EC-gfxProgram, the default
measurement system of EC-gfxProgram will
take the measurement system of the PC. Simi-
larly, when a new project is created, the project
measurement system will take the measure-
ment system set in EC-gfxProgram Options.
Location (ECP & Specify where the device is located. This is written in
ECL Series SCPTlocation configuration property under the device
controllers only) NodeObject.
MaxSendTime The maximum time period between automatic
(ECP Series transmissions of the network variable on the network
controllers only) (whether or not the variable's value has changed). This
is a LONWORKS communications setting. Setting
MaxSendTime to 0 disables it.
The MaxSendTime is often referred to as the
"heartbeat". If MaxSendTime is configured for the
corresponding network variable input, the
recommended setting for this value is half the Max
receive time value.
The values of Variable Numeric (ECP Series), Variable
Enum (ECP Series), Wireless, SmartSensor,
Hardware Input, and Hardware Output blocks are
exposed in network variable output structures of the
Program object in the device.
This applies to Variable Numeric (ECP Series),
Variable Enum (ECP Series), Boolean, Enum,
Numeric, and all Inputs and Outputs blocks except
Network Variable Input (ECP Series) and Network
Variable Output (ECP Series) blocks.
134 EC-gfxProgram
User Interface Overview
Parameter Description
MinSendTime The minimum time period that must pass between
(ECP Series network variable updates on the network. If the value of
controllers only) the network variable changes, an update will only be
sent after this time expires. This is a LONWORKS
communications setting. Setting MinSendTime to 0
disables it.
The MinSendTime is often referred to as the "throttle".
The values of Variable Numeric (ECP Series), Variable
Enum (ECP Series), Wireless, SmartSensor,
Hardware Input, and Hardware Output blocks are
exposed in network variable output structures of the
Program object in the device.
This applies to Variable Numeric (ECP Series),
Variable Enum, Boolean, Enum, Numeric, and all
Inputs and Outputs blocks except Network Variable
Input (ECP Series) and Network Variable Output (ECP
Series) blocks.
Author Enter the name of the author of the project.
ControllerType Enter the type of controller for which the project is
created.
CreationDate Displays the date and time when the project was first
created (Read-Only).
Description Enter a description of the project.
Identifier An alphanumeric string automatically generated when
a project is opened or created. It can be modified.
NOTE: For ECLYPSE controllers, this identifier is used
when a project with Controller Specific configu-
rations is synchronized. If the identifier of the
project being downloaded is the same as the
identifier of the project on the controller, if the
project on the controller has no project identi-
fier, or if the project on the controller has a proj-
ect identifier but has no controller specific
configurations, controller specific configurations
are kept in the controller.
If the identifiers are not the same, the project
being downloaded overwrites all the configura-
tions in the controller.
LastModification Displays the date and time when the project was last
Date saved (Read-Only).
Version Enter the version number of the project.
EC-gfxProgram 135
Right-click on a document name in the Project Explorer to open a drop-down
menu containing functions that pertain to the selected document.
Figure 99: Project Explorer drop-down menu - Document
Parameter Description
View Content Displays the selected document on the programming
sheet. See View content.
Duplicate (for a This creates a copy of the programming sheet page
Programming including the Programming Sheet’s contents.
Sheet only)
Delete Deletes the selected document from the project.
Selected documents can also be deleted by pressing
Delete on the keyboard.
NOTE: Undo (Ctrl+Z) is not available to restore a
deleted document.
Rename Makes the name of the selected document editable.
Properties Opens the Properties Pane to display the properties of
the document. This pane can also be displayed by
clicking the Properties button on the View ribbon in
Panes button, or by pressing F4 on the keyboard.
Right-click on a block name in the Project Explorer to open a drop-down menu
containing functions that pertain to the selected block.
Figure 100: Project Explorer drop-down menu - Block
Parameter Description
Show Highlights the selected block on the programming
sheet.
136 EC-gfxProgram
User Interface Overview
Parameter Description
Delete Deletes the selected block from the project. Selected
blocks can also be deleted by pressing Delete on the
keyboard.
Rename Makes the name of the selected block editable.
Properties Opens the Properties Pane to display the properties of
the block. This pane can also be displayed clicking the
Properties button on the View ribbon in Panes button,
or by pressing F4 on the keyboard.
Properties
The Properties Pane is used to define the properties of the project, docu-
ments, and each block object in the programming sheet. The properties dis-
played in the pane are dependent on what is selected by the user. Properties
Pane options vary according to the controller model.
Figure 101: Properties pane
Some block objects have minimal properties where only the block’s name,
location, and width are definable through the Properties Pane. Other block
objects are more complex and possess separate Block Actions windows. For
more information on a block’s properties, refer to the Block Objects section.
For more information on a project’s properties, see Project properties.
EC-gfxProgram 137
Output
The Output pane shows background operations being done, such as the
progress of a build.
Figure 102: Output pane
Error List
The Error List pane indicates any errors that occur while building a project or
control sequence. This pane assists the user to locate, troubleshoot, and
debug problems.
Figure 103: Error List pane
The Error List pane will also show the user where exactly the problem is.
When an error message is double-clicked, a tooltip points to the input, output,
or object that is the source of the error on the programming sheet. In order to
avoid having build errors, refer to the Connection rules section.
When Show compilation errors in real-time is set in EC-gfxProgram Options,
project code errors are shown in real time. As you connect objects to make
valid code, errors are removed from the Error List pane.
138 EC-gfxProgram
User Interface Overview
Statistics
After a project is built, the Statistics pane will display certain statistics such as
memory usage, input, and output usage, compiling time, etc. This information
pertains to the device associated with the project.
Figure 104: Statistics pane (ECP & ECL Series and ECB Series controllers)
Figure 105: Statistics pane (ECY Series controllers)
Compiled code is stored in flash memory. The amount of memory varies by
controller model series. The RAM memory is used to store certain values that
depend on the block used, type of connections between blocks and block lay-
outs (for more information, see Block Objects). The blocks that have a limited
number of instances are also listed. Some blocks have the same usage limits
for all controllers and some are particular to the controller utilized (for more
information, see the Block Objects section).
Persistent Values are values that are saved by the controller during any type
of controller reset or power cycling. See Persistent values (ECP Series con-
trollers) and Persistent values (ECL, ECB & ECY Series controllers).
EC-gfxProgram 139
NOTE: When the option Show compilation errors in real-time is set in EC-gfx-
Program Options, the statistics are updated in real time. When the
option Show compilation errors in real-time is cleared, the statistics
are updated only when the project is built.
Resource Viewer
The Resource Viewer pane displays information about all the inputs, outputs,
constants, and variables in the device. These points can also be configured
and printed from this pane.
Figure 106: Resource Viewer pane (options vary according to controller model)
Depending on the tab selected and depending on the controller model, the
options and fields available in the pane will change.
The Resource Viewer always displays the project values except for Network
Variables as these values come from the network.
The Refresh All and Refresh Selected buttons read the values from the net-
work and update the project values accordingly. For example, if the project
contains the value 30 for Variable Numeric 1 and this value has been changed
on the network to 45, the Resource Viewer will continue to display 30 until you
click the Refresh button. When you click Refresh, the network value 45 then
replaces the value of the project.
Parameter Description
Refresh All Updates all the fields in the selected tab.
Refresh Updates the selected fields in the selected tab.
Selected
View Mode Select between Used Only and All. Used Only
displays only those blocks that appear in the
programming sheet. All displays every possible block
whether it is used in the project or not.
Quick Print Opens the Print window.
Export Exports the Resource Viewer pane data to a CSV file
that can be viewed in a spreadsheet. Depending on the
tab selected, the fields available for export will change.
140 EC-gfxProgram
User Interface Overview
Parameter Description
Add Floating Adds a Floating Pair output for use with the Floating
Pair (for ECP & Output object. This opens the Advanced Configuration
ECL Series and dialog for ECP Series controllers or Resources
ECB Series Configuration dialog for ECL, ECB & ECY Series
controllers only) controllers.
Delete Floating Deletes the selected Floating Pair output.
Pair (for ECP &
ECL Series and NOTE: When importing a project code that has more
ECB Series floating pair outputs than can be supported by
controllers only) the current controller, save your project to
remove these floating pair outputs. See File
menu.
Add Wireless Adds a wireless sensor input.
Sensor (ECB
Series only)
Delete Sensor Deletes the selected wireless sensor input.
(ECB Series
only)
Fields The fields shown vary according to the selected tab and according to control-
ler model.
Parameter Description
Source (for For controllers with one or more ECY-IO Series or ECx-
controllers that 400 Series Extension Modules connected to it, a
support Source column shows on which device the input or
Extension output is located: Controller, IO Module 1, or IO
Modules) Module 2.
Number Lists the block numbers.
Name Lists the block names. A block name can be edited by
clicking the name two times slowly (like a file rename in
Windows) or by selecting the block then selecting the
Name field in the block’s Properties Pane.
Description Lists the block descriptions. A block description can be
edited by clicking the description two times slowly (like
a file rename in windows) or by selecting the block then
selecting the Description field in the block’s Properties
Pane.
Type Lists the SNVT types for network variables.
Controller The block’s Controller Specific setting. See Controller
Specific (ECL, specific values and device synchronization options
ECB & ECY (ECL, ECB & ECY Series).
Series
controllers only)
EC-gfxProgram 141
Parameter Description
Sensor Name The ComSensor’s block descriptive name. A sensor
name can be edited by clicking the name two times
slowly (like a file rename in Microsoft Windows) or by
selecting the block then selecting the Name field in the
block’s Properties Pane.
Sensor Name The Wireless Sensor’s block descriptive name. A
module name can be edited by clicking the name two
times slowly (like a file rename in windows) or by
selecting the block then selecting the Name field in the
block’s Properties Pane.
Input Name The Wireless Sensor / ComSensor input’s descriptive
(ECP & ECL name. A Wireless Sensor / ComSensor input’s
Series descriptive name can be edited by clicking the name
controllers only) two times slowly (like a file rename in windows) or it
can be set in the block’s Advanced Configuration.
Object Name The Wireless Sensor / ComSensor’s BACnet object
(ECB Series name. A Wireless Sensor / ComSensor’s BACnet
only) object name can be edited by clicking the name two
times slowly (like a file rename in windows) or it can be
set in the block’s Advanced Configuration.
Initial Value The block’s initial value. See Initial value.
Visible (ECB When a Hardware Input (ECB & ECY Series) or
Series Hardware Output (ECB & ECY Series) block is added
controllers only) to a programming sheet, it is automatically exposed to
the BACnet network (Visible is shown as being set).
Force Visible Shows the status of Force Visible On. This indicates
(ECB Series that the Present Value of a hardware input or output is
controllers only) exposed to the BACnet network even when there is no
instance of a Hardware Input (ECB & ECY Series) or
Hardware Output (ECB & ECY Series) block on any
programming sheet.
Configuration These are Network Value (ECB & ECY Series)
Type properties from the Advanced Configuration screen.
See Advanced Network Value configuration (ECB
Access Type
Series) for details.
Operation
Device Instance
Object Instance
Property
Data Type
Status (ECB &
ECY Series
controllers only)
142 EC-gfxProgram
User Interface Overview
Parameter Description
Proportional The PID loop’s current proportional band value.
Band
Integral Time The PID loop’s current integral time value.
Derivative Time The PID loop’s current derivative time value.
Dead Band The PID loop’s current dead band value.
Bias The PID loop’s current bias value.
Ramp Time The PID loop’s current ramp time value.
Saturation Time The PID loop’s current saturation time value.
Reverse Action If False, the control loop acts directly. Thus an increase
in the error will be directly proportional to the output
(the more positive the error; the more positive the
output).
If True, the control loop acts in reverse. Thus an
increase in the error will be inversely proportional to the
increase in the output (the more positive the error; the
more negative the output).
Sat. Time Low The PID loop’s current saturation time low limit status.
Limit
Sat. Time High The PID loop’s current saturation time high limit status.
Limit
Default Value Lists the block’s default value.
NOTE: For ECP & ECL Series controllers only: For
Network Variables, depending on the SNVT
type of the block, the default value will change.
It is useful to know the default value of the block
to quickly detect when there is some kind of
network fault like a heartbeat failure since it is
the default value that will appear on the NVI.
Time Interval The Network Value (ECB & ECY Series)’s poll or write
(ECB & ECY interval time.
Series
controllers only)
Present Value Lists the current block’s value. The value is formatted
according to the format setting that you applied to the
block.
Mode (ECP & Lists the block modes.
ECL Series
controllers only)
EC-gfxProgram 143
Parameter Description
Format Lists the block formats. The format can be changed by
invoking the Configure Ports action on the
corresponding block.
Commissioned Used as a flag or means of verification. It has no effect
(ECP & ECL on the code.
Series
controllers only)
Edit Mode and Opens the Edit Mode and Value (ECP Series) window.
Value (ECP &
ECL Series
controllers only)
Configure (ECP Opens the hardware input or output Configuration
& ECL Series window.
controllers only)
Value Lists the block’s value.
Persist Lists the block’s persistency setting. See Persistent
values (ECP Series controllers) and Persistent values
(ECL, ECB & ECY Series controllers).
Current Value Lists the current block value.
(ECB & ECY
Series
controllers only)
Number of The number of resources a controller can support varies by model.
resources
supported by a Controller
controller Description
Model
ECB Series The number of resources that a controller can support
is found in the Resource Viewer: in the block object’s
ECL Series
tab, set the View Mode to All (see Figure 107). The
ECP Series Resource Viewer then lists all available block
instances.
This can also be found by referring to the specific block
in the Block Objects section or by selecting the block
on the programming sheet and pressing F1.
ECY Series The number of resources are limited by the controller’s
available memory resources. However, there is a limit
for the number of Analog Values that can be used in a
project. See Supported number of BACnet objects with
an ECY Series controller
144 EC-gfxProgram
User Interface Overview
Supported The number of BACnet objects an ECY Series controller can support depends
number of on the amount of current available memory during operation. The number of
BACnet objects trend logs and the number of BACnet objects used in your project code are
with an ECY the main factors that affect memory usage.
Series controller
• Limit your project code to use less than 2000 BACnet objects otherwise
controller performance may degrade. These BACnet objects are listed in
ECB & ECY Series resource block configuration.
• The combined buffer size of all trend logs should not exceed total 500 000
records. For example, this can be 100 trend logs with the buffer set to
5000 records or it could be 1000 trend logs with the buffer set to 500
records.
• Limit the total number of BACnet object that have alarms enabled to less
than 1000.
The number of hardware inputs and outputs depend on the type and quantity
of ECY-IO Series Extension Modules connected to the controller (see the con-
troller’s datasheet for more information). Once all the ECY-IO Series Exten-
sion Modules have been added to the Resource Tree (see Adding a
Hardware IO extension module (ECY Series)), the number of Hardware
Inputs and Outputs can be viewed in the Resource Tree under IO Modules.
Block options To configure a resource, right-click the resource in the Resource Viewer to
select any of the options from the drop-down list. See Advanced configuration
windows overview for more information about these configuration settings.
These options vary according to the block type and according to whether the
debug mode is running or stopped (see Controller connection and debugging
status indicators).
Before some items are shown in the drop-down list, the resource may have to
have been previously configured, set to Force Visible, or shown as Visible.
Figure 107: Right-click an entry in the resource viewer (options vary according to controller model)
ECB ECY
ECP & ECL
Series Series
Property Series Description
Controller Controller
Controllers
Object Object
Configure Opens the Resources Configuration
window where all numbered resources
are configured. Press F1 on the
keyboard once the configuration widow
is open for more information.
EC-gfxProgram 145
ECB ECY
ECP & ECL
Series Series
Property Series Description
Controller Controller
Controllers
Object Object
Opens the configuration window for the
selected block type. Press F1 on the
keyboard once the configuration widow
is open for more information.
Emergency Forces an output to assume a user-set
Override value at priority level 1. See Emergency
override and emergency auto (ECB &
ECY Series).
Emergency Clears an Emergency Override value
Auto at priority level 1. See Emergency
override and emergency auto (ECB &
ECY Series).
Change Type Sets the SNVT type for the selected
resources. This is typically used to
modify the variable type before creating
a binding. Sets the associated NVO on
the other controller(s) to the same
SNVT variable type. See Change Type
(ECP & ECL Series).
Override Forces the input / output to assume a
user-set value as its present value. See
Override and auto.
Auto Clears an Override value. See Override
and auto.
Set Value Forces an output to assume a user-set
value. See Set Value.
146 EC-gfxProgram
User Interface Overview
ECB ECY
ECP & ECL
Series Series
Property Series Description
Controller Controller
Controllers
Object Object
Force Visible Exposes the Present Value of the
On hardware input or output to the BACnet
network. When a Hardware Input (ECB
& ECY Series) or Hardware Output
(ECB & ECY Series) block is added to a
programming sheet, it is automatically
exposed to the BACnet network
(Visible is shown as being set).
When using a For Loop (ECL, ECB &
ECY Series) block with a Generic
Hardware Input or a Generic
Hardware Output block, these inputs
and outputs are not automatically
exposed to the BACnet network. Force
Visible On can be used to expose the
Present Value of a hardware input or
output to the BACnet network even
when there is no instance of a
Hardware Input (ECB & ECY Series) or
Hardware Output (ECB & ECY Series)
block on any programming sheet.
Force Visible Turns off the Force Visible On setting.
Off
Find All To know which blocks are using a
References resource, right-click a resource and
select Find All References.
Figure 108: Find All References in the
Resource Viewer
See Find All References (ECL, ECB &
ECY Series).
Add to Adds the selected resource to the
Favorites Favorites list. See Favorites List.
View Trend Opens the trend log for the selected
Log History resource. See Live Trend Log.
Clear Trend Clears the trend log history for the
Log selected resource.
EC-gfxProgram 147
Find object and replace object
As a result of having used Find Object or Replace Object, the Search
Results pane displays the results of a search for objects, inputs, outputs, and
object properties. To start a search or a search and replace, click Find Object
or Replace Object on the Home ribbon, Editing buttons, or press Ctrl+F on
the keyboard. The Replace Object option allows you to exchange the
searched text with new text.
The powerful search pattern language called Regular Expression can be used
to select and replace a complex information pattern when the Use regular
expressions option is selected.
Figure 109: Find Object dialog
Find Object search setting provide control over what objects will be found.
Parameter Description
Find Object tab Find objects within the scope set in Look in.
Replace Object Find and replace objects within the scope set in Look
tab in.
Find what Specify the text (a name or property) you are looking
for.
Replace with When the Replace Object tab has been selected, this
is the text to replace the text being searched for.
Look in Select if the search is to be limited to the current
project, or to all open projects.
The search will do a recursive search in Custom block
and Conditional Custom Block.
148 EC-gfxProgram
User Interface Overview
Parameter Description
Match case Select to make the search case sensitive.
Match whole Select to make the search finds complete words only
word (for example, if you search for Pid, it will not find Pid1).
Use regular Use a regular expression to find content. When this
expression option is enabled, click (a)+ in Find what to view a list
of basic regular expressions.
For example, RTU_2[0-9] will match all items in the
range from RTU_20 to RTU_29.
For more information about how to create a regular
expression to search for a specific criteria, search for
“regular expression” with an Internet search engine.
Search Focuses the search on specific data types:
• Block Properties: Permits the search to match text
found in object properties (Name) or TagName
field, when selected.
• Block Type: Permits the search to match text (for
block type, which is the second line of text in any
block header) when selected.
• Block Ports: Permits the search to match text for
input and output names (for example, Setpoint or
input), when selected.
• Resource Configuration Properties: Permits the
search to match text for resource properties (for
example, block instance Description), when
selected. Note that only the Find All and Replace
All options are available for this data type.
NOTE: When no data types are checked, the search is
performed on Block Names.
Find Next Search for and highlight the next instance.
Find All List all instances in the Search Results in the Search
Results window. See below.
Replace When the Replace Object tab has been selected, this
replaces the searched for text for with the Replace
with text.
Replace All When the Replace Object tab has been selected, this
replaces all searched for text instances for with the
Replace with text.
Replace Object When the Replace Object Properties tab has been
properties selected, this replaces the searched for property with
new properties (e.g.: Description, WatchVariableName,
ProgrammaticName or InputNames.
EC-gfxProgram 149
Search Results
Search results are shown in the Search Results pane. Double-click a search
result to focus the programming sheet on that object, which is shown high-
lighted.
Figure 110: Double-click a search result to focus the programming sheet on the search result
The Resources Configuration Properties search type returns all the blocks in
the project with a property containing the specified text. This includes blocks
used on the programming sheet ( ) as well as unused blocks configured in
the Resources Configuration window ( ).
Figure 111: Resource Configuration Properties search results
Task Viewer
EC-gfxProgram is able to carry out background tasks simultaneously during
project code creation. The Task Viewer shows the tasks waiting to be pro-
cessed.
Watch List
Shows a table of values from Monitor blocks in which a name has been
assigned to the WatchVariable in the Block’s Properties Pane of the Monitor
block.
150 EC-gfxProgram
User Interface Overview
Favorites List
The Favorites tab in the Resource Viewer is a convenient way to organize
and access resources that are important to you, thereby making system-criti-
cal information readily available. The Favorites list shows the resource’s
name, value, and format. Favorites can be organized into groups for conve-
nience.
For controllers equipped with an operator interface or it is connected to an
ECx-Display, the favorites added to the Favorites tab are also made available
in the controller’s Favorites menu, once the project code has been synchro-
nized with the controller (see Project Synchronization). See also Lcd Screen
(ECL, ECB & ECY Series).
NOTE: When a controller is equipped with an operator interface or it is con-
nected to an ECx-Display, only the first 50 favorites in each group will
be available on the controller’s LCD screen.
The following procedure describes how to create groups and add and orga-
nize favorites.
Adding and 1. In the Favorites tab, right-click on a blank area and select Add Group
organizing and enter the name of the group you wish to create.
favorites
Figure 112: The Favorites list in the Resource Viewer (options vary according to controller model)
EC-gfxProgram 151
2. To add a favorite, right click a resource in the Resource Viewer, and
select Add to Favorites (see Block options). The Favorites Group
Selection window is displayed.
Figure 113: Favorites Group Selection window
3. Select a pre-existing group to which the favorite will be added or click
Create New Group to create a new group.
NOTE: Not all resources that can be added to the Favorites list will become
available in the controller’s operator’s interface / ECx-Display (color
LCD screen), when equipped. For example, Network Value (ECB &
ECY Series) blocks and Internal variable (ECL, ECB & ECY Series)
blocks added as a Favorite will not be available on the controller’s
operator’s interface. Only the first 50 favorites in each group will be
available in the controller’s operator’s interface / ECx-Display (color
LCD screen).
4. To delete a favorite, right click an entry in the list and select Delete.
5. To view the selected favorite in the Resource Viewer, right click an entry
and select Show in Resource Viewer.
Figure 114: Right-click an entry in the Favorites list
6. To reorder entries in the Favorites list, click an entry and drag and drop it
into its new position within the list.
152 EC-gfxProgram
Resources Configuration
CHAPTER 4
Resources Configuration
This chapter describes the Resources configuration window.
Topics
Adding resources
Renumbering/Swapping Resources
Resources Summary view
Configuring properties
Configuring a resource block
Trending (ECY Series)
ENVYSION Data Tree (ECY Series)
Cleaning up unused resources in a project
For ECL, ECB & ECY Series controllers, the Resources Configuration win-
dow centralizes the configuration parameters of resource blocks, the control-
ler’s real time clock synchronization with other networked controllers, trend
logs, and for BACnet controllers, BACnet notification classes. For a list of
resource blocks, see ECL Series resource block configuration and ECB &
ECY Series resource block configuration.
The Resources Configuration window allows you to select more than one
resource block at a time to let you set a number of common configuration
parameters for the selected blocks (only values that are changed will be
applied to the selected blocks). The Resources Configuration window will
already be populated with any resource block that has been added to a Pro-
gramming Sheet. For ECB & ECY Series controllers, all objects configured in
the Resources Configuration window are exposed to the BACnet network.
The number of resources a controller can support varies by model. See Num-
ber of resources supported by a controller.
Accessing the The Resources Configuration window can be opened by double-clicking a
Resources resource block1 that has already been added to a programming sheet or by
Configuration clicking Open Configuration in the Home ribbon.
window
1.For Internal Variable and ComSensor blocks, right-click the block and
select Configure.
EC-gfxProgram 153
Figure 115: The Resources Configuration window
Item Description
1 The Resources Configuration toolbar. See Resources Configura-
tion toolbar.
2 To find a resource block by name, type one or more letters of its
name. Click to clear the search filter and restore the complete
Resource Tree view.
3 Resources configuration icons appear when certain configura-
tion options are enabled in an object’s configuration. See
Resources configuration icons.
4 The Resource Tree shows the resource types and any resource
block instances configured for this project. When a branch has
items underneath it, click to expand it or to collapse it.
When a resource block is selected in the tree, its properties are
shown in the right pane. When two or more resource blocks are
selected in the tree, their common properties are shown in the
right pane.
154 EC-gfxProgram
Resources Configuration
Item Description
5 When a resource block is selected in the tree, its properties are
shown in the right pane so you can configure them.
When two or more resource blocks are selected in the tree, their
common properties are shown in the right pane. You can modify
those common properties for all selected resource blocks (only
values that are changed are applied to the selected blocks).
6 Provides quick access to favorite and recently-used units. See
Favorite and recently-used units.
Click OK to synchronize and changes made to a resource’s configuration with
the controller. If the controller is offline, the changes will be synchronized
when the controller is online. Changes to the ENVYSION Data Tree will also
be synchronized with the controller.
Resources The following types of icons may be shown in the Resources Configuration
Configuration toolbar:
toolbar
• Icons mostly related to navigating the Resource Tree (always visible).
• Icons related to the current selection in the Resource Tree (visible based
on selection).
Icon Description
Go back to the previous navigation view.
Go forward to the next navigation view.
Collapse all items in the Resource Tree.
Expand all items in the Resource Tree.
Show/Hide the Resource Tree.
• Add a resource block instance of the selected resource type to
the current project. The next available block instance number
is used.
• Add a Time Sync Recipient to the Real Time Clock (ECB &
ECY Series) block.
Adds a range of resource block instances of the selected resource
type to the current project tree. See Figure 118.
Opens the configuration for the currently selected ComSensor
instance. See ComSensor Scenes Configuration window (ECB &
ECY Series) and ComSensor (ECB & ECY Series).
Cut an ENVYSION Data Tree resource reference.
Copy an ENVYSION Data Tree resource reference.
EC-gfxProgram 155
Icon Description
Paste an ENVYSION Data Tree resource reference that has been
cut or copied.
Rename a resource instance.
Delete the selected resource or resource reference instance. For
ECB Series controllers, when you delete a block instance in the
Resources Configuration window, it is also deleted from your proj-
ect and from the controller.
Set the format for the selected resource. See Format editor.
Make a copy of the currently selected resource.
When a hardware ECx-400 Series Extension module is selected,
create a floating pair.
When two hardware outputs are selected, co-join the outputs to
create a floating output or floating pair.
See Adding a Floating Output (ECL Series) or Adding a Floating
Output (ECB & ECY Series).
Remove unknown references from the ENVYSION Data Tree.
This is necessary when an underlying resource in the ENVYSION
Data Tree has been removed from the configuration, but the refer-
ence to it still remains.
Import the ENVYSION Data Tree structure that was saved on your
file system. Opens the Open window.
Export the ENVYSION Data Tree to your PC’s file system. The
Save As window opens.
Imports the ENVYSION Data Tree structure from the currently con-
nected device.
Opens a window listing all unused resources in the project so you
can clean up the project.
Resources The following icons appear in the Resources Configuration when certain con-
configuration figuration options have been enabled in an object’s configuration.
icons
Icon Description
An alarm has been configured for this object instance. See Alarms
(ECB & ECY Series).
A trend log has been configured for this object instance. See
Trending (ECY Series).
This object instance has been set as Controller specific. See Proj-
ect Synchronization and Controller specific values and device syn-
chronization options (ECL, ECB & ECY Series).
156 EC-gfxProgram
Resources Configuration
Icon Description
The configuration for the resource is invalid. Select the resource
and ensure all properties have been configured.
Favorite and Favorite and recent units permit instant recall of units:
recently-used
units • That you have added to the favorites list as Favorite Units.
• Any recently-used format (history) as Recent Units.
Figure 116: Favorite and Recent Units list
Parameter Description
List of Favorite List of favorite units. Click an entry to select it as the
Units format to be used.
Add to Favorites Add the currently-selected unit to the list of favorite
units.
Manage Favor- Allows you to delete a unit from the list of Favorite
ites Units. Right-click a unit and select Delete from the list.
List of Recent List of recently-used units. Click an entry to select it as
Units the unit to be used.
Clear Recent Removes all recently-used units from the Recent Units
List list.
Adding resources
Resources are shown in the Resources Configuration window when a
resource block instance is added to the project. Resources can be added to a
project and configured before the related block is added to the project (by
dragging the block from the Toolbox).
EC-gfxProgram 157
Adding resource Resource block instances can be added to a project by right-clicking a branch
block instances in the Resource Tree.
to the resource
tree NOTE: These actions are also available from the toolbar. See Resources
Configuration toolbar.
Figure 117: Adding resource block instances to the resource tree
Parameter Description
Add Adds a resource block instance of the selected
resource type to the current project. The next available
block instance number is used.
Add With Adds a range of resource block instances of the
Options selected resource type to the current project as set in
Quantity. Start number sets the number of the first
block instance to be added in the range.
Figure 118: The Add Resources window
NOTE: Multiple resource blocks can also be added
using the CTRL key while dragging the block
onto the Programming Sheet. See Adding mul-
tiple resource blocks.
Duplicate Makes a copy of the currently selected resource.
Add Floating When two hardware outputs are selected, co-joins the
Pair outputs to create a floating output or floating pair. See
Adding a Floating Output (ECL Series) or Adding a
Floating Output (ECB & ECY Series).
Resource block A number of operations can be performed on a resource block instance in the
instance Resource Tree. A resource blocks’ instance operations vary according to the
operations type of resource block currently selected.
158 EC-gfxProgram
Resources Configuration
Figure 119: Resource block instance operations (options may vary)
Parameter Description
Configure Opens the configuration for the currently selected
Scenes ComSensor instance. See ComSensor Scenes Config-
uration window (ECB & ECY Series) and ComSensor
(ECB & ECY Series).
Rename Renames the object. You can also double-click the
name of a resource block instance in the Resource
Tree to rename the object.
Delete Deletes the selected resource object. If this object is
being used by one or more blocks in your project code,
the corresponding blocks in your project code are also
deleted.
Renumber Renumbers resource objects. This option allows you to
assign new numbers to selected resources.
Swap Swap instance numbers for 2 selected objects of the
same type.
Format Sets the resource object’s output format. See Format
editor.
Create Live Connects to a resource block’s current value that when
Configuration used in the Configuration Assistant, allows a user to
Variable view the variable’s current value and to set the vari-
able’s value to be used in the controller’s EC-gfxPro-
gram code. See Configuration Assistant.
Bind to New Creates a new Configuration Variable Group and binds
Configuration the selected resource to this group. See Configuration
Variable Group Variable Groups.
EC-gfxProgram 159
Parameter Description
Bind to Existing Binds the selected resource to an existing Configura-
Configuration tion Variable Group.
Variable Group
Test From This Sends a test email message from an email account to
PC verify that it has been properly configured. See e Con-
figuring a notification class to send email alerts (ECY
Test From Series).
Device
160 EC-gfxProgram
Resources Configuration
Renumbering/Swapping Resources
Renumbering resources allows you to assign new numbers to selected
resources as well as swapping numbers amongst two or more compatible
resources. This action assigns new numbers to the selected resources while
preserving any associations with existing programming blocks and resources.
Renumbering while working online could unexpectedly affect
what is currently running in the controller as well as other
devices or tools that are reading/writing from objects being
renumbered. It is highly recommended to perform this opera-
tion while working offline. If that is the case, when switching to
online mode, make sure to fully synchronize the project.
Renumbering a From the Resources Configuration window, you can assign new instance
resource numbers to resource objects while preserving their configuration.
1. To renumber a resource, right-click on the resource you wish to renumber
and select Renumber.
2. In the New Number cell, enter the new number you wish to assign to the
selected resource and click OK.
The selected resources is renumbered and reordered within the list of
resources:
EC-gfxProgram 161
Renumbering 1. Select multiple resources using the CTRL or SHIFT key.
multiple 2. Right-click on the selected resources and select Renumber.
resources
3. Enter the new numbers for the selected resources in the New Number
cells and click OK.
TIP: To quickly renumber large amounts of resources:
1. Select the entire list using the CTRL key or click on the parent resource
and click Renumber. The entire list is displayed in the Renumber
Resources window.
2. Select the entire list or partial list that you wish to renumber using the
CTRL key and select Set numbers.
162 EC-gfxProgram
Resources Configuration
3. Enter the starting number you wish to assign to the new numbering. All
resources will be renumbered sequentially starting with that value.
Swapping You can exchange one resource instance number for another using the Swap
resources feature. Swapping occurs between two resources of the same type.
1. Select two resource objects of the same type.
2. Right click on the selected objects and select Swap. The two instances
will be exchanged while keeping their associated configuration.
Renumbering IO IO module resources can be renumbered or swapped at the module level
modules (parent) (IOM1, IOM2, etc.) while taking into account the parent/child resources notion.
In other words, because the predefined sets of inputs/outputs (child) are asso-
ciated to the parent IO module the numbering structure must follow.
1. Select two or more IO modules (parents).
2. Right-click on the selected objects and select Renumber.
EC-gfxProgram 163
3. Enter the new numbers you wish to assign in the New Number cell and
click OK.
Both the parent IO modules and the child resources are renumbered accord-
ingly. For instance, the IOM10 parent module will have input/outputs 1001,
1002, 1003, etc. because the submodule numbers are associated to the par-
ent IO module.
Renumbering If you wish to renumber the input/outputs (child), select two instances to swap
inputs/outputs or select three or more to renumber but within the selected range of numbers.
(child IO)
1. Select three or more inputs/outputs.
2. Right-click on the selected objects and select Renumber.
164 EC-gfxProgram
Resources Configuration
3. In the New Number cells, select the number you wish to assign to the
input/outputs from the dropdown list provided.
NOTE: The numbers provided in the list are the current numbers of the
selected objects. You can only reassign numbers within that range in
order to preserve the predefined numbers of the inputs/outputs.
Configuration Variable Groups
The easiest way to create a new fully configured configuration variable group
is to create it directly from a resource block instance or configuration property
group. By doing so, the group is automatically configured with the properties
used in the source block instance or property group.
Creating new To create a fully configured configuration variable group:
Configuration
Variable Groups
1. Right-click a resource block instance or click on the right of a config-
uration property group. and select Bind to New Configuration Variable
Group.
2. Set the configuration variable group’s name in Name and select the folder
where the configuration variable group is to be located in Create in.
EC-gfxProgram 165
If a new folder is needed to organize variables into logical or structural
group, click Create new folder. Click OK.
Figure 120: Add Variable Group destination
3. Edit the values in the Configuration Variable Group as needed.
NOTE: If you edit values for properties bound to a configuration variable
group in the block instance configuration, these values apply to all
block instances that are bound to the configuration variable group in
question.
166 EC-gfxProgram
Resources Configuration
Binding Once the Configuration Variable group has been created, it can be bound to
resources to other resources.
existing
Configuration 1. Right-click a resource block instance or click on the right of a config-
Variable Groups uration property group, and select Bind to Existing Configuration Vari-
able.
2. From the Variable Selector list, select the Configuration Variable Group
you previously created. Click OK.
Figure 121: Selecting a variable group you previously created
3. Repeat steps 1 and 2 to bind other resources to this Configuration Vari-
able Group as necessary.
Reusing You can create Configuration Variable Groups to use as templates for fre-
Configuration quently used configurations. Once you have Configuration Variable Groups,
Variable Groups you can export these fully configured variable groups from your project to a
in different .gvx file and then import this file in other projects.
projects
NOTE: Bindings are not exported, and must be redone whenever a Configu-
ration Variable Group is imported in a project.
Exporting Configuration Variable Groups
1. Drill down in the Configuration Variables folder to the group you want to
export.
2. Right-click the group to export and select Export to File.
EC-gfxProgram 167
3. In the Save As window, select a location and specify the File name, and
click Save.
Importing Configuration Variable Groups
To import Configuration Variable Groups previously saved in a .gvx file in your
project:
1. Drill down in the Configuration Variables folder to the group where you
want to import the variables.
2. Right-click the destination group and select Import from File.
168 EC-gfxProgram
Resources Configuration
The Configuration Variable Groups in the .gvx file are added to the
resource tree, and can be bound to resources in your project.
EC-gfxProgram 169
Resources Summary view
Click a resource type to view a summary of the configuration of all associated
resource instances.
Figure 122: Resources summary
Configuring properties
When one resource block instance is selected in the Resource Tree, the
resource block’s properties can be configured in the right pane.
When two or more resource block instances are selected in the Resource
Tree, the common resource block’s properties can be configured in the right
pane. Any modification to the resource block’s properties are applied to all
selected instances.
To select two or more resource block instances:
1. Click a resource block instance.
2. Hold down the Ctrl or Shift key.
3. Click another resource block instance to individually add it to the selection
or to select a range of resource block instances.
170 EC-gfxProgram
Resources Configuration
Blocks that are configured in the Resources Con-
figuration window
ECL Series The blocks shown in the following table can be configured in the Resources
resource block Configuration window. See also Resource block configuration parameter.
configuration
Resource block Configuration information
Numeric Constant Numeric Constant (ECL Series)
Boolean Constant Boolean Constant (ECL Series)
Enum Constant Enum Constant (ECL Series)
Setpoint Constant Setpoint Constant (ECL Series)
Numeric Values Numeric Value (ECL Series)
Boolean Values Boolean Value (ECL Series)
Enum Values Enum Value (ECL Series)
Hardware Input Hardware Input (ECL Series)
Hardware Output Hardware Input (ECL Series)
Floating Pair Adding a Floating Output (ECL Series)
Light Sunblind Light Sunblind Input (ECL Series expansion mod-
Modules ules)
Light Output (ECB & ECY Series expansion mod-
ules)
Sunblind Output (ECL Series expansion module)
Network Values Network Variable Input (ECL Series)
Network Variable Output (ECL Series)
Pid Loops Pid Loop (ECL Series)
Timers Timer (ECL Series)
Calendars Calendar (ECL Series)
Schedules Schedule (ECL Series)
VAV Actuator Control (ECL Series)
Diff Pressure (ECL Series)
Internal Actuator (ECL Series)
System Set the time zone where the controller is located and
the time synchronization interval. See Real Time
Clock (ECL Series).
LCD Lcd Screen (ECL, ECB & ECY Series)
Wireless Wireless Sensor (ECL Series)
Internal Variables Internal variable (ECL, ECB & ECY Series)
EC-gfxProgram 171
Resource block Configuration information
ComSensors ComSensor (ECL Series)
MultiSensors Advanced Multi Sensor configuration
Subnet Extensions Subnet Extension (ECL Series)
Configuration Used by the Configuration Assistant. See Configura-
Variables tion Assistant..
ECB & ECY The blocks shown in the following table can be configured in the Resources
Series resource Configuration window. See also Resource block configuration parameter
block
configuration Resource block Configuration information
Analog Values Analog Value (ECB & ECY Series)
Binary Values Binary Value (ECB & ECY Series)
Multi State Values Multi State Value (ECB & ECY Series)
Hardware Input Hardware Input (ECB & ECY Series)
Hardware Output Hardware Output (ECB & ECY Series)
Floating Pair Adding a Floating Output (ECB & ECY Series)
Light Sunblind
Modules Light Output (ECB & ECY Series expansion mod-
ules)
Sunblind Output (ECB & ECY Series expansion
module)
Network Values Network Value (ECB & ECY Series)
Pid Loops Pid Loop (ECB & ECY Series)
Timers Timer (ECB & ECY Series)
Calendars Calendar (ECB & ECY Series)
Schedules Schedule (ECB & ECY Series)
VAV Actuator Control (ECB & ECY Series)
VAV Differential Pressure (ECY Series)
Internal Actuator (ECB & ECY Series)
System Set the time zone where the controller is located and
the time synchronization interval. See Real Time
Clock (ECB & ECY Series). This controller can also
send time synchronization to other networked con-
trollers.
LCD Lcd Screen (ECL, ECB & ECY Series)
Wireless Wireless Sensor (ECB Series)
172 EC-gfxProgram
Resources Configuration
Resource block Configuration information
Internal Variables Internal variable (ECL, ECB & ECY Series)
ComSensor ComSensor (ECB & ECY Series)
Trend Logs Trending (ECY Series)
Notification Class Configuring alarm recipients
Email Accounts These email accounts are used to send alarm notifi-
cations. See Configuring a notification class to send
email alerts (ECY Series).
Multi Sensors Advanced Multi Sensor configuration
Modbus Modbus Device (ECY Series)
Subnet Extensions Subnet Extension (ECB & ECY Series)
Configuration Used by the Configuration Assistant. See Configura-
Variables tion Assistant.
ENVYSION Data ENVYSION Data Tree (ECY Series)
Tree (ECY Series
only)
ByteLight Groups ByteLight Group (ECY Series)
nLight Devices nLight Device (ECY Series)
EC-gfxProgram 173
Configuring a resource block
Resource block A Resource blocks’ configuration parameters vary based on the type currently
configuration selected.
parameter
Figure 123: Typical resource block configuration parameters
174 EC-gfxProgram
Resources Configuration
Resource blocks have the following configuration parameters:
Resource block
Configuration information
parameter
General Sets:
• The block’s resource name in Object name. This is
used to identify the object in the Resource Viewer
and on the controller’s operator interface (if
equipped). For certain BACnet objects, the Object
name is exposed on the BACnet network as the
BACnet object name.
• Whether the instance is Controller specific. See
Project Synchronization and Controller specific val-
ues and device synchronization options (ECL, ECB
& ECY Series).
• Whether the value of this object is to be saved by
the controller during any type of controller reset or
power cycling by setting Persist. This may apply to
Timer and Internal Variable Blocks. See Per-
sistent values (ECL, ECB & ECY Series control-
lers).
Signal / Sets the hardware input’s/output’s signal type. See
Selection Hardware Input (ECL Series) and Hardware Input (ECL
Series).
Mode Sets the mode of the Network Variable Input block. See
Advanced Network Object configuration (ECY Series).
Parameters Sets the Pid loop properties. See Pid Loop (ECL
Options Series) or Pid Loop (ECB & ECY Series).
Metadata Used to add the current controller resource to the
ENVYSION Data Tree. The same resource can be
added to more than one place in the ENVYSION Data
Tree. See Adding resources to the ENVYSION Data
Tree and ENVYSION Data Tree (ECY Series).
Inhibit binary For certain blocks, alarms that have been configured
value can be temporarily suppressed by turning off the
block’s alarm management so that no alarms will be
reported by the block during this time. See AlarmInhibit
input (ECY Series controllers).
Alarm (ECB & Sets the alarm thresholds that will trigger the dispatch
ECY Series of a notification message to other BACnet devices. See
only) Alarms (ECB & ECY Series).
Trending (ECY Configures the BACnet trend log object for the related
Series control- resource. See Trending (ECY Series).
lers only)
EC-gfxProgram 175
Resource block
Configuration information
parameter
Server Settings Configures the settings used to communicate with an
(ECY Series email server. See Configuring a notification class to
controllers only) send email alerts (ECY Series).
Calibration Configures the Multi Sensor’s properties. See
Options (ECY Advanced Multi Sensor configuration.
Series control-
lers only)
Network (ECY Configures the Modbus network properties. See Con-
Series control- figuring a Modbus resource.
lers only)
Trending (ECY Series)
Some resources support the ability to record a history of their values, when
certain conditions are met, so they can be later reviewed to show a variation
or trend over time. The number of values that can be recorded is set by the
buffer size.
First, set the Generate trend logs option for the resource you want to record a
trend log for.
Figure 124: Enable the resource’s Generate trend logs option
NOTE: For ECB & ECY Series controllers, when the trend log is enabled for
an object, the BACNet interface can be used to trigger the trend log,
through EC-net for example. See Automatic generation of control
points from EC-gfxProgram code.
The trend log configuration for the resources is available under the resource
and under Trend Logs in the Resource Tree.
176 EC-gfxProgram
Resources Configuration
Figure 125: Trend log configuration window
Parameter Description
General > Assigns an identification name to the object (program-
Object name ming block). For ECB & ECY Series controllers, this is
also used as the trend log’s BACnet object name.
Data Source Identifies the object associated with this trend log. For
information purposes only.
Trending > When checked, enables trend logging for this object.
Enabled
EC-gfxProgram 177
Parameter Description
Trending > Log- Polled: The object value is recorded at regular time
ging Type intervals set in Logging interval.
COV: The value is recorded according to a threshold
for a minimum change in value set in COV Increment.
In Fallback poll interval, set the period after which the
controller will log the object value if the COV update
fails to arrive.
Triggered: A pulse at the block’s TriggerTrendLog
input forces the object’s present value to be recorded in
the trend log. To show the TriggerTrendLog port on
the block, see Configure Ports.
Log Buffer > Sets the number of values that can be saved in this
Buffer size trend log. The oldest values are overwritten unless
Stop when full is set.
Log Buffer > When checked, the trend log records the number of
Stop when full values set in Buffer size, and then stops recording val-
ues.
When unchecked, the oldest values are overwritten
once the log buffer is filled, so only the most recent his-
tory is available.
Logging Param- Sets a regular time interval to record the object’s pres-
eters > Logging ent value in the trend log.
interval
Logging Param- Aligns the Logging Interval to be on the hour plus any
eters > Align Interval offset.
intervals When checked, the beginning of any Logging interval
value that divides evenly to an hour (60 minutes) or day
(1440 minutes) without any remainder, is aligned to the
hour or day, respectively, plus any Interval offset.
Logging Param- When Align interval is checked, the moment when a
eters > Interval logged value is recorded can be offset by the specified
offset amount of time.
Logging Param- If no change of value is received during this time
eters > COV period, a re-subscription to the COV is triggered.
subscription
time NOTE: Six hours (21,600 seconds) is a reasonable set-
ting for this parameter.
178 EC-gfxProgram
Resources Configuration
Parameter Description
Logging Param- The minimum change in value that causes a value to
eters > COV be recorded in the trend log.
increment
NOTE: When the trend log is linked to a point on
another controller, the largest COV increment
value between the value of the sending or
receiving controller determines the true COV
increment requirement for the updated value to
be logged.
For example, if the point’s COV increment of
the sending controller is 5 and the logging COV
increment of the receiving controller is 1, the
point will only be logged when the point’s value
changes by more than 5 or once the point’s
COV Max Send Time has expired.
This value can be used to throttle the number of
logged values by increasing the logging COV
value so that a larger change of value is
required for the value to be logged.
Logging Param- When COV is set, determines the period after which
eters > Fallback the controller will log the object value if the COV update
poll interval fails to arrive.
Notifications > When checked, enables event notifications of the trend
Enables (ECB & logging object to support the BACnet automatic trend
ECY Series con- log retrieval mechanism.
trollers only)
Notifications > Sets the number of values that are to be recorded in
Notification the trend log before a notification is sent.
threshold
Notifications > Sets the type of notification message to send: Alarm or
Notify type Event.
Notifications > Sets the types of service status change that trigger a
Events enabled notification message according to the trend log’s reli-
ability status to support the automatic Trend Log
Retrieval mechanism.
To offnormal: the trend log’s reliabiliry is offnormal.
To fault: the trend log has become unreliable.
To normal: the trend log’s reliability is normal.
Notifications > Sets the BACnet Notification Class Object used to
Notify class route alarms with the same similar set of properties to
(ECB & ECY one or more devices. See Configuring alarm recipients.
Series control-
lers only)
EC-gfxProgram 179
Viewing a trend A trend log can be viewed by right-clicking the programming block on the pro-
log gramming sheet and selecting View Trend Log History in the context menu.
The trend log is shown for the block. See Viewing a trend log (ECY Series).
ENVYSION Data Tree (ECY Series)
The ENVYSION Data Tree is a user-configured structure that allows you to
organize controller resources as you see fit. This can be used to create a
physical representation of the controller’s objects, organized by floor, room
number, boiler, and chiller, for example. The goal is to populate the ENVYS-
ION Data Tree with only the resources needed for the project. As such, only
the most relevant controller resources will be added to the ENVYSION Data
Tree.
To avoid duplicate work, this structure can be exported to a file on your PC.
This structure can be also imported from the ENVYSION Data Panel interface
or from a file on your PC.
Figure 126: ENVYSION Data Tree operations
Parameter Description
Add Folder Adds a new folder to the ENVYSION Data Tree at the
current location.
Add Reference Within the ENVYSION Data Tree, adds a reference to
any Resources Configuration object.
Import From File Imports the ENVYSION Data Tree structure that was
saved on your file system. Opens the Open window.
Export To File Exports the ENVYSION Data Tree structure to your file
system. Opens the Save As window.
Import From Imports the ENVYSION Data Tree structure from the
Device currently connected device.
Cut Cuts an ENVYSION Data Tree folder.
Copy Copies an ENVYSION Data Tree folder.
180 EC-gfxProgram
Resources Configuration
Parameter Description
Paste Pastes an ENVYSION Data Tree folder that has been
cut or copied.
Remove When an imported ENVYSION Data Tree has refer-
Unknown Refer- ences to inexistent resources, removes these unknown
ences references from the ENVYSION Data Tree.
Delete Deletes the selected resource reference instance.
Clear Deletes the entire ENVYSION Data Tree structure and
all resource reference instances.
Figure 127: Typical ENVYSION Data Tree Structure
Adding resources to the ENVYSION Data Tree
Resources can be added to the ENVYSION Data Tree as follows:
• By browsing resources, selecting and adding them to the ENVYSION
Data Tree.
• By adding elements to the resource’s Metadata configuration.
Adding Add elements to the ENVYSION Data Tree as follows.
resources
through the 1. Right-click the ENVYSION Data Tree and select Add Folder to create a
ENVYSION Data branch in the data tree structure. Name this folder.
Tree 2. Right-click the folder and select Add Reference(s).
3. Select the resources you want to add to the selected folder.
To select two or more resources, click a resource instance, hold down the
Ctrl or Shift key, and click another resource instance to individually add it
to the selection or a to select a range of resource instances.
EC-gfxProgram 181
Figure 128: Adding a resource to the ENVYSION Data Tree
4. Click Add to add the selected resources and leave the window so you
can continue adding resources. Click OK when you’re done.
Adding elements To add elements to the resource’s metadata configuration so they appear in
to the resource’s the ENVYSION Data Tree in one or more places:
metadata
configuration 1. In a resource that can be added to the ENVYSION Data Tree (Metadata is
available in its configuration), click + to add the resource to the ENVYS-
ION Data Tree.
Figure 129: Adding a resource to the ENVYSION Data Tree
2. If the structure of the ENVYSION Data Tree has already been created,
click the drop down arrow to select the path where this resource is to be
shown in the ENVYSION Data Tree. Or create a new path by typing it in,
using back slashes (\) or forward slashes (/) to create the path and to sep-
arate the data tree branches.
Figure 130: Adding a resource to the pre-existing ENVYSION Data Tree structure
182 EC-gfxProgram
Resources Configuration
3. Click + to add more paths, or click - to delete a path.
Cleaning up unused resources in a project
To streamline and help clean your programs of unnecessary objects that may
have been created during the setup and programming of the job, you can
access a window that quickly finds and shows all the resources that have no
references in the project. You can then decide whether to leave these
resources in the project, or to delete them permanently.
Finding and 1. To find unused resources in the project, click the toolbar icon
Deleting Unused The Unused Resources window opens and lists the unused resources
Resources found in the project or the selected category.
2. Select the resource(s) to delete, or check the Select All/None box to
select/deselect all resources.
3. Click .
4. Click to make sure that there are no remaining unused
resources, and repeat steps 2 and 3 if necessary.
Since objects are sometimes linked to one another, deleting an object
may leave other objects unreferenced (for example, variable bindings on
a ComSensor block). This is why it is recommended that you repeat this
step until no unused resources are found when re-evaluating the project.
EC-gfxProgram 183
184 EC-gfxProgram
Using EC-gfxProgram
CHAPTER 5
Using EC-gfxProgram
This chapter provides a basic understanding of how EC-gfxProgram works
and outlines best practices to ensure that the user gets the most out of the
software. More specifically, the way to drag and drop blocks, connect blocks,
process data, and build control sequences are described herein.
Topics
Dragging and dropping blocks
Connecting blocks
Build sequencing
RAM usage
Data processing
LONWORKS network description
BACnet objects, services, and data priority
Commandable object priority array levels
EC-gfxProgram 185
Dragging and dropping blocks
The basic programming element of EC-gfxProgram is the block. In order to
make a control sequence, several blocks must be laid out and connected on
the programming sheet. In order to bring a block onto the Programming Sheet
from the Toolbox Pane:
1. Select a block from the Toolbox pane.
2. Click and hold the block.
Figure 131: Selecting the block
186 EC-gfxProgram
Using EC-gfxProgram
3. While still holding the block, drag it over to the Programming Sheet. The
block’s icon will be shown beside the mouse pointer.
Figure 132: Dragging the block
4. Place the mouse pointer over the desired location in the Programming
Sheet and release the block.
Figure 133: Dropping the block
Adding multiple You can add multiple resource blocks by pressing the CTRL key while drag-
resource blocks ging the block to the Programming Sheet.
1. Press and hold the CTRL key while dragging the block on to the Program-
ming Sheet. The Add Blocks dialog box is displayed.
EC-gfxProgram 187
2. In the Quantity field, enter the number of blocks you wish to add to the
Programming Sheet.
3. In the Start number field, enter the starting number for the first block in
the sequence.
4. Click OK. The selected number of blocks with the assigned sequential
numbers will be created on the Programming sheet.
Example of 5 resource blocks, with a starting number of 10, added simultaneously to
the Programming SheetWhen resource blocks are added to the Programming
Sheet, they will also appear as resources in the Resources Configuration win-
dow.
188 EC-gfxProgram
Using EC-gfxProgram
Connecting blocks
In order to create a control sequence or develop a program, it is essential to
create connections between blocks. These connections allow data and com-
mands to be transferred from one block to the next and permit the develop-
ment of sophisticated programs. The more connections in a control sequence;
the more complex it becomes.
Connection rules
The ways in which blocks are connected are governed by a few rules. These
rules are in place to ensure that the control sequence behaves in the way it is
supposed to and to ensure there is no ambiguity in the results or processes.
The following is a list of the applicable rules:
• Two output ports cannot be connected to each other. Neither can two
input ports be connected to each other. An output port can only be con-
nected to an input port and an input port can only be connected to an out-
put port.
• Any output can be connected to any input. The data types are automati-
cally converted.
• An output port can be connected to multiple input ports.
• An input port can only be connected to one output port.
• All blocks must have at least one connection (except for the Custom block
and Lcd Screen (ECL, ECB & ECY Series) block).
• Input and output ports with connection indicators (see Block objects
description) must be connected.
NOTE: If there is an input port that the user does not need, but needs to be
linked nevertheless, connect it to an Internal constant block and give it
a value.
If there is an output port that the user does not need, but needs to be
linked nevertheless, connect it to a Monitor block.
Connection types
Blocks can be connected in a variety of ways depending upon the user’s
needs. The following is a list of the various connection types:
• Simple connection
• Monitoring an output port
• Monitoring all output ports
• Exposing an output port to a network variable
• Turnaround connection
• Fan-out connection
EC-gfxProgram 189
• Connection via references
•
• Re-linking an input or output port connection
• Autolinking ports between blocks
NOTE: A connection can either be started from an Output to an Input or from
an Input to an Output.
Simple A simple connection is connecting the input port of one block to the output
connection port of another block. In order to create a simple connection between two
blocks:
1. Select and hold an Output port of one of the blocks once the connection
symbol appears on the mouse pointer.
Figure 134: Simple connection - selecting the input or output port
2. While still holding, drag the connector to the desired Input port of the
other block. You do not have to point directly to the destination port, the
cursor can be anywhere over the block, and the connection will lock on
the port that corresponds to the mouse’s vertical position.
Figure 135: Simple connection - dragging the connector
3. Once the connector locks on to the desired Input port, release the con-
nector.
Figure 136: Simple connection - completing the connection
190 EC-gfxProgram
Using EC-gfxProgram
Monitoring an Use the Monitor block to monitor values to debug project code or to provide
output port connections to block outputs that require connections (see Connection rules).
1. Place the mouse pointer over an Output port of block so that the connec-
tion symbol appears.
2. Right-click the output port and select Link to in the list and then Monitor.
Figure 137: Adding a monitor to an output port
EC-gfxProgram 191
Monitoring all Quickly add Monitor blocks to all unconnected output ports of one or more
output ports selected blocks as follows:
• Press Ctrl+Space.
• Right-click the top title area of the block and select Monitor All.
Figure 138: Adding a Monitor block to all output ports
NOTE: To monitor all outputs of more than one block in one operation, select
the blocks, then right-click the top title area of any block and select
Monitor All.
Exposing an Use a network variable to make a block’s output data available on the network
output port to a for use by other controllers.
network variable
For a LONWORKS network, this makes the data available as a Network Vari-
able Output (NVO) – The 5 numeric variables nvoVnX_Y and the nvoVe1_27
on the device interface, under the FreeProg object.
For a BACnet network, this makes the data available to the Network as set in
the block’s configuration window.
Proceed as follows:
1. Place the mouse pointer over an Output port of block so that the connec-
tion symbol appears.
192 EC-gfxProgram
Using EC-gfxProgram
2. Right-click the output port and select Link to in the list and then a variable
type according to the table below.
Table 1: Available variable types
Controller Type Variable Types Supported
ECP Series controllers Variable Enum (ECP Series)
Variable Numeric (ECP Series)
ECL Series controllers Boolean Constant (ECL Series)
Boolean Value (ECL Series)
Enum Constant (ECL Series)
Enum Value (ECL Series)
Numeric Constant (ECL Series)
Numeric Value (ECL Series)
ECB & ECY Series controllers Analog Value (ECB & ECY Series)
Binary Value (ECB & ECY Series)
Multi State Value (ECB & ECY Series)
EC-gfxProgram 193
Turnaround A turnaround is a way to inject into an input a previously calculated value. A
connection turnaround connection in its simplest form is connecting an input port of a
block to an output port of the same block. The purpose of this type of connec-
tion is to use the output value of a block as an input to the same block. In
order to create a turnaround connection on a block:
1. Select and hold an Output port of the block once the connection symbol
appears on the mouse pointer.
Figure 139: Turnaround connection - selecting the input or output port
2. While still holding, drag the connector to the desired Input port of the
same block.
Figure 140: Turnaround connection - dragging the connector
3. Once the connector locks on to the desired Input port, release the con-
nector.
Figure 141: Turnaround connection - completing the connection
A turnaround connection can also be made with the autolink feature; see
Autolinking turnaround connection example.
194 EC-gfxProgram
Using EC-gfxProgram
Fan-out A fan-out connection is connecting the output port of one block to the input
connection ports of one or more other blocks. This type of connection transmits informa-
tion from one block to many blocks at once. In order to create a fan-out con-
nection between several blocks:
1. Select and hold an Output port of one of the blocks once the connection
symbol appears on the mouse pointer.
Figure 142: Fan-out connection - selecting the input
2. While still holding, drag the connector to the desired Input port of one of
the other blocks.
Figure 143: Fan-out connection - dragging the connector
3. Once the connector locks on to the desired Input port, release the con-
nector.
Figure 144: Fan-out connection - completing the connection
EC-gfxProgram 195
4. Repeat steps 1 to 3 for all other connections.
Figure 145: Fan-out connection - completing multiple connections
Connection via A connection via references is done by connecting the output port of one
references block to a Reference Hub block and then connecting a corresponding Refer-
ence Target block to the input port(s) of other blocks. This is how you pass
values between two Programming Sheets to inter-connect blocks (however it
does not allow you to pass values to or from custom blocks, or between two
custom blocks).
This type of connection helps to keep the programming sheet clean, without
having too many connectors, and thus make it easier to see where connec-
tions are going.
NOTE: When Assign tag name to linked reference hub7 is set in the EC-gfx-
Program Options, linking to a Reference Hub block will automatically
assign to it the name of the source object being linked (when linked to
an Output port, it will use the block’s name only; any other port will
use the combination of the block’s name and the port’s name).
If the name for the Reference Hub block already exists, an automati-
cally incremented number is added to the end of the block name.
In order to create a connection via references between several blocks:
1. Add a Reference Hub block for the block from which the connection will
be coming from. Place the mouse pointer over an Output port of block so
that the connection symbol appears.
196 EC-gfxProgram
Using EC-gfxProgram
2. Right-click the output port and select Link to in the list and then Reference
Hub. The Reference Hub and target blocks can also be dropped from the
Toolbox.
Figure 146: Connection via references - adding a reference hub
3. In the Properties Pane of the Reference Hub block, enter a relevant
TagName. If Assign tag name to linked reference hub is set in EC-gfxPro-
gram Options, this is not necessary as the Reference Hub block will auto-
matically be assigned the name the source object being linked to it (when
linked to an Output port, it will use the block’s name only; any other port
will use the combination of the block’s name and the port’s name).
Figure 147: Connection via references - naming reference hub (optional)
4. Add Reference Target blocks for each block to which the connection will
be going: place the mouse pointer over an Output port of block so that the
connection symbol appears.
EC-gfxProgram 197
5. Right-click the input port and select Link To in the list and then Refer-
ence Target.
Figure 148: Connection via references - adding reference targets
6. In the Reference Hub Selection popup, select the Reference Hub block
from the drop-down menu (identified by its TagName).
Figure 149: Connection via references - selecting a reference target
7. Add Reference Target blocks as necessary to the Input ports of the other
blocks.
Figure 150: Connection via references - adding reference target blocks to input
ports
NOTE: A Reference Target block inside a Custom block cannot be used with
a Reference Hub block outside of the Custom block and vice versa.
However, it is permitted to use a Reference Target block and a Refer-
198 EC-gfxProgram
Using EC-gfxProgram
ence Hub block together inside a Custom block. If a block outside a
Custom block needs to be linked to a block inside a Custom block,
the connection needs to go through an Exported Input or Output within
the Custom block.
Copying blocks If you select a block with a connected Reference Hub and then copy and
with reference paste them, the name of the reference hub will remain the same, however a
hubs number is appended to the end of the name to differentiate it from the source
reference hub.
If you do this with the Reference Target and its corresponding Reference Hub
both selected, the name of both the Reference Target and the Reference
Hub will be changed (a number is appended to the end of the name) such that
they still link to each other but they are not linked to the original Reference
Target / Reference Hub blocks.
Figure 151: Copying blocks with reference target and its corresponding reference hub ‘SetpointReset’
Figure 152: The pasted reference target/reference hub (second row) are now automatically named
‘SetpointReset1’
Transforming Once you have made a connection, you can transform it to a Hub/Target con-
reference and nection or direct link, as needed.
direct link
connections Transforming a direct link to a Reference Hub/Target
To transform a direct link to a Reference Hub/Target:
1. Right-click the link and select the Transform to Hub/Target Connection
option.
EC-gfxProgram 199
The resulting Reference Hub and Reference Target are named as per
your EC-gfxProgram options. For more information, see Connection via
references.
200 EC-gfxProgram
Using EC-gfxProgram
Transforming a Hub/Target connection to a direct link
To transform a Hub/Target connection to a direct link:
1. Right-click the Reference Hub or Reference Target of the connection to
transform, and select the Transform To Direct Link(s) option.
You can select multiple Reference Hubs or Reference Targets to trans-
form several connections to direct links.
NOTE: Reference connections can only be transformed to direct links if all
Targets and Hubs are on the same programming sheet.
EC-gfxProgram 201
Re-linking an Once you have made a connection, you may need to change the port to which
input or output the connection has been made. This can be done when debugging is
port connection stopped.
For a single connection input port or output port
For an input port or an output port with a single connection, this can be done
as follows:
1. Hover your mouse cursor over the connection near the input or output
port. The cursor changes to become . This is shown below.
Figure 153: Hover your mouse cursor near the input port so it changes style
Figure 154: Hover your mouse cursor near the output port so it changes style
2. Click your mouse and move the connection to another port. A connection
to an input port can only be remade to another input port, while a connec-
tion to an output port can only be remade to another output port.
For an output port with two or more connections
For an output port with two or more connections, a single connection can be
reconnected as follows:
1. Select the connection you want to reconnect by clicking it with your
mouse. The connection becomes highlighted.
Figure 155: Click to select the connection you want to reconnect
2. Hover your mouse cursor over the connection near the input or output
port. The cursor changes to become . This is shown below.
Figure 156: Click to move the connection you want to reconnect
3. Click your mouse and move the connection to another output port. A con-
nection to an output port can only be remade to another output port.
NOTE: To reconnect two or more connections at once, hold down the <Shift>
key and select the connections to be reconnected.
202 EC-gfxProgram
Using EC-gfxProgram
If an output port has two or more connections, and you want to recon-
nect all of them to another output port, simply click your mouse (with-
out any connection being previously selected) and move the
connections to another output port.
Autolinking Autolinking allows you to quickly connect the ports between two or more
ports between blocks by using a context menu or keyboard shortcut. For this, the ports must
blocks be unconnected to any other port. Use any one of the following methods to
autolink ports:
• By vertically aligned ports
• By port order
• By linking the ports while moving a block
Autolinking by vertically-aligned ports
Autolinking can link ports when they are vertically aligned. Autolinking through
the context menu is shown below or by pressing Ctrl+q (for quick link) on your
keyboard.
Figure 157: Autolinking vertically-aligned ports
EC-gfxProgram 203
Autolinking by port order
Autolinking can link ports by their vertical order when all blocks to be linked
are selected.
Figure 158: Autolinking selected blocks by port order
Autolinking by linking the ports while moving a block
Autolinking can also be done while a block is selected and moved next to the
block you want to autolink to, and then while the block is still selected, use the
shortcut to link the ports, then move the selected block to its final position.
This can be done as follows.
1. Move the block into position so that its ports are vertically aligned with the
ports to be linked on the other blocks.
Figure 159: Autolinking ports: moving the block into position
204 EC-gfxProgram
Using EC-gfxProgram
2. Once the block is aligned, press ‘l’ (lower-case L) on your keyboard to link
the ports.
Figure 160: Autolinking ports: press “l” to link the ports
3. Now move the block to its final position and release it.
Figure 161: Autolinking ports: move the block to its final position and release it
Autolinking turnaround connection example
The following is an autolink turnaround connection example.
1. Move the block so that its Output port is vertically aligned with the Input2
port.
2. Press 'l' (lower-case L) on your keyboard to link the ports. Do not release
the block at this time.
3. Move the block back to its original position.
4. Release the block. The turnaround connection is made.
EC-gfxProgram 205
Build sequencing
After a control sequence is fully developed, it needs to be built to determine if
there are any logical errors and to evaluate if the results are as expected. The
manner in which blocks are connected and laid out, both affect the order in
which the project code is compiled. Proper planning ahead of time can save a
lot of confusion and errors when it is time to build.
To begin with, the compiler optimizes the project code in a way that if a block
or group of blocks does not execute something that is used or is not linked to
any block giving an end result, these blocks are not executed. For example,
although the project code shown below is built since it follows all the Connec-
tion rules, the Custom and Add blocks are not executed since their outputs
are not linked to anything.
Figure 162: Code optimization
Figure 163: Inside the custom block
The first things that determine the order of compilation are “endpoints”. End-
points are the last blocks in a sequence of connected blocks. The compiler
locates these endpoints and starts the building process from here. It then fol-
lows the connections to the beginning of the sequence.
Figure 164: Endpoints
The second thing that determines the build order is location. In the Program-
ming Sheet, if there are two or more separate groups of connected blocks,
then the one located higher on the y-axis will be compiled before the lower
ones and the one located further to the left of the x-axis will be compiled
before the ones located further to the right.
In practice, you usually do not have to be methodical about block positioning.
However, the following example below shows how important block location
can be to project code execution. The average outdoor air temperature is cal-
206 EC-gfxProgram
Using EC-gfxProgram
culated and stored for two days, therefore at the end of the day, the project
code needs to transfer today’s value to yesterday’s value and yesterday’s
value to the value 2 days ago. The sequence in which this is done is import-
ant: Yesterday’s value needs to be transferred to the value 2 days ago before
today’s value is transferred to yesterday’s value or else today’s value will be
transferred to both yesterday’s value and the value 2 days ago. This operation
happens in the Custom block called Day change OAT AVG. As shown in the
lower image, the transfer of today’s value to yesterday’s value can be located
below or to the right of the transfer of yesterday’s value to the value 2 days
ago for it to be executed second and have proper control logic.
Figure 165: Location of blocks
Figure 166: Inside day change OAT AVG - acceptable location for execution sequence
Figure 167: Inside day change OAT AVG - acceptable location execution sequence
Figure 168: Inside day change OAT AVG - unacceptable location - incorrect sequence
EC-gfxProgram 207
Figure 169: Inside day change OAT AVG - unacceptable location - incorrect sequence
NOTE: Should you change the relative order of blocks on the programming
sheet, the project needs to be synchronized before the new project
code can be executed. In this case, select Compile code and send it
to device synchronization option only. For example, should you move
the blocks shown in Figure 168 to change their relative order to
become as shown in Figure 166, you will have to Synchronize the
project code before running it.
208 EC-gfxProgram
Using EC-gfxProgram
RAM usage
Once a project is built, the Statistics pane displays information concerning the
compilation time, as well as the amount of resources and memory used by the
controller. One of these statistics is RAM usage. The following is a list of gen-
eral issues that affect RAM usage:
• The type of block, block layout, and connections can affect RAM usage.
• Each output of Conditional Custom Block use one unit of RAM.
• Turnaround connections use one unit of RAM.
• For ECY Series controllers: The number of BACnet objects used in your
code. See Supported number of BACnet objects with an ECY Series con-
troller.
EC-gfxProgram 209
Data processing
Data types
The way in which EC-gfxProgram processes data can greatly affect expected
results, resource, and memory usage, as well as several other factors that are
pertinent to the development of a proper control sequence. It is important to
know and understand the different data types, values, and ranges in order to
be able to predict how the control sequence will react to them.
8-Bit and 32-Bit controllers handle numeric information differently according to
their respective network standards.
8-Bit The following controller model use an 8-bit microprocessor: ECP Series. See
ECP Series controllers data processing.
32-Bit The following controller models use an 32-bit microprocessor: ECL, ECB &
ECY Series. See ECL, ECB & ECY Series controller data processing.
ECP Series controllers data processing
The type of data dictates the way a value will appear, its range, and the way it
will react when that range is surpassed. The type of data depends on the type
of block, type of input or output, type of property, etc. The following table lists
and describes all the data types in EC-gfxProgram for ECP Series controllers
with 24-Bit numeric precision.
Table 2: ECP Series controllers data types
Data Type Range Description
Numeric -83886.08 to Signed 24-Bit number with two decimal places. Often used for
+83886.07 sensor values and calculations.
Enum -128 to 127 Enumerations are used for values that have corresponding
actions associated with each integer value such as schedules,
HVAC modes, fan speeds, etc.
Integer -83886 to +83886 Same as Numeric, however the two decimal places are
truncated. Often used for properties associated with time or
iterations.
Digital 0 or 1 Used for decisions (True/False) or switching (On/Off).
String Unlimited Used to name and describe blocks, provide textual
explanations about the control sequence or as notes for the
developer, among other uses.
210 EC-gfxProgram
Using EC-gfxProgram
Data type conversion
In reality there are only two types of numerical data in EC-gfxProgram:
Numeric and Enumeration. Integer and Digital data are actually numeric val-
ues that are restricted to be only integers (Integer data) or 0 and 1 (Digital
data). So an integer value of 279 is actually 279.00 and a digital value of 0 is
actually 0.00.
Each block in EC-gfxProgram can actually receive any type of data type into
its inputs. The block will receive a value and then convert it to the data type of
the block’s input according to a certain set of rules. The following are a list of
rules that apply to Enumeration and Integer inputs when they receive numeric
values:
• If an out-of-range value is received, it is converted to the closest value in
the range. For example, an enumeration input that receives a value of -
524.13 is converted to -128.
• If a value is received within the range, the decimal value is truncated and
not rounded. For example, an integer input receives a value of 34.88 is
converted to 34.
Persistent values (ECP Series controllers)
Persistent Values are values that are saved by the controller during any type
of controller reset or power cycling. The following blocks support persistent
values when used with a controller equipped with a real-time clock (RTC).
Table 3: Persistent values for ECP Series controllers equipped with a real-time clock
Blocks that Support Persistence
Count Up
Count Down
Latch
Timer
Toggle
Variable Enum (ECP Series)
Variable Numeric (ECP Series)
EC-gfxProgram 211
ECL, ECB & ECY Series controller data processing
The type of data dictates the way a value will appear, its range, and the way it
will react when that range is surpassed. The type of data depends on the type
of block, type of input or output, type of property, etc. The following table lists
and describes all the data types in EC-gfxProgram for ECL, ECB & ECY
Series controllers with 32-Bit floating-point numeric precision.
Table 4: ECL, ECB & ECY Series controllers data types
Data Type Range Description
Numeric ±3.4028×1038 Signed 32-Bit number with 8 significant digits that is scaled
using an exponent. Used for sensor values, digital values,
and calculations.
NOTE: Large numbers are entered into a dialog box using
a special format. For example, 2.385X1012 is
entered into a dialog box as 2.385E+12.
A null value is typed into a dialog box as null.
Enum (ECP & -128 to 127 Used for values that have corresponding actions
ECL Series associated with each integer value such as schedules,
controllers only) HVAC modes, fan speeds, etc.
NOTE: For BACnet controllers, the Multistate data type
does not support zero or negative numbers.
When exchanging enumeration values between a
LONWORKS network and a BACnet network, care
must be taken to use enumeration values that are
within the range of the Multistate data type.
Multi State (ECB 1 to 255 Used for values that have corresponding actions
& ECY Series associated with each integer value such as schedules,
controllers only) HVAC modes, fan speeds, etc.
NOTE: For LONWORKS controllers, the Enum data type-
does not support numbers greater than 127.
When exchanging enumeration values between a
LONWORKS network and a BACnet network, care must be
taken to use Multistate values that are within the range of
the Enum data type.
Integer ±3×1038 Same as Numeric, however all decimal places are
truncated. Often used for properties associated with time
or iterations.
Digital 0 or 1 Used for decisions (True/False) or switching (On/Off).
String Unlimited Used to name and describe blocks, provide textual
explanations about the control sequence or as notes for
the developer, among other uses.
212 EC-gfxProgram
Using EC-gfxProgram
Table 4: ECL, ECB & ECY Series controllers data types
Data Type Range Description
Null – A special value to indicate ‘no value’ or an ‘unknown
value’. A null value is typed into a dialog box as null. See
Null value (ECL, ECB & ECY Series).
For ECB & ECY Series controllers: For example, this is
useful to release a priority for a value. See How
commandable object priority levels work.
Out-of-Service
The Out-of-Service property indicates a known problem with a service that
provides a status, data, or values. For example, this can be due to a user
override.
For ECP & ECL Series controllers only: When Out-of-Service is set (True) for
an object, this means the point is under manual or remote control. For exam-
ple, the point is overridden by nviModify or, for hardware outputs only, by the
HOA switch or the nvi of the output LONMARK Object.
For ECB & ECY Series controllers only: When Out-of-Service is set (True) for
an object:
• The BACnet object is disconnected from the controller / program. The
object is no longer written to. For example, the Present Value is decou-
pled from, and will not track changes to the physical input of a Hardware
Input (ECB & ECY Series) block.
• The Present Value can be set to any value by a user to simulate a fixed
condition or a value for test purposes. Other blocks that read the Present
Value of an object that is Out-of-Service will respond to these changes as
though the changes have come from a normally functioning block.
EC-gfxProgram 213
Data type conversion
In reality there are only two types of numerical data in EC-gfxProgram:
Numeric and Enumeration. Integer and digital data are actually numeric val-
ues that are restricted to be only integers (Integer data) or 0 and 1 (Digital
data). So an integer value of 279 is actually 2.79 × 102 and a digital value of 0
is actually 0 × 100.
Each block in EC-gfxProgram can actually receive any type of data type into
its inputs. The block will receive a value and then convert it to the data type of
the block’s input according to a certain set of rules. The following are a list of
rules that apply to Enumeration and Integer inputs when they receive numeric
values:
• If an out-of-range value is received, it is converted to the closest value in
the range. For example, an Enumeration input that receives a value of
307 is converted as follows:
• For ECP & ECL Series controllers, it is converted to the highest allow-
able Enumeration, which is 127.
• For ECB & ECY Series controllers, it is converted to the highest
allowable Multistate, which is 255.
• If a value is received within the range, the decimal value is truncated and
not rounded. For example, an integer input receives a value of 34.8876 is
converted to 34.
Persistent values (ECL, ECB & ECY Series control-
lers)
Persistent Values are values that are saved by the controller during any type
of controller reset or power cycling.
NOTE: Values are persistent only when the value is written directly to the
blocks listed below.
Persistence is not supported when a value is written to a generic ver-
sion of these blocks (if such a block exists). However a generic ver-
sion of the block can be used to read values that have persistence
enabled after a controller reset or power cycling.
Persistent The following blocks support persistent values. For blocks that can support
values for ECL persistence, persistence is enabled by setting the Persist to True in the
Series block’s Properties Pane.
controllers
Table 5: Persistent values for ECL Series controllers
Blocks that can Support Persistence Automatically Persistent Blocks
Count Down Boolean Constant (ECL Series)
214 EC-gfxProgram
Using EC-gfxProgram
Table 5: Persistent values for ECL Series controllers
Blocks that can Support Persistence Automatically Persistent Blocks
Count Up Boolean Value (ECL Series)
Internal variable (ECL, ECB & ECY Enum Constant (ECL Series)
Series)
Latch Enum Value (ECL Series)
Timer (ECL Series) Numeric Constant (ECL Series)
Toggle Numeric Value (ECL Series)
Setpoint Constant (ECL Series)
Network Variable Input (ECL Series) configured as
configuration properties
Persistent The following blocks support persistent values. For blocks that can support
values for ECB & persistence, persistence is enabled by setting the Persist to True in the
ECY Series block’s Properties Pane.
controllers
Table 6: Persistent values for ECB & ECY Series controllers
Blocks that can Support Persistence Automatically Persistent Blocksa
Count Down Analog Value (ECB & ECY Series)
Count Up Binary Value (ECB & ECY Series)
Internal variable (ECL, ECB & ECY Multi State Value (ECB & ECY Series)
Series)b
Latch For the Pid Loop block inputs of ECY Series
controllers only: Pid Loop (ECB & ECY Series)
Timer (ECB & ECY Series)
Toggle
a. For ECB Series controllers:
• For commandable objects, the out-of-service flag, and the following
priority levels are persistent: 1 (Manual Life-Safety), 8 (Manual Oper-
ator), and Relinquish Default.
• For non-commandable objects, the present value and the out-of-ser-
vice flag are persistent.
• For commandable objects with ECY Series controllers:
• The out-of-service flag, and the following priority levels are persistent:
1 (Manual Life-Safety), 8 (Manual Operator), and Relinquish Default.
EC-gfxProgram 215
• The priority level 16 is optionally persistent by setting Persist value 16
in the Resources Configuration window for the following blocks: Ana-
log Value, Binary Value, and Multi State Value, and Pid Loop (inputs
only). See also Commandable values (ECY Series controllers).
• For binary objects that support ElapsedActiveTime and ChangeOf-
StateCount output ports, these values are persistent.
b. For ECY Series controllers: Persistence can be enabled by setting Persist
or Persist value 16 in the Resources Configuration window.
Digital block inputs
For digital inputs that receive a Numeric value, any value other than 0 whether
positive or negative, is converted to 1 (or True) and only 0.00 or 0 × 100 is
considered as 0 (or False).
For example, an Add block outputs a Numeric value of 9.48 to the digital
input, Enable, of a Min On Time block. The Min On Time block converts 9.48
into 1 and thus activates the Enable input and the block is turned On.
NOTE: It is good programming practice to make sure no incorrect
type of values or out of range values enter a block to avoid
undesired behavior. For example:
• A block input that requires an integer is not supplied with a
decimal value (for example, 22.4).
• A block input that requires a digital input is not supplied with a
Numeric value (for example, 25.1).
216 EC-gfxProgram
Using EC-gfxProgram
Numeric data types
The Numeric data type allows for numbers with up to 8 significant digits. In the
interface, these numbers are often rounded to show fewer significant digits.
This can result in confusion when two numbers that are seemingly equal are
evaluated as not being equal. EC-gfxProgram performs calculations using all
significant digits, even when they are not all shown in the interface.
When adding and subtracting highly disparate Numeric numbers having many
orders of magnitude of difference between them will have no effect. For exam-
ple, the operation of adding 1 and 1 quintillion (1×1018) has no effect as there
are not enough significant digits in the Numeric data type to capture and take
into account the addition of 1 under such conditions. An example of this effect
is shown below.
Figure 170: adding 1 to a large number using the numeric data types
Due to this phenomenon, a loop that adds 1 to a number will count up to a
maximum of 16 777 216 and likewise a loop that subtracts 1 from a number
will decrement to a minimum of -16 777 216.
Significant digits
Numbers are displayed with a maximum of 8 significant digits. When a value
has more than 8 significant digits, the truncated number is shown in blue.
Figure 171: Showing a truncated number
EC-gfxProgram 217
Reliability property
The reliability property is an enumeration that provides an indication of
whether current value or the operation of the physical input in question is reli-
able as far as the controller can determine and, if not, why. The reliability
property supports the following enumeration values.
Enumeration Description
No Fault The Present Value is reliable; as no other fault
Detected (enumerated below) has been detected.
No Sensor No sensor is connected to the Input object.
This fault may be sent by the Wireless Sensor block for
example.
Over Range The sensor connected to the Input is reading a value
higher than the normal operating range set in Check
out of range (see the Check out of range setting in
the block’s Advanced Configuration or in the
Resources Configuration window).
If the object is a Digital Input, this is possible when the
Binary state is derived from an analog sensor or a
Digital input equipped with electrical loop supervision
circuits.
Under Range The sensor connected to the Input is reading a value
lower than the normal operating range set in Check
out of range (see the Check out of range setting in
the block’s Advanced Configuration or in the
Resources Configuration window).
If the object is a Digital Input, this is possible when the
Digital Input is actually a binary state calculated from
an analog sensor.
Open Loop The connection between the defined object and the
physical device is providing a value indicating an open
circuit condition.
This threshold for an open circuit condition is set in
Check signal fault when available (see the Check
signal fault setting in the block’s Advanced
Configuration or in the Resources Configuration
window).
Shorted Loop The connection between the defined object and the
physical device is providing a value indicating a short
circuit condition.
The threshold for a short circuit condition is set in
Check signal fault when available (see the Check
signal fault setting in the block’s Advanced
Configuration or in the Resources Configuration
window).
218 EC-gfxProgram
Using EC-gfxProgram
Enumeration Description
Process Error A processing error was encountered.
Multi State Fault The Present_Value of the Multi-state object is equal to
one of the states in the Fault_Values property and no
other fault has been detected.
This fault may be sent by some controller models.
Configuration The object's properties are not in a consistent state.
Error
Communication Proper operation of the object is dependent on
Failure communication with a remote sensor or device and
communication with the remote sensor or device has
been lost.
This fault may be sent by the ComSensor block for
example.
Unreliable Other The controller has detected that the Present Value is
unreliable, but none of the other conditions describe
the nature of the problem. A generic fault other than
those listed above has been detected, e.g. a Digital
Input is not cycling as expected, or a schedule is empty
(it has not yet been configured).
EC-gfxProgram 219
LONWORKS network description
Network variable object
Network Variables allow a controller to send and receive data over the net-
work to and from other devices. A network variable is any data item such as a
temperature, an actuator position, a switch’s setting that a device’s application
program expects to get from another networked device (Network Variable
Input or NVI), or expects to make available to other networked devices (Net-
work Variable Output or NVO).
The data transmitted in network variables are specifically formatted as to their
content and structure according to their type. Common data types have been
defined by LonMark International such as Standard Configuration Property
Types (SCPTs) and Standard Network Variable Types (SNVTs). Application
programs can use non-standard types such as User Network Variable Types
(UNVTs) and User Configuration Property Types (UCPTs). The number and
type of NVOs / NVIs, Configuration Properties Components (CPs), and Con-
figuration Properties (NCIs) are defined in the device’s functional profile. An
example of a LONMARK object found within a functional profile is shown in Fig-
ure 172.
Configuration properties (CPs and NCIs) object
Configuration properties are the customization data sent to the device by net-
work tools. Configuration properties are set during installation, operation, and
maintenance to set device options.
Communication services
Binding Binding is a process of communication between a sender (NVO) and receiver
(NVI) to send an updated value and/or mode. The NVO initiates the communi-
cation by sending an updated current value/or mode to the NVI. For NVOs,
this method can be used for medium to large scale networks since, generally,
updates are sent only when the value and/or mode of the internal point
changes in accordance to the MaxSendTime and MinSendTime values
defined in the controller.
Bindings are made through a network management tool by configuring a
device with the logical address of other devices on the network that are
expecting a network variable. Once configured, the device creates and sends
the appropriate packets to the bound devices. This creates a logical connec-
tion between a NVO in one device and a NVI in one or more devices.
An NVO can be bound to many NVIs to send values to many devices. This is
called a fan out. In the same way, many NVOs can be bound to one NVI. This
is a fan in. For example, a fan in is useful for a roof top unit to calculate the
terminal load of all VAV boxes. An example of how to code a fan in is shown in
Using LONWORKS network variables to fan in values from many controllers.
220 EC-gfxProgram
Using EC-gfxProgram
There are 4 types of bindings or Service/Link Types: Standard, Reliable, Criti-
cal, and Authenticated. See Proxy Ext.
Polling Polling is a method to monitor or write to Network Variables. In a periodic
fashion, as specified by the polling rate, the browser will request and display
the value of a network variable. This is useful when the network variable value
is constantly changing. Polling can create unnecessary network traffic if the
network variable value rarely changes. This can be mitigated by reducing the
polling rate.
Figure 172: Example of a LONMARK object, SVNTs, UNVTs, CPs, and NCIs of a
LONWORKS device
EC-gfxProgram 221
Priority levels in LONWORKS (ECL Series)
There are four ways to control a hardware output. A priority hierarchy shown
in Table 7 determines which method will control the controller’s hardware out-
put. In practice, 1 is the highest priority and 4 is the lowest priority. For exam-
ple, now the project code can know if the output is being controlled by its HOA
switch, by a network binding, or by EC-gfxProgram code. This current priority
value is available to your project code through the block’s Priority port output.
Table 7: ECL Series priority levels
Priority Value Description
0 Default The default value. The hardware output is not
currently being controlled (no other priority is
active).
1 Override An HOA override switch has been activated (is
switch set to either the OFF or MAN positions).
2 Manual The hardware output has been overridden by
operator the nviModify mechanism. EC-gfxProgram
interface uses this mechanism when you
manually set a block’s output (by right-clicking
the block or right-clicking a resource in the and
selecting Override - see Resource Viewer). See
Override and auto.
3 Network The hardware output has been overridden
override through the NVI hardware output.
4 Program Automatic EC-gfxProgram Program operation.
The hardware output is under the control of your
project code or the interface.
The LONWORKS Properties tab in the block’s advanced configuration shows
the block instance’s network variable input information. Writing to this NVI is
at priority level 3.
Figure 173: Typical LONWORKS Properties tab that shows the Network Variable
Information
See also Output priority.
222 EC-gfxProgram
Using EC-gfxProgram
BACnet objects, services, and data priority
Object and properties
In a BACnet device, Objects represent physical inputs, outputs, and values for
and from software processes. All BACnet devices use the Device Object to
identify themselves. Objects are viewed and controlled through a set of prop-
erties that belong to each object. An example of this is shown below.
Figure 174: Objects and properties of a BACnet device
Present value The Present Value property is the value of the Input / Output / Value at the
moment. For properties that are commandable, the method by which the
Present Value is determined is explained in Commandable object priority
array levels When a property is Out-of-Service, it is manually overridden as
explained below.
Non- Blocks with Non-Commandable Objects and Commandable Objects are
commandable shown in the table below.
and
commandable
objects for
standard BACnet
objects
Table 8: Non-commandable and commandable objects for standard BACnet objects
BACnet
Block Description Type
Acronym
Hardware Input (ECB & BI Digital Input Non-Commandable Object
ECY Series)
MSI Multi State Non-Commandable Object
Input
AI Analog Input Non-Commandable Object
EC-gfxProgram 223
Table 8: Non-commandable and commandable objects for standard BACnet objects
BACnet
Block Description Type
Acronym
Binary Value (ECB & BV Digital Value For ECB Series controllers:
ECY Series)
• Commandable Object
Generic Binary Value
• Non-Commandable Object
(ECB & ECY Series)
For ECY Series controllers: all
instances are Commandable Objects
Multi State Value (ECB & MSV Multi State For ECB Series controllers:
ECY Series) Value
• Commandable Object
Generic nLight Channel
• Non-Commandable Object
(ECY Series)
For ECY Series controllers: all
instances are Commandable Objects
Analog Value (ECB & AV Analog Value For ECB Series controllers:
ECY Series)
• Commandable Object
Generic Analog Value
• Non-Commandable Object
(ECB & ECY Series)
For ECY Series controllers: all
instances are Commandable Objects
Hardware Output (ECB & BO Digital Output For ECB Series controllers:
ECY Series)
• Commandable Object
• Non-Commandable Object
For ECY Series controllers: all
instances are Commandable Objects
AO Analog Output For ECB Series controllers:
• Commandable Object
• Non-Commandable Object
For ECY Series controllers: all
instances are Commandable Objects
Light Output (ECB & ECY AO Analog Output Commandable Object
Series expansion
modules)
Sunblind Output (ECB &
ECY Series expansion
module)
Non- EC-gfxProgram supports the writing of values that are without priority. These
commandable values are written directly to the Present Value. The last write to a Writable
objects Property overwrites any previous writes that were made to the Writable Prop-
properties erty.
224 EC-gfxProgram
Using EC-gfxProgram
Commandable See Commandable object priority array levels.
object priority
levels
Reading and BACnet devices can support a number of services to exchange values from
writing network one controller to another. Typically read services retrieve a value from a BAC-
points net object property. On the other side, a write service sends a value to a BAC-
net object property.
Controller
See
Model
ECB Series Methods for reading from a network point (ECB Series)
Methods for writing to a network point (ECB Series)
ECY Series Methods for reading from a network point (ECY Series)
Methods for writing to a network point (ECY Series)
See also Network Value (ECB & ECY Series).
Methods for reading from a network point (ECB Series)
ECB Series controllers support the following services to read a network point.
Table 9: Methods for reading from a network point - ECB Series
Access Type Description
Read Property Read polling makes a request to a network device to
provide the value of a network point at a regular time
interval. Should the value change immediately after the
value was polled, the update will occur only when the
device is polled again. The polling frequency should not
be set too high as this can create excessive network
traffic. The Read Property service is supported at
minimum by all network devices.
Read Property Read multiple points in one telegram. This reduces the
Multiple amount of network traffic required to transmit data. It is
preferable to use the Read Property Multiple service
when a device supports this service, instead of using
the Read Property service.
If the device that is servicing the request does not
support the Read Property Multiple service, the
controller will fall-back to using the Read Property
service to satisfy the request.
EC-gfxProgram 225
Table 9: Methods for reading from a network point - ECB Series
Access Type Description
Confirmed COV Subscribe as a client to an object for change-of-value
Subscription reporting. The remote device (server) watches the
object property value, the subscription list, and the
change criteria. The change criteria are determined by
a change in value, and throttling rules for the minimum
and maximum period between object value
transmissions. When the change criteria for the value
are met, the server sends COV notifications for the new
value to the subscribed clients.
Clients return a confirmation message to the server to
validate that the message was received. This adds
extra traffic on the network. If a confirmation is not
received, the COV notification is resent.
NOTE: Not all BACnet devices support this service and
often have a limited number of subscriptions
supported.
Unconfirmed Subscribe as a client to an object for change-of-value
COV reporting. The remote device (server) watches the
Subscription object property value, the subscription list, and the
change criteria. The change criteria are determined by
a change in value, and throttling rules for the minimum
and maximum period between object value
transmissions. When the change criteria for the value
are met, the server sends COV notifications for the new
value to the subscribed clients.
Clients do not return a confirmation message to the
server to validate that the message was received. This
reduces the amount of traffic on the network. This
method is less secure as lost messages are not resent.
NOTE: Not all BACnet devices support this service and
often have a limited number of subscriptions
supported.
Receive Instead of regularly polling an object for its value, this
Broadcast COV allows a device to push a value to the receiving
controller only when the value has changed at the
remote controller. This method is useful to reduce
network congestion as information is transmitted only
when necessary. The remote controller must be
configured for Send Broadcast COV for the property
value.
226 EC-gfxProgram
Using EC-gfxProgram
Methods for writing to a network point (ECB Series)
ECB Series controllers support the following services to write to a network
point.
Table 10: Methods for writing to a network point - ECB Series
Access Type Description
Write Property Write to a network point.
Write Property Write multiple points in one telegram. This reduces the
Multiple amount of network traffic required to transmit data. No
confirmation message is returned and there is no
guarantee that the write message was successfully
received. If the device being written support the write
property multiple service execution, this service is
preferred over Write Property.
Send Local The local device (server) watches the object property
Broadcast COV value and the change criteria. The change criteria are
determined by a change in value, and throttling rules
for the minimum and maximum period between object
value transmissions. When the change criteria for the
value are met, the server broadcasts a COV notification
for the new value to any client that may need it (remote
device) located on the local BACnet MS/TP data bus
(all devices that share the same Network Number or
are on the same subnet).
This broadcast COV is not passed on (repeated) by a
Building Controller.
Clients do not return a confirmation message to the
server to validate that the message was received. This
reduces the amount of traffic on the network. This
method is less secure as lost messages are not resent.
NOTE: Not all BACnet devices support this service and
often have a limited number of subscriptions
supported.
EC-gfxProgram 227
Table 10: Methods for writing to a network point - ECB Series
Access Type Description
Send Global The local device (server) watches the object property
Broadcast COV value and the change criteria. The change criteria are
determined by a change in value, and throttling rules
for the minimum and maximum period between object
value transmissions. When the change criteria for the
value are met, the server broadcasts a COV notification
for the new value to any client (remote device) located
on the BACnet intranetwork that may need it. This
broadcast COV is passed on (repeated) by Building
Controllers according to their routing configuration.
Clients do not return a confirmation message to the
server to validate that the message was received. This
reduces the amount of traffic on the network. This
method is less secure as lost messages are not resent.
NOTE: Not all BACnet devices support this service and
often have a limited number of subscriptions
supported.
Methods for reading from a network point (ECY Series)
ECY Series controllers support services to read a network point either locally
or remotely when Operation is set to Read Local Property or Read Remote
Property. When reading a remote property, the controller discovers the ser-
vice type that the remote controller is configured for. It will detect and auto-
matically configure itself for the service type the remote network point has
been configured to provide, as follows: Read Property, Read Property Multi-
ple, Confirmed COV Subscription, Unconfirmed COV Subscription, or
Receive Broadcast COV. These properties are configured in the Resources
Configuration and the parameters are described in Network Value (ECB &
ECY Series).
Methods for writing to a network point (ECY Series)
ECY Series controllers support services to write to a network point either
locally or remotely when Operation is set to Write Local Property or Write
Remote Property. These properties are configured in the Resources Config-
uration and the parameters are described in Network Value (ECB & ECY
Series).
Table 11: Methods for writing to a network point - ECY Series
Access Type Description
Write Property Write to a network point.
228 EC-gfxProgram
Using EC-gfxProgram
Table 11: Methods for writing to a network point - ECY Series
Access Type Description
Write Property Write multiple points in one telegram. This reduces the
Multiple amount of network traffic required to transmit data. No
confirmation message is returned and there is no
guarantee that the write message was successfully
received. If the device being written support the write
property multiple service execution, this service is
preferred over Write Property.
Send Local The local device (server) watches the object property
Broadcast COV value and the change criteria. The change criteria are
determined by a change in value, and throttling rules
for the minimum and maximum period between object
value transmissions. When the change criteria for the
value are met, the server broadcasts a COV notification
for the new value to any client that may need it (remote
device) located on the local IP network (all devices that
share the same Network Number).
This broadcast COV is not passed on (repeated) by a
Building Controller.
Clients do not return a confirmation message to the
server to validate that the message was received. This
reduces the amount of traffic on the network. This
method is less secure as lost messages are not resent.
NOTE: Not all BACnet devices support this service and
often have a limited number of subscriptions
supported.
Send Global The local device (server) watches the object property
Broadcast COV value and the change criteria. The change criteria are
determined by a change in value, and throttling rules
for the minimum and maximum period between object
value transmissions. When the change criteria for the
value are met, the server broadcasts a COV notification
for the new value to any client (remote device) located
on the BACnet intranetwork that may need it. This
broadcast COV is passed on (repeated) by Building
Controllers according to their routing configuration.
Clients do not return a confirmation message to the
server to validate that the message was received. This
reduces the amount of traffic on the network. This
method is less secure as lost messages are not resent.
NOTE: Not all BACnet devices support this service and
often have a limited number of subscriptions
supported.
Fault status flag Logical True (1) if the Reliability property is present and does not have a
value of No Fault Detected, otherwise logical False (0).
EC-gfxProgram 229
Commandable object priority array levels
A write to a Commandable Object always contains a priority level. This allows
the most important value (the one with the highest priority level) to be the one
to supersede all other levels. The highest priority levels are reserved for man-
ual life safety. If there is no priority level specified, the write to the Command-
able Object is assumed to be the lowest active Present Value priority.
Standard BACnet Priority level assignments are shown in the table below.
Table 12: Commandable object priority array levels
Priority Level Application
1 Manual Life Safety.
2 Automatic Life Safety
3 User-Defined
4 User-Defined
5 Critical Equipment Control
6 RESERVED: This command priority cannot be used for
any purpose by any object. It is reserved for internal
use only for the Minimum On/Off time property.
7 User-Defined
8 Manual Operator
9 User-Defined
10 User-Defined
11 User-Defined
12 User-Defined
13 User-Defined
14 User-Defined. This is EC-gfxProgram’s default priority
level for ECB Series controllers.
15 User-Defined
16 User-Defined. This is EC-gfxProgram’s default priority
level for ECY Series controllers.
- Relinquish Default: If no priority level is active, the
relinquish default becomes the Present Value.
NOTE: In EC-Net, do not use priority level inputs 1 to 16 on proxy
points mapped on non-commandable objects as non-com-
mandable objects do not support this concept, which may
produce unexpected results.
230 EC-gfxProgram
Using EC-gfxProgram
How commandable object priority levels work
At start up, for each Commandable Object, the controller re-populates any
Persistent Values into the Priority Array. The remaining positions are filled
with Null values. When a command value is received, the Controller updates
the slot in the Priority Array with the new value. The controller continuously
looks through the Priority Array of each Commandable Object and looks for
the highest priority slot that is not Null. The value of this slot becomes the
Present Value.
If two devices command the same priority level, it is the device that makes the
last write to the priority array level that will be in effect.
Edit priority values
You can access the Priority Array Values window to view or change the values
for the 16 priority levels of commandable objects.
To access this window, right-click a commandable object on the programming
sheet, and select the BACnet Object > Edit Priority Values option.
Figure 175: The Priority Array Values window
EC-gfxProgram 231
Item Description
1 The Present Value, as defined by the values set in block’s priority
levels, or its Default Value if all inputs have a Null value.
2 The 16 priority levels and their set values. To set the Null value
for a field, leave it empty and click away.
3 Applies and saves changes made to any of the 16 priority levels.
The Present Value changes to the value of the highest priority
level, if modified.
4 Refreshes all priority levels to their last saved value.
Relinquish default
When all command priority level values in the Priority Array have a Null value,
the Relinquish Default becomes the Present Value.
Relinquishing a To relinquish a priority level in the Priority Array, send a Null value at that pri-
priority ority level to free the slot. A relinquish can have three outcomes:
• The Present Value does not change as there is currently a non-Null value
at a higher priority level.
• The Present Value changes to the value of the next highest priority level
as the relinquish command was for the current highest priority level.
• The Priority Array is now empty (all slots are Null) and the Relinquish
Default value adopted is the Present Value.
232 EC-gfxProgram
Block Objects
CHAPTER 6
Block Objects
This chapter describes the EC-gfxProgram block objects that can found in the
Toolbox pane.
Topics
Overview of block objects
ByteLight
Comparators
Constants and variables
ECP Series specific blocks
ECL Series specific constant and variable blocks
ECB & ECY Series specific blocks
Custom
General
Generics
HVAC
Inputs and Outputs
LONMARK Objects (ECL Series)
Logic
Logic (Binary)
Math
nLight
Psychrometric
SNVT Conversions (ECP Series specific blocks)
Time
Tools
VAV
EC-gfxProgram 233
Overview of block objects
EC-gfxProgram blocks allow users to quickly and easily assemble common
and customized programs. These programs can be assembled simply by
dragging and dropping the required blocks from the vast block library found in
the Toolbox pane onto the programming sheet and then linking them
together with a simple “click, drag, and release” technique.
Block objects description
Every block found in the Toolbox pane has a unique function, though they all
have the same basic elements in common.
Figure 176: Block description
The following are the components of a typical block:
1. Block icon
2. Input port(s). See Configure Ports for more information.
3. Block name (editable). See Common block properties for more informa-
tion.
4. Block type and number (if applicable). For controllers that support ECx-
400 Series Extension Modules, this shows the controller or ECx-400
Series Extension Module on which a Hardware Input or Hardware Output
has been configured (for example, 205 is the fifth output of the second
ECx-400 Series Extension Module).
5. Output port(s). See Configure Ports for more information.
6. Port connection indicator(s) (white for connected port; red for uncon-
nected port). Ports that have connection indicators must be connected to
be able to build the code, otherwise an error will appear in the Error List
pane. See Configure Ports for more information.
7. Some blocks show their configuration type as set in the block’s advanced
properties.
234 EC-gfxProgram
Block Objects
Collapsed blocks
Certain blocks can be collapsed in order to conserve space on the program-
ming sheet.
Figure 177: The bottom image shows blocks that have been collapsed
The label in a collapsed block is composed of the following components:
• the block name
• the acronym of the block instance type,
• the name of the exposed port, when the it is not Input or Output, as
shown below.
Figure 178: A collapsed block
EC-gfxProgram 235
To collapse a block, only one input or output port for the block must be
exposed. Proceed as follows.
1. Right-click the block and select Configure Ports.
Figure 179: Configuring the block’s ports
2. The collapsed block can expose only one port. Select the one port the
collapsed block is to expose; ensure that all other ports are deselected.
Figure 180: Selecting the port exposed on the collapsed block
3. Configure the format of the port if necessary by clicking Format – See
Configure Ports.
4. Click OK. The block now has only one port exposed.
Figure 181: A block with only one port exposed
236 EC-gfxProgram
Block Objects
5. While the block is selected, set the Collapsed property to True in the
block’s Properties Pane.
Figure 182: Setting the Collapsed property to true
OR
Right-click on the block, and select Collapse.
6. The block is now collapsed.
Figure 183: The collapsed block
7. To expand the collapsed block, set the Collapsed property to False in the
block’s Properties Pane or right-click on the block and select Expand.
NOTE: You can also select multipe blocks and collapse/expand the blocks
simultaneously.
Common block properties
When a block is selected and the Properties pane is shown, the following
properties are available for most blocks.
EC-gfxProgram 237
Property Type Range Default Description
(Name) String Unlimited The block’s Name of the block.
default name
For ECY Series controllers, this can
also be set in the Resources
Configuration.
Description String Unlimited – Description of the block.For ECY
Series controllers, this can also be set
in the Resources Configuration.
Location Integer Unlimited – X-coordinate of the block location.
Y-coordinate of the block location.
Width Integer See – Width of the block.
Description
Controller Menu True or False When this is set to True, this allows
Specific False the option of not overwriting the value
(available during project code synchronization
with certain (see Project Synchronization). When
blocks) sending updated project code to two
or more controllers, this is useful to
avoid overwriting:
• VAV box balancing values such
as Minimum Flow, Maximum
flow or K Factor.
• Setpoints (for example, for the
Setpoint Constant (ECL Series)
block).
For ECY Series controllers, this
option can also be set in the
Resources Configuration.
Collapsed Menu True or False When only one output port is made
(available False visible on the block (see Configure
with certain Ports), this can be set to True. This
blocks) reduces the block to a slim format.
The single port that was made visible
then becomes the block’s only visible
port. See Collapsed blocks.
When set to False, the normal block
format is shown.
238 EC-gfxProgram
Block Objects
ByteLight
ByteLight is an indoor positioning solution that uses connected ceiling
mounted LED lighting to create a beacon signal that allows a mobile device’s
position to be accurately known.
ByteLight Group (ECY Series)
Description Provides an interface to the ByteLight network. ByteLight controls can be con-
nected to certain ECY Series controller models. See your controller’s data-
sheet for more information about the number and type of ByteLight modules
that are supported.
Advanced Resources Configuration, Alarms (ECB & ECY Series), Network Properties
configuration Configuration window (ECL, ECB & ECY Series), Emergency override and
emergency auto (ECB & ECY Series), Override and auto, Set Value, Find All
References (ECL, ECB & ECY Series), Copy From, Configure Ports, Show/
Hide Ports
Input(s)
Port Type Range Description
Input Numeric 0 to 100% Sets the lighting fixture’s dimming level.
Priority Integer 1 to 16 The current active priority for commandable objects.
See Commandable object priority array levels.
Feedback Digital 0 or 1 When alarms are enabled for this block, and the
value at this input is different from the Present
Value, this triggers a notification message. See
Alarms (ECB & ECY Series) to configure the alarm
settings.
Trigger Digital 0 or 1 When Broadcast Mode in the Resources
Broadcast Configuration for this block is set to Local or Global,
this port becomes available. A pulse at this input
triggers a broadcast of the object’s present value on
the local network or global networks. See Broadcast
mode.
EC-gfxProgram 239
Port Type Range Description
AlarmInhibit Digital 0 or 1 While set to True (1), no alarms will be reported by
the block. See AlarmInhibit input (ECY Series
controllers).
Output(s)
Port Type Range Description
Output Numeric ±3.4028×1038 The luminaire’s current dimming level. The Present
Value. See Commandable object priority array
levels.
Number Integer – The current block number.
OutOfService Digital 0 or 1 See Out-of-Service.
Fault Digital 0 or 1 Logical True (1) if the Reliability Property does not
have a value of No Fault Detected, otherwise logical
False (0).
Reliability Enum See This provides an indication of whether the power
Description pack is connected to the controller (No fault
detected (0)) or not (Communication failure (12)).
See also Reliability property. Configuration error
identifies that the power pack’s configuration is not
valid.
Priority Integer 1 to 16 The current active priority for commandable objects.
See Commandable object priority array levels.
InAlarm Digital 0 or 1 When Enable Alarms is set for this block and the
present value is outside of the High limit and Low
limit settings and taking into consideration the Dead
band and Time delay settings, this output is On (1).
See Alarms (ECB & ECY Series) to configure the
alarm settings.
NOTE: Setting or clearing High or Low in the Limit
enable options shown above has no effect
on the activation of this output.
Block properties See also Common block properties.
Property Type Range Default Description
Number Menu See Description Not Set The ByteLight Group instance. Click the
drop-down arrow to select the ByteLight
Group to use for the selected block.
240 EC-gfxProgram
Block Objects
Comparators
Comparators are blocks that evaluate two numeric inputs using a particular
function (=, , <, , >, and ). The block will output whether the comparison is
True (1) or False (0) relative to the function used.
The following blocks are available in this category:
• Between
• Equal
• Greater or Equal
• Greater Than
• Is Null (ECL, ECB & ECY Series)
• Less or Equal
• Less Than
• Not Equal
Example Comparators are basic blocks that are often implicitly incorporated within
other more complex blocks. However, they are useful when building simple
control sequences. The example below shows how a Baseboard (Hardware
Output block) is controlled based on the comparison (Equal block) of the
scheduled occupancy (Schedule block) to an occupancy setpoint (Internal
Constant block) and (And block) the comparison (Less Than block) of the
Room Temperature to a temperature Setpoint (Hardware Input blocks).
Figure 184: Comparators example
The Equal block compares the occupancy from the Schedule block to the set
occupancy from the Internal Constant block. Thus the output of the Equal
block will only be True when the occupied mode is scheduled. Similarly, the
Less Than block compares the Room Temperature from a Hardware Input
block to a Setpoint also from a Hardware Input block. Therefore the output of
the Less Than block will only be True when the Room Temperature is below
EC-gfxProgram 241
the Setpoint. The And block checks the outputs of the Equal and Less Than
blocks and only when both conditions are True will the Output of the And
block be True and turn the Baseboard (Hardware Output block) On.
Between
Description The output will be True (1) if the value of Input is within the range of the Low-
Limit and HighLimit inputs where Input is greater or equal to LowLimit AND
Input is less or equal to HighLimit.
The output will be False (0) if the value of Input is outside of the range of the
LowLimit and HighLimit inputs.
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
32-Bit 8-Bit
Input Numeric ±3.4028×1038 -83886.08 to Block input. The value that is tested
+83886.07 whether it is within range.
LowLimit Numeric ±3.4028×1038 -83886.08 to The value of the low limit.
+83886.07
HighLimit Numeric ±3.4028×1038 -83886.08 to The value of the high limit.
+83886.07
242 EC-gfxProgram
Block Objects
Output(s)
Port Type Range Description
Output Digital 0 or 1 Block output. The result of the comparison.
For ECL, ECB & ECY Series controllers:
• First priority condition: If the Input to this block is Null, then
the Output of this block is always Null.
• Second priority condition: If either of the LowLimit or
HighLimit Inputs to this block are Null or both the Low-
Limit and HighLimit Inputs are Null, then the Output of
this block is always False.
Block properties See Common block properties.
Equal
Description The output will be True (1) if the value of Input1 is equal to the value of
Input2 (Input1 = Input2).
The output will be False (0) if the value of Input1 is not equal to the value of
Input2 (Input1 Input2).
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
32-Bit 8-Bit
Inputx Numeric ±3.4028×1038 -83886.08 to Block input. The two values that are
+83886.07 compared. For a Null Input value, see
(x=1 to 2)
below.
EC-gfxProgram 243
Output(s)
Port Type Range Description
Output Digital 0 or 1 Block output. The result of the comparison.
For ECL, ECB & ECY Series controllers: If one or more
Inputs to this block are Null, then the Output of this
block is always Null. This is remains true when
comparing Null at Input1 to Null at Input2; the Output of
this block is remains Null.
NOTE: If the sequence requires that a value be tested to
be Null, use the IsNull comparator. See Is Null
(ECL, ECB & ECY Series).
Block properties See Common block properties.
Greater or Equal
Description The output will be True (1) if the value of Input1 is greater than or equal to the
value of Input2 (Input1 Input2).
The output will be False (0) if the value of Input1 is less than the value of
Input2 (Input1 < Input2).\
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
32-Bit 8-Bit
Input1 Numeric ±3.4028×1038 -83886.08 to Block input. The value being compared.
+83886.07 For a Null Input value, see below.
Input2 Numeric ±3.4028×1038 -83886.08 to Block input. The comparator value. For a
+83886.07 Null Input value, see below.
244 EC-gfxProgram
Block Objects
Output(s)
Port Type Range Description
Output Digital 0 or 1 Block output. The result of the comparison.
For ECL, ECB & ECY Series controllers: If one or more
Inputs to this block are Null, then the Output of this
block is always Null. This is remains true where Null ≥
Null provides a Null output.
Block properties See Common block properties.
Greater Than
Description The output will be True (1) if the value of Input1 is greater than the value of
Input2 (Input1 > Input2).
The output will be False (0) if the value of Input1 is less than or equal to the
value of Input2 (Input1 Input2).
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
32-Bit 8-Bit
Input1 Numeric ±3.4028×1038 -83886.08 to Block input. The value being
+83886.07 compared. For a Null Input value, see
below.
Input2 Numeric ±3.4028×1038 -83886.08 to Block input. The comparator value.
+83886.07 For a Null Input value, see below.
EC-gfxProgram 245
Output(s)
Port Type Range Description
Output Digital 0 or 1 Block output. The result of the comparison.
For ECL, ECB & ECY Series controllers: If one or
more Inputs to this block are Null, then the Output of
this block is always Null. This is remains true where
Null > Null provides a Null output.
Block properties See Common block properties.
Is Null (ECL, ECB & ECY Series)
Description An IsNull block evaluates if the input is Null according to the following logic
table.
Input Output
±3.4028×1038 0
Null 1
Advanced Configure Ports, Show/Hide Ports
configuration
Input(S)
Port Type Range Description
Input Numeric ±3.4028×1038 Block input. The value being tested for being Null.
Output(s)
Port Type Range Description
Output Digital 0 or 1 Block output. The result of the comparison.
Block properties See Common block properties.
246 EC-gfxProgram
Block Objects
Less or Equal
Description The output will be True (1) if the value of Input1 is less than or equal to the
value of Input2 (Input1 Input2).
The output will be False (0) if the value of Input1 is greater than the value of
Input2 (Input1 > Input2).
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
32-Bit 8-Bit
Input1 Numeric ±3.4028×1038 -83886.08 to Block input. The value being compared.
+83886.07 For a Null Input value, see below.
Input2 Numeric ±3.4028×1038 -83886.08 to Block input. The comparator value. For a
+83886.07 Null Input value, see below.
Output(s)
Port Type Range Description
Output Digital 0 or 1 Block output. The result of the comparison.
For ECL, ECB & ECY Series controllers: If one or more
Inputs to this block are Null, then the Output of this block
is always Null. This is remains true where Null ≤ Null
provides a Null output.
Block properties See Common block properties.
EC-gfxProgram 247
Less Than
Description The output will be True (1) if the value of Input1 is less than the value of
Input2 (Input1 < Input2).
The output will be False (0) if the value of Input1 is greater than or equal to
the value of Input2 (Input1 Input2).
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
32-Bit 8-Bit
Input1 Numeric ±3.4028×1038 -83886.08 to Block input. The value being compared.
+83886.07 For a Null Input value, see below.
Input2 Numeric ±3.4028×1038 -83886.08 to Block input. The comparator value. For
+83886.07 a Null Input value, see below.
Output(s)
Port Type Range Description
Output Digital 0 or 1 Block output. The result of the comparison.
For ECL, ECB & ECY Series controllers: If one or more
Inputs to this block are Null, then the Output of this
block is always Null. This is remains true where Null <
Null provides a Null output.
Block properties See Common block properties.
248 EC-gfxProgram
Block Objects
Not Equal
Description The output will be True (1) if the value of Input1 is not equal to the value of
Input2 (Input1 Input2).
The output will be False (0) if the value of Input1 is equal to the value of
Input2 (Input1 = Input2).
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
32-Bit 8-Bit
Inputx Numeric ±3.4028×1038 -83886.08 to Block input. The two values that are
+83886.07 compared. For a Null Input value, see
(x=1 to 2)
below.
Output(s)
Port Type Range Description
Output Digital 0 or 1 Block output. The result of the comparison.
For ECL, ECB & ECY Series controllers: If one or more
Inputs to this block are Null, then the Output of this
block is always Null.
Block properties See Common block properties.
EC-gfxProgram 249
Constants and variables
Constants are blocks that are mostly used to configure set values (setpoints,
delays, limits, etc.) that may need to be made available to an HMI. Variables
are blocks that are mostly used to monitor changing values or calculate new
values using old ones that may need to be made available to an HMI.
Common blocks The following blocks are available in this category:
• Internal constant
• Internal variable (ECL, ECB & ECY Series)
• Null value (ECL, ECB & ECY Series)
About internal There is also another type of constant block. The Internal Constant block is
constants used within the program only and is not exposed to the network or an HMI.
Value blocks allow values to be changed during runtime while Internal Con-
stant blocks require the project code to be recompiled. The number of Values
that are available is limited as they are a resource while the number of Inter-
nal Constants is not limited in number.
About internal Internal Variable blocks are used to internally store results from a calculation
variables (the value is not available to the network). For example, it can be used to
store the highest value when using a For Loop. Also, it can be used to store a
value with persistence, to store the time for optimum start, or to calculate a
daily parameter that does not need to be on the network interface.
A unit can be assigned to the value. They can be formatted to any standard
enumeration or to Boolean values (True or False).
About null A special value to indicate ‘no value’ or an ‘unknown value’. See Null value
values (ECL, ECB & ECY Series). For example, for ECB & ECY Series controllers,
this is useful to release a priority for a value - see How commandable object
priority levels work.
250 EC-gfxProgram
Block Objects
Internal constant
Description Mainly used for internal math processing or for constant values that do not
requiring monitoring. They can be formatted to any standard enumeration or
to Boolean values (True or False).
NOTE: When the value of this block is modified, the project code must be
recompiled.
Persistence The current value is persistent; this allows a value to be saved during a con-
troller power cycle or reset. See Persistent values (ECP Series controllers)
and Persistent values (ECL, ECB & ECY Series controllers).
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s) N/A
Output(s)
Port Type Range Description
32-Bit 8-Bit
Output Numeric ±3.4028×1038 -83886.08 to Block output. The constant value.
+83886.07
Block properties See Common block properties.
Property Type Range Default Description
32-Bit 8-Bit
Value Numeric ±3.4028×1038 -83886.08 to 0 Value of the block.
+83886.07
EC-gfxProgram 251
Internal variable (ECL, ECB & ECY Series)
Description Used to internally store results from a calculation. The value is not available to
the network. For example, it can be used to store the highest value when
using a For Loop. Also, it can be used to store a value with persistence, to
store the time for optimum start, or to calculate a daily parameter that does
not need to be on the network interface but that must be stored in controller’s
memory when the device is reset.
A unit can be assigned to the value. They can also be formatted to any stan-
dard enumeration or to Boolean values (True or False).
Slim format This block can be collapsed into a slim format. See Collapsed in Common
support block properties.
Number of For ECL Series and ECB Series controllers: The number of Internal Variable
blocks block instances supported by a controller is shown in the Number drop-down
list in the Properties or Statistics panes.
For ECY Series controllers: see Supported number of BACnet objects with an
ECY Series controller.
Persistence Allows a value to be saved during a controller power cycle or reset. For ECL
Series and ECB Series controllers: the number of persistent Internal Variables
supported by a controller is shown in the Statistics pane, or refer to the con-
troller’s datasheet. For ECY Series controllers: see Supported number of
BACnet objects with an ECY Series controller. See Persistent values (ECL,
ECB & ECY Series controllers).
Advanced Resources Configuration, Set Value, Find All References (ECL, ECB & ECY
configuration Series), Copy From, Configure Ports, Show/Hide Ports
Related blocks Generic Internal Variable (ECL, ECB & ECY Series)
Input(s)
Port Type Range Description
Input Numeric ±3.4028×1038 Block input. The Internal Variable value.
252 EC-gfxProgram
Block Objects
Output(s)
Port Type Range Description
Output Numeric ±3.4028×1038 Block output. The Present Value.
Number Integer – The current block number.
Block properties See also Common block properties.
Property Type Range Default Description
Number Menu See Internal Use this drop-down menu to select an instance
Description Variable 1 of this block. See Number of blocks for the
number of block instances supported by the
current controller model.
NOTE: When a new block instance is added to
the programming sheet, the block’s
number is incremented to the next avail-
able block number according to the cur-
rent Auto Increment setting. See Auto
increment (ECP & ECL Series and EBC
Series controllers only) or Auto incre-
ment (ECY Series controllers only).
Persist Menu See False When this option is True, the output and mode is
Description preserved during a controller reset. The number
of persistent Internal Variables supported by a
controller is shown in the Statistics pane, or refer
to the controller’s datasheet. See Persistent
values (ECL, ECB & ECY Series controllers).
Null value (ECL, ECB & ECY Series)
Description A special value to indicate ‘no value’ or an ‘unknown value’. For example, a
block’s output can have this value when the resource for the output is not
available. This can occur when a network connection is lost.
Related blocks Is Null (ECL, ECB & ECY Series)
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s) N/A
EC-gfxProgram 253
Output(s)
Port Type Range Description
Output Null Null Block output. The null value.
Block properties See Common block properties.
254 EC-gfxProgram
Block Objects
ECP Series specific blocks
There are two types of constant and variable blocks. Numeric blocks output
any decimal number between -83886.08 and +83886.07. They can be used
for several purposes including creating setpoints, storing the results of a cal-
culation, monitoring values, etc. Enumeration (enum) blocks output any inte-
ger value from -128 to 127. They are often used to correspond to various
equipment modes (HVAC, fan, occupancy, etc.) or as two-state Boolean val-
ues representing “True” or “on” with a value of 1 and “False” or “off” with a
value of 0.
There is also another type of constant block. The Internal constant block is
used within the program only and is not exposed to the network or an HMI.
Constant and Variable blocks allow values to be changed during runtime while
Internal Constant blocks require the project code to be recompiled. The
number of Constants and Variables that are available is limited as they are a
resource while the number of Internal Constants is not limited in number.
The following blocks are available in this category:
• Constant Enum (ECP Series)
• Constant Numeric (ECP Series)
• Variable Enum (ECP Series)
• Variable Numeric (ECP Series)
Example Constants and Variables are blocks that are used to set and monitor values.
These values are either used for internal calculation only or they can be
exposed to the network. The example below shows how a Supply Air Tem-
perature Setpoint (Variable Numeric block) is calculated based on the Out-
door Air Temperature (Hardware Input block) being interpolated linearly
(Linear block) and limited (Limit block) by a Maximum and Minimum Supply
Air Temperature (Constant Numeric blocks) and a maximum and minimum
outdoor air temperature (Internal Constant block).
Figure 185: Constants and variables examples
The Internal Constant blocks set the outdoor air temperature limits, which
are not required to change. The Constant Numeric blocks set the supply air
temperature min and max values, which can be changed through an HMI over
the network. The Linear block then creates a linear interpolation based on
these min and max values and the Limit block sets the values received from
EC-gfxProgram 255
the Constant Numeric blocks as outdoor air temperature limits. The Hard-
ware Input block sends the value of the Outdoor Air Temperature and the
Supply Air Temperature Setpoint is calculated and outputted by the Limit
block to the Variable Numeric block where it can be monitored by an HMI
over the network.
Constant Enum (ECP Series)
Description Mainly used for adjustable mode values or for constant values requiring moni-
toring. They can be formatted to any standard enumeration or to Boolean val-
ues (True or False). These blocks are available in a structured configuration
property (UCPT_constant_enum_1to31) implemented as a NCI (nciCe1_31).
The user can read or write the values of the Constant Enum blocks 1 to 31
directly through these configuration properties.
WARNING: Values stored in Constant Enum blocks are always persistent.
Never write to this constant’s Network Configuration Input (NCI)
from the network with an automated process (Polling). Continu-
ous writing to this constant’s NCI could exhaust the ability of the
controller’s EEPROM to store the value in its permanent memory.
Should this happen, controller failure will result.
Number of 31
blocks
Advanced Edit Value (ECP Series),Creating and using enumerations (ECP Series),
configuration Copy From, Configure Ports, Show/Hide Ports
Input(s) N/A
Output(s)
Port Type Range Description
Output Enum -128 to 127 Block output. The constant enumeration value.
256 EC-gfxProgram
Block Objects
Block properties See also Common block properties.
Property Type Range Default Description
Number Menu 1 to 31 Constant Use this drop-down menu to select from the
Enum 1 31 available block instances.
See
Description
NOTE: When a new block instance is added
to the Programming Sheet, the
block’s number is incremented to
the next available block number
according to the current Auto Incre-
ment setting. See Auto Increment
(ECP & ECL Series and ECB Series
Controllers only).
Value Enum -128 to 127 0 Value of the block.
Constant Numeric (ECP Series)
Description Mainly used for adjustable setpoint values or for constant values requiring
monitoring. These blocks are available in four structured configuration proper-
ties and implemented as NCIs as follows.
Structured configuration propertiesNCIs
UCPT_constant_num_1to7nciCn1_7
UCPT_constant_num_8to14nciCn8_14
UCPT_constant_num_15to21nciCn15_21
UCPT_constant_num_22to28nciCn22_28
The user can read or write the values of the Constant Numeric blocks 1 to 7,
8 to 14, 15 to 21, and 22 to 28 directly through these configuration properties.
WARNING: Values stored in Constant Numeric blocks are always persistent.
Never write to this constant’s Network Configuration Input (NCI)
from the network with an automated process (Polling). Continu-
ous writing to this constant’s NCI could exhaust the ability of the
controller’s EEPROM to store the value in its permanent memory.
Should this happen, controller failure will result.
Number of 28
blocks
EC-gfxProgram 257
Advanced Edit Value (ECP Series), Copy From, Configure Ports, Show/Hide Ports
configuration
Input(s) N/A
Output(s)
Port Type Range Description
Output Numeric -83886.08 to Block output. The constant value.
+83886.07
Block properties See also Common block properties.
Property Type Range Default Description
Number Menu 1 to 28 Constant Use this drop-down menu to select from
Numeric 1 the 28 available block instances.
See
Description
NOTE: When a new block instance is
added to the programming sheet,
the block’s number is incre-
mented to the next available
block number according to the
current Auto Increment setting.
See Auto increment (ECP & ECL
Series and EBC Series control-
lers only).
Value Numeric -83886.08 to 0 Value of the block.
+83886.07
Variable Enum (ECP Series)
Description Mainly used for variable values requiring monitoring. They can be formatted to
any standard enumeration or to Boolean values (True or False). These blocks
are available in a structured Network Variable Output (NVO). nvoVe1_27 con-
tains the values and modes of Variable Enum blocks 1 to 27. The user can
read the values and modes of the Variable Enum blocks directly through this
NVO. nviModify can be used to write to the values and modes of the blocks by
specifying the internal value type (Enum Variable), the index (Block Number),
the mode (Automatic or Manual) and the value (-128 to 127).
258 EC-gfxProgram
Block Objects
Number of 27
blocks
Advanced Edit Mode and Value (ECP Series), Creating and using enumerations (ECP
configuration Series), Copy From, Configure Ports, Show/Hide Ports
Input(s)
Port Type Range Description
Input Enum -128 to 127 Block input. The read value.
Output(s)
Port Type Range Description
Output Enum -128 to 127 Block output. The read (Automatic) value or set (Manual)
value.
Mode Digital 0 or 1 Mode of the input:
0 = Automatic
1 = Manual
Block properties See also Common block properties.
Property Type Range Default Description
Number Menu 1 to 27 Variable Use this drop-down menu to select from the
Enum 1 27 available block instances.
See
Description
NOTE: When a new block instance is added
to the programming sheet, the
block’s number is incremented to
the next available block number
according to the current Auto Incre-
ment setting. See Auto increment
(ECP & ECL Series and EBC Series
controllers only).
Persist Menu See False When this option is True, the output and
Description mode is preserved during any type of reset.
EC-gfxProgram 259
Variable Numeric (ECP Series)
Description Mainly used for variable values requiring monitoring. These blocks are avail-
able in 5 structured NVOs as follows.
Contains the values and modes of Variable
NVOs
Numeric blocks
nvoVn1_7 1 to 7
nvoVn8_14 8 to 14
nvoVn15_21 15 to 21
nvoVn22_28 22 to 28
nvoVn29_35 29 to 35
The user can read the values and modes of the Variable Numeric blocks
directly through these NVOs. nviModify can be used to write to the values and
modes of the blocks by specifying the internal value type (NUM_VARIABLE),
the index (Block Number), the mode (Automatic or Manual) and the value (-
83886.08 to 83886.07)(±3.4028×1038).
The block can be set to be controller specific to allow the option of not over-
writing the value during code synchronization (see Project Synchronization).
This is useful to avoid overwriting VAV box balancing values when sending
updated code to two or more controllers.
Number of 35
blocks
Advanced Edit Mode and Value (ECP Series), Copy From, Configure Ports, Show/Hide
configuration Ports
Input(s)
Port Type Range Description
Input Numeric -83886.08 to Block input. The read value.
+83886.07
260 EC-gfxProgram
Block Objects
Output(s)
Port Type Range Description
Output Numeric -83886.08 to Block output. The read (Automatic) value or set (Manual)
+83886.07 value.
Mode Digital 0 or 1 Mode of the input:
0 = Automatic
1 = Manual
Block properties See also Common block properties.
Property Type Range Default Description
Number Menu 1 to 35 Variable Use this drop-down menu to select from the
Numeric 1 35 available block instances.
See
Description
NOTE: When a new block instance is added
to the programming sheet, the
block’s number is incremented to
the next available block number
according to the current Auto Incre-
ment setting. See Auto increment
(ECP & ECL Series and EBC Series
controllers only).
Persist Menu See False When this option is True, the output and
Description mode is preserved during any type of reset.
EC-gfxProgram 261
ECL Series specific constant and variable blocks
Constants are blocks that are mostly used to configure set values (setpoints,
delays, limits, etc.) that may need to be made available to an HMI. Variables
are blocks that are mostly used to monitor changing values or calculate new
values using old ones that may need to be made available to an HMI.
Values and Values and constants are stored in any one of the following data types.
constants
• A Value data type has a range of any numeric number between
±3.4028×1038. This data type can be used for several purposes including
creating setpoints, storing the result of a calculation, monitoring values,
etc.
• An Enum data type has a range of any integer value from -128 to 127.
They are often used to correspond to various equipment modes (HVAC,
fan, occupancy, etc.).
• A Boolean data type represents two-states: “True” with a value of 1 and
“False” with a value of 0.
Initial value A constant sets the initial value for a process or setpoint. A value can be mod-
ified during debugging and is exposed to the network.
The following blocks are available in this category.
Blocks To set the Initial Value, See
Boolean Constant (ECL Series) Resources Configuration
Enum Constant (ECL Series)
Numeric Constant (ECL Series)
Setpoint Constant (ECL Series) Advanced configuration
Boolean Value (ECL Series) Network Properties Configuration
window (ECL, ECB & ECY Series)
Enum Value (ECL Series)
Numeric Value (ECL Series)
These blocks can be set to be controller specific to allow the option of not
overwriting the value during project code synchronization (see Project Syn-
chronization). This is useful to avoid overwriting values when sending
updated project code to two or more controllers.
Example Values and Constants are blocks that are used to set and monitor values.
These values are either used for internal calculation only or they can be
exposed to the network. The example below shows how a Supply Air Tem-
perature Setpoint (Numeric Value block) is calculated based on the Outdoor
Air Temperature (Hardware Input block) being interpolated linearly (Linear
block) and limited (Limit block) by a Maximum and Minimum Supply Air Tem-
262 EC-gfxProgram
Block Objects
perature (Numeric Value blocks) and a maximum and minimum outdoor air
temperature (Internal constant block).
Figure 186: Constants and variables example
The Internal Constant blocks set the outdoor air temperature limits, which
are not required to change. The Numeric Value blocks set the supply air tem-
perature min and max values, which can be changed through an HMI over the
network. The Linear block then creates a linear interpolation based on these
min and max values and the Limit block sets the values received from the
Numeric Value blocks as outdoor air temperature limits. The Hardware Input
block sends the value of the Outdoor Air Temperature and the Supply Air
Temperature Setpoint is calculated and outputted by the Limit block to the
Numeric Value block where it can be monitored by an HMI over the network.
Boolean Constant (ECL Series)
Description Used for True or False constant values. They can be formatted to a Boolean
value (True or False). These blocks are available in one structured configura-
tion property (UCPT_constant_bool_1to124)implemented as an NCI
(nciCb01_124). The user can read or write the values of the Boolean Con-
stant blocks 1 to 124 directly through this configuration property.
Configuration parameters for this block are set in the Resources Configura-
tion window. This sets the Initial Value for this block according to the format
that has been applied to the block when the controller is Online. Values writ-
ten at the Input ports will overwrite the value set in this window (the current
value can be viewed in the Constants tab, Present Value column of the
Resource Viewer). The following value ranges are valid: True / False.
Slim format This block can be collapsed into a slim format. See Collapsed in Common
support block properties.
Number of The number of Boolean Constant block instances supported by a controller is
blocks shown in the Number drop-down list in the Properties or Statistics panes.
EC-gfxProgram 263
Persistence The current value is persistent; this allows a value to be saved during a con-
troller power cycle or reset. See Persistent values (ECL, ECB & ECY Series
controllers).
Advanced Resources Configuration, Set Constant (ECL Series), Find All References
configuration (ECL, ECB & ECY Series), Copy From, Configure Ports, Show/Hide Ports
Related blocks Generic Boolean Constant (ECL Series)
Input(s)
Port Type Range Description
Input Digital 0 or 1 Block input. The value to write.
Output(s)
Port Type Range Description
Output Digital 0 or 1 Block output. The Boolean constant value.
Number Integer 1 to 124 The current block number.
Block proterties See also Common block properties.
Property Type Range Default Description
Number Menu See Boolean Use this drop-down menu to select an instance
Descripti Constant 1 of this block. See Number of blocks for the
on number of block instances supported by the
current controller model.
NOTE: When a new block instance is added to
the programming sheet, the block’s
number is incremented to the next avail-
able block number according to the cur-
rent Auto Increment setting. See Auto
increment (ECP & ECL Series and EBC
Series controllers only).
264 EC-gfxProgram
Block Objects
Boolean Value (ECL Series)
Description Used for True or False constant values. Mainly used for variable values
requiring monitoring. These blocks are available in one structured Network
Variable Output (nvoVb1_124) as follows. The user can read and write to the
values of the Boolean Value blocks 1 to 124 directly through this NVO. nvi-
Modify can be used to write to the values and modes of the blocks by specify-
ing the internal value type (BOOL_VARIABLE), the index (Block Number), the
mode (Automatic or Manual), and the value (True or False).
The block can be set to be controller specific to allow the option of not over-
writing the value during project code synchronization (see Project Synchroni-
zation). This is useful to avoid overwriting values when sending updated
project code to two or more controllers.
Slim format This block can be collapsed into a slim format. See Collapsed in Common
support block properties.
Number of The number of Boolean Value block instances supported by a controller is
blocks shown in the Number drop-down list in the Properties or Statistics panes.
Persistence The current value is persistent; this allows a value to be saved during a con-
troller power cycle or reset. See Persistent values (ECL, ECB & ECY Series
controllers).
Advanced Resources Configuration, Network Properties Configuration window (ECL,
configuration ECB & ECY Series), Override and auto, Set Value, Find All References (ECL,
ECB & ECY Series), Copy From, Configure Ports, Show/Hide Ports
Related blocks Generic Boolean Value (ECL Series)
Input(s)
Port Type Range Description
Input Digital 0 or 1 Block input. The value to write.
EC-gfxProgram 265
Output(s)
Port Type Range Description
Output Digital 0 or 1 Block output. The actual value read (Automatic) or set
value (Manual).
Number Integer 1 to 124 The current block number.
OutOfService Digital 0 or 1 See Out-of-Service.
Update Digital 0 or 1 Outputs a pulse when a value is written to the block.
NOTE: If more than one instance of this block is used in
your project code with the same block number,
only expose one Update port among all the
instances of this block with the same block num-
ber.
It is recommended to use a Reference Hub to
propagate the Update pulse throughout your
project code if necessary.
Block properties See also Common block properties.
Property Type Range Default Description
Number Menu See Boolean Use this drop-down menu to select an
Descripti Value 1 instance of this block. See Number of
on blocks for the number of block instances
supported by the current controller model.
NOTE: When a new block instance is
added to the programming sheet,
the block’s number is incremented
to the next available block number
according to the current Auto
Increment setting. See Auto incre-
ment (ECP & ECL Series and
EBC Series controllers only).
266 EC-gfxProgram
Block Objects
Enum Constant (ECL Series)
Description Used for enumeration constant values. They can be formatted to any stan-
dard enumeration. These blocks are available in two structured configuration
properties and implemented as NCIs as follows.
Structured configuration
NCIs
properties
UCPT_constant_enum_1to31 nciCe01_31
UCPT_constant_enum_32to62 nciCe32_62
The user can read or write the values of the Enum Constant blocks 1 to 31
and 32 to 62 directly through this configuration property.
Configuration parameters for this block are set in the Resources Configura-
tion window. This sets the Initial Value for this block according to the format
that has been applied to the block when the controller is Online. Values writ-
ten at the Input ports will overwrite the value set in this window (the current
value can be viewed in the Constants tab, Present Value column of the
Resource Viewer). The following value ranges are valid: Any integer value
between -128 and 127.
Slim format This block can be collapsed into a slim format. See Collapsed in Common
support block properties.
Number of The number of Enum Constant block instances supported by a controller is
blocks shown in the Number drop-down list in the Properties or Statistics panes.
Persistence The current value is persistent; this allows a value to be saved during a con-
troller power cycle or reset. See Persistent values (ECL, ECB & ECY Series
controllers).
Advanced Resources Configuration, Creating and using enumerations (ECL Series),
configuration Enumeration Picker (ECP & ECL Series), Set Constant (ECL Series), Find All
References (ECL, ECB & ECY Series), Copy From, Configure Ports, Show/
Hide Ports
Related blocks Generic Enum Constant (ECL Series)
EC-gfxProgram 267
Input(s)
Port Type Range Description
Input Enum -128 to 127 Block input. The value to write.
Output(s)
Port Type Range Description
Output Enum -128 to 127 Block output. The enumeration constant value.
Number Integer 1 to 62 The current block number.
Block properties See also Common block properties.
Property Type Range Default Description
Number Menu See Enum Use this drop-down menu to select an
Description Constant 1 instance of this block. See Number of
Blocks for the number of block instances
supported by the current controller model.
NOTE: When a new block instance is added
to the programming sheet, the
block’s number is incremented to
the next available block number
according to the current Auto Incre-
ment setting. See Auto increment
(ECP & ECL Series and EBC Series
controllers only).
268 EC-gfxProgram
Block Objects
Enum Value (ECL Series)
Description Used for enumeration values. Mainly used for variable values requiring moni-
toring. These blocks are available in two structured Network Variable Outputs
(NVOs) as follows.
NVOs Contains the values and modes of Enum Value blocks
nvoVe1_27 1 to 27
nvoVe28_54 28 to 54
The user can read and write to the values of the Enum Value blocks directly
through this NVO. nviModify can be used to write to the values and modes of
the blocks by specifying the internal value type (Enum Variable), the index
(Block Number), the mode (Automatic or Manual), and the value (-128 to
127).
The block can be set to be controller specific to allow the option of not over-
writing the value during project code synchronization (see Project Synchroni-
zation). This is useful to avoid overwriting VAV box balancing values when
sending updated project code to two or more controllers.
Slim format This block can be collapsed into a slim format. See Collapsed in Common
support block properties.
Number of The number of Enum Value block instances supported by a controller is
blocks shown in the Number drop-down list in the Properties or Statistics panes.
Persistence The current value is persistent; this allows a value to be saved during a con-
troller power cycle or reset. See also Persistent values (ECL, ECB & ECY
Series controllers).
Advanced Resources Configuration, Creating and using enumerations (ECL Series),
configuration Enumeration Picker (ECP & ECL Series), Network Properties Configuration
window (ECL, ECB & ECY Series), Override and auto, Set Value, Find All
References (ECL, ECB & ECY Series), Copy From, Configure Ports, Show/
Hide Ports
Related blocks Generic Enum Value (ECL Series)
EC-gfxProgram 269
Input(s)
Port Type Range Description
Input Enum -128 to 127 Block input. The value to write.
Output(s)
Port Type Range Description
Output Enum -128 to 127 Block output. The read (Automatic) value or set
(Manual) value.
Number Integer 1 to 54 The current block number.
OutOfService Digital 0 or 1 See Out-of-Service.
Update Digital 0 or 1 Outputs a pulse when a value is written to the block.
NOTE: If more than one instance of this block is used
in your project code with the same block num-
ber, only expose one Update port among all
the instances of this block with the same block
number.
It is recommended to use a Reference Hub to
propagate the Update pulse throughout your
project code if necessary.
Block properties See also Common block properties.
Property Type Range Default Description
Number Menu See Enum Use this drop-down menu to select an
Description Value 1 instance of this block. See Number of
blocks for the number of block instances
supported by the current controller
model.
NOTE: When a new block instance is
added to the programming
sheet, the block’s number is
incremented to the next avail-
able block number according to
the current Auto Increment set-
ting. See Auto increment (ECP
& ECL Series and EBC Series
controllers only).
270 EC-gfxProgram
Block Objects
Numeric Constant (ECL Series)
Description Used for numeric constant values. These blocks are available in eight struc-
tured configuration properties and implemented as NCIs as follows.
Structured configuration properties NCIs
UCPT_constant_numf_1to7 nciCn01_07
UCPT_constant_numf_8to14 nciCn08_14
UCPT_constant_numf_15to21 nciCn15_21
UCPT_constant_numf_22to28 nciCn22_28
UCPT_constant_numf_29to35 nciCn29_35
UCPT_constant_numf_36to42 nciCn36_42
UCPT_constant_numf_43to49 nciCn43_49
UCPT_constant_numf_50to56 nciCn50_56
The user can read or write the values of the Numeric Constant blocks 1 to 7, 8
to 14, 15 to 21, 22 to 28, 29 to 35, 36 to 42, 43 to 49, and 50 to 56 directly
through this configuration property.
Configuration parameters for this block are set in the Resources Configura-
tion window. This sets the Initial Value for this block according to the format
that has been applied to the block when the controller is Online. Values writ-
ten at the Input ports will overwrite the value set in this window (the current
value can be viewed in the Constants tab, Present Value column of the
Resource Viewer). The following value ranges are valid: Any decimal value
between ±3.4028×1038.
Slim format This block can be collapsed into a slim format. See Collapsed in Common
support block properties.
Number of The number of Numeric Constant block instances supported by a controller is
blocks shown in the Number drop-down list in the Properties or Statistics panes.
Persistence The current value is persistent; this allows a value to be saved during a con-
troller power cycle or reset. See also Persistent values (ECL, ECB & ECY
Series controllers).
Advanced Resources Configuration, Set Constant (ECL Series), Find All References
configuration (ECL, ECB & ECY Series), Copy From, Configure Ports, Show/Hide Ports
EC-gfxProgram 271
Related blocks Generic Numeric Constant (ECL Series)
Input(s)
Port Type Range Description
Input Numeric ±3.4028×1038 Block input.
Output(s)
Port Type Range Description
Output Numeric ±3.4028×1038 Block output. The constant value.
Number Integer 1 to 56 The current block number.
Block properties See also Common block properties.
Property Type Range Default Description
Number Menu See Numeric Use this drop-down menu to select an
Description Constant 1 instance of this block. See Number of
blocks for the number of block
instances supported by the current
controller model.
NOTE: When a new block instance is
added to the programming
sheet, the block’s number is
incremented to the next avail-
able block number according
to the current Auto Increment
setting. See Auto increment
(ECP & ECL Series and EBC
Series controllers only).
272 EC-gfxProgram
Block Objects
Numeric Value (ECL Series)
Description Mainly used for variable values requiring monitoring. These blocks are avail-
able in eight structured NVOs as follows.
Contains the values and modes of Numeric Value
NVOs
blocks
nvoVn1_7 1 to 7
nvoVn8_14 8 to 14
nvoVn15_21 15 to 21
nvoVn22_28 22 to 28
nvoVn29_35 29 to 35
nvoVn36_42 36 to 42
nvoVn43_49 43 to 49
nvoVn50_56 50 to 56
The user can read the values and modes of the Numeric Value blocks directly
through these NVOs. nviModify can be used to write to the values and modes
of the blocks by specifying the internal value type (NUM_VARIABLE), the
index (Block Number), the mode (Automatic or Manual) and the value
(±3.4028×1038).
The block can be set to be controller specific to allow the option of not over-
writing the value during project code synchronization (see Project Synchroni-
zation). This is useful to avoid overwriting VAV box balancing values when
sending updated project code to two or more controllers.
Slim format This block can be collapsed into a slim format. See Collapsed in Common
support block properties.
Number of The number of Numeric Value block instances supported by a controller is
blocks shown in the Number drop-down list in the Properties or Statistics panes.
Persistence The current value is persistent; this allows a value to be saved during a con-
troller power cycle or reset. See Persistent values (ECL, ECB & ECY Series
controllers).
EC-gfxProgram 273
Advanced Resources Configuration, Network Properties Configuration window (ECL,
configuration ECB & ECY Series), Override and auto, Set Value, Find All References (ECL,
ECB & ECY Series), Copy From, Configure Ports, Show/Hide Ports
Related blocks Generic Numeric Value (ECL Series)
Input(s)
Port Type Range Description
Input Numeric ±3.4028×1038 Block input.
Output(s)
Port Type Range Description
Output Numeric ±3.4028×1038 Block output. The read (Automatic) value or set
(Manual) value.
Number Integer 1 to 56 The current block number.
OutOfService Digital 0 or 1 See Out-of-Service.
Update Digital 0 or 1 Outputs a pulse when a value is written to the
block.
NOTE: If more than one instance of this block is
used in your project code with the same
block number, only expose one Update
port among all the instances of this block
with the same block number.
It is recommended to use a Reference
Hub to propagate the Update pulse
throughout your project code if necessary.
274 EC-gfxProgram
Block Objects
Block properties See also Common block properties.
Property Type Range Default Description
Number Menu See Numeric Use this drop-down menu to select an
Description Value 1 instance of this block. See Number of
blocks for the number of block instances
supported by the current controller model.
NOTE: When a new block instance is
added to the programming sheet,
the block’s number is incremented
to the next available block number
according to the current Auto
Increment setting. See Auto incre-
ment (ECP & ECL Series and
EBC Series controllers only).
Setpoint Constant (ECL Series)
Description Used to set the initial values of multiple heating and cooling setpoints. These
blocks are available in one structured configuration property (SCPTsetPnts)
implemented as an nci (nciSetPoint). The user can read or write the values of
the Setpoint constant block directly through this configuration property.
The block can be set to be controller specific to allow the option of not over-
writing the value during project code synchronization (see Project Synchroni-
zation). This is useful to avoid overwriting setpoint values when sending
updated project code to two or more controllers.
Slim format This block can be collapsed into a slim format. See Collapsed in Common
support block properties.
Number of 1
blocks
Advanced Resources Configuration, Edit Value (ECP Series), Set Constant (ECL
configuration Series), Advanced configuration, SCPTsetPnts Value, Find All References
(ECL, ECB & ECY Series), Copy From, Configure Ports, Show/Hide Ports,
Creating and using enumerations (ECL Series)
EC-gfxProgram 275
Input(s)
Port Type Range Description
Occupied Cool Numeric -273.17 to 327.67ºC The Occupied Cool setpoint input.
-459.7 to 621.8ºF
StandbyCool Numeric -273.17 to 327.67ºC The Standby Cool setpoint input.
-459.7 to 621.8ºF
Unoccupied Numeric -273.17 to 327.67ºC- The Unoccupied Cool setpoint input.
Cool 459.7 to 621.8ºF
Occupied Heat Numeric -273.17 to 327.67ºC The Occupied Heat setpoint input.
-459.7 to 621.8ºF
StandbyHeat Numeric -273.17 to 327.67ºC The Standby Heat setpoint input.
-459.7 to 621.8ºF
Unoccupied Numeric -273.17 to 327.67ºC The Unoccupied Heat setpoint input.
Heat -459.7 to 621.8ºF
Output(s)
Port Type Range Description
Occupied Cool Numeric -273.17 to 327.67ºC The Occupied Cool setpoint output.
-459.7 to 621.8ºF
StandbyCool Numeric -273.17 to 327.67ºC The Standby Cool setpoint output.
-459.7 to 621.8ºF
Unoccupied Numeric -273.17 to 327.67ºC The Unoccupied Cool setpoint output.
Cool -459.7 to 621.8ºF
Occupied Heat Numeric -273.17 to 327.67ºC The Occupied Heat setpoint output.
-459.7 to 621.8ºF
StandbyHeat Numeric -273.17 to 327.67ºC The Standby Heat setpoint output.
-459.7 to 621.8ºF
Unoccupied Numeric -273.17 to 327.67ºC The Unoccupied Heat setpoint output.
Heat -459.7 to 621.8ºF
Block properties See also Common block properties.
276 EC-gfxProgram
Block Objects
Advanced Configuration parameters for this block are set in the Resources Configura-
configuration tion window where the initial value of multiple heating and cooling setpoints.
Values written at the Input ports will overwrite the corresponding value set in
this window.
Figure 187: Setpoint Constant configuration window
Parameter Description
Occupied Cool Set the initial Occupied Cool setpoint output.
Standby Cool Set the initial Standby Cool setpoint output.
Unoccupied Cool Set the initial Unoccupied Cool setpoint output.
Occupied Heat Set the initial Occupied Heat setpoint output.
Standby Heat Set the initial Standby Heat setpoint output.
Unoccupied Heat Set the initial Unoccupied Heat setpoint output.
SCPTsetPnts Set the value according to the format that has been applied to the block.
Value
Figure 188: Setpoint Constant configuration window
Parameter Description
occupied_cool Set the value for Occupied Cool setpoint output.
EC-gfxProgram 277
Parameter Description
standby_cool Set the value for Standby Cool setpoint output.
unoccupied_cool Set the value for Unoccupied Cool setpoint output.
occupied_heat Set the value for Occupied Heat setpoint output.
standby_heat Set the value for Standby Heat setpoint output.
unoccupied_heat Set the value for Unoccupied Heat setpoint output.
278 EC-gfxProgram
Block Objects
ECB & ECY Series specific blocks
Values are blocks that are mostly used to monitor changing values or calcu-
late new values using old ones that may need to be made available to an HMI.
Values
Values are stored in any one of the following data types.
• An Analog Value data type has a range of any numeric number between
±3.4028×1038. This data type can be used for several purposes including
creating setpoints, storing the result of a calculation, monitoring values,
etc.
• A Multi-State Value data type has a range of any integer value from 1 to
255. They are often used to correspond to various equipment modes
(HVAC, fan, occupancy, etc.).
• Binary Value data type represents two-states: “Active” with a value of 1
and “Inactive” with a value of 0.
Commandable and non-commandable values (ECB
& ECY Series controllers)
Commandable The main difference between commandable and non-commandable Value
value types is that Commandable Values use the BACnet Commandable object pri-
ority array levels mechanism, while the non-commandable Values do not use
this mechanism.
Commandable For ECB Series controllers only: certain instances of Values blocks are com-
values (ECB mandable. The main interest in using a Commandable value is it allows the
Series Present Value to be overridden. Typically, a setpoint value is not manually
controllers) overridden but simply replaced with a new value that has a higher priority.
However, the result of a calculation such as the cooling load may need to be
manually overridden for test purposes or to provide additional cooling.
NOTE: In EC-Net, do not use priority level inputs 1 to 16 on proxy points
mapped on non-commandable objects as non-commandable objects
do not support this concept, which may produce unexpected results.
For more information, see Non-commandable and commandable objects for
standard BACnet objects and Commandable object priority array levels.
There are two sub-types of each Values block that are available: Command-
able and Non-commandable Values. Both types of Values can be used for any
application such as storing a setpoint value or the result of a calculation such
as totaling the cooling load. In the Toolbox, the same object can represent
either a Commandable or Non-commandable Values. See Non-commandable
and commandable objects for standard BACnet objects. Once an Analog
Value (ECB & ECY Series) block, Multi State Value (ECB & ECY Series)
EC-gfxProgram 279
block, or Binary Value (ECB & ECY Series) block has been dropped on the
Programming Sheet, you select the instance number of the block, by which
you also choose to make the block instance Commandable or not. The num-
ber of block instances supported by the connected controller is shown during
block instance selection or in the Statistics pane.
Figure 189: Setting the block number (in the block‘s properties pane) selects whether
the block instance is commandable or not (ECB Series controllers)
Commandable For ECY Series controllers only: all instances of Values blocks are command-
values (ECY able. Commandable values allow the Present Value to be overridden. Typi-
Series cally, a setpoint value is not manually overridden but simply replaced with a
controllers) new value that has a higher priority. However, the result of a calculation such
as the cooling load may need to be manually overridden for test purposes or
to provide additional cooling.
A set made in EC-Net to a controller’s value will be written at priority16. By
setting the Persist value 16 in the Resources Configuration, the object value
at priority level 16 is saved by the controller during any type of controller reset
or power cycling. See Persistent values (ECL, ECB & ECY Series controllers).
For more information, see Non-commandable and commandable objects for
standard BACnet objects and Commandable object priority array levels.
Constants and variables supported by ECB & ECY
Series controllers
The following blocks are available in this category:
• Analog Value (ECB & ECY Series)
• Binary Value (ECB & ECY Series)
• Multi State Value (ECB & ECY Series)
280 EC-gfxProgram
Block Objects
Example Constants and Variables are blocks that are used to set and monitor values.
These values are either used for internal calculation only or they can be
exposed to the network. The example below shows how a Supply Air Tem-
perature Setpoint (Analog Value block) is calculated based on the Outdoor
Air Temperature (Hardware Input block) being interpolated linearly (Linear
block) and limited (Limit block) by a Maximum and Minimum Supply Air Tem-
perature (Analog Value blocks) and a maximum and minimum outdoor air
temperature (Internal constant block).
Figure 190: Constants and variables examples
The Internal Constant blocks set the outdoor air temperature limits, which
are not required to change. The Analog Value blocks set the supply air tem-
perature min and max values, which can be changed through an HMI over the
network. The Linear block then creates a linear interpolation based on these
min and max values and the Limit block sets the values received from the
Analog Value blocks as outdoor air temperature limits. The Hardware Input
block sends the value of the Outdoor Air Temperature and the Supply Air
Temperature Setpoint is calculated and outputted by the Limit block to the
Analog Value block where it can be monitored by an HMI over the network.
Analog Value (ECB & ECY Series)
Description Used for either non-commandable constants (used for adjustable setpoint val-
ues for example) or commandable variables that support command priorities
(used for automatic control with manual override for example).
When the block is used as a non-commandable constant, it can be set to be
controller specific to allow the option of not overwriting the value during proj-
ect code synchronization (see Project Synchronization). This is useful to
avoid overwriting VAV box balancing values when sending updated project
code to two or more controllers.
A unit can be assigned to the value in BACnet network properties. These
blocks are network read/writable as BACnet objects.
EC-gfxProgram 281
Alarms (ECB & ECY Series) are available with B-AAC and B-BC controller
models only (see the controller’s datasheet for more information) and for ECB
Series controllers, commandable value instances of this block only (see Com-
mandable value).
Slim format This block can be collapsed into a slim format. See Collapsed in Common
support block properties.
Number of For ECB Series controllers: The number of Analog Value block instances sup-
blocks ported by a controller is shown in the Number drop-down list in the Properties
or Statistics panes. When selecting a block instance, it is possible to see
which Values are Commandable and which are not.
Figure 191: Commandable value for ECB Series controllers
Commandable instances of this block have the Commandable? field shown
as True. Non-commandable instances of this block have the Commandable?
field shown as False. See Commandable and non-commandable values
(ECB & ECY Series controllers).
For ECY Series controllers: see Supported number of BACnet objects with an
ECY Series controller.
Persistence Allows a value to be saved during a controller power cycle or reset. See Per-
sistent values (ECL, ECB & ECY Series controllers).
Advanced Network Properties Configuration window (ECL, ECB & ECY Series),
configuration Resources Configuration, BACnet network properties, Alarms (ECB & ECY
Series), Emergency override and emergency auto (ECB & ECY Series),
Override and auto, Set Value, Find All References (ECL, ECB & ECY Series),
Copy From, Configure Ports, Show/Hide Ports
Related blocks Generic Analog Value (ECB & ECY Series)
282 EC-gfxProgram
Block Objects
Input(s)
Port Type Range Description
Input Numeric ±3.4028×1038 Block input. The value to write.
Priority Integer 1 to 16 For a Commandable Value only, the value at the
Input is written at the priority level specified at
this input. If a value is not linked to this input, the
value at the Input is written into the default
priority level. See Commandable object priority
array levels.
TriggerTrend Digital 0 or 1 When Trend Logs are enabled for this object
Log and the Logging Type is set to Triggered, a
pulse at this input forces the present value to be
recorded in the object’s trend log. See Trending
(ECY Series).
Alarm Setpoint Numeric ±3.4028×1038 When alarms are enabled for this block (see
(B-AAC and B- Alarms (ECB & ECY Series)), a positive input
BC controllers value increases the alarm setpoint values set in
only) the Resources Configuration’s Alarms
configuration for the block (a negative value
reduces the alarm setpoint values): The High
limit is now the High limit value (set in the
Resources Configuration’s Alarms configuration
for the block) plus AlarmSetpoint and the Low
limit is now the Low limit value (set in the
Resources Configuration’s Alarms configuration
for the block) plus AlarmSetpoint. See
Dynamic alarm activation thresholds adjust.
NOTE: When the AlarmSetpoint input is dis-
connected, you must reset the controller
(see Project Synchronization) or connect
a Null value (ECL, ECB & ECY Series)
block to this port so the controller will
release this port as being unconnected.
When the AlarmSetpoint input is dis-
connected, the High limit and Low limit
can be written to through the BACnet
interface.
AlarmInhibit Digital 0 or 1 While set to True(1), no alarms will be reported
by the block. See AlarmInhibit input (ECY Series
controllers).
EC-gfxProgram 283
Output(s)
Port Type Range Description
Output Numeri ±3.4028×1038 Block output. The Present Value.
c
Number Integer – The current block number.
OutOfService Digital 0 or 1 See Out-of-Service.
Priority Integer 1 to 16 The current active priority for commandable
objects. See Commandable object priority array
levels.
Update Digital 0 or 1 Outputs a pulse when a value is written to the
block, even if the value has not changed.
If any instance of the resource has its Input port
linked, the Update port will remain TRUE since
the resource is written to on every code execution.
WARNING: The usage requires that none of the
instances of the resource have its
Input port linked, except if it is encap-
sulated in a conditional custom block.
In the case where the Resource value
(present value) is written from an
external event (user interface) or trig-
gered in a conditional custom block,
the Update port will pulse a TRUE
only when the event occurs, and will
otherwise FALSE.
NOTE: If more than one instance of this block is
used in your project code with the same
block number, only expose one Update
port among all the instances of this block
with the same block number.
It is recommended to use a Reference
Hub to propagate the Update pulse
throughout your project code if necessary.
InAlarm (B-AAC Digital 0 or 1 For commandable instances (see Commandable
and B-BC value) only: When Enable Alarms is set for this
controllers only) block and the present value is outside of the High
limit and Low limit settings and taking into
consideration the Dead band and Time delay
settings, this output is On (1). See Alarms (ECB &
ECY Series) to configure the alarm settings.
NOTE: Setting or clearing High or Low in the
Limit enable options shown above has no
effect on the activation of this output.
284 EC-gfxProgram
Block Objects
Block properties See also Common block properties.
Property Type Range Default Description
Number Menu See Analog Use this drop-down menu to select an
Description Value 1 instance of this block. See Number of
blocks for the number of block
instances supported by the current
controller model.
NOTE: When a new block instance is
added to the programming
sheet, the block’s number is
incremented to the next avail-
able block number according
to the current Auto Increment
setting. See Auto increment
(ECP & ECL Series and EBC
Series controllers only) or
Auto increment (ECY Series
controllers only).
Binary Value (ECB & ECY Series)
Description Used for either non-commandable constants (used for True or False values
for example) or commandable variables that support command priorities
(used for automatic control with manual override for example).
When the block is used as a non-commandable constant, it can be set to be
controller specific to allow the option of not overwriting the value during proj-
ect code synchronization (see Project Synchronization). This is useful to
avoid overwriting values when sending updated project code to two or more
controllers.
These blocks are network read/writable as BACnet objects.
Alarms (ECB & ECY Series) are available with B-AAC and B-BC controller
models only (see the controller’s datasheet for more information) and for ECB
Series controllers, commandable value instances of this block only (see Com-
mandable value).
For ECY Series controllers, alarms that have been configured for this block
can be suppressed by turning off the block’s alarm management so that while
EC-gfxProgram 285
this mechanism is engaged, no alarms will be reported by the block. See
AlarmInhibit input (ECY Series controllers).
Slim format This block can be collapsed into a slim format. See Collapsed in Common
support block properties.
Number of For ECB Series controllers: The number of Binary Value block instances sup-
blocks ported by a controller is shown in the Number drop-down list in the Properties
pane (see Commandable value) or in the Statistics pane. When selecting a
block instance, it is possible to see which Values are Commandable and
which are not.
Figure 192: Commandable value
Commandable instances of this block have the Commandable? field shown
as True. Non-commandable instances of this block have the Commandable?
field shown as False. See Commandable and non-commandable values
(ECB & ECY Series controllers).
For ECY Series controllers: see Supported number of BACnet objects with an
ECY Series controller.
Persistence Allows a value to be saved during a controller power cycle or reset. See Per-
sistent values (ECL, ECB & ECY Series controllers).
Advanced Resources Configuration, Network Properties Configuration window (ECL,
configuration ECB & ECY Series), Alarms (ECB & ECY Series), Emergency override and
emergency auto (ECB & ECY Series), Override and auto, Set Value, Find All
References (ECL, ECB & ECY Series), Copy From, Configure Ports, Show/
Hide Ports
Related blocks Generic Binary Value (ECB & ECY Series)
Input(s)
Port Type Range Description
Input Digital 0 or 1 Block input. The value to write.
286 EC-gfxProgram
Block Objects
Port Type Range Description
Priority Integer 1 to 16 For a Commandable Value only, the value at the Input is
written at the priority level specified at this input. If a value
is not linked to this input, the value at the Input is written
into the default priority level. See Commandable object
priority array levels.
AlarmValue Digital 0 or 1 When alarms are enabled for this block (see Alarms (ECB
(B-AAC & B- & ECY Series)), this input overrides the alarm value set in
BC the Resources Configuration’s Alarms configuration for
controllers the block.
only)
NOTE: When the AlarmValue input is disconnected, you
must reset the controller (see Project Synchroniza-
tion) or connect a Null value (ECL, ECB & ECY
Series) block to this port so the controller will
release this port as being unconnected.
When the AlarmValue input is disconnected, the
alarm value property can be overwritten through
the BACnet interface.
Trigger Digital 0 or 1 When Broadcast Mode in the Resources Configuration
Broadcast for this block is set to Local or Global, this port becomes
(ECY Series available. A pulse at this input triggers a broadcast of the
controllers object’s present value on the local network or global
only) networks. See Broadcast mode.
TriggerTrend Digital 0 or 1 When Trend Logs are enabled for this object and the
Log Logging Type is set to Triggered, a pulse at this input
forces the present value to be recorded in the object’s
trend log. See Trending (ECY Series).
ResetElapse Digital 0 or 1 A pulse at this input resets the timer for the
dActiveTime ElapsedActiveTime output (see below).
ResetChang Digital 0 or 1 A pulse at this input resets the counter for the
eOfStateCou ChangeOfStateCount output (see below).
nt
AlarmInhibit Digital 0 or 1 While set to True(1), no alarms will be reported by the
block. See AlarmInhibit input (ECY Series controllers).
Output(s)
Port Type Range Description
Output Digital 0 or 1 Block output. The Present Value.
Number Integer – The current block number.
OutOfService Digital 0 or 1 See Out-of-Service.
Priority Integer 1 to 16 The current active priority for commandable objects.
See Commandable object priority array levels.
EC-gfxProgram 287
Port Type Range Description
Update Digital 0 or 1 Outputs a pulse when a value is written to the BACnet
object.
InAlarm (B- Digital 0 or 1 For commandable instances (see Commandable
AAC and B- value) only: When Enable Alarms is set for this block
BC and the block is in an alarm state, this output is On (1).
controllers See Alarms (ECB & ECY Series) to configure the
only) alarm settings.
Elapsed Numeric 3.4028×1038 Cumulates the time this value is set to true (1).
ActiveTime
(ECY Series
controllers
only)
ChangeOf Numeric 3.4028×1038 Cumulates the number of this value’s state changes.
StateCount
(ECY Series
controllers
only)
Block properties See also Common block properties.
Property Type Range Default Description
Number Menu See Binary Use this drop-down menu to select an instance
Description Value 1 of this block. See Number of blocks for the
number of block instances supported by the
current controller model.
NOTE: When a new block instance is added to
the programming sheet, the block’s
number is incremented to the next avail-
able block number according to the cur-
rent Auto Increment setting. See Auto
increment (ECP & ECL Series and EBC
Series controllers only) or Auto incre-
ment (ECY Series controllers only).
Value Digital 0 or 1 0 Value of the block.
288 EC-gfxProgram
Block Objects
Multi State Value (ECB & ECY Series)
Description Used for either non-commandable enumerations or commandable enumera-
tions that support command priorities (used for automatic control with manual
override for example).
When the block is used as a non-commandable enumeration, it can be set to
be controller specific to allow the option of not overwriting the value during
project code synchronization (see Project Synchronization). This is useful to
avoid overwriting values when sending updated project code to two or more
controllers.
These blocks are network read/writable as BACnet objects. They can be for-
matted to any standard enumeration or to Boolean values (True or False). For
more information about the enumeration to use with this block, see Creating
and using enumerations (8-Bit).
Alarms (ECB & ECY Series) are available with B-AAC and B-BC controller
models only (see the controller’s datasheet for more information) and for ECB
Series controllers, commandable value instances of this block only (see Com-
mandable value).
For ECY Series controllers, alarms that have been configured for this block
can be suppressed by turning off the block’s alarm management so that while
this mechanism is engaged, no alarms will be reported by the block. See
AlarmInhibit input (ECY Series controllers).
Slim format This block can be collapsed into a slim format. See Collapsed in Common
support block properties.
EC-gfxProgram 289
Number of For ECB Series controllers: The number of Multi State Value block instances
blocks supported by a controller is shown in the Number drop-down list in the Prop-
erties or Statistics panes. When selecting a block instance, it is possible to
see which Values are Commandable and which are not.
Figure 193: Commandable value
Commandable instances of this block have the Commandable? field shown
as True. Non-commandable instances of this block have the Commandable?
field shown as False. See Commandable and non-commandable values
(ECB & ECY Series controllers).
For ECY Series controllers: see Supported number of BACnet objects with an
ECY Series controller.
Persistence Allows a value to be saved during a controller power cycle or reset. See Per-
sistent values (ECL, ECB & ECY Series controllers).
Advanced Resources Configuration, Creating and using enumerations (8-Bit), Network
configuration Properties Configuration window (ECL, ECB & ECY Series), Alarms (ECB &
ECY Series), Emergency override and emergency auto (ECB & ECY Series),
Override and auto, Set Value, Find All References (ECL, ECB & ECY Series),
Copy From, Configure Ports, Show/Hide Ports, Data processing
Related blocks Generic nLight Channel (ECY Series)
Input(s)
Port Type Range Description
Input Multistate 1 to 255 Block input. The value to write.
Priority Integer 1 to 16 For a Commandable Value only, the value at the Input is
written at the priority level specified at this input. If a
value is not linked to this input, the value at the Input is
written into the default priority level. See Commandable
object priority array levels.
AlarmInhibit Digital 0 or 1 While set to True(1), no alarms will be reported by the
block. See AlarmInhibit input (ECY Series controllers).
290 EC-gfxProgram
Block Objects
Output(s)
Port Type Range Description
Output Multistate 1 to 255 Block Output. The Present Value.
Number Integer – The current block number.
OutOfService Digital 0 or 1 See Out-of-Service
Priority Integer 1 to 16 The current active priority for commandable objects.
See Commandable object priority array levels.
Update Digital 0 or 1 Outputs a pulse when a value is written to the BACnet
object.
Fault (B-AAC Digital 0 or 1 When Enable Alarms is set for this block and the
and B-BC block is in an alarm state, only the InAlarm output is
controllers On (1). When the block is in a fault state, both the
only) InAlarm and Fault outputs are On (1).
InAlarm (B- Digital 0 or 1 See Alarms (ECB & ECY Series) to configure the
AAC and B- alarm settings.
BC
controllers
only)
Block properties See also Common Block Properties.
Property Type Range Default Description
Number Menu See Multi State Use this drop-down menu to select an
Description Value 1 instance of this block. See Number of
blocks for the number of block instances
supported by the current controller
model.
NOTE: When a new block instance is
added to the programming
sheet, the block’s number is
incremented to the next avail-
able block number according to
the current Auto Increment set-
ting. See Auto increment (ECP
& ECL Series and EBC Series
controllers only) or Auto incre-
ment (ECY Series controllers
only).
EC-gfxProgram 291
292 EC-gfxProgram
Custom
Custom blocks are used to simplify project code representation on a Program-
ming Sheet by creating a block that contains project code that make up a
unique sequence, function, or logic. The following blocks are available in this
category:
Custom Block Type Description /Use
Conditional Custom Block Is used for advanced programming and
allows for the execution of a part of the
sequence when the block is enabled.
Custom block Is executed in sequence with other blocks in
the code. A shortcut allows you to make a
Custom Block directly from selected code.
See Encapsulate shortcut.
For Loop (ECL, ECB & Is used to simplify project code by using a
ECY Series) For Loop block that can sequentially
process data. This block is usually used with
Generics blocks.
Loop Info (ECL, ECB & Is used with the For Loop block only.
ECY Series)
Exported Input and Are only used within the Programming
Exported Output blocks Sheet of a custom block to get data into and
out of a Conditional Custom Block, Custom
Block, or For Loop blocks. See Adding
exported inputs and exported outputs
The Conditional Custom Block, Custom Block, and For Loop blocks can
also be used to create blocks that do not already exist in the standard Toolbox
pane and they can be saved in the Code Library pane for easy reuse (see
Saving a code snippet). A Custom block can also be converted into a toolbox
with The Toolbox Builder Tool.
EC-gfxProgram 293
Creating project code in a custom document
Create project code in a Custom block, a Conditional Custom Block, or a For
Loop (ECL, ECB & ECY Series) block object as follows.
1. Add a Conditional Custom Block, a Custom Block, or a For Loop
block object to a project.
Figure 194: Dragging a custom block on the programming sheet
2. Double-click the new Custom object to go to the corresponding Program-
ming Sheet document.
A new tab for this Conditional Custom Block, Custom Block, or For Loop
(ECL, ECB & ECY Series) Block is created in the upper left corner of the
Programming Sheet.
Figure 195: Double-click the custom object
3. Add project code to the Conditional Custom Block, Custom Block, or
For Loop’s Programming Sheet document. Use Exported Input blocks
and Exported Output blocks to bring data in and out of the Programming
294 EC-gfxProgram
Sheet document to the calling block object. See Adding exported inputs
and exported outputs.
Figure 196: Content of the conditional custom block, custom block, or For loop block objects
4. To return to the calling block object, see Show in Containing Page.
Adding exported inputs and exported outputs
On the Toolbox for the Programming Sheet document that was created for a
Conditional Custom Block, Custom block, or For Loop (ECL, ECB & ECY
Series) blocks, inputs and outputs are created by:
• Adding Exported Input blocks and Exported Output blocks from the
Toolbox. Connect a graphic control sequence to these inputs and outputs
as usual. Set the name for these blocks in the Properties pane.
Figure 197: Creating exported input and output objects
• Right-clicking an object’s input or output port and select Link To in the list
and then Exported Input or Exported Output.
Figure 198: Creating an Exported Input or Exported Output block
NOTE: Exported input and output ports can be renamed and reordered in the
Conditional Custom Block, Custom Block, or For Loop blocks
through the Configure Ports window.
EC-gfxProgram 295
About exported input and output formats
Setting the format of a Conditional Custom Block, Custom block, or For Loop
(ECL, ECB & ECY Series) blocks output also applies the change to the output
that is linked to that port inside the Conditional Custom Block, Custom
Block, or For Loop block’s Programming Sheet document. Equally, setting
the format of a block that is linked to an input of a Conditional Custom
Block, Custom Block, or For Loop block changes the format at that input
and consequently the format of that input for that port inside the Conditional
Custom Block, Custom Block, or For Loop block’s Programming Sheet
document.
Making an exported input automatic, optional, or
mandatory
The following Exported Input block Properties pane can be set.
Figure 199: Setting the exported input’s properties
The ConnectionType property controls how the port for this block will behave
on the Conditional Custom Block, Custom block, or For Loop (ECL, ECB &
ECY Series) block.
• Automatic: The port inherits the connection type from the input port of
the block it is connected to. For example, making a connection to the first
two Add block inputs are mandatory (as shown by the or symbol at
the input port), therefore the first two Custom block inputs have inherited
this property and making a connection to the first two Custom Block
inputs are also mandatory. Likewise, making a connection to the third
Add block inputs is optional (there is no or symbol at the input port),
therefore the third Custom Block input has inherited this property and
making a connection to the third Custom Block input is also mandatory.
Figure 200: The exported input automatic property setting inherits the connection type requirement from the
connected port
Conditional Custom Block, Custom Block, or For Loop Block programming sheet
Exported Inputs Exported Outputs
296 EC-gfxProgram
If the Exported Input block is connected to two or more block inputs, any of
which are mandatory (as shown by the or symbol at the input port), the
Custom Block input will also be mandatory.
• Optional: Making a connection to the corresponding port of the Condi-
tional Custom Block, Custom Block, or For Loop block is optional. If
no connection is made to the port on the Conditional Custom Block,
Custom Block, or For Loop block, the value set in the Exported Input’s
OptionalValue property will be used. When a connection is made to such
a port, the connected input overrides the OptionalValue property.
Figure 201: Setting the OptionalValue
An Exported Input’s OptionalValue property drop-down list also allows you
to select values such as null, + infinity, and - infinity. For example, using +
infinity and - infinity for an Exported Input Block’s Properties pane is useful
for range limiting inputs, that when left unconnected will disable the limit fea-
ture. See the MinValidValue and MaxValidValue input below.
Figure 202: MinValidValue and MaxValidValue inputs are unlimitted when left
unconnected due to the OptionalValue being set to -Infinity and +Infinity
• Mandatory: Making a connection to the corresponding port of the Condi-
tional Custom Block, Custom Block, or For Loop block is mandatory,
otherwise a compilation error will result.
See also Configure Ports.
EC-gfxProgram 297
Show in Containing Page
When viewing project code inside a Conditional Custom Block, a Custom
block, or a For Loop (ECL, ECB & ECY Series), and you want to return to the
Conditional Custom Block, Custom Block, or For Loop block object, right-
click a blank area of the programming sheet and select Show in Containing
Page.
Figure 203: Returning to the Conditional Custom Block, Custom Block, or For Loop
(ECL, ECB & ECY Series) block objects
Converting selected project code in a custom
block/conditional custom block shortcut
Encapsulate When you have project code that you want to make into a Custom block or a
shortcut Conditional Custom Block, use the Encapsulate shortcut which allows you to
select one or more blocks and to move them into a Custom Block or a Con-
ditional Custom Block. Proceed as follows.
1. Select the blocks you want to create a Custom Block/Conditional Cus-
tom Block from. Right-click one of the blocks and select either Encapsu-
late > In a Custom Block or Encapsulate > In a Conditional Custom
Block.
Figure 204: Encapsulating the selected blocks in a custom block
298 EC-gfxProgram
The results are shown below. The input and output ports of the Custom
Block/Conditional Custom Block can be renamed if necessary or re-
ordered (change the order in which the ports are shown): right-click the Cus-
tom Block or Conditional Custom Block and select Configure Ports. See
Configure Ports.
Figure 205: The encapsulated custom block
This Custom Block can then be reused by copying and pasting it or by saving
it as a code snippet so it can be easily reused from the Code Library. See
Saving a code snippet. A Custom block can also be converted into a toolbox
with The Toolbox Builder Tool.
Conditional Custom Block
Description Used to simplify graphic control sequences by grouping multiple blocks
together and creating a new block for advanced controls. The block’s
sequences also have the ability to be executed only when the block is
enabled. These new blocks can then be added to the Code Library.
This block is used as the root block when creating a toolbox. See The Toolbox
Builder Tool for more information.
Slim format This block can be collapsed into a slim format. See Collapsed in Common
support block properties.
Advanced Configure Ports, Adding exported inputs and exported outputs
configuration
Related blocks Exported Input, Exported Output (see Adding exported inputs and exported
outputs)
EC-gfxProgram 299
Input(s)
Port Type Range Description
Enabled Digital 0 or 1 Used to enable or disable the block. Setting this to 0 disables the
block while setting it to 1 enables the block. If the block is
disabled, each connected output holds the last value. For this
reason, each output will consume 1 unit of RAM.
When this block is disabled, the programming sheet for this block
shows the following message: This logic is not currently
executed by the device.
NOTE: The project code within a Conditional Custom block is
only executed when the block is enabled. However, the
user should be aware that the project code may not out-
put expected results when the block is subsequently dis-
abled and re-enabled. This is especially True when the
Conditional Custom block contains blocks that are
dependent on transitions (On-Off or Off- On) such as
Rising Edge, Falling Edge, Latch, Toggle, etc. blocks.
Outout(s) See Adding exported inputs and exported outputs.
Block properties See also Common block properties.
Property Type Range Default Description
Programmatic String Unlimited [blank] Assign a name to this block’s type or class
Name for identification purposes. This text is
shown underneath the block’s name. This is
useful when you are creating code snippets
or a toolbox.
When left blank, the default block’s type is
shown underneath the block’s name
(Conditional Custom Block).
Creating a Add a Conditional Custom Block object to a project. See Creating project
custom block code in a custom document and Show in Containing Page.
document
By adding Exported Input objects and Exported Output objects on the pro-
gramming sheet document for the new Conditional Custom Block, inputs
and outputs are added to the Conditional Custom Block object.
Figure 206: Custom Block with exported input and exported output objects in the
corresponding document
See Adding Adding exported inputs and exported outputs.
300 EC-gfxProgram
Example Custom blocks simplify control sequence representation by allowing a com-
plex project code to be built within a single block. Therefore, as seen in the
example below, an apparently simple control sequence that uses a wireless
Light Switch (Wireless Sensor block) to dim (Conditional Custom block) a
Light (Hardware Output block) is displayed (see figure below). However,
within the Conditional Custom block is a more complex project code consist-
ing of several Internal constant blocks, a Switch block, an Add block, and a
Limit block (see figure below).
Figure 207: Conditional Custom Block example
The only exposed inputs to the Conditional Custom block are Input
(exported input) and Enabled. Each time the Light Switch (Wireless Sensor
block) is pressed, a pulse is sent that enables the Conditional Custom block
and the On or Off signal is sent to the Input of the Conditional Custom
block. The inputted value is then taken inside the Conditional Custom block
to follow the sequence and is then sent to the exported output, Level, and in
turn to the Light (Hardware Output block).
Figure 208: Inside the Conditional Custom block
Inside the Conditional Custom block, the Input value is sent to the Switch
block. Internal Constant blocks are used by the Switch block to increase or
decrease the light dimming level by 10% depending on whether the Light
Switch is turned On or Off. The Add block receives the increase or decrease
to the light dimming level from the Switch block and adds it to the current
level. The Limit block receives the Output of the Add block, evaluates if it is
within the High and Low limits specified by a pair of Internal Constant blocks
and outputs the current dimming level to the Add block and the Level output
of the Conditional Custom block.
EC-gfxProgram 301
Custom block
Description Used to simplify graphic control sequences by grouping multiple blocks
together and creating a new block for advanced controls. These new blocks
can then be added to the Code Library.
This block is used as the root block when creating a toolbox. See The Toolbox
Builder Tool for more information.
Slim format This block can be collapsed into a slim format. See Collapsed in Common
support block properties.
Advanced Configure Ports, Show/Hide Ports, Adding exported inputs and exported out-
configuration puts
Input(s) See Adding exported inputs and exported outputs.
Output(s) See Adding exported inputs and exported outputs.
Block properties See also Common block properties.
Property Type Range Default Description
Programmatic String Unlimited [blank] Assign a name to this block’s type or
Name class for identification purposes. This
text is shown underneath the block’s
name. This is useful when you are
creating code snippets or a toolbox.
When left blank, the default block’s type
is shown underneath the block’s name
(Custom Block).
Creating a Add a Custom Block block to a project. See Creating project code in a cus-
Custom Block tom document and Show in Containing Page.
document
By adding Exported Input blocks and Exported Output blocks on the pro-
gramming sheet document within the new Custom Block, inputs and outputs
are added to the Custom Block block.
Figure 209: Custom Block with exported input and exported output blocks in the
corresponding document
302 EC-gfxProgram
See Adding exported inputs and exported outputs.
Example Custom blocks simplify control sequence representation by allowing a com-
plex project code to be built within a single block. Therefore, as seen in the
example below, an apparently simple control sequence that calculates a Sup-
ply Air Temperature Setpoint (Custom block) based on the Outdoor Air Tem-
perature (Hardware Input block) is displayed (see figure below). However,
within the Custom block, is a more complex project code consisting of several
Internal constant blocks, a Linear block, and a Limit block (see Figure 211).
Figure 210: Custom Block example
The only exported input in the Custom block is Outdoor Air Temperature. The
Outdoor Air Temperature value inputted into this port from the Hardware
Input block is then taken inside the Custom block to follow the sequence and
is then sent to the exported output, Supply Air Temperature Setpoint.
Figure 211: Inside the Custom Block programming sheet document
Inside the Custom block, the Outdoor Air Temperature input is sent to the
Linear block. Supply air and outdoor air temperature min and max values
from the Internal Constant blocks are used by the Linear block to create a
linear interpolation. The Limit block receives the Output of the Linear block,
evaluates it against the High and Low outdoor air temperature min and max
values from the Internal Constant blocks and outputs the result to the Supply
Air Temperature Setpoint output of the Custom block.
For Loop (ECL, ECB & ECY Series)
Description Used to execute project code created on the associated programming sheet a
pre-determined number of times as set by the StartIndex and StopIndex.
This block is typically used to compare multiple network values between each
other (use Generic Network Value (ECB & ECY Series)), to find the average,
highest/lowest value, etc.
EC-gfxProgram 303
The output of the related Loop Info block shows the current value of the For
Loop (see Adding a Loop index).
Advanced Configure Ports, Show/Hide Ports, Adding exported inputs and exported out-
configuration puts
Related blocks Loop Info (ECL, ECB & ECY Series), Exported Input, Exported Output (see
Adding exported inputs and exported outputs)
Input(s)
Port Type Range Description
StartIndex Integer -16 777 216 to The count start point. Each time the loop has completed,
16 777 216 the index is increased by 1.
StopIndex Integer -16 777 216 to When the index is greater than or equal to the value of
16 777 216 StopIndex, the loop stops.
Output(s) See Adding exported inputs and exported outputs.
Block properties See also Common block properties.
Property Type Range Default Description
Debug Menu See False Enables or disables the generation of
Enabled Description debugging values from the project code
within the For Loop block. When this is set
to True, the controller can generate a lot of
network traffic which can hinder normal
communications between other controllers
on the network. It is recommended to set
this to True only when it is essential to
debug For Loop block code.
Creating a For Add a For Loop block to a project. See Creating project code in a custom
Loop document document and Show in Containing Page.
By adding Exported Input blocks and Exported Output blocks on the pro-
gramming sheet document for the new For Loop, inputs and outputs are
added to the For Loop block.
Figure 212: For Loop block with exported input and exported out put blocks in the
corresponding document
304 EC-gfxProgram
See About exported input and output formats.
Adding a Loop A Loop Info block provides the current index value of the For Loop. A Loop
index Info can only be used on the programming sheet page that was created for
the new For Loop as shown in the below. See Loop Info (ECL, ECB & ECY
Series).
For Loop block A For Loop block executes project code created on the associated program-
example for ECB ming sheet a pre-determined number of times as set by the StartIndex and
& ECY Series StopIndex at each controller scan cycle. In the following example, a For Loop
controllers is used to find the instantaneous maximum value (high select) of four Analog
Value (ECB & ECY Series) blocks (shown as Value1 through Value4).
Figure 213: ECB & ECY Series controller For Loop block example
Within the For Loop block is the project code that finds the highest value. The
Equal block resets the Maximum block with a large negative value (-999999)
that is normally out of range of the maximum values being tested for, when
the loop is at the start of its cycle. The Generic Analog Value (ECB & ECY
Series) block uses the output of the For Loop to scan through the four Analog
Values. The Maximum block finds the highest value which is sent to the
Exported Output block (named as Maximum). The Exported Output block
appears as an output port on the For Loop block.
Figure 214: Inside the For Loop programming sheet document
EC-gfxProgram 305
As with a Custom block, an Exported Input can be used to add an input port
on the For Loop block to make values available within the associated For
Loop programming sheet. See Adding exported inputs and exported outputs.
For Loop block NOTE: For an example of using the For Loop block to fan in values from
example for ECL many controllers, see Using LONWORKS network variables to fan in
Series values from many controllers
controllers
A For Loop block executes project code created on the associated program-
ming sheet a pre-determined number of times as set by the StartIndex and
StopIndex at each controller scan cycle. In the following example, a For Loop
is used to find the instantaneous maximum value (high select) of four Numeric
Value (ECL Series) blocks (shown as Numeric Value1 through Numeric Val-
ue4).
Figure 215: ECL Series controller For Loop block example
Within the For Loop block is the project code that finds the highest value. The
Equal block resets the Maximum block with a large negative value (-3E+36)
that is normally out of range of the maximum values being tested for, when
the loop is at the start of its cycle. The Generic Numeric Value (ECL Series)
block uses the output of the For Loop to scan through the four Numeric Val-
ues. The Maximum block finds the highest value which is sent to the
Exported Output block (named as Maximum). The Exported Output block
appears as an output port on the For Loop block.
Figure 216: Inside the For Loop programming sheet document
306 EC-gfxProgram
As with a Custom block, an Exported Input can be used to add an input port
on the For Loop block to make values available within the associated For
Loop programming sheet. See Adding exported inputs and exported outputs.
For Loop block A Null Input to this block should be avoided. If any Input to a For Loop block is
with null input Null, the block may experience unexpected behavior.
Loop Info (ECL, ECB & ECY Series)
Description Provides the status of the For Loop (ECL, ECB & ECY Series) block. This
block can only be used inside the For Loop Block.
Advanced Configure Ports, Show/Hide Ports
configuration
Related blocks For Loop (ECL, ECB & ECY Series)
Input(s) N/A
Output(s)
Port Type Range Description
Output Integer -16 777 216 to Block output. Each time the loop has completed, the
16 777 216 index is increased by 1.
StartIndex Integer -16 777 216 to The count start-point.
16 777 216
EndIndex Integer -16 777 216 to The count end-point.
16 777 216
TotalLoops Integer 0 to 33 554 432 The number of times the loop is to execute.
Remaining Integer 0 to 33 554 432 The number of remaining times the loop is to execute.
Loops
Block properties See Common block properties.
EC-gfxProgram 307
General
General blocks are used to perform various important control loop functions in
a program to provide control and supervision of a process.
The following blocks are available in this category:
• Color Decoder
• Color Encoder
• Count Down
• Count Up
• Device Info (ECL Series)
• Device Info (ECB & ECY Series)
• Digital Fault
• Dual Pid (ECP Series)
• Falling Edge
• Hysteresis
• Latch
• Lcd Screen (ECL, ECB & ECY Series)
• Limit
• Linear
• Notification Class (ECB & ECY Series)
• Numeric Fault
• Pid (ECP Series)
• Pid Loop (ECL Series)
• Pid Loop (ECB & ECY Series)
• Ramp
• Rising Edge
• Startup
• Toggle
• Weather (ECB & ECY Series)
308 EC-gfxProgram
Color Decoder
Description Used to decode an encoded light color value, that is to transform it into stan-
dard Red, Green, Blue, and White numeric values.
Related blocks Light Output (ECB & ECY Series expansion modules), Color Encoder
Input(s)
Port Type Range Description
32-Bit 8-Bit
EncodedColor Numeric 1.17549x10-38 to Encoded color code.
16777216
Output(s)
Port Type Range Description
32-Bit 8-Bit
Red Numeric 0 to 255 Standard Red color value.
Green Numeric 0 to 255 Standard Green color value.
Blue Numeric 0 to 255 Standard Blue color value.
White Numeric 0 to 255 Standard White color value.
Block properties See also Common block properties.
EC-gfxProgram 309
Color Encoder
Description Used to transform standard Red, Green, Blue, and White numeric values into
a RGB or RBGW light color code. The resulting code is meant to be input into
a Light Output block, thus allowing it to manage the light color of the con-
nected light expansion module.
NOTE: You can use a graphics editor to choose a color and find the corre-
sponding Red, Green, Blue, and White values to write into the respec-
tive input ports of this block.
WARNING: For proper functioning of the Color Encoder block in combina-
tion with a Light Output block, make sure to set the Color Man-
agement field of the corresponding Light Output resource to
RGB or RGBW (rather than Tunable White). See Configure the
Light Output.
Related blocks Color Decoder, Light Output (ECB & ECY Series expansion modules)
Input(s)
Port Type Range Description
32-Bit 8-Bit
Red Numeric 0 to 255 Standard Red color value.
Green Numeric 0 to 255 Standard Green color value.
Blue Numeric 0 to 255 Standard Blue color value.
White Numeric 0 to 255 Standard White color value.
Output(s)
Port Type Range Description
32-Bit 8-Bit
EncodedColor Numeric 1.17549x10-38 Encoded RGB or RGBW code that can
to 16777216 be used by a Light Output block. See
Light Output (ECB & ECY Series expan-
sion modules).
310 EC-gfxProgram
Block properties See also Common block properties.
EC-gfxProgram 311
Count Down
Description Used to decrement the output by 1 at every Off-to-On transition, On-to-Off
transition or on both transitions.
Persistence For ECL, ECB & ECY Series controllers, he current value is persistent; this
allows a value to be saved during a controller power cycle or reset. See Per-
sistent values (ECP Series controllers) and Persistent values (ECL, ECB &
ECY Series controllers).
Advanced Configure Ports, Show/Hide Ports
configuration
Related blocks Count Up
Input(s)
Port Type Range Description
32-Bit 8-Bit
Input Digital 0 or 1 Block input.
StartPoint Integer 0 to 3×1038 0 to 83886 The count start point. The counter will then
commence counting down to 0. When the
Output has reached 0, the UnderFlow is set
to 1 for one execution cycle and the Output is
reset to 0.
Reset Digital 0 or 1 When On (1), the Output is reset to the value
of StartPoint and UnderFlow is set to 0.
When Off (0), the Count Down block is
enabled.
312 EC-gfxProgram
Output(s)
Port Type Range Description
32-Bit 8-Bit
Output Integer 0 to 3×1038 0 to 83886 Block output. Number of the count.
For ECL, ECB & ECY Series controllers: If no
Input to this block is Null, then the block’s
output is the normal result. If one or more
Inputs to this block are Null, then the Output of
this block is always Null.
UnderFlow Digital 0 or 1 Count underflow limit. Indicates that the count
number has reached 0.
NOTE: This can be used in another count
down block to get more count steps.
Block properties See also Common block properties.
Property Type Range Default Description
CountType Menu See RisingEdge Set the condition under which the count is
Description decremented: RisingEdge (Off-to-On),
FallingEdge (On-to-Off) or Both (Off-to-On
or On-to-Off).
Persist Menu See False When this option is True, the output count is
Description preserved during any type of reset. See
Persistent values (ECP Series controllers)
and Persistent values (ECL, ECB & ECY
Series controllers).
When Persist is set for a new block, you must reset the persistent value that
is associated with the block after the project code has been sent to the device.
The application cannot really determine if the persistent value that is stored in
the controller is the one you want. So a manual operation is required to reset
this value the first time you setup it on a block. The procedure to do so is the
following:
1. Create your project code with your Count Down block.
2. Setup Persist for the block.
3. Build the project code and send it to the device.
4. Start debugging: Click the Start button on the Home ribbon, Debugging
buttons.
5. Right-click on the block and select Reset Persistent Value.
EC-gfxProgram 313
Count Down The Count Down block can be used to count down the number of Off to On
example values received by its Input. The example below shows how a Pump Mainte-
nance Notice (Latch and Variable Enum block) is issued after a Pump (Hard-
ware Output block) turns On 1000 times (Count Down and Internal constant
block). After the Pump Maintenance Notice is dealt with, the count is reset
(Constant Enum (ECP Series) and Rising Edge block).
Figure 217: Count Down block example
The Count Down block receives values from the Pump command (Hardware
Output block) and outputs a Pump Maintenance Notice (Variable Enum
block) from the UnderFlow output through a Latch block once the block
receives 1000 Pump (Hardware Output block) starts, that is, the count limit.
The Count Down block is programmed to be reset by a Manual Count Reset
(Constant Enum block).
Count Up
Description Used to increment the output by 1 on every Off-to-On transition, On-to-Off
transition or on both transitions.
Persistence For ECL, ECB & ECY Series controllers, the current value is persistent; this
allows a value to be saved during a controller power cycle or reset. See Per-
sistent values (ECP Series controllers) and Persistent values (ECL, ECB &
ECY Series controllers).
Advanced Configure Ports, Show/Hide Ports
configuration
Related blocks Count Down
Input(s)
Port Type Range Description
32-Bit 8-Bit
Input Digital 0 or 1 Block input.
314 EC-gfxProgram
Port Type Range Description
32-Bit 8-Bit
CntLimit Integer 0 to 3×1038 0 to 83886 The upper limit for the OverFlow. When the
Output has reached this number, the
OverFlow is set to 1 for one execution cycle
and the Output is reset to 0.
Reset Digital 0 or 1 When On (1), the Output and OverFlow
are set to 0. When Off (0), the Count Up
block is enabled.
Output(s)
Port Type Range Description
32-Bit 8-Bit
Output Integer 0 to 3×1038 0 to 83886 Block output. Number of the count.
For ECL, ECB & ECY Series controllers: If
no Input to this block is Null, then the
block’s output is the normal result. If one or
more Inputs to this block are Null, then the
Output of this block is always Null.
OverFlow Digital 0 or 1 Count overflow limit. Indicates that the
maximum count number has been reached.
The maximum counter limit is determined by
the CntLimit.
NOTE: This can be used in another count
up block to get more count steps.
Block properties See also Common block properties.
Property Type Range Default Description
CountType Menu See RisingEdge Set the condition under which the count is
Description incremented: RisingEdge (Off-to-On),
FallingEdge (On-to-Off) or Both (Off-to-
On or On-to-Off).
Persist Menu See False When this option is True, the output count
Description is preserved during any type of reset. See
Persistent values (ECP Series controllers)
and Persistent values (ECL, ECB & ECY
Series controllers).
When Persist is set for a new block, you must reset the persistent value that
is associated with the block after the project code has been sent to the device.
EC-gfxProgram 315
The application cannot really determine if the persistent value that is stored in
the controller is the one you want. So a manual operation is required to reset
this value the first time you setup it on a block. The procedure to do so is the
following:
1. Create your project code with your Count Up block.
2. Setup Persist for the block.
3. Build the project code and send it to the device.
4. Start debugging: Click the Start button on the Home ribbon, Debugging
buttons.
5. Right-click on the block and select Reset Persistent Value.
Example The Count Up block can be used to count the number of Off to On values
received by its Input. The example below shows how the Number of Chiller
Starts (Variable Numeric (ECP Series) block) is counted (Count Up and Inter-
nal constant block) for maintenance purposes, every time the Chiller (Hard-
ware Output block) turns On. After the issue is dealt with, the count is reset
(Constant Enum (ECP Series) and Rising Edge block).
Figure 218: Count Up block example
The Count Up block receives values from the Chiller command (Hardware
Output block) and outputs the number of times it receives an On value to a
Variable Numeric block. Once the count reaches the specified limit of 1000
(Internal Constant block), the OverFlow output sends a 1 value to a second
Count Up block. This second Count Up block is used to collect the overflow
from the first one and continues to count every 1000 Chiller (Hardware Out-
put block) starts and sends the count to a second Variable Numeric block.
Both Count Up blocks are programmed to be reset by a Manual Count Reset
(Constant Enum block).
316 EC-gfxProgram
Device Info (ECL Series)
Description Used to show information about the device. This block allows project code
behavior to adapt to the current controller model (in order to facilitate project
code reuse between controllers).
Slim format This block can be collapsed into a slim format. See Collapsed in Common
support block properties.
Advanced Configure Ports, Show/Hide Ports
configuration
Output(s)
Port Type Range Description
Internal Integer See Number of Internal variable (ECL, ECB & ECY Series)
VariablesQty Description blocks supported by the current controller.
Numeric Integer See Number of Numeric Value (ECL Series) blocks
ValueQty Description supported by the current controller.
Boolean Integer See Number of Boolean Value (ECL Series) blocks
ValueQty Description supported by the current controller.
Enum Integer See Number of Enum Value (ECL Series) blocks supported
ValueQty Description by the current controller.
Numeric Integer See Number of Numeric Constant (ECL Series) blocks
ConstantQty Description supported by the current controller.
Boolean Integer See Number of Boolean Constant (ECL Series) blocks
ConstantQty Description supported by the current controller.
Enum Integer See Number of Enum Constant (ECL Series) blocks
ConstantQty Description supported by the current controller.
PidLoopQty Integer See Number of PID loops supported by the current
Description controller.
OutputQty Integer See Number of hardware outputs supported by the current
Description controller.
EC-gfxProgram 317
Port Type Range Description
InputQty Integer See Number of hardware inputs supported by the current
Description controller.
ScanTime Integer See Number of milliseconds for the controller perform a
Description program cycle.
Subnet Integer See The current controller’s SubnetNodeID. For example,
NodeId Description use this value to set the amount of delay for sequential
equipment startup after a power failure, thereby
avoiding a current spike when all equipment is turned
on at once. See Example.
Block properties See Common Block Properties.
Example As the NodeId is a unique number for each controller, use this output to set
the amount of delay for sequential equipment startup after a power failure,
thereby avoiding a current spike when all equipment is turned on at once.
The SubnetNodeId is formed as follows: SubnetNodeID = (Subnet * 1000 +
nodeID). For example, if the SubnetNodeID is 1002, then the Subnet can be
found by applying modulus 1000 which equals 2.
The following project code multiplies the NodeId value by 5 seconds which
sets the startup time delay before the fan will start after controller startup.
Figure 219: Start Up Delay example code
318 EC-gfxProgram
Device Info (ECB & ECY Series)
Description Used to show information about the device. This block allows project code
behavior to adapt to the current controller model (in order to facilitate project
code reuse between controllers).
Slim format This block can be collapsed into a slim format. See Collapsed in Common
support block properties.
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s) N/A
Output(s)
Port Type Range Description
Internal Integer See Number of Internal variable (ECL, ECB & ECY Series)
VariablesQty Description blocks supported by the current controller.
Analog Integer See Number of Analog Value (ECB & ECY Series) blocks
ValueQty Description supported by the current controller.
Binary Integer See Number of Binary Value (ECB & ECY Series) blocks
ValueQty Description supported by the current controller.
MultiState Integer See Number of Multi State Value (ECB & ECY Series)
ValueQty Description supported by the current controller.
PidLoopQty Integer See Number of PID loops supported by the current
Description controller.
OutputQty Integer See Number of hardware outputs supported by the current
Description controller.
InputQty Integer See Number of hardware inputs supported by the current
Description controller.
ScanTime Integer See Number of milliseconds for the controller perform a
Description program cycle.
EC-gfxProgram 319
Port Type Range Description
MacAddress Integer See The current controller’s MAC Address. For example,
(for ECB Description use this value to set the amount of delay for sequential
Series equipment startup after a power failure, thereby
controllers avoiding a current spike when all equipment is turned
only) on at once. See Example.
Block properties See Common block properties.
Example As the MAC Address is a unique number for each controller, use this output to
set the amount of delay for sequential equipment startup after a power failure,
thereby avoiding a current spike when all equipment is turned on at once.
The following project code multiplies the MAC Address value by 5 seconds
which sets the startup time delay before the fan will start after controller
startup.
Figure 220: Start Up Delay example code
Digital Fault
Description Used to evaluate a digital fault condition such as a fan or a pump stop or a
manual override. When the input is different than the status for a defined time
period (Activation Delay), the block will output a fault. There are two types of
faults; run faults and stop faults.
Input Status RunFault StopFault
0 0 0 0
0 1 1 (after Activation Delay) 0
1 0 0 1 (after Activation Delay)
1 1 0 0
320 EC-gfxProgram
Advanced Configure Ports, Show/Hide Ports
configuration
Related blocks Numeric Fault
Input(s)
Port Type Range Description
Input Digital 0 or 1 Block input. The equipment command
Status Digital 0 or 1 The equipment status.
Enabled Digital 0 or 1 Used to enable or disable the block. Setting this to 0
disables the block while setting it to 1 enables the
block. If the block is disabled, the outputs are set to 0.
Output(s)
Port Type Range Description
RunFault Digital 0 or 1 State of the run fault. If On (1), it means that the
equipment is manually overridden (forced) to run.
For ECL, ECB & ECY Series controllers: If no Input to
this block is Null, then the block’s output is the normal
result. If one or more Inputs to this block are Null, then
the Output of this block is always Null.
StopFault Digital 0 or 1 State of the stop fault. If On (1), it means that the
equipment is commanded to start, but it does not start
or that the equipment has stopped without having
been commanded to stop.
For ECL, ECB & ECY Series controllers: If no Input to
this block is Null, then the block’s output is the normal
result. If one or more Inputs to this block are Null, then
the Output of this block is always Null.
Block properties See also Common block properties.
Property Type Range Default Description
32-Bit 8-Bit
Activation Integer 0 to 3×1038 0 to 83886 60 The time (in seconds) that a fault
Delay condition must be True before a
fault is activated.
Example The Digital Fault block can be used to determine whether a digital condition
is working properly. The example below shows how Supply and Return Fan
State Alarms (Digital Fault blocks) are evaluated based on the Supply and
EC-gfxProgram 321
Return Fan State (Hardware Input blocks) inputs they are receiving and the
actual Supply and Return Fan statuses (Hardware Output blocks).
Figure 221: Digital Fault block example
The Digital Fault blocks compare the Input (the desired state) to the Status
(the actual state) and checks if they are the same. In the case of the Supply
Fan, the Input is On, but the Status is Off, therefore once the Activation Delay
has passed, the StopFault turns On. In the case of the Return Fan, the Input,
and Status are both Off, therefore both Faults remain Off. These Fault values,
along with values from the Numeric Fault and Hardware Input blocks, are
then sent to a SNVT_state Mux block which in turn sends all these fault val-
ues to a Network Variable Output block.
322 EC-gfxProgram
Dual Pid (ECP Series)
Description Used to provide a proportional, integral, and derivative (PID) loop control for
two setpoints. Often used for generating heating and cooling demands based
on a room temperature input and heating and cooling setpoints.
NOTE: This block only uses 1 of the controller’s PID loops.
Number of 16 (Pid & Dual Pid)
blocks
Advanced Advanced configuration, Tuning a PID Loop
configuration
Related blocks Pid (ECP Series)
Input(s)
Port Type Range Description
Input Numeric -83886.08 to Input of the block.
83886.07
HiSetPt Numeric -83886.08 to The upper setpoint limit. Usually the cooling setpoint.
83886.07
LowSetPt Numeric -83886.08 to The lower setpoint limit. Usually the heating setpoint.
83886.07
Enabled Digital 0 or 1 Used to enable or disable the block. Setting this to 0
disables the block while setting it to 1 enables the block.
If the block is disabled, the outputs are set to 0.
EC-gfxProgram 323
Output(s)
Port Type Range Description
HiVal Numeric 0 to 100.00 High value output of the PID loop. Usually the cooling
loop.
LowVal Numeric 0 to 100.00 Low value output of the PID loop. Usually the heating
loop.
Block properties See Common block properties.
Property Type Range Default Description
Number Menu 1 to 16 Dual Pid 1 Use this drop-down menu to select from
the 16 available block instances.
See
Description
NOTE: When a new block instance is
added to the programming sheet,
the block’s number is incremented
to the next available block number
according to the current Auto
Increment setting. See Auto incre-
ment (ECP & ECL Series and
EBC Series controllers only).
Advanced The Dual Pid Configuration window provides an interface giving full control of
configuration the proportional, integral, and derivative parameters. See also Tuning a PID
Loop.
The only difference between the Dual Pid block and the Pid (ECP Series)
block is that the Dual Pid block has two control loops that have two outputs
based on two separate setpoints while using only one of the controller’s PID
loops.
The output of a PID loop is defined by the following equations:
P = Proportional part of PID Output
I = Integral part of PID Output
D = Derivative part of PID Output
B = Bias part of PID Output
324 EC-gfxProgram
GP = Proportional gain (200/PB; PB = Proportional band)
E = Error (Input – Setpoint)
GI = Integral gain
TI = Integral time
∫Edt = Integral of Error with respect to time
GD = Derivative gain
TD = Derivative time
dE/dt = Derivative of Error with respect to time
The following graphs illustrate the effect of Proportional (P), Proportional-Inte-
gral (PI) and Proportional-Integral-Derivative (PID) control on a control point:
Figure 222: Proportional (P) control
EC-gfxProgram 325
With proportional (P) only control, the output is a function of the error or differ-
ence between the control point and setpoint. The control point eventually sta-
bilizes, but most often not on the setpoint, creating an offset.
Figure 223: Proportional-Integral (PI) control
With proportional-integral (PI) control, the control point eventually stabilizes
on the setpoint, eliminating the offset, but there is still a significant overshoot.
Figure 224: Proportional-Integral-Derivative (PID) control
With proportional-integral-derivative (PID) control, the control point stabilizes
on the setpoint faster than with PI control and overshoot is reduced.
326 EC-gfxProgram
Property Description
Proportional The proportional band is the error value that is necessary to span the extent of
band the output range, that is, to move the output from 0 to 100%. The proportional
gain is the instantaneous effect of the error on the output. The proportional gain
and proportional band have the following relationship: proportional gain = 200/
(proportional band).
For example, If the proportional band is set to 4ºF, then a 2ºF error (deviation
from the setpoint) will result in 100% output. The proportional band is
sometimes referred to as a "throttling range" or "modulating range".
Integral gain A multiplication factor that adds weight to the integral part of the PID loop. The
accumulated error is multiplied by the integral gain value and contributes to the
control output. If required, it is recommended to adjust the integral time and
leave the integral gain equal to the proportional gain. Integral control particularly
helps to stabilize the input close to the setpoint.
Integral time The integral time is a factor of the effect of the error (deviation from setpoint)
over time. The integral time determines how quickly the system responds to a
given error.
Derivative gain A multiplication factor that adds weight to the derivative part of the PID loop.
The accumulated error is multiplied by the derivative gain value and contributes
to the control output. Derivative control particularly helps to reduce overshoot
and the time it takes for the input to stabilize close to the setpoint.
Derivative time The derivative time determines the effect of the derivative action on the system
response. The derivative time is sometimes referred to as "rate time".
EC-gfxProgram 327
Property Description
Dead band The dead band is a range (centered on the setpoints) in which no corrective
action is taken, that is, the output of the PID loop remains the same.
For example, the graph below shows the effect of a 2°F dead band on a Dual
Pid loop that has a proportional band of 4°F. The low setpoint is 72°F while the
high setpoint is 75°F. The dead band is 2°F centered on each of the setpoints
and thus the output of the Dual Pid loop does not change when the input is
between 71-73°F or 74-76°F. No matter how the Dual Pid loop is configured
(change to proportional, integral, derivative control, or bias) the dead band
remains centered on the setpoints.
Figure 225: Effect of 2°C Dead Band on Dual Pid
328 EC-gfxProgram
Property Description
Bias The bias is the default percentage of output when there is no error (setpoint =
Input). It is a constant value that is applied to the control loops to correct offsets.
For example, The graphs below show the effect of a 50% bias on a Dual Pid
loop that has a proportional band of 4°F. The low setpoint is 72°F while the high
setpoint is 75°F. The bias is 50% and thus the total output of the Dual Pid loop is
increased by 50% so that previously a 72°F input temperature resulted in an
output of 0% and now results in an output of 50%.
NOTE: Biasing the output may cause the control loops to intersect. This may
cause unpredictable and undesired reactions. It is recommended to
always set the bias to 0 for a Dual Pid.
Figure 226: 0% Bias on Dual Pid
Figure 227: 50% Bias on Dual Pid
NOTE: To setup and tune a PID loop, refer to the Tuning a PID Loop for fur-
ther information.
EC-gfxProgram 329
Example The Dual Pid block is used to provide PID loop control for a pair of setpoints.
The example below shows how the cooling and heating demands are deter-
mined (Dual Pid block) based on the Room Temperature (Hardware Input
block) and cooling and heating setpoints (Internal constant blocks) and how
these demands are used (Greater Than, Switch, Multiplexer, and Internal
Constant blocks) to determine the HVAC modes and display them on a
SmartSensor Module (ECP Series) block.
Figure 228: Dual Pid block example
The Dual Pid block receives the Room Temperature (Hardware Input block),
compares it to heating and cooling setpoints (Internal Constant blocks) and
outputs either a heating or cooling demand. This demand is then sent to
Comparator and Logic blocks which output the HVAC_AUTO mode to be
selected by the SmartSensor Module block through the Multiplexer block.
Falling Edge
Description Output turns On if the input goes from On (any non-zero value) to Off or any
other value. The output will remain On for the duration of one loop of code
execution. This is used to do a one-shot execution (pulse) upon an On to Off
transition.
Advanced Configure Ports, Show/Hide Ports
configuration
Related blocks Rising Edge
330 EC-gfxProgram
Input(s)
Port Type Range Description
Input Digital 0 or 1 Block input.
Output(s)
Port Type Range Description
Output Digital 0 or 1 Block output.
For ECL, ECB & ECY Series controllers: If no Input
to this block is Null, then the block’s output is the
normal result. If one or more Inputs to this block are
Null, then the Output of this block is always Null.
Block properties See Common block properties.
EC-gfxProgram 331
Hysteresis
Description Used to hold the output value steady until the input value has surpassed
either the high or low limits. It prevents the output from short cycling due to
small, yet frequent changes to the input.
NOTE: The SwitchOn and SwitchOff values should not change during the
execution of the project code to avoid any unexpected effects to the
controller logic. It is a good practice to make them fixed values or to
use Add and Subtract blocks as shown in the Example.
Advanced Configure Ports, Show/Hide Ports
configuration
Related blocks Thermostat
Input(s)
Port Type Range Description
32-Bit 8-Bit
Input Numeric ±3.4028×1038 -83886.08 to Block input.
+83886.07
332 EC-gfxProgram
Port Type Range Description
32-Bit 8-Bit
SwitchOn Numeric ±3.4028×1038 -83886.08 to If the SwitchOn value is less than the
+83886.07 SwitchOff value, then the Output
turns On when the Input is less than
or equal to the SwitchOn value. If the
SwitchOn value is greater than the
SwitchOff value, then the Output
turns On when the Input is greater
than or equal to the SwitchOn value.
NOTE: If the SwitchOn and Swi-
tchOff values are equal, then
the Output turns On when the
Input is greater than or equal
to the SwitchOn value and
Off when it is less than it.
SwitchOff Numeric ±3.4028×1038 -83886.08 to If the SwitchOff value is less than the
+83886.07 SwitchOn value, then the Output
turns Off when the Input is less than
or equal to the SwitchOff value. If the
SwitchOff value is greater than the
SwitchOn value, then the Output
turns Off when the Input is greater
than or equal to the SwitchOff value.
Output(s)
Port Type Range Description
Output Digital 0 or 1 Block output.
For ECL, ECB & ECY Series controllers: If no Input to
this block is Null, then the block’s output is the normal
result. If one or more Inputs to this block are Null, then
the Output of this block is always Null.
Block properties See Common block properties.
EC-gfxProgram 333
Example The Hysteresis block can be used to control equipment while preventing
short cycling. The example below shows how a Baseboard (Hardware Out-
put block) is controlled based on the comparison (Equal block) of the sched-
uled occupancy (Schedule block) to an occupancy setpoint (Internal constant
block) and (And block) the comparison (Hysteresis, Add, Subtract, and
Internal Constant blocks) of the Room Temperature to a temperature Set-
point (Hardware Input blocks).
Figure 229: Hysteresis block example
The Hysteresis block receives the Room Temperature (Hardware Input
block) as its Input value. It will only output an On value when its Input value is
less than or equal to the SwitchOn value, or 0.5°F less than the Setpoint
(Hardware Input block). Likewise, it will only output an Off value when its
Input value is greater than or equal to the SwitchOff value, or 0.5°F greater
than the Setpoint (Hardware Input block). When its Input value is between
the SwitchOn and SwitchOff values, the Output value remain at its last value
(On or Off). The Baseboard (Hardware Output block) will only turn On when
both inputs of the And block are 1, that is, when the occupied mode is sched-
uled and when the Hysteresis block outputs an On value.
334 EC-gfxProgram
Latch
Description Used for a set-reset logic. If the Set input turns On, the block will output and
hold an On value. If the Reset input turns On, the block will output and hold
an Off value. However, if the Reset input turns On while the Set input is On,
then the output will remain On. Likewise, if the Set input turns On while the
Reset input is On, then the output will remain Off.
Set Reset Output
0 0 No change
1 0 1
0 1 0
1 1 No change
Persistence For ECL, ECB & ECY Series controllers, the current value is persistent; this
allows a value to be saved during a controller power cycle or reset. See Per-
sistent values (ECL, ECB & ECY Series controllers).
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
Set Digital 0 or 1 Set input. If On and Reset is Off, Output turns On.
Reset Digital 0 or 1 Reset input. If On and Set is Off, Output turns Off.
EC-gfxProgram 335
Output(s)
Port Type Range Description
Output Digital 0 or 1 Block output.
For ECL, ECB & ECY Series controllers: If no Input
to this block is Null, then the block’s output is the
normal result. If one or more Inputs to this block are
Null, then the Output of this block is always Null.
Block properties See also Common block properties.
Property Type Range Default Description
Persist Menu See False When this option is True, the output
Description state is preserved during any type of
reset. See Persistent values (ECL, ECB
& ECY Series controllers).
About persist When Persist is set for a new block, you must reset the persistent value that
is associated with the block after the project code has been sent to the device.
The application cannot really determine if the persistent value that is stored in
the controller is the one you want. So a manual operation is required to reset
this value the first time you setup it on a block. The procedure to do so is the
following:
1. Create your project code with your Latch block.
2. Setup Persist for the block.
3. Build the project code and send it to the device.
4. Start debugging: Click the Start button on the Home ribbon, Debugging
buttons.
5. Right-click on the block and select Reset Persistent Value.
Example The Latch block can be used for holding an On value after it receives a
pulsed On value. The example below shows how a Light (Hardware Output
block) is controlled by a Light Switch (Wireless Sensor block) to turn On
(And and Latch block) for 60 minutes (Start Delay and Internal constant
blocks) unless the Light Switch is turned Off (Not and Or block) or is turned
On again while it is already On, thus resetting the timer (Not and And block).
Figure 230: Latch block example
336 EC-gfxProgram
The Latch block receives its Set command through an And block when a
Light Switch (Wireless Sensor block) is turned On. When the Set input is On,
the Output of the Latch block turns the Light (Hardware Output block) and
Start Delay block On (through an And block). If the Output of the Start Delay
block pulses On, that is, the Delay reaches 60 minutes or the Light Switch
(Wireless Sensor block) is turned Off, the Reset of the Latch block is turned
On, which turns the Output of the Latch block Off and in turn the Light (Hard-
ware Output block) and Start Delay block are also turned Off. If the Light
Switch (Wireless Sensor block) is turned On while the Light (Hardware Out-
put block) is already On, the Start Delay block is reset.
Lcd Screen (ECL, ECB & ECY Series)
Description The Lcd Screen block is primarily used for controllers equipped with an oper-
ator’s interface (color LCD screen) or that are connected to an ECx-Display.
In addition, it can be used for controllers connected to the myDC Control
application or the HORYZON-C and HORYZON-R displays. It allows you to
easily configure different parameters:
• Parameters such as your company name and logo, passwords, and inter-
face language can be configured in the LCD Screen advanced configura-
tion.
• Resources can be added to the Favorites List in the Resource Viewer that
may appear in the controller’s Favorites menu, once the project code has
been synchronized with the controller (see Project Synchronization).
• Weather information may be made available on the controller’s operator
interface or on a connected ECx-Display when the controller is used with
EC-Net. See Sending weather information to a controller (for ECL Series
controllers) and Configuring weather information for controllers with an
operator interface (for ECB & ECY Series controllers).
The Lcd Screen block has a Reliability port that indicates if the current con-
troller is actually equipped with an operator interface or it is connected to an
ECx-Display when the Reliability output is No fault detected (0).
WARNING: For ECY Series and ECL Series controllers, the Lcd Screen
block must be added to the Programming Sheet of any controller
that will be connected to an ECx-Display and the project code
has been synchronized with the controller (see Project Synchro-
nization). Otherwise, when an ECx-Display is connected to the
controller, it’s loading screen will be continuously shown and the
display will not load to show the controller’s information or invalid
data will be shown.
EC-gfxProgram 337
The loading screen is shown on the LCD screen during power-up,
when its firmware is being upgraded, or for ECY Series control-
lers, when the Lcd Screen block has not been added to the Pro-
gramming Sheet.\
NOTE: When you are using the myDC Control application or the HORYZON-
C or HORYZON-R displays, the presence of the Lcd Screen is not
required. It is only needed if you want to set up access rights. If no
Lcd Screen block is present in your project’s programming sheets,
myDC Control, HORYZON-C, and HORYZON-R will preserve their
default functioning, i.e. without password protection. See Security.
For a unit of a value to be correctly shown on the LCD screen, the point must
be correctly configured. See LCD interface supported units.
NOTE: As the configuration of this block often does not change from control-
ler to controller, it is ideal to create a code snippet of an appropriately
configured Lcd Screen block that can then be effortlessly used as
needed without having to configure it for each individual controller.
See Saving a code snippet.
Advanced Resources Configuration, LCD Screen advanced configuration, Favorites List
configuration , Configure Ports, Show/Hide Ports
Input(s) N/A
Output(s)
Port Type Range Description
Reliability Enum See Descrip- This provides an indication of whether the operator inter-
tion face is physically present or an ECx-Display is connected
to the controller (No fault detected (0)) or not (Communi-
cation failure (12)). See also Reliability property. Config-
uration error identifies that the operator interface / ECx-
Display configuration is not valid; try upgrading the firm-
ware for the controller and then for the operator interface /
ECx-Display. See Upgrade firmware (for ECL Series or
ECB Series controllers only). You do not need to configure
the Reliability output if you are using myDC Control,
HORYZON-C, or HORYZON-R.
Block properties See Common block properties.
338 EC-gfxProgram
LCD Screen advanced configuration
Configuration parameters for this block are set in the Resources Configura-
tion window. For controllers with an LCD interface, the following parameter
types can be configured.
Table 13: Password user access levels when user passwords have been configured
Parameters Description See
Main Screen In the Main Screen configuration you can optionally configure Main screen
up to two lines of text in the upper left corner of the LCD inter-
face’s Main screen. Click Add new line to add a text line. The
Screen Preview shows an approximation of the actual screen
presentation. The number of available lines are shown next to
the Add new line.
The Main Screen configuration does not apply to myDC Con-
trol, HORYZON-C, and HORYZON-R.
About The About Screen is used to display company information About screen
Screen and logo for contact information. Optionally, up to eight lines of
text and/or an image for the LCD interface’s About screen can
be configured. The Screen Preview shows an approximation
of the actual screen presentation in real time as you add con-
tent. The number of available lines is shown next to the Add
new line.
This About Screen configuration section cannot be used for
myDC Control, HORYZON-C, and HORYZON-R.
Security The Security is used to enable user access control to the LCD Security
interface when user passwords have been configured.
Display Lan- The Display Language is used to select a preferred user inter- Display lan-
guages face display language. guages
EC-gfxProgram 339
Figure 231: LCD Screen configuration in the Resources Configuration
340 EC-gfxProgram
Main screen In the Main Screen configuration you can optionally configure up to two lines
of text in the upper left corner of the controller’s Main screen. Click Add new
line to add a text line. The Screen Preview shows an approximation of the
actual screen presentation.
Figure 232: Main screen, LCD screen configuration
Function Description
Click to make the entire line of text bold face.
Click the drop-down arrow to select a color for
the entire line of text.
Click to add a new line of text.
Click to delete the line of text.
EC-gfxProgram 341
About screen The About Screen configuration is used to display company information and
logo for contact information. Optionally, up to eight lines of text and/or an
image for the controller’s About screen can be configured. The Screen Pre-
view shows an approximation of the actual screen presentation in real time as
you add content.
Figure 233: About screen, LCD screen configuration
Configuring the About screen
1. To begin configuring the About Screen, choose a display style available
in the Style drop-down list:
Property Description
Show image Allows an image to be shown on the left half of the
and text screen with up to eight lines of text on the right half of
the screen. In this mode, the LCD interface supports a
native image size of 200W x 180H pixels (see Figure
233).
Show image Allows only an image to be shown on most of the
only screen. This option allows you to use the allocated
screen space as you choose. For example, create a
graphic that combines both text and your logo as you
like. In this mode, the LCD interface supports a native
image size of 400W x 180H pixels.
Show text only Allows up to eight lines of text.
342 EC-gfxProgram
2. Click Load from file to select an image file on your PC’s file system.
When an image is selected, the image (in GIF, JPG, JPEG, BMP, or PNG
file format) is automatically processed as follows: The image size (width
or height) does not matter as any image will be proportionally scaled
down to the available native LCD screen image size specified in the table
above and is also converted to 256 indexed colors. If the size of this
scaled-down image is still too large for the allocated amount of memory
space on the controller for this image, the number of indexed colors used
in the image will be down-sampled until the image will fit into the control-
ler’s memory. The result of these conversions is that a line art image (a
logo) may be better represented on the LCD display as compared to a
continuous-tone image (for example, a photograph).
NOTE: To obtain optimal presentation clarity on the controller’s screen when
creating an image, it is always best to create the graphic using a third
party graphic editing program at the native screen resolution specified
in the table above and using 256 indexed colors or less.
3. Click Add new line to add a text line. The number of characters available
on a line of text varies according to actual letters used: For example, a
“W” uses far more space than an “I”.
4. If necessary, select the number of pixels for Padding. This is the amount
of white space that can be added around the image to add a border.
5. Click Add new line to add a text line. The number of characters available
on a line of text varies according to actual letters used: For example, a
“W” uses far more space than an “i”. Click this option every time you wish
to add a new line of text (up to 8 lines). For spacing between lines of text,
leave one of the lines empty (see Figure 233).
Security The Security configuration is used to enable user access control to the LCD
interface when user passwords have been configured. Up to four passwords
can be configured for the four different user access levels: Administrator,
Manager, Operator, and Guest. Each password is for an LCD interface access
level that is to be used by different types of LCD interface users, according to
their roles. When password protection is set for an LCD interface access
level, a user who uses that password when unlocking the LCD interface has
the access rights of that access level shown in Table 14.
In the Resource Viewer , first create groups in the Favorites List and then add
points to one or more groups. These Favorites Groups are listed in the Secu-
rity configuration where the ability for Operator or Guest users to view or
modify points for individual Favorite Groups can be set. An Operator always
has at minimum the same access rights as a Guest. See Security favorites
group example for more information.
When no user passwords have been created, anyone with physical access to
the controller can use all LCD interface features (they have the equivalent of
Administrator access).
EC-gfxProgram 343
Figure 234: Security, LCD screen configuration
Table 14: Password user access levels when user passwords have been configured
Password Type Administrator Manager Operator Guest
Points (Points, Overrides) RW RW No access No access
Favorites List RW RW See example below.
Schedule RW RW RW No access
Alarms RW RW No access No access
PID Parameters RW R No access No access
Trends R R R No access
Time / Date RW RW RW R
Daylight Saving Time RW RW RW R
Language RW RW RW R
Device Commissioning: MAC RW R R R
Address, Baud Rate, etc. for ECB
Series models only
Where: R = Read, W = Write, edit, override, or acknowledge
344 EC-gfxProgram
Security favorites group example
For example, in the Resource Viewer, five favorites groups have been cre-
ated: Inputs, Setpoints, Outputs, Outdoor Parameter, and PIDs. In the
Security configuration of the Lcd Screen block, these five favorites groups
are shown below.
Figure 235: Security configuration, favorites groups Read/Write access settings
Where: R = Read; W = Write, edit, or override
As can be seen by the tick box settings shown above for Operator and Guest
users, the right to write to the points in a Favorite Group also gives a user the
ability to view those same points. When a Guest user has the right to read or
write to the points in a Favorite Group, the Operator user either has the same
user rights as a Guest user or the Operator user can have more user rights
than a Guest user. For example, a Guest user can view (R) the points con-
tained in the Setpoints Favorites Group, then an Operator user can also view
the points contained in the Setpoints Favorites Group.
Display The Display Language configuration is used to select the languages that the
languages LCD interface can show. The controller has French and English as built in
user interface languages that can be enabled or disabled. Any language that
is enabled by adding it to the Available languages list becomes available to
the controller’s LCD interface. The default language for the user interface can
also be set once it has been added to the Available languages list.
Figure 236: Display language, LCD screen configuration
For ECL & ECB Series controllers, a third user interface language can be
uploaded into the controller through a custom language file, which can then
be selected from the Available languages drop-down list. See below.
For ECY Series controllers, one or more user interface languages can be
uploaded into the controller through a custom language file, which can then
be selected from the Available languages drop-down list. See below.
EC-gfxProgram 345
Creating your own interface language
Should a required language be unavailable, you can create your own lan-
guage file. The language file is an XML file that can support all languages that
use any combination of the following Unicode character sets (excluding con-
trol characters): Basic Latin, Latin-1 Supplement, Latin Extended-A, and Latin
Extended-B. Note that unsupported characters are shown on screen as a
question mark (?). The language files are located under EC-gfxProgram
installation folder in the following directory: \Config\Languages\LcdScreen.
Editing and uploading an XML file
The XML language file can be created as follows:
1. Copy a language XML file that was installed with EC-gfxProgram and
save it under a new filename.
NOTE: If you do not rename the file to a new name, re-installing EC-gfxPro-
gram will overwrite the file and your modifications will be lost.
2. Open the new file with a text editor (for example, using Notepad).
3. Update the language values as shown below, keeping in mind that certain
information should not be changed:
Figure 237: Example of the XML language format file
4. Only localize the text-string values that are enclosed in straight quotes ("),
except for the XML File Header and Element nodes. When localizing the
text string values, try to keep the same length as used in the original text.
Some letters will take much more space than others as the LCD screen
uses a proportionally spaced font: For example, a ‘W’ will take much more
space on the screen than an ‘i’.
5. Save the file.
NOTE: Protect the new language file by backing it up to a safe location else-
where on your computer network.
6. Restart EC-gfxProgram and select the new language file in the Available
languages drop-down list.
346 EC-gfxProgram
7. Verify that the localized text string values fit in the space allocated in the
screen by checking the screens and menus.
LCD interface For a unit of a value to be correctly shown on the LCD screen, the point must
supported units be correctly configured: It is best to use a type of unit that corresponds to the
value’s type. For example:
• For numeric values (ECL Series controllers), use an Engineering Units
format type for the point.
• For enumeration values (ECL Series controllers), use an Enumeration
format type for the point.
• For Boolean values (ECL Series controllers), use a Boolean format type
for the point.
• For BACnet values (ECB & ECY Series controllers), configure the unit in
the block’s advanced configuration properties.
NOTE: Avoid using Numeric Value + Text as this format type is not sup-
ported by the LCD screen.
Limit
Description Used to control the input value within a specified range.
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
32-Bit 8-Bit
Input Numeric ±3.4028×1038 -83886.08 to Block input.
+83886.07
High Numeric ±3.4028×1038 -83886.08 to The maximum value of the input. If the
+83886.07 Input is greater than this value, this value
will be outputted.
If you leave this port unconnected, it will
default back to the maximum value of the
8-bit controllers.
EC-gfxProgram 347
Port Type Range Description
32-Bit 8-Bit
Low Numeric ±3.4028×1038 -83886.08 to The minimum value of the input. If the
+83886.07 Input is less than this value, this value will
be outputted.
If you leave this port unconnected, it will
default back to the maximum value of the
8-bit controllers.
Output(s)
Port Type Range Description
32-Bit 8-Bit
Output Numeric ±3.4028×1038 -83886.08 to Block output.
+83886.07 For ECL, ECB & ECY Series controllers: If
no Input to this block is Null, then the
block’s output is the normal result. If one
or more Inputs to this block are Null, then
the Output of this block is always Null.
Block properties See Common block properties.
Limit block The Limit block can be used to prevent a value from exceeding a specified
example range. The example below shows how a Supply Air Temperature Setpoint
(Variable Numeric block) is calculated based on the Outdoor Air Tempera-
ture (Hardware Input block) being interpolated linearly (Linear block) and
limited (Limit block) by a Maximum and Minimum Supply Air Temperature
(Constant Numeric blocks) and a maximum and minimum outdoor air tem-
perature (Internal Constant blocks).
Figure 238: Limit block example
The Limit block receives the Output of the Linear block, which calculates the
Supply Air Temperature Setpoint (Variable Numeric block) based on a linear
interpolation generated from set values and the Outdoor Air Temperature
(Hardware Input block). The Limit block then ensures that its Input is within
the High limit, which is received from Maximum Supply Air Temperature (Con-
stant Numeric block) and Low limit, which is received from Minimum Supply
Air Temperature (Constant Numeric block). If the input of the Limit block
348 EC-gfxProgram
exceeds the High limit, then the block will output the High limit value and if it
exceeds the Low limit, then the block will output the Low limit value.
Linear
Description Provides a proportional reset based on the linear equation (y = mx + b). This
is useful for applications such as supply temperature reset in relation to the
outside air temperature. The linear curve is calculated as follows:
NOTE: Be aware that as a result of the calculation, the input values may
cause an overflow (>83886.07) or underflow (<-83886.08) on the Out-
put. See Internal range limits for more information.
The Output value is not limited between the value of Y1 and Y2. In
order to limit the Output value, use a Limit block.
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
32-Bit 8-Bit
Input Numeric ±3.4028×1038 -83886.08 to Block input.
+83886.07
EC-gfxProgram 349
Port Type Range Description
32-Bit 8-Bit
X1 Numeric ±3.4028×1038 -83886.08 to Value for X1.
+83886.07
Y1 Numeric ±3.4028×1038 -83886.08 to Value for Y1.
+83886.07
X2 Numeric ±3.4028×1038 -83886.08 to Value for X2.
+83886.07
Y2 Numeric ±3.4028×1038 -83886.08 to Value for Y2.
+83886.07
Outout(s)
Port Type Range Description
32-Bit 8-Bit
Output Numeric ±3.4028×1038 -83886.08 to Block output. Result of the linear
+83886.07 interpolation of the Input.
For ECL, ECB & ECY Series
controllers: If no Input to this block is
Null, then the block’s output is the
normal result. If one or more Inputs to
this block are Null, then the Output of
this block is always Null.
Block properties See Common block properties.
350 EC-gfxProgram
Internal range The Linear block is capable of an extended range of mathematical operation,
limits however any of the following conditions will cause the Linear block will go into
underflow/overflow:
• All terms of the linear formula (that is (Y2 – Y1), (X2 – X1), and (Input –
X1)) when resolved should evaluate to be within the range of -83886.08 to
+83886.07.
• (Y2 – Y1) and (Input – X1) can both evaluate to be ±83886.07, however
the value of (X2 – X1) must bring the final result of Output within the range
of -83886.08 to +83886.07.
• Having the denominator (X2 – X1) approach zero. Any denominator of
less than 1 acts as a multiplier in this formula.
NOTE: To keep this block in a safe operating range, use a Limit block on this
block’s inputs to avoid underflow/overflow conditions.
Example The Linear block can be used to interpolate a value based on a generated lin-
ear curve. The example below shows how a Supply Air Temperature Setpoint
(Variable Numeric (ECP Series) block) is calculated based on the Outdoor Air
Temperature (Hardware Input block) being interpolated linearly (Linear
block) and limited (Limit block) by a Maximum and Minimum Supply Air Tem-
perature (Constant Numeric (ECP Series) blocks) and a maximum and mini-
mum outdoor air temperature (Internal constant blocks).
Figure 239: Linear block example
Figure 240: Example results for linear curve with a Limit block applied
The Linear block generates a linear curve based on values from the Con-
stant Numeric and Internal Constant blocks. It then receives the Outdoor
Air Temperature (Hardware Input block) and interpolates it based on this
EC-gfxProgram 351
curve to output the Supply Air Temperature Setpoint (Variable Numeric
block). The Limit block then ensures that the value outputted by the Linear
block is within the specified limits and is outputted to the Numeric Variable
block.
Notification Class (ECB & ECY Series)
Description Used to make the notification class status available to your code. For all
objects linked to this notification class, the block’s outputs show the total num-
ber of objects that are currently in alarm and whether alarms have been
acknowledged or not.
Notification classes are used to route alarms to other devices that have the
same set of properties, priorities, and use for the alarm or event notification. In
addition, the requirement for the acknowledgment from a human operator can
also be set (for a notification message only). See Alarms (ECB & ECY
Series).
NOTE: As this block represents the NotificationClass resource, the Notifica-
tion Class configuration (for example, the recipients) often does not
change from controller to controller, it is ideal to create a code snippet
of an appropriately configured Notification Class block that can then
be effortlessly used as needed without having to configure it for each
individual controller. See Saving a code snippet.
Advanced Alarms (ECB & ECY Series), Configure Ports, Show/Hide Ports
configuration
Output(s)
Port Type Range Description
Number Numeric 0 to 3.4028×1038 The current instance of the object.
FaultUnack Numeric 0 to 3.4028×1038 The total number of unacknowledged faults
Count alarms.
FaultAck Count Numeric 0 to 3.4028×1038 The total number of acknowledged faults
alarms.
OffNormal Numeric 0 to 3.4028×1038 The total number of unacknowledged
UnackCount OffNormal alarms.
352 EC-gfxProgram
Port Type Range Description
OffNormal Numeric 0 to 3.4028×1038 The total number of acknowledged
AckCount OffNormal alarms.
NormalUnack Numeric 0 to 3.4028×1038 The total number of unacknowledged
Count Normal alarms.
HasUnack Fault Digital 0 or 1 If 1, there are currently active
unacknowledged fault alarms.
HasUnack Digital 0 or 1 If 1, there are currently active
OffNormal unacknowledged offnormal alarms.
Block properties See also Common block properties.
EC-gfxProgram 353
Numeric Fault
Description Used to evaluate a numeric fault condition such as a supply temperature low
limit. If the input is less than or equal to the low limit or greater than or equal to
the high limit for a defined time period (Activation Delay), the block will output
a fault. There are two types of faults; low fault and high fault. Hysteresis sets
the amount the Input has to return above the LowLimit or below the HiLimit
before the LowFault or HighFault output turns Off.
Advanced Configure Ports, Show/Hide Ports
configuration
Related blocks Digital Fault
354 EC-gfxProgram
Input(s)
Port Type Range Description
32-Bit 8-Bit
Input Numeric ±3.4028×1038 -83886.08 to Block input.
+83886.07
LowLimit Numeric ±3.4028×1038 -83886.08 to The minimum value of the input.
+83886.07
HiLimit Numeric ±3.4028×1038 -83886.08 to The maximum value of the input.
+83886.07
Enabled Digital 0 or 1 Used to enable or disable the block.
Setting this to 0 disables the block
while setting it to 1 enables the block.
If the block is disabled, the outputs
are set to 0.
Output(s)
Port Type Range Description
LowFault Digital 0 or 1 State of the low limit fault.
For ECL, ECB & ECY Series controllers: If no Input to
this block is Null, then the block’s output is the normal
result. If one or more Inputs to this block are Null, then
the Output of this block is always Null.
HiFault Digital 0 or 1 State of the high limit fault.
For ECL, ECB & ECY Series controllers: If no Input to
this block is Null, then the block’s output is the normal
result. If one or more Inputs to this block are Null, then
the Output of this block is always Null.
Block properties See also Common block properties.
Property Type Range Default Description
32-Bit 8-Bit
Activation Integer ±3×1038 ±83886 60 The time (in seconds)
Delay that a fault condition
must be True before a
fault is activated.
EC-gfxProgram 355
Property Type Range Default Description
32-Bit 8-Bit
Hysteresis Numeric ±3.4028×1038 -83886.08 to 0 Used to keep faults
+83886.07 from short cycling when
the input value
frequently moves
above and below the
LowLimit or HiLimit.
This sets the amount
the Input has to return
above the LowLimit or
below the HiLimit
before the LowFault or
HighFault output turns
Off.
Example The Numeric Fault block can be used to determine whether a numeric value is
outside of its limits. The example below shows how a Supply Air Temperature
Alarm (Numeric Fault block) is evaluated based on the Supply Air Tempera-
ture (Hardware Input blocks) input it is receiving and the high and low supply
air temperature limits (Internal constant blocks).
Figure 241: Numeric Fault block example
The Numeric Fault block checks if the Input is within the LowLimit and HiLimit.
Since the Input is lower than the LowLimit and there is no Hysteresis set, the
LowFault turns On once the Activation Delay has passed. This Fault value,
along with values from the Digital Fault and Hardware Input blocks, are then
sent to a SNVT_state Mux block which in turn sends all these fault values to
a Network Variable Output block.
356 EC-gfxProgram
Pid (ECP Series)
Description Used to provide a proportional, integral, and derivative (PID) loop control.
Number of 16 (Pid and Dual Pid)
blocks
Advanced Advanced configuration, Copy From, Configure Ports, Show/Hide Ports, Tun-
configuration ing a PID Loop
Related blocks Dual Pid (ECP Series)
Input(s)
Port Type Range Description
Input Numeric -83886.08 to Block input.
+83886.07
Setpoint Numeric -83886.08 to The setpoint.
+83886.07
Enabled Digital 0 or 1 Used to enable or disable the block. Setting this to 0
disables the block while setting it to 1 enables the block. If
the block is disabled, the output is set to 0.
Output(s)
Port Type Range Description
Output Numeric 0 to 100.00 PID loop output.
EC-gfxProgram 357
Block properties See also Common block properties.
Property Type Range Default Description
Number Menu 1 to 16 Pid 1 Use this drop-down menu to select from the
16 available block instances.
See
Description
NOTE: When a new block instance is added
to the programming sheet, the block’s
number is incremented to the next
available block number according to
the current Auto Increment setting.
See Auto increment (ECP & ECL
Series and EBC Series controllers
only).
Advanced The Pid Configuration window provides an interface giving full control of the
configuration proportional, integral, and derivative parameters. See also Tuning a PID Loop.
The output of a PID loop is defined by the following equations:
P = Proportional part of PID Output
I = Integral part of PID Output
D = Derivative part of PID Output
B = Bias part of PID Output
GP = Proportional gain (100/PB; PB = Proportional band)
E = Error (Input – Setpoint)
GI = Integral gain
TI = Integral time
∫Edt = Integral of Error with respect to time
358 EC-gfxProgram
GD = Derivative gain
TD = Derivative time
dE/dt = Derivative of Error with respect to time
The following graphs illustrate the effect of Proportional (P), Proportional-Inte-
gral (PI) and Proportional-Integral-Derivative (PID) control on a control point:
Figure 242: Proportional (P) control
With proportional (P) only control, the output is a function of the error or differ-
ence between the control point and setpoint. The control point eventually sta-
bilizes, but most often not on the setpoint, creating an offset.
Figure 243: Proportional-Integral (PI) control
EC-gfxProgram 359
With proportional-integral (PI) control, the control point eventually stabilizes
on the setpoint, eliminating the offset, but there is still a significant overshoot.
Figure 244: Proportional-Integral-Derivative (PID) control
With proportional-integral-derivative (PID) control, the control point stabilizes
on the setpoint faster than with PI control and overshoot is reduced.
Figure 245: Pid Configuration window
Parameter Description
Proportional band The proportional band is the error value that is necessary to span
the extent of the output range, to move the output from 0 to 100%.
The proportional gain is the instantaneous effect of the error on the
output. The proportional gain and proportional band have the
following relationship: proportional gain = 100/(proportional band).
For example, If the proportional band is set to 2ºF, then a 2ºF error
(deviation from the setpoint) will result in 100% output. The
proportional band is sometimes referred to as a "throttling range"
or "modulating range".
Integral gain A multiplication factor that adds weight to the integral part of the
PID loop. The accumulated error is multiplied by the integral gain
value and contributes to the control output. If required, it is
recommended to adjust the integral time and leave the integral
gain equal to the proportional gain. Integral control particularly
helps to stabilize the input close to the setpoint.
360 EC-gfxProgram
Parameter Description
Integral time The integral time is a factor of the effect of the error (deviation from
setpoint) over time. The integral time determines how quickly the
system responds to a given error.
Derivative gain A multiplication factor that adds weight to the derivative part of the
PID loop. The accumulated error is multiplied by the derivative gain
value and contributes to the control output. Derivative control
particularly helps to reduce overshoot and the time it takes for the
input to stabilize close to the setpoint.
Derivative time The derivative time determines the effect of the derivative action
on the system response. The derivative time is sometimes referred
to as "rate time".
Dead band The dead band is a range (centered on the setpoint) in which no
corrective action is taken, that is, the output of the PID loop
remains the same.
For example, the graph below shows the effect of a 2°F dead band
on a Pid loop that has a proportional band of 4°F. The setpoint is
72°F. The dead band is 2°F centered on the setpoint and thus the
output of the Pid loop does not change when the input is between
71 and 73°F. No matter how the Pid loop is configured (change to
proportional, integral, derivative control or bias represented by the
dashed lines) the dead band remains centered on the setpoint.
Figure 246: Effect of 2°C Dead Band on Pid
EC-gfxProgram 361
Parameter Description
Bias The bias is the default percentage of output when there is no error
(setpoint = Input). It is a constant value that is applied to the control
loop to correct offsets.
For example, the graph below shows the effect of a 50% bias on a
Pid loop that has a proportional band of 4°F. The setpoint is 72°F.
The bias is 50% and thus the total output of the Pid loop is
increased by 50% so that previously a 72°F input temperature
resulted in an output of 0% and now results in an output of 50%.
Figure 247: 0% Bias on Pid
i
Figure 248: 50% Bias on Pid
Reverse action If deselected, the control loop acts directly. Thus an increase in the
error will be directly proportional to the output (the more positive
the error; the more positive the output).
When selected, the control loop acts in reverse. Thus an increase
in the error will be inversely proportional to the increase in the
output (the more positive the error; the more negative the output).
NOTE: To setup and tune a PID loop, see Tuning a PID Loop for further infor-
mation.
362 EC-gfxProgram
Pid Loop (ECL Series)
Description Used to provide a proportional, integral, and derivative (PID) loop control.
Each Pid Loop block is linked to a corresponding network variable which fol-
lows the same value as the PID block.
The Pid Loop values are configured in the Pid Loop configuration theory win-
dow. However, during runtime, the PID loop values can be modified through a
network property, through the controller’s operator interface or through the
connected ECx-Display (when equipped), through the Live Trend Log (see
below), or through project code (by linking project code to a PID block’s Pro-
portionalBand, IntegralTime, or DerivativeTime input ports). When an input
port is linked to code, the corresponding network property is set to Read Only
and the controller’s operator interface or the connected ECx-Display (when
equipped) and Live Trend Log cannot be used to modify the parameter. If the
input port is later disconnected, the controller must be rebooted or the option
Reset PIDS selected during Project Synchronization to make the associated
network property writable again so that the parameter can be modified in the
controller’s operator interface or in the connected ECx-Display.
A Live Trend Log of the response of the PID loop’s Input, Setpoint, and
Output can be used to view a graph of these variables so as to help with PID
loop tuning. While Debugging a project, right-click the Pid Loop block and
select View Trend Log. See Viewing a Live Trend Log. The PID loop’s
advanced configuration parameters can be set within the Live Trend Log,
when the parameter is not being set at the block’s corresponding input port.
Number of The number of Pid Loop block instances supported by a controller is shown in
blocks the Number drop-down list in the Properties or Statistics panes.
Advanced Resources Configuration, Advanced configuration, Pid Loop configuration
configuration theory, Network Properties Configuration window (ECL, ECB & ECY Series),
Viewing a Live Trend Log, Override and auto, Find All References (ECL, ECB
& ECY Series) Copy From, Configure Ports, Show/Hide Ports, Tuning a PID
Loop
Related blocks Generic Pid Loop (ECL, ECB & ECY Series), Live Trend Log
EC-gfxProgram 363
Input(s)
Port Type Range Description
Input Numeric ±3.4028 ×1038 Block input.
Setpoint Numeric ±3.4028 ×1038 The setpoint.
Feedback Numeric 0 to 100 This is a feedback input of the actual control signal
being sent to the process being controlled.
For example, between the PID loop output and the
hardware output, blocks can be used to further
process the signal. When the process being
controlled is overridden, a PID block will normally
integrate either to 0% or 100%. This results in a
surge when the override is removed. By providing
the override signal to this input (the value at the
analog output for example), once the override is
removed, the block’s output will smoothly resume
operation starting from the last override value over
to PID loop control.
While the Pid block detects a difference between
the Output output and the Feedback input, the
integration function of the PID loop is suspended.
See To setup and tune a PID loop, see Tuning a
PID Loop for further information..
Proportional Numeric 0.001 to 3.4028 The proportional band is the error value that is
Band ×1038 necessary to span the extent of the output range,
to move the output from 0 to 100%. The
proportional gain is the instantaneous effect of the
error on the output. The proportional gain and
proportional band have the following relationship:
proportional gain = 100/(proportional band).
For example, If the proportional band is set to 2ºF,
then a 2ºF error (deviation from the setpoint) will
result in 100% output. The proportional band is
sometimes referred to as a "throttling range" or
"modulating range".
IntegralTime Numeric 0 to 3.4028 The integral time is a factor of the effect of the
×1038 error (deviation from setpoint) over time. The
integral time determines how quickly the system
responds to a given error.
Derivative Numeric 0 to 3.4028 The derivative time determines the effect of the
Time ×1038 derivative action on the system response. The
derivative time is sometimes referred to as "rate
time".
364 EC-gfxProgram
Port Type Range Description
Deadband Numeric 0 to 3.4028 The dead band is a range (centered on the
×1038 setpoint) in which no corrective action is taken,
that is, the output of the PID loop remains the
same.
For example, the graph below shows the effect of
a 2°F dead band on a Pid loop that has a
proportional band of 4°F. The setpoint is 72°F. The
dead band is 2°F centered on the setpoint and
thus the output of the Pid loop does not change
when the input is between 71 and 73°F. No matter
how the Pid loop is configured (change to
proportional, integral, derivative control or bias
represented by the dashed lines) the dead band
remains centered on the setpoint.
Figure 249: Effect of 2°C Dead Band on Pid
EC-gfxProgram 365
Port Type Range Description
Bias Numeric 0 to 100 The bias is the default percentage of output when
there is no error (setpoint = Input). It is a constant
value that is applied to the control loop to correct
offsets.
For example, the graph below shows the effect of
a 50% bias on a Pid loop that has a proportional
band of 4°F. The setpoint is 72°F. The bias is 50%
and thus the total output of the Pid loop is
increased by 50% so that previously a 72°F input
temperature resulted in an output of 0% and now
results in an output of 50%.
Figure 250: 0% Bias on Pid
Figure 251: 50% Bias on Pid
366 EC-gfxProgram
Port Type Range Description
RampTime Numeric 0 to 3.4028 Sets the maximum rate of change in seconds for
×1038 the Output to go from 0% to 100%.
For example, if this input is set to 120 seconds,
and the Enabled input port changes from False to
True, the block’s Output will take at least 120
seconds to ramp up from 0% to 100%. As such, if
the PID loop calculates a required Output of 50%,
it will take the Output at least 60 seconds to go
from 0% to 50%. This is shown below.
Figure 252: Example: 50% RampTime Effect on Pid
Output
Saturation Numeric 0 to 3.4028 When either SaturationTimeHighLimitEnable,
Time ×1038 SaturationTimeLowLimitEnable, or both are
enabled, this sets the time delay in seconds, after
which the SaturationStatus output can indicate
the saturation status.
Action Digital 0 or 1 If deselected, the control loop acts directly. Thus
an increase in the error will be directly proportional
to the output (the more positive the error; the more
positive the output). When selected, the control
loop acts in reverse. Thus an increase in the error
will be inversely proportional to the increase in the
output (the more positive the error; the more
negative the output).
Saturation Digital 0 or 1 When enabled, and the block’s output remains at
TimeHigh 100% output (at saturation) for a time period
LimitEnable longer than that set by SaturationTime, the
SaturationStatus output becomes 3.
Saturation Digital 0 or 1 When enabled, and the block’s output remains at
TimeLow 0% output (at saturation) for a time period longer
LimitEnable than that set by SaturationTime, the
SaturationStatus output becomes 2.
Enabled Digital 0 or 1 Used to enable or disable the block. Setting this to
0 disables the block while setting it to 1 enables
the block. If the block is disabled, the output is set
to 0.
EC-gfxProgram 367
Output(s)
Port Type Range Description
Output Numeric 0 to 100 The PID loop output. If no Input to this block is Null,
then the block’s output is the normal result. If one or
more Inputs to this block are Null, then the Output of
this block is always Null.
Saturation Digital 1, 2, or 3 The block’s output is:
Status
1. Normal. The output is unsaturated or either Satu-
rationTimeHighLimitEnable or Saturation-
TimeLowLimitEnable or both are not enabled.
2. Low saturation. The output is saturated at 0% for a
time period longer than that set by Saturation-
Time and SaturationTimeLowLimitEnable (see
above) is enabled.
3. High saturation. The output is saturated at 100%
for a time period longer than that set by Satura-
tionTime and SaturationTimeHighLimitEnable
(see above) is enabled.
Number Integer – The current block number.
Fault Digital 0 or 1 This is logically True (1) if the Reliability property does
not have a value of No Fault Detected, otherwise
logical False (0).
Reliability Enum See When either the Check out of range or the Check
Description signal fault in the Advanced Configuration is set (or
both are set), this provides an indication of whether
the physical input is "reliable" and, if not, why. See
Reliability property.
368 EC-gfxProgram
Block properties See also Common block properties.
Property Type Range Default Description
Number Menu See Pid 1 Use this drop-down menu to select an
Description instance of this block. See Number of
blocks for the number of block instances
supported by the current controller model.
This drop-down list also provides a
summary overview of the current
configuration parameters of all Pid blocks.
NOTE: When a new block instance is
added to the programming sheet,
the block’s number is incremented
to the next available block number
according to the current Auto
Increment setting. See Auto incre-
ment (ECP & ECL Series and
EBC Series controllers only).
Advanced configuration
Configuration parameters for this block are set in the Resources Configura-
tion window.
Figure 253: Resources configuration, Pid Loop configuration parameters
EC-gfxProgram 369
The Pid resource has specific parameters to configure. See also Pid Loop
(ECL Series) and Pid Loop (ECB & ECY Series).
Parameter Description
Proportional The proportional band is the error value that is
Band necessary to span the extent of the output range, to
move the output from 0 to 100%. The proportional gain
is the instantaneous effect of the error on the output.
The proportional gain and proportional band have the
following relationship: proportional gain = 100/
(proportional band).
For example, If the proportional band is set to 2ºF, then
a 2ºF error (deviation from the setpoint) will result in
100% output. The proportional band is sometimes
referred to as a "throttling range" or "modulating
range".
IntegralTime The integral time is a factor of the effect of the error
(deviation from setpoint) over time. The integral time
determines how quickly the system responds to a given
error.
Derivative Time The derivative time determines the effect of the
derivative action on the system response. The
derivative time is sometimes referred to as "rate time".
Deadband The dead band is a range (centered on the setpoint) in
which no corrective action is taken, that is, the output of
the PID loop remains the same. See the block’s
Deadband input for more information (Figure 249).
Bias The bias is the default percentage of output when there
is no error (setpoint = Input). It is a constant value that
is applied to the control loop to correct offsets. See the
block’s Bias input for more information (Figure 250).
RampTime Sets the maximum rate of change in seconds for the
Output to go from 0% to 100%. See the block’s
RampTime input for more information (Figure 252).
Saturation Time When either SaturationTimeHighLimitEnable,
SaturationTimeLowLimitEnable, or both are enabled,
this sets the time delay in seconds, after which the
SaturationStatus output can indicate the saturation
status.
370 EC-gfxProgram
Parameter Description
Reverse action If deselected, the control loop acts directly. Thus an
increase in the error will be directly proportional to the
output (the more positive the error; the more positive
the output).
When selected, the control loop acts in reverse. Thus
an increase in the error will be inversely proportional to
the increase in the output (the more positive the error;
the more negative the output).
Saturation high When enabled, and the block’s output remains at 100%
limit enable output (at saturation) for a time period longer than that
set by SaturationTime, the SaturationStatus output
becomes 3.
Saturation low When enabled, and the block’s output remains at 0%
limit enable output (at saturation) for a time period longer than that
set by SaturationTime, the SaturationStatus output
becomes 2.
Pid Loop The Pid Configuration window provides an interface giving full control of the
configuration proportional, integral, and derivative parameters. See also Tuning a PID Loop.
theory
The output of a PID loop is defined by the following equations:
P = Proportional part of PID Output
I = Integral part of PID Output
D = Derivative part of PID Output
B = Bias part of PID Output
GP = Proportional gain (100/PB; PB = Proportional band)
E = Error (Input – Setpoint)
GI = Integral gain
EC-gfxProgram 371
TI = Integral time
∫Edt = Integral of Error with respect to time
GD = Derivative gain
TD = Derivative time
dE/dt = Derivative of Error with respect to time
The following graphs illustrate the effect of Proportional (P), Proportional-Inte-
gral (PI) and Proportional-Integral-Derivative (PID) control on a control point:
Figure 254: Proportional (P) control
With proportional (P) only control, the output is a function of the error or differ-
ence between the control point and setpoint. The control point eventually sta-
bilizes, but most often not on the setpoint, creating an offset.
Figure 255: Proportional-Integral (PI) control
372 EC-gfxProgram
With proportional-integral (PI) control, the control point eventually stabilizes
on the setpoint, eliminating the offset, but there is still a significant overshoot.
Figure 256: Proportional-Integral-Derivative (PID) control
With proportional-integral-derivative (PID) control, the control point stabilizes
on the setpoint faster than with PI control and overshoot is reduced.
Figure 257: Pid Configuration window
Parameter Description
Proportional See the Description for the ProportionalBand block
band input above.
Integral time See the Description for the IntegralTime block input
above.
Derivative time See the Description for the DerivativeTime block input
above.
Dead band See the Description for the DeadBand block input
above.
Bias See the Description for the Bias block input above.
Ramp time See the Description for the RampTime block input
above.
Saturation time See the Description for the SaturationTime block input
above.
EC-gfxProgram 373
Parameter Description
Reverse action If deselected, the control loop acts directly. Thus an
increase in the error will be directly proportional to the
output (the more positive the error; the more positive
the output).
When selected, the control loop acts in reverse. Thus
an increase in the error will be inversely proportional to
the increase in the output (the more positive the error;
the more negative the output).
NOTE: A change to this setting requires that the project
code be synchronized with the controller for this
change to take effect. See Project Synchroniza-
tion.
Saturation time See the Description for the
low limit enabled SaturationTimeLowLimitEnabled block input above.
Saturation time See the Description for the
high limit SaturationTimeHighLimitEnabled block input above.
enabled
NOTE: To setup and tune a PID loop, see Tuning a PID Loop for further infor-
mation.
Feedback input Figure 258: Control diagram for this example
example
Often two PID loops are used and their calculations are coupled together. This
example controls the Outside Air Damper (OAD) by choosing the minimum
between a Discharge Air Temperature (DAT) PID loop calculation and Mixed
Air Temperature (MAT) PID loop calculation. The outputs of the two PID
blocks are selected by a minimum block before the signal goes to the analog
output.
When the Output of the Mixed Air Temperature PID block is less than the
Output of the Discharge Air Temperature PID block, the Minimum block
selects the Mixed Air Temperature as the output to control the Outside Air
Damper (to protect the coil from freezing). Under this condition, due to the
Feedback input of the Discharge Air Temperature PID block, the Output of
this PID is reset to be the value of the Output of the Mixed Air Temperature
374 EC-gfxProgram
PID block plus any proportional, integral, derivative movement based on the
block’s other inputs.
Figure 259: Pid Loop project code example showing the use of the Feedback input
Pid Loop (ECB & ECY Series)
Description Used to provide a proportional, integral, and derivative (PID) loop control.
Each Pid Loop block is linked to a corresponding network variable (BACnet
object) which follows the same value as the PID block.
The Pid Loop values are configured in the Pid Loop configuration theory win-
dow. However, during runtime, the PID loop values can be modified through a
network property (BACnet object), through the controller’s operator interface
or through the connected ECx-Display (when equipped), through the Live
Trend Log (see below), or through project code (by linking project code to a
PID block’s ProportionalBand, IntegralTime, or DerivativeTime input
ports). When an input port is linked to code, the corresponding network prop-
erty is set to Read Only and the controller’s operator interface / ECx-Display
(when equipped) and Live Trend Log cannot be used to modify the parameter.
• For ECB Series controllers: If the input port is later disconnected, the con-
troller must be rebooted or the option Reset PIDS selected during Project
Synchronization to make the associated network property writable again
so that the parameter can be modified in the controller’s operator inter-
face / ECx-Display.
• For ECY Series controllers: If the input port is later disconnected, the
associated network property is automatically made writable again so that
the parameter can be modified in the controller’s operator interface / ECx-
Display.
EC-gfxProgram 375
A Live Trend Log of the response of the PID loop’s Input, Setpoint, and Out-
put can be used to view a graph of these variables so as to help with PID loop
tuning. While Debugging a project, right-click the Pid Loop block and select
View Trend Log. See Viewing a Live Trend Log. The PID loop’s advanced
configuration parameters can be set within the Live Trend Log, when the
parameter is not being set at the block’s corresponding input port.
Number of For ECB Series controllers: The number of Pid Loop block instances sup-
blocks ported by a controller is shown in the Number drop-down list in the Properties
or Statistics panes.
For ECY Series controllers: see Supported number of BACnet objects with an
ECY Series controller.
Persistence For ECY Series controllers: Allows the input values to be saved during a con-
troller power cycle or reset. See Persistent values (ECL, ECB & ECY Series
controllers).
Advanced Resources Configuration, Advanced configuration, Pid Loop configuration
configuration theory, Network Properties Configuration window (ECL, ECB & ECY Series),
Viewing a Live Trend Log, Override and auto, Find All References (ECL, ECB
& ECY Series), Copy From, Configure Ports, Show/Hide Ports, Tuning a PID
Loop
Related blocks Generic Pid Loop (ECL, ECB & ECY Series), Live Trend Log
Input(s)
Port Type Range Description
Input Numeric ±3.4028 ×1038 Block input.
Setpoint Numeric ±3.4028 ×1038 The setpoint.
376 EC-gfxProgram
Port Type Range Description
Feedback Numeric 0 to 100 This is a feedback input of the actual control signal
being sent to the process being controlled.
For example, between the PID block output and the
Hardware Output (ECB & ECY Series), blocks can
be used to further process the signal. When the
process being controlled is overridden, a PID block
will normally integrate either to 0% or 100%. This
results in a surge when the override is removed. By
providing the override signal to this input (the value
at the analog output for example), once the override
is removed, the block’s output will smoothly resume
operation starting from the last override value over
to PID loop control.
While the Pid block detects a difference between the
Output output and the Feedback input, the
integration function of the PID loop is suspended.
See To setup and tune a PID loop, see Tuning a PID
Loop for further information..
Proportional Numeric 0.001 to 3.4028 The proportional band is the error value that is
Band ×1038 necessary to span the extent of the output range, to
move the output from 0 to 100%. The proportional
gain is the instantaneous effect of the error on the
output. The proportional gain and proportional band
have the following relationship: proportional gain =
100/(proportional band).
For example, If the proportional band is set to 2ºF,
then a 2ºF error (deviation from the setpoint) will
result in 100% output. The proportional band is
sometimes referred to as a "throttling range" or
"modulating range".
IntegralTime Numeric 0 to 3.4028 The integral time is a factor of the effect of the error
×1038 (deviation from setpoint) over time. The integral time
determines how quickly the system responds to a
given error.
Derivative Numeric 0 to 3.4028 The derivative time determines the effect of the
Time ×1038 derivative action on the system response. The
derivative time is sometimes referred to as "rate
time".
EC-gfxProgram 377
Port Type Range Description
Deadband Numeric 0 to 3.4028 The dead band is a range (centered on the setpoint)
×1038 in which no corrective action is taken, that is, the
output of the PID loop remains the same.
For example, the graph below shows the effect of a
2°F dead band on a Pid loop that has a proportional
band of 4°F. The setpoint is 72°F. The dead band is
2°F centered on the setpoint and thus the output of
the Pid loop does not change when the input is
between 71 and 73°F. No matter how the Pid loop is
configured (change to proportional, integral,
derivative control or bias represented by the dashed
lines) the dead band remains centered on the
setpoint.
Figure 260: Effect of 2°C Dead Band on Pid
378 EC-gfxProgram
Port Type Range Description
Bias Numeric 0 to 100 The bias is the default percentage of output when
there is no error (setpoint = Input). It is a constant
value that is applied to the control loop to correct
offsets.
For example, the graph below shows the effect of a
50% bias on a Pid loop that has a proportional band
of 4°F. The setpoint is 72°F. The bias is 50% and
thus the total output of the Pid loop is increased by
50% so that previously a 72°F input temperature
resulted in an output of 0% and now results in an
output of 50%.
Figure 261: 0% Bias on Pid
Figure 262: 50% Bias on Pid
EC-gfxProgram 379
Port Type Range Description
RampTime Numeric 0 to 3.4028 Sets the maximum rate of change in seconds for the
×1038 Output to go from 0% to 100%.
For example, if this input is set to 120 seconds, and
the Enabled input port changes from False to True,
the block’s Output will take at least 120 seconds to
ramp up from 0% to 100%. As such, if the PID loop
calculates a required Output of 50%, it will take the
Output at least 60 seconds to go from 0% to 50%.
This is shown below.
Figure 263: Example: 50% RampTime Effect on Pid
Output
Saturation Numeric 0 to 3.4028 When either SaturationTimeHighLimitEnable,
Time ×1038 SaturationTimeLowLimitEnable, or both are
enabled, this sets the time delay in seconds, after
which the SaturationStatus output can indicate the
saturation status.
Action Digital 0 or 1 If deselected, the control loop acts directly. Thus an
increase in the error will be directly proportional to
the output (the more positive the error; the more
positive the output). When selected, the control loop
acts in reverse. Thus an increase in the error will be
inversely proportional to the increase in the output
(the more positive the error; the more negative the
output).
Saturation Digital 0 or 1 When enabled, and the block’s output remains at
TimeHigh 100% output (at saturation) for a time period longer
LimitEnable than that set by SaturationTime, the
SaturationStatus output becomes 3.
Saturation Digital 0 or 1 When enabled, and the block’s output remains at
TimeLow 0% output (at saturation) for a time period longer
LimitEnable than that set by SaturationTime, the
SaturationStatus output becomes 2.
Enabled Digital 0 or 1 Used to enable or disable the block. Setting this to 0
disables the block while setting it to 1 enables the
block. If the block is disabled, the output is set to 0.
380 EC-gfxProgram
Output(s)
Port Type Range Description
Output Numeric 0 to 100 The PID loop output. If no Input to this block is
Null, then the block’s output is the normal result. If
one or more Inputs to this block are Null, then the
Output of this block is always Null.
Saturation Digital 1, 2, or 3 The block’s output is:
Status
1: Normal. The output is unsaturated or either
SaturationTimeHighLimitEnable or
SaturationTimeLowLimitEnable or both are not
enabled.
2: Low saturation. The output is saturated at 0%
for a time period longer than that set by
SaturationTime and
SaturationTimeLowLimitEnable (see above) is
enabled.
3: High saturation. The output is saturated at
100% for a time period longer than that set by
SaturationTime and
SaturationTimeHighLimitEnable (see above) is
enabled.
Number Integer – The current block number.
OutOfService Digital 0 or 1 See Out-of-Service.
Fault Digital 0 or 1 This is logically True (1) if the Reliability property
does not have a value of No Fault Detected,
otherwise logical False (0).
Overridden Digital 0 or 1 When the block is disabled (the Enabled input is
set to 0), the block is overridden and, this output
becomes logically True (1), otherwise logical
False (0).
Reliability Enum See When either the Check out of range or the
Description Check signal fault in the Advanced
Configuration is set (or both are set), this
provides an indication of whether the physical
input is "reliable" and, if not, why. See Reliability
Property.
EC-gfxProgram 381
Block properties See also Common block properties.
Property Type Range Default Description
Number Menu See Pid 1 Use this drop-down menu to select an
Description instance of this block. See Number of
blocks for the number of block instances
supported by the current controller
model. This drop-down list also provides
a summary overview of the current
configuration parameters of all Pid
blocks.
NOTE: When a new block instance is
added to the programming
sheet, the block’s number is
incremented to the next avail-
able block number according to
the current Auto Increment set-
ting. See Auto increment (ECP
& ECL Series and EBC Series
controllers only) or Auto incre-
ment (ECY Series controllers
only).
Advanced configuration
Configuration parameters for this block are set in the Resources Configura-
tion window.
Figure 264: Resources Configuration, Pid Loop configuration parameters
382 EC-gfxProgram
The Pid resource has specific parameters to configure. See also Pid Loop
(ECL Series).
Parameter Description
Input unit The unit for the Pid Loop input.
Proportional The proportional band is the error value that is
Band necessary to span the extent of the output range, to
move the output from 0 to 100%. The proportional gain
is the instantaneous effect of the error on the output.
The proportional gain and proportional band have the
following relationship: proportional gain = 100/
(proportional band).
For example, If the proportional band is set to 2ºF, then
a 2ºF error (deviation from the setpoint) will result in
100% output. The proportional band is sometimes
referred to as a "throttling range" or "modulating
range".
IntegralTime The integral time is a factor of the effect of the error
(deviation from setpoint) over time. The integral time
determines how quickly the system responds to a given
error.
Derivative Time The derivative time determines the effect of the
derivative action on the system response. The
derivative time is sometimes referred to as "rate time".
Deadband The dead band is a range (centered on the setpoint) in
which no corrective action is taken, that is, the output of
the PID loop remains the same. See the block’s
Deadband input for more information (Figure 260).
Bias The bias is the default percentage of output when there
is no error (setpoint = Input). It is a constant value that
is applied to the control loop to correct offsets. See the
block’s Bias input for more information (Figure 261).
RampTime Sets the maximum rate of change in seconds for the
Output to go from 0% to 100%. See the block’s
RampTime input for more information (Figure 263).
Saturation Time When either SaturationTimeHighLimitEnable,
SaturationTimeLowLimitEnable, or both are enabled,
this sets the time delay in seconds, after which the
SaturationStatus output can indicate the saturation
status.
EC-gfxProgram 383
Parameter Description
Reverse action If deselected, the control loop acts directly. Thus an
increase in the error will be directly proportional to the
output (the more positive the error; the more positive
the output).
When selected, the control loop acts in reverse. Thus
an increase in the error will be inversely proportional to
the increase in the output (the more positive the error;
the more negative the output).
Saturation high When enabled, and the block’s output remains at 100%
limit enable output (at saturation) for a time period longer than that
set by SaturationTime, the SaturationStatus output
becomes 3.
Saturation low When enabled, and the block’s output remains at 0%
limit enable output (at saturation) for a time period longer than that
set by SaturationTime, the SaturationStatus output
becomes 2.
Feedback input See To setup and tune a PID loop, see Tuning a PID Loop for further informa-
example tion.
Ramp
Description Used to increase and/or decrease an input’s value at a specified rate. Often
used to slowly start a system at a user-defined rate.
If the rate of increase of the input is greater than that of the ramp up, then the
block will output the ramp value or else it will simply output the input value. If
the rate of decrease of the input is greater than the rate of decrease of the
ramp down, then the block will output the ramp value or else it will simply out-
put the input value.
Advanced Configure Ports, Show/Hide Ports
configuration
384 EC-gfxProgram
Input(s)
Port Type Range Description
32-Bit 8-Bit
Input Numeric ±3.4028×1038 -83886.08 to Block input.
+83886.07
RampUp% Numeric 0 to 3×1038 0 to 83886 Rate of ramp up per
RampUpTm. A negative input
value is internally converted to
an absolute (positive) value.
RampUpTm Integer 0 to 3×1038s 0 to 83886s Time that the Output will ramp
up to the RampUp%. To disable
0 to 1398m
0 to 5×1036m the Ramp Up feature, set the
0 to 22h RampUp% to any non-zero
0 to
value and RampUpTm to 0.
8.3333×1034h
RampDown% Numeric 0 to 0 to Rate of ramp down per
3.4028×1038 83886.07 RampDownTm. A negative
input value is internally
converted to an absolute
(positive) value.
RampDown Tm Integer 0 to 3×1038s 0 to 83886s Time that the Output will ramp
down to the RampDown%. To
0 to 1398m
0 to 5×1036m disable the Ramp Down
0 to 22h feature, set the RampDown%
0 to
to any non-zero value and
8.3333×1034h RampDownTm to 0.
Enabled Digital 0 or 1 Used to enable or disable the
block. Setting this to 0 disables
the block while setting it to 1
enables the block. If the block is
disabled, the Output equals the
Input.
EC-gfxProgram 385
Outout(s)
Port Type Range Description
32-Bit 8-Bit
Output Numeric ±3.4028×1038 -83886.08 to Block output.
+83886.07
For ECL, ECB & ECY Series
controllers: If no Input to this
block is Null, then the block’s
output is the normal result. If
one or more Inputs to this block
are Null, then the Output of this
block is always Null.
Block properties See also Common block properties.
Property Type Range Default Description
TimeBase Menu See Second Select the unit of time: Second, Minute or
Description Hour.
NOTE: The TimeBase unit affects the value
ranges of RampUpTm and Ramp-
DownTm.
If the TimeBase is set to minutes, 59
seconds will be shown as 0.98 min-
utes.
Example The Ramp block can be used to slowly modulate a cooling valve on system
startup. The example below shows how the opening of a Cooling Valve (Hard-
ware Output block) is ramped up (Ramp block) to 100% in 2 minutes (Inter-
386 EC-gfxProgram
nal constant blocks) based on the Supply Air Temperature (Hardware Input,
Pid, Internal Constant block).
Figure 265: Ramp block example
Figure 266: Input, Ramp Up, Output relationship
The Ramp block receives its Input from a Pid block for Supply Air Tempera-
ture (Hardware Input block). The Ramp block then increases at a rate of
100% over 2 minutes and outputs this to a Cooling Valve (Hardware Output
block). The graph above shows that the Ramp block outputs the Ramp Up
value up until the Input value intersects with the Ramp Up value and falls
below it. At that point the Ramp block outputs the Input value. The Pid and
Ramp blocks are enabled when the occupied mode is scheduled. The Ramp
block is disabled when the Output of the Ramp block is less than or equal to
the Output of the Pid block.
EC-gfxProgram 387
Rising Edge
Description Output pulses On if the input goes from Off to On (any non-zero value). The
output will remain On for the duration of one code execution. This is used to
do a one-shot execution (pulse) upon an Off to On transition.
Advanced Configure Ports, Show/Hide Ports
configuration
Related blocks Falling Edge
Input(s)
Port Type Range Description
Input Digital 0 or 1 Block input.
Output(s)
Port Type Range Description
Output Digital 0 or 1 Block output.
For ECL, ECB & ECY Series controllers: If no Input to
this block is Null, then the block’s output is the normal
result. If one or more Inputs to this block are Null, then
the Output of this block is always Null.
Block properties See Common block properties.
388 EC-gfxProgram
Example The Rising Edge block can be used to pulse an On value when it receives an
Off to On Input value. The example below shows how a Ramp block is
enabled (Rising Edge and Latch block) based on the Schedule being occu-
pied (Equal and Internal Constant block).
Figure 267: Rising Edge block example
The Rising Edge block receives its Input from an Equal block that compares
the CurrentState of a Schedule block to an Internal Constant block set as
occupied. When this comparison is true, the Rising Edge block pulses an On
value on its Output. This On value is then used by a Latch block to enable the
Ramp block.
Startup
Description Used for program initialization and to output a true value at the first code exe-
cution (after a reset or power up).
Slim format This block can be collapsed into a slim format. See Collapsed in Common
support block properties.
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s) N/A
Output(s)
Port Type Range Description
Output Digital 0 or 1 Startup value.
Block properties See Common block properties.
EC-gfxProgram 389
Example The Startup block is used to output an On value at the first code execution.
The example below shows how an Effective Static Pressure Setpoint (Vari-
able Numeric (ECP Series) block) is initialized at startup (Startup and Switch
block) with a Constant Static Pressure Setpoint (Constant Numeric (ECP
Series) block).
Figure 268: Startup block example
The Startup block pulses an On value at the first code execution then remains
Off until the next reset. This On value is received by a Switch block and out-
puts the Constant Static Pressure Setpoint (Constant Numeric block). For
the remainder of the code execution, the Switch block outputs the Effective
Static Pressure Setpoint (Variable Numeric block), which is governed by a
separate algorithm.
390 EC-gfxProgram
Toggle
Description Used for a push button logic input (for example, a push to start, push to stop
function). If the output is Off, a rising edge to the Toggle input will set the out-
put to On and hold this value until the next rising edge to the Toggle input. If
the output is On, a rising edge to the Toggle input will set the output to Off and
hold this value until the next rising edge to the Toggle input. A rising edge to
the Reset input forces the output to Off and hold this value until the next rising
edge to the Toggle input.
Toggle Reset Output
0 0 No change
1 0 0 or 1
0 1 0
1 1 0
Persistence For ECL, ECB & ECY Series controllers, the current value is persistent; this
allows a value to be saved during a controller power cycle or reset. See Per-
sistent values (ECL, ECB & ECY Series controllers).
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
Toggle Digital 0 or 1 Toggle input. If Output is Off and Toggle turns On, Output
turns On. If Output is On and Toggle turns On, Output
turns Off.
EC-gfxProgram 391
Port Type Range Description
Reset Digital 0 or 1 Reset input. If On, Output turns Off.
Output(s)
Port Type Range Description
Output Digital 0 or 1 Block output.
For ECL, ECB & ECY Series controllers: If no Input to this
block is Null, then the block’s output is the normal result. If
one or more Inputs to this block are Null, then the Output of
this block is always Null.
Block properties See Common block properties.
Property Type Range Default Description
Persist Menu See False When this option is True, the output state is
Description preserved during any type of reset. See
Persistent values (ECL, ECB & ECY Series
controllers).
392 EC-gfxProgram
About When Persist is set for a new block, you must reset the persistent value that
persistence is associated with the block after the project code has been sent to the device.
The application cannot really determine if the persistent value that is stored in
the controller is the one you want. So a manual operation is required to reset
this value the first time you setup it on a block. Proceed as follows to do so:
1. Create your project code with your Toggle block.
2. Setup Persist for the block.
3. Build the project code and send it to the device.
4. Start debugging: Click the Start button on the Home ribbon, Debugging
buttons.
5. Right-click on the block and select Reset Persistent Value.
NOTE: The Persist option is intended to be used with a momentary contact,
push button input. If Persist is set for a Toggle block, and the device is
reset or undergoes a power Off /On cycle during which the Toggle
input remains at On (1), the output of this block will toggle due to this
event.
The output does not toggle if the Toggle input is Off (0) and the device
is reset or undergoes a power Off /On cycle.
Example The Toggle block can be used for toggle switching operations in which a reset
is required. The example below shows how an Exhaust Fan (Hardware Out-
put block) is toggled (Toggle block) On and Off by a Push Button (Hardware
Input block). The system is shut down when the schedule (Schedule block)
becomes (Equal block) Unoccupied (Internal constant block).
Figure 269: Toggle block example
The Toggle block receives its Toggle command from a Hardware Input block
and its Reset command from an Equal block. The Equal block compares the
occupancy from the Schedule block to the set occupancy from the Internal
Constant block. Thus the output of the Equal block will only be True when the
unoccupied mode is scheduled. When the Equal block is True, the Toggle
block is reset and the Exhaust Fan (Hardware Output block) is turned Off.
Assuming that the Reset of the Toggle block is Off, if the Exhaust Fan Push
Button (Hardware Input block) is turned On, the Exhaust Fan (Hardware
Output block) will turn On if it was Off and turn Off if it was On.
EC-gfxProgram 393
Weather (ECB & ECY Series)
Description Provides weather information to EC-gfxProgram code. For this block to work
the controllers must be able to receive BACnet weather information from the
network through any of the following methods.
• BACnet weather information is made available to the controller through a
connected EC-Net controller. For a EC-Net controller, the WeatherSer-
vice must first be configured to do this - see Configuring weather informa-
tion for controllers with an operator interface.
• In the case of an ECY Series Controller, the weather service is configured
in the controller’s configuration Web interface. For more information, refer
to the ECLYPSE User Guide. It is not necessary to enable or configure an
ECY Series Controller’s weather service if the BACnet weather informa-
tion is being made available to the controller through a connected EC-Net
controller.
394 EC-gfxProgram
Input(s)
Port Type Range Description
Day Enum 0 This selects the day for which this block is to output
values for: the current weather (currentCondition) and
1
weather forecast for today (today) and up to six days
2 from now (inSixDays). When Day is greater than 0, not
all block forecast condition outputs will be available.
3
0 = currentCondition: The current weather conditions.
4
1 = today: Today’s weather forecast conditions.
5
2 = tomorrow: Tomorrow’s weather forecast
6
conditions.
7
3 = afterTomorrow: weather forecast conditions in two
days time.
4 = inThreeDays: weather forecast conditions in three
days time.
5 = inFourDays: weather forecast conditions in four
days time.
6 = inFiveDays: weather forecast conditions in five
days time.
7 = inSixDays: weather forecast conditions in six days
time.
Output(s)
Port Type Range Description
LastUpdate Integer 0000 to 9999 The year of the last weather information update.
Year
LastUpdate Integer 1 to 12 The month of the last weather information
Month update.
LastUpdate Integer 1 to 31 The day of the last weather information update.
Day
LastUpdate Integer 0 to 23 The hour of the last weather information update.
Hour
LastUpdate Integer 0 to 59 The minute of the last weather information
Minute update.
LastUpdate Integer 0 to 59 The second of the last weather information
Second update.
DateYear Integer 0000 to 9999 According to the Day input value, this is the
year.
EC-gfxProgram 395
Port Type Range Description
DateMonth Integer 1 to 12 According to the Day input value, this is the
month.
DateDay Integer 1 to 31 According to the Day input value, this is the
current day of the month.
SunriseHour Integer 0 to 23 According to the Day input value, this is the
sunrise hour for that day.
Sunrise Minute Integer 0 to 59 According to the Day input value, this is the
sunrise minute for that day.
Sunrise Integer 0 to 59 According to the Day input value, this is the
Second sunrise second for that day.
SunsetHour Integer 0 to 23 According to the Day input value, this is the
sunset hour for that day.
SunsetMinute Integer 0 to 59 According to the Day input value, this is the
sunset minute for that day.
Sunset Second Integer 0 to 59 According to the Day input value, this is the
sunset second for that day.
Temperature Numeric Weather This is the current outdoor temperature.
Service value
When the Day input is greater than 0, this output
in Fahrenheit
is null (this parameter is not forecasted).
or Celcius
Temperature Numeric Weather According to the Day input value, this is the
High Service value maximum temperature for that day.
in Fahrenheit
or Celcius
Temperature Numeric Weather According to the Day input value, this is the
Low Service value minimum temperature for that day.
in Fahrenheit
or Celcius
Precipitation Integer 0 to 100% According to the Day input value, this is the
Chance chance of precipitation for that day.
396 EC-gfxProgram
Port Type Range Description
Summary Enum 0 According to the Day input value, this is the
weather summary for that day.
1
0 = Clear
2
1 = Sunny
3
2 = Mostly Sunny
4
3 = Partly Sunny
5
4 = Fair
6
5 = A Few Clouds
7
6 = Partly Cloudy
8
7 = Mostly Cloudy
9
8 = Cloudy
10
9 = Overcast
11
10 = Light Rain
12
11 = Rain
13
12 = Heavy Rain
14
13 = Thunderstorms
15
14 = Freezing Rain
16
15 = Fog
17
16 = Haze
18
17 = Snow
19
18 = Windy
20
19 = Misty
21
20 = Dust
22
21 = Unknown
23
22 = Tsunami
24
23 = Tornado
25
24 = Flood
26
25 = Fire
27
26 = Hurricane
28
27 = Earthquake
28 = Volcano
Humidity Integer 0 to 100% RH This is the current outdoor relative humidity.
When the Day input is greater than 0, this output
is null (this parameter is not forecasted).
EC-gfxProgram 397
Port Type Range Description
WindDirection Enum 0 This is the current wind direction.
1 0 = North
2 1 = Northeast
3 2 = East
4 3 = Southeast
5 4 = South
6 5 = Southwest
7 6 = West
8 7 = Northwest
8 = Variable
When the Day input is greater than 0, this output
is -1 (this parameter is not forecasted).
WindSpeed Integer Weather This is the current wind speed.
Service value
When the Day input is greater than 0, this output
in mph or km/h
is null (this parameter is not forecasted).
WindGust Integer Weather This is the current wind gust speed.
Service value
When the Day input is greater than 0, this output
in mph or km/h
is null (this parameter is not forecasted).
WindChill Numeric Weather This is the current windchill temperature.
Service value
When the Day input is greater than 0, this output
in Fahrenheit
is null (this parameter is not forecasted).
or Celcius
Pressure Numeric Weather This is the current barometric pressure.
Service value
When the Day input is greater than 0, this output
in inches
is null (this parameter is not forecasted).
mercury or kPa
DewPoint Numeric Weather This is the current dewpoint temperature.
Service value
When the Day input is greater than 0, this output
in Fahrenheit
is null (this parameter is not forecasted).
or Celcius
Block properties See Common block properties.
398 EC-gfxProgram
Generics
Generic blocks represent multiple instantiations of their root or base type. The
generic block’s Number input selects the instance identity at any moment that
the generic block is to assume. The For Loop (ECL, ECB & ECY Series) block
is ideal for use with a generic block as it cycles through a range of numbers
allowing the generic block to go through each of its instantiations.
Generic blocks are also useful for creating toolboxes since they allow reading
and writing to resource blocks inside toolboxes, which is not possible using
the standard blocks.
The following blocks are available in this category:
• Generic Analog Value (ECB & ECY Series)
• Generic Binary Value (ECB & ECY Series)
• Generic Boolean Value (ECL Series)
• Generic ComSensor Condition (ECL, ECB & ECY Series)
• Generic ComSensor Value (ECL, ECB & ECY Series)
• Generic Internal Variable (ECL, ECB & ECY Series)
• Generic Boolean Constant (ECL Series)
• Generic Enum Constant (ECL Series)
• Generic Enum Value (ECL Series)
• Generic Floating Output (ECL Series)
• Generic Floating Output (ECB & ECY Series)
• Generic Hardware Input (ECL Series)
• Generic Hardware Input (ECB & ECY Series)
• Generic Hardware Output (ECL Series)
• Generic Hardware Output (ECB & ECY Series)
• Generic Network Value (ECB & ECY Series)
• Generic Network Variable Input (ECL Series)
• Generic Network Variable Output (ECL Series)
• Generic Numeric Constant (ECL Series)
• Generic nLight Channel (ECY Series)
• Generic Numeric Value (ECL Series)
• Generic Pid Loop (ECL, ECB & ECY Series)
• Generic Timer (ECL Series)
• Generic Timer (ECB & ECY Series)
EC-gfxProgram 399
Generic Analog Value (ECB & ECY Series)
Description Used to provide access to any instance of an Analog Value block through the
Number input.
Each Analog Value block is linked to a corresponding BACnet object which
follows the same value as the Analog Value block. The corresponding Analog
Values that are used with this block must have their advanced configuration
set. This is done in the:
• Resource Viewer in the Bacnet Objects tab, set the View Mode to All,
and right-click an Analog Value to select Configure.
• Resources Configuration window by double-clicking the block.
For more information about the advanced configuration settings of an Analog
Value block, see Analog Value (ECB & ECY Series).
Advanced Configure Ports
configuration
For more information about BACnet objects, see BACnet objects, services,
and data priority, Reading and writing network points, and Commandable
object priority array levels.
Related blocks Analog Value (ECB & ECY Series)
Input(s)
Port Type Range Description
Number Numeric 1 to n Selects the Analog Value block instance to assume.
Where n is the maximum number of Analog Values
supported by the current controller model. See the
Resource Viewer for the available number of Analog
Value blocks.
Input Numeric ±3.4028×1038 Block input. The value to write.
NOTE: Persistence is not available when writing to
the input of this block. Persistence is only
available when the value is written directly to
the Input of the Analog Value (ECB & ECY
Series) block.
400 EC-gfxProgram
Port Type Range Description
Priority Integer 1 to 16 For a Commandable Value only, the value at the
Input is written at the priority level specified at this
input. If a value is not linked to this input, the value
at the Input is written into the default priority level.
See Commandable object priority array levels.
Trigger Digital 0 or 1 When Broadcast Mode in the Resources
Broadcast Configuration for this block is set to Local or Global,
(ECY Series this port becomes available. A pulse at this input
controllers triggers a broadcast of the object’s present value on
only) the local network or global networks. See Broadcast
mode.
Alarm Numeric ±3.4028×1038 When alarms are enabled for this block (see Alarms
Setpoint (B- (ECB & ECY Series)), a positive input value
AAC and B- increases the alarm setpoint values set in the
BC Resources Configuration’s Alarms configuration for
controllers the block (a negative value reduces the alarm
only) setpoint values): The High limit is now the High
limit value (set in the Resources Configuration’s
Alarms configuration for the block) plus
AlarmSetpoint and the Low limit is now the Low
limit value (set in the Resources Configuration’s
Alarms configuration for the block) plus
AlarmSetpoint. See Dynamic alarm activation
thresholds adjust.
NOTE: When the AlarmSetpoint input is discon-
nected, you must reset the controller (see
Project Synchronization) or connect a Null
value (ECL, ECB & ECY Series)block to this
port so the controller will release this port as
being unconnected.
When the AlarmSetpoint input is discon-
nected, the High limit and Low limit can be
written to through the BACnet interface.
Output(s)
Port Type Range Description
Output Numeric ±3.4028×1038 Block output. The Present Value.
OutOfService Digital 0 or 1 See Out-of-Service.
Fault (ECY Digital 0 or 1 For the output: This is logically True (1) if the
Series Reliability property does not have a value of No
controllers Fault Detected, otherwise logical False (0).
only)
EC-gfxProgram 401
Port Type Range Description
Priority Integer 1 to 16 The current active priority for commandable objects.
See Commandable object priority array levels.
Update Digital 0 or 1 Outputs a pulse when a value is written to the
BACnet object.
InAlarm (B- Digital 0 or 1 For commandable instances (see Commandable
AAC and B- value) only: When Enable Alarms is set for a block
BC instance and the present value is outside of the
controllers High limit and Low limit settings and taking into
only) consideration the Dead band and Time delay
settings, this output is On (1). See Analog Value
(ECB & ECY Series) for more information about this
output. See Alarms (ECB & ECY Series) to
configure the alarm settings.
Block properties See Common block properties.
Example To use a Generic Analog Value block with a For Loop (ECL, ECB & ECY
Series) block, see For Loop block example for ECB & ECY Series controllers.
Generic Binary Value (ECB & ECY Series)
Description Used to provide access to any instance of a Binary Value block through the
Number input.
Each Binary Value block is linked to a corresponding BACnet object which fol-
lows the same value as the Binary Value block. The corresponding Binary Val-
ues that are used with this block must have their advanced configuration set.
This is done in the:
• Resource Viewer in the Bacnet Objects tab, set the View Mode to All,
and right-click a Binary Value to select Configure.
• Resources Configuration window by double-clicking the block.
For more information about the advanced configuration settings of a Binary
Value block, see Binary Value (ECB & ECY Series).
Advanced Configure Ports, Show/Hide Ports
configuration
402 EC-gfxProgram
Related Blocks Binary Value (ECB & ECY Series)
Input(s)
Port Type Range Description
Number Numeric 1 to n Selects the Binary Value (ECB & ECY Series)
instance to assume.
Where n is the maximum number of Binary Values
supported by the current controller model. See the
Number of resources supported by a controller for
the available number of Binary Value blocks.
Input Digital 0 or 1 Block input. The value to write.
NOTE: Persistence is not available when writing to
the input of this block. Persistence is only
available when the value is written directly to
the Input of the Binary Value (ECB & ECY
Series) block.
Priority Integer 1 to 16 For a Commandable Value only, the value at the
Input is written at the priority level specified at this
input. If a value is not linked to this input, the value
at the Input is written into the default priority level.
See Commandable object priority array levels.
Trigger Digital 0 or 1 When Broadcast Mode in the Resources
Broadcast Configuration for this block is set to Local or Global,
(ECY Series this port becomes available. A pulse at this input
controllers triggers a broadcast of the object’s present value on
only) the local network or global networks. See Broadcast
mode.
AlarmValue (B- Digital 0 or 1 When alarms are enabled for this block (see Alarms
AAC and B-BC (ECB & ECY Series)), this input overrides the alarm
controllers value set in the Resources Configuration’s Alarms
only) configuration for the block.
NOTE: When the AlarmValue input is discon-
nected, you must reset the controller (see
Project Synchronization) or connect a Null
value (ECL, ECB & ECY Series) block to this
port so the controller will release this port as
being unconnected.
When the AlarmValue input is discon-
nected, the alarm value property can be
overwritten through the BACnet interface.
ResetElapsedA Digital 0 or 1 A pulse at this input resets the timer for the
ctiveTime ElapsedActiveTime output (see below).
ResetChangeO Digital 0 or 1 A pulse at this input resets the counter for the
fStateCount ChangeOfStateCount output (see below).
EC-gfxProgram 403
Output(s)
Port Type Range Description
Output Digital 0 or 1 Block output. The Present Value.
OutOfService Digital 0 or 1 See Out-of-Service.
Fault (ECY Digital 0 or 1 For the output: This is logically True (1) if the
Series Reliability property does not have a value of No
controllers only) Fault Detected, otherwise logical False (0).
Priority Integer 1 to 16 The current active priority for commandable
objects. See Commandable object priority array
levels.
Update Digital 0 or 1 Outputs a pulse when a value is written to the
BACnet object.
InAlarm (B-AAC Digital 0 or 1 For commandable instances (see
and B-BC Commandable value) only: When Enable
controllers only) Alarms is set for this block and the block is in an
alarm state, this output is On (1). See Alarms
(ECB & ECY Series) to configure the alarm
settings.
Elapsed Numeric 3.4028×1038 Cumulates the time this value is set to true (1).
ActiveTime
(ECY Series
controllers only)
ChangeOf Numeric 3.4028×1038 Cumulates the number of this value’s state
StateCount changes.
(ECY Series
controllers only)
Block properties See Common block properties.
Property Type Range Default Description
Value Digital 0 or 1 0 Value of the block.
Example For an example of how to use a Generic block with a For Loop (ECL, ECB &
ECY Series) block, see For Loop block example for ECB & ECY Series con-
trollers.
404 EC-gfxProgram
Generic Boolean Value (ECL Series)
Description Used for True or False constant values. Mainly used for variable values
requiring monitoring. For a detailed description of this block’s configuration
parameters and features, see Boolean Value (ECL Series).
Advanced Configure Ports, Show/Hide Ports
configuration
Related blocks Boolean Value (ECL Series)
Input(s)
Port Type Range Description
Input Digital 0 or 1 Block input. The read value.
NOTE: Persistence is not available when writing to the
input of this block. Persistence is only available
when the value is written directly to the Input of
the Boolean Value (ECL Series) block.
Number Numeric 1 to n Selects the Boolean Value (ECL Series) block instance
to assume.
Where n is the maximum number of Boolean Values
supported by the current controller model. See the
Number of resources supported by a controller for the
available number of Boolean Value blocks.
Output(s)
Port Type Range Description
Output Digital 0 or 1 Block output. The read (Automatic) value or set Manual
value.
OutOfService Digital 0 or 1 See Out-of-Service.
Update Digital 0 or 1 Outputs a pulse when a value is written to the block.
Block properties See Common Block Properties.
EC-gfxProgram 405
Example For an example of how to use a Generic block with a For Loop (ECL, ECB &
ECY Series) block, see For Loop block example for ECL Series controllers.
For an example of using the For Loop block to fan in values from many con-
trollers, see Using LONWORKS network variables to fan in values from many
controllers.
Generic ComSensor Condition (ECL, ECB & ECY
Series)
Description Used to provide access to any instance of a ComSensor Condition block
through the Number input. For a detailed description of this block’s configura-
tion parameters and features, see ComSensor Condition (ECL, ECB & ECY
Series).
Advanced • ECL Series controllers: Configure Ports
configuration • ECB & ECY Series controllers: Using Scenes, Alarms (ECB & ECY
Series), Find All References (ECL, ECB & ECY Series), Copy From, Con-
figure Ports
Related blocks ComSensor (ECB & ECY Series), ComSensor (ECL Series), ComSensor
Value (ECL, ECB & ECY Series), ComSensor Condition (ECL, ECB & ECY
Series), ComSensor Condition Selector (ECL, ECB & ECY Series)
Input(s)
Port Type Range Description
Module Numeric 1 to n Selects the ComSensor Condition (ECL, ECB & ECY Series)
instance to assume.
Where n is the maximum number of ComSensors supported
by the current controller model. See the controller’s
datasheet for more information.
Number Numeric 1 to 15 Selects the Condition to assume.
Input Digital 0 or 1 Block input.
Outpu(s)
Port Type Range Description
Output Digital 0 or 1 Block output. The Present Value.
406 EC-gfxProgram
Block properties See Common block properties.
Generic ComSensor Value (ECL, ECB & ECY
Series)
Description Used to provide access to any instance of a ComSensor Value block through
the Number input. For a detailed description of this block’s configuration
parameters and features, see ComSensor Value (ECL, ECB & ECY Series).
Advanced Configure Ports, Show/Hide Ports
configuration
Related blocks ComSensor Value (ECL, ECB & ECY Series), ComSensor (ECB & ECY
Series), ComSensor (ECL Series), ComSensor Condition (ECL, ECB & ECY
Series), ComSensor Value Selector (ECL, ECB & ECY Series)
Input(s)
Port Type Range Description
Module Numeric 1 to n Selects the ComSensor Value (ECL, ECB & ECY
Series) instance to assume.
Where n is the maximum number of ComSensors
supported by the current controller model. See the
controller’s datasheet for more information.
Number Numeric 11 to 110 Selects the Value to assume. 11 to 40 for the 30 Local
Values and 41 to 110 for the 70 Global Values.
Input Numeric ±3.4028×1038 Block input.
Output(s)
Port Type Range Description
Output Numeric ±3.4028×1038 Block output. The Present Value.
Update Digital 0 or 1 Outputs a pulse when user activity updates a Value (a
button is pressed on the ComSensor).
Block properties See Common block properties.
EC-gfxProgram 407
Generic Internal Variable (ECL, ECB & ECY Series)
Description Used to provide access to any instance of an Internal Variable block through
the Number input. For a detailed description of this block’s configuration
parameters and features, see Internal variable (ECL, ECB & ECY Series).
Advanced Configure Ports, Show/Hide Ports
configuration
Related blocks Internal variable (ECL, ECB & ECY Series)
Input(s)
Port Type Range Description
Number Numeric 1 to n Selects the Internal variable (ECL, ECB & ECY Series)
instance to assume.
Where n is the maximum number of Internal Variables
supported by the current controller model. See the
Number of resources supported by a controller for the
available number of Internal Variable blocks.
Input Numeric ±3.4028×1038 Block input. The Internal variable (ECL, ECB & ECY
Series) value.
NOTE: Persistence is not available when writing to the
input of this block. Persistence is only available
when the value is written directly to the Input of
the Internal Variable block.
Output(s)
Port Type Range Description
Output Numeric ±3.4028×1038 Block output. The Present Value.
Block properties See Common block properties.
408 EC-gfxProgram
Generic Boolean Constant (ECL Series)
Description Used for True or False constant values. They can be formatted to a Boolean
value (True or False). For a detailed description of this block’s configuration
parameters and features, see Boolean Constant (ECL Series).
Advanced Configure Ports, Show/Hide Ports
configuration
Related blocks Boolean Constant (ECL Series)
Input(s)
Port Type Range Description
Number Numeric 1 to n Selects the Boolean Constant (ECL Series) block instance to
assume.
Where n is the maximum number of Boolean Constants
supported by the current controller model. See the Number
of resources supported by a controller for the available
number of Boolean Constant blocks.
Input Digital 0 or 1 Block input. The value to write.
NOTE: Persistence is not available when writing to the input
of this block. Persistence is only available when the
value is written directly to the Input of the Boolean
Constant (ECL Series) block.
Block properties See Common block properties.
Generic Enum Constant (ECL Series)
Description Used for enumeration constant values. They can be formatted to any stan-
dard enumeration. For a detailed description of this block’s configuration
parameters and features, see Enum Constant (ECL Series). Advanced con-
figuration
EC-gfxProgram 409
Configure Ports, Show/Hide Ports
Related blocks Enum Constant (ECL Series)
Input(s)
Port Type Range Description
Number Numeric 1 to n Selects the Enum Constant (ECL Series) block instance
to assume.
Where n is the maximum number of Enum Constants
supported by the current controller model. See the
Number of resources supported by a controller for the
available number of Enum Constant blocks.
Input Enum -128 to 127 Block input. The value to write.
NOTE: Persistence is not available when writing to the
input of this block. Persistence is only available
when the value is written directly to the Input of
the Enum Constant (ECL Series) block.
Output(s)
Port Type Range Description
Output Enum -128 to 127 Block output. The enumeration constant value.
Block properties See Common block properties.
Generic Enum Value (ECL Series)
Description Used for enumeration values. Mainly used for variable values requiring moni-
toring. For a detailed description of this block’s configuration parameters and
features, see Enum Value (ECL Series).
Advanced Configure Ports, Show/Hide Ports
configuration
Related blocks Enum Value (ECL Series)
410 EC-gfxProgram
Input(s)
Port Type Range Description
Input Enum -128 to 127 Block input. The read value.
NOTE: Persistence is not available when writing to
the input of this block. Persistence is only
available when the value is written directly to
the Input of the Enum Value (ECL Series)
block.
Number Numeric 1 to n Selects the Enum Value block instance to assume.
Where n is the maximum number of Enum Values
supported by the current controller model. See the
Number of resources supported by a controller for
the available number of Enum Value blocks.
Output(s)
Port Type Range Description
Output Enum -128 to 127 Block output. The read (Automatic) value or set
(Manual) value.
OutOfService Digital 0 or 1 See Out-of-Service.
Update Digital 0 or 1 Outputs a pulse when a value is written to the block.
Block properties See Common block properties.
Example For an example of how to use a Generic block with a For Loop (ECL, ECB &
ECY Series) block, see For Loop block example for ECL Series controllers.
For an example of using the For Loop block to fan in values from many con-
trollers, see Using LONWORKS network variables to fan in values from many
controllers.
EC-gfxProgram 411
Generic Floating Output (ECL Series)
Description Used to provide access to any instance of a Floating Output block through
the Number input.
Floating Output blocks that are used with this block must have their advanced
configuration set. This is done in the:
• Resource Viewer in the Hardware IOs tab, set the View Mode to All, and
right-click either Floating Output to select Configure.
• Resources Configuration window by double-clicking the block.
For more information about the advanced configuration settings of a Hard-
ware Input block, see Floating Output (ECL Series).
Advanced Configure Ports, Show/Hide Ports
configuration
Related blocks Floating Output (ECL Series)
Input(s)
Port Type Range Description
Number Numeric 1 to n Selects the Hardware Input instance to assume.
Where n is the current number of Floating Output (ECL
Series) blocks that have been configured. See the
Number of resources supported by a controller for the
available number of Floating Output blocks.
Position Numeric 0 to 100 The position demand for the floating actuator (in %).
Output(s)
Port Type Range Description
Position Numeric 0 to 100 The actual position of the actuator (in %).
412 EC-gfxProgram
Port Type Range Description
Close Digital 0 or 1 If 1, indicates that the floating actuator is closing. The
amount of close movement is determined by the
Position output.
Open Digital 0 or 1 If 1, indicates that the floating actuator is opening. The
amount of open movement is determined by the
Position output.
Block properties See Common block properties.
Generic Floating Output (ECB & ECY Series)
Description Used to provide access to any instance of a Floating Output block through the
Number input.
Floating Output blocks that are used with this block must have their advanced
configuration set. This is done in the:
• Resource Viewer in the Hardware IOs tab, set the View Mode to All, and
right-click either Floating Output to select Configure.
• Resources Configurationwindow by double-clicking the block.
For more information about the advanced configuration settings of a Hard-
ware Input block, see Floating Output (ECB & ECY Series).
Advanced Configure Ports, Show/Hide Ports
configuration
For more information about BACnet objects, see BACnet objects, services,
and data priority, Reading and writing network points, and Commandable
object priority array levels.
Related blocks Floating Output (ECB & ECY Series)
EC-gfxProgram 413
Input(s)
Port Type Range Description
Number Numeric 1 to n Selects the Hardware Input instance to assume.
Where n is the current number of Floating Output blocks
that have been configured. See the Number of
resources supported by a controller for the available
number of Floating Output blocks.
Position Numeric 0 to 100 The position demand for the floating actuator (in %).
Priority Integer 1 to 16 For a Commandable Value only, the value at the Input is
written at the priority level specified at this input. If a
value is not linked to this input, the value at the Input is
written into the default priority level. See Commandable
object priority array levels.
Output(s)
Port Type Range Description
Position Numeric 0 to 100 The actual position of the actuator (in %).
Close Digital 0 or 1 If 1, indicates that the floating actuator is closing. The
amount of close movement is determined by the Position
output.
Open Digital 0 or 1 If 1, indicates that the floating actuator is opening. The
amount of open movement is determined by the Position
output.
Block properties See Common block properties.
Generic Hardware Input (ECL Series)
Description Used to provide access to any instance of a Hardware Input block through the
Number input.
Hardware inputs that are used with this block must have their advanced con-
figuration set. This is done in the
414 EC-gfxProgram
• Resource Viewer in the Hardware IOs tab, set the View Mode to All, and
right-click a hardware input to select Configure.
• Resources Configuration window by double-clicking the block.
For more information about the advanced configuration settings of a Hard-
ware Input block, see Hardware Input (ECL Series).
Advanced Configure Ports, Show/Hide Ports
configuration
Related blocks Hardware Input (ECL Series)
Input(s)
Port Type Range Description
Number Numeric 1 to n Selects the Hardware Input instance to assume.
Where n is the maximum number of Hardware Inputs
supported by the current controller model. See the
Number of resources supported by a controller for the
available number of Hardware Input blocks.
ClrPulse Digital 0 or 1 For inputs configured for pulse counting, set this input
to True (1) to clear the pulse count.
Output(s)
Port Type Range Description
Output Digital 0 or 1 Block output. Whether the block will output a
digital value or a numeric value is dependent on
Numeric ±3.4028 ×1038 what type of Signal interpretation is selected in
the block’s Advanced configuration.
OutOfService Digital 0 or 1 See Out-of-Service.
Override Digital 0 or 1 When the Use override option is selected in the
Advanced configuration window; a shorted input is
interpreted as an override (Bypass) signal. The
Override output only emits a pulse, thus if it is
required to stay on for an extended period of time,
a Min On Time or Latch block should be used.
Fault Digital 0 or 1 When either the Check out of range or the
Check signal fault in the Advanced
Configuration is set (or both are set), this is
logically False (0) if the value of Reliability
property is No Fault Detected, otherwise logical
True (1).
EC-gfxProgram 415
Port Type Range Description
Reliability Enum See When either the Check out of range or the
Description Check signal fault in the Advanced
Configuration is set (or both are set), this
provides an indication of whether the physical
input is "reliable" and, if not, why. See Reliability
property.
Block properties See Common block properties.
416 EC-gfxProgram
Generic Hardware Input (ECB & ECY Series)
Description Used to provide access to any instance of a Hardware Input block through the
Number input.
Each Hardware Input block is linked to a corresponding BACnet object which
follows the same value as the Hardware Input block. Hardware inputs that are
used with this block must have their advanced configuration set. This is done
in the:
• Resource Viewer in the Hardware IOs tab, set the View Mode to All, and
right-click a hardware input to select Configure.
• Resources Configuration window by double-clicking the block.
For more information about the advanced configuration settings of a Hard-
ware Input block, see Hardware Input (ECB & ECY Series).
Advanced Configure Ports, Show/Hide Ports
configuration
Related blocks Hardware Input (ECB & ECY Series)
Input(s)
Port Type Range Description
Number Numeric 1 to n Selects the Hardware Input instance to assume.
Where n is the maximum number of Hardware Inputs
supported by the current controller model. See the
Number of resources supported by a controller for the
available number of Hardware Input blocks.
ClrPulse Digital 0 or 1 For inputs configured for pulse counting, set this input to
True (1) to clear the pulse count.
EC-gfxProgram 417
Port Type Range Description
AlarmValue Numeric ±3.4028 When alarms are enabled for this block (see Alarms
(B-AAC ×1038 (ECB & ECY Series)), a positive input value increases
and B-BC the alarm setpoint values set in the Resources
controllers Configuration’s Alarms configuration for the block (a
only for a negative value reduces the alarm setpoint values): The
non-Digital High limit is now the High limit value (set in the
block Resources Configuration’s Alarms configuration for the
instance) block) plus AlarmSetpoint and the Low limit is now the
Low limit value (set in the Resources Configuration’s
Alarms configuration for the block) plus AlarmSetpoint.
See Dynamic alarm activation thresholds adjust.
NOTE: When the AlarmSetpoint input is disconnected,
you must reset the controller (see Project Syn-
chronization) or connect a Null value (ECL, ECB
& ECY Series)) block to this port so the controller
will release this port as being unconnected.
When the AlarmSetpoint input is disconnected,
the High limit and Low limit can be written to
through the BACnet interface.
AlarmValue Digital 0 or 1 When alarms are enabled for this block for a digital value
(B-AAC (see Alarms (ECB & ECY Series)), this input overrides
and B-BC the alarm value set in the Resources Configuration’s
controllers Alarms configuration for the block.
only for a
Digital NOTE: When the AlarmValue input is disconnected,
block you must reset the controller (see Project Syn-
instance) chronization) or connect a Null value (ECL, ECB
& ECY Series) block to this port so the controller
will release this port as being unconnected.
When the AlarmValue input is disconnected, the
alarm value property can be overwritten through
the BACnet interface.
Trigger Digital 0 or 1 When Broadcast Mode in the Resources Configuration
Broadcast for this block is set to Local or Global, this port
(ECY becomes available. A pulse at this input triggers a
Series broadcast of the object’s present value on the local
controllers network or global networks. See Broadcast mode.
only)
ResetElaps Digital 0 or 1 When a hardware input is configured as a Digital output,
edActiveTi a pulse at this input resets the timer for the
me ElapsedActiveTime output (see below).
ResetChan Digital 0 or 1 When a hardware input is configured as a Digital output,
geOfState a pulse at this input resets the counter for the
Count ChangeOfStateCount output (see below).
418 EC-gfxProgram
Output(s)
Port Type Range Description
Output Digital 0 or 1 Block output. Whether the block will output a
digital value or a numeric value is dependent on
Numeric ±3.4028 ×1038 what type of Signal interpretation is selected
in the block’s Advanced configuration window.
Override Digital 0 or 1 Value of the override (Bypass). The Override
output only emits a pulse, thus if it is required to
stay on for an extended period of time, a Min
On Time or Latch block should be utilized.
OutOfService Binary 0 or 1 See Out-of-Service.
Fault Binary 0 or 1 When the Check signal fault in the Advanced
Configuration is set, this is logically True (1) if
the Reliability property does not have a value of
No Fault Detected, otherwise logical False (0).
Reliability Enum See Description When either the Check out of range or the
Check signal fault in the Advanced
Configuration is set (or both are set), this
provides an indication of whether the physical
input is "reliable" and, if not, why. See
Reliability property.
InAlarm (B- Digital 0 or 1 When Enable Alarms is set for this block and
AAC and B- the block is in an alarm state, this output is On
BC (1). See Alarms (ECB & ECY Series) to
controllers configure the alarm settings.
only)
Elapsed Numeric 3.4028×1038 When a hardware input is configured as a
ActiveTime Digital output, this cumulates the time this
(ECY Series value is set to true (1).
controllers
only)
ChangeOf Numeric 3.4028×1038 When a hardware input is configured as a
StateCount Digital output, this cumulates the number of
(ECY Series this value’s state changes.
controllers
only)
Block properties See Common block properties.
EC-gfxProgram 419
Generic Hardware Output (ECL Series)
Description Used to provide access to any instance of a Hardware Output block through
the Number input.
Hardware Outputs that are used with this block must have their advanced
configuration set. This is done in the:
• Resource Viewer in the Hardware IOs tab, set the View Mode to All, and
right-click a hardware output to select Configure.
• Resources Configuration window by double-clicking the block.
For more information about the advanced configuration settings of a Hard-
ware Output block, see Hardware Output (ECL Series).
Advanced Configure Ports, Show/Hide Ports
configuration
Related blocks Hardware Output (ECL Series)
Input(s)
Port Type Range Description
Number Numeric 1 to n Selects the Hardware Output instance to
assume.
Where n is the maximum number of Hardware
Outputs supported by the current controller
model. See the Number of resources supported
by a controller for the available number of
Hardware Output blocks.
Input Digital 0 or 1 Value of the controller’s output.
Numeric 0 to 100
Null – When the Hardware Output is configured as a
pulse output, a Null value (ECL, ECB & ECY
Series) must be set at the Input.
420 EC-gfxProgram
Port Type Range Description
OnFor Numeric 0 to 3.4028×1038 When the Hardware Output is configured as a
pulse output, this sets the output pulse duration
in seconds. To retrigger a pulse output, there
must be a change of value at this input.
Output(s)
Port Type Range Description
Output Digital 0 or 1 Effective value of the controller’s output.
Whether the block will output a digital value or
Numeric 0 to 100 a numeric value is dependent on what type of
Signal type is selected in the block’s
Advanced configuration window.
Priority Numeric 0 to 4 The current priority that is controlling the
output. See Output priority for a description of
the priority levels.
TimeLeft Numeric 0 to 2147318 When the Hardware Output is configured as a
pulse output, this is the remaining time before
the pulse ends, once the pulse has been
triggered by the OnFor input.
OutOfService Digital 0 or 1 See Out-of-Service.
Override Multi State Off The HOA switch’s current position. Manual is
Switcha Value the Hand position.
Auto
Manual
Not available
Override Numeric 0 to 12.5VDC The HOA potentiometer’s current position
Potentiometera (expressed as a voltage).
WARNING: When the HOA switch on the con-
troller is set to the Man position,
the potentiometer has an effective
output control range of:
• 0 to 12.5VDC for an output configured
as a 0 to 10VDC output.
• 0 to 25mA for an output configured as
a 0 to 20mA output.
Effective Numeric 0 to 125% The actual output voltage or current at the
Outputa hardware output, which represents the value
Digital 0 or 1 of any software generated output or any HOA
override setting.
EC-gfxProgram 421
Port Type Range Description
Reliability Enum See When either the Check out of range or the
Description Check signal fault in the Advanced
Configuration is set (or both are set), this
provides an indication of whether the physical
input is "reliable" and, if not, why. See
Reliability property.
a. Available with HOA-equipped controller outputs – refer to the Hardware
Installation Guide for the controller.
Block properties See Common block properties.
Generic Hardware Output (ECB & ECY Series)
Description Used to provide access to any instance of a Hardware Output block through
the Number input.
Each Hardware Output block is linked to a corresponding BACnet object
which follows the same value as the Hardware Output block. Hardware Out-
puts that are used with this block must have their advanced configuration set.
This is done in the:
• Resource Viewer in the Hardware IOs tab, set the View Mode to All, and
right-click a hardware output to select Configure.
• Resources Configuration window by double-clicking the block.
For more information about the advanced configuration settings of a Hard-
ware Output block, see Hardware Output (ECB & ECY Series).
Advanced Configure Ports, Show/Hide Ports
configuration
For more information about BACnet objects, see BACnet objects, services,
and data priority, Reading and writing network points, and Commandable
object priority array levels.
Related blocks Hardware Output (ECB & ECY Series)
422 EC-gfxProgram
Input(s)
Port Type Range Description
Number Numeric 1 to n Selects the Hardware Output instance to
assume. Where n is the maximum number of
Hardware Outputs supported by the current
controller model. See the Number of
resources supported by a controller for the
available number of Hardware Output blocks.
Input Digital 0 or 1 Value to be generated at the controller’s
output.
Numeric 0 to 100
Null – When the Hardware Output is configured as a
pulse output, a Null value (ECL, ECB & ECY
Series) must be set at the Input.
Priority Integer 1 to 16 For a Commandable value only, the value at
the Input is written at the priority level
specified at this input. If a value is not linked to
this input, the value at the Input is written into
the default priority level. See Commandable
object priority array levels.
OnFor Numeric 0 to When the Hardware Output is configured as a
3.4028×1038 pulse output, this sets the output pulse
duration in seconds. To retrigger a pulse
output, there must be a change of value at this
input.
AlarmValue (B- Digital 0 or 1 When the Hardware Output is configured as a
AAC and B-BC Digital or Pulse output and alarms are enabled
controllers only for this block (see Alarms (ECB & ECY
for a Digital / Series)), and the value at this input is different
Pulse block from the present value, this triggers a
instance) notification message.
EC-gfxProgram 423
Port Type Range Description
AlarmValue (B- Numeric ±3.4028×1038 When alarms are enabled for this block (see
AAC and B-BC Alarms (ECB & ECY Series)), a positive input
controllers only value increases the alarm setpoint values set
for a non-Digital in the Resources Configuration’s Alarms
/ Pulse block configuration for the block (set in the
instance) Resources Configuration’s Alarms
configuration for the block): The High limit is
now the High limit value (set in the
Resources Configuration’s Alarms
configuration for the block) plus AlarmValue
and the Low limit is now the Low limit value
(set in the Resources Configuration’s Alarms
configuration for the block) plus AlarmValue.
See Dynamic alarm activation thresholds
adjust.
NOTE: When the AlarmValue input is discon-
nected, you must reset the controller
(see Project Synchronization) or con-
nect a Null value (ECL, ECB & ECY
Series) block to this port so the con-
troller will release this port as being
unconnected.
When the AlarmValue input is discon-
nected, the High limit and Low limit
can be written to through the BACnet
interface.
Feedback (B- Digital 0 or 1 When the Hardware Output is configured as a
AAC & B-BC Digital or Pulse output and alarms are enabled
controllers only) for this block, and the value at this input is
different from the present value, this triggers a
notification message. See Alarms (ECB &
ECY Series) to configure the alarm settings.
Trigger Digital 0 or 1 When Broadcast Mode in the Resources
Broadcast (ECY Configuration for this block is set to Local or
Series Global, this port becomes available. A pulse
controllers only) at this input triggers a broadcast of the
object’s present value on the local network or
global networks. See Broadcast mode.
ResetElapsedAc Digital 0 or 1 When a hardware input is configured as a
tiveTime Digital output, a pulse at this input resets the
timer for the ElapsedActiveTime output (see
below).
ResetChangeOf Digital 0 or 1 When a hardware input is configured as a
StateCount Digital output, a pulse at this input resets the
counter for the ChangeOfStateCount output
(see below).
424 EC-gfxProgram
Outout(s)
Port Type Range Description
Output Digital 0 or 1 Effective value of the controller’s output.
Whether the block will output a digital value or
Numeric 0 to 100 a numeric value is dependent on what type of
Signal type is selected in the block’s
Advanced configuration window.
OutOfService Binary 0 or 1 See Out-of-Service.
Fault Digital 0 or 1 When a hardware output on an ECx-400
Series Extension module has lost
communications with the controller, this output
is logically True (1), otherwise it is logically
False (0).
Reliability Enum See When a hardware output on an ECx-400
Description Series Extension module has lost
communications with the controller, this output
becomes Communication Failure. See
Reliability property.
Priority Integer 1 to 16 The current active priority for commandable
objects. See Commandable object priority
array levels.
TimeLeft Numeric 0 to 2 147 318 When the Hardware Output is configured as a
pulse output, this is the remaining time before
the pulse ends, once the pulse has been
triggered by the OnFor input.
Override Switcha Multi State Off The HOA switch’s current position. Manual is
Value the Hand position.
Auto
Manual
Not available
Override Numeric 0 to 12.5VDC The HOA potentiometer’s current position
Potentiometera (expressed as a voltage).
WARNING: When the HOA switch on the con-
troller is set to the Man position,
the potentiometer has an effective
output control range of:
• 0 to 12.5VDC for an output configured
as a 0 to 10VDC output.
• 0 to 25mA for an output configured as
a 0 to 20mA output.
EC-gfxProgram 425
Port Type Range Description
Effective Outputa Numeric 0 to 125% The actual output voltage or current at the
hardware output, which represents the value
Digital 0 or 1 of any software generated output or any HOA
override setting.
InAlarm (B-AAC Digital 0 or 1 When Enable Alarms is set for this block and
and B-BC the block is in an alarm state, this output is On
controllers only) (1). See Alarms (ECB & ECY Series) to
configure the alarm settings.
Elapsed Numeric 3.4028×1038 When a hardware output is configured as a
ActiveTime (ECY Digital output, this cumulates the time this
Series controllers value is set to true (1).
only)
ChangeOf Numeric 3.4028×1038 When a hardware output is configured as a
StateCount (ECY Digital output, this cumulates the number of
Series controllers this value’s state changes.
only)
a. Available with HOA-equipped controller outputs – refer to the Hardware
Installation Guide for the controller.
Block properties See Common block properties.
Generic Network Value (ECB & ECY Series)
Description Used to provide access to any instance of a Network Value block through the
Number input. For a detailed description of this block’s configuration parame-
ters and features, see Network Value (ECB & ECY Series).
Each Network Value block is linked to a corresponding BACnet object which
follows the same value as the Network Value block. Network Values that are
used with this block must have their advanced configuration set. This is done
in the:
• Resource Viewer in the BACnet Objects tab, set the View Mode to All,
and right-click a Network Value to select Configure.
• Resources Configuration window by double-clicking the block.
For more information about the advanced configuration settings of a Network
Value block, see Multi State Value (ECB & ECY Series).
426 EC-gfxProgram
Advanced Configure Ports, Show/Hide Ports
configuration
For more information about BACnet objects, see BACnet objects, services,
and data priority, Reading and writing network points, and Commandable
object priority array levels.
Related blocks Network Value (ECB & ECY Series)
Input(s)
Port Type Range Description
Number Numeric 1 to n Selects the Network Value instance to assume.
Where n is the maximum number of Network Values
supported by the current controller model. See the
Number of resources supported by a controller for
the available number of Network Value blocks.
Trigger Digital 0 or 1 Forces a read or write action as soon as possible.
Priority Integer 1 to 16 For a Commandable value only, the value at the
(write only) Input is written at the priority level specified at this
input. If a value is not linked to this input, the value
at the Input is written into the default priority level.
SeeCommandable object priority array levels.
Input (write Numeric ±3.4028×1038 The value to be sent to the remote device on the
only) BACnet intranetwork.
Output(s)
Port Type Range Description
Output Numeric ±3.4028×1038 The value from the remote device made available on
(read only) the BACnet intranetwork.
NOTE: Any change in the measurement system of
the project results in no change to the output
value. For example, no conversion is made.
Status Digital See Communication failure alarm status. See Status
Description output.
EC-gfxProgram 427
Port Type Range Description
Update Digital 0 or 1 When configured to Input mode, this outputs a pulse
(1) when a value is written to the BACnet object.
When configured to Output mode, this outputs a
pulse (1) when the current controller receives a
confirmation from the target controller that the value
has been written to properly. If the output is
configured as a broadcast COV (Send Global
Broadcast COV or Send Local Broadcast COV),
this outputs a pulse to indicate that the value has
been sent, however it does not mean that the value
has been correctly received as there is no reception
confirmation provided when using broadcast COV.
Block properties See Common block properties.
Example For an example of how to use a Generic block with a For Loop (ECL, ECB &
ECY Series) block, see For Loop block example for ECB & ECY Series con-
trollers.
Generic Network Variable Input (ECL Series)
Description Used to provide access to any instance of a Network Variable Input block
through the Number input.
Network Variable Inputs that are used with this block must have their
advanced configuration set. This is done in the:
• Resource Viewer in the Network Variable tab, set the View Mode to All,
and right-click a Network Variable Input to select Configure.
• Resources Configuration window by double-clicking the block.
For more information about the advanced configuration settings of a Network
Variable Input block, see Network Variable Input (ECL Series).
Advanced Configure Ports, Show/Hide Ports
configuration
428 EC-gfxProgram
Related blocks Network Variable Input (ECL Series)
Input(s)
Port Type Range Description
Number Numeric 1 to n Selects the Network Variable Input instance to
assume.
Where n is the maximum number of Network
Variable Input blocks supported by the current
controller model. See the Number of Resources
Supported by a Controller for the available number
of Network Variable Input blocks.
Input See See The value to write. See Network Variable Input (ECL
Description Description Series).
NOTE: Persistence is not available when writing to
the input of this block. Persistence is only
available when the value is written directly to
the Input of the Network Variable Input
block.
NOTE:
EC-gfxProgram 429
Port Type Range Description
FieldNumber Numeric – Selects an input and output port of a Network
Variable Input block for its input and output. The
FieldNumber can be found by opening the
Configure Ports window for the related Network
Variable Input block. Count Down the output ports
(whether the port is enabled or not) to find the
corresponding FieldNumber. For example, for a
SNVT_dev_status type,
dev_type.pump_ctrl.remote_pressis
FieldNumber 14 as it is the 14th output port down
the list.
Figure 270: Finding a FieldNumber for an NVI.
NOTE: An invalid FieldNumber value will result in a
Null value at the block’s Output port.
FanInNumber Integer 0-255 Selects the FanIn number of a value to be read. The
FanInNumber port affects the Output, Com Failure
and Subnet and Node Id ports. See also Using
LONWORKS network variables to fan in values from
many controllers.
Output(s)
Port Type Range Description
Output See See The outputs are defined according to the SNVT or
Description Description UNVT type selected. See also the Format option in
this block’s Properties.
430 EC-gfxProgram
Port Type Range Description
TypeIndex Integer See Network variable type index.
Description
NOTE: For UNVT, multiply the manufacturer index
by 1000 and then add the type index.
For example: If using UNVT_x in the DRF is type 1
and the manufacturer id is 131, the resulting Type
Index is 131001.
FanInCount Integer 0-255 Number of fan in values available in the fan in table.
ComFailure Digital 0 or 1 Communication failure alarm status.
Update Digital 0 or 1 Outputs a pulse when the NV is updated.
SubnetNode Id Integer See Network variable update Subnet and Node Id source
Description address.
The source address is the Subnet id (1 to 255)
multiplied by 1000 and then add the node id.
For example: Address 1005 has a Subnet id of 1
and a Node id of 5.
Block properties See Common block properties.
Property Type Range Default Description
Format Menu See See Click to select a format that
Description Description corresponds to the units type the
block is to use for the Input and
Output ports of the block.
For example, because all values sent
on a LONWORKS network are in SI
(metric) values, a temperature on a
LONWORKS network is sent in degrees
Celsius. By setting the Format to a
US type such as SNVT_temp#US,
the value is converted at the Output
to degrees Fahrenheit with ºF as the
unit.
See also Change Type (ECP & ECL
Series).
Example For an example of using the For Loop (ECL, ECB & ECY Series) block to fan
in values from many controllers, see Using a LonWorks Network Variable to
Fan in Values From Many Controllers.
EC-gfxProgram 431
Generic Network Variable Output (ECL Series)
Description Used to provide access to any instance of a Network Variable Output block
through the Number input.
Network Variable Outputs that are used with this block must have their
advanced configuration set. This is done in the:
• Resource Viewer in the Network Variable tab, set the View Mode to All,
and right-click a Network Variable Output to select Configure.
• Resources Configuration window by double-clicking the block.
For more information about the advanced configuration settings of a Network
Variable Output block, see Network Variable Output (ECL Series).
Advanced Configure Ports, Show/Hide Ports
configuration
Related blocks Network Variable Output (ECL Series)
Input(s)
Port Type Range Description
Number Numeric 1 to n Selects the Network Variable Output (ECL Series)
instance to assume.
Where n is the maximum number of Network Variable
Outputs supported by the current controller model. See
the Number of resources supported by a controller for
the available number of Network Variable Output
blocks.
Input See See The value to write. The inputs are defined according to
Description Description the SNVT or UNVT type selected. See also the Format
option in this block’s Properties pane.
432 EC-gfxProgram
Port Type Range Description
FieldNumber Numeric – Selects an input and output port of a Network Variable
Output (ECL Series) block for its input and output. The
FieldNumber can be found by opening the Configure
Ports window for the related Network Variable Output
block. Count Down the output ports (whether the port is
enabled or not) to find the corresponding
FieldNumber. For example, for a SNVT_dev_status
type, dev_type.pump_ctrl.remote_press is
FieldNumber 14 as it is the 14th output port down the
list.
Figure 271: Finding a FieldNumber for an NVI.
NOTE: An invalid FieldNumber value will result in a
Null value at the block’s Output port.
Output(s)
Port Type Range Description
Output See See The outputs are defined according to the SNVT or UNVT
Description Description type selected. See also the Format option in this block’s
Properties Pane.
TypeIndex Integer See Network variable type index.
Description
NOTE: For UNVT, multiply the manufacturer index by
1000 and then add the type index.
For example: If using UNVT_x in the DRF is type 1 and
the manufacturer id is 131, the resulting Type Index is
131001.
EC-gfxProgram 433
Block properties See Common block properties.
Property Type Range Default Description
Format Menu See See Click to select a format that
Description Description corresponds to the units type the
block is to use for the Input and
Output ports of the block.
For example, because all values sent
on a LONWORKS network are in SI
(metric) values, a temperature on a
LONWORKS network is sent in degrees
Celsius. By setting the Format to a
US type such as SNVT_temp#US,
the value is converted at the Output
to degrees Fahrenheit with ºF as the
unit.
See also Change Type (ECP & ECL
Series).
Example For an example of using the For Loop (ECL, ECB & ECY Series) block to fan
in values from many controllers, see Using LONWORKS network variables to
fan in values from many controllers.
434 EC-gfxProgram
Generic Numeric Constant (ECL Series)
Description Used for numeric constant values. For a detailed description of this block’s
configuration parameters and features, see Numeric Constant (ECL Series).
Advanced Configure Ports, Show/Hide Ports
configuration
Related blocks Numeric Constant (ECL Series)
Input(s)
Port Type Range Description
Number Numeric 1 to n Selects the Numeric Constant (ECL Series) block
instance to assume.
Where n is the maximum number of Numeric
Constants supported by the current controller model.
See the Number of resources supported by a
controller for the available number of Numeric
Constant blocks.
Input Numeric ±3.4028×1038 Block input.
NOTE: Persistence is not available when writing to the
input of this block. Persistence is only avail-
able when the value is written directly to the
Input of the Numeric Constant (ECL Series)
block.
Output(s)
Port Type Range Description
Output Numeric ±3.4028×1038 Block output. The constant value.
Block Properties See Common block properties.
EC-gfxProgram 435
Generic nLight Channel (ECY Series)
Description Used to provide access to any instance of an nLight Channel block through
the Number input. By default, it exposes the ports that are available both for a
Switch and an Occupancy channel. The applicable ports will be assigned val-
ues, while the non-applicable ports will remain null. Other ports can be
exposed as well (see Show/Hide Ports). For a detailed description of this
block’s configuration parameters and features, see nLight Channel (ECY
Series).
Advanced Configure Ports, Show/Hide Ports, nLight Channel Calculator (ECY Series),
configuration nLight Channel (ECY Series)
Input(s)
Port Type Range Description
Number Integer 1 to 999 The number of the nLight Channel Resource.
If the nLight Channel whose number you want to
input has a Device type of the Local Interface or
First Bridge types, it is recommended to use the
nLight Channel Calculator block. In this way, a
combination of an nLight Channel Calculator
block and a Generic nLight Channel block can be
used in code snippets and function correctly in
different setups, for different controllers, without the
user having to respecify the resource numbers, thus
reducing the programming effort. For more details,
see nLight Channel Calculator (ECY Series).
DimLevel Numeric 0 to 100% Sets the channel’s dimming output level (0 to 10
VDC). Only applicable to channels of the Switch
type.
RelayState Digital 0 or 1 Switches the lighting on or off for the channel. Only
applicable to channels of the Switch type.
436 EC-gfxProgram
Output(s)
Port Type Range Description
DimLevel Numeric 0 to 100% Outputs the channel’s dimming level (0 to 10
VDC). Only applicable to channels of the Switch
type.
RelayState Digital 0 or 1 Outputs the channel’s relay state value: ON or
OFF. Only applicable to channels of the Switch
type.
Occupied Digital 0 or 1 Outputs the current occupancy state. Only appli-
cable to channels of the Occupancy type.
Occupied.Reli- Enum See Descrip- This provides an indication of whether the occu-
ability tion pancy channel is connected to the controller (No
fault detected (0)) or not (Communication failure
(12)). See also Reliability property. A configura-
tion error identifies that the device’s configuration
is not valid. Only applicable to channels of the
Occupancy type.
Occupied.Fault Digital 0 or 1 Logical True (1) if the Reliability property's value
is different from No Fault Detected, otherwise log-
ical False (0). Only applicable to channels of the
Occupancy type.
[Port].OutOfSer- Digital 0 or 1 See Out-of-Service. [Port] stands for RelayState,
vice DimLevel, or Occupancy.
[Port].Update Digital 0 or 1 Outputs a pulse when a value is written to the
BACnet object. [Port] stands for RelayState or
DimLevel, i.e. it is only applicable to channels of
the Switch type.
Block properties See Common Block Properties.
nLight Channel Based on the values assigned to its input parameters (in this example, the
Resource values are provided by Internal Constant blocks referring to the nLight
Number Channel Type and nLight Channel Device Type enumerations), the nLight
Calculator Channel Calculator block computes the nLight channel resource number
Example (BACnet object ID) and sends it, through the Number output, to the Generic
nLight Channel block, which uses it to automatically identify and represent
the concerned nLight channel. As a result, the Generic nLight Channel out-
puts the actual values of the dimming level and relay state of the selected
Switch channel. The Occupied parameter is null since the channel is not of
the Occupancy type.
EC-gfxProgram 437
Generic Multi State Value (ECB & ECY Series)
Description Used to provide access to any instance of a Multi State Value block through
the Number input. For a detailed description of this block’s configuration
parameters and features, see Multi State Value (ECB & ECY Series).
Each Multi State Value block is linked to a corresponding BACnet object which
follows the same value as the Multi State Value block. Multi State Values that
are used with this block must have their advanced configuration set. This is
done in the:
• Resource Viewer in the BACnet Objects tab, set the View Mode to All,
and right-click a Multi State Value to select Configure.
• Resources Configuration window by double-clicking the block.
For more information about the advanced configuration settings of a Multi
State Value block, see Multi State Value (ECB & ECY Series).
Advanced Configure Ports, Show/Hide Ports
configuration
For more information about BACnet objects, see BACnet objects, services,
and data priority, Reading and writing network points, and Commandable
object priority array levels.
Related blocks Multi State Value (ECB & ECY Series)
438 EC-gfxProgram
Input(s)
Port Type Range Description
Number Numeric 1 to n Selects the Multi State Value instance to assume.
Where n is the maximum number of Multi State
Values supported by the current controller model.
See the Number of resources supported by a
controller for the available number of Multi State
Value blocks.
Input Multistate 1 to 255 Block input. The value to write.
NOTE: Persistence is not available when writing to
the input of this block. Persistence is only
available when the value is written directly to
the Input of the Multi State Value (ECB &
ECY Series) block.
Priority Integer 1 to 16 For a Commandable value only, the value at the
Input is written at the priority level specified at this
input. If a value is not linked to this input, the value
at the Input is written into the default priority level.
See Commandable object priority array levels.
Trigger Digital 0 or 1 When Broadcast Mode in the Resources
Broadcast Configuration for this block is set to Local or Global,
(ECY Series this port becomes available. A pulse at this input
controllers triggers a broadcast of the object’s present value on
only) the local network or global networks. See Broadcast
mode.
Output(s)
Port Type Range Description
Output Multistate 1 to 255 Block output. The Present Value.
OutOfService Digital 0 or 1 See Out-of-Service.
Priority Integer 1 to 16 The current active priority for commandable objects.
See Commandable object priority array levels.
Update Digital 0 or 1 Outputs a pulse when a value is written to the
BACnet object.
EC-gfxProgram 439
Port Type Range Description
Fault (B-AAC Digital 0 or 1 When Enable Alarms is set for this block and the
and B-BC block is in an alarm state, only the InAlarm output is
controllers On (1). When the block is in a fault state, both the
only) InAlarm and Fault outputs are On (1).
InAlarm (B- Digital 0 or 1 See Alarms (ECB & ECY Series) to configure the
AAC and B- alarm settings.
BC
controllers
only)
Block properties See Common block properties.
Example For an example of using the For Loop (ECL, ECB & ECY Series) block to fan
in values from many controllers, see Using LONWORKS network variables to
fan in values from many controllers.
Generic Numeric Value (ECL Series)
Description Mainly used for variable values requiring monitoring. For a detailed descrip-
tion of this block’s configuration parameters and features, see Numeric Value
(ECL Series).
Advanced Configure Ports, Show/Hide Ports
configuration
Related blocks Numeric Value (ECL Series)
440 EC-gfxProgram
Input(s)
Port Type Range Description
Number Numeric 1 to n Selects the Numeric Value (ECL Series) block
instance to assume.
Where n is the maximum number of Numeric
Values supported by the current controller model.
See the Number of resources supported by a
controller for the available number of Numeric
Value blocks.
Input Numeric ±3.4028×1038 Block input. The read value.
NOTE: Persistence is not available when writing
to the input of this block. Persistence is
only available when the value is written
directly to the Input of the Numeric Value
(ECL Series) block.
Output(s)
Port Type Range Description
Output Numeric ±3.4028×1038 Block output. The read (Automatic) value or set
(Manual) value.
OutOfService Digital 0 or 1 See Out-of-Service.
Update Digital 0 or 1 Outputs a pulse when a value is written to the
block.
Block properties See Common block properties.
Example For an example of how to use a Generic block with a For Loop (ECL, ECB &
ECY Series) block, see For Loop block example for ECL Series controllers.
For an example of using the For Loop block to fan in values from many con-
trollers, see Using LONWORKS network variables to fan in values from many
controllers.
EC-gfxProgram 441
Generic Pid Loop (ECL, ECB & ECY Series)
Description Used to provide access to any instance of a Pid Loop block through the Num-
ber input.
Each Pid Loop block is linked to a corresponding network variable which fol-
lows the same value as the Pid Loop block. Pid Loops that are used with this
block must have their advanced configuration set. This is done in the:
• Resource Viewer in the Pid Values tab, set the View Mode to All, and
right-click a Pid Loop to select Configure.
• Resources Configuration window by double-clicking the block.
For more information about the advanced configuration settings of a Pid Loop
block, see Pid Loop (ECL Series) or Pid Loop (ECB & ECY Series).
Advanced Configure Ports, Show/Hide Ports, Tuning a PID Loop
configuration
Related blocks Pid Loop (ECL Series), Pid Loop (ECB & ECY Series)
Input(s)
Port Type Range Description
Number Numeric 1 to n Selects the Pid Loop instance to assume.
Where n is the maximum number of PID blocks supported by
the current controller model. See the for the available
number of Pid Loop blocks.
See also the inputs for Pid Loop (ECL Series) block or Pid Loop (ECB & ECY
Series) block.
Output(s) See the outputs for Pid Loop (ECL Series) block or Pid Loop (ECB & ECY
Series) block.
Block properties See Common block properties.
442 EC-gfxProgram
Generic Timer (ECL Series)
Description Used to provide access to any instance of a Timer block through the Number
input. For a detailed description of this block’s configuration parameters and
features, see Timer (ECL Series).
Advanced Configure Ports, Show/Hide Ports
configuration
Related blocks Timer (ECL Series)
Input(s)
Port Type Range Description
Number Numeric 1 to n Selects the Timer instance to assume.
Where n is the maximum number of Timers
supported by the current controller model.
Input Digital 0 or 1 Block input. If On (1), the timer is started. If Off (0),
the timer is stopped.
NOTE: Persistence is not available when writing to
the input of this block. Persistence is only
available when the value is written directly to
the Input of the Timer (ECL Series) block.
InitValue Numeric ±3.4028×1038 Sets the starting value of the timer.
Reset Digital 0 or 1 Enabling this input (1) will reset the output to the
InitValue value.
Output(s)
Port Type Range Description
Output Numeric 0 to The time count. The time count will stop
3.4028×1038 automatically when the range limit is reached.
Block properties See Common block properties.
EC-gfxProgram 443
Generic Timer (ECB & ECY Series)
Description Used to provide access to any instance of a Timer block through the Number
input. For a detailed description of this block’s configuration parameters and
features, see Timer (ECB & ECY Series).
Advanced Configure Ports, Show/Hide Ports
configuration
Related blocks Timer (ECB & ECY Series)
Input(s)
Port Type Range Description
Number Numeric 1 to n Selects the Timer instance to assume.
Where n is the maximum number of Timers
supported by the current controller model.
Input Digital 0 or 1 Block input. If On (1), the timer is started. If Off (0),
the timer is stopped.
NOTE: Persistence is not available when writing to
the input of this block. Persistence is only
available when the value is written directly to
the Input of the Timer (ECL Series) or Timer
(ECB & ECY Series) block.
InitValue Numeric ±3.4028×1038 Sets the starting value of the timer.
Reset Digital 0 or 1 Enabling this input (1) will reset the output to the
InitValue value.
Output(s)
Port Type Range Description
Output Numeric 0 to The time count. The time count will stop
3.4028×1038 automatically when the range limit is reached.
Block properties See Common Block Properties.
444 EC-gfxProgram
HVAC
HVAC blocks are used for standard HVAC requirements such as stage control
and Optimum start and stop calculations.
The following blocks are available in this category:
• Analog Stages
• Digital Stages
• Digital Stages + Delay
• Optimum Start/Stop
• Smart Stages
• Stages With Modulation
• Thermostat
EC-gfxProgram 445
Analog Stages
Description Used to control multiple analog stages.
As the Input demand increases, the Output stages increase from 0 to 100% in
a sequential manner.
If only 2 stages are configured, the first stage will increase at double the rate
of the Input so that when the Input reaches 50%, the first stage will reach
100%. As the Input increases beyond 50%, the second stage will begin to
increase at double the rate of the Input so that finally when the Input reaches
100%, the second stage will also reach 100%.
This block behaves similarly if 3 or 4 stages are configured, that is, each stage
will increase in sequence at 3 times the rate of the Input (3 stages) or 4 times
the rate of the Input (4 stages).
As the Input decreases, each stage decreases in the opposite manner than it
increased. For example, if 2 stages are configured, the second stage will
decrease to 0% when the Input reaches 50% and the first stage will decrease
to 0% when the Input reaches 0%.
Figure 272: 2 stages/outputs
446 EC-gfxProgram
Figure 273: 3 stages/putputs
Figure 274: 4 stages/outputs
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
Input Numeric 0 to 100 Stage demand, usually the output of a Pid block.
Enable Digital 0 or 1 Used to enable or disable the block. Setting this to 0
disables the block while setting it to 1 enables the
block. If the block is disabled, the outputs are set to 0.
EC-gfxProgram 447
Output(s)
Port Type Range Description
Outputx Numeric 0 to 100 Output for the analog stage control.
(x=1 to 4)
NOTE: Two outputs are always visible. The other two
possible outputs can be added by the user
through the Properties pane.
For ECL, ECB & ECY Series controllers: If no Input to
this block is Null, then the block’s output is the normal
result. If one or more Inputs to this block are Null, then
the Output of this block is always Null.
Block properties See also Common block properties.
Property Type Range Default Description
NumberOf Integer 2 to 4 2 Number of stages being controlled.
Stages
Example The Analog Stages block is used to control multiple analog outputs based on
the demands of a Dual Pid (ECP Series) block. The example below shows
how a Fresh Air Damper and Cooling Valve (Hardware Output blocks) are
controlled in sequence (Analog Stages and Internal constant block) based on
the Room Temperature (Hardware Input, Dual Pid, and Internal Constant
blocks).
Figure 275: Analog Stages block example
The Analog Stages block receives its Input or cooling demand from the
HiVal of the Dual Pid block. The Dual Pid block evaluates the Room Tem-
perature (Hardware Input block) against heating and cooling setpoints (Inter-
nal Constant blocks) and outputs either a cooling demand to the Analog
Stages block, which controls a Fresh Air Damper and Cooling Valve (Hard-
ware Output blocks) or a heating demand to the Digital Stages block, which
controls a pair of heaters (Hardware Output blocks).
448 EC-gfxProgram
Digital Stages
Description Used to control multiple digital stages. As the Input demand increases or
decreases, the Output stages turn On or Off in a sequential manner.
Output Threshold 2 Stages 3 Stages 4 Stages
Output1 On 40% 26.7% 20%
Off 10% 6.66% 5%
NOTE: This value has changed from
0.5% used in pre-version 2.0
releases.
Output2 On 90% 60% 45%
Off 60% 40% 30%
Output3 On - 93.4% 70%
Off - 73.3% 55%
Output4 On - - 95%
Off - - 80%
Figure 276: 2 stages/outputs
EC-gfxProgram 449
Figure 277: 3 stages/outputs
Figure 278: 4 stages/outputs
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
Input Numeric 0 to 100 Stage demand, usually the output of a Pid block.
Enable Digital 0 or 1 Used to enable or disable the block. Setting this to 0
disables the block while setting it to 1 enables the block.
If the block is disabled, the outputs are set to 0.
450 EC-gfxProgram
Output(s)
Port Type Range Description
Outputx Digital 0 or 1 Output for the digital stage control.
(x=1 to 4)
NOTE: Two outputs are always visible. The other two
possible outputs can be added by the user
through the Properties pane.
For ECL, ECB & ECY Series controllers: If no Input to
this block is Null, then the block’s output is the normal
result. If one or more Inputs to this block are Null, then
the Output of this block is always Null.
Block properties See also Common block properties.
Property Type Range Default Description
NumberOf Integer 2 to 4 2 Number of stages being controlled.
Stages
Example The Digital Stages block is used to control multiple digital outputs based on
the demands of one input. The example below shows how a pair of heaters
(Hardware Output blocks) is controlled in sequence (Digital Stages and
Internal constantblock) based on the Room Temperature (Hardware Input,
Dual Pid (ECP Series), and Internal Constant blocks).
Figure 279: Digital Stages block example
The Digital Stages block receives its Input or heating demand from the
LowVal of the Dual Pid block. The Dual Pid block evaluates the Room Tem-
perature (Hardware Input block) against heating and cooling setpoints (Inter-
nal Constant blocks) and outputs either a cooling demand to the Analog
Stages block, which controls a Fresh Air Damper and Cooling Valve (Hard-
ware Output blocks) or a heating demand to the Digital Stages block, which
controls a pair of heaters (Hardware Output blocks).
EC-gfxProgram 451
Digital Stages + Delay
Description Used to control multiple digital stages with On and Off delays.
This block works the same way as the Digital Stages block, except that a min-
imum On or Off time can be added between each stage depending on
whether it is turning On or Off.
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
32-Bit 8-Bit
Input Numeric 0 to 100 Stage demand, usually the output of a Pid
block.
MinOn Integer 0 to 3×1038 0 to 83886 Minimum On time (in seconds).
452 EC-gfxProgram
Port Type Range Description
32-Bit 8-Bit
MinOff Integer 0 to 3×1038 0 to 83886 Minimum Off time (in seconds).
Enable Digital 0 or 1 Used to enable or disable the block.
Setting this to 0 disables the block while
setting it to 1 enables the block. If the
block is disabled, the outputs are set to 0.
Output(s)
Port Type Range Description
Outputx Digital 0 or 1 Output for the digital stage control.
(x=1 to 4)
NOTE: Two outputs are always visible. The other two
possible outputs can be added by the user
through the Properties pane.
For ECL, ECB & ECY Series controllers: If no Input to
this block is Null, then the block’s output is the normal
result. If one or more Inputs to this block are Null, then
the Output of this block is always Null.
Block properties See also Common block properties.
Property Type Range Default Description
NumberOf Integer 2 to 4 2 Number of stages being controlled.
Stages
Example The Digital Stages + Delay block is used to control multiple digital outputs
based on the demands of one input with optional delays between each stage.
The example below shows how a pair of heaters (Hardware Output blocks) is
controlled in sequence (Digital Stages + Delay and Internal constant block)
based on the Room Temperature (Hardware Input, Dual Pid (ECP Series)
and Internal Constant blocks).
Figure 280: Digital Stages + Delay block example
EC-gfxProgram 453
The Digital Stages + Delay block receives its Input or heating demand from
the LowVal of the Dual Pid block. The Dual Pid block evaluates the Room
Temperature (Hardware Input block) against heating and cooling setpoints
(Internal Constant blocks) and outputs either a cooling demand to the Ana-
log Stages block, which controls a Fresh Air Damper and Cooling Valve
(Hardware Output blocks) or a heating demand to the Digital Stages + Delay
block, which controls a pair of heaters (Hardware Output blocks). The stages
go On and Off for a minimum time of 2 minutes (Internal Constant blocks).
Optimum Start/Stop
Description Sets a transition slope for the setpoint to go from unoccupied mode to occu-
pied mode and vice-versa.
• Optimum start time is the time at which heating or cooling is started
before occupancy switches from unoccupied to occupied to ensure that
the space is at its required setpoint by the time the space becomes occu-
pied.
• Optimum stop time is the time at which heating or cooling demands are
ignored before the occupancy switches from occupied to unoccupied in
order to not waste energy for heating or cooling a space that is soon to
become unoccupied.
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
32-Bit 8-Bit
Temperature Numeric ±3.4028×1038 -83886.08 to Current room temperature.
+83886.07
OccSp Numeric ±3.4028×1038 -83886.08 to Occupied setpoint.
+83886.07
UnoccSp Numeric ±3.4028×1038 -83886.08 to Unoccupied setpoint.
+83886.07
454 EC-gfxProgram
Port Type Range Description
32-Bit 8-Bit
CurrentState Enum -1 to 3 Current occupancy state:
-1 = OC_NUL
0 = OC_OCCUPIED
1 = OC_UNOCCUPIED
2 = OC_BYPASS
3 = OC_STANDBY
NOTE: This value is usually
received from a Schedule
block.
NextState Enum -1 to 3 Next occupancy state for ECP &
ECL Series controllers:
-1 = OC_NUL
0 = OC_OCCUPIED
1 = OC_UNOCCUPIED
2 = OC_BYPASS
3 = OC_STANDBY
NOTE: This value is usually
received from a Schedule
block.
TimeToNext Integer 0 to 3×1038 0 to 83886 The length of time before the
State current occupancy state changes to
the next occupancy state.
NOTE: This value is usually
received from a Schedule
block.
StartTime Integer 0 to 3×1038 0 to 83886 When transitioning from unoccupied
mode to occupied mode, this sets
the length of time before the start of
the occupied mode during which the
optimum start transition slope is
enabled. Use the same time units
as the TimeToNextState input
(seconds, minutes, hours).
EC-gfxProgram 455
Port Type Range Description
32-Bit 8-Bit
StopTime Integer 0 to 3×1038 0 to 83886 When transitioning from occupied
mode to unoccupied mode, this sets
the length of time before the start of
the unoccupied mode during which
the optimum start transition slope is
enabled. Use the same time units
as the TimeToNextState input
(seconds, minutes, hours).
Enable Digital 0 or 1 When this input is On (1) the block
is enabled. When this input is Off
(0) then the output follows the
OccSp or UnoccSP input as
selected by the CurrentState input.
Output(s)
Port Type Range Description
32-Bit 8-Bit
OptSetPoint Numeric ±3.4028×1038 -83886.08 to Optimum setpoint.
+83886.07
OptStart Digital 0 or 1 Optimum start status. Logical True
Status (1) when the Optimum Start/Stop
block is active according to the input
values. See the logic table below.
NOTE: If no Input of the block is
Null, then this Output is the
normal result. If one or more
Inputs to this block are Null,
then this output is always
Null.
OptStop Digital 0 or 1 Optimum stop status.
Status
NOTE: If no Input of the block is
Null, then this Output is the
normal result. If one or more
Inputs to this block are Null,
then this output is always
Null.
Block properties See also Common block properties.
456 EC-gfxProgram
Logic table This is the logic table for the Optimum Start/Stop block.
Table 15: Logic table for the Optimum Start/Stop block
Temperature /
Occupancy State Timing Output Status
Setpoint
CurrentState input = TimeToNextState Temperature input < OptSetPoint output =
Unoccupied (1) input <= StartTime OccSp input See graph below
input
NextState input = OptStartStatus output =
Occupied (0) See graph below
OptStopStatus output =
NOTE: This input
0
combination
selects the Temperature input > OptSetPoint output =
block’s opti- OccSp input See graph below
mum start
mode. OptStartStatus output =
0
OptStopStatus output =
0
TimeToNextState Temperature input = OptSetPoint output =
input > StartTime Any value UnoccSp input
input
OccSp input = Any OptStartStatus output =
value 0
OptStopStatus output =
0
CurrentState input = TimeToNextState Temperature input > OptSetPoint output =
Occupied (0) input <= StopTime UnoccSp input See graph below
input
NextState input = OptStartStatus output =
Unoccupied (1) 0
OptStopStatus output =
NOTE: This input
See graph below
combination
selects the Temperature input < OptSetPoint output =
block’s opti- UnoccSp input See graph below
mum stop
mode. OptStartStatus output =
0
OptStopStatus output =
0
TimeToNextState Temperature input = OptSetPoint output =
input > StopTime input Any value OccSp input
UnoccSp input = Any OptStartStatus output =
value 0
OptStopStatus output =
0
EC-gfxProgram 457
Optimum Start/ The following is the Optimum Start/Stop block setpoint transition graph.
Stop block
setpoint
transition graph
Example The Optimum Start/Stop block is used to reach the temperature setpoint by
the time the occupancy changes. The example below shows how a Heater
and a Fan (Hardware Output blocks) are turned On before the space is
occupied (Optimum Start/Stop and Pid block) based on the Schedule
(Schedule block), Room Temperature (Hardware Input block) and setpoints
(Internal constant blocks).
Figure 281: Optimum Start/Stop block example
The Optimum Start/Stop block receives the Room Temperature (Hardware
Input block) and occupancy (Schedule block) and based on these and other
inputs (Internal Constant blocks) determines if optimum start should be initi-
ated. If optimum start is initiated, the Fan (Hardware Output block) is turned
On immediately and the Pid block is enabled to control the Heater (Hardware
Output block).
458 EC-gfxProgram
Smart Stages
Description Used to control multiple digital stages based on the length of the period.
The output range will vary in proportion to the number of stages, so that if
there are 2 stages, then the output range for the first stage will be 0 to 50% of
the input demand and the output range for the second stage will be 50 to
100% of the input demand and so on for 3 and 4-stage outputs (assuming that
there are no delays configured).
For example, A 2-stage output is setup for a period of 10 minutes. At the start
of the first period, the Input load is 10%, then the first stage is On 20% of the
time (10 X 20% = 2 minutes) and the second stage does not turn On. At the
start of the second period, the Input load is 30%, then the first stage is On
60% of the time (10 X 60% = 6 minutes) and the second stage does not turn
On. At the start of the third period, the Input load is 70%, then the first stage is
On 100% of the time (10 X 100% = 10 minutes) and the second stage is On
40% of the time (10 X 40% = 4 minutes). At the start of the fourth period, the
Input load is 95%, then the first stage is On 100% of the time (10 X 100% = 10
minutes) and the second stage is On 90% of the time (10 X 90% = 9 minutes).
For the same example, if there is a MinOn of 4 minutes and a MinOff of 2 min-
utes, then each output will not turn On unless it has a load greater than 4/10
or 40% and will not turn Off unless it has a load less than 2/10 or 20% less
than 100%. So the first stage would not turn On at all during the first period
and the second stage would not turn Off at all in the fourth period.
EC-gfxProgram 459
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
32-Bit 8-Bit
Input Numeric 0 to 100.00 Stage demand, usually the output of a Pid
block.
MinOn Integer 0 to 3×1038 0 to 83886 Minimum On delay (in seconds). The load
must be greater than the percentage of
the delay over the period to allow the
output to turn On.
MinOff Integer 0 to 3×1038 0 to 83886 Minimum Off delay (in seconds). The load
must be less than the percentage of the
delay over the period to allow the output
to turn Off.
Enable Digital 0 or 1 Used to enable or disable the block.
Setting this to 0 disables the block while
setting it to 1 enables the block. If the
block is disabled, the outputs are set to 0.
Period Integer 0 to 3×1038 0 to 83886 Period (in seconds).
460 EC-gfxProgram
Output(s)
Port Type Range Description
Outputx Digital 0 or 1 Output for the smart stage control.
(x=1 to 4)
NOTE: Two outputs are always visible. The other two possi-
ble outputs can be added by the user through the
Properties Pane.
For ECL, ECB & ECY Series controllers: If no Input to this
block is Null, then the block’s output is the normal result. If
one or more Inputs to this block are Null, then the Output of
this block is always Null.
Block properties See also Common block properties.
Property Type Range Default Description
NumberOf Integer 2 to 4 2 Number of stages being controlled.
Stages
Example The Smart Stages block is used to control multiple digital outputs based on
the demands of one input with optional delays between each stage. The
example below shows how a pair of compressors (Hardware Output blocks)
are controlled (Smart Stages and Internal constant blocks) based on the
Room Temperature (Hardware Input, Dual Pid (ECP Series), Add, and Inter-
nal Constant blocks).
Figure 282: Smart Stages block example
The Smart Stages block receives its Input from the HiVal output of the Dual
Pid block. The Dual Pid block evaluates the Room Temperature (Hardware
Input block) against the cooling setpoint (Internal Constant block) and out-
puts a cooling demand.
The threshold for Output 1 to turn Off is an Input of 25% or less. With the Input
at 25% and a Period of 6000 seconds, Output1 should be On for 3000 sec-
onds and Off for 3000 seconds. However, with MinOn set to 3000 seconds,
Output1 remains Off with an Input of 25%. With an Input between 25% and
50%, Output1 turns On and Off according to the formula:
((2 X Input) / 100)) X Period.
EC-gfxProgram 461
With and Input of 75%, Output1 is On and Output2 is Off. With an Input
between 75% and 100%, Output2 turns On and Off according to the formula:
((2 X Input - 50) / 100)) X Period.
Stages With Modulation
Description Used to control multiple digital stages with one analog stage. To maintain lin-
earity, the load controlled by each stage must be equal.
As the Input value increases, Output1 modulates from 0 to 100%. As soon
as it reaches 100%, it immediately resets back to 0% and Output2 is turned
On. If the load continues to increase, then Output1 again modulates from 0 to
100%. As soon as it reaches 100% again, it immediately resets back to 0%
and Output3 is turned On. This process continues to repeat until outputs 2 to
4 are all turned On according to the increasing value at the Input and the
number of stages set in the Properties pane.
462 EC-gfxProgram
NOTE: Output1 is always analog. Outputs 2 to 4 are digital.
Figure 283: 2 stages/outputs
Figure 284: 3 stages/outputs
Figure 285: 4 stages/outputs
Advanced Configure Ports
configuration
EC-gfxProgram 463
Input(s)
Port Type Range Description
Input Numeric 0 to 100 Stage demand, usually the output of a Pid block.
Enable Digital 0 or 1 Used to enable or disable the block. Setting this to 0
disables the block while setting it to 1 enables the block.
If the block is disabled, the outputs are set to 0.
Output(s)
Port Type Range Description
Output1 Numeric 0 to 100 Analog stage control output.
For ECL, ECB & ECY Series controllers: If no Input to
this block is Null, then the block’s output is the normal
result. If one or more Inputs to this block are Null, then
the Output of this block is always Null.
Outputx Digital 0 or 1 Digital stage control output.
(x=2 to 4)
NOTE: Two outputs are always visible. The other
remaining outputs can be added through the
Properties pane.
Block properties See also Common block properties.
Property Type Range Default Description
NumberOf Integer 2 to 4 2 Number of stages being controlled.
Stages
Thermostat
Description Used to control a single stage, two-state (On/Off) load for heating or cooling
for example. The dead band can be configured to be above the setpoint, cen-
tered on the setpoint, or it can be below the setpoint.
464 EC-gfxProgram
This holds the output value steady until the input value goes outside the dead-
band limits. It prevents the output from short cycling due to small, yet frequent
changes to the input.
Figure 286: The Thermostat block operation when Above the setpoint is set as the
DeadBandType in the Block’s Properties pane.
EC-gfxProgram 465
Figure 287: The Thermostat block operation when Centered on the setpoint is set as
the DeadBandType in the Block’s Properties pane.
Figure 288: The Thermostat block operation when Below the setpoint is set as the
DeadBandType in the Block’s Properties pane.
Advanced Configure Ports, Show/Hide Ports
configuration
Related blocks Hysteresis
466 EC-gfxProgram
Input(s)
Port Type Range Description
32-Bit 8-Bit
Input Numeric ±3.4028×1038 -83886.08 to The controlled variable.
+83886.07
Setpoint Numeric ±3.4028×1038 -83886.08 to The setpoint value.
+83886.07
Deadband Numeric ±3.4028×1038 -83886.08 to The dead band is a range in which
+83886.07 no corrective action is taken, that is,
the output remains unchanged. The
dead band range (Above the
setpoint, Centered on the setpoint,
or Below the setpoint) is set in
DeadBandType in the Block’s
Properties pane.
NOTE: Any negative input value is
made positive (absolute
value).
A zero input value is made
to be 0.01.
EC-gfxProgram 467
Output(s)
Port Type Range Description
Direct Digital 0 or 1 The behavior varies according to how DeadBandType is set
in the Thermostat Block’s Properties pane:
• DeadBandType in the Block’s Properties Pane set to
Above:
• On when the Input >= Setpoint + Deadband
• Off when the Input <= Setpoint
• When the input varies between (Setpoint + Dead-
band) and Setpoint, the Direct output remains
unchanged.
• DeadBandType in the Block’s Properties Pane set to
Centered:Direct:
• On when the Input >= Setpoint + (Deadband / 2)
• Off when the Input <= Setpoint - (Deadband / 2)
• When the input varies between (Setpoint + (Dead-
band/2)) and (Setpoint - (Deadband/2)), the Direct
output remains unchanged.
• DeadBandType in the Block’s Properties Pane set to
Below:
• On when the Input >= Setpoint
• Off when the Input <= Setpoint – Deadband
• When the input varies between Setpoint and (Set-
point - Deadband), the Direct output remains
unchanged.
Reverse Digital 0 or 1 The logically inverted value of the Direct output.
Block properties See also Common block properties.
Property Type Range Default Description
DeadBand Integer Above/ Centered The dead band position with regard to the
Type Centered/ setpoint. See the description for Direct in
Below Output(s) above.
468 EC-gfxProgram
Inputs and Outputs
Inputs and Outputs are blocks used to interface with various types of physical
inputs and outputs, as well as network variable inputs (NVIs) and network
variable outputs (NVOs).
The following blocks are available in this category:
• BLE Room Device (ECY Series)
• BLE Room Device (ECY-STAT Series)
• ComSensor (ECL Series)
• ComSensor (ECB & ECY Series)
• ComSensor Condition (ECL, ECB & ECY Series)
• ComSensor Condition Selector (ECL, ECB & ECY Series)
• ComSensor Value (ECL, ECB & ECY Series)
• ComSensor Value Selector (ECL, ECB & ECY Series)
• EnOcean Device (ECY Series)
• Floating Output (ECP Series)
• Floating Output (ECL Series)
• Floating Output (ECB & ECY Series)
• Hardware Input (ECP Series)
• Hardware Input (ECB & ECY Series)
• Hardware Output (ECP Series)
• Hardware Output (ECL Series)
• Hardware Output (ECB & ECY Series)
• Led Output (ECP Series)
• Light Output (ECL Series expansion modules)
• Light Output (ECB & ECY Series expansion modules)
• Light Sunblind Input (ECL Series expansion modules)
• Light Sunblind Input (ECB & ECY Series expansion modules)
• Modbus Device (ECY Series)
• Multi Sensor (ECL Series expansion module)
• Multi Sensor (ECB & ECY Series expansion modules)
• Network Value (ECB & ECY Series)
• Network Variable Input (ECP Series)
• Network Variable Input (ECL Series)
• Network Variable Output (ECP Series)
• Space Comfort Controller (ECL Series)
EC-gfxProgram 469
• Subnet Extension (ECL Series)
• Subnet Extension (ECB & ECY Series)
• Wireless Module (ECP Series)
• Wireless Sensor (ECB Series)
ECL Series Controllers that support the following LONMARK objects:
• Unit Heater Profile LONMARK Object #8550
• Wall Unit Profile LONMARK Object #8540
• Roof Top Unit Profile LONMARK Object #8504 and Space Comfort Control-
ler AHU Profile LONMARK Object #8508
• Hardwired Gas Detection Profile LONMARK Object #4310
• Hardwired Fire Alarm Profile LONMARK Object #4311
• Hardwired Reticulation Profile LONMARK Object #4312
• Hardwired Full Ventilation Profile LONMARK Object #4313
• Hardwired Safety Instrumented System (SIS) Profile LONMARK Object
#4314
470 EC-gfxProgram
BLE Room Device (ECY Series)
Description This block is used to interface with Allure UNITOUCHTM Sensors, EC-Multi-
Sensor-BLE devices, and UNIWAVE devices connected to a controller’s sub-
network bus.
Number of The number of BLE Room Devices varies according to the number of con-
blocks nected devices, up to a maximum of 6 devices on an ECY-S1000 and 4
devices on an ECY-PT/U, ECY-VAV, or ECY-303. See the controller’s data-
sheet for more information about the number/combinations of BLE Room
Devices that are supported.
Advanced Resources Configuration, Configuring a BLE Room Device resource, Alarms
configuration (ECB & ECY Series), Find All References (ECL, ECB & ECY Series), Copy
From, Configure Ports, Show/Hide Ports
Related blocks Light Output (ECB & ECY Series expansion modules), Light Sunblind Input
(ECB & ECY Series expansion modules), BLE Room Device (ECY-STAT
Series)
Input(s) Input port availability and names will depend on the device’s configuration. If
the port you need is not listed, make sure the corresponding option is enabled
in the configuration. See Configuring a BLE Room Device resource.
Port Type Range Description
Enabled Digital 0 or 1 Used to enable or disable the block. Setting
this to 0 disables the block while setting it to 1
enables the block. If the block is disabled, the
outputs are set to 0, null or the port default
value.
NOTE: If the block is enabled when the corre-
sponding physical device is not con-
nected to the controller, some delays
and errors may occur on the network.
Thus, it is recommended that this port
always be linked, and that the block
only be enabled when a physical
device is connected.
EC-gfxProgram 471
Port Type Range Description
SpaceTemp- Numeric ±3.4028 ×1038 When alarms are enabled for this parameter
AlarmSetpoint (see Alarms (ECB & ECY Series)), a positive
input value increases the alarm setpoint val-
ues set in the Options tree of the configura-
tion window (a negative value reduces the
alarm setpoint values): The High limit is now
the High limit value (set in the Resources
Configuration’s Alarms configuration for the
block) plus AlarmSetpoint and the Low limit
is now the Low limit value (set in the
Resources Configuration’s Alarms configura-
tion for the block) plus AlarmSetpoint.
NOTE: When the AlarmSetpoint input is dis-
connected, you must reset the con-
troller (see Project Synchronization)
or connect a Null value (ECL, ECB &
ECY Series) block to this port so the
controller will release this port as
being unconnected. When the Alarm-
Setpoint input is disconnected, the
High limit and Low limit can be writ-
ten to through the BACnet interface.
SpaceTemp- Digital 0 or 1 While set to True (1), no alarms will be
AlarmInhibit reported by the block. See AlarmInhibit input
(ECY Series controllers).
HumidityAlarm- Numeric ±3.4028 ×1038 When alarms are enabled for this parameter
Setpoint (see Alarms (ECB & ECY Series)), a positive
input value increases the alarm setpoint val-
ues set in the Options tree of the configura-
tion window (a negative value reduces the
alarm setpoint values): The High limit is now
the High limit value (set in the Resources
Configuration’s Alarms configuration for the
block) plus AlarmSetpoint and the Low limit
is now the Low limit value (set in the
Resources Configuration’s Alarms configura-
tion for the block) plus AlarmSetpoint.
NOTE: When the AlarmSetpoint input is dis-
connected, you must reset the con-
troller (see Project Synchronization)
or connect a Null value (ECL, ECB &
ECY Series) block to this port so the
controller will release this port as
being unconnected. When the Alarm-
Setpoint input is disconnected, the
High limit and Low limit can be writ-
ten to through the BACnet interface.
472 EC-gfxProgram
Port Type Range Description
HumidityAlarmIn- Digital 0 or 1 While set to True (1), no alarms will be
hibit reported by the block. See AlarmInhibit input
(ECY Series controllers).
CO2Alarm- Numeric ±3.4028 ×1038 When alarms are enabled for this parameter
Setpoint (see Alarms (ECB & ECY Series)), a positive
input value increases the alarm setpoint val-
ues set in the Options tree of the configura-
tion window (a negative value reduces the
alarm setpoint values): The High limit is now
the High limit value (set in the Resources
Configuration’s Alarms configuration for the
block) plus AlarmSetpoint and the Low limit
is now the Low limit value (set in the
Resources Configuration’s Alarms configura-
tion for the block) plus AlarmSetpoint.
NOTE: When the AlarmSetpoint input is dis-
connected, you must reset the con-
troller (see Project Synchronization)
or connect a Null value (ECL, ECB &
ECY Series) block to this port so the
controller will release this port as
being unconnected. When the Alarm-
Setpoint input is disconnected, the
High limit and Low limit can be writ-
ten to through the BACnet interface.
CO2AlarmInhibit Digital 0 or 1 While set to True (1), no alarms will be
reported by the block. See AlarmInhibit input
(ECY Series controllers).
EC-gfxProgram 473
Port Type Range Description
MotionAlarm- Numeric ±3.4028 ×1038 When alarms are enabled for this parameter
Setpoint (see Alarms (ECB & ECY Series)), a positive
input value increases the alarm setpoint val-
ues set in the Options tree of the configura-
tion window (a negative value reduces the
alarm setpoint values): The High limit is now
the High limit value (set in the Resources
Configuration’s Alarms configuration for the
block) plus AlarmSetpoint and the Low limit
is now the Low limit value (set in the
Resources Configuration’s Alarms configura-
tion for the block) plus AlarmSetpoint.
NOTE: When the AlarmSetpoint input is dis-
connected, you must reset the con-
troller (see Project Synchronization)
or connect a Null value (ECL, ECB &
ECY Series) block to this port so the
controller will release this port as
being unconnected. When the Alarm-
Setpoint input is disconnected, the
High limit and Low limit can be writ-
ten to through the BACnet interface.
MotionAlarm- Digital 0 or 1 While set to True (1), no alarms will be
Inhibit reported by the block. See AlarmInhibit input
(ECY Series controllers).
LuxLevelAlarm- Numeric ±3.4028 ×1038 When alarms are enabled for this parameter
Setpoint (see Alarms (ECB & ECY Series)), a positive
input value increases the alarm setpoint val-
ues set in the Options tree of the configura-
tion window (a negative value reduces the
alarm setpoint values): The High limit is now
the High limit value (set in the Resources
Configuration’s Alarms configuration for the
block) plus AlarmSetpoint and the Low limit
is now the Low limit value (set in the
Resources Configuration’s Alarms configura-
tion for the block) plus AlarmSetpoint.
NOTE: When the AlarmSetpoint input is dis-
connected, you must reset the con-
troller (see Project Synchronization)
or connect a Null value (ECL, ECB &
ECY Series) block to this port so the
controller will release this port as
being unconnected. When the Alarm-
Setpoint input is disconnected, the
High limit and Low limit can be writ-
ten to through the BACnet interface.
474 EC-gfxProgram
Port Type Range Description
LuxLevelAlarm- Digital 0 or 1 While set to True (1), no alarms will be
Inhibit reported by the block. See AlarmInhibit input
(ECY Series controllers).
(The names of the ports outlined below represent the names when the default value configuration is
used for these parameters. The names in your project may vary based on the configuration used for
the device.)
Temperature Numeric -83886.08 to The temperature setpoint. If this input
Setpoint +83886.07 receives a change of value, it will override
any setpoint set by the user through an Allure
UNITOUCH device or the mobile app until
there is another change of value through this
input or set by the user.
Fan Speed Level Enum 1 to 5 The current fan speed.
Feedback 1: Auto
2: Off
3: Low
4: Medium
5: High
NOTE: This port is only available when the
fan speed is configured in Level
mode.
Fan Speed Numeric 0 to 100 The current fan speed.
Analog Feedback
NOTE: This port is only available when the
fan speed is configured in Analog
mode.
Heating/Cooling Enum 1 to 3 The heating/cooling status.
Status 1: Auto
2: Heat
3: Cool
EC-gfxProgram 475
Port Type Range Description
Eco-Vue Status Enum 1 to 5 Sets the Eco Vue icon display properties. To
encourage occupants to be as green as pos-
sible, the Eco Vue icon can be programmed
to show more leaves when the occupant
chooses a setpoint that reduces energy use.
This helps to promote awareness for energy
consciousness and to save operational costs.
1: Low energy efficiency
2: Moderate energy efficiency
3: Higher energy efficiency
4: Highest energy efficiency
5: Hide
Occupancy Enum See description The current occupancy state.
Status 1: Occupied
2: Unoccupied
3: Bypass
4: Standby
[Group #] Light Numeric 0 to 100 The current state (in %) of the lights in [Group
Feedback #], where [Group #] stands for the name of
the light variable associated with the group.
[Group #] Numeric 0 to 100 The current vertical position (in %) of the sun-
Sunblind Transla- blinds in [Group #], where [Group #] stands
tion Feedback for the name of the sunblind translation vari-
able associated with the group.
[Group #] Numeric 0 to 90 when The current rotation angle of the sunblinds in
Sunblind Rota- Sunblind mode [Group #], where [Group #] stands for the
tion Feedback is Translation name of the sunblind rotation variable associ-
& Rotation 90 ated with the group.
deg
or
-90 to 90 when
Sunblind mode
is Translation
& Rotation
180 deg
476 EC-gfxProgram
Port Type Range Description
[Custom Action] Digital 0 or 1 When Custom Actions have been configured
for the BLE Room Device, this inputs the
state of the Custom Action, where [Custom
Action] stands for the name of the Custom
Action as defined in the configuration:
0: Inactive
1: Active
NOTE: The use of this port is not mandatory.
It is only useful when visual feedback
for the action state is required by the
physical room device. When the Cus-
tom Action is used as a simple trigger,
in which case states are not applica-
ble, this port should not be used.
ResetFanSpeed- Digital 0 or 1 When a BLE Room Device is configured to
Override support the auto mode for fan speed, a pulse
at this input resets the Fan Speed Level or
Fan Speed Analog output to Auto.
ResetLight- Digital 0 or 1 When a BLE Room Device is configured to
Override support the auto mode for lights, a pulse at
this input resets all the [Group#] Light out-
puts to Auto (null).
ResetSunblind- Digital 0 or 1 When a BLE Room Device is configured to
Override support the auto mode for sunblinds, a pulse
at this input resets all the [Group#] Sunblind
outputs to Auto (null).
Output(s) Output port availability and name will depend on the device’s configuration. If
the port you need is not listed, make sure the corresponding option is enabled
in the configuration. See Configuring a BLE Room Device resource.
Port Type Range Description
Number Integer - The current block number.
Reliability Enum See description This provides an indication of whether the
BLE Room Device is physically present (No
fault detected (0)) or not (Communication
failure (12)). See also Reliability property.
SpaceTemp Numeric 5 to 40ºC The room’s temperature.
41 to 104ºF
NOTE: Any change in the measurement sys-
tem of the project results in the output
value being converted.
EC-gfxProgram 477
Port Type Range Description
SpaceTemp- Digital 0 or 1 For the SpaceTemp output: See Out-of-Ser-
OutOfService vice.
SpaceTempFault Digital 0 or 1 For the SpaceTemp output: This is logically
True (1) if the Reliability property does not
have a value of No fault detected (0).
SpaceTemp- Enum See description For the SpaceTemp output: When BLE Room
Reliability Device communication is lost, this becomes
Communication failure (12) otherwise this is
No fault detected (0).
SpaceTemp- Digital 0 or 1 When Enable Alarms is set for a block
InAlarm instance and the present value is outside of
the High limit and Low limit settings and tak-
ing into consideration the Dead band and
Time delay settings, this output is On (1). See
Analog Value (ECB & ECY Series) for more
information about this output. See Alarms
(ECB & ECY Series) to configure the alarm
settings.
Humidity Numeric 0 to 100 The room’s humidity level.
HumidityOutOf- Digital 0 or 1 For the Humidity output: See Out-of-Service.
Service
HumidityFault Digital 0 or 1 For the Humidity output: This is logically True
(1) if the Reliability property does not have a
value of No fault detected (0).
Humidity- Enum See description For the Humidity output: When BLE Room
Reliability Device communication is lost, this becomes
Communication failure (12) otherwise this is
No fault detected (0).
HumidityInAlarm Digital 0 or 1 When Enable Alarms is set for a block
instance and the present value is outside of
the High limit and Low limit settings and tak-
ing into consideration the Dead band and
Time delay settings, this output is On (1). See
Analog Value (ECB & ECY Series) for more
information about this output. See Alarms
(ECB & ECY Series) to configure the alarm
settings.
CO2 Numeric 0 to 2000 The room’s CO2 level.
CO2OutOf- Digital 0 or 1 For the CO2 output: See Out-of-Service.
Service
CO2Fault Digital 0 or 1 For the CO2 output: This is logically True (1) if
the Reliability property does not have a value
of No fault detected (0).
478 EC-gfxProgram
Port Type Range Description
CO2Reliability Enum See description For the CO2 output: When BLE Room Device
communication is lost, this becomes Commu-
nication failure (12) otherwise this is No fault
detected (0).
CO2InAlarm Digital 0 or 1 When Enable Alarms is set for a block
instance and the present value is outside of
the High limit and Low limit settings and tak-
ing into consideration the Dead band and
Time delay settings, this output is On (1). See
Analog Value (ECB & ECY Series) for more
information about this output. See Alarms
(ECB & ECY Series) to configure the alarm
settings.
Motion Digital 0 or 1 The detected motion.
MotionOutOf- Digital 0 or 1 For the Motion output: See Out-of-Service.
Service
MotionFault Digital 0 or 1 For the Motion output: This is logically True
(1) if the Reliability property does not have a
value of No fault detected (0).
MotionReliability Enum See description For the Motion output: When BLE Room
Device communication is lost, this becomes
Communication failure (12) otherwise this is
No fault detected (0).
MotionInAlarm Digital 0 or 1 When Enable Alarms is set for a block
instance and the present value is outside of
the High limit and Low limit settings and tak-
ing into consideration the Dead band and
Time delay settings, this output is On (1). See
Analog Value (ECB & ECY Series) for more
information about this output. See Alarms
(ECB & ECY Series) to configure the alarm
settings.
LuxLevel Numeric 0 to 4000 The current room light level in Lux measured
at the Multi Sensor.
LuxLevelOutOf- Digital 0 or 1 For the LuxLevel output: See Out-of-Service.
Service
LuxLevelFault Digital 0 or 1 For the LuxLevel output: This is logically True
(1) if the Reliability property does not have a
value of No fault detected (0).
LuxLevel- Enum See description For the LuxLevel output: When BLE Room
Reliability Device communication is lost, this becomes
Communication failure (12) otherwise this is
No fault detected (0).
EC-gfxProgram 479
Port Type Range Description
LuxLevelInAlarm Digital 0 or 1 When Enable Alarms is set for a block
instance and the present value is outside of
the High limit and Low limit settings and tak-
ing into consideration the Dead band and
Time delay settings, this output is On (1). See
Analog Value (ECB & ECY Series) for more
information about this output. See Alarms
(ECB & ECY Series) to configure the alarm
settings.
(The names of the ports outlined below represent the names when the default value configuration is
used for these parameters. The names in your project may vary based on the configuration used for
the device.)
Temperature Numeric See description The current temperature setpoint for the con-
Setpoint troller. The High and Low limits are deter-
mined by the resource’s configuration.
Temperature Digital 0 or 1 Outputs a pulse when user activity updates
SetpointUpdate the Temperature Setpoint.
Fan Speed Level Enum 1 to 5 The level of the fan speed.
1: Auto
2: Off
3: Low
4: Medium
5: High
NOTE: This port is only available when the fan
speed is configured in Level mode.
Fan Speed Digital 0 or 1 Outputs a pulse when user activity updates
LevelUpdate the Fan Speed.
NOTE: This port is only available when the fan
speed is configured in Level mode.
Fan Speed Numeric Null The speed of the fan (in %).
Analog or
0 to 100 NOTE: This port is only available when the fan
speed is configured in Analog mode.
Fan Speed Digital 0 or 1 Outputs a pulse when user activity updates
AnalogUpdate the Fan Speed.
NOTE: This port is only available when the fan
speed is configured in Analog mode.
Occupancy Enum See description The current occupancy state.
Status 1: Occupied
2: Unoccupied
3: Bypass
4: Standby
480 EC-gfxProgram
Port Type Range Description
Occupancy Digital 0 or 1 Outputs a pulse when user activity updates
StatusUpdate the Occupancy Status.
[Group #] Light Numeric Null The current state/command of the lights in
or [Group #], where [Group #] stands for the
0 to 100 name of the light variable associated with the
group.
NOTE: This value is either a percentage rang-
ing from 0 to 100, or null (when the
Auto mode is selected for the group).
[Group #] Digital 0 or 1 Outputs a pulse when user activity updates
LightUpdate the lights of the [Group #], where [Group #]
stands for the name of the light variable asso-
ciated with the group.
[Group #] Sun- Numeric Null The current state/command vertical position of
blind Translation or the sunblinds in [Group #], where [Group #]
0 to 100 stands for the name of the sunblind translation
variable associated with the group.
NOTE: This value is either a percentage rang-
ing from 0 to 100, or null (when the
Auto mode is selected for the group).
[Group #] Digital 0 or 1 Outputs a pulse when user activity updates
Sunblind Trans- the sunblind translation of the [Group #],
lationUpdate where [Group #] stands for the name of the
light variable associated with the group.
[Group #] Sun- Numeric Null The current state/command rotation angle of
blind Rotation or the sunblinds in [Group #], where [Group #]
0 to 90 when stands for the name of the sunblind rotation
Sunblind mode variable associated with the group.
is Translation
& Rotation 90
deg
or
-90 to 90 when
Sunblind mode
is Translation
& Rotation
180 deg
[Group #] Digital 0 or 1 Outputs a pulse when user activity updates
Sunblind Rota- the sunblind rotation of the [Group #], where
tionUpdate [Group #] stands for the name of the sunblind
rotation variable associated with the group.
EC-gfxProgram 481
Port Type Range Description
[Custom Action] Digital 0 or 1 When Custom Actions have been configured
for the BLE Room Device, this outputs the
state of the Custom Action, where [Custom
Action] stands for the name of the Custom
Action as defined in the configuration:
0: Inactive
1: Active
[Custom Digital 0 or 1 When Custom Actions have been configured
Action]Update for the BLE Room Device, this outputs a pulse
when user activity has triggered the custom
action, where [Custom Action] stands for the
name of the Custom Action as defined in the
configuration.
Remote Space- Numeric 0 to 50ºC The room‘s temperature deriving from the
Temp (A & B) 32 to 122ºF Allure UNIWAVE that communicates with an
EC-Multi-Sensor-BLE.
NOTE: Any change in the measurement sys-
tem of the project results in the output
value being converted.
Remote Humid- Numeric 1 to 100 The room’s humidity level deriving from the
ity (A & B) Allure UNIWAVE, equipped with a humidity
sensor, that communicates with an EC-Multi-
Sensor-BLE.
Remote Status Enum 1 to 4 The UNIWAVE series status:
(A & B) 1: Disconnected
2: Battery Low
3: Battery Medium
4: Battery High
Remote RSSI Numeric -50 to -75 The signal strength is measured in dBm. We
(A & B) recommend having a signal between -50
(good signal quality) and -75 (bad signal qual-
ity) dBm to ensure a proper connection
between UNIWAVE and EC-Multi-Sensor-
BLE.
482 EC-gfxProgram
Block properties See also Common block properties.
Property Type Range Default Description
Number Menu See RoomDevice 1 Use this drop-down menu to
Description select a physical Allure
UNITOUCH or EC-Multi-Sensor-
BLE Sensor connected to this
controller. The number of sensors
supported by a controller is
shown in this drop-down list or in
the Statistics pane. This usually
corresponds to the Allure
UNITOUCH or EC-Multi-Sensor-
BLE Sensor’s subnet ID number.
Adding a BLE Room Device Resource
1. In the Resource Configuration window, right-click Devices under BLE
Room Devices and select Add or Add With Options.
If you select Add With Options, you will be prompted to specify the Num-
ber of devices to add and the Start number of the first device in the
range. The number is automatically incremented by 1 for each subse-
quent device.
2. Enter the device’s name and description.
3. Choose the model.
4. Select the configuration to use for the device. You can use the same con-
figuration for several devices of different models. The options that apply to
the specified model will be considered, while the options that don’t apply
(for instance, CO2 options for an EC-Multi-Sensor) will be ignored.
When you add the first device in your project, a configuration is created
by default. To edit this configuration, click Configure. To add a new con-
figuration, click .
5. Specify the ID of the device on the controller’s Subnet network.
EC-gfxProgram 483
6. If necessary, enter offset values to calibrate the device’s sensors (vary
based on model).
The offset is a constant value that is applied to the block’s output to com-
pensate for reading errors, for example, to perform sensor calibration.
For example, assume that a temperature sensor is connected to one of
the hardware inputs. If the actual room temperature is 72ºF but the sensor
reading is 74ºF, an offset of -2ºF can be applied to correct the error.
Configuring a BLE Room Device resource
A configuration is created by default when you add the first device in the proj-
ect. You can modify this configuration, or any existing configuration, as well as
create new configurations. You can create as many configurations as neces-
sary. You can also use the same configuration for several devices.
If you know how you would like your project’s BLE devices to be configured,
you can create the configurations you need ahead of time, and associate
them with the physical devices later on.
NOTE: A configuration can be associated with more than one device.
To create new configurations:
• Select an existing device and click on the right of the Configuration
drop-down list.
• Right-click Configuration under BLE Room Devices and select Add Sim-
ple Configuration.
484 EC-gfxProgram
To edit existing configurations:
• Select an existing device. Choose the configuration you want to modify
and click Configure on the right of the Configuration drop-down list.
• Select an existing configuration under BLE Room Devices > Configura-
tions.
The BLE Room Device configuration screen is divided in sections that repre-
sent every available options for room devices, regardless of models. If you
apply a configuration to a device that includes options not available in its
specified models, these options will be ignored.
For each set of options, you can choose whether it will be available to view
and modify on the associated devices. Each enabled option will also add an
input/output to the BLE Device Block and create default resources (such as
values and group definitions).
General 1. Give a Name to your configuration.
Lights 1. Choose whether the Light option will be available for users to access in
the rolling menu on the associated devices.
2. Click to access the Group Definition Selector window, where you can
manage your light groups definition. See Light/Sunblind Group Defini-
tions.
Temperature 1. Choose whether the Temperature option will be available for users to
access in the rolling menu on the associated devices.
If this is the case, click to access the Value Selector window, where
you can choose which temperature value will be shown. See Values.
2. Choose whether the Temperature Setpoint will be shown and modifiable
on the associated devices.
If this is the case, click to access the Value Selector window, where
you can choose which temperature setpoint value and Heating/Cooling
icons will be shown.
EC-gfxProgram 485
(The following options are only available if the Setpoint option is enabled.)
3. Choose whether the Setpoint mode is Absolute or Relative.
If the Setpoint mode is Absolute, specify the Minimum and Maximum
values for the space temperature. The space temperature is then limited
to the values within this range.
If the Setpoint mode is Relative, specify the relative value. The space
temperature is then limited to the current setpoint plus or minus this value.
4. If the Setpoint mode is Absolute, set the Default setpoint, and specify
the Increment by which it can be increased or decreased.
Fan 1. Choose whether the Fan speed option will be available for users to
access in the rolling menu and modify on the associated devices.
If this is the case, click to access the Value Selector window, where
you can choose which fan speed and fan speed feedback values will be
shown. See Values.
2. Choose whether the devices with this configuration will support Auto
mode.
When fans are set in Auto mode, this means that the EC-gfxProgram
logic is controlling fans, rather than a user-entered value.
3. Select whether the fan speed mode is Level (Auto, Off, Low, Medium,
High) or Analog (percentage).
486 EC-gfxProgram
Sunblinds 1. Choose whether the Sunblinds option will be available for users to access
in the rolling menu and modify on the associated devices.
2. Click to access the Group Definition Selector window, where you can
manage your sunblind groups definition. See Light/Sunblind Group Defini-
tions.
Custom Actions 1. Choose whether the Custom Actions option will be shown for the associ-
ated devices.
Click to access the Custom Actions Configuration window window,
where you can manage your Custom Actions. See Custom Actions.
Humidity 1. Choose whether Humidity information will be shown on the associated
devices.
If this is the case, click to access the Value Selector window, where
you can choose which humidity value will be shown. See Values.
CO2 1. Choose whether CO2 information will be shown on the associated
devices.
If this is the case, click to access the Value Selector window, where
you can choose which CO2 value will be shown. See Values.
Image 1. Choose whether a Custom image will be shown in the image (rolling
screens) of the associated devices.
If this is the case, choose the image file on your computer or network.
• Supported file formats are .gif, . jpg, .jpeg, .bmp, and .png.
• The maximum supported size is 260 pixels (W) x 200 pixels (H). If the
selected file is larger, EC-gfxProgram scales it down and centers it.
A preview of the image is shown.
Since the Allure UNITOUCH background is either black (dark theme) or
white (pale theme), it is recommended to use the alpha channel in your
image to be sure it will be shown correctly on both themes. The alpha
channel can be used to set some portion of your image as transparent (or
EC-gfxProgram 487
semi-transparent) color to let the black or white UNITOUCH background
filter through.
Click the icon to revert to the default image.
Menu 1. Choose whether the my PERSONIFY item will be visible in the menu of
the associated device, allowing users to view and modify the settings
related to the my PERSONIFY mobile application. Unchecking this check-
box hides the my PERSONIFY item and allows you to replace it with your
own custom menu by using REST API.
2. Choose whether the device Settings will be available in the menu of the
associated devices for users to view and modify.
3. Choose whether the Technician Mode item will be visible in the menu of
the associated device, allowing users to directly adjust the related subnet
ID settings.
4. Choose whether a custom company Logo will be shown in the menu of
the associated devices. If not, the Distech Controls logo is shown.
To show a custom logo, choose the file on your computer or network.
• Supported file formats are .gif, . jpg, .jpeg, .bmp, and .png.
• The maximum supported size is 210 pixels (W) x 90 pixels (H). If the
selected file is larger, EC-gfxProgram scales it down and centers it.
A preview of the logo is shown.
Since the Allure UNITOUCH background is either black (dark theme) or
white (pale theme), it is recommended to use the alpha channel in your
image to be sure it will be shown correctly on both themes. The alpha
channel can be used to set some portion of your image as transparent (or
semi-transparent) color to let the black or white UNITOUCH background
filter through.
Click the icon to revert to the default image.
488 EC-gfxProgram
Options 1. Choose whether the Eco-Vue or Occupancy status are to be shown on
the Allure UNITOUCH or my PERSONIFY mobile app.
If this is the case, click for each option to access the Value Selector
window where you can choose which Eco-Vue and Occupancy values will
be shown. See Values.
Wireless room 1. Choose whether to show ambient temperature from the internal sensor, if
sensors temperature sensing is available.
Choose whether to show humidity from the internal sensor, if humidity sensing
is avail-
able.
EC-gfxProgram 489
Timeouts 1. Specify the Edition, Session, and Screen timeout values.
Type Description
Edition Sets the delay before the display returns to the
main menu when there is no user interaction.
Session Sets the delay after which a user who leaves a
password-protected screen must reenter their cre-
dentials when trying to return to a password-pro-
tected screen.
Screen Sets the delay before the device’s screen turns off
when there is no user interaction.
Languages 1. Set the language that will be used by default in the devices associated
with this configuration.
2. Click to make one or more languages available on the associated
devices. Each BLE Room Device can support up to 5 languages.
To remove a language from this list, click .
3. After you modify or add available language(s), you can select which lan-
guage will be used by default on the associated Allure UNITOUCH. The
other languages will be available to users in the device. See the Allure
UNITOUCH user guide for more details.
Light/Sunblind Group Definitions
You can define groups for the lights or sunblinds controlled by a BLE Room
Device. To manage group definitions for the Lights or Sunblinds option:
1. In the configuration screen, click on the right of the Show lights/sun-
blind option to access the Group Definition Selector window.
490 EC-gfxProgram
2. By default, the group definition created for the option is selected. To select
a different definition, click to view the list of definitions available for
this option.
If the group definition you want is not available in the list, click to cre-
ate a new definition (see Creating/configuring group definitions).
To modify the configuration of an existing group definition, click Confi-
gure.
Creating/ There are two ways to create new group definitions:
configuring
group definitions
• Click in the Group Definition Selector window to create a group defi-
nition for the option currently being configured.
In this case, the New Lights/Sunblinds Definition window opens with the
parameters for the appropriate type (Lights or Sunblinds).
• Right-click Values under BLE Room Devices > Resources and click Add
Lights Definition or Add Sunblinds Definition.
In this case, the configuration screen shows the parameters for the cho-
sen type.
1. Give a Name to the group definition.
2. Indicate whether the groups included in the definition Support auto
mode.
3. Select the mode of the lights/sunblinds controlled by the associated
devices.
For lights, the mode can be By group, On/Off, or Dimming.
For sunblinds, the mode can be By group, Translation, Translation &
Rotation 90 degrees, or Translation & Rotation 180 degrees.
4. You do the following actions to manage the groups in the definition:
• Click in the text fields to change the groups’ programming name.
Their display names are changed in the ECLYPSE Web Interface
(see the ECLYPSE user guide).
• Click to add groups.
• Click to remove groups.
EC-gfxProgram 491
• Click to select values for the group (see Value Selector window).
Values
Default values are created automatically when you enable options in a config-
uration. If they are not used in any other configuration and if they have not
been modified, these values are automatically deleted if you disable the
related option in a configuration.
You can use values specifically created for BLE Room Devices, or values
from any resource already configured in you project.
Value Selector When you enable certain options in a configuration, you can then select and
window configure the value associated with the option.
1. To access the Value Selector window, click on the right of a configura-
tion option.
2. By default, the value created for the option is selected. To select a differ-
ent value, click to view the list of values available for this option.
If the value you want to show is not available in the list, click to cre-
ate the value you need (see Creating/configuring values).
To modify the parameters of an existing value, click Configure.
3. Click OK.
492 EC-gfxProgram
Creating/ There are two ways to create new values:
configuring
values
• Click in the Value Selector window to create a value for the option
currently being configured.
In this case, the Category will be set to match the current option in the
configuration, and the New Value window opens with the parameters for
the appropriate type (Numeric or Enumeration).
• Right-click Values under BLE Room Devices > Resources > Values and
click Add Numeric Value or Add Enumeration Value.
In this case, the configuration screen shows the parameters for the cho-
sen type.
1. Give a Name to the value.
2. Specify the configuration Category the value will be used for.
The category is used to filter the values available in the Value Selector
window for specific configuration options (for instance, Fan Speed values
are not available when configuring a Temperature Setpoint). If the value
should be available for different types of options, set the Category to
Unspecified.
If you access the New Value window from the Value Selector window, the
category is set to the one of the configuration option and cannot be
changed.
EC-gfxProgram 493
3. Select the Data source type for the value.
Parameter Description
Resource The value is taken from another EC-gfxProgram
resource (a temperature sensor on another device,
for instance).
In this case, specify the Resource type and
instance.
NOTE: A block must already exist in the project for
the resource to be used as the value.
Program The value will be exposed as a port on the BLE
Room Device block.
In this case, specify the Access type for the value.
Possible options are Read Only, Write Only, and
Read Write.
Configuring Numeric Values
1. Indicate whether the value can be null (Support null value checkbox).
2. Choose the value’s unit from the list of all available units, or from your
Favorite or Recent units.
3. Specify the Default value.
4. Check the Use range checkbox to limit the value’s range, and specify the
Minimum and Maximum values.
494 EC-gfxProgram
Configuring Enumeration Values
1. Click Configure to access the Enumerations Configurations window and
select the value’s Enumeration.
Preconfigured enumerations for BLE Room Device configurations are
under General Enumerations > BLE Room Devices, but you can select
any enumeration available.
You can also add custom enumerations depending on your requirements.
2. Specify the Default value.
Custom Actions
Using Custom Actions, the occupant is able to activate a series of settings
predefined in EC-gfxProgram, e.g. a meeting mode, a concentration mode,
tunable white settings, etc. You can define your own actions for a given BLE
Room Device configuration. Once defined, these actions can be reused in
other configurations.
NOTE: Custom Actions represent action launchers that are visible in the
graphical user interface of your device, allowing end users to activate
or deactivate them. For example, and depending on your EC-gfxPro-
gram strategy, a Custom Action may consist in setting all the lights to
50% of their capacity, setting your blinds to a specific position, etc.
EC-gfxProgram 495
Custom Actions To access the Custom Actions Configuration window, check the Show Cus-
Configuration tom Actions checkbox and click in the BLE Room Device configuration
window screen.
The Custom Actions Configuration window, where each row corresponds to
one Custom Action, allows you to add and remove Custom Actions for your
configuration.
Creating Custom When no Custom Actions have been defined within your current configura-
Actions tion, this window does not contain any element.
1. To add Custom Actions to your configuration, click to create a new
row. A new empty row is added.
2. Click , type a name in the New Custom Action window, and click OK.
NOTE: When creating custom actions, it is recommended that you assign
descriptive names with a maximum of 13 characters for the UNIWAVE
and 15 characters for the UNITOUCH, to ensure that the name is fully
visible on the display.
496 EC-gfxProgram
3. Once you have finished creating the desired number of Custom Actions,
click OK.
WARNING: A newly created Custom Action does not perform any real action.
It first needs to be programmed using the corresponding ports on
the BLE Room Device block.
Reusing Custom Once you have created a Custom Action within a project, it can be reused for
Actions every configuration within the same project.
To reuse a previously created Custom Action, open the Custom Actions Con-
figuration window, click to create a new row, and then select the desired
Custom Action from the Custom Actions drop-down menu:
Removing If you want to remove a Custom Action from your configuration, open the Cus-
Custom Actions
tom Actions Configuration window and click opposite the corresponding
from your
Custom Action
configuration
WARNING: This does not delete the Custom Action from your project but sim-
ply removes it from the current configuration. Once removed, the
Custom Action will still be available and reusable within the proj-
ect. To learn how to delete a Custom Action from your project,
see Deleting Custom Actions.
EC-gfxProgram 497
Renaming You can rename an already created Custom Action in two ways.
Custom Actions
1. Open the Custom Actions Configuration window, click Configure oppo-
site the corresponding Custom Action, and edit its name in the Edit Cus-
tom Action window.
2. Go to BLE Room Devices > Resources > Custom Actions tree in the
Resources Configuration window, select the desired Custom Action,
and edit its name in the Name field, in the right part of your screen. You
can alternatively right-click a Custom Action and select Rename to edit
the name directly in the tree.
Deleting Custom To delete a Custom Action from your project, go to the BLE Room Devices >
Actions Resources > Custom Actions tree in the Resources Configuration win-
dow, right-click a Custom Action, and select Delete.
WARNING: If the Custom Action that you want to delete has been used in a
configuration, a warning message will ask you to confirm the
deletion. Following the deletion, a message will be displayed in
the Output Messages section (visible to the right with the BLE
Room Device selected in the Resource Tree), and a dedicated
red icon will be displayed in the Custom Actions Configuration
and Resource Configuration windows, as well as in the Resource
Configuration tree.
498 EC-gfxProgram
BLE Room Device (ECY-STAT Series)
Description This block is used to interface with an ECY-STAT controller.
To interface with Allure UNITOUCHTM Sensors, EC-Multi-Sensor-BLE
devices, and UNIWAVE devices connected to a controller’s subnetwork bus,
please see section BLE Room Device (ECY Series).
Number of 1
blocks
Advanced Resources Configuration, Configuring a BLE Room Device resource, Alarms
configuration (ECB & ECY Series), Find All References (ECL, ECB & ECY Series), Copy
From, Configure Ports, Show/Hide Ports
Related blocks Light Output (ECB & ECY Series expansion modules), Light Sunblind Input
(ECB & ECY Series expansion modules), BLE Room Device (ECY Series)
Input(s) Input port availability and names will depend on the device’s configuration. If
the port you need is not listed, make sure the corresponding option is enabled
in the configuration. See Configuring a BLE Room Device resource.
Port Type Range Description
Enabled Digital 0 or 1 Used to enable or disable the block. Setting
this to 0 disables the block while setting it to 1
enables the block. If the block is disabled, the
outputs are set to 0, null or the port default
value.
NOTE: If the block is enabled when the corre-
sponding physical device is not con-
nected to the controller, some delays
and errors may occur on the network.
Thus, it is recommended that this port
always be linked, and that the block
only be enabled when a physical
device is connected.
EC-gfxProgram 499
Port Type Range Description
SpaceTemp- Numeric ±3.4028 ×1038 When alarms are enabled for this parameter
AlarmSetpoint (see Alarms (ECB & ECY Series)), a positive
input value increases the alarm setpoint val-
ues set in the Options tree of the configura-
tion window (a negative value reduces the
alarm setpoint values): The High limit is now
the High limit value (set in the Resources
Configuration’s Alarms configuration for the
block) plus AlarmSetpoint and the Low limit
is now the Low limit value (set in the
Resources Configuration’s Alarms configura-
tion for the block) plus AlarmSetpoint.
NOTE: When the AlarmSetpoint input is dis-
connected, you must reset the con-
troller (see Project Synchronization)
or connect a Null value (ECL, ECB &
ECY Series) block to this port so the
controller will release this port as
being unconnected. When the Alarm-
Setpoint input is disconnected, the
High limit and Low limit can be writ-
ten to through the BACnet interface.
SpaceTemp- Digital 0 or 1 While set to True (1), no alarms will be
AlarmInhibit reported by the block. See AlarmInhibit input
(ECY Series controllers).
HumidityAlarm- Numeric ±3.4028 ×1038 When alarms are enabled for this parameter
Setpoint (see Alarms (ECB & ECY Series)), a positive
input value increases the alarm setpoint val-
ues set in the Options tree of the configura-
tion window (a negative value reduces the
alarm setpoint values): The High limit is now
the High limit value (set in the Resources
Configuration’s Alarms configuration for the
block) plus AlarmSetpoint and the Low limit
is now the Low limit value (set in the
Resources Configuration’s Alarms configura-
tion for the block) plus AlarmSetpoint.
NOTE: When the AlarmSetpoint input is dis-
connected, you must reset the con-
troller (see Project Synchronization)
or connect a Null value (ECL, ECB &
ECY Series) block to this port so the
controller will release this port as
being unconnected. When the Alarm-
Setpoint input is disconnected, the
High limit and Low limit can be writ-
ten to through the BACnet interface.
500 EC-gfxProgram
Port Type Range Description
HumidityAlarmIn- Digital 0 or 1 While set to True (1), no alarms will be
hibit reported by the block. See AlarmInhibit input
(ECY Series controllers).
(The names of the ports outlined below represent the names when the default value configuration is
used for these parameters. The names in your project may vary based on the configuration used for
the device.)
Temperature Numeric -83886.08 to The temperature setpoint. If this input
Setpoint +83886.07 receives a change of value, it will override
any setpoint set by the user through an ECY-
STAT device or the mobile app until there is
another change of value through this input or
set by the user.
Temperature Numeric 0 to 100 The current temperature setpoint.
Setpoint
Feedback
Fan Speed Level Enum 1 to 5 The current fan speed.
Feedback 1: Auto
2: Off
3: Low
4: Medium
5: High
NOTE: This port is only available when the
fan speed is configured in Level
mode.
Fan Speed Numeric 0 to 100 The current fan speed.
Analog Feedback
NOTE: This port is only available when the
fan speed is configured in Analog
mode.
Heating/Cooling Enum 1 to 3 The heating/cooling status.
Status 1: Auto
2: Heat
3: Cool
EC-gfxProgram 501
Port Type Range Description
Eco-Vue Status Enum 1 to 5 Sets the Eco Vue icon display properties. To
encourage occupants to be as green as pos-
sible, the Eco Vue icon can be programmed
to show more leaves when the occupant
chooses a setpoint that reduces energy use.
This helps to promote awareness for energy
consciousness and to save operational costs.
1: Low energy efficiency
2: Moderate energy efficiency
3: Higher energy efficiency
4: Highest energy efficiency
5: Hide
Occupancy Enum See description The current occupancy state.
Status 1: Occupied
2: Unoccupied
3: Bypass
4: Standby
[Group #] Light Numeric 0 to 100 The current state (in %) of the lights in [Group
Feedback #], where [Group #] stands for the name of
the light variable associated with the group.
[Group #] Numeric 0 to 100 The current vertical position (in %) of the sun-
Sunblind Transla- blinds in [Group #], where [Group #] stands
tion Feedback for the name of the sunblind translation vari-
able associated with the group.
[Group #] Numeric 0 to 90 when The current rotation angle of the sunblinds in
Sunblind Rota- Sunblind mode [Group #], where [Group #] stands for the
tion Feedback is Translation name of the sunblind rotation variable associ-
& Rotation 90 ated with the group.
deg
or
-90 to 90 when
Sunblind mode
is Translation
& Rotation
180 deg
502 EC-gfxProgram
Port Type Range Description
[Custom Action] Digital 0 or 1 When Custom Actions have been configured
for the BLE Room Device, this inputs the
state of the Custom Action, where [Custom
Action] stands for the name of the Custom
Action as defined in the configuration:
0: Inactive
1: Active
NOTE: The use of this port is not mandatory.
It is only useful when visual feedback
for the action state is required by the
physical room device. When the Cus-
tom Action is used as a simple trigger,
in which case states are not applica-
ble, this port should not be used.
ResetTempera- Digital 0 or 1 When a BLE Room Device is configured to
tureSet- support the auto mode for temperature set-
pointOverride point, a pulse at this input resets the Tem-
perature Setpoint output to Auto.
ResetFanSpeed- Digital 0 or 1 When a BLE Room Device is configured to
Override support the auto mode for fan speed, a pulse
at this input resets the Fan Speed Level or
Fan Speed Analog output to Auto.
ResetLight- Digital 0 or 1 When a BLE Room Device is configured to
Override support the auto mode for lights, a pulse at
this input resets all the [Group#] Light out-
puts to Auto (null).
ResetSunblind- Digital 0 or 1 When a BLE Room Device is configured to
Override support the auto mode for sunblinds, a pulse
at this input resets all the [Group#] Sunblind
outputs to Auto (null).
Output(s) Output port availability and name will depend on the device’s configuration. If
the port you need is not listed, make sure the corresponding option is enabled
in the configuration. See Configuring a BLE Room Device resource.
Port Type Range Description
Number Integer - The current block number.
Reliability Enum See description This provides an indication of whether the
BLE Room Device is physically present (No
fault detected (0)) or not (Communication
failure (12)). See also Reliability property.
EC-gfxProgram 503
Port Type Range Description
SpaceTemp Numeric 5 to 40ºC The room’s temperature.
41 to 104ºF
NOTE: Any change in the measurement sys-
tem of the project results in the output
value being converted.
SpaceTemp- Digital 0 or 1 For the SpaceTemp output: See Out-of-Ser-
OutOfService vice.
SpaceTempFault Digital 0 or 1 For the SpaceTemp output: This is logically
True (1) if the Reliability property does not
have a value of No fault detected (0).
SpaceTemp- Enum See description For the SpaceTemp output: When BLE Room
Reliability Device communication is lost, this becomes
Communication failure (12) otherwise this is
No fault detected (0).
SpaceTemp- Digital 0 or 1 When Enable Alarms is set for a block
InAlarm instance and the present value is outside of
the High limit and Low limit settings and tak-
ing into consideration the Dead band and
Time delay settings, this output is On (1). See
Analog Value (ECB & ECY Series) for more
information about this output. See Alarms
(ECB & ECY Series) to configure the alarm
settings.
Humidity Numeric 0 to 100 The room’s humidity level.
HumidityOutOf- Digital 0 or 1 For the Humidity output: See Out-of-Service.
Service
HumidityFault Digital 0 or 1 For the Humidity output: This is logically True
(1) if the Reliability property does not have a
value of No fault detected (0).
Humidity Enum See description For the Humidity output: When BLE Room
Reliability Device communication is lost, this becomes
Communication failure (12) otherwise this is
No fault detected (0).
HumidityInAlarm Digital 0 or 1 When Enable Alarms is set for a block
instance and the present value is outside of
the High limit and Low limit settings and tak-
ing into consideration the Dead band and
Time delay settings, this output is On (1). See
Analog Value (ECB & ECY Series) for more
information about this output. See Alarms
(ECB & ECY Series) to configure the alarm
settings.
504 EC-gfxProgram
Port Type Range Description
(The names of the ports outlined below represent the names when the default value configuration is
used for these parameters. The names in your project may vary based on the configuration used for
the device.)
Temperature Numeric See description The current temperature setpoint for the con-
Setpoint troller. The High and Low limits are deter-
mined by the resource’s configuration.
Temperature Digital 0 or 1 Outputs a pulse when user activity updates
SetpointUpdate the Temperature Setpoint.
Fan Speed Level Enum 1 to 5 The level of the fan speed.
1: Auto
2: Off
3: Low
4: Medium
5: High
NOTE: This port is only available when the fan
speed is configured in Level mode.
Fan Speed Digital 0 or 1 Outputs a pulse when user activity updates
LevelUpdate the Fan Speed.
NOTE: This port is only available when the fan
speed is configured in Level mode.
Fan Speed Numeric Null The speed of the fan (in %).
Analog or
0 to 100 NOTE: This port is only available when the fan
speed is configured in Analog mode.
Fan Speed Digital 0 or 1 Outputs a pulse when user activity updates
AnalogUpdate the Fan Speed.
NOTE: This port is only available when the fan
speed is configured in Analog mode.
HVAC Mode Enum 1 to 5 The state of the HVAC mode.
1: Auto
2: Off
3: Cool
4: Heat
5: Eco
NOTE: This port is only available when the
HVAC mode is configured.
HVAC Outputs a pulse when user activity updates
ModeUpdate the HVAC mode.
NOTE: This port is only available when the
HVAC mode is configured.
EC-gfxProgram 505
Port Type Range Description
Occupancy Enum See description The current occupancy state.
Status 1: Occupied
2: Unoccupied
3: Bypass
4: Standby
Occupancy Digital 0 or 1 Outputs a pulse when user activity updates
StatusUpdate the Occupancy Status.
[Group #] Light Numeric Null The current state/command of the lights in
or [Group #], where [Group #] stands for the
0 to 100 name of the light variable associated with the
group.
NOTE: This value is either a percentage rang-
ing from 0 to 100, or null (when the
Auto mode is selected for the group).
[Group #] Digital 0 or 1 Outputs a pulse when user activity updates
LightUpdate the lights of the [Group #], where [Group #]
stands for the name of the light variable asso-
ciated with the group.
[Group #] Sun- Numeric Null The current state/command vertical position of
blind Translation or the sunblinds in [Group #], where [Group #]
0 to 100 stands for the name of the sunblind translation
variable associated with the group.
NOTE: This value is either a percentage rang-
ing from 0 to 100, or null (when the
Auto mode is selected for the group).
[Group #] Digital 0 or 1 Outputs a pulse when user activity updates
Sunblind Trans- the sunblind translation of the [Group #],
lationUpdate where [Group #] stands for the name of the
light variable associated with the group.
[Group #] Sun- Numeric Null The current state/command rotation angle of
blind Rotation or the sunblinds in [Group #], where [Group #]
0 to 90 when stands for the name of the sunblind rotation
Sunblind mode variable associated with the group.
is Translation
& Rotation 90
deg
or
-90 to 90 when
Sunblind mode
is Translation
& Rotation
180 deg
506 EC-gfxProgram
Port Type Range Description
[Group #] Digital 0 or 1 Outputs a pulse when user activity updates
Sunblind Rota- the sunblind rotation of the [Group #], where
tionUpdate [Group #] stands for the name of the sunblind
rotation variable associated with the group.
[Custom Action] Digital 0 or 1 When Custom Actions have been configured
for the BLE Room Device, this outputs the
state of the Custom Action, where [Custom
Action] stands for the name of the Custom
Action as defined in the configuration:
0: Inactive
1: Active
[Custom Digital 0 or 1 When Custom Actions have been configured
Action]Update for the BLE Room Device, this outputs a pulse
when user activity has triggered the custom
action, where [Custom Action] stands for the
name of the Custom Action as defined in the
configuration.
Block properties See also Common block properties.
Property Type Range Default Description
Number Menu See RoomDevice 1 The ECY-STAT connected to this
Description controller.
BLE Room Device Resource
1. In the Resource Configuration window, select the Device under BLE
Room Devices > Devices.
2. Enter the device’s name and description.
3. Select the configuration to use for the device.
A configuration is created by default. To edit this configuration, click Con-
figure. If the default configuration was removed from the device, click
to add a new one.
4. If necessary, enter offset values to calibrate the device’s sensors (vary
based on model).
The offset is a constant value that is applied to the block’s output to com-
pensate for reading errors, for example, to perform sensor calibration.
EC-gfxProgram 507
For example, assume that a temperature sensor is connected to one of
the hardware inputs. If the actual room temperature is 72ºF but the sensor
reading is 74ºF, an offset of -2ºF can be applied to correct the error.
Configuring a BLE Room Device resource
A configuration is created by default when you add the first device in the proj-
ect.
To edit this configuration:
1. Select the device.Click Configure on the right of the Configuration drop-
down list.
The BLE Room Device configuration screen is divided in sections that repre-
sent every available options for room devices, regardless of models. If you
apply a configuration to a device that includes options not available in its
specified model, these options will be ignored.
For each set of options, you can choose whether it will be available to view
and modify on the associated device. Each enabled option will also add an
input/output to the BLE Device Block and create default resources (such as
values and group definitions).
General 1. Give a Name to your configuration and indicate whether to Use summary
view to enable users to view equipment information on one screen.
508 EC-gfxProgram
Lights 1. Choose whether the Light option will be available for users to access in
the rolling menu on the associated device.
2. Click to access the Group Definition Selector window, where you can
manage your light groups definition. See Light/Sunblind Group Defini-
tions.
Temperature 1. Choose whether the Temperature option will be available for users to
access in the rolling menu on the associated device.
If this is the case, click to access the Value Selector window, where
you can choose which temperature value will be shown. See Values.
2. Choose whether the Temperature Setpoint will be shown and modifiable
on the associated devices.
If this is the case, click to access the Value Selector window, where
you can choose which temperature setpoint value and Heating/Cooling
icons will be shown.
(The following options are only available if the Setpoint option is enabled.)
3. Choose whether the devices with this configuration will support Auto
mode.
When the temperature is set in Auto mode, this means that the EC-gfx-
Program logic is controlling the temperature, rather than a user-entered
value.
4. Choose whether the Setpoint mode is Absolute or Relative.
If the Setpoint mode is Absolute, specify the Minimum and Maximum
values for the space temperature. The space temperature is then limited
to the values within this range.
If the Setpoint mode is Relative, specify the relative value. The space
temperature is then limited to the current setpoint plus or minus this value.
5. If the Setpoint mode is Absolute, set the Default setpoint, and specify
the Increment by which it can be increased or decreased.
EC-gfxProgram 509
Fan 1. Choose whether the Fan speed option will be available for users to
access in the rolling menu and modify on the associated device.
If this is the case, click to access the Value Selector window, where
you can choose which fan speed and fan speed feedback values will be
shown. See Values.
2. Choose whether the devices with this configuration will support Auto
mode.
When fans are set in Auto mode, this means that the EC-gfxProgram
logic is controlling fans, rather than a user-entered value.
3. Select whether the fan speed mode is Level (Auto, Off, Low, Medium,
High) or Analog (percentage).
510 EC-gfxProgram
HVAC 1. Indicate whether the HVAC mode will be will be available for users to
access in the rolling menu.
If this is the case, click to access the Value Selector window, where
you can choose which HVAC mode value will be shown. See Values.
Sunblinds 1. Choose whether the Sunblinds option will be available for users to access
in the rolling menu and modify on the associated device.
2. Click to access the Group Definition Selector window, where you can
manage your sunblind groups definition. See Light/Sunblind Group Defini-
tions.
Custom Actions 1. Choose whether the Custom Actions option will be shown for the associ-
ated device.
Click to access the Custom Actions Configuration window window,
where you can manage your Custom Actions. See Custom Actions.
Humidity 1. Choose whether Humidity information will be shown on the associated
device.
If this is the case, click to access the Value Selector window, where
you can choose which humidity value will be shown. See Values.
CO2 1. Choose whether CO2 information will be shown on the associated device.
If this is the case, click to access the Value Selector window, where
you can choose which CO2 value will be shown. See Values.
EC-gfxProgram 511
Image 1. Choose whether a Custom image will be shown in the image (rolling
screens) of the associated device.
If this is the case, choose the image file on your computer or network.
• Supported file formats are .gif, . jpg, .jpeg, .bmp, and .png.
• The maximum supported size is 260 pixels (W) x 200 pixels (H). If the
selected file is larger, EC-gfxProgram scales it down and centers it.
A preview of the image is shown.
Since the ECY-STAT background is either black (dark theme) or white
(pale theme), it is recommended to use the alpha channel in your image
to be sure it will be shown correctly on both themes. The alpha channel
can be used to set some portion of your image as transparent (or semi-
transparent) color to let the black or white ECY-STAT background filter
through.
Click the icon to revert to the default image.
Menu 1. Choose whether the my PERSONIFY item will be visible in the menu of
the associated device, allowing users to view and modify the settings
related to the my PERSONIFY mobile application. Unchecking this check-
box hides the my PERSONIFY item and allows you to replace it with your
own custom menu by using REST API.
2. Choose whether the device Settings will be available in the menu of the
associated devices for users to view and modify.
3. Choose whether a custom company Logo will be shown in the menu of
the associated devices. If not, the Distech Controls logo is shown.
To show a custom logo, choose the file on your computer or network.
• Supported file formats are .gif, . jpg, .jpeg, .bmp, and .png.
• The maximum supported size is 210 pixels (W) x 90 pixels (H). If the
selected file is larger, EC-gfxProgram scales it down and centers it.
A preview of the logo is shown.
Since the ECY-STAT background is either black (dark theme) or white
(pale theme), it is recommended to use the alpha channel in your image
to be sure it will be shown correctly on both themes. The alpha channel
can be used to set some portion of your image as transparent (or semi-
512 EC-gfxProgram
transparent) color to let the black or white ECY-STAT background filter
through.
Click the icon to revert to the default image.
Options 1. Choose whether the Eco-Vue or Occupancy status are to be shown on
the ECY-STAT or my PERSONIFY mobile app.
If this is the case, click for each option to access the Value Selector
window where you can choose which Eco-Vue and Occupancy values will
be shown. See Values.
Wireless room 1. Choose whether to show ambient temperature from the internal sensor, if
sensors temperature sensing is available.
Choose whether to show humidity from the internal sensor, if humidity sensing
is available.
EC-gfxProgram 513
Timeouts 1. Specify the Edition, Session, and Screen timeout values.
Type Description
Edition Sets the delay before the display returns to the
main menu when there is no user interaction.
Session Sets the delay after which a user who leaves a
password-protected screen must reenter their cre-
dentials when trying to return to a password-pro-
tected screen.
Screen Sets the delay before the device’s screen turns off
when there is no user interaction.
Languages 1. Set the language that will be used by default in the devices associated
with this configuration.
2. Click to make one or more languages available on the associated
devices. The ECY-STAT can support up to 5 languages.
To remove a language from this list, click .
3. After you modify or add available language(s), you can select which lan-
guage will be used by default on the associated ECY-STAT. The other lan-
guages will be available to users in the device. See the ECY-STAT user
guide for more details.
Light/Sunblind Group Definitions
You can define groups for the lights or sunblinds controlled by a BLE Room
Device. To manage group definitions for the Lights or Sunblinds option:
1. In the configuration screen, click on the right of the Show lights/sun-
blind option to access the Group Definition Selector window.
514 EC-gfxProgram
2. By default, the group definition created for the option is selected. To select
a different definition, click to view the list of definitions available for
this option.
If the group definition you want is not available in the list, click to cre-
ate a new definition (see Creating/configuring group definitions).
To modify the configuration of an existing group definition, click Confi-
gure.
Creating/ There are two ways to create new group definitions:
configuring
group definitions
• Click in the Group Definition Selector window to create a group defi-
nition for the option currently being configured.
In this case, the New Lights/Sunblinds Definition window opens with the
parameters for the appropriate type (Lights or Sunblinds).
• Right-click Values under BLE Room Devices > Resources and click Add
Lights Definition or Add Sunblinds Definition.
In this case, the configuration screen shows the parameters for the cho-
sen type.
1. Give a Name to the group definition.
2. Indicate whether the groups included in the definition Support auto
mode.
3. Select the mode of the lights/sunblinds controlled by the associated
devices.
For lights, the mode can be By group, On/Off, or Dimming.
For sunblinds, the mode can be By group, Translation, Translation &
Rotation 90 degrees, or Translation & Rotation 180 degrees.
4. You do the following actions to manage the groups in the definition:
• Click in the text fields to change the groups’ programming name.
Their display names are changed in the ECLYPSE Web Interface
(see the ECLYPSE user guide).
• Click to add groups.
• Click to remove groups.
EC-gfxProgram 515
• Click to select values for the group (see Value Selector window).
Values
Default values are created automatically when you enable options in a config-
uration. If they have not been modified, these values are automatically
deleted if you disable the related option in the configuration.
You can use values specifically created for BLE Room Devices, or values
from any resource already configured in you project.
Value Selector When you enable certain options in a configuration, you can then select and
window configure the value associated with the option.
1. To access the Value Selector window, click on the right of a configura-
tion option.
2. By default, the value created for the option is selected. To select a differ-
ent value, click to view the list of values available for this option.
If the value you want to show is not available in the list, click to cre-
ate the value you need (see Creating/configuring values).
To modify the parameters of an existing value, click Configure.
3. Click OK.
Creating/ There are two ways to create new values:
configuring
values
• Click in the Value Selector window to create a value for the option
currently being configured.
516 EC-gfxProgram
In this case, the Category will be set to match the current option in the
configuration, and the New Value window opens with the parameters for
the appropriate type (Numeric or Enumeration).
• Right-click Values under BLE Room Devices > Resources > Values and
click Add Numeric Value or Add Enumeration Value.
In this case, the configuration screen shows the parameters for the cho-
sen type.
1. Give a Name to the value.
2. Specify the configuration Category the value will be used for.
The category is used to filter the values available in the Value Selector
window for specific configuration options (for instance, Fan Speed values
are not available when configuring a Temperature Setpoint). If the value
should be available for different types of options, set the Category to
Unspecified.
If you access the New Value window from the Value Selector window, the
category is set to the one of the configuration option and cannot be
changed.
3. Select the Data source type for the value.
Parameter Description
Resource The value is taken from another EC-gfxProgram
resource (a temperature sensor on another device,
for instance).
In this case, specify the Resource type and
instance.
NOTE: A block must already exist in the project for
the resource to be used as the value.
Program The value will be exposed as a port on the BLE
Room Device block.
In this case, specify the Access type for the value.
Possible options are Read Only, Write Only, and
Read Write.
EC-gfxProgram 517
Configuring Numeric Values
1. Indicate whether the value can be null (Support null value checkbox).
2. Choose the value’s unit from the list of all available units, or from your
Favorite or Recent units.
3. Specify the Default value.
4. Check the Use range checkbox to limit the value’s range, and specify the
Minimum and Maximum values.
Configuring Enumeration Values
1. Click Configure to access the Enumerations Configurations window and
select the value’s Enumeration.
Preconfigured enumerations for BLE Room Device configurations are
under General Enumerations > BLE Room Devices, but you can select
any enumeration available.
You can also add custom enumerations depending on your requirements.
518 EC-gfxProgram
2. Specify the Default value.
Custom Actions
Using Custom Actions, the occupant is able to activate a series of settings
predefined in EC-gfxProgram, e.g. a meeting mode, a concentration mode,
tunable white settings, etc. You can define your own actions for a given BLE
Room Device configuration.
NOTE: Custom Actions represent action launchers that are visible in the
graphical user interface of your device, allowing end users to activate
or deactivate them. For example, and depending on your EC-gfxPro-
gram strategy, a Custom Action may consist in setting all the lights to
50% of their capacity, setting your blinds to a specific position, etc.
Custom Actions To access the Custom Actions Configuration window, check the Show Cus-
Configuration tom Actions checkbox and click in the BLE Room Device configuration
window screen.
The Custom Actions Configuration window, where each row corresponds to
one Custom Action, allows you to add and remove Custom Actions for your
configuration.
EC-gfxProgram 519
Creating Custom When no Custom Actions have been defined within your current configura-
Actions tion, this window does not contain any element.
1. To add Custom Actions to your configuration, click to create a new
row. A new empty row is added.
2. Click , type a name in the New Custom Action window, and click OK.
NOTE: When creating custom actions, it is recommended that you assign
descriptive names with a maximum of 13 characters for the UNIWAVE
and 15 characters for the ECY-STAT, to ensure that the name is fully
visible on the display.
3. Once you have finished creating the desired number of Custom Actions,
click OK.
520 EC-gfxProgram
WARNING: A newly created Custom Action does not perform any real action.
It first needs to be programmed using the corresponding ports on
the BLE Room Device block.
Removing If you want to remove a Custom Action from your configuration, open the Cus-
Custom Actions
tom Actions Configuration window and click opposite the corresponding
from your
Custom Action
configuration
WARNING: This does not delete the Custom Action from your project but sim-
ply removes it from the current configuration. Once removed, the
Custom Action will still be available and reusable within the proj-
ect. To learn how to delete a Custom Action from your project,
see Deleting Custom Actions.
Renaming You can rename an already created Custom Action in two ways.
Custom Actions
1. Open the Custom Actions Configuration window, click Configure oppo-
site the corresponding Custom Action, and edit its name in the Edit Cus-
tom Action window.
2. Go to BLE Room Devices > Resources > Custom Actions tree in the
Resources Configuration window, select the desired Custom Action,
and edit its name in the Name field, in the right part of your screen. You
can alternatively right-click a Custom Action and select Rename to edit
the name directly in the tree.
Deleting Custom To delete a Custom Action from your project, go to the BLE Room Devices >
Actions Resources > Custom Actions tree in the Resources Configuration win-
dow, right-click a Custom Action, and select Delete.
WARNING: If the Custom Action that you want to delete has been used in a
configuration, a warning message will ask you to confirm the
deletion. Following the deletion, a message will be displayed in
the Output Messages section (visible to the right with the BLE
Room Device selected in the Resource Tree), and a dedicated
red icon will be displayed in the Custom Actions Configuration
and Resource Configuration windows, as well as in the Resource
Configuration tree.
EC-gfxProgram 521
522 EC-gfxProgram
ComSensor (ECL Series)
Description Used to interface with the Allure EC-Smart-Vue Sensor that is connected to a
controller’s subnetwork bus. This block allows the menus and display options
to be defined.
NOTE: Humidity, Motion and CO2 scenes can be configured for this block
even when the corresponding Allure EC-Smart-Vue Sensor does not
have these features. Ensure to only use the actual features supported
by the connected Allure EC-Smart-Vue Sensor (that the Subnet ID
shown in the Options tree corresponds the Subnet ID configured in
the connected Allure EC-Smart-Vue Sensor).
Figure 289: Allure EC-Smart-Vue Sensor
Slim format This block can be collapsed into a slim format. See Collapsed in Common
support block properties.
Advanced Resources Configuration, Configuring a ComSensor resource, Find All Refer-
configuration ences (ECL, ECB & ECY Series), Copy From, Configure Ports, Show/Hide
Ports
EC-gfxProgram 523
Related blocks Generic ComSensor Condition (ECL, ECB & ECY Series), ComSensor Con-
dition (ECL, ECB & ECY Series), ComSensor Value (ECL, ECB & ECY
Series), Wireless Sensor (ECL Series)
Input(s)
Port Type Range Description
Elevation (for Numeric 0 to 4877m The Allure EC-Smart-Vue Sensor’s current elevation
CO2 models above mean sea level. This compensates for the
0 to 16 000ft
only) CO2 gas density ratio found at higher elevations.
This input must be set for any elevation above 500ft
(152m) to obtain the highest elevation compensation
accuracy: The sensor will automatically compensate
CO2 readings for a number of factors including the
current room temperature and the elevation.
Output(s)
Port Type Range Description
SpaceTemp Numeric 5 to 40ºC The room’s temperature.
41 to 104ºF
NOTE: Any change in the measurement system of
the project results in the output value being
converted.
SpaceTemp Digital 0 or 1 For the SpaceTemp output: See Out-of-Service.
OutOfService
SpaceTemp Digital 0 or 1 For the SpaceTemp output: This is logically True (1)
Fault if the Reliability property does not have a value of
No Fault Detected, otherwise logical False (0).
SpaceTemp Enum See For the SpaceTemp output: When Allure EC-Smart-
Reliability Description Vue Sensor communication is lost, this becomes
Communication failure (12) otherwise this is No
fault detected (0).
Humidity Numeric 0 to 100% The room’s relative humidity.
NOTE: A ‘null’ output may indicate that this feature
is not supported by the currently connected
Allure EC-Smart-Vue Sensor.
Humidity Digital 0 or 1 For the Humidity output: See Out-of-Service.
OutOfService
Humidity Digital 0 or 1 For the Humidity output: This is logically True (1) if
Fault the Reliability property does not have a value of No
Fault Detected, otherwise logical False (0).
524 EC-gfxProgram
Port Type Range Description
Humidity Enum See For the Humidity output: When Allure EC-Smart-
Reliability Description Vue Sensor communication is lost, this becomes
Communication failure (12) otherwise this is No
fault detected (0).
NOTE: A No sensor (1) output indicates that this
feature is not supported by the currently con-
nected Allure EC-Smart-Vue Sensor.
CO2 Numeric 0 to The measured CO2 concentration.
2000ppm
NOTE: A ‘null’ output may indicate that this feature
is not supported by the currently connected
Allure EC-Smart-Vue Sensor.
CO2 Digital 0 or 1 For the CO2 output: See Out-of-Service.
OutOfService
CO2 Fault Digital 0 or 1 For the CO2 output: This is logically True (1) if the
Reliability property does not have a value of No
Fault Detected, otherwise logical False (0).
CO2 Enum See For the CO2 output: When Allure EC-Smart-Vue
Reliability Description Sensor communication is lost, this becomes
Communication failure (12) otherwise this is No
fault detected (0).
NOTE: A No sensor (1) output indicates that this
feature is not supported by the currently con-
nected Allure EC-Smart-Vue Sensor.
Motion Digital 0 or 1 The detected motion.
Motion Digital 0 or 1 For the Motion output: See Out-of-Service.
OutOfService
Motion Fault Digital 0 or 1 For the Motion output: This is logically True (1) if
the Reliability property does not have a value of No
Fault Detected, otherwise logical False (0).
Motion Enum See For the Motion output: When Allure EC-Smart-Vue
Reliability Description Sensor communication is lost, this becomes
Communication failure (12) otherwise this is No
fault detected (0).
NOTE: A No sensor (1) output indicates that this
feature is not supported by the currently con-
nected Allure EC-Smart-Vue Sensor.
Number Integer – The current block number.
Block properties See also Common block properties.
EC-gfxProgram 525
Property Type Range Default Description
Number Menu See ComSensor 1 Use this drop-down menu to select a
Description physical Allure EC-Smart-Vue Sensor
connected to this controller. The number
of Allure EC-Smart-Vue Sensors
supported by a controller is shown in
this drop-down list or in the Statistics
pane.
This corresponds to the Allure EC-
Smart-Vue Sensor’s subnet ID number.
Configuring a ComSensor resource
The ComSensor resource is configured in the following places in this order:
1. Right-click a ComSensor block instance and select Configure to set the
ComSensor’s model type and network properties in the Resources Con-
figuration window (see ComSensor resources configuration window).
2. Double-click a ComSensor block instance to create and configure scenes
in the ComSensor Scenes configuration window (see ComSensor Scenes
Configuration window (ECL Series)).
526 EC-gfxProgram
ComSensor resources configuration window
Set the Allure EC-Smart-Vue Sensor’s model type and subnet in the
Resources Configuration window.
Figure 290: Setting the ComSensor Model and Subnet ID
Parameter Description
Model Select the Allure EC-Smart-Vue Sensor model used for
this block instance.
NOTE: If you are uncertain of which Allure EC-Smart-
Vue Sensor model will be used, select the
model that has all options equipped. By detect-
ing a ‘null’ on the ComSensor block’s sensor
output (for example, on the Humidity port), this
may indicate that this feature is not supported
by the currently connected Allure EC-Smart-
Vue Sensor.
However, if the controller is equipped with an
operator interface or it is connected to an ECx-
Display, it is important to set the correct Allure
EC-Smart-Vue Sensor model type as the oper-
ator interface will show alarms for inputs that
are not currently supported by the connected
Allure EC-Smart-Vue Sensor.
Subnet ID The Allure EC-Smart-Vue Sensor’s subnet ID must be
set to this value for it to correspond to this block
instance. Refer to the Allure EC-Smart-Vue Sensor’s
installation guide for the procedure to set this value.
(Common This is the name of the structured network variable
Status) (ECL used to display the actual Allure EC-Smart-Vue Sensor
Series value on the LONWORKS network. Note that because a
controllers only) structured network variable contains more than one
value, the min and max send time are common to all
Allure EC-Smart-Vue Sensors associated to this
structured network variable. See Network Properties
Configuration window (ECL, ECB & ECY Series).
EC-gfxProgram 527
Parameter Description
Min send time The minimum time period that must pass between
(ECL Series network variable updates on the network for the
controllers only) network variable shown immediately above. If the value
of the network variable changes, an update will only be
sent after this time expires. Setting the min send time to
0 disables it. See Network Properties Configuration
window (ECL, ECB & ECY Series).
The min send time is often referred to as the "throttle".
Max send time The maximum time period between automatic
(ECL Series transmissions of the network variable on the network
controllers only) (whether or not the variable’s value has changed) for
the network variable shown immediately above. Setting
the max send time to 0 disables it. See Network
Properties Configuration window (ECL, ECB & ECY
Series).
The max send time is often referred to as the
"heartbeat".
If max receive time is configured for the corresponding
network variable input, the recommended setting for
this value is half the COV max receive time (for an nvo)
value.
Configuring the Select a sensor parameter entry from the ComSensor tree to set the configu-
ComSensor ration parameters to use for sensor readings from the ComSensor such as
block’s outputs the units to be used and the alarm settings.
(ECB & ECY
Series) When the ComSensor is so equipped, according to the model, sensor read-
ings for space temperature, humidity, CO2, and motion are read. The Object
name is used to identify this input in the Resource Viewer and on the control-
ler’s operator interface or on the connected ECx-Display (if equipped).
528 EC-gfxProgram
Figure 291: Tyoical Sensor parameter configuration (ECB & ECY Series)
See Network Properties Configuration window (ECL, ECB & ECY Series).
For B-AAC and B-BC controller models, BACnet alarms can be configured in
each ComSensor tree entry. When Enable alarms is set, the ComSensor
block makes an AlarmSetpoint input port available to dynamically offset the
High limit and Low limit values. See Alarms (ECB & ECY Series) to config-
ure the alarm parameters.
Now configure the ComSensor’s scenes: see ComSensor Scenes Configura-
tion window (ECB & ECY Series).
Figure 292: Opening Configure Scenes from the resources configuration
EC-gfxProgram 529
Configuring the Select a sensor parameter entry from the ComSensor tree to set the configu-
ComSensor ration parameters to use for sensor readings from the ComSensor such as
block’s inputs the units to be used.
(ECL Series)
When the Allure EC-Smart-Vue Sensor is so equipped, according to the
model, sensor readings for space temperature, humidity, CO2, and motion are
read. The Input name is used to identify this input in the Resource Viewer
and on the controller’s operator interface or on the connected ECx-Display (if
equipped).
Figure 293: Typical Options Tree
Figure 294: Setting the Input name
Now configure the ComSensor’s scenes: see ComSensor Scenes Configura-
tion window (ECL Series).
Figure 295: Opening Configure Scenes from the resources configuration
ComSensor Scenes Configuration window (ECL Series)
Scenes are used to display information on the Allure EC-Smart-Vue Sensor’s
LCD screen. The Allure EC-Smart-Vue Sensor can support up to 96 scenes in
total, including pre-configured scenes that allow a commissioning technician
to set the Allure EC-Smart-Vue Sensor’s Subnet ID, LCD display contrast,
and to show hardware information and space temperature measured by the
internal sensor. Customized scenes can be added to show both fixed and
dynamic information, say to show the outdoor temperature, or to show and set
the current setpoint temperature for example.
Use the up/down buttons to go to the first Quick Edit menu to modify
its value. Use the Menu button to navigate from one scene to the next
while using the up/down buttons to enter into the menu.
530 EC-gfxProgram
The following graphic shows the default Allure EC-Smart-Vue Sensor menu
map.
Figure 296: Default Allure EC-Smart-Vue Sensor menu map
Scenes depend on ComSensor Condition (ECL, ECB & ECY Series) block
settings, ComSensor Value (ECL, ECB & ECY Series) block settings, and
enumerations that you have previously created.
Figure 297: ComSensor Block Configuration screen
Property Description
Main Rolling Display scenes only. These scenes are shown in
Scenes sequence when the Allure EC-Smart-Vue Sensor is at
rest (no user interaction).
EC-gfxProgram 531
Property Description
Quick Edit This scene is accessible by pressing the up/down
buttons . Scenes can be enabled / disabled by
Conditions.
Menu
Accessible via Menu button . Pressing the Menu
button cycles the Allure EC-Smart-Vue Sensor through
the scenes defined under this branch. Use the up/down
buttons to enter into a submenu.
Advanced Menu
Accessible by pressing Menu button for 5 seconds.
A Password validation can be added. Use the up/down
buttons to enter into a submenu.
Conditions Used to Hide/Show Scenes from the user based on a
signal from EC-gfxProgram code. The number and
name of all conditions are identical across all Allure
EC-Smart-Vue Sensors connected to the controller.
The conditions values are unique to each Allure EC-
Smart-Vue Sensor. Up to 15 Conditions can be
created. See Conditions (ECL Series).
Values Used to share Allure EC-Smart-Vue Sensor data with
EC-gfxProgram code.
Up to 30 Local Values can be created: The number and
name of all Values are identical across all Allure EC-
Smart-Vue Sensors connected to the controller. The
value for each Value is unique to each Allure EC-
Smart-Vue Sensor.
Up to 70 Global Values can be created: Names and
values are shared across all the Allure EC-Smart-Vue
Sensor.
See Values (ECL Series).
Enumerations Used to select options in the Select Enumeration
Scenes. All texts displayed in the text section of a
scene use an enumeration. A maximum of 127 strings
in total can be created and each string can have up to
16 characters. The first enumeration value to be shown
can be selected. See Enumerations (ECL Series).
Global Options Used to set the settings that are shared between all
Allure EC-Smart-Vue Sensors. See Global Options.
Icons Selection See Allure EC-Smart-Vue Sensor display icons, below.
532 EC-gfxProgram
Allure EC-Smart-Vue Sensor display icons
In all scenes, the following Allure EC-Smart-Vue Sensor display icons can be
shown.
Figure 298: Allure EC-Smart-Vue Sensor display components
Eco Vue Light Outdoor Temperature Indoor Temperature
Alarm Blind Setpoint Clock
Scrolling Display : Text /
Date / Enumeration
Display Value Unit of Measurement
Day/ Night
Auto Fan Speed
Fan Speed Auto Mode Heat Cool Dehumidify Unoccupied
Emergency Heat Humidity Occupied
HVAC Occupancy
EC-gfxProgram 533
Icons selection Icon activation can be controlled by project code through an Icon Value (see
Icon Value configuration).
Figure 299: Icon Selection screen
Property Description
Eco Vue Sets the Eco Vue icon display properties. To encourage
occupants to be as green as possible, the Eco Vue icon
can be programmed to show more leaves when the
occupant chooses a setpoint that reduces energy use.
This helps to promote awareness for energy
consciousness and to save operational costs.
Ecological level 1: Low energy efficiency
Ecological level 2: Moderate energy efficiency
Ecological level 3: Higher energy efficiency
Ecological level 4: Highest energy efficiency
Unit Sets the unit for the display value.
Occupancy Sets the occupied / unoccupied icon display properties.
Fan Speed Sets the fan speed icon display properties.
Temperature Sets the indoor / outdoor / setpoint temperature icon
display properties.
HVAC Sets the heat / cool / dehumidify icon display
properties.
Alarm Sets the alarm icon display properties.
Light Sets the light icon display properties.
Blind Sets the sunblind (shade) icon display properties.
Clock Sets the clock icon display properties.
534 EC-gfxProgram
Adding a scene
Standard scenes Standard scenes are pre-programmed into the Allure EC-Smart-Vue Sensor
out of the box.
Figure 300: Stadard Allure EC-Smart-Vue Sensor scenes
Property Description
Display Space Shows the space temperature as measured by the
Temperature internal temperature sensor.
Display Relative Shows the space humidity as measured by the internal
Humidity humidity sensor (when the connected Allure EC-Smart-
Vue Sensor supports this feature).
Display CO2 Shows the space CO2 level as measured by the
internal CO2 sensor (when the connected Allure EC-
Smart-Vue Sensor supports this feature).
Display Shows the Allure EC-Smart-Vue Sensor’s firmware
Hardware Info version.
Adjust Contrast Adjust the display’s contrast setting.
Adjust Motion Adjust the motion detector’s sensitivity to movement
Sensitivity within the detector’s operating range (when the
connected Allure EC-Smart-Vue Sensor supports this
feature). With this scene, Allure EC-Smart-Vue Sensor
users can set any of the following values:
• 0: Low sensitivity to motion.
• 1: Medium sensitivity to motion.
• 2: High sensitivity to motion.
Refer to the Allure EC-Smart-Vue Sensor’s installation
guide for more information.
EC-gfxProgram 535
Property Description
Calibrate Space Allows the user to calibrate the temperature sensor at
Temp the Allure EC-Smart-Vue Sensor. The permitted range
is between 0.09 and 5.4ºF (0.05 and 3ºC).
NOTE: To use this scene, a technician adjusts the tem-
perature shown in the scene to that of a refer-
ence thermometer. The necessary offset is
automatically calculated.
Calibrate Allows the user to calibrate the hygrometer sensor at
Humidity the Allure EC-Smart-Vue Sensor. The permitted range
is between 0.5 and 3% (when the connected Allure EC-
Smart-Vue Sensor supports this feature).
NOTE: To use this scene, a technician adjusts the
humidity shown in the scene to that of a refer-
ence hygrometer. The necessary offset is auto-
matically calculated.
Edit Subnet ID Each controller can support a number of Allure EC-
Smart-Vue Sensors. Each Allure EC-Smart-Vue
Sensor must have a unique Subnet ID among all Allure
EC-Smart-Vue Sensor connected to a controller. This
scene allows the Subnet ID to be set.
Edit Date or Allows the user to set the controller’s year, time, or date
Time at the Allure EC-Smart-Vue Sensor. See Edit date or
time scene.
NOTE: Three scenes are needed to set the year, time,
or date: That is, one scene is required for each
of these parameters.
Password This password protects the advanced settings.
Validation
Wireless Allows a user to commission a wireless sensor by
Commissioning capturing a wireless sensor’s datagram which is
transmitted by activating the wireless sensor’s learn
button. The datagram contains the wireless sensor’s ID
number which is then assigned to the selected
Wireless Sensor instance. See Wireless
Commissionning Scene.
Up One Level Allows the user to go up one menu level.
536 EC-gfxProgram
Custom scenes Custom scenes can be added to the Allure EC-Smart-Vue Sensor.
Figure 301: Custom Allure EC-Smart-Vue Sensor scenes
Property Description
Normal Display Displays the value of a Value. Opens the Display
Scene popup. See Display Scene configuration.
Edit Value Allows the value of a Value to be edited. Opens the
Edit Scene popup. See Edit Scene configuration.
Display and Edit Displays the value of one Value while allowing another
Value Value to be edited. Opens the Display and Edit Scene
popup. See Display and Edit Scene configuration.
Change Value This scene is invisible when a user navigates past it;
however by doing so, it sets a point to a specific value.
Opens the Change Value Scene popup. See Change
Value Scene configuration.
Select String Allows an enumeration string to be selected. Opens the
Enumeration String Enumeration Scene popup. See String
Enumeration Scene configuration.
Select Value Allows an enumeration value to be selected. Opens the
Enumeration Value Enumeration Scene popup. See Value
Enumeration Scene configuration.
Select Icon Allows an icon to be selected. Opens the Icon
Enumeration Enumeration Scene popup. See Icon Enumeration
Scene configuration.
Add Sub Menu Adds a new menu in which scenes are added. Users
drill-down into these menus to access the scenes
contained in the sub-menu.
EC-gfxProgram 537
Common scene Scene configurations have configuration options that are common from scene
options configuration to scene configuration.
Property Description
Edit Real Time Changes the value in the controller without the user
having to press the Menu button to accept the new
value.
Allow null Allows a user to select null as a value. For example, a
null value can be used as a flag in your project code to
disable a feature.
When this option is enabled, the Allure EC-Smart-Vue
Sensor user can select a null value for the scene as
follows:
Press and hold both arrow keys simultaneously.
The screen displays three dashes (this indicates that
the null value has been selected).
Press the Menu button to send the null value to the
code.
Decimals This sets the number of decimal points to be used
when displaying a value in the display value part of the
LCD display. Auto shows the maximum number of
decimal places that will fit into the remaining space
available on the display.
Timeout This sets the delay before the display returns to the
Main Rolling Scenes when there is no user interaction,
or it goes to the next scene display while in a Main
Rolling Scenes.
Blink Text Makes the display flash information to get a user’s
Selection attention.
Blink Value
Reverse Displays the scene when the condition is inactive. See
Condition Conditions (ECL Series).
538 EC-gfxProgram
Edit date or time This configuration allows the user to set the controller’s real time clock.
scene
The Allure EC-Smart-Vue Sensor’s LCD screen can also show the current
time or text in a scrolling display.
NOTE: Three scenes are needed to allow the user to set the year, time, or
date: That is, one scene is required for each of these parameters.
Figure 302: Edit Date or Time Scene configuration
Property Description
Text Section This defines the types of data that will be displayed in
the scrolling display part of the LCD display: Default
Text
Datetime shows the default date and time set in Global
Options, Text shows up to 16 characters of upper-case
text defined in the Text box. Year, Time, and Date
shows the currently configured year, time, and date.
Edit Select the date or time parameter to be edited in this
scene. See Values (ECL Series).
Condition This is used to hide or show this scene. See Conditions
(ECL Series).
See also Common Scene Options.
Wireless Commissionning Scene
Wireless commissioning allows you to configure a Wireless Sensor in your
controller’s project code without associating a specific Sensor ID to the Wire-
less Sensor. You must create a Wireless Commissioning scene in the Allure
EC-Smart-Vue Sensor. Once the controller is in the field, a technician can
associate the specific Sensor ID of the wireless sensor that has been installed
through the Allure EC-Smart-Vue Sensor’s Wireless Commissioning scene.
To program the controller to do this, see Configuring a wireless commission-
ning scene. To discover a wireless sensor in the field, see Using the Allure
EC-Smart-Vue Sensor to discover wireless devices in the field.
Wireless Commissioning consists of two scenes: The first scene allows
access to the second submenu wherein the user can select a wireless sensor
instance and engage the wireless learning phase that has a fixed timeout of 5
EC-gfxProgram 539
minutes during which the controller will wait for a wireless datagram. These
two scenes always come together.
NOTE: To cancel the wireless learn phase, exit the scene by pressing for
5 seconds on the Allure EC-Smart-Vue Sensor.
Figure 303: First-level wireless commissionning Menu Scene
Property Description
Text Shows up to 16 characters of upper-case text that
identifies this Wireless Commissioning menu scene.
Condition This is used to hide or show this scene. See Conditions
(ECL Series).
See also Common scene options.
The second-level Wireless Commissioning Scene is hard coded to assign the
wireless sensor’s ID number to the selected Wireless Sensor (ECL Series)
block instance. This scene is dynamically created for each Wireless Sensor
instance block that has been added to the project.
Figure 304: Second-level Wireless Commissionning Scene
Property Description
Text section These values are fixed and cannot be edited.
Value
Condition This is used to hide or show this scene. See Conditions
(ECL Series).
See also Common scene options.
540 EC-gfxProgram
Configuring a Configure a Wireless Commissioning Scene as follows.
wireless
commissionning 1. Add a Wireless Sensor block to the Programming Sheet.
scene Figure 305: Adding a Wireless Sensor to the programming sheet
2. In the Properties pane for the Wireless Sensor block, click the Sensor
drop-down list and then click Add new sensor.
Figure 306: Adding a Wireless Sensor to the controller
3. Do not set the Sensor ID or click Learn. It is through the Allure EC-Smart-
Vue Sensor scene that the sensor ID learn will be triggered.
EC-gfxProgram 541
4. Select the wireless sensor type in the Sensor type drop down list.
5. Configure the Wireless Sensor block as you normally would. See also
Wireless Sensor (ECL Series).
Figure 307: Configuring the Wireless Sensor
6. Click OK.
7. Add and configure as many wireless sensors that will be used with the
controller: In the Properties pane for the Wireless Sensor block, click
the Sensor drop-down list and then click Add new sensor.
8. Add a ComSensor block to the Programming Sheet.
Figure 308: Adding a ComSensor block to the programming sheet
542 EC-gfxProgram
9. Double-click the Allure EC-Smart-Vue Sensor block.
10. Add a Wireless Commissioning scene to the Advanced Menu and con-
figure it. See Wireless Commissionning Scene.
11. Synchronize your project code with the controller.
Using the Allure 1. With the connected Allure EC-Smart-Vue Sensor, go to the Wireless
EC-Smart-Vue Commissioning scene. The scrolling display part of the LCD display
Sensor to shows Wireless.
discover
wireless devices 2. Press an up or down button to enter into the submenu.
in the field 3. Use the up/down buttons to select a Wireless Sensor block
instance that will be used to learn the sensor’s ID.
4. Press to start the wireless learning phase. The scrolling display part of
the LCD display shows a 5 minute count-down timer during which a wire-
less datagram must be received in order to associate the Wireless Sen-
sor block instance to a wireless device.
5. The controller must receive a valid signal from a wireless device when the
device’s Learn button is pressed or, if it does not have a Learn button,
when the device senses a change of value. Once the value has been
learnt by the controller, the sensor’s ID value is shown in the scrolling dis-
play part of the LCD display.
6. Press for 5 seconds to accept the value and exit the scene.
7. Repeat the procedure for all remaining
8. Wireless Sensor block instances.
NOTE: Synchronizing your project code with a controller will erase the discov-
ered wireless Sensor ID from the controller. Repeat the above proce-
dure to re-discover it.
Unlearning a 1. With the connected Allure EC-Smart-Vue Sensor, go to the Wireless
Sensor ID for a Commissioning scene. The scrolling display part of the LCD display
Wireless Sensor shows Wireless.
block instance
2. Press an up or down button to enter into the submenu.
3. Use the up/down buttons to select the Wireless Sensor block
instance that will be cleared of a wireless sensor’s ID.
4. Press to start the wireless learning phase. The scrolling display part of
the LCD display shows a 5 minute count-down timer.
5. Press both the up and down buttons at the same time.
6. Press for 5 seconds to accept the value and exit the scene.
EC-gfxProgram 543
Scene configuration
Display Scene This configuration makes the Allure EC-Smart-Vue Sensor’s LCD screen
configuration show a value from a Value. The Allure EC-Smart-Vue Sensor’s LCD screen
can also show the time, text, or a delay Value in the scrolling display.
Figure 309: Display Scene configuration
Property Description
Text section This defines the types of data that will be displayed in
the scrolling display part of the LCD display: Default
Text
Datetime shows the default date and time set in Global
Options; Text shows up to 16 characters of upper-case
text defined in the Text box. Delay Values can also be
displayed (see Delay Value configuration).
Value The Value to be displayed in the Display Value field of
the LCD display. See Values (ECL Series).
Conditions This is used to hide or show this scene. See Conditions
(ECL Series).
See also Common scene options.
544 EC-gfxProgram
Edit Scene This configuration allows the display and editing of a value from a Value. The
configuration Allure EC-Smart-Vue Sensor’s LCD screen can also show the time, text, or a
delay Value in a scrolling display.
Figure 310: Edit Scene configuration
Property Description
Text Section This defines the types of data that will be displayed in
the scrolling display part of the LCD display: Default
Text
Datetime shows the default date and time set in Global
Options; Text shows up to 16 characters of upper-case
text defined in the Text box. Delay Values can also be
displayed (see Delay Value configuration).
Value The Value to be displayed in the Display Value field of
the LCD display. The value can be changed by using
the up/down buttons . See Values (ECL Series).
Conditions This is used to hide or show this scene. See Conditions
(ECL Series).
Value Limits Use to set the valid limit range over which the value
can be edited by the user. Options include a static
setting (0 to 126) or a dynamic value set by a Value.
Click to set the limits in the Scene Limits
configuration popup.
See also Common scene options.
EC-gfxProgram 545
Scene Limits This configuration sets the valid limit range over which the value can be edited
configuration by the user.
Figure 311: Static and dynamic Scene Limits Configuration
Property Description
Enable low limit When enabled, sets the lowest value that can be
selected by the user.
Enable high limit When enabled, sets the highest value that can be
selected by the user.
Static Static (fixed) values are set to define the high or low
limit.
Dynamic The dynamic values for the high or low limit are based
on the instantaneous value of a Local or Global Value.
Value Set the Static value or select a Dynamic value to be
used for the high or low limit.
546 EC-gfxProgram
Display and Edit This configuration allows a user to edit a Value while displaying the value of
Scene another Value. The Allure EC-Smart-Vue Sensor’s LCD screen can also show
configuration the time, text, or a delay Value in a scrolling display.
Figure 312: Display and Edit Scene configuration
Property Description
Text Section This defines the types of data that will be displayed in
the scrolling display part of the LCD display: Default
Text
Datetime shows the default date and time set in Global
Options; Text shows up to 16 characters of upper-case
text defined in the Text box. Delay Values can also be
displayed (see Delay Value configuration).
Value The Value to be displayed in the Display Value field of
the LCD display. See Values (ECL Series).
Conditions This is used to hide or show this scene. See Conditions
(ECL Series).
Edited Value The Value to be edited by the user. The value can be
changed by using the up/down buttons .
Value Limits Use to set the valid limit range over which the value
can be edited by the user. Options include a static
setting (0 to 126) or a dynamic value set by a Value.
Click to set the limits in the Scene Limits
configuration popup.
See also Common scene options.
EC-gfxProgram 547
Change Value This scene is invisible when a user navigates past it; however by doing so, it
Scene sets a point to a specific value when the Condition is True.
configuration Figure 313: Change Value Scene configuration
Property Description
Value The Local or Global Value to be set. See Values (ECL
Series).
Conditions When this condition is True, the Value takes the value
of Set value.
Set value The value to be set when the Condition is True.
See also Common scene options.
String This configuration allows a user to select a text string from a string enumera-
Enumeration tion (for example, to select a mode from an enumeration of Heat, Cool, Auto,
Scene and so on).
configuration Figure 314: String Enumeration Scene configuration
Property Description
Text The enumeration string from which the user can select
a setting. The value can be changed by using the up/
down buttons .
Value The text to be shown in the Value field. Not all
characters are shown with equal quality as this portion
of the display does not support the full alphabet.
Condition This is used to hide or show the scene. See Conditions
(ECL Series).
Filter This restricts the available choices to the user. See
Filter Configuration window.
See also Common scene options.
548 EC-gfxProgram
Filter The filter restricts the available choices enumeration or Value members avail-
Configuration able to a user for this scene. Click to set the Filter properties.
window
Figure 315: String enumeration scene Filter Configuration
Property Description
Enable filter Enable the filter to restrict the available choices to the
user.
Filter type Static: Select the Members of the enumeration to
make available to the user.
Dynamic: Select the value that will hold the number
corresponding to the members that will be made
available to the user.
EC-gfxProgram 549
Value This configuration allows a user to select a value from an enumeration shown
Enumeration in the display’s Display Value field. The Allure EC-Smart-Vue Sensor’s LCD
Scene screen can also show the time or text in a scrolling display.
configuration
Figure 316: Value Enumeration Scene configuration
Property Description
Text Section This defines the types of data that will be displayed in
the scrolling display part of the LCD display: Default
Text
Datetime shows the default date and time set in Global
Options; Text shows up to 16 characters of upper-case
text defined in the Text box. Delay Values can also be
displayed (see Delay Value configuration).
Value The enumeration Values to display in the Display Value
field of the LCD display that allows the user to select
the enumeration value by using the up/down buttons
. Only 4 digits are shown. See Values (ECL
Series).
Condition This is used to hide or show this scene. See Conditions
(ECL Series).
Filter This restricts the available choices to the user. See
Filter Configuration window.
See also Common scene options.
550 EC-gfxProgram
Icon This configuration allows a user to select an icon from an icon Value. The
Enumeration Allure EC-Smart-Vue Sensor’s LCD screen can also show the time or text in a
Scene scrolling display.
configuration
Figure 317: Icon Enumeration Scene configuration
Property Description
Text Section This defines the types of data that will be displayed in
the scrolling display part of the LCD display: Default
Text
Datetime shows the default date and time set in Global
Options; Text shows up to 16 characters of upper-case
text defined in the Text box. Delay Values can also be
displayed (see Delay Value configuration).
Value The icon Values to display in the Icon field of the LCD
display that allows the user to select the icon value by
using the up/down buttons . See Values (ECL
Series).
Condition This is used to hide or show this scene. See Conditions
(ECL Series).
Filter This restricts the available icon choices to the user.
See Filter Configuration window.
See also Common scene options.
Conditions (ECL Conditions are used to Hide/Show Scenes from the user by sharing a digital
Series) signal from logical blocks on the programming sheet with the ComSensor
Block through a ComSensor Condition block (see ComSensor Condition
(ECL, ECB & ECY Series)). Up to 15 Conditions can be created. The number
and name of all conditions are identical across all Allure EC-Smart-Vue Sen-
sors connected to the controller. The condition values sent from the ComSen-
sor Condition block to each Allure EC-Smart-Vue Sensor is unique. This
means that each condition on each Allure EC-Smart-Vue Sensor connected
to the controller can be individually enabled/disabled.
EC-gfxProgram 551
To add a condition, right-click Conditions in the tree and select Add New
Conditions and give this condition a name.
Figure 318: Add New Condition
The condition can now be used to hide or show the scene in the ComSensor
configuration as follows.
1. On a programming sheet, add a ComSensor Condition block.
2. In the Properties of the ComSensor Condition block, set the Condition
to the name of the newly created condition.
Figure 319: Selecting the condition instance created in the ComSensor block
3. Connect a digital output to the ComSensor Condition block’s input. The
input to the ComSensor Condition block will now hide or show any scene
that uses this condition. An example is shown below.
Figure 320: ComSensor condition block example
ComSensor A scene can be shown or hidden according to the value at the associated
condition block ComSensor Condition block Input and the Reverse Condition setting for the
reverse scene as shown in the following table.
condition
ComSensor
Scene Reverse Scene Reverse
Condition block Input
Condition Cleared Condition Set
Value
Digital 0 The scene is hidden. The scene is shown.
Digital 1 The scene is shown. The scene is hidden.
552 EC-gfxProgram
Values (ECL Values are used to share data between the ComSensor block and other
Series) blocks on the programming sheet through a ComSensor Value block (see
ComSensor Value (ECL, ECB & ECY Series)).
Up to 30 Local Values can be created: The number and name of all Values
are identical across all Allure EC-Smart-Vue Sensors connected to the con-
troller. The value for each Value is unique to each Allure EC-Smart-Vue Sen-
sor.
Up to 70 Global Values can be created: The names and values are shared
across all Allure EC-Smart-Vue Sensors.
To add a Value, right-click Local Values / Global Values in the tree and
select Add New Value, and select the Value type to be added.
Figure 321: Add New Value
EC-gfxProgram 553
The Value can now be used to pass values between the ComSensor block
and other blocks as follows:
1. On the programming sheet, add a ComSensor Value block.
2. In the properties of the ComSensor Value block, set the Value to the
name of the newly created Value.
Figure 322: Selecting the Value instance created in the ComSensor block
3. Connect the ComSensor Value block to other blocks on the programming
sheet. An example is shown below.
Figure 323: ComSensor Value block example
4. Use the Value in a ComSensor Block scene by selecting it in the Value
drop down list.
Numeric Value Values can be linked to a LONWORKS object.
configuration
Figure 324: Numeric Value configuration
Property Description
Unit Select the native units of the value sent to the Value.
This is usually set to the default internal measurement
system (Metric or US units). Internally, the ComSensor
block converts values between measurement systems,
as required by a scene.
554 EC-gfxProgram
Property Description
Default Value This value is used when all priority levels are set to
Null.
Link to Select the LONWORKS object to be associated to the
LONWORKS Value if needed. This allows the Allure EC-Smart-Vue
Object Sensor user to edit the selected network value.
Delay Value Delay Values are used to display a count-down delay in the Scrolling Display
configuration area of the LCD.
Figure 325: Delay Value configuration
Property Description
Delay Display Select how the delay is to be displayed (minutes /
minutes and seconds).
Default Value This value is used when all priority levels are set to
Null.
Link to Select the LONWORKS object to be associated to the
LONWORKS Value if needed. This allows the Allure EC-Smart-Vue
Object Sensor user to edit the selected network value.
EC-gfxProgram 555
Icon Value Icon Values are used to store the value of an Icon to display different icons on
configuration the Allure EC-Smart-Vue Sensor based on a project code value.
Figure 326: Icon Value configuration
Property Description
Link to Select the enumeration that will control the display. The
LONWORKS table below shows the icon’s behavior according to the
Object enumeration value. This allows the Allure EC-Smart-
Vue Sensor user to edit the selected network value.
Start Value Sets the default icon to be first shown.
The following icon values can be added to control their display by linking the
Value to an enumeration. To see an example of the Allure EC-Smart-Vue Sen-
sor icons, refer to Allure EC-Smart-Vue Sensor display icons.
Property Description
Eco Vue Value Sets the Eco Vue icon display properties.
Occupancy Sets the occupied / unoccupied icon display properties.
Value
Fan Speed Sets the fan speed icon display properties.
Value
Temperature Sets the indoor / outdoor / setpoint temperature icon
Value display properties.
HVAC Mode Sets the heat / cool / dehumidify icon display
Value properties.
Alarm Value Sets the alarm icon display properties.
Light Value Sets the light icon display properties.
556 EC-gfxProgram
Property Description
Blind Value Sets the sunblind (shade) icon display properties.
Clock Value Sets the clock icon display properties.
Unit Value Sets the unit for the display value. If the units from the
EC-gfxProgram project are different from that chosen
here, the ComSensor block internally converts the units
automatically.
Hide: Suppresses the icon from being shown on the display.
Blink: Flashes the icon on and off.
Enumeration Enumeration Values are used to store the value of an enumeration to be dis-
Value played or selected on the Allure EC-Smart-Vue Sensor.
configuration
Figure 327: Enumeration Value configuration
Property Description
Enumeration Select the Enumeration to associate with this Value.
Default Value This value is used when all priority levels are set to
Null.
Link to Select the LONWORKS object to be associated to the
LONWORKS Value if needed. This allows the Allure EC-Smart-Vue
Object Sensor user to edit the selected network value.
Enumeration The Enumeration Validity Value is used to mask enumerations when using
Validity Value Select Enumeration Scene. Digital validation is done with the enumeration
configuration fields.
Figure 328: Enumeration Validity Value configuration
Property Description
Link to Select the LONWORKS object to be associated to the
LONWORKS Value if needed. This allows the Allure EC-Smart-Vue
Object Sensor user to edit the selected network value.
EC-gfxProgram 557
Enumerations Enumerations are used to select options in the Select Enumeration Scenes.
(ECL Series) All texts displayed in the text section of a scene use an enumeration. A maxi-
mum of 127 strings in total can be created and each string can have up to 16
characters. The first enumeration value to be shown can be selected.
Enumeration string optimization is possible if the same text is used more than
one time, either when the text is used in Enumerations or in the Scene Text
box. Enumerations added by the user are not optimized.
To add an enumeration, right-click Enumerations in the tree and select Add
New Enumeration.
Figure 329: Add New Enumeration
Click an empty cell in the Name column and type a value to add a new enu-
meration. Click a cell with a pre-existing value in the Name column and type a
value to edit the current value.
Figure 330: Enumeration configuration
Property Description
Start Value Sets the base index of the enumeration (0base, 1base,
-1base, etc.).
Value The enumeration value.
Name The enumeration string.
558 EC-gfxProgram
Global Options These settings are shared between all Allure EC-Smart-Vue Sensors.
Figure 331: Global Options
Property Description
Default datetime Set the default date and time format to use when
display Datetime is selected in the Text Section drop-down.
Time format Set the time format to use when Time is selected in the
Text Section drop-down.
Date format Set the date format to use when Date is selected in the
Text Section drop-down.
Activity backlight Set the LCD backlight level when the Allure EC-Smart-
Vue Sensor has had any of its keys recently pressed by
a user.
Inactivity Set the LCD backlight level when the Allure EC-Smart-
backlight Vue Sensor has not had any of its keys recently
pressed by a user.
Default scene The default scene timeout that is used when creating a
timeout new scene.
EC-gfxProgram 559
ComSensor (ECB & ECY Series)
Description Used to interface with the Allure EC-Smart-Vue Sensor communicating sen-
sor that is connected to a controller’s subnetwork bus.
This block allows the menus and display options to be defined.
Alarms (ECB & ECY Series) are available with B-AAC and B-BC controller
models only (see the controller’s datasheet for more information).
NOTE: Humidity, Motion, and CO2 scenes can be configured for this block
even when the corresponding Allure EC-Smart-Vue Sensor does not
have these features. Ensure to only use the actual features supported
by the connected Allure EC-Smart-Vue Sensor (that the Subnet ID
shown in the Options tree corresponds the Subnet ID configured in
the connected Allure EC-Smart-Vue Sensor)
Figure 332: Allure EC-Smart-Vue Sensor
560 EC-gfxProgram
Slim format This block can be collapsed into a slim format. See Collapsed in Common
support block properties.
Setting the The Allure EC-Smart-Vue Sensor may be used to set this controller’s time and
controller’s time day, when configured. When the controller’s time is set with the Allure EC-
(ECB Series Smart-Vue Sensor, a local broadcast for manual time synchronization is sent
controllers only) from the connected controller to propagate the time change from the Allure
EC-Smart-Vue Sensor to other controllers in the network (where such service
is supported).
Advanced Resources Configuration, Configuring a ComSensor resource, Alarms (ECB
configuration & ECY Series), Find All References (ECL, ECB & ECY Series), Copy From,
Configure Ports, Show/Hide Ports
Related blocks Generic ComSensor Condition (ECL, ECB & ECY Series), ComSensor Con-
dition (ECL, ECB & ECY Series), ComSensor Value (ECL, ECB & ECY
Series), Real Time Clock (ECB & ECY Series), Wireless Sensor (ECB
Series), Resources Configuration
EC-gfxProgram 561
Input(s)
Port Type Range Description
SpaceTemp Numeric ±3.4028 ×1038 When alarms are enabled for this parameter
Alarm Setpoint (see Alarms (ECB & ECY Series)), a positive
input value increases the alarm setpoint values
Humidity Alarm
set in the Options tree of the Configure window
Setpoint
(a negative value reduces the alarm setpoint
CO2AlarmSetpo values): The High limit is now the High limit
int value (set in the Resources Configuration’s
Alarms configuration for the block) plus
(for CO2 models
AlarmSetpoint and the Low limit is now the
only) Low limit value (set in the Resources
(These inputs Configuration’s Alarms configuration for the
are available block) plus AlarmSetpoint.
with B-AAC and Figure 333: Alarms Configuration Window
B-BC controllers
only)
NOTE: When the AlarmSetpoint input is dis-
connected, you must reset the controller
(see Project Synchronization) or connect
a Null value (ECL, ECB & ECY Series)
block to this port so the controller will
release this port as being unconnected.
When the AlarmSetpoint input is dis-
connected, the High limit and Low limit
can be written to through the BACnet
interface.
Elevation (for Numeric 0 to 4877m The Allure EC-Smart-Vue Sensor’s current
CO2 models elevation above mean sea level. This
0 to 16 000ft
only) compensates for the CO2 gas density ratio
found at higher elevations. This input must be
set for any elevation above 500ft (152m) to
obtain the highest elevation compensation
accuracy: The sensor will automatically
compensate CO2 readings for a number of
factors including the current room temperature
and the elevation.
562 EC-gfxProgram
Port Type Range Description
MotionAlarmVal Digital 0 or 1 When alarms are enabled for this parameter see
ue (B-AAC and Alarms (ECB & ECY Series)), this input
B-BC controllers overrides the alarm value set in the Options
only) tree of the Configure window:
NOTE: When the MotionAlarmValue input is dis-
connected, you must reset the controller
(see Project Synchronization) or connect
a Null value (ECL, ECB & ECY Series)
block to this port so the controller will
release this port as being unconnected.
When the MotionAlarmValue input is
disconnected, the alarm value property
can be overwritten through the BACnet
interface.
Output(s)
Port Type Range Description
SpaceTemp Numeric 5 to 40ºC The room’s temperature.
41 to 104ºF
NOTE: Any change in the measurement system of
the project results in the output value
being converted.
SpaceTemp Digital 0 or 1 For the SpaceTemp output: See Out-of-Service.
OutOfService
SpaceTemp Fault Digital 0 or 1 For the SpaceTemp output: This is logically True
(1) if the Reliability property does not have a value
of No fault detected (0).
SpaceTemp Enum See For the SpaceTemp output: When Allure EC-
Reliability Description Smart-Vue Sensor communication is lost, this
becomes Communication failure (12) otherwise
this is No fault detected (0).
SpaceTemp Digital 0 or 1 When Enable Alarms is set for a block instance
InAlarm (B-AAC and the present value is outside of the High limit
and B-BC and Low limit settings and taking into
controllers only) consideration the Dead band and Time delay
settings, this output is On (1). See Analog Value
(ECB & ECY Series) for more information about
this output. See Alarms (ECB & ECY Series) to
configure the alarm settings.
EC-gfxProgram 563
Port Type Range Description
Humidity Numeric 0 to 100% The room’s relative humidity.
NOTE: A ‘null’ output may indicate that this fea-
ture is not supported by the currently con-
nected Allure EC-Smart-Vue Sensor.
Humidity Digital 0 or 1 For the Humidity output: See Out-of-Service.
OutOfService
Humidity Fault Digital 0 or 1 For the Humidity output: This is logically True (1)
if the Reliability property does not have a value of
No fault detected (0).
Humidity Enum See For the Humidity output: When the Check out of
Reliability Description range in the Advanced Configuration is set, this
provides an indication of whether the physical
input is "reliable" and, if not, why. See Reliability
property.
NOTE: A No sensor (1) output indicates that this
feature is not supported by the currently
connected Allure EC-Smart-Vue Sensor.
Humidity InAlarm Digital 0 or 1 When Enable Alarms is set for a block instance
(B-AAC and B- and the present value is outside of the High limit
BC controllers and Low limit settings and taking into
only) consideration the Dead band and Time delay
settings, this output is On (1). See Analog Value
(ECB & ECY Series) for more information about
this output. See Alarms (ECB & ECY Series) to
configure the alarm settings.
CO2 Numeric 0 to The measured CO2 concentration.
2000ppm
NOTE: A ‘null’ output may indicate that this fea-
ture is not supported by the currently con-
nected Allure EC-Smart-Vue Sensor.
CO2 Digital 0 or 1 For the CO2 output: See Out-of-Service.
OutOfService
CO2 Fault Digital 0 or 1 For the CO2 output: This is logically True (1) if the
Reliability property does not have a value of No
fault detected (0).
564 EC-gfxProgram
Port Type Range Description
CO2 Reliability Enum See For the CO2 output: When the Check out of
Description range in the Advanced Configuration is set, this
provides an indication of whether the physical
input is "reliable" and, if not, why. See Reliability
property.
NOTE: A No sensor (1) output indicates that this
feature is not supported by the currently
connected Allure EC-Smart-Vue Sensor.
CO2 InAlarm (B- Digital 0 or 1 When Enable Alarms is set for a block instance
AAC and B-BC and the present value is outside of the High limit
controllers only) and Low limit settings and taking into
consideration the Dead band and Time delay
settings, this output is On (1). See Analog Value
(ECB & ECY Series) for more information about
this output. See Alarms (ECB & ECY Series) to
configure the alarm settings.
Motion Digital 0 or 1 The detected motion.
Motion Digital 0 or 1 For the Motion output: See Out-of-Service.
OutOfService
Motion Fault Digital 0 or 1 For the Motion output: This is logically True (1) if
the Reliability property does not have a value of
No fault detected (0).
Motion Reliability Enum See For the Motion output: When the Check out of
Description range in the Advanced Configuration is set, this
provides an indication of whether the physical
input is "reliable" and, if not, why. See Reliability
property.
NOTE: A No sensor (1) output indicates that this
feature is not supported by the currently
connected Allure EC-Smart-Vue Sensor.
Motion InAlarm Digital 0 or 1 When Enable Alarms is set for a block instance
(B-AAC and B- and the present value is outside of the High limit
BC controllers and Low limit settings and taking into
only) consideration the Dead band and Time delay
settings, this output is On (1). See Analog Value
(ECB & ECY Series) for more information about
this output. See Alarms (ECB & ECY Series) to
configure the alarm settings.
Number Integer – The current block number.
EC-gfxProgram 565
Block properties See also Common Block Properties.
Property Type Range Default Description
Number Menu See ComSensor 1 Use this drop-down menu to
Description select a physical Allure EC-
Smart-Vue Sensor connected to
this controller. The number of
Allure EC-Smart-Vue Sensors
supported by a controller is
shown in this drop-down list or in
the Statistics pane. This
corresponds to the Allure EC-
Smart-Vue Sensor’s subnet ID
number.
Configuring a ComSensor resource
The ComSensor resource is configured in the following places:
1. In the Resources Configuration window (see ComSensor resources con-
figuration window) by double-clicking the ComSensor block.
2. In the ComSensor Scenes configuration window (see ComSensor
Scenes Configuration window (ECB & ECY Series)) by double-clicking
the ComSensor block and then right-click a ComSensor instance in the
Resource Tree and selecting Configure Scenes.
ComSensor Scenes Configuration window (ECB & ECY Series)
Scenes are used to display information on the Allure EC-Smart-Vue Sensor’s
LCD screen. The Allure EC-Smart-Vue Sensor can support up to 96 scenes in
total, including 6 pre-configured scenes that allow a commissioning technician
to set the VAV controller’s Baud rate, MAC Address, Allure EC-Smart-Vue
Sensor’s Subnet ID, LCD display contrast, and to show hardware information
and space temperature measured by the internal sensor. Customized scenes
can be added to show both fixed and dynamic information, say to show the
outdoor temperature, or to show and set the current setpoint temperature for
example.
Use the up/down buttons to go to the first Quick Edit menu to modify
its value. Use the Menu button to navigate from one scene to the next
while using the up/down buttons to enter into the menu.
566 EC-gfxProgram
The following graphic shows the default Allure EC-Smart-Vue Sensor menu
map
Figure 334: Default Allure EC-Smart-Vue sensor menu map
Scenes depend on ComSensor Condition (ECL, ECB & ECY Series) block
settings, ComSensor Value (ECL, ECB & ECY Series) block settings, and
enumerations that you have previously created.
Figure 335: ComSensor Block Configuration screen
Parameter Description
Main Rolling Display scenes only. These scenes are shown in
Scenes sequence when the Allure EC-Smart-Vue Sensor is at
rest (no user interaction).
EC-gfxProgram 567
Parameter Description
Quick Edit This scene is accessible by pressing the up/down
buttons . Scenes can be enabled / disabled by
Conditions.
Menu
Accessible via Menu button . Pressing the Menu
button cycles the Allure EC-Smart-Vue Sensor through
the scenes defined under this branch. Use the up/down
buttons to enter into a submenu.
Advanced Menu
Accessible by pressing Menu button for 5 seconds.
A Password validation can be added. Use the up/down
buttons to enter into a submenu.
Conditions Used to Hide/Show Scenes from the user based on a
signal from EC-gfxProgram code. The number and
name of all conditions are identical across all Allure
EC-Smart-Vue Sensors connected to the controller.
The conditions values are unique to each Allure EC-
Smart-Vue Sensor. Up to 15 Conditions can be
created. See Conditions.
Values Used to share Allure EC-Smart-Vue Sensor data with
EC-gfxProgram code.
Up to 30 Local Values can be created: The number and
name of all Values are identical across all Allure EC-
Smart-Vue Sensors connected to the controller. The
value for each Value is unique to each Allure EC-
Smart-Vue Sensor.
Up to 70 Global Values can be created: Names and
values are shared across all the Allure EC-Smart-Vue
Sensor.
See Values.
Enumerations Used to select options in the Select Enumeration
Scenes. All texts displayed in the text section of a
scene use an enumeration. A maximum of 127 strings
in total can be created and each string can have up to
16 characters. The first enumeration value to be shown
can be selected. See Enumerations.
Global Options Used to set the settings that are shared between all
Allure EC-Smart-Vue Sensors. See Global Options.
Icons Selection See Allure EC-Smart-Vue Sensor display icons, below.
568 EC-gfxProgram
Allure EC-Smart-Vue Sensor display icons
In all scenes, the following Allure EC-Smart-Vue Sensor display icons can be
shown.
Figure 336: Allure EC-Smart-Vue Sensor display components
Eco Vue Light Outdoor Temperature Indoor Temperature
Alarm Blind Setpoint Clock
Scrolling Display : Text /
Date / Enumeration
Display Value Unit of Measurement
Day/ Night
Auto Fan Speed
Fan Speed Auto Mode Heat Cool Dehumidify Unoccupied
Emergency Heat Humidity Occupied
HVAC Occupancy
EC-gfxProgram 569
Icon selection Icon activation can be controlled by project code through an Icon Value (see
Icon Value configuration).
Figure 337: Icons Selection screen
Parameter Description
Eco Vue Sets the Eco Vue icon display properties. To encourage
occupants to be as green as possible, the Eco Vue icon
can be programmed to show more leaves when the
occupant chooses a setpoint that reduces energy use.
This helps to promote awareness for energy
consciousness and to save operational costs.
Ecological level 1: Low energy efficiency
Ecological level 2: Moderate energy efficiency
Ecological level 3: Higher energy efficiency
Ecological level 4: Highest energy efficiency
Unit Sets the unit for the display value.
Occupancy Sets the occupied / unoccupied icon display properties.
Fan Speed Sets the fan speed icon display properties.
Temperature Sets the indoor / outdoor / setpoint temperature icon
display properties.
HVAC Sets the heat / cool / dehumidify icon display
properties.
Alarm Sets the alarm icon display properties.
Light Sets the light icon display properties.
Blind Sets the sun blind / shade icon display properties.
Clock Sets the clock icon display properties.
570 EC-gfxProgram
Adding a scene
Standard scenes Standard scenes are pre-programmed into the Allure EC-Smart-Vue Sensor
out of the box.
Figure 338: Standard Allure EC-Smart-Vue Sensor scenes
Parameter Description
Display Space Shows the space temperature as measured by the
Temperature internal temperature sensor.
Display Relative Shows the space humidity as measured by the internal
Humidity humidity sensor (when the connected Allure EC-Smart-
Vue Sensor supports this feature).
Display CO2 Shows the space CO2 level as measured by the
internal CO2 sensor (when the connected Allure EC-
Smart-Vue Sensor supports this feature).
Display Shows the Allure EC-Smart-Vue Sensor’s firmware
Hardware Info version.
Adjust Contrast Adjust the display’s contrast setting.
Adjust Motion Adjust the motion detector’s sensitivity to movement
Sensitivity within the detector’s operating range (when the
connected Allure EC-Smart-Vue Sensor supports this
feature). With this scene, Allure EC-Smart-Vue Sensor
users can set any of the following values:
• 0: Low sensitivity to motion.
• 1: Medium sensitivity to motion.
• 2: High sensitivity to motion.
Refer to the Allure EC-Smart-Vue Sensor’s installation
guide for more information.
EC-gfxProgram 571
Parameter Description
Calibrate Space Allows the user to calibrate the temperature sensor at
Temp the Allure EC-Smart-Vue Sensor. The permitted range
is between 0.09 and 5.4ºF (0.05 and 3ºC).
NOTE: To use this scene, a technician adjusts the tem-
perature shown in the scene to that of a refer-
ence thermometer. The necessary offset is
automatically calculated.
Calibrate Allows the user to calibrate the hygrometer sensor at
Humidity the Allure EC-Smart-Vue Sensor. The permitted range
is between 0.5 and 3% (when the connected Allure EC-
Smart-Vue Sensor supports this feature).
NOTE: To use this scene, a technician adjusts the
humidity shown in the scene to that of a refer-
ence hygrometer. The necessary offset is auto-
matically calculated.
Edit Baud Rate Allows the Baud rate of the connected controller’s
(ECB Series BACnet MS/TP communications network to be set.
controllers)
Edit MAC Allows the MAC address of the connected controller to
Address (ECB be set when the controller’s MAC address DIP
Series switches have been set to 0. See the controller’s
controllers) installation guide for more information.
Edit Subnet ID Each controller can support a number of Allure EC-
Smart-Vue Sensors. Each Allure EC-Smart-Vue
Sensor must have a unique Subnet ID among all Allure
EC-Smart-Vue Sensor connected to a controller. This
scene allows the Subnet ID to be set.
Edit Date or Allows the user to set the controller’s year, time, or date
Time (ECB at the Allure EC-Smart-Vue Sensor. See Edit Date or
Series Time scene (ECB Series controllers).
controllers)
Password This password protects the advanced settings.
Validation
Wireless Allows a user to commission a wireless sensor by
Commissioning capturing a wireless sensor’s datagram which is
(ECB Series transmitted by activating the wireless sensor’s learn
controllers) button. The datagram contains the wireless sensor’s ID
number which is then assigned to the selected
Wireless Sensor instance. See Wireless
Commissionning scene (ECB Series only).
Up One Level Allows the user to go up one menu level.
572 EC-gfxProgram
Custom scenes Custom scenes can be added to the Allure EC-Smart-Vue Sensor.
Figure 339: Custom Allure EC-Smart-Vue Sensor scenes
Parameter Description
Normal Display Displays the value of a Value. Opens the Display
Scene popup. See Display Scene configuration.
Edit Value Allows the value of a Value to be edited. Opens the
Edit Scene popup. See Edit Scene configuration.
Display and Edit Displays the value of one Value while allowing another
Value Value to be edited. Opens the Display and Edit Scene
popup. See Display and Edit Scene configuration.
Change Value This scene is invisible when a user navigates past it;
however by doing so, it sets a point to a specific value.
Opens the Change Value Scene popup. See Change
Value Scene configuration.
Select String Allows an enumeration string to be selected. Opens the
Enumeration String Enumeration Scene popup. See String
Enumeration Scene configuration.
Select Value Allows an enumeration value to be selected. Opens the
Enumeration Value Enumeration Scene popup. See Value
Enumeration Scene configuration.
Select Icon Allows an icon to be selected. Opens the Icon
Enumeration Enumeration Scene popup. See Icon Enumeration
Scene configuration.
Add Sub Menu Adds a new menu in which scenes are added. Users
drill-down into these menus to access the scenes
contained in the sub-menu.
EC-gfxProgram 573
Common scene Scene configurations have configuration options that are common from scene
options configuration to scene configuration.
Parameter Description
Edit Real Time Changes the value in the controller without the user
having to press the Menu button to accept the new
value.
Allow null Allows a user to select null as a value. A null value can
be used to release a priority. See Commandable object
priority array levels.
When this option is enabled, the Allure EC-Smart-Vue
Sensor user can select a null value for the scene as
follows:
1. Press and hold both arrow keys simultaneously.
The screen displays three dashes (this indicates that
the null value has been selected).
2. Press the Menu button to send the null value to the
code.
Decimals This sets the number of decimal points to be used
when displaying a value in the display value part of the
LCD display. Auto shows the maximum number of
decimal places that will fit into the remaining space
available on the display.
Timeout This sets the delay before the display returns to the
Main Rolling Scenes when there is no user interaction,
or it goes to the next scene display while in a Main
Rolling Scenes.
Blink Text Makes the display flash information to get a user’s
Selection attention.
Blink Value
Reverse Displays the scene when the condition is inactive. See
Condition Conditions.
574 EC-gfxProgram
Edit Date or Time This configuration allows the user to set the controller’s real time clock. Time
scene (ECB or date updates made through the Allure EC-Smart-Vue Sensor are sent as a
Series manual time synchronization to all controllers that support the time-synchroni-
controllers) zation-recipients or utc-time-synchronization-recipients services on the net-
work as a local broadcast. Up to five controllers for time-synchronization-
recipients can be defined and up to five controllers for utc-time-synchroniza-
tion-recipients can be defined.
The Allure EC-Smart-Vue Sensor’s LCD screen can also show the current
time or text in a scrolling display.
NOTE: Three scenes are needed to allow the user to set the year, time, or
date: That is, one scene is required for each of these parameters.
Figure 340: Edit Date or Time Scene configuration
Parameter Description
Text Section This defines the types of data that will be displayed in
Text the scrolling display part of the LCD display: Default
Datetime shows the default date and time set in Global
Options, Text shows up to 16 characters of upper-case
text defined in the Text box. Year, Time, and Date
shows the currently configured year, time, and date.
Edit Select the date or time parameter to be edited in this
scene.
Condition This is used to hide or show this scene. See
Conditions.
EC-gfxProgram 575
Parameter Description
Time sync (ECB Set the recipient controller of the manual time
Series only) synchronization message that is sent when a user sets
the time or date with the Allure EC-Smart-Vue Sensor.
NOTE: Usually, the objective is to propagate the user’s
time and date setting to all controllers that have
calendars and schedules, or are equipped with
Allure EC-Smart-Vue Sensors where the time
and date may be shown. This is done by setting
the recipient as a B-AAC or B-BC listed control-
ler that supports BIBBS DM-ATS-A. See Real
Time Clock (ECB & ECY Series).
See also Common scene options.
Figure 341: Manual Time Sync Configuration
Parameter Description
Time zone Select the type of manual time synchronization
message to send:
UTC: For controllers that maintain their clock at
Greenwich Mean Time and use a time zone offset to
calculate the local time, as set in Time zone in Figure
348. This controller must support the utc-time-
synchronization-recipients service.
Local: For controllers that maintain their clock at the
local time (for their time zone). This controller must
support the time-synchronization-recipients service.
576 EC-gfxProgram
Parameter Description
Recipient Type The destination controller for manual time
synchronization can be specified as follows:
• BACnet Node Address.
• BACnet device instance – Click Select device from
database to open a list of devices in the database.
This is the preferred option when using EC-Net.
Wireless Commissionning scene (ECB Series only)
Wireless commissioning allows you to configure a Wireless Sensor in your
controller’s project code without associating a specific Sensor ID to the Wire-
less Sensor. You must also create a Wireless Commissioning scene in the
Allure EC-Smart-Vue Sensor. Once the controller is in the field, a technician
can associate the specific Sensor ID of the wireless sensor that has been
installed through the Allure EC-Smart-Vue Sensor’s Wireless Commissioning
scene. To program the controller for this, see Configuring a Wireless Commis-
sionning Scene (ECB Series only). To discover a wireless sensor in the field,
see Using the Allure EC-Smart-Vue Sensor to discover wireless devices in
the field (ECB Series only).
Wireless Commissioning consists of two scenes: The first scene allows
access to the second submenu wherein the user can select a wireless sensor
instance and engage the wireless learning phase that has a fixed timeout of 5
minutes during which the controller will wait for a wireless datagram. These
two scenes always come together.
NOTE: To cancel the wireless learn phase, exit the scene by pressing for
5 seconds on the Allure EC-Smart-Vue Sensor.
Figure 342: First-level wireless commissionning Menu Scene
Parameter Description
Text Shows up to 16 characters of upper-case text that
identifies this Wireless Commissioning menu scene.
Condition This is used to hide or show this scene. See
Conditions.
See also Common scene options.
The second-level Wireless Commissioning Scene is hard coded to assign the
wireless sensor’s ID number to the selected Wireless Sensor block instance.
EC-gfxProgram 577
This scene is dynamically created for each Wireless Sensor instance block
that has been added to the project.
Figure 343: Second-level Wireless Commissionning Scene
Parameter Description
Text section These values are fixed and cannot be edited.
Value
Condition This is used to hide or show this scene. See
Conditions.
See also Common scene options.
Configuring a Configure a Wireless Commissioning Scene as follows.
Wireless
Commissionning 1. Add a Wireless Sensor block to the Programming Sheet.
Scene (ECB Figure 344: Adding a Wireless Sensor to the programming sheet
Series only)
578 EC-gfxProgram
2. In the Properties pane for the Wireless Sensor block, click the Sensor
drop-down list and then click Add new sensor.
Figure 345: Adding a Wireless Sensor to the controller
NOTE: Do not set the Sensor ID or click Learn. It is through the Allure EC-
Smart-Vue Sensor scene that the sensor ID learn will be triggered.
3. Select the wireless sensor type in the Sensor type drop down list.
4. Configure the Wireless Sensor block as you normally would. See also
Wireless Sensor (ECB Series).
Figure 346: Configuring the Wireless Sensor
5. Click OK.
EC-gfxProgram 579
6. Add and configure as many wireless sensors that will be used with the
controller: In the Properties pane for the Wireless Sensor block, click
the Sensor drop-down list and then click Add new sensor.
7. Add a ComSensor block to the Programming Sheet.
Figure 347: Adding a ComSensor block to the programming sheet
8. Double-click the ComSensor block.
9. Add a Wireless Commissioning scene to the Advanced Menu and con-
figure it. See Wireless Commissionning scene (ECB Series only).
10. Synchronize your project code with the controller.
Using the Allure 1. With the connected Allure EC-Smart-Vue Sensor, go to the Wireless
EC-Smart-Vue Commissioning scene. The scrolling display part of the LCD display
Sensor to shows Wireless.
discover
wireless devices 2. Press an up or down button to enter into the submenu.
in the field (ECB 3. Use the up/down buttons to select a Wireless Sensor block
Series only) instance that will be used to learn the sensor’s ID.
4. Press to start the wireless learning phase. The scrolling display part of
the LCD display shows a 5 minute count-down timer during which a wire-
less datagram must be received in order to associate the Wireless Sensor
(ECB Series) block instance to a wireless device.
5. The controller must receive a valid signal from a wireless device when the
device’s Learn button is pressed or, if it does not have a Learn button,
when the device senses a change of value. Once the value has been
580 EC-gfxProgram
learnt by the controller, the sensor’s ID value is shown in the scrolling dis-
play part of the LCD display.
6. Press for 5 seconds to accept the value and exit the scene.
7. Repeat the procedure for all remaining Wireless Sensor block instances.
NOTE: Synchronizing your project code with a controller will erase the discov-
ered wireless Sensor ID from the controller. Repeat the above proce-
dure to re-discover it.
Unlearning a 1. With the connected Allure EC-Smart-Vue Sensor, go to the Wireless
Sensor ID for a Commissioning scene. The scrolling display part of the LCD display
wirelss sensor shows Wireless.
block instance
(ECB Series 2. Press an up or down button to enter into the submenu.
only) 3. Use the up/down buttons to select the Wireless Sensor block
instance that will be cleared of a wireless sensor’s ID.
4. Press to start the wireless learning phase. The scrolling display part of
the LCD display shows a 5 minute count-down timer.
5. Press both the up and down buttons at the same time.
6. Press for 5 seconds to accept the value and exit the scene.
Scene configuration
Display Scene This configuration makes the Allure EC-Smart-Vue Sensor’s LCD screen
configuration show a value from a Value. The Allure EC-Smart-Vue Sensor’s LCD screen
can also show the time, text, or a delay Value in a scrolling display.
Figure 348: Display Scene configuration
Parameter Description
Text Section This defines the types of data that will be displayed in
Text the scrolling display part of the LCD display: Default
Datetime shows the default date and time set in Global
Options, Text shows up to 16 characters of upper-case
text defined in the Text box. Delay Values can also be
displayed (see Delay Value configuration).
EC-gfxProgram 581
Parameter Description
Value The Value to be displayed in the Display Value field of
the LCD display. See Values.
Conditions This is used to hide or show this scene. See
Conditions.
See also Common scene options.
Edit Scene This configuration allows the display and editing of a value from a Value. The
configuration Allure EC-Smart-Vue Sensor’s LCD screen can also show the time, text, or a
delay Value in a scrolling display.
Figure 349: Edit Scene configuration
Parameter Description
Text Section This defines the types of data that will be displayed in
the scrolling display part of the LCD display: Default
Text
Datetime shows the default date and time set in Global
Options, Text shows up to 16 characters of upper-case
text defined in the Text box. Delay Values can also be
displayed (see Delay Value configuration).
Value The Value to be displayed in the Display Value field of
the LCD display. The value can be changed by using
the up/down buttons . See Values.
Conditions This is used to hide or show this scene. See
Conditions.
Value Limits Use to set the valid limit range over which the value
can be edited by the user. Options include a static
setting (0 to 126) or a dynamic value set by a Value.
Click to set the limits in the Scene Limits
Configuration popup.
See also Common scene options.
582 EC-gfxProgram
Scene Limits This configuration sets the valid limit range over which the value can be edited
Configuration by the user.
Figure 350: Static and dynamic Scene Limits Configuration
Parameter Description
Enable low limit When enabled, sets the lowest value that can be
selected by the user.
Enable high limit When enabled, sets the highest value that can be
selected by the user.
Static Static (fixed) values are set to define the high or low
limit.
Dynamic The dynamic values for the high or low limit are based
on the instantaneous value of a Local or Global Value.
Value Set the Static value or select a Dynamic value to be
used for the high or low limit.
EC-gfxProgram 583
Display and Edit This configuration allows a user to edit a Value while displaying the value of
Scene another Value. The Allure EC-Smart-Vue Sensor’s LCD screen can also show
configuration the time, text, or a delay Value in a scrolling display.
Figure 351: Display and Edit Scene configuration
Parameter Description
Text Section This defines the types of data that will be displayed in
the scrolling display part of the LCD display: Default
Text
Datetime shows the default date and time set in Global
Options, Text shows up to 16 characters of upper-case
text defined in the Text box. Delay Values can also be
displayed (see Delay Value configuration).
Value The Value to be displayed in the Display Value field of
the LCD display. See Values.
Conditions This is used to hide or show this scene. See
Conditions.
Edited Value The Value to be edited by the user. The value can be
changed by using the up/down buttons .
Value Limits Use to set the valid limit range over which the value
can be edited by the user. Options include a static
setting (0 to 126) or a dynamic value set by a Value.
Click to set the limits in the Scene Limits
Configuration popup.
See also Common scene options.
584 EC-gfxProgram
Change Value This scene is invisible when a user navigates past it; however by doing so, it
Scene sets a point to a specific value when the Condition is True.
configuration
Figure 352: Change Value Scene configuration
Parameter Description
Value The Local or Global Value to be set. See Values.
Conditions When this condition is True, the Value takes the value
of Set value.
Set value The value to be set when the Condition is True.
See also Common scene options.
String This configuration allows a user to select a text string from a string enumera-
Enumeration tion (for example, to select a mode from an enumeration of Heat, Cool, Auto,
Scene and so on).
configuration
Figure 353: String Enumeration Scene configuration
Parameter Description
Text The enumeration string from which the user can select
a setting. The value can be changed by using the up/
down buttons .
Value The text to be shown in the Value field. Not all
characters are shown with equal quality as this portion
of the display does not support the full alphabet.
Condition This is used to hide or show the scene. See Conditions.
Filter This restricts the available choices to the user. See
Filter Configuration window.
See also Common scene options.
EC-gfxProgram 585
Filter The filter restricts the available choices enumeration or Value members avail-
Configuration able to a user for this scene. Click to set the Filter properties.
window
Figure 354: String Enumeration scene Filter Configuration
Parameter Description
Enable filter Enable the filter to restrict the available choices to the
user.
Filter type Static: Select the Members of the enumeration to
make available to the user.
Dynamic: Select the value that will hold the number
corresponding to the members that will be made
available to the user.
586 EC-gfxProgram
Value This configuration allows a user to select a value from an enumeration shown
Enumeration in the display’s Display Value field. The Allure EC-Smart-Vue Sensor’s LCD
Scene screen can also show the time or text in a scrolling display.
configuration
Figure 355: Value Enumeration Scene configuration
Parameter Description
Text Section This defines the types of data that will be displayed in
the scrolling display part of the LCD display: Default
Text
Datetime shows the default date and time set in Global
Options, Text shows up to 16 characters of upper-case
text defined in the Text box. Delay Values can also be
displayed (see Delay Value configuration).
Value The enumeration Values to display in the Display Value
field of the LCD display that allows the user to select
the enumeration value by using the up/down buttons
. Only 4 digits are shown. See Values.
Condition This is used to hide or show this scene. See
Conditions.
Filter This restricts the available choices to the user. See
Filter Configuration window.
See also Common scene options.
EC-gfxProgram 587
Icon This configuration allows a user to select an icon from an icon Value. The
Enumeration Allure EC-Smart-Vue Sensor’s LCD screen can also show the time or text in a
Scene scrolling display.
configuration
Figure 356: Icon Enumeration Scene configuration
Parameter Description
Text Section This defines the types of data that will be displayed in
the scrolling display part of the LCD display: Default
Text
Datetime shows the default date and time set in Global
Options, Text shows up to 16 characters of upper-case
text defined in the Text box. Delay Values can also be
displayed (see Delay Value configuration).
Value The icon Values to display in the Icon field of the LCD
display that allows the user to select the icon value by
using the up/down buttons . See Values.
Condition This is used to hide or show this scene. See
Conditions.
Filter This restricts the available icon choices to the user.
See Filter Configuration window.
See also Common scene options.
Conditions Conditions are used to Hide/Show Scenes from the user by sharing a digital
signal from logical blocks on the programming sheet with the ComSensor
block through a ComSensor Condition block (see ComSensor Condition
(ECL, ECB & ECY Series)). Up to 15 Conditions can be created. The number
and name of all conditions are identical across all Allure EC-Smart-Vue Sen-
sors connected to the controller. The condition values sent from the ComSen-
sor Condition block to each Allure EC-Smart-Vue Sensor is unique. This
means that each condition on each Allure EC-Smart-Vue Sensor connected
to the controller can be individually enabled/disabled.
To add a condition, right-click Conditions in the tree and select Add New
Conditions and give this condition a name.
Figure 357: Add New Condition
588 EC-gfxProgram
The condition can now be used to hide or show the scene in the ComSensor
configuration as follows.
1. On a programming sheet, add a ComSensor Condition block.
2. In the Properties of the ComSensor Condition block, set the Condition
to the name of the newly created condition.
Figure 358: Selecting the condition instance created in the ComSensor block
3. Connect a digital output to the ComSensor Condition block’s input. The
input to the ComSensor Condition block will now hide or show any scene
that uses this condition. An example is shown below.
Figure 359: ComSensor Condition block example
ComSensor A scene can be shown or hidden according to the value at the associated
Condition block ComSensor Condition block Input and the Reverse Condition setting for
and Reverse the scene as shown in the following table.
Condition
ComSensor Condition block Scene Reverse Condition
Scene Reverse Condition Set
Input Value Cleared
Digital 0 The scene is hidden. The scene is shown.
Digital 1 The scene is shown. The scene is hidden.
Values Values are used to share data between the ComSensor block and other
blocks on the programming sheet through a ComSensor Value block (see
ComSensor Value (ECL, ECB & ECY Series)).
Up to 30 Local Values can be created: The number and name of all Values
are identical across all Allure EC-Smart-Vue Sensors connected to the con-
EC-gfxProgram 589
troller. The value for each Value is unique to each Allure EC-Smart-Vue Sen-
sor.
Up to 70 Global Values can be created: The names and values are shared
across all Allure EC-Smart-Vue Sensors.
To add a Value, right-click Local Values / Global Values in the tree and
select Add New Value, and select the Value type to be added.
Figure 360: Add New Value
The Value can now be used to pass values between the ComSensor block
and other blocks as follows:
1. On the programming sheet, add a ComSensor Value block.
2. In the properties of the ComSensor Value block, set the Value in the
Properties pane to the name of the newly created Value.
Figure 361: Selecting the Value instance created in the ComSensor block
3. Connect the ComSensor Value block to other blocks on the program-
ming sheet. An example is shown below.
Figure 362: ComSensor Value block example
4. Use the Value in a ComSensor Block scene by selecting it in the Value
drop down list.
590 EC-gfxProgram
Numeric Value Values can be linked to a BACnet object.
configuration
Figure 363: Numeric Value configuration
Parameter Description
Unit Select the native units of the value sent to the Value.
This is usually set to the default internal measurement
system (Metric or US units). Internally, the Allure EC-
Smart-Vue Sensor converts values between
measurement systems, as required by a scene.
Default Value This value is used when all priority levels are set to
Null. See Commandable object priority array levels.
Link to BACnet Select the BACnet object to be associated to the Value
Object if needed.
Write Priority Set the BACnet priority to use to write to the BACnet
object from the Allure EC-Smart-Vue Sensor. See
Commandable object priority array levels.
Delay Value Delay Values are used to display a count-down delay in the Scrolling Display
configuration area of the LCD.
Figure 364: Delay Value configuration
Parameter Description
Delay Display Select how the delay is to be displayed (minutes /
minutes and seconds).
Default Value This value is used when all priority levels are set to Null.
See Commandable Object Priority Array Levels.
Link to BACnet Select the BACnet object to be associated to the Value if
Object needed.
Write Priority Set the BACnet priority to use to write to the object. See
Commandable Object Priority Array Levels.
EC-gfxProgram 591
Icon Value Icon Values are used to store the value of an Icon to display different icons on
configuration the Allure EC-Smart-Vue Sensor based on EC-gfxProgram programming
code.
Figure 365: Icon Value configuration
Parameter Description
Link to BACnet Select the enumeration that will control the display. The
Object table below shows the icon’s behavior according to the
enumeration value.
Write Priority Set the BACnet priority to use to write to the object.
See Commandable object priority array levels.
Start Value Sets the default icon to be first shown.
The following icon values can be added to control their display by linking the
Value to an enumeration. To see an example of the Allure EC-Smart-Vue Sen-
sor icons, refer to Icon selection.
Parameter Description
Eco Vue Value Sets the Eco Vue icon display properties.
Occupancy Sets the occupied / unoccupied icon display properties.
Value
Fan Speed Sets the fan speed icon display properties.
Value
Temperature Sets the indoor / outdoor / setpoint temperature icon
Value display properties.
HVAC Mode Sets the heat / cool / dehumidify icon display
Value properties.
592 EC-gfxProgram
Parameter Description
Alarm Value Sets the alarm icon display properties.
Light Value Sets the light icon display properties.
Blind Value Sets the sun blind / shade icon display properties.
Clock Value Sets the clock icon display properties.
Unit Value Sets the unit for the display value. If the units from the
EC-gfxProgram project are different from that chosen
here, the Allure EC-Smart-Vue Sensor internally
converts the units automatically.
Hide: Suppresses the icon from being shown on the display.
Blink: Flashes the icon on and off.
Enumeration Enumeration Values are used to store the value of an enumeration to be dis-
Value played or selected on the Allure EC-Smart-Vue Sensor.
configuration
Figure 366: Enumeration Value configuration
Parameter Description
Enumeration Select the Enumeration to associate with this Value.
Default Value This value is used when all priority levels are set to
Null. See Commandable object priority array levels.
Link to BACnet Select the BACnet object to be associated to the Value
Object if needed.
Write Priority Set the BACnet priority to use to write to the object.
See Commandable object priority array levels.
EC-gfxProgram 593
Enumeration The Enumeration Validity Value is used to mask enumerations when using
Validity Value Select Enumeration Scene. Digital validation is done with the enumeration
configuration fields.
Figure 367: Enumeration Validity Value configuration
Parameter Description
Link to BACnet Select the BACnet object to be associated to the Value
Object if needed.
Write Priority Set the BACnet priority to use to write to the object.
See Commandable object priority array levels.
Enumerations Enumerations are used to select options in the Select Enumeration Scenes.
All texts displayed in the text section of a scene use an enumeration. A maxi-
mum of 127 strings in total can be created and each string can have up to 16
characters. The first enumeration value to be shown can be selected.
Enumeration string optimization is possible if the same text is used more than
one time, either when the text is used in Enumerations or in the Scene Text
box. Enumerations added by the user are not optimized.
To add an enumeration, right-click Enumerations in the tree and select Add
New Enumeration.
Figure 368: Add New Enumeration
594 EC-gfxProgram
Click an empty cell in the Name column and type a value to add a new enu-
meration. Click a cell with a pre-existing value in the Name column and type a
value to edit the current value.
Figure 369: Enumeration configuration
Parameter Description
Start Value Sets the base index of the enumeration (0base, 1base,
-1base, etc.).
Value The enumeration value.
Name The enumeration string.
Global Options These settings are shared between all Allure EC-Smart-Vue Sensors.
Figure 370: Global Options
Parameter Description
Default datetime Set the default date and time format to use when
display Datetime is selected in the Text Section drop-down.
Time format Set the time format to use when Time is selected in the
Text Section drop-down.
Date format Set the date format to use when Date is selected in the
Text Section drop-down.
EC-gfxProgram 595
Parameter Description
Activity backlight Set the LCD backlight level when the Allure EC-Smart-
Vue Sensor has had any of its keys recently pressed by
a user.
Inactivity Set the LCD backlight level when the Allure EC-Smart-
backlight Vue Sensor has not had any of its keys recently
pressed by a user.
Default scene The default scene timeout that is used when creating a
timeout new scene.
ComSensor Condition (ECL, ECB & ECY Series)
Description Used to send a condition to ComSensor blocks where they are used to Hide/
Show Allure EC-Smart-Vue Sensor Scenes from the user when configured.
Slim format This block can be collapsed into a slim format. See Collapsed in Common
support block properties.
Advanced Conditions (ECL Series), Conditions, Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
Input Digital 0 or 1 Block input.
Output(s)
Port Type Range Description
Output Digital 0 or 1 Block output. The Present Value.
596 EC-gfxProgram
Block properties See also Common block properties.
Property Type Range Default Description
Condition Menu See – This menu lists the Conditions that
Description have been previously created in a
ComSensor block. See Conditions
(ECL Series) or Conditions.
Number Menu See ComSensor 1 Use this drop-down menu to select
Description the Allure EC-Smart-Vue Sensor
instance to interface with.
ComSensor Condition Selector (ECL, ECB & ECY
Series)
Description Used with the Number input of the Generic ComSensor Condition (ECL, ECB
& ECY Series) block to consistently identify a ComSensor Condition (ECL,
ECB & ECY Series) index number. This index number is dynamically
assigned to the ComSensor Condition name. When a ComSensor Condition
is deleted, the index numbers for other ComSensor Conditions may change.
This block outputs the index number for the ComSensor Condition selected in
the Condition field of this block’s Property pane.
Advanced Configure Ports, Show/Hide Ports
configuration
Related blocks ComSensor (ECL Series), ComSensor (ECB & ECY Series), ComSensor
Value (ECL, ECB & ECY Series), ComSensor Condition (ECL, ECB & ECY
Series)
Input(s) N/A
Output(s)
Port Type Range Description
Output Numeric 2 to 16 Block output. The current index number for the
ComSensor Condition (ECL, ECB & ECY Series) selected
in the Condition field of this block’s Property pane. See
Conditions (ECL Series) and Conditions.
EC-gfxProgram 597
Block properties See also Common block properties.
Property Type Range Default Description
Condition Menu See – This menu lists the Conditions that have
Description been previously created in a ComSensor
block. See Conditions (ECL Series) or
Conditions.
ComSensor Value (ECL, ECB & ECY Series)
Description Used to send or receive a value, digital, or enumeration to or from ComSen-
sor blocks where they can be shown to the user on the controller’s operator
interface or on the connected ECx-Display. Users can also edit values that are
then used by the programming code. First a ComSensor’s Value must be con-
figured to use this block.
Slim format This block can be collapsed into a slim format. See Collapsed in Common
support block properties.
Advanced Values (ECL Series), Values, Configure Ports, Show/Hide Ports
configurations
Related blocks ComSensor (ECL Series), ComSensor (ECB & ECY Series), Generic Com-
Sensor Value (ECL, ECB & ECY Series), ComSensor Condition (ECL, ECB &
ECY Series), ComSensor Value Selector (ECL, ECB & ECY Series)
Input(s)
Port Type Range Description
Input Numeric ±3.4028×1038 Block input.
598 EC-gfxProgram
Output(s)
Port Type Range Description
Output Numeric ±3.4028×1038 Block output. The Present Value.
Update Digital 0 or 1 Outputs a pulse when user activity updates a Value (a
button is pressed on the Allure EC-Smart-Vue
Sensor).
Block properties See also Common block properties.
Property Type Range Default Description
Value Menu See ComSensor 1 Use this drop-down menu to select
Description the ComSensor Value to interface
with. See Values (ECL Series) or
Values. When a ComSensor’s
Global Value is selected, the title of
the block changes to Global
ComSensor Value.
ComSensor Value Selector (ECL, ECB & ECY
Series)
Description Used with the Number input of the Generic ComSensor Value (ECL, ECB &
ECY Series) block to consistently identify a ComSensor Value (ECL, ECB &
ECY Series) index number. This index number is dynamically assigned to the
ComSensor Value name. When a ComSensor Value is deleted, the index
numbers for other ComSensor Values may change. This block outputs the
index number for the ComSensor Value selected in the Value field of this
block’s Property pane.
Advanced Values (ECL Series), Values, Configure Ports, Show/Hide Ports
configuration
Related blocks ComSensor (ECL Series), ComSensor (ECB & ECY Series), Generic Com-
Sensor Value (ECL, ECB & ECY Series), ComSensor Value (ECL, ECB &
ECY Series)
Input(s) N/A
EC-gfxProgram 599
Output(s)
Port Type Range Description
Output Numeric 11 to 110 Block output. The current index number for the
ComSensor Value (ECL, ECB & ECY Series) selected
in the Value field of this block’s Property pane. See
also Values (ECL Series) or Values.
Block properties See also Common block properties.
Property Type Range Default Description
Value Menu See – This menu lists the Values that have been
Description previously created in a ComSensor block.
See Values (ECL Series) or Values.
EnOcean Device (ECY Series)
Description Used to interface with a wireless input using standard EnOcean® profiles.
For the number of wireless inputs that are available for a device, refer to its
datasheet. Different output ports are available on the EnOcean Device block
depending on the sensor type selected. Also, some sensor types can use
more than one wireless inputs.
Slim format This block can be collapsed into a slim format. See Collapsed in Common
support block properties.
Number of The number of EnOcean Device inputs supported by a controller is shown in
blocks the Statistics pane.
Advanced Resources Configuration, Advanced configuration, Configure Ports, Show/
configuration Hide Ports
Input(s) N/A
600 EC-gfxProgram
Output(s)
Port Type Range Description
SpaceTemp Numeric See the EEP The room’s temperature.
profile of the
selected NOTE: Any change in the measurement system of
EnOcean the project results in the output value
device being converted.
Setpoint Numeric Varies accord- The temperature setpoint offset being sent by the
ing to EnOcean EnOcean device.
device (usually
-10 to 10) NOTE: Any change in the measurement system of
the project results in the output value
being converted.
Humidity Numeric 0 to 99.9 The room’s relative humidity.
Occupancy Digital 0 or 1 The occupied / unoccupied state.
FanSpeed Enum 1 to 5 The fan speed. The values are defined as such:
1 = ST_NUL (AUTO)
2 = ST_OFF
3 = ST_LOW
4 = ST_MED
5 = ST_HIGH
Illumination Numeric 0 to 1020 The light intensity.
0 to 510
300 to 30000
600 to 60000
InputStatus Digital 0 or 1 The status of a digital switch.
Window Con- Digital 0 or 1 The status of a digital switch (a window contact,
tact key card presence, or slide switch).
KeyCard
Slide Switch
Supply Voltage Numeric 0 to 5.1 The EnOcean device’s supply voltage.
Button Enum 1 or 2 Button of an EnOcean device having the Rocker
Switch profile.
CO2 Numeric See the EEP The room’s CO2 level.
profile of the
selected
EnOcean
device
InputVoltage Numeric Manufacturer- The input voltage of an EnOcean device having
specific the Universal profile.
PIR Digital 0 or 1 The status of the motion / occupancy sensor.
EC-gfxProgram 601
Port Type Range Description
[ANY].OutOf Digital 0 or 1 See Out-of-Service.
Service
[ANY].Fault Digital 0 or 1 Logical True (1) if the Reliability property does not
have a value of No Fault Detected, otherwise log-
ical False (0).
Wireless Digital 0 or 1 Outputs a pulse when a valid EnOcean telegram
Update is received. For example, a user presses a wire-
less switch button and the transmission is
received and decoded.
RSSI Numeric -98 to -41 The current EnOcean device’s receive signal
Available with strength measured in dBm. Wireless operation is
wireless receiv- more reliable with stronger signal strength. See
ers that support the Receiver signal strength indication table in
this feature the EnOcean Device information section for more
information.
NOTE: When troubleshooting signal reception
issues, connect this output port to a Live
Trend Log block to track signal strength
over time and to appraise the effective-
ness of any changes made to receiver and
sensor location.
Block properties See also Common block properties.
Property Type Range Default Description
Number Menu See – The EnOcean device instance. Click the drop-
Description down arrow to see the list of the configured
EnOcean devices and to switch between them.
When an EnOcean Device block is added to a
programming sheet, it has no output ports. First
you need to add a device resource (see Adding
resources).
Once you have added and configured your
EnOcean devices, they will be listed in this
Number drop-down menu.
602 EC-gfxProgram
Advanced The configuration parameters for this block are set via the Resources Config-
configuration uration window. The EnOcean Configuration window has the settings required
to configure any type of EnOcean device, including sensors, switches, digital
contacts, etc. Depending on the Device type selected, the options available
will vary.
EnOcean Device
information
Parameter Description
Object name Used to identify this block in the Reliability property and
on the controller’s operator interface (if equipped).
Description Enter a description of the block here.
Controller spe- For ECY Series controllers, indicate whether the Devi-
cific ceID is considered "controller specific" and thus will not
be overwritten when the project is re-synchronized on
the controller.
Best practice when first using Controller Specific
configurations in existing projects:
1. Create a backup of the project on each controller.
2. Open the reference project that you want to down-
load to multiple devices.
3. Flag the Controller Specific checkbox for the appli-
cable Network Object and EnOcean resources.
4. Save and Synchronize the project for all controllers
to synchronize the Project Identifiers.
WARNING: When you open and save projects on indi-
vidual controllers, each project gets
assigned a different project identifier. If you
have flagged resource configurations as
controller specific in those projects, and
you then download a reference project to
all the controllers, these configurations will
be overwritten by those in the reference
project since the identifiers of the refer-
ence project being downloaded and the
project in the controller don't match.
Device ID The Device ID is a unique hexadecimal identifier used
to identify each EnOcean device. The Device ID of an
EnOcean device must be associated with the controller
for communication to take place. The controller dis-
cards messages that are received from unknown
sources.
EC-gfxProgram 603
Parameter Description
Device type The sensor type and EEP profile number. When a
device is learned in, the device type may be automati-
cally detected (see the Learn button below). If you are
unable to learn in a device (the wireless receiver is not
currently connected to the controller, the device does
not send its device profile type, the controller is not
online, or the device is not in range), you can select the
device type from this drop-down list. The EnOcean
Equipment Profiles (EEP) is shown for each device
shown in this drop-down list.
Learn This button opens the Learn window. For a list of sup-
ported devices, see Supported EnOcean Wireless Sen-
sor Profiles.
Receiver signal The EnOcean device‘s received signal strength mea-
strength indica- sured in dBm when the sensor is learned in. Wireless
tion operation is more reliable with stronger signal strength.
Signal strength bars show the relative received signal
power. See Table 16.
Available with For some devices, it may be necessary to activate the
wireless receiv- dedicated button on the device to allow the controller to
ers that support determine the RSSI.
this feature
Max Receive The maximum time period between updates received
Time from the EnOcean device. This field appears for certain
device types only.
Number of but- Select the number of buttons on the switch from 1 to 4.
tons
Available when
a rocker switch
device type is
selected.
Table 16: Receiver signal strength indication
Wireless Signal
Bars Signal Quality Description
Strength
-50 to -41 dBm 5 Excellent Highest wireless reliability.
-62 to -51 dBm 4 Strong Excellent resistance to interference.
-73 to -63 dBm 3 Good
-85 to -74 dBm 2 Acceptable Moderate resistance to interference. Transmission
path reliability may be an issue. Consider relocat-
-98 to -86 dBm 1 Weak ing the sensor or the wireless receiver to improve
transmission reliability or install a repeater to
increase signal strength.
604 EC-gfxProgram
Configuration Figure 371: EnOcean Device Inputs Configuration window
Parameter Description
Name The EnOcean Device’s input descriptive name. This is
used to identify the input on the controller’s operator
interface or on the connected ECx-Display (if
equipped).
Offset The offset is a constant value that is applied to the
device input reading to compensate for reading errors,
for example, to perform sensor calibration. For a push-
button, see Button.
NOTE: When this value is changed, it becomes effec-
tive only when the next valid EnOcean telegram
is received. See also the WirelessUpdate out-
put port.
Default When the property cannot be read from the wireless
sensor, this is the fall back value to be used in lieu of
live data.
True text / false Assigns a Boolean format to the BACnet object, for
text example, On, Off. Click Configure to create a new
enumeration or add a new member to an enumeration.
See Creating and using enumerations (ECB & ECY
Series).
EC-gfxProgram 605
Parameter Description
Options Normal: Select this for a 2-position on-off switch.
Momentary: Selects one of three enumerations: Neu-
tral (no button pressed), button 1 pressed, or button 2
pressed. This can be used to dim lights or to raise or
lower a sun blind.
Toggle: The output state inverts for each switch activa-
tion.
Min range This field is used to specify the value of the minimum
setpoint offset.
Max range This field is used to specify the value of the maximum
setpoint offset.
Range Select the byte for the range of the light sensor. Refer
to the EnOcean equipment profile.
Enabled Check this box to bind a BACnet resource to your
EnOcean point. When set, the Resource Type and
Resource Instance fields are displayed below.
Resource type The drop-down list allows you to select one of the
resource types that are being used in the project and
that can be bound to the EnOcean point (Analog Val-
ues, Binary Values, Multi-State Values, etc).
Resource Use this drop-down list to select the specific object to
instance which you want to bind the EnOcean point. Only
resources of the type selected in the Resource Type
field are included in the list.
Click Configure to access the configuration of the cor-
responding object. See the description of the corre-
sponding block object.
Write priority If the resource type selected in the Resource Type
field is a commandable object, this field is displayed to
allow you to set the BACnet priority to use when writing
to the BACnet object.
606 EC-gfxProgram
Button
Property Description
Offset Used to assign the inputs for switches.
If the universal wireless switch module has 1 switch, it
must be assigned an offset of B. If the universal wire-
less switch module has 2 switches, offset A and B
should be assigned as shown below.
Figure 372: Wireless Double Switch (typical)
NOTE: C and D are additional offsets that would be
used for a universal wireless switch module
that has 4 switches. Different manufacturers
may specify different offsets. Refer to their doc-
umentation for more details.
Learn The Learn window allows the EnOcean Device block to associate itself with
an EnOcean wireless device. The window will be closed when the EnOcean
Device block receives a valid signal from an EnOcean device (as soon as its
Learn button is pressed) or when it senses a value change (if the device does
not have a Learn button). The window can also be closed by clicking Stop
Learning.
Figure 373: Learn window
EC-gfxProgram 607
Floating Output (ECP Series)
Description Used to interface with a floating actuator connected to the controller’s output.
The controller calculates the time that is needed for the actuator motor to
reach the correct position.
For example, assume that it takes 90 seconds for the actuator to go from fully
closed to fully open, then a 25% demand means that the actuator will be
opened for 25% X 90 = 22.5 seconds. If the actuator is already at 15% and
there is a 25% demand, the controller will calculate that it must move for (25%
- 15%) X 90 = 9 seconds.
NOTE: Be aware that the Position output may not equal the Position input
all the time. If the time calculated to move the position of the actuator
from one point to another is less than the Min pulse on time config-
ured, then the actuator will not move to the new position and thus the
outputted Position will not be the same as the inputted Position.
If there is a demand for 0% or 100%, the calculation will be based on
110% of the drive time to ensure that the actuator reaches the limits.
Number of Maximum 3 Floating Output blocks per controller.
blocks
Advanced Advanced configuration (accessed through the Adding a Floating Pair)
configuration
A floating actuator requires 2 consecutive outputs on the same controller: one
to move the actuator to the closed position and another to move the actuator
to the open position. In the Resource Viewer pane, the actuator Position is
displayed in the first of the two output numbers and the State is displayed in
the second of the two output numbers (0=No Movement, 1=Opening, 2=Clos-
ing).
For example, Hardware Output 1 and 2 are used. The Position value is dis-
played in Hardware Output 1 and the State is displayed in Hardware Output 2.
nviModify can be used to write to the position and states of the blocks by
specifying the internal value type (HW_OUTPUT), the index (Output Number),
the mode (Automatic or Manual), and the value (0 to 100 or 0, 1, or 2).
608 EC-gfxProgram
Input(s)
Port Type Range Description
Position Numeric 0.00 to The position demand for the floating actuator (in
100.00 %).
Output(s)
Port Type Range Description
Position Numeri 0.00 to The actual position of the actuator (in %).
c 100.00
Close Digital 0 or 1 If 1, indicates that the floating actuator is closing. The
amount of close movement is determined by the
Position output.
Open Digital 0 or 1 If 1, indicates that the floating actuator is opening. The
amount of open movement is determined by the
Position output.
PositionMode Digital 0 or 1 0 indicates that the position is in automatic mode and 1
indicates that the position is in manual mode. The
PositionMode is set to automatic/manual mode in the
Resource Viewer, Hardware IOs tab, by clicking Edit
Mode and Value for the Position floating pair output for
the block. See also Manually overriding the damper
position and state.
StateMode Digital 0 or 1 0 indicates that the state is in automatic mode and 1
indicates that the state is in manual mode. The
StateMode is set to automatic/manual mode in the
Resource Viewer, Hardware IOs tab, by clicking Edit
Mode and Value for the State floating pair output for the
block. When changing the State from manual to
automatic, the damper position is first reset to its fully
open or full closed position as set by On init resync. See
also Manually overriding the damper position and state.
Block properties See also Common block properties.
Property Type Range Default Description
Floating Pair Menu See Not Set The floating output pair instance. Click the
Description drop-down arrow to open the Adding a
Floating Pair window, which provides
access to the Advanced configuration
window and lists the floating output pairs.
Adding a The Floating Pair window lists the configured floating output pairs and pro-
Floating Pair vides access to the Advanced configuration window. This window displays the
EC-gfxProgram 609
number and name of the floating pair as well as which output(s) on the con-
troller are used to close and open the floating output. To view this window,
select this block on the Programming Sheet and in the block’s Properties,
click the drop-down arrow for Floating Pair. This block instance will use the
floating output pair selected in this window.
Figure 374: Floating Pair window
Item Description
Delete Selecting deletes the selected floating pair.
Add new floating pair Opens the Advanced Configuration window.
Advanced The Floating Output Configuration window has all the settings required to con-
configuration figure a floating output.
Figure 375: Floating Output Configuration window
Property Description
Close Select the hardware output that is used to move the
actuator to the closed position.
Open Select the hardware output that is used to move the
actuator to the open position.
NOTE: Consecutive hardware outputs must be chosen
for the Close and Open settings.
610 EC-gfxProgram
Property Description
Min pulse on This field defines the minimum amount of time for
which the actuator can move.
Min pulse off This field defines the minimum amount of time that the
actuator does not move between movements.
Drive time This field defines the amount of time it takes for the
actuator to go from being fully closed to fully open or
vice-versa.
On init resync When the device is reset or when the State output is
set to automatic mode from manual, the actuator needs
to be resynchronized. Select whether the output should
be made fully Open or fully Closed on
resynchronization.
Resynchronization drives the output for 110% of the
Drive Time to ensure that the damper is fully reset to its
fully open or fully closed position. Once
resynchronization is complete (110% of the Drive Time
has elapsed), the Floating Output block sets the
damper position according to the Position input
(Automatic mode). See also Manually overriding the
damper position and state.
Manually In the Resource Viewer pane, the actuator Position is displayed in the first of
overriding the the two output Values and the State is displayed in the second of the two out-
damper position put Values (0=No Movement, 1=Opening, 2=Closing).
and state
Figure 376: The position and state outputs of a floating pair block in the
There are two ways to manually override the damper position:
• By manually setting the damper position that the damper actuator is to go
to.
• By manually forcing actuator movement (to open, close, or stay put).
Manually setting Manually override the damper position by clicking Edit Mode and Value for
the damper the Position output in the Hardware IOs tab of the Resource Viewer. Set
position
EC-gfxProgram 611
Manual and an override value (in %) for the damper position. This sets the
PositionMode output of the block to Manual (1).
Figure 377: Edit Mode and Value window
Manually forcing Manually force actuator movement to open, close, or stay put by clicking Edit
actuator Mode and Value for the State output in the Hardware IOs tab of the
movement (ECP Resource Viewer. Set Manual and select one of the following states: Off,
Series Close, or Open. This sets the StateMode output of the block to 1. Movement
controllers) continues until you select Off.
When overriding the State output, the device does not keep track the damper
position. As a result, when changing the State output from manual to auto-
matic, the damper position must be resynchronized. Resynchronization drives
the output for 110% of the Drive Time to ensure that the damper is fully reset
to its fully open or fully closed position (as set by On init resync). Once resyn-
chronization is complete (110% of the Drive Time has elapsed), the Floating
Output block sets the damper position according to the Position input (Auto-
matic mode).
612 EC-gfxProgram
Deleting a Before you delete a Floating Output block, you should first delete the Floating
Floating Output Pair outputs in the Floating Pair Window (see Adding a Floating Pair).
If you delete a Floating Output block without deleting the Floating Pair outputs
first, the controller’s outputs for the floating pair will still be assigned for this
purpose (and those outputs will not be available for other purposes).
Floating Pair outputs can be deleted in the Resource Viewer pane (whether
the outputs are associated to a Floating Pair block or not) as follows:
1. Open the .
2. Select the Hardware IOs tab.
3. Select the first Floating Pair output and click Delete Floating Pair.
NOTE: When importing a project or project code that has more floating pair
outputs than can be supported by the current controller, save your
project to remove these floating pair outputs.
EC-gfxProgram 613
614 EC-gfxProgram
Floating Output (ECL Series)
Description Used to interface with a floating actuator connected to the controller’s output.
The controller calculates the time that is needed for the actuator motor to
reach the correct position.
For example, assume that it takes 90 seconds for the actuator to go from fully
closed to fully open, then a 25% demand means that the actuator will be
opened for 25% X 90 = 22.5 seconds. If the actuator is already at 15% and
there is a 25% demand, the controller will calculate that it must move for (25%
- 15%) X 90 = 9 seconds.
NOTE: Be aware that the Position output may not equal the Position input
all the time. If the time calculated to move the position of the actuator
from one point to another is less than the Min pulse on time config-
ured, then the actuator will not move to the new position and thus the
outputted Position will not be the same as the inputted Position.
If there is a demand for 0% or 100%, the calculation will be based on
110% of the drive time to ensure that the actuator reaches the limits.
A floating actuator requires 2 unused outputs on the same controller or ECx-
400 Series extension module: One to move the actuator to the closed position
and another to move the actuator to the open position.
For example, Hardware Output 1 and 2 are used. The actuator is closed by
Hardware Output 1 and the actuator is opened by Hardware Output 2.
EC-gfxProgram 615
Configuration Once the outputs for this block have been configured, the two hardware out-
type display puts that have been selected in the Resources Configuration window are
shown at the bottom of the block: The number shown after Close refers to the
hardware output number used to move the actuator to the closed position.
The number shown after Open refers to the hardware output number used to
move the actuator to the open position.
Hardware Output Assignment
Number of Depends on the number of hardware outputs available for the current control-
blocks ler model.
Advanced Resources Configuration, Adding a Floating Output (ECL Series), Manually
configuration forcing actuator movement (ECL Series), Deleting a Floating Output, Config-
ure Ports, Show/Hide Ports
Related blocks Generic Floating Output (ECL Series)
Input(s)
Port Type Range Description
Position Numeric 0 to 100 The position demand for the floating actuator (in %).
Output(s)
Port Type Range Description
Position Numeric 0 to 100 The actual position of the actuator (in %).
Number Integer - The current block number.
Close Digital 0 or 1 If 1, indicates that the floating actuator is closing. The
amount of close movement is determined by the
Position output.
Open Digital 0 or 1 If 1, indicates that the floating actuator is opening. The
amount of open movement is determined by the
Position output.
616 EC-gfxProgram
Port Type Range Description
ClosePriority Integer Override The current active priority level in effect to close or
Switch open the actuator:
OpenPriority
Manual • Override Switch (1) = An HOA override switch
Operator has been activated.
Network • Manual Operator (2) = The floating output has
Override been overridden. See Manually forcing actuator
movement (ECP Series controllers).
Program
• Network Override (3) = The floating output has
been overridden through a hardware output NVO.
See Hardware Output configuration for a Floating
Pair.
• Program (4) = Automatic EC-gfxProgram Pro-
gram operation.
Close Override Multi Off For the floating pair’s close output: The HOA switch’s
Switcha State current position. Manual is shown on the controller’s
Auto
Value faceplate as Man.
Manual
Not
available
Close Override Numeric 0 to For the floating pair’s close output: The HOA
Potentiometera 12.5VDC potentiometer’s current position (expressed as a
voltage).
null
Close Effective Digital 0 or 1 For the floating pair’s close output: The actual output
Outputa at the hardware output, which represents the value of
any software generated output or any HOA override
setting, interpreted according to the threshold set in
the Hardware Output configuration for a Floating Pair
(HOA ON/OFF Threshold parameter).
WARNING: When the HOA switch on the controller is
set to the Man position, the potentiometer
has an effective output control range of 0
to 12.5VDC.
Open Override Multi Off For the floating pair’s open output: The HOA switch’s
Switcha State current position. Manual is shown on the controller’s
Auto
Value faceplate as Man.
Manual
Not
available
Open Override Numeric 0 to For the floating pair’s open output: The HOA
Potentiometera 12.5VDCn potentiometer’s current position (expressed as a
ull voltage).
EC-gfxProgram 617
Port Type Range Description
Open Effective Digital 0 or 1 For the floating pair’s open output: The actual output
Outputa at the hardware output, which represents the value of
any software generated output or any HOA override
setting, interpreted according to the threshold set in
the Hardware Output configuration for a Floating Pair
(HOA ON/OFF Threshold parameter).
WARNING: When the HOA switch on the controller is
set to the Man position, the potentiometer
has an effective output control range of 0
to 12.5VDC.
a. Available with HOA-equipped controller outputs – refer to the Hardware
Installation Guide for the controller. HOA outputs provide a direct override at
the controller’s output. Therefore you can drive both outputs of a floating pair
at the same time. Care must be taken to not damage connected equipment
by improperly driving it with two output signals at the same time, for example,
by setting the two outputs of a floating pair to be On at the same time.
Block properties See also Common block properties.
Property Type Range Default Description
Floating Pair Menu See Not Set The floating output pair instance. Click the
Description drop-down arrow to open Manage IO
Modules in the Resources Configuration.
See Adding a Floating Output (ECL
Series).
For controllers with one or more ECx-400
Series Extension Modules connected to it,
a Source column shows on which device
the input is located. This information is
also shown in the block type and number;
see Block objects description.
Adding a Floating Output (ECL Series)
Overview A floating output requires 2 unused hardware outputs located on the same
ECx-400 Series extension module or on the same controller. The following
are ways to add a floating output.
• In the Resources Configuration window’s Resource Tree, create a floating
pair by selecting 2 hardware outputs from the same IO module / controller
and then right-click the selection and select Create Floating Pair or click
in the tool bar. To program a floating output, use the Floating Output
block.
• In the Resources Configuration window’s Resource Tree, right-click the
controller / IO module to which you want to add a floating pair and select
Add Floating Pair. See below.
618 EC-gfxProgram
• Drag a Floating Pair Block from the Toolbox onto the Programming Sheet.
See Figure 380.
Adding a Add a floating output in the Resources Configuration window as follows.
Floating Output
to the Resources 1. In the Resource Tree, right-click the controller / IO module to which you
Configuration want to add a floating pair and select Add Floating Pair. A floating output
is added to the Resource Tree under the controller / IO module.
Figure 378: Resource block instance operations
2. Select the floating output and configure it (see Floating Pair configura-
tion). In Close output and Open output, select the hardware outputs that
are to be used for closing and opening movement.
3. Configure the close and open hardware outputs: Click Show output con-
fig for each output. See Hardware Output configuration for a Floating
Pair.
Figure 379: Resource block instance operations
4. To control a floating output, drop a Floating Output block onto the Pro-
gramming Sheet.
Dragging a When you drop a Floating Output block onto the Programming Sheet, the fol-
Floating Pair lowing popup will appear. Click Yes to continue.
block from the
toolbox Figure 380: Dragging a Floating Pair block from the Toolbox on the programming sheet
EC-gfxProgram 619
Floating Pair Configure a floating output as follows.
configuration
Figure 381: Floating Output configuration window
Parameter Description
Object name The block’s resource name.
Source (for Select the controller or ECx-400 Series Extension
controllers that Module to use for this floating pair output.
support ECx-
400 Series NOTE: Two outputs must be available (currently
Extension unconfigured) on the same controller or on the
Modules) same ECx-400 Series extension module for a
floating output to be successfully configured.
The floating pair Close output and the Open
output cannot be split between a different con-
troller or a different ECx-400 Series extension
module.
Close Output Select the hardware output that is used to move the
actuator to the closed position.
Open Output Select the hardware output that is used to move the
actuator to the open position.
Show output Click to configure the associated hardware output.
config
Min pulse on This field defines the minimum amount of time for
which the actuator can move.
Min pulse off This field defines the minimum amount of time that the
actuator does not move between movements.
620 EC-gfxProgram
Parameter Description
Resync dead When the output is commanded to go to either fully
band open (100%) or fully closed (0%), the output is
commanded longer than necessary (it is overdriven) to
ensure that the actuator is fully open or closed. This is
called resynchronization.This field defines the
minimum amount that output has to go away from
either fully open (100%) or fully closed (0%) before a
resynchronization is performed again. This prevents
signal fluctuations near 0 or 100% from constantly
triggering time-consuming resynchronizations.
Drive time This field defines the amount of time it takes for the
actuator to go from being fully closed to fully open or
vice-versa.
On init resync When the device is reset or when the State output is
set to automatic mode from manual, the actuator needs
to be resynchronized. Select whether the output should
be made fully open or fully closed on
resynchronization. Resynchronization drives the output
for 110% of the Drive Time to ensure that the damper is
fully reset to its fully open or fully closed position. Once
resynchronization is complete (110% of the Drive Time
has elapsed), the Floating Output block sets the
damper position according to the Position input
(Automatic mode). See also Manually forcing actuator
movement (ECL Series).
EC-gfxProgram 621
Hardware Output Configure the two hardware outputs to be used by the floating pair.
configuration for
a Floating Pair Figure 382: Hardware Output configuration for a Floating Pair
Parameter Description
Object name A descriptive name given to the open or close output of
this floating output.
Common The current name used to identify this Network Variable
network name output on the network. See Network Properties
Configuration window (ECL, ECB & ECY Series).
Signal type When an output is associated to a floating pair, the
Signal type is Floating.
Show floating Click to configure the associated floating pair.
pair config
HOA OFF For a close output: when the potentiometer is set below
Threshold this threshold, the block’s CloseEffectiveOutput port
(available with will be False and the close hardware output will no
HOA equipped longer be driven.
outputs only)
For an open output: when the potentiometer is set
below this threshold, the block’s OpenEffectiveOutput
port will be False and the open hardware output will no
longer be driven.
NOTE: Leaving a gap between the HOA ON threshold
and the HOA OFF threshold creates a dead-
band range in which varying the potentiometer
will not affect change in the block’s output.
622 EC-gfxProgram
Parameter Description
HOA ON For a close output: when the potentiometer is set
Threshold above this threshold, the block’s
(available with CloseEffectiveOutput port will be True and the close
HOA equipped hardware output will be driven.
outputs only)
For an open output: when the potentiometer is set
above this threshold, the block’s
OpenEffectiveOutput port will be True and the open
hardware output will be driven.
LONMARK The network variable name following this title is the
Properties name of the network variable used for displaying the
actual value on the LONWORKS network. See ECL
Series network properties.
Manually forcing actuator movement (ECL Series)
In the Resource Viewer pane, when movement is overridden (Mode is Man-
ual), the actuator movement is displayed in Present Value which shows the
current output status (0=No Movement, 1=Movement) for each floating pair
output shown under Type (Floating / Close and Floating / Open).
Figure 383: Floating Pair block Hardware IOs shown in the
Manually force actuator movement by right-clicking either the Floating /
Close or Floating / Open output in the Resource Viewer and selecting Over-
ride. Set the value to 0 (No Movement) or 1 (Movement). Only one Floating /
Close or Floating / Open output should be set to 1 (Movement) at a time oth-
erwise equipment damage may result: Always override both Floating / Close
or Floating / Open outputs to 0 before overriding either one to 1.
Return the floating pair to automatic operation (to software control) by right-
clicking the Floating / Close output in the and selecting Auto and then by
right-clicking the Floating / Open output in the and selecting Auto.
When overriding the output, the device does not keep track the damper posi-
tion. As a result, when changing the State output from manual to automatic
operation, the damper position must be resynchronized. Resynchronization
drives the output for 110% of the Drive Time to ensure that the equipment is
fully reset to its fully open or fully closed position (as set by On init resync).
Once resynchronization is complete (110% of the Drive Time has elapsed),
the Floating Output block sets the equipment position according to the Posi-
tion input (Automatic mode).
EC-gfxProgram 623
Deleting a Floating Output
Before you delete a Floating Output block, you should first delete the Floating
Pair resources. If you delete a Floating Output block without deleting the
Floating Pair outputs first, the controller’s outputs for the floating pair will still
be assigned for this purpose (and those outputs will not be available for other
purposes).
The following are ways to delete the resources for a Floating Pair.
• In the Resources Configuration, right-click the Floating Pair in the
Resource Tree and select Delete.
Figure 384: Deleting a Floating Pair
• Select the Floating Output block on the Programming Sheet and in the
block’s Properties, click the drop-down arrow for Floating Pair. Select the
floating pair and click .
Figure 385: Floating Pair window
NOTE: When importing a project code that has more floating pair outputs than
can be supported by the current controller, save your project to
remove these floating pair outputs.
624 EC-gfxProgram
Floating Output (ECB & ECY Series)
Description Used to interface with a floating actuator connected to the controller’s output.
The controller calculates the time that is needed for the actuator motor to
reach the correct position.
For example, assume that it takes 90 seconds for the actuator to go from fully
closed to fully open, then a 25% demand means that the actuator will be
opened for 25% X 90 = 22.5 seconds. If the actuator is already at 15% and
there is a 25% demand, the controller will calculate that it must move for (25%
- 15%) X 90 = 9 seconds.
NOTE: Be aware that the Position output may not equal the Position input
all the time. If the time calculated to move the position of the actuator
from one point to another is less than the Min pulse on time config-
ured, then the actuator will not move to the new position and thus the
outputted Position will not be the same as the inputted Position.
If there is a demand for 0% or 100%, the calculation will be based on
110% of the drive time to ensure that the actuator reaches the limits.
A floating actuator requires 2 unused outputs on the same controller, ECY-IO
Series, or ECx-400 Series extension module: One to move the actuator to the
closed position and another to move the actuator to the open position.
For example, Hardware Output 1 and 2 are used. The actuator is closed by
Hardware Output 1 and the actuator is opened by Hardware Output 2.
EC-gfxProgram 625
Configuration Once the outputs for this block have been configured, the two hardware out-
type display puts that have been selected in the Resources Configuration window are
shown at the bottom of the block: The number shown after Close refers to the
hardware output number used to move the actuator to the closed position.
The number shown after Open refers to the hardware output number used to
move the actuator to the open position.
Hardware Output Assignment
Number of Depends on the number of hardware outputs available for the current control-
blocks ler model.
Advanced Resources Configuration, Adding a Floating Output (ECB & ECY Series),
configuration Manually forcing actuator movement, Deleting a Floating Output (ECB Series
Controllers), BACnet network properties, Configure Ports, Show/Hide Ports
Related blocks Generic Floating Output (ECB & ECY Series)
input(s)
Port Type Range Description
Position Numeric 0 to 100 The position demand for the floating actuator (in %).
Priority Integer 1 to 16 The value at the Input is written at the priority level
specified at this input. If a value is not linked to this
input, the value at the Input is written into the default
priority level. See Commandable object priority array
levels.
Output(s)
Port Type Range Description
Position Numeric 0 to 100 The actual position of the actuator (in %).
Number Integer - The current block number.
Close Digital 0 or 1 If 1, indicates that the floating actuator is closing.
The amount of close movement is determined by the
Position output.
626 EC-gfxProgram
Port Type Range Description
Open Digital 0 or 1 If 1, indicates that the floating actuator is opening.
The amount of open movement is determined by the
Position output.
ClosePriority Integer 1 to 16 The current active priority level in effect to close the
actuator. See Commandable object priority array
levels.
OpenPriority Integer 1 to 16 The current active priority level in effect to open the
actuator. See Commandable object priority array
levels.
Close Override Multi State Off For the floating pair’s close output: The HOA
Switcha Value switch’s current position. Manual is shown on the
Auto
controller’s faceplate as Man.
Manual
Not
available
Close Override Numeric 0 to For the floating pair’s close output: The HOA
Potentiometera 12.5VDC potentiometer’s current position (expressed as a
voltage).
Close Effective Numeric 0 to For the floating pair’s close output: The actual output
Outputa 12500% at the hardware output, which represents the value
of any software generated output or any HOA
override setting, interpreted according to the
threshold set in the Hardware Output configuration
for a Floating Pair (HOA ON/OFF Threshold
parameter).
NOTE: When the HOA switch on the controller is set
to the Man position, the potentiometer has
an effective output control range of 0 to
12.5VDC.
Open Override Multi State Off For the floating pair’s open output: The HOA
Switcha Value switch’s current position. Manual is shown on the
Auto
controller’s faceplate as Man.
Manual
Not
available
Open Override Numeric 0 to For the floating pair’s open output: The HOA
Potentiometera 12.5VDC potentiometer’s current position (expressed as a
voltage).
EC-gfxProgram 627
Port Type Range Description
Open Effective Numeric 0 to For the floating pair’s open output: The actual output
Outputa 12500% at the hardware output, which represents the value
of any software generated output or any HOA
override setting, interpreted according to the
threshold set in the Hardware Output configuration
for a Floating Pair (HOA ON/OFF Threshold
parameter).
WARNING: When the HOA switch on the controller
is set to the Man position, the potenti-
ometer has an effective output control
range of 0 to 12.5VDC.
a. Available with HOA-equipped controller outputs – refer to the Hardware
Installation Guide for the controller. HOA outputs provide a direct override at
the controller’s output. Therefore you can drive both outputs of a floating pair
at the same time. Care must be taken to not damage connected equipment
by improperly driving it with two output signals at the same time, for example,
by setting the two outputs of a floating pair to be On at the same time.
Block properties See also Common block properties.
Property Type Range Default Description
Floating Pair Menu See Not Set The floating output pair instance. Click
Description the drop-down arrow to open Manage
IO Modules in the Resources
Configuration. See Adding a Floating
Output (ECB & ECY Series).
For controllers with one or more ECY-IO
Series or ECY-IO Series or ECx-400
Series Extension Modules connected to
it, a Source / Module column shows on
which device the input is located. This
information is also shown in the block
type and number; see Block objects
description.
Adding a Floating Output (ECB & ECY Series)
Overview To add a floating output, the ECY-IO Series or any ECx-400 Series extension
module(s) must have been first added to the Resources Configuration window
(if necessary see Adding a Hardware IO extension module (ECY Series)). A
floating output requires 2 unused hardware outputs located on the same ECY-
IO Series extension module, on the same ECx-400 Series extension module,
or on the same controller. The following are ways to add a floating output.
• In the Resources Configuration window’s Resource Tree, create a floating
pair selecting 2 hardware outputs from the same controller / IO module
and then right-click the selection and select Create Floating Pair or click
628 EC-gfxProgram
in the tool bar. To program a floating output, use the Floating Output
block.
• In the Resources Configuration window’s Resource Tree, right-click the
controller / IO module to which you want to add a floating pair and select
Add Floating Pair. See below.
• Drag a Floating Pair Block from the Toolbox onto the Programming Sheet.
Adding a Add a floating output in the Resources Configuration window as follows.
Floating Output
to the Resources 1. In the Resource Tree, right-click the controller / IO module to which you
Configuration want to add a floating pair and select Add Floating Pair. A floating output
is added to the Resource Tree under the controller / IO module.
Figure 386: Resource block instance operation
2. Select the floating output and configure it. In Close output and Open
output, select the hardware outputs that are to be used for closing and
opening movement.
3. Configure the close and open hardware outputs: Click Show output con-
fig for each output. See Hardware Output configuration for a Floating
Pair.
Figure 387: Resource block instance operations
4. To program a floating output, use the Floating Output block.
Dragging a When you drop a Floating Output block onto the Programming Sheet, the fol-
Floating Pair lowing popup will appear. Click Yes to continue.
block from the
Toolbox Figure 388: Dragging a Floating Pair block from the Toolbox on the programing sheet
EC-gfxProgram 629
Floating Pair Configure a floating output as follows.
configuration
Figure 389: Floating Output configuration window
Parameter Description
Object name The block’s resource name.
Description An optional description for this object.
Source (for Select the controller, ECY-IO Series, or ECx-400 Series
controllers that Extension Module to use for this floating pair output.
support ECY-IO
Series or ECx- NOTE: Two outputs must be available (currently
400 Series unconfigured) on the same ECY-IO Series
Extension extension module, on the same ECx-400
Modules) Series extension module, or on the same con-
troller for a floating output to be successfully
configured. The floating pair Close output and
the Open output cannot be split between a dif-
ferent controller, a different ECY-IO Series
extension module, or a different ECx-400
Series extension module.
Close Output Select the hardware output that is used to move the
actuator to the closed position.
Open Output Select the hardware output that is used to move the
actuator to the open position.
Show output Click to configure the associated hardware output.
config
Min pulse on This field defines the minimum amount of time for
which the actuator can move.
Min pulse off This field defines the minimum amount of time that the
actuator does not move between movements.
630 EC-gfxProgram
Parameter Description
Resync dead When the output is commanded to go to either fully
band open (100%) or fully closed (0%), the output is
commanded longer than necessary (it is overdriven) to
ensure that the actuator is fully open or closed. This is
called resynchronization.
This field defines the minimum amount that output has
to go away from either fully open (100%) or fully closed
(0%) before a resynchronization is performed again.
This prevents signal fluctuations near 0 or 100% from
constantly triggering time-consuming
resynchronizations.
Drive time This field defines the amount of time it takes for the
actuator to go from being fully closed to fully open or
vice-versa.
On init resync When the device is reset or when the State output is
set to automatic mode from manual, the actuator needs
to be resynchronized. Select whether the output should
be made fully open or fully closed on
resynchronization.
Resynchronization drives the output for 110% of the
Drive Time to ensure that the damper is fully reset to its
fully open or fully closed position. Once
resynchronization is complete (110% of the Drive Time
has elapsed), the Floating Output block sets the
damper position according to the Position input
(Automatic mode). See also Manually forcing actuator
movement (ECL Series).
EC-gfxProgram 631
Hardware Output Configure the two hardware outputs to be used by the floating pair.
configuration for
a Floating Pair Figure 390: Hardware Output configuration for a Floating Pair
Parameter Description
Object name A descriptive name given to the open or close output of
this floating output.
Description An optional description for this object.
BACnet The BACnet Properties for this object. See BACnet
Properties network properties.
Signal type When an output is associated to a floating pair, the
Signal type is Floating.
Show floating Click to configure the associated floating pair.
pair config
632 EC-gfxProgram
Parameter Description
Metadata This allows you to add the current controller resource
into the ENVYSION Data Tree. The same resource can
be added to more than one place in the ENVYSION
Data Tree. See Adding resources to the ENVYSION
Data Tree and ENVYSION Data Tree (ECY Series).
HOA OFF For a close output: when the potentiometer is set below
Threshold this threshold, the block’s CloseEffectiveOutput port
(available with will be False and the close hardware output will no
HOA equipped longer be driven.
outputs only)
For an open output: when the potentiometer is set
below this threshold, the block’s OpenEffectiveOutput
port will be False and the open hardware output will no
longer be driven.
NOTE: Leaving a gap between the HOA ON threshold
and the HOA OFF threshold creates a dead-
band range in which varying the potentiometer
will not affect change in the block’s output.
HOA ON For a close output: when the potentiometer is set
Threshold above this threshold, the block’s
(available with CloseEffectiveOutput port will be True and the close
HOA equipped hardware output will be driven.
outputs only)
For an open output: when the potentiometer is set
above this threshold, the block’s
OpenEffectiveOutput port will be True and the open
hardware output will be driven.
Alarm This sets the alarm configuration that will trigger the
dispatch of a notification message to other BACnet
devices. See Alarms (ECB & ECY Series).
Trending (ECY This configures the BACnet trend log object for the
Series related resource. See Trending (ECY Series).
controllers only)
EC-gfxProgram 633
Manually forcing actuator movement
The Floating Output block has commandable outputs (see Commandable
object priority array levels). The current active priority level in effect is avail-
able at the Floating Output block’s ClosePriority and OpenPriority output
ports.
In the Resource Viewer, manually force actuator movement by right-clicking
either the Floating / Close or Floating / Open output in the and selecting
Override. Set the value to False (No Movement), True (Movement) or Null
(release overrride). Only one Floating / Close or Floating / Open output
should be set to True (Movement) at a time otherwise equipment damage
may result: Always override both Floating / Close or Floating / Open outputs
to False before overriding either one to True.
Figure 391: Floating Pair block shown in the
Return the floating pair to automatic operation (to software control) as follows.
1. Right-click the Floating / Close output in the and select Auto.
2. Right-click the Floating / Open output in the and select Auto.
634 EC-gfxProgram
When overriding the output, the device does not keep track the damper posi-
tion. As a result, when changing the State output from manual to automatic
operation, the damper position must be resynchronized. Resynchronization
drives the output for 110% of the Drive Time to ensure that the damper is fully
reset to its fully open or fully closed position (as set by On init resync). Once
resynchronization is complete (110% of the Drive Time has elapsed), the
Floating Output block sets the damper position according to the Position
input (Automatic mode).
Deleting a Floating Output (ECB Series Controllers)
Before you delete a Floating Output block, you should first delete the Floating
Pair resources. If you delete a Floating Output block without deleting the
Floating Pair outputs first, the controller’s outputs for the floating pair will still
be assigned for this purpose (and those outputs will not be available for other
purposes).
The following are ways to delete the resources for a Floating Pair.
• In the Resources Configuration, right-click the Floating Pair in the
Resource Tree and select Delete.
Figure 392: Deleting a Floating Pair
• Select the Floating Output block on the Programming Sheet and in the
block’s Properties, click the drop-down arrow for Floating Pair. Select the
floating pair and click .
Figure 393: Floating Pair window
EC-gfxProgram 635
• Floating Pair outputs can be deleted in the Resource Viewer pane
(whether the outputs are associated to a Floating Pair block or not) as fol-
lows:
1. Open the .
2. Select the Hardware IOs tab.
3. Select the first Floating Pair output and click Delete Floating Pair.
NOTE: When importing a project code that has more floating pair outputs than
can be supported by the current controller, save your project to
remove these floating pair outputs.
Hardware Input (ECP Series)
Description Used to interface with a hardware input. Each Hardware Input block is linked
to a corresponding nvoFP_xx (xx = input number), which follows the same
value as the Hardware Input block. However, this link is broken if a Network
Variable Output block with the same block number is used in the code, in
which case the nvoFP_xx follows the same value as the Network Variable
Output block. The user can read the values and modes of the Hardware Input
blocks directly through nvoHwIx_x (x=input number). nviModify can be used
to write to the values and modes of the blocks by specifying the internal value
type (HW_INPUT), the index (Block Number), the mode (Automatic or Man-
ual), and the value (-83886.08 to 83886.07).
Configuration The configuration type that has been selected in the Advanced Configuration
Type display window is shown at the bottom of the block as shown below.
Configuration Type
Number of Depends on the number of hardware inputs available for the current controller
blocks model.
Advanced Advanced configuration, Edit Mode and Value (ECP Series), Copy From,
configuration Configure Ports, Show/Hide Ports
636 EC-gfxProgram
Input(s)
Port Type Range Description
ClrPulse Digital 0 or 1 For inputs configured for pulse counting, set this input
to True (1) to clear the pulse count.
Output(s)
Port Type Range Description
Output Digital 0 or 1 Block output. Whether the block will output a digital
value or a numeric value is dependent on what type of
Numeric -83886.08 to Signal interpretation is selected in the block’s
83886.07 Advanced configuration window.
NOTE: For numeric inputs, if there is an open circuit,
the output is 83886.07. If there is a short circuit,
the output is -83886.08.
If a STD_THERMISTOR Signal interpretation
is selected, then a change in the measurement
system of the project results in the output value
being converted. If any other Signal interpre-
tation is selected, then a change in the mea-
surement system of the project results in no
change to the output value, that is, no conver-
sion is made.
Mode Digital 0 or 1 Mode of the input:
0 = Automatic
1 = Manual
Override Digital 0 or 1 When the Use override option is selected in the
Advanced configuration window, this port becomes
available: A shorted input is interpreted as an override
(Bypass) signal.
NOTE: This feature is not available with a PT100
thermistor.
ElectAlm Digital 0 or 1 Electrical fault alarm status.
EC-gfxProgram 637
Block properties See also Common block properties.
Property Type Range Default Description
Number Menu See Hardware Use this drop-down menu to select a
Description Input 1 physical electrical input on this controller.
This drop-down menu shows the total
number of block instances that are available
for the current controller model.
NOTE: When a new block instance is added
to the Programming Sheet, the
block’s number is incremented to
the next available block number
according to the current Auto Incre-
ment setting. See Auto increment
(ECP & ECL Series and EBC Series
controllers only).
Advanced configuration
Configuration parameters for this block are set in the Resources Configura-
tion window to configure any type of hardware input including sensors,
switches, contacts, etc. Depending on the Signal interpretation selected, the
options available under Settings will vary.
DISCONNECTED
The hardware input is not used.
Figure 394: Hardware Input Configuration window - Disconnected
638 EC-gfxProgram
LINEAR
A linear curve is used to interpret a voltage (0 to 10V), current (4 to 20mA) or
resistance (0 to 10kΩ) input signal.
Figure 395: Hardware Input Configuration window - Linear
Parameter Description
Signal type This parameter determines the input signal type of the
connected sensor. When supported by the current
controller model, the following signal types are
available:
RESISTANCE: Resistance input, typically 0 to 10kΩ
VOLTAGE_0_10V: Voltage input, 0 to 10V
MILLIAMPS_4_20MA: Current input, 4 to 20mA (DC)
NOTE: If the input value falls out of the expected input
range, it is interpreted as the lower or upper
value of the range.
For example, if the input is 3.5mA, then it will be
rounded up to 4mA and if the input is 21mA,
then it will be clipped at 20mA.
WARNING: Exceeding the upper limits for current and
voltage may damage the controller.
For resistance inputs (0 to 10kΩ), if disconnected (+inf
Ω) it will cause an electrical fault.
For voltage inputs (0 to 10V), if left disconnected, this
will cause erratic readings as it will convert random
ambient electrical noise present at the input terminal.
For current inputs (4 to 20mA), any input below 3.5mA
will cause an electrical fault.
EC-gfxProgram 639
Parameter Description
Offset The offset is a constant value that is applied to the
sensor input reading to compensate for reading errors,
that is, to perform sensor calibration.
For example, assume that a temperature sensor is
connected to one of the hardware inputs. If the actual
room temperature is 72ºF but the sensor reading is
74ºF, an offset of -2ºF can be applied to correct the
error.
Input min The Input min is used to correlate with the Min value to
create the lower point of the linear interpolation curve
that is used to interpret the raw input reading.
Input max The Input max is used to correlate with the Max value
to create the higher point of the linear interpolation
curve that is used to interpret the raw input reading.
Min value The Min value is used to correlate with the Input min to
create the lower point of the linear interpolation curve
that is used to interpret the raw input reading.
Max value The Max value is used to correlate with the Input max
to create the higher point of the linear interpolation
curve that is used to interpret the raw input reading.
For example, if there is a resistance input (0 to 10kΩ)
and an Input min of 2kΩ, an Input max of 8kΩ, a Min
value of 60ºF and a Max value of 80ºF are set, then
2kΩ will correspond to 60ºF and 8kΩ will correspond to
80ºF.
Use filter When selected, the input signal will be filtered from any
low-frequency noise or distortion caused by, for
example, the input wires running too close to an
electrical source or flow sensor air turbulence.
640 EC-gfxProgram
TRANS_TABLE
A translation table is applied to the input. A user-defined curve can be setup
to interpret the input signal in the Translation Table Configuration window. A
curve is generated based on the points defined and is interpolated linearly.
Figure 396: Hardware Input Configuration window - Translation Table
Parameter Description
Signal type This parameter determines the input signal type of the
connected sensor. When supported by the current
controller model, the following signal types are
available:
RESISTANCE: Resistance input, typically 0 to 10kΩ
VOLTAGE_0_10V: Voltage input, 0 to 10V
MILLIAMPS_4_20MA: Current input, 4 to 20mA (DC)
WARNING: Exceeding the upper limits for current and
voltage may damage the controller.
For current inputs (4 to 20mA), any input below 3.5mA
will cause an electrical fault.
For resistance inputs (0 to 10kΩ), if disconnected (+inf
Ω) it will cause an electrical fault.
Offset The offset is a constant value that is applied to the
sensor input reading to compensate for reading errors,
that is, to perform sensor calibration.
For example, assume that a temperature sensor is
connected to one of the hardware inputs. If the actual
room temperature is 72ºF but the sensor reading is
74ºF, an offset of -2ºF can be applied to correct the
error.
Trans Table This button opens the Translation Table Configuration
window.
Use filter When selected, the input signal will be filtered from any
low-frequency noise or distortion caused by, for
example, the input wires running too close to an
electrical source.
EC-gfxProgram 641
Translation Table The translation table consists of 16 rows used to define a curve that converts
configuration the raw input value (mA, V, Ω) into the appropriate units of measurement (for
example, ºF). The curve is interpolated linearly based on the values entered.
It is not necessary to fill out all the rows since a linear curve will be generated
automatically between each pair of points and interpolated/extrapolated as
required.
NOTE: The values in the Input value column must be in ascending order,
otherwise the conversion will be incorrect.
642 EC-gfxProgram
Example: The following example illustrates how a translation table can translate a
Temperatutre thermistor’s resistance values into temperature values. The following graph
translation and window display the data points that have been used.
Figure 397: Graph of temperature translation
Figure 398: Translation Table Configuration window
Parameter Description
Input Value (mA, The raw hardware input reading. Must be in ascending
V or Ω) order.
Output Value The converted input value.
EC-gfxProgram 643
DIGITAL
Figure 399: Hardware Input Configuration window - Digital
Parameter Description
Signal type This parameter determines the input signal type of the
connected sensor. The following signal type is
supported:
RESISTANCE: Resistance input, typically 0 to 10kΩ
For resistance inputs (0 to 10kΩ), if disconnected (+inf
Ω) it will cause an electrical fault.
Normal digital A normal digital two-state (On/Off) input such as a light
input switch, occupancy contact, window contact, etc.
ON Value The value of the block when the input is On.
OFF Value The value of the block when the input is Off.
Reverse The input is normally On when the contact is closed
and Off when it is open. When the reverse option is
selected, the input is On when the contact is open and
Off when it is closed.
644 EC-gfxProgram
Parameter Description
Pulse count A pulse count input is comprised of a Rising
input increment and a Falling increment. Therefore the
value of a pulse count input is equal to the summation
Rising increment
of all pulse cycles and is based on the following
Falling equation:
increment
Pulse count input value = (number of rising edges
multiplied by the value of Rising increment) plus
(number of falling edges multiplied by the value of
Falling increment).
For example, a pulse count input has been configured
with a Rising increment value of 5 and a Falling
increment value of 0. After four pulse cycles the value
of the input will be as follows (as based on the equation
above): (4 x 5) + (4 x 0) = 20
Figure 400: Pulse Count Input Example
EC-gfxProgram 645
MULTI_LEVEL
A translation table is applied to the input. A user-defined function can be setup
to interpret the signal in the Multi-Level Table Configuration window. A step
function is generated based on the points defined.
Figure 401: Hardware Input Configuration window - Multi Level
Parameter Description
Signal type This parameter determines the input signal type of the
connected sensor. When supported by the current
controller model, the following signal types are
available:
RESISTANCE: Resistance input, typically 0 to 10kΩ
VOLTAGE_0_10V: Voltage input, 0 to 10V
MILLIAMPS_4_20MA: Current input, 4 to 20mA (DC)
WARNING: Exceeding the upper limits for current and
voltage may damage the controller.
For current inputs (4 to 20mA), any input below 3.5mA
will cause an electrical fault.
For resistance inputs (0 to 10kΩ), if disconnected (+inf
Ω) it will cause an electrical fault.
Trans Table This button opens the Multi-Level Table Configuration
window.
Multi-Level Table The multi-level table consists of 16 rows used to define a function that con-
configuration verts the raw input value (mA, V, Ω) into the appropriate level. The function is
interpolated based on the values entered. It is not necessary to fill out all the
rows since a step function will automatically be generated between each pair
of points and interpolated/extrapolated as required.
NOTE: The values in the Input Value column must be in ascending order,
otherwise the conversion will be incorrect.
646 EC-gfxProgram
Example: HVAC The following example illustrates how a multi-level table can assign a potenti-
mode ometer’s resistance values to a corresponding level. Each level corresponds
to a particular HVAC mode as follows: -1 = HVAC_NUL, 0 = HVAC_AUTO, 1 =
HVAC_HEAT, 3 = HVAC_COOL, 6 = HVAC_OFF. The following graph and
window display the data points that have been used.
Figure 402: Graph of HVAC Mode translation
Figure 403: Multi-Level Table Configuration window
Parameter Description
Input Value (mA, The raw hardware input reading. Must be in ascending
V or Ω) order.
Output Value The converted input value.
EC-gfxProgram 647
STD_THERMISTOR
Predefined translation tables that apply to the standard type thermistors that
are used within sensors.
Figure 404: Hardware Input Configuration window - Standard Thermistor
Parameter. Description
Signal type This parameter determines the input signal type of the
connected sensor. The following signal type is
supported:
RESISTANCE: Resistance input, typically 0 to 10kΩ
For resistance inputs (0 to 10kΩ), if disconnected (+inf
Ω) for more than 10 seconds, it will cause an electrical
fault.
Offset The offset is a constant value that is applied to the
sensor input reading to compensate for reading errors,
for example, to perform sensor calibration.
For example, assume that a temperature sensor is
connected to one of the hardware inputs. If the actual
room temperature is 72ºF but the sensor reading is
74ºF, an offset of -2ºF can be applied to correct the
error.
Min value The Min value is used to establish the low limit of the
input reading.
Max value The Max value is used to establish the high limit of the
input reading.
For example, if a Min value and Max value are set,
then the predefined translation table is cut off at those
values. So if a Min value of 32ºF and a Max value of
122ºF are set, then the input value will never pass
these limits even if the sensed value reads values
higher or lower than the maximum or minimum value
respectively.
648 EC-gfxProgram
Parameter. Description
Thermistor type This parameter determines the thermistor type being
used.
The following thermistor types are supported: PT100,
PT1000, NI1000, 10K Type II and 10K Type III. See
Thermistor Resistance Tables.
Use filter When selected, the input signal will be filtered from any
low-frequency noise or distortion caused by, for
example, the input wires running too close to an
electrical source.
SETPOINT_OFFSET
An offset input (±) that is applied to the heating and cooling setpoints.
Figure 405: Hardware Input Configuration window - Setpoint Offset
Parameter Description
Signal type This parameter determines the input signal type of the
connected sensor. The following signal type is
supported:
RESISTANCE: Resistance input, typically 0 to 10kΩ
NOTE: If the input value falls out of the expected input
range, it is interpreted as the lower or upper
value of the range.
For example, if the input is 11kΩ, then it will be clipped
at 10kΩ.
For resistance inputs (0 to 10kΩ), if disconnected (+inf
Ω) it will cause an electrical fault.
EC-gfxProgram 649
Parameter Description
Input min The Input min is used to correlate with the Min value
to create the lower point of the linear interpolation
curve that is used to interpret the input reading.
Input max The Input max is used to correlate with the Max value
to create the higher point of the linear interpolation
curve that is used to interpret the input reading.
Min value The Min value is used to correlate with the Input min
to create the lower point of the linear interpolation
curve that is used to interpret the input reading.
Max value The Max value is used to correlate with the Input max
to create the higher point of the linear interpolation
curve that is used to interpret the input reading.
For example, if there is a resistance input (0 to 10kΩ)
and an Input min of 2kΩ, an Input max of 8kΩ, a Min
value of -10ºF and a Max value of 10ºF are set, then
2kΩ will correspond to -10ºF and 8kΩ will correspond
to 10ºF.
Hardware Input (ECL Series)
Description Used to interface with a hardware input. The value of each of these blocks is
available through network variables; see Controlling a Hardware Input
through a Structured Network Variable.
Configuration The configuration type that has been selected in the Advanced configuration
Type display window is shown at the bottom of the block as shown below.
Configuration Type
650 EC-gfxProgram
Slim format This block can be collapsed into a slim format. See Collapsed in Common
support block properties.
Advanced Resources Configuration, Advanced configuration, Change Type (ECP & ECL
configuration Series), Find All References (ECL, ECB & ECY Series), Copy From, Config-
ure Ports, Show/Hide Ports, Controlling a Hardware Input through a Struc-
tured Network Variable, LONWORKS properties, Creating and using
enumerations (ECL Series)
Related blocks Generic Hardware Input (ECL Series)
Input(s)
Port Type Range Description
ClrPulse Digital 0 or 1 For inputs configured for pulse counting, set this
input to True (1) to clear the pulse count.
Output(s)
Port Type Range Description
Output Digital 0 or 1 Block output. Whether the block will output a digital
value or a numeric value is dependent on what type
Numeric ±3.4028 of Signal interpretation is selected in the block’s
×1038 Advanced configuration window.
Number Integer – The block number. For controllers with one or more
ECx-400 Series Extension Modules connected to it,
a number from 1 to 16 means the input is on the
controller. A number from 101 to 112 means the
output is on ECx-400 Series Extension Module 1. A
number from 201 to 212 means the output is on
ECx-400 Series Extension Module 2.
Override Digital 0 or 1 When the Use override option is selected in the
Advanced configuration window, this port becomes
available: A shorted input is interpreted as an
override (Bypass) signal. The Override output only
emits a pulse, thus if it is required to stay on for an
extended period of time, a Min On Time or Latch
block should be utilized.
OutOfService Digital 0 or 1 When an override has been set (see Override and
auto), this is logically True (1). When the block is set
to auto, this is logically False (0). See Out-of-
Service.
EC-gfxProgram 651
Port Type Range Description
Fault Digital 0 or 1 When either the Check out of range or the Check
signal fault in the Advanced Configuration is set
(or both are set), this is logically True (1) if the
Reliability property does not have a value of No
Fault Detected, otherwise logical False (0).
Reliability Enum See When either the Check out of range or the Check
Description signal fault in the Advanced Configuration is set
(or both are set), this provides an indication of
whether the physical input is "reliable" and, if not,
why. See Reliability property.
Block properties See also Common Block Properties.
Property Type Range Default Description
Number Menu See Hardware Use this drop-down menu to select a
Description Input 1 physical electrical input on this
controller. The number of Hardware
Input block instances supported by a
controller is shown in this drop-down
list or in the Statistics pane.
For controllers with one or more ECx-
400 Series Extension Module
connected to it, a Source column
shows on which device the input is
located. This information is also
shown in the block type and number;
see Block objects description.
NOTE: When a new block instance is
added to the programming
sheet, the block’s number is
incremented to the next avail-
able block number according
to the current Auto Increment
setting. See Auto increment
(ECP & ECL Series and EBC
Series controllers only).
Advanced configuration
Configuration parameters for this block are set in the Resources Configura-
tion window to configure any type of hardware input including sensors,
switches, contacts, etc.
NOTE: Certain models of controllers only support a limited number of input
types, that may vary according to the specific hardware input being
configured. See your controller’s datasheet for more information as to
652 EC-gfxProgram
the output types supported by the controller. In all cases, the Signal
interpretation drop-down list (shown below) reflects the available
configuration options and output types supported by a controller’s
hardware input. Refer to the controller’s Hardware Installation Guide
for more details.
Configure this block as follows:
• Hardware Input and Output numbering scheme
• Configuring the Input Signal Type (ECL Series))
Hardware Input and Output numbering scheme
For ECL Series controllers that support extension modules, the hardware
inputs and outputs are numbered in the Resource Tree according to the
extension module’s MAC address setting.
Figure 406: Hardware Input and Output numbering scheme for ECL Series controller
extension modules
HO 202
The number of the ECx-400 Series Extension
module Input or Output port, as labeled on the
controller’s faceplate. For example, this refers to
hardware output #2. See the ECx-400 Series
Extension module’s hardware installation guide.
The extension module’s MAC address setting.
For example, this refers to the ECx-400 Series
Extension module with its MAC address set to 2.
Configuring the Input Signal Type (ECL Series)
General Configuration
Set the hardware input’s name and the network variable properties. See ECL
Series network properties.
EC-gfxProgram 653
Disconnected
The hardware input is not used.
Figure 407: Hardware Input Configuration window - Disconnected
Linear
A linear curve is used to interpret a voltage (0 to 10V, 0 to 5V), current (0 to
20mA), or resistance (0 to 350kΩ) input signal.
Figure 408: Hardware Input Configuration window - Linear
654 EC-gfxProgram
Parameter Description
Signal Type This parameter determines the input signal type of the
connected sensor. When supported by the current
controller model, the following signal types are
available:
RESISTANCE: Resistance input, typically 0 to 350kΩ.
VOLTAGE 0 - 10V: Voltage input, 0 to 10V.
MILLIAMPS 0 - 20mA: Current input, 0 to 20mA (DC).
VOLTAGE 0 - 5V: Voltage input, 0 to 5V.
NOTE: If the input value falls out of the expected input
range, it is interpreted as the lower or upper
value of the range.
For example, if a current input is 21mA, then it will be
clipped at 20mA.
WARNING: Exceeding the upper limits for current and
voltage may damage the controller.
Signal This sets the raw input signal range (set by the
Configuration – Minimum and Maximum parameters).
Signal
Minimum: Is used to correlate with the Minimum
Output value to create the lower point of the linear
interpolation curve that is used to interpret the raw
input reading.
Maximum: Is used to correlate with the Maximum
Output value to create the higher point of the linear
interpolation curve that is used to interpret the raw
input reading.
EC-gfxProgram 655
Parameter Description
Signal This linearly scales the input signal (as set by the
Configuration – Signal Minimum and Maximum parameters) to a new
Output range set by the Output Minimum and Maximum
parameters.
Minimum: Is used to correlate with the Signal
Minimum to create the lower point of the linear
interpolation curve that is used to interpret the raw
input reading.
Maximum: Is used to correlate with the Signal
Maximum to create the higher point of the linear
interpolation curve that is used to interpret the raw
input reading.
For example, if there is a resistance input (0 to 10kΩ)
and an Minimum Signal of 2kΩ, an Maximum signal
of 8kΩ, a Minimum Output value of 60ºF and a
Maximum Output value of 80ºF are set, then 2kΩ will
correspond to 60ºF and 8kΩ will correspond to 80ºF.
Figure 409: Setting the signal input range
Default Value When the Check signal fault is set, and the
Reliability output is either Open Loop or Shorted
Loop (see Reliability property), this becomes the
block’s output value.
Check out of When set, this enables the block’s Reliability and
range Fault outputs to report the out of range enumeration.
The values are based on these calculated by the
Signal Configuration – Output configuration. See
Table 17.
See Reliability property for a complete list of reliability
enumerations.
Check signal When set, this enables the block’s Reliability and
fault Fault outputs to report the signal fault status. Values
are based on the raw input signal. See Table 18.
Use filter When selected, the input signal will be filtered from any
low-frequency noise or distortion caused by, for
example, the input wires running too close to an
electrical source or flow sensor air turbulence.
656 EC-gfxProgram
Table 17: Check out of range
Status Reliability output Fault output
The scaled value (Signal No fault detected (0) False (0) if there is
Configuration: Output) is if there is no signal no signal fault as set
within the range set by fault as set in Check in Check signal
the Minimum and signal fault fault, otherwise True
Maximum parameters. (1)
The scaled value Over range (2) True (1)
exceeds the value set by
the Maximum parameter.
The scaled value Under range (3) True (1)
exceeds the value set by
the Minimum parameter.
Table 18: Check signal fault
Status Reliability output Fault output
The raw input (Signal No fault detected (0) False (0) if there is
Configuration: Signal) is if there is no out of no out of range fault
within the range set by range fault as set in as set in Check out
the Signal Low Limit Check out of range of range, otherwise
and Signal High Limit True (1)
parameters.
The raw input value Open loop (4) True (1)
exceeds the value set by
The block’s output is
the Signal High Limit
the Default value.
parameters.
The raw input value Shorted loop (5) True (1) The block’s
exceeds the value set by output is the Default
the Signal Low Limit value.
parameters.
EC-gfxProgram 657
Custom
A translation table is applied to the input. A user-defined curve can be setup
to interpret the input signal in the TTranslation Table Configuration window. A
curve is generated based on the points defined and is interpolated linearly. If
Smooth curve option is selected, a curve-smoothing technique that calcu-
lates curve inflexion is used.
Figure 410: Hardware Input Configuration window - Custom
Parameter Description
This button opens the Translation Table Configuration
window.
658 EC-gfxProgram
Parameter Description
Signal type This parameter determines the input signal type of the
connected sensor. When supported by the current
controller model, the following signal types are
available:
RESISTANCE: Resistance input, typically 0 to 350kΩ.
VOLTAGE 0 - 10V: Voltage input, 0 to 10V.
MILLIAMPS 0 - 20mA: Current input, 0 to 20mA (DC).
VOLTAGE 0 - 5V: Voltage input, 0 to 5V.
NOTE: If the input value falls out of the expected input
range, it is interpreted as the lower or upper
value of the range.
For example, if a current input is 21mA, then it will be
clipped at 20mA.
WARNING: Exceeding the upper limits for current and
voltage may damage the controller.
Signal offset The offset is a constant value that is applied to the raw
sensor input reading to compensate for reading errors,
for example, from the resistance of a long wire run to
the sensor.
For example, a temperature sensor is connected to one
of the hardware inputs with 1000 feet (305 M) of wire,
which has an effective voltage drop of 0.15V; set the
signal offset to 0.15V to correct for this offset.
Offset The offset is a constant value that is applied to the
block’s output to compensate for reading errors, for
example, to perform sensor calibration.
For example, assume that a temperature sensor is
connected to one of the hardware inputs. If the actual
room temperature is 72ºF but the sensor reading is
74ºF, an offset of -2ºF can be applied to correct the
error.
Default value When the Check signal fault is set, and the
Reliability output is either Open Loop or Shorted
Loop (see Reliability property), this becomes the
block’s output value.
Check out of When set, this enables the block’s Reliability and
range Fault outputs to report the out of range enumeration.
See Table 17.
See Reliability property for a complete list of reliability
enumerations.
EC-gfxProgram 659
Parameter Description
Check signal When set, this enables the block’s Reliability and
fault Fault outputs to report the signal fault status. See
Table 18.
Use filter When selected, the input signal will be filtered from any
low-frequency noise or distortion caused by, for
example, the input wires running too close to an
electrical source or flow sensor air turbulence.
Use override When enabled, a shorted input is interpreted as an
override (Bypass) signal. The Override output only
emits a pulse, thus if it is required to stay on for an
extended period of time, a Min On Time or Latch block
should be utilized.
The override threshold is calculated as follows:
• If Check signal fault is set, the threshold input
resistance that triggers the Override output is set
by the Signal Low Limit.
• If Check signal fault is cleared, the threshold input
resistance that triggers the Override output is cal-
culated as one-half of the lowest Signal value set
in the translation table. For example, if the lowest
Signal value in the translation table is 50 Ohms,
the resistance required to trigger the Override out-
put must be less than 25 Ohms. Accordingly, take
the resistance of long wire runs into account when
setting the Signal offset to compensate for the
long wire run to ensure correct operation.
Smooth curve When selected, a curve-smoothing technique that
calculates curve inflexion is applied between
translation table values. This can make the response of
the translation table better fit the curve of second
degree or higher order functions with fewer translation
table data points.
Translation Table The translation table consists of 2 to 32 rows used to define points on a curve
configuration that converts the raw input value (mA, V, Ω) into the appropriate units of mea-
surement (for example, ºF). The curve is interpolated linearly between each
point based on the values entered. A linear curve is generated automatically
between each pair of points and interpolated/extrapolated as required.
When Smooth Curve is set, this applies a curve-smoothing technique that
calculates curve inflexion between translation table values. This can make the
response of the translation table better fit the curve of second degree or
higher order functions with fewer translation table data points.
NOTE: The values in the Signal value column must be in ascending order,
otherwise the conversion will be incorrect.
660 EC-gfxProgram
Example: The following example illustrates how a translation table can translate a
temperature thermistor’s resistance values into temperature values. The following graph
translation and window display the data points that have been used.
Figure 411: Graph of temperature translation
Figure 412: Translation Table Configuration window
Parameter Description
Create new Click to clear the values in the current translation table.
table
Click to add a row to the translation table.
Add entry
Click to delete the selected row from the translation
Delete
table.
Set number Click to set the total number of rows in the translation
of entries table.
Save to file Click to save the translation table to a file on your file
system. This allows a translation table to be reused in
the future.
EC-gfxProgram 661
Parameter Description
Import from Click to import a translation table that was saved on
file your file system.
Signal Value The raw hardware input reading. Must be in ascending
(mA, V or ohms) order.
Output Value The converted input value.
Digital
Figure 413: Hardware Input Configuration window - Digital
Property Description
Default value This sets the controller’s output to this default value
when:
• The output has not been written to (it is in an unex-
ecuted Conditional Custom Block for example).
• An ECx-400 Series Extension module has lost
communications with the controller.
It assigns a Boolean format to this input, for example,
TRUE, FALSE.
Reverse action The input is normally On when the contact is closed
and Off when it is open.
When the reverse action option is selected, the input is
On when the contact is open and Off when it is closed.
662 EC-gfxProgram
MultiLevel
A user-defined translation table is applied to the input to select the appropri-
ate enumeration as a step function is generated based on the points defined
in the Multi-Level Table Configuration window.
Figure 414: Hardware Input Configuration window - MultiLevel
Parameter Description
This button opens the Multi-Level Table Configuration
window. Assign an input value that is to represent each
enumeration value.
Signal type This parameter determines the input signal type of the
connected sensor. When supported by the current
controller model, the following signal types are
available:
RESISTANCE: Resistance input, typically 0 to 350kΩ.
VOLTAGE 0 - 10V: Voltage input, 0 to 10V.
MILLIAMPS 0 - 20mA: Current input, 0 to 20mA (DC).
VOLTAGE 0 - 5V: Voltage input, 0 to 5V.
NOTE: If the input value falls out of the expected input
range, it is interpreted as the lower or upper
value of the range.
For example, if a current input is 21mA, then it will be
clipped at 20mA.
WARNING: Exceeding the upper limits for current and
voltage may damage the controller.
EC-gfxProgram 663
Parameter Description
Default Value When the Check signal fault is set, and the
Reliability output is either Open Loop or Shorted
Loop (see Reliability property), this enumeration value
is used to set the block’s output value.
It assigns an enumeration format to the object, for
example, occupancy. Click Configure to select the
enumeration that is to be used by the translation table
to convert a given input level to a specific enumeration
member, or create an enumeration or add a new
member to an enumeration. See Creating and using
enumerations (ECL Series).
Check signal When set, this enables the block’s Reliability and
fault Fault outputs to report the signal fault status. Values
are based on the raw input signal. See Table 19.
Table 19: Check signal fault
Status Reliability output Fault output
The raw input is within the No fault detected False (0)
range set by the Signal (0)
Low Limit and Signal High
Limit parameters.
The raw input value Open loop (4) True (1)
exceeds the value set by
The block’s output is
the Signal High Limit
the Default value.
parameters.
The raw input value Shorted loop (5) True (1)
exceeds the value set by
The block’s output is
the Signal Low Limit
the Default value.
parameters.
Translation Table The translation table has a row for each enumeration member of the selected
configuration enumeration. Each row defines a value that when matched to the raw input
value (mA, V, Ω), selects the corresponding enumeration member for the out-
put.
NOTE: The values in the Signal Value column must be in ascending order,
otherwise the conversion will be incorrect.
Example: HVAC The following example illustrates how a multi-level table can assign a potenti-
Mode ometer’s resistance values to a corresponding level. Each level corresponds
to a particular HVAC mode as follows: 0 = HVAC_NUL, 1 = HVAC_AUTO, 2 =
664 EC-gfxProgram
HVAC_HEAT, 3 = HVAC_COOL, 4 = HVAC_OFF. The following graph and
window display the data points that have been used.
Figure 415: Graph of HVAC Mode translation
Figure 416: Multi-Level Table Configuration window
Parameter Description
Signal Value The raw hardware input reading. Must be in ascending
(mA, V or ohms) order.
Output Value The converted input value.
EC-gfxProgram 665
RTD & Thermostors
Predefined translation tables that apply to the standard type thermistors that
are used within sensors.
Figure 417: Hardware Input Configuration - RTD & Thermistors
Parameter Description
Thermistor Type This parameter determines the thermistor type being
used:
PT1000: Platinum RTD
NI1000 @ 0ºC: Nickel RTD
NI1000 @ 22ºC: Nickel RTD
10k Type II: 10KΩ Thermistor
10k Type III: 10KΩ Thermistor
See Thermistor Resistance Tables for the required
specifications of thermistors to be used.
For resistance inputs (0 to 10kΩ), if disconnected (+inf
Ω) for more than 10 seconds, it will cause an electrical
fault.
666 EC-gfxProgram
Parameter Description
Signal Offset The offset is a constant value that is applied to the raw
sensor input reading to compensate for reading errors,
for example, from the resistance of a long wire run to
the sensor.
For example, a temperature sensor is connected to one
of the hardware inputs with 1000 feet (305 M) of wire
that has an effective resistance of 15Ω, set the signal
offset to -15 to correct for this offset.
Offset The offset is a constant value that is applied to the
block’s output to compensate for reading errors, for
example, to perform sensor calibration.
For example, assume that a temperature sensor is
connected to one of the hardware inputs. If the actual
room temperature is 72ºF but the sensor reading is
74ºF, an offset of -2ºF can be applied to correct the
error.
Default value When the Reliability output is either Open Loop or
Shorted Loop (see Reliability property), this becomes
the block’s output value.
Check out of When set, this enables the block’s Reliability and
range Fault outputs to report the out of range enumeration.
See Table 20.
See Reliability property for a complete list of reliability
enumerations.
Use filter When selected, the input signal will be filtered from any
low-frequency noise or distortion caused by, for
example, the input wires running too close to an
electrical source.
Use override When enabled, a shorted input is interpreted as an
override (Bypass) signal. The Override output only
emits a pulse, thus if it is required to stay on for an
extended period of time, a Min On Time or Latch block
should be utilized.
Table 20: Check out of range
Status Reliability output Fault output
The scaled value (Signal No fault detected (0) False (0) if there
Configuration: Output) is if there is no signal is no signal fault
within the range set by the fault
Minimum and Maximum
parameters.
EC-gfxProgram 667
Table 20: Check out of range
Status Reliability output Fault output
The scaled value exceeds the Over range (2) True (1)
value set by the Maximum
parameter.
The scaled value exceeds the Under range (3) True (1)
value set by the Minimum
parameter.
668 EC-gfxProgram
Setpoint Offset
An offset input (±) that is applied to heating and cooling setpoints.
Figure 418: Hardware Input Configuration - Setpoint Offset
Parameter Description
Signal This sets the raw input signal range (set by the
Configuration – Minimum and Maximum parameters).
Signal
Minimum: Is used to correlate with the Minimum
Output value to create the lower point of the linear
interpolation curve that is used to interpret the raw
input reading.
Maximum: Is used to correlate with the Maximum
Output value to create the higher point of the linear
interpolation curve that is used to interpret the raw
input reading.
EC-gfxProgram 669
Parameter Description
Signal This scales the input signal (as set by the Signal
Configuration – Minimum and Maximum parameters) to a new range
Output set by the Output Minimum and Maximum
parameters. A 10% deadband of full signal is centered
at the mid range.
Minimum: Is used to correlate with the Signal
Minimum to create the lower point of the linear
interpolation curve that is used to interpret the raw
input reading.
Maximum: Is used to correlate with the Signal
Maximum to create the higher point of the linear
interpolation curve that is used to interpret the raw
input reading.
For example, if there is a resistance input (0 to 10kΩ)
and a Minimum Signal of 2kΩ, a Maximum signal of
8kΩ, a Minimum Output value of -4 and a Maximum
Output value of 4 are set, then a 2kΩ input will
correspond to -4 and 8kΩ input will correspond to 4.
Figure 419: Setting the signal input range
The 10% deadband of fullscale input is shown below as
a plateau where a user can easily set the setpoint
offset potentiometer to a mid-point zero value.
Figure 420: Centered 10% deadband of fullscale input
Default value When the Check signal fault is set, and the
Reliability output is either Open Loop or Shorted
Loop (see Reliability property), this becomes the
block’s output value.
670 EC-gfxProgram
Parameter Description
Check out of When set, this enables the block’s Reliability and
range Fault outputs to report the out of range enumeration.
The values are based on these calculated by the
Signal Configuration – Output configuration. See
Table 17
See Reliability property for a complete list of reliability
enumerations.
Check signal When set, this enables the block’s Reliability and
fault Fault outputs to report the signal fault status. Values
are based on the raw input signal. See Table 18.
LONWORKS properties
The LONWORKS network properties are set in the Resources Configuration
window’s Resource Tree as shown below (refer to the controller’s Functional
Profile in its datasheet). See also Typical controller internal points.
Figure 421: Network properties configuration for a Hardware Input
See Network Properties Configuration window (ECL, ECB & ECY Series).
Changing the Signal Interpretation type
Should you reconfigure the Signal interpretation type, the network variable
type may no longer be compatible with the new signal type (for example,
using a Digital Signal interpretation type used with a SNVT_Count_inc_f net-
work variable type), a popup window may warn of this situation. In all cases,
ensure the correct network variable type is set in Change Type (ECP & ECL
Series) according to the hardware input’s signal type.
Figure 422: A warning that the Network Variable Type is not appropriate for the Signal
Interpretation Type
EC-gfxProgram 671
Controlling a Hardware Input through a Structured Network Vari-
able
The Hardware Input block’s value and mode are available in a number of
structured Network Variable Outputs (NVOs):
• nvoHwIn1_7, nvoHwIn8_14, and nvoHwIn15_16 contain the values and
modes of Hardware Input blocks 1 to 7, 8 to 14, 15 to 16, according to the
actual number of hardware inputs supported by the controller.
• When ECx-400 Series Extension Module(s) are equipped, nvoHwInX-
1_1_7, nvoHwInX1_8_12, nvoHwInX2_1_7, and nvoHwInX2_8_12 con-
tain the values and modes of Hardware Input blocks 1 to 7, and 8 to 12 for
each ECx-400 Series Extension Module.
The user can read the Hardware Input values directly through these NVOs. A
write to this block is made according the highest priority write method shown
in the table below.
Access Method Write Method Priority
nviModify 1. Set the IntValType to HW_INPUT. 1
2. Set the Index (Block Number: A num-
ber from 1 to 16 means the input is on
the controller. A number from 101 to
112 means the input is on ECx-400
Series Extension Module 1, when
equipped. A number from 201 to 212
means the input is on ECx-400 Series
Extension Module 2, when equipped.)
to the Hardware Input number.
3. Set the Mode to Manual.
4. Set the Value (±3.4028×1038) the
Hardware Input block is to provide at
its Output according to the SNVT type
set in Change Type (ECP & ECL
Series).
To relinquish control, set the Mode to
AUTOMATIC.
No network Relinquish any network override – see 2
override - The above.
value is read
from the
controller’s
physical input as
configured in
Advanced
configuration.
672 EC-gfxProgram
The Hardware Input points can be managed in EC-Net as follows:
1. Select the hardware inputs that are to be overridden by connecting to the
device’s internal points. See EC-Net Platform Support Pack Features for
ECP & ECL Series Controllers.
2. Set the Action for the hardware input. See Typical controller internal
points.
To relinquish control, set the Action to AUTO.
Pulse
Figure 423: Hardware Input Configuration window - Pulse
When the Signal interpretation is set to Pulse, the ClrPulse block input
becomes active. The ClrPulse block input resets the pulse count to zero. A
pulse count input is comprised of a rising edge and a falling edge. Therefore
the value of a pulse count input is equal to the summation of all pulse cycles
and is based on the following equation:
Pulse count input value = (number of rising edges multiplied by the value of
rising increment) + (number of falling edges multiplied by the value of falling
increment).
EC-gfxProgram 673
For example, a pulse count input has been configured with a Rising Incre-
ment value of 5 and a Falling Increment value of 0. After four pulse cycles
(shown below) the value of the input will be as follows (as based on the equa-
tion above): (4 x 5) + (4 x 0) = 20
Figure 424: Pulse Input example
Parameter Description
Supply Type Pulse Input types must be configured according to how
(available on the pulse meter is powered:
fast pulse
Internal: Select this option for a pulse meter that can
controller inputs,
pull-down a +5VDC supply with a 10KΩ pull-up
if available -
resistor, for example, a dry contact.
refer to the
Hardware External: For this option, a Fast Pulse Input type must
Installation be used. An external power source is required to drive
Guide for the the input.
controller)
For more information about this selection, the pulse
meter requirements, and how to wire a pulse meter
input accordingly, refer to the Hardware Installation
Guide for the controller.
Falling A falling edge increments the output by the amount set
Increment by this parameter.
Rising A rising edge increments the output by the amount set
Increment by this parameter.
674 EC-gfxProgram
Hardware Input (ECB & ECY Series)
Description Used to interface with a hardware input. Each Hardware Input block is linked
to a corresponding network object which follows the same value as the Hard-
ware Input block. Units are set in BACnet network properties.
Alarms (ECB & ECY Series) are available with B-AAC or B-BC controller
models only (see the controller’s datasheet for more information).
For ECY Series controllers, alarms that have been configured for this block
can be suppressed by turning off the block’s alarm management so that while
this mechanism is engaged, no alarms will be reported by the block. See
AlarmInhibit input (ECY Series controllers).
Configuration The configuration type that has been selected in the Advanced configuration
Type display window is shown at the bottom of the block as shown below.
Configuration Type
Slim format This block can be collapsed into a slim format. See Collapsed in Common
support block properties.
Number of For ECB Series controllers: the number of Hardware Input block instances
blocks supported by a controller is shown in the Number drop-down list in the Proper-
ties or Statistics panes.
For ECY Series controllers: see Supported number of BACnet objects with an
ECY Series controller.
Advanced Resources Configuration, Advanced configuration, BACnet network proper-
configuration ties, Alarms (ECB & ECY Series), Network Properties Configuration window
(ECL, ECB & ECY Series), Override and auto, Find All References (ECL,
ECB & ECY Series), Copy From, Configure Ports, Show/Hide Ports, Data pro-
cessing, Creating and using enumerations (8-Bit)
Related blocks Generic Hardware Input (ECB & ECY Series)
EC-gfxProgram 675
Input(s)
Port Type Range Description
ClrPulse Digital 0 or 1 For inputs configured for pulse counting, set this
input to True (1) to clear the pulse count.
Alarm Setpoint Numeric ±3.4028 When alarms are enabled for this block (see
(B-AAC and B- ×1038 Alarms (ECB & ECY Series)), a positive input
BC controllers value increases the alarm setpoint values set in
only) the Resources Configuration’s Alarms
configuration for the block (a negative value
reduces the alarm setpoint values): The High
limit is now the High limit value (set in the
Resources Configuration’s Alarms configuration
for the block) plus AlarmSetpoint and the Low
limit is now the Low limit value (set in the
Resources Configuration’s Alarms configuration
for the block) plus AlarmSetpoint. See
Dynamic alarm activation thresholds adjust.
NOTE: When the AlarmSetpoint input is dis-
connected, you must reset the controller
(see Project Synchronization) or connect
a Null value (ECL, ECB & ECY Series)
block to this port so the controller will
release this port as being unconnected.
When the AlarmSetpoint input is dis-
connected, the High limit and Low limit
can be written to through the BACnet
interface.
AlarmValue (B- Digital 0 or 1 When alarms are enabled for this block for a
AAC and B-BC digital value (see Alarms (ECB & ECY Series)),
controllers only) this input overrides the alarm value set in the
Resources Configuration’s Alarms configuration
for the block.
NOTE: When the AlarmValue input is discon-
nected, you must reset the controller
(see Project Synchronization) or connect
aNull value (ECL, ECB & ECY Series)
block to this port so the controller will
release this port as being unconnected.
When the AlarmValue input is discon-
nected, the alarm value property can be
overwritten through the BACnet inter-
face.
676 EC-gfxProgram
Port Type Range Description
Trigger Digital 0 or 1 When Broadcast Mode in the Resources
Broadcast (ECY Configuration for this block is set to Local or
Series controllers Global, this port becomes available. A pulse at
only) this input triggers a broadcast of the object’s
present value on the local network or global
networks. See Broadcast mode.
TriggerTrendLog Digital 0 or 1 When Trend Logs are enabled for this object
(ECY Series and the Logging Type is set to Triggered, a
only) pulse at this input forces the present value to be
recorded in the object’s trend log. See Trending
(ECY Series).
ResetElapsedAct Digital 0 or 1 When a hardware input is configured as a
iveTime Digital output, a pulse at this input resets the
timer for the ElapsedActiveTime output (see
below).
ResetChangeOf Digital 0 or 1 When a hardware input is configured as a
StateCount Digital output, a pulse at this input resets the
counter for the ChangeOfStateCount output
(see below).
AlarmInhibit Digital 0 or 1 While set to True(1), no alarms will be reported
by the block. See AlarmInhibit input (ECY Series
controllers).
Output(s)
Port Type Range Description
Output Digital 0 or 1 Block output. Whether the block will output a
digital value or a numeric value is dependent on
Numeric ±3.4028 what type of Signal interpretation is selected in
×1038 the block’s Advanced configuration window.
Number Integer – The block number. For ECB Series controllers
with one or more ECx-400 Series Extension
Modules connected to it, a number from 1 to 16
means the input is on the controller. A number
from 101 to 112 means the output is on ECx-400
Series Extension Module 1. A number from 201
to 212 means the output is on ECx-400 Series
Extension Module 2. For ECY Series controllers,
see Number of resources supported by a
controller. This information is also shown in the
block type and number; see Block objects
description.
OutOfService Digital 0 or 1 See Out-of-Service.
EC-gfxProgram 677
Port Type Range Description
Fault Digital 0 or 1 When the Check signal fault in the Advanced
Configuration is set, this is logically True (1) if
the Reliability property does not have a value of
No Fault Detected, otherwise logical False (0).
Reliability Enum See When the Check out of range and Check
Description signal fault in the Advanced Configuration is
set, this provides an indication of whether the
physical input is "reliable" and, if not, why. See
Reliability property.
InAlarm (B-AAC Digital 0 or 1 When Enable Alarms is set for this block and
and B-BC the block is in an alarm state, this output is On
controllers only) (1). See Alarms (ECB & ECY Series) to
configure the alarm settings.
Override Digital 0 or 1 When the Use override option is selected in the
Advanced configuration window, this port
becomes available: A shorted input is
interpreted as an override (Bypass) signal. The
Override output only emits a pulse, thus if it is
required to stay on for an extended period of
time, a Min On Time or Latch block should be
utilized.
Elapsed Numeric 3.4028×1038 When a hardware input is configured as a
ActiveTime (ECY Digital output, this cumulates the time this value
Series controllers is set to true (1).
only)
ChangeOf Numeric 3.4028×1038 When a hardware input is configured as a
StateCount (ECY Digital output, this cumulates the number of this
Series controllers value’s state changes.
only)
678 EC-gfxProgram
Block properties See also Common block properties.
Property Type Range Default Description
Number Menu See Hardware Use this drop-down menu to select a physical
Description Input 1 electrical input on this controller. See Number
of blocks for the number of block instances
supported by the current controller model.
For controllers with one or more ECY-IO
Series or ECx-400 Series Extension Modules
connected to it, a Source / Module column
shows on which connected device the input is
located. This information is also shown in the
block type and number; see Block objects
description.
NOTE: When a new block instance is added
to the programming sheet, the block’s
number is incremented to the next
available block number according to
the current Auto Increment setting.
See Auto increment (ECP & ECL
Series and EBC Series controllers
only) or Auto increment (ECY Series
controllers only).
Advanced configuration
Configuration parameters for this block are set in the Resources Configura-
tion window to configure any type of hardware input including sensors,
switches, contacts, etc.
NOTE: Certain models of controllers only support a limited number of input
types, that may vary according to the specific hardware input being
configured. See your controller’s datasheet for more information as to
the output types supported by the controller. In all cases, the Signal
interpretation drop-down list (shown below) reflects the available
configuration options and output types supported by a controller’s
hardware input. Refer to the controller’s Hardware Installation Guide
for more details.
Configure this block as follows:
• Adding a Hardware IO extension module (ECY Series)
• Hardware Input and Output numbering scheme
• Configuring the Input Signal type
EC-gfxProgram 679
Adding a Hardware IO extension module (ECY Series)
For controllers that support ECY-IO Series extension modules, the number
and type of hardware inputs and outputs will vary according to the number
and type of ECY-IO Series Extension modules physically connected to the
controller. ECY-IO Series Extension modules can be added through the
Resources Configuration window as follows.
1. In the Resources Configuration window’s Resource Tree, right-click IO
Modules and select Add.
Figure 425: Adding an ECY-IO Series extension module
2. Set the IO Module’s name, description, and type. According to the
selected IO module type, the inputs and outputs are added to the
Resource Tree.
Figure 426: Setting the IO Module’s description and type
3. In the Resource Tree, select the inputs and outputs to configure them. For
hardware inputs, see Configuring the Input Signal type. For hardware out-
puts, see Configuring the Output Signal Type (ECB & ECY Series).
When no extension IO module is currently configured in an ECY Series
controller’s project and you drop a hardware input or output onto the Pro-
gramming Sheet, the following popup will appear. Click Yes to continue.
Figure 427: Adding an IO module
680 EC-gfxProgram
Hardware Input and Output numbering scheme
ECY Series For ECY Series controllers, the hardware inputs and outputs are numbered in
controllers the Resource Tree according to the following scheme that identifies the ECY-
IO Series Extension module’s position to the right of the main controller and
the physical input or output connection on that ECY-IO Series Extension mod-
ule.
Figure 428: Hardware Input and Output numbering scheme for ECY Series controllers
HO 1202
The number of the ECY-IO Series Extension
module Input or Output port, as labeled on the
controller’s faceplate. For example, this refers to
hardware output #2. See the ECY-IO Series
Extension module’s hardware installation guide.
The number of IO modules to the right of the
main controller. For example, this refers to the
12th ECY-IO Series Extension module con-
nected to the right of the main controller. Non-IO
modules do not count towards this number.
ECB Series For ECB Series controllers that support extension modules, the hardware
controllers inputs and outputs are numbered in the Resource Tree according to the
extension module’s MAC address setting.
Figure 429: Hardware Input and Output numbering scheme for ECB Series controllers
HO 202
The number of the ECx-400 Series Extension
module Input or Output port, as labeled on the
controller’s faceplate. For example, this refers to
hardware output #2. See the ECx-400 Series
Extension module’s hardware installation guide.
The extension module’s MAC address setting.
For example, this refers to the ECx-400 Series
Extension module with its MAC address set to 2.
Configuring the Input Signal type
Disconnected
The hardware input is not used.
Figure 430: Hardware Input Configuration window - Disconnected
EC-gfxProgram 681
Linear
A linear curve is used to interpret a voltage (0 to 10V, 0 to 5V), current (0 to
20mA), or resistance (0 to 350kΩ) input signal.
Figure 431: Hardware Input Configuration window - Linear
682 EC-gfxProgram
Property Description
Signal Type This parameter determines the input signal type of the
connected sensor. When supported by the current
controller model, the following signal types are
available:
RESISTANCE: Resistance input, typically 0 to 350kΩ.
VOLTAGE 0 - 10V: Voltage input, 0 to 10V.
MILLIAMPS 0 - 20mA: Current input, 0 to 20mA (DC).
VOLTAGE 0 - 5V: Voltage input, 0 to 5V.
NOTE: If the input value falls out of the expected input
range, it is interpreted as the lower or upper
value of the range.
For example, if a current input is 21mA, then it will be
clipped at 20mA.
WARNING: Exceeding the upper limits for current and
voltage may damage the controller.
Signal This sets the raw input signal range (set by the
Configuration – Minimum and Maximum parameters).
Signal
Minimum: Is used to correlate with the Minimum
Output value to create the lower point of the linear
interpolation curve that is used to interpret the raw
input reading.
Maximum: Is used to correlate with the Maximum
Output value to create the higher point of the linear
interpolation curve that is used to interpret the raw
input reading.
EC-gfxProgram 683
Property Description
Signal This linearly scales the input signal (as set by the
Configuration – Signal Minimum and Maximum parameters) to a new
Output range set by the Output Minimum and Maximum
parameters.
Minimum: Is used to correlate with the Signal
Minimum to create the lower point of the linear
interpolation curve that is used to interpret the raw
input reading.
Maximum: Is used to correlate with the Signal
Maximum to create the higher point of the linear
interpolation curve that is used to interpret the raw
input reading.
For example, if there is a resistance input (0 to 10kΩ)
and a Minimum Signal of 2kΩ, a Maximum signal of
8kΩ, a Minimum Output value of 60ºF and a
Maximum Output value of 80ºF are set, then 2kΩ will
correspond to 60ºF and 8kΩ will correspond to 80ºF.
Figure 432: Setting the signal input range
Default Value When the Check signal fault is set, and the
Reliability output is either Open Loop or Shorted
Loop (see Reliability property), this becomes the
block’s output value.
Check out of When set, this enables the block’s Reliability and
range Fault outputs to report the out of range enumeration.
The values are based on these calculated by the
Signal Configuration – Output configuration. See
Table 21.
See Reliability property for a complete list of reliability
enumerations.
Check signal When set, this enables the block’s Reliability and
fault Fault outputs to report the signal fault status. Values
are based on the raw input signal. See Table 22.
Use filter When selected, the input signal will be filtered from any
low-frequency noise or distortion caused by, for
example, the input wires running too close to an
electrical source or flow sensor air turbulence.
684 EC-gfxProgram
Table 21: Check out of range
Status Reliability output Fault output
The scaled value (Signal No fault detected False (0) if there is no
Configuration: Output) is (0) if there is no signal fault as set in
within the range set by signal fault as set in Check signal fault,
the Minimum and Check signal fault otherwise True (1)
Maximum parameters.
The scaled value Over range (2) True (1)
exceeds the value set by
the Maximum parameter.
The scaled value Under range (3) True (1)
exceeds the value set by
the Minimum parameter.
Table 22: Check signal status
Status Reliability output Fault output
The raw input value No fault detected False (0) if there is no
(Signal Configuration: (0) if there is no out out of range fault as
Signal) is within the range of range fault as set set in Check out of
set by the Signal Low in Check out of range, otherwise True
Limit and Signal High range (1)
Limit parameters.
The raw input value Open loop (4) True (1)
exceeds the value set by
The block’s output is
the Signal High Limit
the Default value.
parameters.
The raw input value Shorted loop (5) True (1)
exceeds the value set by
The block’s output is
the Signal Low Limit
the Default value.
parameters.
EC-gfxProgram 685
Custom
A translation table is applied to the input. A user-defined curve can be setup
to interpret the input signal in the Translation Table Configuration window. A
curve is generated based on the points defined and is interpolated linearly. If
Smooth curve option is selected, a curve-smoothing technique that calcu-
lates curve inflexion is used.
Figure 433: Hardware Input Configuration window - Translation Table
Property Description
This button opens the Translation Table Configuration
window.
686 EC-gfxProgram
Property Description
Signal type This parameter determines the input signal type of the
connected sensor. When supported by the current
controller model, the following signal types are
available:
RESISTANCE: Resistance input, typically 0 to 350kΩ.
VOLTAGE 0 - 10V: Voltage input, 0 to 10V.
MILLIAMPS 0 - 20mA: Current input, 0 to 20mA (DC).
VOLTAGE 0 - 5V: Voltage input, 0 to 5V.
NOTE: If the input value falls out of the expected input
range, it is interpreted as the lower or upper
value of the range.
For example, if a current input is 21mA, then it will be
clipped at 20mA.
WARNING: Exceeding the upper limits for current and
voltage may damage the controller.
Signal offset The offset is a constant value that is applied to the raw
sensor input reading to compensate for reading errors,
for example, from the resistance of a long wire run to
the sensor.
For example, a temperature sensor is connected to one
of the hardware inputs with 1000 feet (305 M), which
has an effective voltage drop of 0.15V; set the signal
offset to 0.15V to correct for this offset.
Offset The offset is a constant value that is applied to the
block’s output to compensate for reading errors, for
example, to perform sensor calibration.
For example, assume that a temperature sensor is
connected to one of the hardware inputs. If the actual
room temperature is 72ºF but the sensor reading is
74ºF, an offset of -2ºF can be applied to correct the
error.
Default value When the Check signal fault is set, and the
Reliability output is either Open Loop or Shorted
Loop (see Reliability property), this becomes the
block’s output value.
Check out of When set, this enables the block’s Reliability and
range Fault outputs to report the out of range enumeration.
See Table 21.
See Reliability property for a complete list of reliability
enumerations.
EC-gfxProgram 687
Property Description
Check signal When set, this enables the block’s Reliability and
fault Fault outputs to report the signal fault status. See
Table 22.
Use filter When selected, the input signal will be filtered from any
low-frequency noise or distortion caused by, for
example, the input wires running too close to an
electrical source or flow sensor air turbulence.
Use override When enabled, a shorted input is interpreted as an
override (Bypass) signal. The Override output only
emits a pulse, thus if it is required to stay on for an
extended period of time, a Min On Time or Latch block
should be utilized.
The override threshold is calculated as follows:
• If Check signal fault is set, the threshold input
resistance that triggers the Override output is set
by the Signal Low Limit.
• If Check signal fault is cleared, the threshold input
resistance that triggers the Override output is cal-
culated as one-half of the lowest Signal value set
in the translation table. For example, if the lowest
Signal value in the translation table is 50 Ohms,
the resistance required to trigger the Override out-
put must be less than 25 Ohms. Accordingly, take
the resistance of long wire runs into account when
setting the Signal offset to compensate for the
long wire run to ensure correct operation.
Smooth curve When selected, a curve-smoothing technique that
calculates curve inflexion is applied between
translation table values. This can make the response of
the translation table better fit the curve of second
degree or higher order functions with fewer translation
table data points.
Translation Table The translation table consists of 2 to 32 rows used to define points on a curve
configuration that converts the raw input value (mA, V, Ω) into the appropriate units of mea-
surement (for example, ºF). The curve is interpolated linearly between each
point based on the values entered. A linear curve is generated automatically
between each pair of points and interpolated/extrapolated as required.
When Smooth Curve is set, this applies a curve-smoothing technique that
calculates curve inflexion between translation table values. This can make the
response of the translation table better fit the curve of second degree or
higher order functions with fewer translation table data points.
NOTE: The values in the Signal value column must be in ascending order,
otherwise the conversion will be incorrect.
688 EC-gfxProgram
Example: The following example illustrates how a translation table can translate a
temperature thermistor’s resistance values into temperature values. The following graph
translation and window display the data points that have been used.
Figure 434: Graph of temperature translation
Figure 435: Translation Table Configuration window
Parameter Description
Create new Click to clear the values in the current translation table.
table
Click to add a row to the translation table.
Add entry
Click to delete the selected row from the translation
Delete
table.
Set number Click to set the total number of rows in the translation
of entries table.
Save to file Click to save the translation table to a file on your file
system. This allows a translation table to be reused in
the future.
EC-gfxProgram 689
Parameter Description
Import from Click to import a translation table that was saved on
file your file system.
Signal Value The raw hardware input reading. Must be in ascending
(mA, V or ohms) order.
Output Value The converted input value.
690 EC-gfxProgram
Digital
Figure 436: Hardware Input Configuration window - Digital
Property Description
Default value This sets the controller’s output to this default value
when:
• The output has not been written to (it is in an unex-
ecuted Conditional Custom Block for example).
• An ECY-IO Series or ECx-400 Series Extension
module has lost communications with the control-
ler.
It assigns a Boolean format to the BACnet object, for
example, On, Off. Click Configure to create a new
enumeration or add a new member to an enumeration.
See Creating and using enumerations (8-Bit).
Reverse action The input is normally On when the contact is closed
and Off when it is open.
When the reverse action option is selected, the input is
On when the contact is open and Off when it is closed.
EC-gfxProgram 691
Multilevel
A user-defined translation table is applied to the input to select the appropri-
ate enumeration as a step function is generated based on the points defined
in the Multi-Level Table Configuration window.
Figure 437: BACnet Hardware Input Configuration window - MultiLevel
Property Description
This button opens the Multi-Level Table Configuration
window. Assign an input value that is to represent each
enumeration value.
Signal type This parameter determines the input signal type of the
connected sensor. When supported by the current
controller model, the following signal types are
available:
RESISTANCE: Resistance input, typically 0 to 350kΩ.
VOLTAGE 0 - 10V: Voltage input, 0 to 10V.
MILLIAMPS 0 - 20mA: Current input, 0 to 20mA (DC).
VOLTAGE 0 - 5V: Voltage input, 0 to 5V.
NOTE: If the input value falls out of the expected input
range, it is interpreted as the lower or upper
value of the rang.
For example, if a current input is 21mA, then it will be
clipped at 20mA.
WARNING: Exceeding the upper limits for current and
voltage may damage the controller.
692 EC-gfxProgram
Property Description
Default value When the Check signal fault is set, and the
Reliability output is either Open Loop or Shorted
Loop (see Reliability property), this enumeration value
is used to set the block’s output value.
It assigns a enumeration format to the BACnet object,
for example, occupancy. Click Configure to select the
enumeration that is to be used by the translation table
to convert a given input level to a specific enumeration
member, or create an enumeration or add a new
member to an enumeration. See Creating and using
enumerations (8-Bit).
Check signal When set, this enables the block’s Reliability and
fault Fault outputs to report the signal fault status. Values
are based on the raw input signal. See Table 23.
Table 23: Check signal fault - Multilevel
Status Reliability output Fault output
The raw input is within No fault detected (0) False (0)
the range set by the
Signal Low Limit and
Signal High Limit
parameters.
The raw input value Open loop (4) True (1)
exceeds the value set
The block’s output is
by the Signal High
the Default value.
Limit parameters.
The raw input value Shorted loop (5) True (1)
exceeds the value set
The block’s output is
by the Signal Low
the Default value.
Limit parameters.
Translation Table The translation table has a row for each enumeration member of the selected
configuration enumeration. Each row defines a value that when matched to the raw input
value (mA, V, Ω), selects the corresponding enumeration member for the out-
put.
NOTE: The values in the Signal Value column must be in ascending order,
otherwise the conversion will be incorrect.
EC-gfxProgram 693
Example: HVAC The following example illustrates how a multi-level table can assign a potenti-
mode ometer’s resistance values to a corresponding level. Each level corresponds
to a particular HVAC mode as follows: 0 = HVAC_NUL, 1 = HVAC_AUTO, 2 =
HVAC_HEAT, 3 = HVAC_COOL, 4 = HVAC_OFF. The following graph and
window display the data points that have been used.
Figure 438: Graph of HVAC Mode translation
Figure 439: Multi-Level Table Configuration window
Parameter Description
Create new Click to clear the values in the current translation table.
table
Click to add a row to the translation table.
Add entry
Click to delete the selected row from the translation
Delete
table.
694 EC-gfxProgram
Parameter Description
Set number Click to set the total number of rows in the translation
of entries table.
Save to file Click to save the translation table to a file on your file
system. This allows a translation table to be reused in
the future.
Import from Click to import a translation table that was saved on
file your file system.
Signal Value The raw hardware input reading. Must be in ascending
(mA, V or Ω) order.
Output Value The converted input value.
The output port of this block can be configured with a format that will display
the MSI values as a user-friendly enumeration. See Configure Ports. For
more information about the enumeration to use with this block, see Creating
and using enumerations (8-Bit).
RTD & Thermistors
EC-gfxProgram 695
Predefined translation tables that apply to the standard type thermistors that
are used within sensors.
Figure 440: Hardware Input Configuration - RTD & Thermistors
Parameter Description
Thermistor Type This parameter determines the thermistor type being
used:
PT1000: Platinum RTD
NI1000 @ 0ºC: Nickel RTD
NI1000 @ 22ºC: Nickel RTD
10k Type II: 10KΩ Thermistor
10k Type III: 10KΩ Thermistor
See Thermistor Resistance Tables for the required
specifications of thermistors to be used.
For resistance inputs (0 to 10kΩ), if disconnected (+inf
Ω) for more than 10 seconds, it will cause an electrical
fault.
Signal Offset The offset is a constant value that is applied to the raw
sensor input reading to compensate for reading errors,
for example, from the resistance of a long wire run to
the sensor.
For example, a temperature sensor is connected to one
of the hardware inputs with 1000 feet (305 M) of wire
that has an effective resistance of 15Ω, set the signal
offset to -15 to correct for this offset.
696 EC-gfxProgram
Parameter Description
Offset The offset is a constant value that is applied to the
block’s output to compensate for reading errors, for
example, to perform sensor calibration.
For example, assume that a temperature sensor is
connected to one of the hardware inputs. If the actual
room temperature is 72ºF but the sensor reading is
74ºF, an offset of -2ºF can be applied to correct the
error.
Default value When the Reliability output is either Open Loop or
Shorted Loop (see Reliability property), this becomes
the block’s output value.
Check out of When set, this enables the block’s Reliability and
range Fault outputs to report the out of range enumeration.
See Table 21.
See Reliability property for a complete list of reliability
enumerations.
Use filter When selected, the input signal will be filtered from any
low-frequency noise or distortion caused by, for
example, the input wires running too close to an
electrical source.
Use override When enabled, a shorted input is interpreted as an
override (Bypass) signal. The Override output only
emits a pulse, thus if it is required to stay on for an
extended period of time, a Min On Time or Latch block
should be utilized.
EC-gfxProgram 697
Setpoint Offset
An offset input (±) that is applied to heating and cooling setpoints.
Figure 441: Hardware Input Configuration window - Setpoint Offset
Parameter Description
Signal This sets the raw input signal range (set by the
Configuration – Minimum and Maximum parameters).
Signal
Minimum: Is used to correlate with the Minimum
Output value to create the lower point of the linear
interpolation curve that is used to interpret the raw
input reading.
Maximum: Is used to correlate with the Maximum
Output value to create the higher point of the linear
interpolation curve that is used to interpret the raw
input reading.
698 EC-gfxProgram
Parameter Description
Signal This scales the input signal (as set by the Signal
Configuration – Minimum and Maximum parameters) to a new range
Output set by the Output Minimum and Maximum
parameters. A 10% deadband of full signal is centered
at the mid range.
Minimum: Is used to correlate with the Signal
Minimum to create the lower point of the linear
interpolation curve that is used to interpret the raw
input reading.
Maximum: Is used to correlate with the Signal
Maximum to create the higher point of the linear
interpolation curve that is used to interpret the raw
input reading.
For example, if there is a resistance input (0 to 10kΩ)
and a Minimum Signal of 2kΩ, an Maximum signal of
8kΩ, a Minimum Output value of -4 and a Maximum
Output value of 4 are set, then a 2kΩ input will
correspond to -4 and 8kΩ input will correspond to 4.
Figure 442: Setting the signal input range
The 10% deadband of fullscale input is shown below as
a plateau where a user can easily set the setpoint
offset potentiometer to a mid-point zero value.
Figure 443: Centered 10% deadband of fullscale input
Default value When the Check signal fault is set, and the
Reliability output is either Open Loop or Shorted
Loop (see Reliability property), this becomes the
block’s output value.
EC-gfxProgram 699
Parameter Description
Check out of When set, this enables the block’s Reliability and
range Fault outputs to report the out of range enumeration.
The values are based on these calculated by the
Signal Configuration – Output configuration. See
Table 21.
See Reliability property for a complete list of reliability
enumerations.
Check signal When set, this enables the block’s Reliability and
fault Fault outputs to report the signal fault status. Values
are based on the raw input signal. See Table 22.
Pulse
Figure 444: Hardware Input Configuration window - Pulse
When the Signal interpretation is set to Pulse, the ClrPulse block input
becomes active. The ClrPulse block input resets the pulse count to zero. A
pulse count input is comprised of a rising edge and a falling edge. Therefore
the value of a pulse count input is equal to the summation of all pulse cycles
and is based on the following equation:
Pulse count input value = (number of rising edges multiplied by the value of
rising increment) + (number of falling edges multiplied by the value of falling
increment).
For example, a pulse count input has been configured with a Rising Incre-
ment value of 5 and a Falling Increment value of 0. After four pulse cycles
(shown below) the value of the input will be as follows (as based on the equa-
tion above): (4 x 5) + (4 x 0) = 20.
Figure 445: Pulse Input example
700 EC-gfxProgram
Property Description
Supply Type Pulse Input types must be configured according to how
(available on the pulse meter is powered:
fast pulse
Internal: Select this option for a pulse meter that can
controller inputs,
pull-down a +5VDC supply with a 10KΩ pull-up
if available -
resistor, for example, a dry contact.
refer to the
Hardware External: For this option, a Fast Pulse Input type must
Installation be used. An external power source is required to drive
Guide for the the input.
controller)
For more information about this selection, the pulse
meter requirements, and how to wire a pulse meter
input accordingly, refer to the Hardware Installation
Guide for the controller.
Falling A falling edge increments the output by the amount set
Increment by this parameter.
Rising A rising edge increments the output by the amount set
Increment by this parameter.
Hardware Output (ECP Series)
Description Used to interface with a hardware output. Each Hardware Output block is
linked to a corresponding nviFP_xx (xx=output number). However, this link is
broken either if a Network Variable Input block with the same block number is
used in the project code or a Hardware Output block is used. The user can
read the values and modes of the Hardware Output blocks directly through
nvoHwOx_x (x=output number). nviModify can be used to write to the values
and modes of the blocks by specifying the internal value type (HW_OUTPUT),
the index (Block Number), the mode (Automatic or Manual), and the value
(0.00 to 100.00).
EC-gfxProgram 701
Configuration The configuration type that has been selected in the Advanced configuration
Type display window is shown at the bottom of the block as shown below.
Configuration Type
Number of Depends on the number of hardware outputs available for the current control-
blocks ler model.
Advanced Advanced configuration, Edit Mode and Value (ECP Series), Copy From,
configuration Configure Ports, Show/Hide Ports
Input(s)
Port Type Range Description
Input Digital 0 or 1 Value of the controller’s output.
Numeric 0.00 to 100.00
Output(s)
Port Type Range Description
Output Digital 0 or 1 Effective value of the controller’s output. This
value takes into consideration the manual and
Numeric 0.00 to physical (HOA) override values. Whether the
100.00 block will output a digital value or a numeric
value is dependent on what type of Signal
type is selected in the block’s Advanced
configuration window.
Mode Digital 0 or 1 Mode of the input.
0 = Automatic
1 = Manual
HwOvrSt Enum 0 to 2 Hardware override status (HOA switches).
0 = OFF
1 = Auto
2 = Hand
HwOvrVal Numeric -1 to 12.00 Hardware override value that represents the 0
to 12V of the output. When HwOvrSt is Off (0),
this output is -1.
702 EC-gfxProgram
Block properties See also Common block properties.
Property Type Range Default Description
Number Menu See Hardware Use this drop-down menu to select
Description Output 1 a physical electrical output on this
controller. This drop-down menu
shows the total number of block
instances that are available for the
current controller model.
NOTE: When a new block instance
is added to the Program-
ming Sheet, the block’s
number is incremented to
the next available block
number according to the
current Auto Increment set-
ting. See Auto Increment
(ECP & ECL Series and
ECB Series controllers
only).
The number of blocks available
depends on the number of outputs
available for the current controller
model.
Advanced configuration
The Hardware Output Configuration window has all the settings required to
configure any type of hardware output including fans, heating/cooling sys-
tems, lights, etc. Depending on the Signal type selected, the options avail-
able under Settings will vary.
NOTE: The available signal types depend on the type of output on each con-
troller. Refer to the Hardware Installation Guides of the controllers for
more details.
UNASSIGNED
Figure 446: Hardware Output Configuration window - Unassigned
EC-gfxProgram 703
DIGITAL
Figure 447: Hardware Output Configuration window - Digital
Property Description
Reverse Set this option to invert the output.
PWM
Figure 448: Hardware Output Configuration window - PWM
Property Description
Min value The minimum value that is allowed for PWM outputs.
Max value The maximum value that is allowed for PWM outputs.
PWM period Used to specify the PWM period for all outputs set to
PWM signal type (the period cannot be set to different
values for individual outputs). Lowering the default
value will result in a faster response and will provide a
more stable temperature when using perimeter
heating. However, it must be ensured that the PWM
period is not too low (fast cycling time) for the type of
equipment used.
Reverse Set this option to invert the output.
704 EC-gfxProgram
ANALOG_0_10V
Figure 449: Hardware Output Configuration window - Analog 0 to 10V
Property Description
Min value The minimum value that is allowed for Analog outputs.
The output range is 0 to 100; therefore the Min Value
corresponds to 0.
Max value The maximum value that is allowed for Analog outputs.
The output range is 0 to 100; therefore the Max Value
corresponds to 100.
Reverse Set this option to invert the output.
ANALOG_0_20MA
Figure 450: Hardware Output Configuration window - Analog 0 to 20mA
Property Description
Min value The minimum value that is allowed for Analog outputs.
The output range is 0 to 100; therefore the Min Value
corresponds to 0.
EC-gfxProgram 705
Property Description
Max value The maximum value that is allowed for Analog outputs.
The output range is 0 to 100; therefore the Max Value
corresponds to 100.
Reverse Set this option to invert the output.
Hardware Output (ECL Series)
Description Used to interface with a hardware output. Each Hardware Output block is
linked to a corresponding network object which follows the same value as the
Hardware Output block.
Configuration The configuration type that has been selected in the Advanced configuration
Type display window is shown at the bottom of the block as shown below.
Configuration Type
Slim format This block can be collapsed into a slim format. See Collapsed in Common
support block properties.
Advanced Resources Configuration, Advanced configuration, Change Type (ECP & ECL
configuration Series), Controlling a Hardware Output through a structured network variable,
Find All References (ECL, ECB & ECY Series), Copy From, Configure Ports,
Show/Hide Ports, LONWORKS properties
Related blocks Generic Hardware Output (ECL Series)
706 EC-gfxProgram
Input(s)
Port Type Range Description
Input Digital 0 or 1 Value of the controller’s output.
Numeric 0 to 100
Null – For a pulse output, a Null Value (ECL,
ECB & ECY Series) must be set at the
Input, otherwise the hardware output will
function as a Digital output
OnFor Numeric 0 to 3.4028 ×1038 When the Hardware Output is configured
as a pulse output, this sets the output
pulse duration in seconds. To retrigger a
pulse output, there must be a change of
value at this input.
Output(s)
Port Type Range Description
Output Digital 0 or 1 Effective value of the controller’s output.
Whether the block will output a digital
Numeric 0 to 100 value or a numeric value is dependent on
what type of Signal type is selected in the
block’s Advanced configuration window.
TimeLeft Numeric 0 to 2147318 When the Hardware Output is configured
as a pulse output, this is the remaining
time before the pulse ends, once the
pulse has been triggered by the OnFor
input.
Number Integer 1 to 12 The block number. For controllers with
one or more ECx-400 Series Extension
Modules connected to it, a number from 1
to 12 means the output is on the
controller. A number from 101 to 112
means the output is on ECx-400 Series
Extension Module 1. A number from 201
to 212 means the output is on ECx-400
Series Extension Module 2.
OutOfService Digital 0 or 1 See Out-of-Service.
Reliability Enum See Description When a hardware output on an ECx-400
Series Extension module has lost
communications with the controller, this
output becomes Communication
Failure. See Reliability property.
EC-gfxProgram 707
Port Type Range Description
Priority Numeric 0 to 4 The current priority that is controlling the
output. See Output priority for a
description of the priority levels.
OverrideSwitcha Multi State OffAutoManualN The HOA switch’s current position.
Value ot available Manual is the Hand position.
Override Numeric 0 to 12.5VDC The HOA potentiometer’s current position
Potentiometera (expressed as a voltage).
NOTE: When the HOA switch on the con-
troller is set to the Man position,
the potentiometer has an effective
output control range of:
-0 to 12.5VDC for an output con-
figured as a 0 to 10VDC output.
-0 to 25mA for an output config-
ured as a 0 to 20mA output.
Effective Outputa Numeric 0 to 1% The actual output voltage or current at the
hardware output, which represents the
Digital 0 or 1 value of any software generated output or
any HOA override setting.
a. Available with HOA-equipped controller outputs – refer to the Hardware
Installation Guide for the controller.
708 EC-gfxProgram
Block properties See also Common Block Properties.
Port Type Range Default Description
Number Menu See Hardware Output 1 Use this drop-down menu to select a
Description physical electrical output on this
controller. The number of Hardware
Output block instances supported by a
controller is shown in this drop-down list
or in the Statistics pane.
For controllers with one or more ECx-
400 Series Extension Modules
connected to it, a Source column
shows on which device the input is
located. This information is also shown
in the block type and number; see Block
objects description.
NOTE: When a new block instance is
added to the Programming
Sheet, the block’s number is
incremented to the next avail-
able block number according to
the current Auto Increment set-
ting. See Auto Increment (ECP
& ECL Series and ECB Series
controllers only).
Advanced configuration
Configuration parameters for this block are set in the Resources Configura-
tion window allowing this block to operate fans, heating/cooling systems, light-
ing, etc.
NOTE: Certain models of controllers only support a limited number of output
types, that may vary according to the specific hardware output being
configured. See your controller’s datasheet for more information as to
the output types supported by the controller. In all cases, the Signal
interpretation drop-down list (shown below) reflects the available
configuration options and output types supported by a controller hard-
ware output. Refer to the controller’s Hardware Installation Guide for
more details.
Configure this block as follows:
• Hardware Input and Output numbering scheme
• Adding a Floating Output (ECL Series)
• Configuring the output signal type (ECL Series)
EC-gfxProgram 709
Configuring the output signal type (ECL Series)
General configuration
Set the hardware output’s name and the network variable properties. See
ECL Series network properties.
Disconnected
The hardware input is not used.
Figure 451: Hardware Output Configuration window - Unassigned
710 EC-gfxProgram
Digital
Figure 452: Hardware Output Configuration window - Digital
Parameter Description
HOA OFF On controllers equipped with HOA switches, when the
threshold potentiometer is set below this threshold, the block’s
(available with EffectiveOutput port will be False.
HOA equipped
outputs only) NOTE: Leaving a gap between the HOA ON threshold
and the HOA OFF threshold creates a dead-
band range in which varying the potentiometer
will not affect change in the block’s output.
HOA ON On controllers equipped with HOA switches, when the
threshold potentiometer is set above this threshold, the block’s
(available with EffectiveOutput port will be True.
HOA equipped
outputs only)
Default value This sets the controller’s output to this default value
when:
• The output has not been written to (it is in an unex-
ecuted Conditional Custom Block for example).
• An ECx-400 Series Extension module has lost
communications with the controller.
EC-gfxProgram 711
Parameter Description
Reverse action Set this option to invert the output. When this option is
set with outputs equipped with an HOA switch and
potentiometer:
HOA in Auto position: The block’s EffectiveOutput
port will be the software commanded output.
HOA in Off position: The block’s EffectiveOutput
port will be True.
HOA in On position and the potentiometer is set
above the HOA On Threshold: The block’s
EffectiveOutput port will be False.
HOA in On position and the potentiometer is set
below the HOA Off Threshold: The block’s
EffectiveOutput port will be True.
HOA in On position and the potentiometer is set
between the HOA Off Threshold and HOA On
Threshold: This is a dead-band range in which varying
the potentiometer will not affect change in the block’s
EffectiveOutput.
PWM
Figure 453: Hardware Output Configuration window - Unassigned
Parameter Description
Minimum The minimum duty cycle that is allowed for PWM
outputs. The input range to the block is 0 to 100;
therefore the Minimum corresponds to the output duty
cycle when the block’s input is at 0.
Maximum The maximum duty cycle that is allowed for PWM
outputs. The input range to the block is 0 to 100;
therefore the Maximum corresponds to the output duty
cycle when the block’s input is at 100.
712 EC-gfxProgram
Parameter Description
Default value This sets the controller’s output to this default value
when:
• The output has not been written to (it is in an unex-
ecuted Conditional Custom Block for example).
• An ECx-400 Series Extension module has lost
communications with the controller.
Period Used to specify the PWM period for individual outputs
set to PWM signal type. Lowering the default value will
result in a faster response and will provide a more
stable temperature when using perimeter heating.
However, it must be ensured that the PWM period is
not too low (fast cycling time) for the type of equipment
used.
Cool down time Thermal actuators take time to cool off before the
actuator starts to return its resting position. The cool-
down time is usually specified in the thermal actuator’s
datasheet. Once the cool down time has expired, the
controller will initiate a warm up cycle defined by the
Warm up time parameter.
Figure 454: Thermal Actuator Opening and Closing Times
Example
Set this value to zero if a thermal actuator is not being
used with this output.
EC-gfxProgram 713
Parameter Description
Warm up time Thermal actuators take time to warm up before the
actuator starts to activate and respond to a control
signal. The warm-up time is usually specified in the
thermal actuator’s datasheet.
Set this value to zero if a thermal actuator is not being
used with this output.
NOTE: During warm up, the output will be continuously
on (no PWM signal modulation) to heat the
thermal actuator and make it controllable as
quick as possible.
- Only once the cool down time has expired can
the warm up period become active.
- The warm up and cool down times required by
a thermal actuator is dependent on the ambient
temperature of the environment in which the
thermal actuator is located.
Reverse action Set this option to invert the output. When this option is
set with outputs equipped with an HOA switch and
potentiometer:
HOA is in Auto position: The block’s EffectiveOutput
port will be the software commanded output.
HOA is in Off position and the potentiometer is set
to a voltage less than 3 volts: The block’s
EffectiveOutput port will be the Maximum set above.
HOA in On position and the potentiometer is set to
a voltage greater than or equal to 3 volts: The
block’s EffectiveOutput port will be Minimum as set
above.
HOA in On position and the potentiometer is set to
a voltage less than 3 volts: The block’s
EffectiveOutput port will be Maximum as set above.
714 EC-gfxProgram
Analog 0 - 20mA
Figure 455: Hardware Output Configuration window - Analog 0 - 20mA
Parameter Description
Minimum The minimum value that is allowed for Analog outputs.
The input range to the block is 0 to 100; therefore the
Minimum corresponds to the output value when the
block’s input is at 0.
Maximum The maximum value that is allowed for Analog outputs.
The input range to the block is 0 to 100; therefore the
Maximum corresponds to the output value when the
block’s input is at 100.
Default This sets the controller’s output to this default value
when:
• The output has not been written to (it is in an unex-
ecuted Conditional Custom Block for example).
• An ECx-400 Series Extension module has lost
communications with the controller.
Reverse action Set this option to invert the output. When this option is
set with outputs equipped with an HOA switch and
potentiometer:
HOA is in Auto position: The block’s EffectiveOutput
port will be the software commanded output according
to the range limits (Minimum and Maximum) as set
above.
HOA is in Off position: The block’s EffectiveOutput
port will be the Maximum as set above.
HOA in On position: The block’s EffectiveOutput port
varies inversely to the potentiometer’s position
according to the range limits (Minimum and
Maximum) as set above.
EC-gfxProgram 715
Pulse
This creates a pulse output for a duration set by the OnFor input. The Input
must be set to Null to enable this feature; otherwise the hardware output will
function as a Digital output.
Figure 456: Hardware Output Configuration window - Analog 0 - 20mA
Parameter Description
Default This sets the controller’s output to this default value
when:
• The output has not been written to (it is in an unex-
ecuted Conditional Custom Block for example).
• An ECx-400 Series Extension module has lost
communications with the controller.
Reverse action Set this option to invert the output.
LONWORKS properties
The LONWORKS network properties are set in the Resources Configuration
window’s Resource Tree as shown below (refer to the controller’s Functional
Profile in its datasheet). See also Typical controller internal points.
Figure 457: Network properties configuration for a Hardware Output
See Network Properties Configuration window (ECL, ECB & ECY Series).
Output priority There are four ways to control a hardware output. A priority hierarchy shown
in Table 24 determines which method will control the controller’s hardware
output. 1 is the highest priority and 4 is the lowest priority. For example, now
the project code can know if the output is being controlled by its HOA switch,
by a network binding, or by EC-gfxProgram code. This current priority value is
available to your program code through the block’s Priority port output. See
also Priority levels in LONWORKS (ECL Series).
716 EC-gfxProgram
Controlling a Hardware Output through a structured network vari-
able
The Hardware Output block’s value and mode are available in a number of
structured Network Variable Outputs (NVOs):
• nvoHwOut1_12 contain the values and modes of Hardware Output blocks
1 to 12, according to the actual number of hardware outputs supported by
the controller.
• When ECx-400 Series Extension Module(s) are equipped, nvoHwOutX-
1_1_12 and nvoHwOutX2_1_12 contain the values and modes of Hard-
ware Output blocks 1 to 12 for each ECx-400 Series Extension Module.
The user can read to the Hardware Output values directly through these
NVOs.
The Hardware Output points can be managed in EC-Net as follows:
1. Select the hardware Outputs that are to be overridden by connecting to
the device’s internal points. See EC-Net Platform Support Pack Features
for ECP & ECL Series Controllers.
2. Set the Action for the hardware output. See Internal control points
actions.
To relinquish control, set the Action to AUTO.
A write to this block is made according the highest priority write method
shown in the table below.
Table 24: Output priority
Method Description Priority
No priority The default value. The hardware output is not currently 0
being controlled (no other priority is active).
HOA switch (when equipped) When the controller’s HOA switch is set to either the 1
OFF or MAN positions, the hardware output is
overridden.
EC-gfxProgram 717
Table 24: Output priority
Method Description Priority
Access Method: Write Method: 2
nviModify
1. Set the IntValType to HW_OUTPUT.
2. Set the Index (Block Number: A number from 1 to
16 means the output is on the controller. A number
from 101 to 112 means the output is on ECx-400
Series Extension Module 1, when equipped. A num-
ber from 201 to 212 means the output is on ECx-
400 Series Extension Module 2, when equipped.) to
the Hardware Output number.
3. Set the Mode to Manual.
4. Set the Value (±3.4028×1038) the Hardware Output
block is to provide at its Output according to the
SNVT type set in Change Type (ECP & ECL
Series).
To relinquish control, set the Mode to AUTOMATIC.
Access Method: Write Method: 3
nviHwOutputX Write the value in the NVI.
Where X is the hardware To relinquish control, write the following value the NVI
output number on the according to the SNVT type:
controller to be overridden.
• 163.835 for SNVT_lev_percent.
nviHwOutputX1_X
• -1 in the state field for SNVT_switch.
Where X is the hardware
output number on ECx-400
Series Extension Module 1
to be overridden, when
equipped.
nviHwOutputX2_X
Where X is the hardware
output number on ECx-400
Series Extension Module 2
to be overridden, when
equipped.
EC-gfxProgram The hardware output is under the control of your project 4
code or the EC-gfxProgram interface.
718 EC-gfxProgram
EC-gfxProgram 719
Hardware Output (ECB & ECY Series)
Description Used to interface with a hardware output. Each Hardware Output block is
linked to a corresponding network object which follows the same value as the
Hardware Output block. Units are set in BACnet network properties.
Alarms are available with B-AAC or B-BC controller models only (see the con-
troller’s datasheet for more information).
For ECY Series controllers, alarms that have been configured for this block
can be suppressed by turning off the block’s alarm management so that while
this mechanism is engaged, no alarms will be reported by the block. See
AlarmInhibit input (ECY Series controllers).
Configuration The configuration type that has been selected in the Advanced configuration
Type display window is shown at the bottom of the block as shown below.
Configuration Type
Slim format This block can be collapsed into a slim format. See Collapsed in Common
support block properties.
Number of For ECB Series controllers: The number of Hardware Output block instances
blocks supported by a controller is shown in the Number drop-down list in the Proper-
ties or Statistics panes.
For ECY Series controllers: see Supported number of BACnet objects with an
ECY Series controller.
Advanced Resources Configuration, Advanced configuration, Creating and using enu-
configuration merations (8-Bit), BACnet network properties, Alarms (ECB & ECY Series),
Network Properties Configuration window (ECL, ECB & ECY Series), Emer-
gency override and emergency auto (ECB & ECY Series), Override and auto,
Set Value, Find All References (ECL, ECB & ECY Series), Copy From, Con-
figure Ports, Show/Hide Ports, Creating and using enumerations (8-Bit)
EC-gfxProgram 721
Related blocks Generic Hardware Output (ECB & ECY Series)
Input(s)
Port Type Range Description
Input Digital 0 or 1 Value to be generated at the controller’s
output.
Numeric 0 to 100
Null – For a pulse output, a Null value (ECL, ECB
& ECY Series) must be set at the Input,
otherwise the hardware output will function
as a Digital output.
Priority Integer 1 to 16 For a Commandable value only, the value
at the Input is written at the priority level
specified at this input. If a value is not
linked to this input, the value at the Input is
written into the default priority level. See
Commandable object priority array levels.
OnFor (ECB Numeric 0 to 3.4028 When the Hardware Output is configured
Series ×1038 as a Pulse output, this sets the output pulse
controllers) duration in seconds. To retrigger a pulse
output, there must be a change of value at
this input.
Feedback (B- Digital 0 or 1 When the Hardware Output is configured
AAC & B-BC as a Digital or Pulse (ECB Series
controllers only) controllers only) output and alarms are
enabled for this block, and the value at this
input is different from the present value, this
triggers a notification message. See Alarms
(ECB & ECY Series) to configure the alarm
settings.
722 EC-gfxProgram
Port Type Range Description
Alarm Setpoint Numeric ±3.4028 ×1038 When alarms are enabled for this block
(B-AAC & B-BC (see Alarms (ECB & ECY Series)), a
controllers only) positive input value increases the alarm
setpoint values set in the Resources
Configuration’s Alarms configuration for
the block (a negative value reduces the
alarm setpoint values): The High limit is
now the High limit value (set in the
Resources Configuration’s Alarms
configuration for the block) plus
AlarmSetpoint and the Low limit is now
the Low limit value (set in the Resources
Configuration’s Alarms configuration for
the block) plus AlarmSetpoint. See
Dynamic alarm activation thresholds adjust.
NOTE: When the AlarmSetpoint input is
disconnected, you must reset the
controller (see Project Synchroniza-
tion) or connect a Null value (ECL,
ECB & ECY Series) block to this
port so the controller will release
this port as being unconnected.
When the AlarmSetpoint input is
disconnected, the High limit and
Low limit can be written to through
the BACnet interface.
ResetElapsedAc Digital 0 or 1 When a hardware output is configured as a
tiveTime Digital output, a pulse at this input resets
the timer for the ElapsedActiveTime
output (see below).
ResetChangeOf Digital 0 or 1 When a hardware output is configured as a
StateCount Digital output, a pulse at this input resets
the counter for the ChangeOfStateCount
output (see below).
AlarmInhibit Digital 0 or 1 While set to True(1), no alarms will be
reported by the block. See AlarmInhibit
input (ECY Series controllers).
Output(s)
Port Type Range Description
Output Digital 0 or 1 Effective value of the controller’s output.
Whether the block will output a digital value
Numeric 0 to 100 or a numeric value is dependent on what type
of Signal type is selected in the block’s
Advanced configuration window.
EC-gfxProgram 723
Port Type Range Description
TimeLeft Numeric 0 to 2147318 When the Hardware Output is configured as
a pulse output, this is the remaining time
before the pulse ends, once the pulse has
been triggered by the OnFor input.
Number Integer 1 to 12 The block number. For ECB Series
controllers with one or more ECx-400 Series
Extension Modules connected to it, a Source
/ Module column shows on which connected
device the input is located. For ECY Series
controllers, see Number of resources
supported by a controller. This information is
also shown in the block type and number; see
Block objects description.
OutOfService Digital 0 or 1 See Out-of-Service.
Fault Digital 0 or 1 When a hardware output on an ECx-400
Series Extension module has lost
communications with the controller, this
output is logically True (1), otherwise it is
logically False (0).
Reliability Enum See Description When a hardware output on an ECx-400
Series Extension module has lost
communications with the controller, this
output becomes Communication Failure.
See Reliability property.
Priority Integer 1 to 16 The current active priority for commandable
objects. See Commandable object priority
array levels.
Override Multi State Off The HOA switch’s current position. Manual is
Switcha Value the Hand position.
Auto
Manual
Not available
Override Numeric 0 to 12.5VDC The HOA potentiometer’s current position
Potentiometera (expressed as a voltage).
WARNING: When the HOA switch on the
controller is set to the Man posi-
tion, the potentiometer has an
effective output control range of:
• 0 to 12.5VDC for an output config-
ured as a 0 to 10VDC output.
• 0 to 25mA for an output configured
as a 0 to 20mA output.
724 EC-gfxProgram
Port Type Range Description
Effective Numeric 0 to 100% The actual output voltage or current at the
Outputa hardware output, which represents the value
Digital 0 or 1 of any software generated output or any HOA
override setting.
InAlarm (B-AAC Digital 0 or 1 When Enable Alarms is set for this block and
and B-BC the block is in an alarm state, this output is
controllers only) On (1). See Alarms (ECB & ECY Series) to
configure the alarm settings.
Elapsed Numeric 3.4028×1038 When a hardware output is configured as a
ActiveTime Digital output, this cumulates the time this
(ECY Series value is set to true (1).
controllers only)
ChangeOf Numeric 3.4028×1038 When a hardware output is configured as a
StateCount Digital output, this cumulates the number of
(ECY Series this value’s state changes.
controllers only)
a. Available with HOA-equipped controller outputs – refer to the Hardware
Installation Guide for the controller.
EC-gfxProgram 725
Block properties See also Common block properties.
Property Type Range Default Description
Number Menu See Hardware Use this drop-down menu to select a
Description Output 1 physical electrical output on this
controller. See Number of blocks for
the number of block instances
supported by the current controller
model.
For controllers with one or more ECY-
IO Series or ECx-400 Series
Extension Modules connected to it, a
Source / Module column shows on
which device the input is located. This
information is also shown in the block
type and number; see Block objects
description.
NOTE: When a new block instance is
added to the programming
sheet, the block’s number is
incremented to the next avail-
able block number according
to the current Auto Increment
setting. See Auto increment
(ECP & ECL Series and EBC
Series controllers only) or
Auto increment (ECY Series
controllers only).
Advanced configuration
Configuration parameters for this block are set in the Resources Configura-
tion window allowing this block to operate fans, heating/cooling systems, light-
ing, etc.
NOTE: Certain models of controllers only support a limited number of output
types, that may vary according to the specific hardware output being
configured. See your controller’s datasheet for more information as to
the output types supported by the controller. In all cases, the Signal
interpretation drop-down list (shown below) reflects the available
configuration options and output types supported by a controller’s
hardware output. Refer to the controller’s Hardware Installation Guide
for more details.
Configure this block as follows:
• Adding a Hardware IO extension module (ECY Series)
• Hardware Input and Output numbering scheme
• Adding a Floating Output (ECB & ECY Series)
726 EC-gfxProgram
• Configuring the Output Signal Type (ECB & ECY Series)
Configuring the Output Signal Type (ECB & ECY Series)
In the Resources Configuration tree, the Hardware Outputs branch allows you
to configure a Hardware Output.
Unassigned
The hardware output is unused.
Figure 458: Hardware Output Configuration window - Unassigned
Digital
For B-AAC and B-BC controllers only (see the controller’s datasheet): A com-
mand failure notification message can be triggered when alarms are enabled
for this block, and the value at the Feedback input is not the same as the
present value, this triggers a notification message. See Alarms (ECB & ECY
Series) to configure the alarm settings.
Figure 459: Hardware Output Configuration window - Digital
Parameter Description
Default value This sets the controller’s output to this default value
when:
• The output has not been written to (it is in an unexe-
cuted Conditional Custom Block for example).
• An ECY-IO Series or ECx-400 Series Extension
module has lost communications with the controller.
It assigns a Boolean format to the BACnet object, for
example, On, Off. Click Configure to select the
enumeration to be used to create a new enumeration, or
add a new member to an enumeration. See Creating
and using enumerations (8-Bit).
EC-gfxProgram 727
Parameter Description
Minimum on This sets a temporary override at priority level 6 for the
time minimum amount of time a binary value will be true (1)
when a rising edge is written to this object. See
Commandable object priority array levels.
Minimum off This sets a temporary override at priority level 6 for the
time minimum amount of time a binary value will be false (0)
when a falling edge is written to this object. See
Commandable object priority array levels.
HOA OFF On controllers equipped with HOA switches, when the
threshold potentiometer is set below this threshold, the block’s
(available with EffectiveOutput port will be Off.
HOA equipped
outputs only) NOTE: Leaving a gap between the HOA ON threshold
and the HOA OFF threshold creates a dead-
band range in which varying the potentiometer
will not affect change in the output.
HOA ON On controllers equipped with HOA switches, when the
threshold potentiometer is set above this threshold, the block’s
(available with EffectiveOutput port will be On.
HOA equipped
outputs only)
Reverse action Set this option to invert the output. When this option is
set with outputs equipped with an HOA switch and
potentiometer:
HOA in Auto position: The block’s EffectiveOutput
port will be the software commanded output.
HOA in Off position: The block’s EffectiveOutput port
will be True.
HOA in On position and the potentiometer is set
above the HOA On Threshold: The block’s
EffectiveOutput port will be False.
HOA in On position and the potentiometer is set
below the HOA Off Threshold: The block’s
EffectiveOutput port will be True.
HOA in On position and the potentiometer is set
between the HOA Off Threshold and HOA On
Threshold: This is a dead-band range in which varying
the potentiometer will not affect change in the block’s
EffectiveOutput.
728 EC-gfxProgram
Parameter Description
Output mode The operating mode of certain controller outputs can be
configured as a triac output or as a universal output
(DUO).
24 VAC: Externally-powered triac mode.
12 VDC: Universal output mode.
See the controller’s hardware installation guide for wiring
and safety information for this output.
WARNING: Selecting the wrong output mode may pro-
duce unexpected behaviour resulting in
equipment dammage. For example, when
the output mode is 12 VDC and the control-
ler’s output is wired to a 24 VAC relay, the
relay may oscillate as 12 VDC is not enough
voltage to keep the relay energized.
PWM
Figure 460: Hardware Output Configuration window - PWM
Parameter Description
Minimum The minimum duty cycle that is allowed for PWM
outputs. The input range to the block is 0 to 100;
therefore the Minimum corresponds to the output duty
cycle when the block’s input is at 0.
Maximum The maximum duty cycle that is allowed for PWM
outputs. The input range to the block is 0 to 100;
therefore the Maximum corresponds to the output duty
cycle when the block’s input is at 100.
EC-gfxProgram 729
Parameter Description
Default value This sets the controller’s output to this default value
when:
• The output has not been written to (it is in an unex-
ecuted Conditional Custom Block for example).
• An ECY-IO Series or ECx-400 Series Extension
module has lost communications with the control-
ler.
Period Used to specify the PWM period for individual outputs
set to PWM signal type. Lowering the default value will
result in a faster response and will provide a more
stable temperature when using perimeter heating.
However, it must be ensured that the PWM period is
not too low (fast cycling time) for the type of equipment
used.
Cool down time Thermal actuators take time to cool off before the
actuator starts to return its resting position. The cool-
down time is usually specified in the thermal actuator’s
datasheet. Once the cool down time has expired, the
controller will initiate a warm up cycle defined by the
Warm up time parameter.
Figure 461: Thermal Actuator Opening and Closing Times
Example
Set this value to zero if a thermal actuator is not being
used with this output.
730 EC-gfxProgram
Parameter Description
Warm up time Thermal actuators take time to warm up before the
actuator starts to activate and respond to a control
signal. The warm-up time is usually specified in the
thermal actuator’s datasheet.
Set this value to zero if a thermal actuator is not being
used with this output.
NOTE: During warm up, the output will be continuously
on (no PWM signal modulation) to heat the
thermal actuator and make it controllable as
quick as possible.
Only once the cool down time has expired can
the warm up period become active.
The warm up and cool down times required by
a thermal actuator is dependent on the ambient
temperature of the environment in which the
thermal actuator is located.
Reverse action Set this option to invert the output. When this option is
set with outputs equipped with an HOA switch and
potentiometer:
HOA is in Auto position: The block’s EffectiveOutput
port will be the software commanded output.
HOA is in Off position and the potentiometer is set
to a voltage less than 3 volts: The block’s
EffectiveOutput port will be the Maximum set above.
HOA in On position and the potentiometer is set to
a voltage greater than or equal to 3 volts: The
block’s EffectiveOutput port will be Minimum as set
above.
HOA in On position and the potentiometer is set to
a voltage less than 3 volts: The block’s
EffectiveOutput port will be Maximum as set above.
EC-gfxProgram 731
Parameter Description
Output mode The operating mode of certain controller outputs can be
configured as a triac output or as a universal output
(DUO).
24 VAC: Externally-powered triac mode.
12 VDC: Universal output mode.
See the controller’s hardware installation guide for
wiring and safety information for this output.
WARNING: Selecting the wrong output mode may pro-
duce unexpected behaviour resulting in
equipment dammage. For example, when
the output mode is 12 VDC and the con-
troller’s output is wired to a 24 VAC relay,
the relay may oscillate as 12 VDC is not
enough voltage to keep the relay ener-
gized.
Analog 0 - 10V
Figure 462: Hardware Output Configuration window - Analog 0 to 10V
Parameter Description
Minimum The minimum value that is allowed for Analog outputs.
The input range to the block is 0 to 100; therefore the
Minimum corresponds to the output value when the
block’s input is at 0.
Maximum The maximum value that is allowed for Analog outputs.
The input range to the block is 0 to 100; therefore the
Maximum corresponds to the output value when the
block’s input is at 100.
732 EC-gfxProgram
Parameter Description
Default value This sets the controller’s output to this default value
when:
• The output has not been written to (it is in an unex-
ecuted Conditional Custom Block for example).
• An ECY-IO Series or ECx-400 Series Extension
module has lost communications with the control-
ler.
Reverse action Set this option to invert the output. When this option is
set with outputs equipped with an HOA switch and
potentiometer:
HOA is in Auto position: The block’s EffectiveOutput
port will be the software commanded output according
to the range limits (Minimum and Maximum) as set
above.
HOA is in Off position: The block’s EffectiveOutput
port will be the Maximum as set above.
HOA in On position: The block’s EffectiveOutput port
varies inversely to the potentiometer’s position
according to the range limits (Minimum and
Maximum) as set above.
Analog 0 - 20mA
Figure 463: Hardware Input Configuration window - Analog 0 to 20mA
Parameter Description
Minimum The minimum value that is allowed for Analog outputs.
The input range to the block is 0 to 100; therefore the
Minimum corresponds to the output value when the
block’s input is at 0.
Maximum The maximum value that is allowed for Analog outputs.
The input range to the block is 0 to 100; therefore the
Maximum corresponds to the output value when the
block’s input is at 100.
EC-gfxProgram 733
Parameter Description
Default value This sets the controller’s output to this default value
when:
• The output has not been written to (it is in an unex-
ecuted Conditional Custom Block for example).
• An ECY-IO Series or ECx-400 Series Extension
module has lost communications with the control-
ler.
Reverse action Set this option to invert the output. When this option is
set with outputs equipped with an HOA switch and
potentiometer:
HOA is in Auto position: The block’s EffectiveOutput
port will be the software commanded output according
to the range limits (Minimum and Maximum) as set
above.
HOA is in Off position: The block’s EffectiveOutput
port will be the Maximum as set above.
HOA in On position: The block’s EffectiveOutput port
varies inversely to the potentiometer’s position
according to the range limits (Minimum and
Maximum) as set above.
Pulse
This creates a pulse output for a duration set by the OnFor input. The Input
must be set to Null to enable this feature; otherwise the hardware output will
function as a Digital output.
Figure 464: Hardware Output Configuration window - Pulse
734 EC-gfxProgram
Parameter Description
Default value This sets the controller’s output to this default value
when:
• The output has not been written to (it is in an unex-
ecuted Conditional Custom Block for example).
• An ECY-IO Series or ECx-400 Series Extension
module has lost communications with the control-
ler.
Reverse action Set this option to invert the output.
Led Output (ECP Series)
Description Used to interface with the LED output on ECP Series VAVS controllers. This
output is usually used to control an LED on a sensor to indicate an override or
any other type of condition.
Controller Programmable ECP Series VAVS controllers.
support
Input(s)
Port Type Range Description
Input Digital 0 or 1 Value of the output.
Output(s) N/A
Block properties See Common block properties.
EC-gfxProgram 735
Light Output (ECL Series expansion modules)
Description Used to interface to a light output of a light expansion module that is con-
nected to a controller’s subnetwork bus. This block is only available with con-
troller models that support this expansion module. There are two types of light
expansion modules: one that supports dimming, and another that has on/off
outputs.
Number of The number of light outputs varies according to the number of connected light
blocks modules, up to a maximum of 8 light outputs. See the controller’s datasheet
for more information about the number / combinations of expansion modules
that are supported.
Each light expansion module also has 4 multi-level inputs. See Light Sunblind
Input (ECL Series expansion modules).
Advanced Resources Configuration, Managing Light and Sunblind module instances,
configuration Manage Light and Sunblind Modules window, Light and Sunblind module con-
figuration, Network Properties Configuration window (ECL, ECB & ECY
Series), Find All References (ECL, ECB & ECY Series), Copy From, Config-
ure Ports
Related blocks Sunblind Output (ECL Series expansion module), Light Sunblind Input (ECL
Series expansion modules)
Input(s)
Port Type Range Description
Input Numeric 0 to 100% Used with the Function port. See below. The block
(module has uses a digital value or a numeric value according
dimming to the type of expansion module used.
outputs)
See Managing Light and Sunblind module
Digital 0 or 1 (module instances, Manage Light and Sunblind Modules
has on/off window, and Light and Sunblind module
outputs) configuration.
736 EC-gfxProgram
Port Type Range Description
Function Enum Nul (-1) Sets the light output action.
For light Off (0) Nul (-1): Frees the current value to enable the
outputs that default value regardless of the input value. See
On (1)
support Configure the Light Output to set the default value.
dimming Down (2)
Off (0): Turn off the light, regardless of the input
Up (3) value.
Stop (4) On (1): Turn on the light, regardless of the input
value.
State (5)
Down (2): This is activated only when there is a
change of Function value or the Trigger input is
activated.
• When set to Down, the value at the Input port
sets the step decrease to be commanded at
the expansion module’s output. For example,
if the light output is at 50% and the Input port
value is 15%, setting the Function input to
Down will decrease the light output to 35%
(50-15).
• When set to Down and the value at the Input
port is Nul, the light output will ramp down until
this input is set to Stop or it reaches 0%.
Up (3): This is activated only when there is a
change of Function value or the Trigger input is
activated.
• When set to Up, the value at the Input port
sets the step increase to be commanded at
the expansion module’s output. For example,
if the light output is at 50% and the Input port
value is 15%, setting the Function input to Up
will increase the light output to 65% (50+15).
• When set to Up and the value at the Input
port is Nul, the light output will ramp up until
this input is set to Stop or it reaches 100%.
Stop (4): Stops any ramp function.
State (5): When set to State, the value at the
Input port sets the light level to be commanded at
the expansion module’s output.
EC-gfxProgram 737
Port Type Range Description
Function Enum Nul (-1) Sets the light output action.
For On/Off Off (0) Nul (-1): Frees the current value to enable the
light outputs default value regardless of the input value. See
On (1)
Configure the Light Output to set the default value.
Down (2)
Off (0): Turn off the light, regardless of the input
Up (3) value.
Stop (4) On (1): Turn on the light, regardless of the input
value.
State (5)
Down (2): When set to Down, this has no effect.
Up (3): When set to Up, this has no effect.
Stop (4): When set to Stop, this has no effect.
State (5): When set to State, the output is On
when the Input port value is 1 and Off when the
Input port value is 0.
Dimming Digital 0 or 1 Used to enable or disable the Fade time set in the
Disabled Advanced Properties. See Configure the Light
Output. When used with a light module that
For light
supports dimming:
outputs that
support 0: Changes in input value are made according to
dimming the Fade time set in the Advanced Properties.
1: Sets the Fade time to zero. The output value
immediately follows any change to the input value.
Trigger Digital 0 or 1 Forces a write action of the current block’s Input
value to the expansion module’s hardware. This is
necessary when you want to force the execution
of the same command again when there is no
change of value at the Function input.
For example, to decrease the light output by 10%
and then later again by 10%, proceed as follows:
Set the Input port to 10% and the Function input
to Down, then set the Trigger input to 1 to again
push the change to expansion module’s output.
738 EC-gfxProgram
Output(s)
Port Type Range Description
Output Digital 0 or 1 Effective value of the controller’s output. The
block will output a digital value or a numeric
Numeric 0 to 100% value according to the type of expansion module
used. See Managing Light and Sunblind module
instances, Manage Light and Sunblind Modules
window, and Light and Sunblind module
configuration.
Feedback Digital 0 or 1 Actual light output value. This takes into account
any user command from a remote control.
Numeric 0 to 100%
Runtime Numeric 0 to 7.158× 107 The output’s On time (operating time) in
minutes. This is useful to know how many hours
a lamp has been used (for example, to be used
as part of a preventive maintenance program).
This value can be set (or reset to zero) by
writing the new value through the nviRunHours
network variable.
Number Integer 1 to 8 The current block number. This is set through
Number in the Block’s Properties pane.
OutOfService Digital 0 or 1 See Out-of-Service.
Fault Digital 0 or 1 This is logically True (1) if the Reliability
property does not have a value of No Fault
Detected, otherwise logical False (0).
Reliability Enum See When communication to the expansion module
Description is lost, this becomes Communication Failure.
If the configuration does not match the current
device, this becomes Configuration Error.
Otherwise this is No Fault Detected.
DaliFault Digital 0 or 1 This is logically True (1) if the DaliReliability
Property does not have a value of No Fault
Detected, otherwise logical False (0).
Dali Reliability Enum 0 to 5 The current reliability of the corresponding DALI
bus.
0 = No fault detected: No other fault
(enumerated below) has been detected.
1 = Lamp failure
2 = No ballast detected
3 = Shorted DALI bus
4 = Communication failure
5 = Not available
EC-gfxProgram 739
Port Type Range Description
Priority Integer 0 to 4 The current active priority. See Priority levels in
LONWORKS (ECL Series).
Block properties
Property Type Range Default Description
Number Menu See Light The Light Output block instance.
Description Output 1 Click the drop-down arrow to open
the Managing Light and Sunblind
module instances window, in which
you first add light and sunblind
modules by clicking Manage Light
and Sunblind Modules. See
Figure 501.
Once the light output expansion
modules have been added to the
controller, the Source column
shows the sunblind expansion
module on which the output is
located. Use this drop-down menu
to select a physical light output on a
connected expansion module.
The number of Light Output block
instances supported by a controller
is shown in the Statistics pane.
Advanced Configuration parameters for this block are set in the Resources Configura-
configuration tion window. See Managing Light and Sunblind module instances, Manage
Light and Sunblind Modules window, and Light and Sunblind module configu-
ration.
740 EC-gfxProgram
Light Output (ECB & ECY Series expansion mod-
ules)
Description Used to interface to a light output of a light expansion module that is con-
nected to a controller’s subnetwork bus. This block is only available with con-
troller models that support this expansion module. There are two types of light
expansion modules: one that supports dimming, and another that has on/off
outputs.
For ECY Series controllers, alarms that have been configured for this block
can be suppressed by turning off the block’s alarm management so that while
this mechanism is engaged, no alarms will be reported by the block. See
AlarmInhibit input (ECY Series controllers).
Number of The number of light outputs varies according to the number of connected light
blocks modules, up to a maximum of 8 light outputs. See the controller’s datasheet
for more information about the number / combinations of expansion modules
that are supported.
Each light expansion module also has 4 multi-level inputs. See Light Sunblind
Input (ECB & ECY Series expansion modules).
Advanced Resources Configuration, Manage Managing Light and Sunblind module
configuration instances, Manage Light and Sunblind Modules window, Light and Sunblind
module configuration, Network Properties Configuration window (ECL, ECB &
ECY Series), Find All References (ECL, ECB & ECY Series), Copy From,
Configure Ports, Alarms (ECB & ECY Series)(ECY Series only)
Related blocks Sunblind Output (ECB & ECY Series expansion module), Light Sunblind Input
(ECB & ECY Series expansion modules)
EC-gfxProgram 741
Input(s)
Port Type Range Description
Input Numeric 0 to 100% Used with the Function port. See below. The
(module has block uses a digital value or a numeric value
dimming outputs) according to the type of expansion module
used.
Digital 0 or 1 (module
has on/off See Managing Light and Sunblind module
outputs) instances, Manage Light and Sunblind
Modules window, and Light and Sunblind
module configuration.
742 EC-gfxProgram
Port Type Range Description
Function Enum Nul (1) Sets the light output action.
For light Off (2) Nul (1): Free the current priority set at the
outputs that Priority input.
On (3)
support
Off (2): Turn off the light, regardless of the
dimming Down (4)
input value.
Up (5)
On (3): Turn on the light, regardless of the
Stop (6) input value.
State (7) Down (4): This is activated only when there is
a change of Function value or the Trigger
input is activated.
• When set to Down, the value at the Input
port sets the step decrease to be com-
manded at the expansion module’s out-
put. For example, if the light output is at
50% and the Input port value is 15%, set-
ting the Function input to Down will
decrease the light output to 35% (50-15).
• When set to Down and the value at the
Input port is Nul, the light output will ramp
down until this input is set to Stop or it
reaches 0%.
Up (5): This is activated only when there is a
change of Function value or the Trigger input
is activated.
• When set to Up, the value at the Input
port sets the step increase to be com-
manded at the expansion module’s out-
put. For example, if the light output is at
50% and the Input port value is 15%, set-
ting the Function input to Up will increase
the light output to 65% (50+15).
• When set to Up and the value at the Input
port is Nul, the light output will ramp up
until this input is set to Stop or it reaches
100%.
Stop (6): Stops any ramp function.
State (7): When set to State, the value at the
Input port sets the light level to be
commanded at the expansion module’s
output.
EC-gfxProgram 743
Port Type Range Description
Function Enum Nul (1) Sets the light output action.
For On/Off light Off (2) Nul (1): Free the current priority set at the
outputs Priority input.
On (3)
Off (2): Turn off the light, regardless of the
Down (4)
input value.
Up (5)
On (3): Turn on the light, regardless of the
Stop (6) input value.
State (7) Down (4): When set to Down, this has no
effect.
Up (5): When set to Up, this has no effect.
Stop (6): When set to Stop, this has no effect.
State (7): When set to State, the output is On
when the Input port value is 1 and Off when
the Input port value is 0.
Dimming Digital 0 or 1 Used to enable or disable the Fade time set in
DisabledFor the Advanced Properties. See Configure the
light outputs Light Output. When used with a light module
that support that supports dimming:
dimming
0: Changes in input value are made according
to the Fade time set in the Advanced
Properties.
1: Sets the Fade time to zero. The output
value immediately follows any change to the
input value.
Priority Integer 1 to 16 The value at the Input is written at the priority
level specified at this input. If a value is not
linked to this input, the value at the Input is
written into the default priority level. See
Commandable object priority array levels.
Trigger Digital 0 or 1 Forces a write action of the current block’s
Input value to the expansion module’s
hardware. This is necessary when you want to
force the execution of the same command
again when there is no change of value at the
Function input.
For example, to decrease the light output by
10% and then later again by 10%, proceed as
follows: Set the Input port to 10% and the
Function input to Down, then set the Trigger
input to 1 to again push the change to
expansion module’s output.
744 EC-gfxProgram
Port Type Range Description
AlarmInhibit Digital 0 or 1 While set to True(1), no alarms will be
reported by the block. See AlarmInhibit input
(ECY Series controllers).
Color Numeric 1.17549x10-38 to Only available on ECY controllers. Manages
16777216 (for the light color for a lighting module that sup-
RGB or RGBW); ports the DALI Type 8 Command. If the color
15 K to 1,000, management type is Tunable White, this input
000 K (for Tun- should be linked to a value that represents the
able White) color temperature rating in kelvins (K). If the
color management type is RGB or RGBW, this
input should be linked to a specific encoded
value generated by a Color Encoder block.
See Color Encoder.
Output(s)
Port Type Range Description
Output Digital 0 or 1 Effective value of the controller’s output. The
block will output a digital value or a numeric
Numeric 0 to 100% value according to the type of expansion
module used. See Managing Light and
Sunblind module instances, Manage Light and
Sunblind Modules window, and Light and
Sunblind module configuration.
Feedback Digital 0 or 1 Actual light output value. This takes into
account any user command from a remote
Numeric 0 to 100% control.
Runtime Numeric 0 to 7.158 × 107 The output’s On time (operating time) in
minutes. This is useful to know how many
hours a lamp has been used (for example, to
be used as part of a preventive maintenance
program).
This value can be set (or reset to zero) by
writing the new value through the Runtime
network property.
Number Integer 1 to 8 The current block number. This is set through
Number in the Block’s Properties pane.
OutOf Service Digital 0 or 1 See Out-of-Service.
Fault Digital 0 or 1 This is logically True (1) if the Reliability
property does not have a value of No Fault
Detected, otherwise logical False (0).
EC-gfxProgram 745
Port Type Range Description
Reliability Enum See Description When communication to the expansion
module is lost, this becomes Communication
Failure. If the configuration does not match
the current device, this becomes
Configuration Error. Otherwise this is No
Fault Detected.
DaliFault Digital 0 or 1 This is logically True (1) if the DaliReliability
Property does not have a value of No Fault
Detected, otherwise logical False (0).
Dali Reliability Enum 0 to 5 The current reliability of the corresponding
DALI bus.
0 = No fault detected: No other fault
(enumerated below) has been detected.
1 = Lamp failure
2 = No ballast detected
3 = Shorted DALI bus
4 = Communication failure
5 = Not available
Priority Integer 1 to 16 The current active priority for commandable
objects. See Commandable object priority
array levels.
746 EC-gfxProgram
Block properties
Property Type Range Default Description
Number Menu See Description Light The Light Output block instance.
Output 1 Click the drop-down arrow to
open the Managing Light and
Sunblind module instances
window, in which you first add
light and sunblind modules by
clicking Manage Light and
Sunblind Modules. See Figure
518.
Once the light output expansion
modules have been added to the
controller, the Source column
shows the sunblind expansion
module on which the output is
located. Use this drop-down
menu to select a physical light
output on a connected expansion
module.
The number of Light Output block
instances supported by a
controller is shown in the
Statistics pane.
Advanced Configuration parameters for this block are set in the Resources Configura-
configuration tion window. See Managing Light and Sunblind module instances, Manage
Light and Sunblind Modules window, and Light and Sunblind module configu-
ration.
Light Sunblind Input (ECL Series expansion mod-
ules)
Description Used to interface with a Light or Sunblind expansion module’s hardware input.
Each Light Sunblind Input block is linked to a corresponding network object
which follows the same value as the Light Sunblind Input block.
Number of 4 per light / sunblind expansion module.
blocks
EC-gfxProgram 747
Advanced Resources Configuration, Advanced configuration, Network Properties Con-
configuration figuration window (ECL, ECB & ECY Series), Find All References (ECL, ECB
& ECY Series), Copy From, Configure Ports
Input(s) N/A
Output(s)
Port Type Range Description
Output Enum Off (0) Block output.
On (1) Off: The hardware input is open-circuit.
Pulse (2) On: The hardware input is short-circuited.
Pulse: A momentary contact at the hardware input
that lasts for less than 200ms.
Number Integer – The block number.
OutOfService Digital 0 or 1 See Out-of-Service.
Fault Digital 0 or 1 This is logically True (1) if the Reliability property
does not have a value of No Fault Detected,
otherwise logical False (0).
Reliability Enum See When communication to the expansion module is
Description lost, this becomes Communication Failure. If the
output has not been written to (it is in an unexecuted
Conditional Custom Block for example), this
becomes Unreliable Other. Otherwise this is No
Fault Detected.
748 EC-gfxProgram
Block properties See also Common block properties.
Property Type Range Default Description
Number Menu See Light The block number. The number of
Description Sunblind Light Sunblind Input block instances
Input 1 supported by a controller is shown
in this drop-down list (4 per light /
sunblind expansion module) or in
the Statistics pane. Use this drop-
down menu to select a physical
Light Sunblind Input on a connected
expansion module.
NOTE: When a new block instance
is added to the program-
ming sheet, the block’s
number is incremented to
the next available block
number according to the
current Auto Increment set-
ting. See Auto increment
(ECP & ECL Series and
EBC Series controllers
only).
Advanced Configuration parameters for this block are set in the Resources Configura-
configuration tionwindow. See Managing Light and Sunblind module instances, Manage
Light and Sunblind Modules window, and Light and Sunblind module configu-
ration.
Light Sunblind Input (ECB & ECY Series expansion
modules)
Description Used to interface with a Light or Sunblind expansion module’s hardware input.
Each Light Sunblind Input block is linked to a corresponding network object
which follows the same value as the Light Sunblind Input block.
For ECY Series controllers, alarms that have been configured for this block
can be suppressed by turning off the block’s alarm management so that while
this mechanism is engaged, no alarms will be reported by the block. See
AlarmInhibit input (ECY Series controllers).
EC-gfxProgram 749
Number of 4 per light / sunblind expansion module.
blocks
Advanced Resources Configuration, Advanced configuration, Network Properties Con-
configuration figuration window (ECL, ECB & ECY Series), Find All References (ECL, ECB
& ECY Series), Copy From, Configure Ports, Alarms (ECB & ECY Series)
(ECY Series only)
Input(s) N/A
Output(s)
Port Type Range Description
Output Enum Off (1) Block output.
On (2) Off: The hardware input is open-circuit.
Pulse (3) On: The hardware input is short-circuited.
Pulse: A momentary contact at the hardware input
that lasts for less than 200ms.
The output enumeration is set in the Enumeration
parameter selected in the block’s configuration
window. See Configure a Light Sunblind Hardware
Input.
Number Integer – The block number.
OutOfService Digital 0 or 1 See Out-of-Service.
Fault Digital 0 or 1 This is logically True (1) if the Reliability property
does not have a value of No Fault Detected,
otherwise logical False (0).
Reliability Enum See When communication to the expansion module is
Description lost, this becomes Communication Failure. If the
output has not been written to (it is in an unexecuted
Conditional Custom Block for example), this
becomes Unreliable Other. Otherwise this is No
Fault Detected.
AlarmInhibit Digital 0 or 1 While set to True(1), no alarms will be reported by
the block. See AlarmInhibit input (ECY Series
controllers).
750 EC-gfxProgram
Bock properties See also Common block properties.
Property Type Range Default Description
Number Menu See Light Sunblind The block number. The number of
Description Input 1 Light Sunblind Input block instances
supported by a controller is shown
in this drop-down list (4 per light /
sunblind expansion module) or in
the Statistics pane. Use this drop-
down menu to select a physical
Light Sunblind Input on a connected
expansion module.
NOTE: When a new block instance
is added to the program-
ming sheet, the block’s
number is incremented to
the next available block
number according to the
current Auto Increment set-
ting. See Auto increment
(ECP & ECL Series and
EBC Series controllers only)
or Auto increment (ECY
Series controllers only).
Advanced Configuration parameters for this block are set in the Resources Configura-
configuration tion window. See Managing Light and Sunblind module instances, Manage
Light and Sunblind Modules window, and Light and Sunblind module configu-
ration.
M-Bus Device (ECY Series)
Description Provides an interface to an M-Bus device with controllers that support com-
munication with M-Bus devices. Depending on the points that you create, the
number and type of block inputs and outputs will vary.
Slim format This block can be collapsed into a slim format. See Collapsed in Common
support block properties.
EC-gfxProgram 751
Number of The number of M-Bus Devices varies according to the number of connected
blocks devices, up to a maximum of 60 devices on an ECY-MBUS module equipped
on an ECY-S1000 and 3 devices on ECY-MBUS module connedted to an
ECY-PT/U, ECY-VAV, or ECY-303 via USB. See the ECLYPSE Communica-
tion Modules datasheet for more information about the number/combinations
of M-Bus Devices that are supported.
Advanced Resources Configuration, Discovering M-Bus Devices from the network,
configuration Alarms (ECB & ECY Series), Emergency override and emergency auto (ECB
& ECY Series), Override and auto, Set Value, Find All References (ECL, ECB
& ECY Series), Copy From, Configure Ports, Show/Hide Ports
Input(s)
Port Type Range Description
Trigger - - Triggers a polling of all of the device’s points.
Outputs The output ports made available depend on the M-Bus device configuration
for the device. See the M-Bus device’s documentation for more information
about the units, data types, and range of values supported by the device.
Port Type Range Description
[Output] - - The current M-Bus device point state / value, where
[Output] stands for the point’s name.
[Output].Stat Enum The current M-Bus device point status / exception code,
us where [Output] stands for the point’s name. This can
provide diagnostic information about the current M-Bus
device operation.
[Output]. Digital 0 or 1 Outputs a pulse when the output point value has been
Update updated. [Output] stands for the point’s name.
Block properties See also Common block properties.
Property Type Range Default Description
Number Menu See M-Bus Device 1 Use this drop-down menu to
Description select a M-Bus device connected
to this controller. The number of
devices supported by a controller
is shown in this drop-down list or
in the Statistics pane.
Discovering M-Bus Devices from the network
Connected M-Bus devices are discovered in the Resources Configuration
window. To add M-Bus devices and assign them to M-Bus Device blocks, pro-
ceed as follows.
752 EC-gfxProgram
1. In the Home ribbon, click Open Configuration.
2. In the Resources Configuration window, right-click M-Bus Devices and
click Discover Devices.
3. In the M-Bus Device Selector window, click to access
the Discovery Parameters window where you can define your discovery
criteria.
Parameter Description
Discovery mode Primary: Limits the discovery to the primary
address of the devices on the network. This can
speed up the discovery process. However, if two or
more devices on the network have the same
primary address, the discovery will fail for the
devices that have the same address.
Secondary: Uses both the secondary address and
manufacturer ID to discover devices on the
network. Note that this mode can be time-
consuming.
Meter Address The discovery will be limited to meters with an
Low and High address that falls within the specified low and high
limits.
Communications The communication speeds of the meters to
Speeds discover. It is recommended to choose only the
communication speeds of the devices you want to
discover, since adding speeds can slow down the
discovery process.
NOTE: If the selected baud rate does not corre-
spond to the M-Bus device’s communica-
tion speed, the communication will fail for
these devices.
Clear Device Meters that were previously discovered are kept in
Cache the device’s cache and are not removed from the
list unless the device is rebooted or a new
discovery is performed with this option checked.
EC-gfxProgram 753
4. All discovered M-Bus devices are listed. Select the desired device or
devices, and click OK.
The selected M-Bus Devices will appear in the Resource Tree.
754 EC-gfxProgram
5. To add points to the device:
• Right-click Points under the device and select Add to manually add
points to the device. See Manually adding points to an M-Bus Device
for more information.
• Right-click Points under the device and select Discover Points to
discover the points from the netwrok. See Manually adding points to
an M-Bus Device for more information.
6. From the Toolbox, drag an M-Bus Device block on the programming
sheet.
7. Select the M-Bus Device block on the programming sheet and in the
block’s Properties, click the drop-down arrow for Number. This block
instance will use the M-Bus Device selected in this window.
Manually adding M-Bus Devices
You can plan a project in advance, before you connect to the physical M-Bus
network. In that context, you can add devices and either apply a pre-existing
template to them, or manually create points to represent the features you
need to create your logic.
To add a new device, proceed as follows:
1. In the Home ribbon, click Open Configuration.
EC-gfxProgram 755
2. In the Resources Configuration window, right-click M-Bus Devices and
select Add.
Configuring the Configure the M-Bus Device as follows in the Resources Configuration win-
M-Bus Device dow. Note that most M-Bus configuration parameters are filled in automati-
cally when select a device on the network or when you discover devices.
Parameter Description
Speed The communication speed of the M-Bus device.
Polling period Polling makes a request to the M-Bus device to provide
a value at a regular time interval. Should the value
change immediately after the value was polled, the
update will occur only when the device is polled again.
The polling period should not be set too low as this can
create excessive network traffic. Also, some M-Bus
models will no longer provide updates after a given
number of requests per day.
756 EC-gfxProgram
Parameter Description
Addressing Primary: Only the primary address of the M-Bus device
mode is specified. This addressing mode will only work if
there is only one device with the configured address.
Full: When devices are in Full addressing mode, their
Primary and Secondary addresses, and Manufacturer
ID, must all be filled for communication to work
properly.
Primary Address The M-Bus device’s primary address on the network.
When the device’s addressing mode is Full, the
primary address can be changed if the Secondary
Address and Manufacturer ID are properly filled.
Secondary The M-Bus device’s secondary address on the
Address network.
When the connection cannot be established with the
device via the primary address, it is attempted via the
secondary address and manufacturer ID.
In the event that the connection is established via the
secondary address, the primary address is
automatically overridden.
Manufacturer ID A number identifying the M-Bus device’s manufacturer.
This information is filled in automatically when a device
is discovered or selected on the network.
This ID is used when the communication with the
device failed via the primary address and is attempted
via the device’s secondary address.
EC-gfxProgram 757
Manually adding 1. Right-click Points under the device to which you want to add points and
points to an M- select Add.
Bus Device 2. Specify the following parameters for the point:
Parameter Description
Name The name used to identify the point in the block’s ports.
If you leave the initial value, a default name will be
assigned to the point when you specify the unit (e.g.,
Volume_gal when you select the gal unit). The name is
not updated if you modified it before changing the unit.
Function Allows you to choose whether the point will return the
Current value, the Maximum value, the Minimum value,
or the Error value.
Tariff Allows you to select a value that supports various
tariffs, for billing purposes.
Storage Number Allows you to select different values from a table of
values where all other entries are identical.
Device Sub Unit For meters that have two sensors, can be used to
choose which sensor will be used.
VIF Allows you to specify the Value Information Field for the
point.
NOTE: This information is usually provided in the man-
ufacturer’s specifications.
758 EC-gfxProgram
Parameter Description
VIFE Allows you to specify the Value Information Field
Extension for points that require an extension code, or
are manufacturer-specific.
NOTE: This information is usually provided in the man-
ufacturer’s specifications.
Unit Indicates the units measured by the M-Bus device
(e.g., Wh, oC, m³/min, bar, kg, m³, etc.).
NOTE: The oC, oF, day, and W units require additional
information for the proper point to be read. A
field where you can select that information will
appear when you select one of these units.
Selecting the no-unit value allows you to configure a
point that has no unit of measurement, such as Access
Number, Medium, Manufacturer, etc.
Multiplier Allows you to specify the multiplier for points that
require an extension code, or are manufacturer-
specific.
NOTE: This information is usually provided in the man-
ufacturer’s specifications.
Discovering 1. Right-click Points under the device to which you want to add points and
points select Discover Points.
2. In the M-Bus Device Selector window, click to discover
the points available on the M-Bus device.
The discovered points will remain in the ECLYPSE controller’s cache until
it is rebooted. If you re-open this window after a discovery was done, the
cached points will be listed. To refresh the list, click .
3. Select the points you want to add and click OK.
EC-gfxProgram 759
4. The selected Points will appear under the device in the Resource Tree
with their configuration already filled in.
760 EC-gfxProgram
Saving an M-Bus Once you have fully configured your M-Bus device, you can save the configu-
Device ration as a template that you can then apply to other M-Bus devices in this
configuration as project or in other projects. Proceed as follows:
a template
1. Right-click the device to use as a template and select Save as Device
Template.
2. Name your template and select the location where you want to save it.
Click OK.
NOTE: To modify an existing template, specify its exact identifier in the Save
As M-Bus Device Template window, and click Yes to replace the exist-
ing template.
Applying a saved Templates are provided for most M-Bus device models. You can also save
configuration to your own configurations as device templates (see above). To apply a template
a device to a device, proceed as follows:
1. Right-click an M-Bus device and select Load Device Template.
2. Select the M-Bus template you want to apply to the device. Click OK.
EC-gfxProgram 761
NOTE: You can right-click any M-Bus device template in the list to open the
file’s location. This can be useful to create backup copies of a project’s
device templates.
Selecting To automatically fill a device’s Primary and Secondary address, and Manufac-
devices on the turer ID:
network
1. Select a device in the resource tree of the Resources Configuration win-
dow.
2. Click the Select Device link to access the M-Bus Device Selector win-
dow.
3. Select a device and click OK.
762 EC-gfxProgram
4. The device’s M-Bus configuration parameter will be initialized with the
parameters from the selected device.
5. Repeat as needed to select all devices in the project.
EC-gfxProgram 763
Modbus Device (ECY Series)
Description Provides an interface to a Modbus device with controllers that support com-
munication with Modbus devices. Depending on the points that you create,
the number and type of block inputs and outputs will vary.
Advanced Resources Configuration, Configuring a Modbus resource.
configuration
Input(s) The input ports made available depend on the type of Modbus device con-
nected to the controller and the configuration for the device. See Configuring
a Modbus resource. See the Modbus device’s documentation for more infor-
mation about the units, data types, and range of values supported by the
Modbus device. {Output} and {Input} are names you assign to a Modbus con-
trol point in the Modbus device configuration - see Adding a Modbus control
point.
Port Type Range Description
{Output} - - Set the Modbus device’s output state / value.
{Output}. Digital 0 or 1 A rising pulse forces a write action of the corresponding
Trigger block’s {Output} value to the Modbus device.
{Input}. Trig- Digital 0 or 1 A rising pulse forces a read action of the corresponding
ger block’s {Input} value from the Modbus device.
Output(s) The output ports made available depend on the type of Modbus device con-
nected to the controller and the configuration for the device. See Configuring
a Modbus resource. See the Modbus device’s documentation for more infor-
mation about the units, data types, and range of values supported by the
Modbus device.
Port Type Range Description
{Input} - - The current Modbus device’s input state / value.
{Input}.Status Enum 1 to 143 The current Modbus input point status / exception code.
This can provide diagnostic information about the cur-
rent Modbus device operation.
{Input}. Digital 0 or 1 Outputs a pulse when the input point is read according
Update to the sampling frequency set in the point’s Update
interval configuration.
764 EC-gfxProgram
Block properties See also Common block properties.
Property Type Range Default Description
Number Menu See Light Out- The number of Modbus Device block
Description put 1 instances is limited by the number of Mod-
bus devices supported by the controller’s
licencing. See the controller’s datasheet
for more information.
Configuring a Certain controller models support communication with Modbus devices - see
Modbus the controller’s datasheet for more information. In the Resource Tree, the
resource Modbus branch allows you to add Modbus devices to the controller. Both
Modbus RTU and Modbus TCP devices are supported. All Modbus devices
(both Modbus RTU and Modbus TCP devices) are configured in the Modbus
instance. Add Modbus instances to Modbus in the Resource Tree (see Adding
resource block instances to the resource tree), and then you configure the
Modbus parameters individually. For Modbus RTU devices connected to the
controller’s RS-485 port, you must also set the communication port settings.
See the Modbus device’s documentation for more information about the units,
data types, and range of values supported by the Modbus device.
To configure the properties for each individual Modbus device, see Resource
block configuration parameter.
Configuring the Configure the Modbus RTU communication port settings as follows in the
Modbus RTU Resources Configuration.
communication
port settings Figure 465: Modbud RTU communicaiton port configuration
Parameters Description
Port Select the communication port to use to communicate
with modbus RTU devices. On-board RS-485 Port is
the controller’s onboard RS-485 port. When an ECY-
RS485 expansion module is attached to the controller,
ECY-RS485 Module Port 1 is port #1 and ECY-RS485
Module Port 2 is port #2 on that module.
EC-gfxProgram 765
Parameters Description
Speed The baud rate for all Modbus RTU devices connected
to the RS-485 data bus. The higher the baud rate, the
faster data is transmitted between devices on the RS-
485 data bus.
Parity This is a simple form of data transmission error check-
ing. When enabled, the parity can be odd or even. All
Modbus RTU devices connected to the RS-485 data
bus must use the same parity setting.
Data bits This is the number of bits used to transmit data in each
serial data frame. All Modbus RTU devices connected
to the RS-485 data bus must use the same number of
data bits.
Stop bits This is the number of stop bits used to signal the end of
a serial data frame. All Modbus RTU devices con-
nected to the RS-485 data bus must use the same
number of stop bits.
All Modbus RTU devices connected to the RS-485 must use the same net-
work communications parameters as set in Figure 465.
Configuring the Configure the Modbus device network addressing parameters as follows.
Modbus Device
network Figure 466: Modbus Device configuration
addressing
parameters
Parameters Description
Network Select the network used to communicate to this device.
TCP/IP: The Modbus TCP device is on the same sub-
net as the controller.
Onboard RS-485: The Modbus RTU device is con-
nected to the controller’s RS-485 port.
766 EC-gfxProgram
Parameters Description
IP address (for The IP address of the Modbus TCP device.
Modbus TCP
devices only)
IP port (for Mod- The port number used by the Modbus TCP device. See
bus TCP the Modbus device’s documentation for this informa-
devices only) tion.
Address The address number used by the Modbus device. See
the Modbus device’s documentation for this informa-
tion.
Heartbeat point A designated Modbus point used to determine whether
a device is online or not. If writing of reading the point
fails, all the other points of the same device won't be
processed until the heartbeat point succeeds.
Configuring the Under most circumstances, leaving all these settings cleared should work. If
Modbus Device the received data is unreadable, consult the device manufacturer’s documen-
data encoding tation for how to set the appropriate decoding according to the device’s trans-
parameters mit format.
Configure the Modbus device data encoding parameters as follows.
Figure 467: Modbus Device configuration
Modbus standards do not specify the byte order when receiving or transmit-
ting 32 or 64-bit data types. Modbus protocol is big-Endian; that is it receives
or transmits the most significant byte first for addressing and data. For exam-
ple, this means that the bytes for a 32-bit data type is received/transmitted in
the following order: A B C D, where A is the most significant byte and D is the
least significant byte. In practice, some Modbus devices do not follow this
byte transmission oder. The following table shows the effect of the Encoding
options.
Int32 byte ordering Int64 byte ordering
Parameters Int16 byte ordering
Float byte ordering Double byte ordering
Standard Byte Reception/ AB ABCD ABCDEFGH
Transmission Order
EC-gfxProgram 767
Int32 byte ordering Int64 byte ordering
Parameters Int16 byte ordering
Float byte ordering Double byte ordering
Byte Swap BA BADC BADCFEHG
(Order1032 in EC-
Net)
Word Swap — CDAB CDABGHEF
Byte Swap & Word Swap — DCBA DCBAHGFE
(Order3210 in EC-
Net)
Double Word Swap — — EFGHABCD
Byte Swap & Double — — FEHGBADC
Word Swap
Word Swap & Double — — GHEFCDAB
Word Swap
Byte Swap & Word Swap — — HGFEDCBA
& Double Word Swap
Configuring a Configure the Modbus device options parameters as follows.
Modbus Device
options Figure 468: Modbus Device configuration
parameters
Parameters Description
Supports write Enable the use of function code 15, write multiple coils
multiple coils with the device. This writes each coil in a sequence of
coils to either ON or OFF.
Supports write Enable the use of function code 16, write multiple regis-
multiple regis- ters with the device. This writes values into a sequence
ters of holding registers.
Maximum read When reading values from contiguous coils, this sets
coils the maximum number of coils that can be read.
Maximum write When writing values to contiguous coils, this sets the
coils maximum number of coils that can be written.
768 EC-gfxProgram
Parameters Description
Maximum read When reading values from contiguous registers, this
registers sets the maximum number of registers that can be
read.
Maximum write When writing values to contiguous registers, this sets
registers the maximum number of registers that can be written.
Request timeout This sets the maximum time lapse between characters
within the message before a network error will be
raised. Some Wide-Area-Network application may
require a timeout in the 4 to 5 second range.
Request throttle This sets the minimum time lapse between each
request to the device. This should take into account the
expected transport delays across the network and
expected device performance in order to determine a
reasonable value for this parameter.
NOTE: If there are communication issues, try increas-
ing the throttle value by small increments from
0.1 to 1 until the issues are resolved.
Adding a Add the Modbus control points you want to read from the device or to write to
Modbus control the device. Each control point that is added to the Modbus configuration adds
point a corresponding port to the Modbus block that is named after the control
point. A read access type adds an output port to the block. A write access
type adds an input port to the block. A read/write access type adds both an
input and output port to the block.
EC-gfxProgram 769
Figure 469: Modbus control point configuration
Parameters Description
Address type This is the address format for the device’s control point.
In EC-Net, this is known as Address Format.
Address This is the address for the device’s control point.
Register type The control point’s register type:
• Discrete Output Coil: an on/off output.
In EC-Net, this is known as Boolean Writable.
• Discrete Input Contact: an on/off input.
In EC-Net, this is known as Boolean Point.
• Input Register: an analog input.
• Analog Output Holding Register: an analog out-
put.
770 EC-gfxProgram
Parameters Description
Data type The control point’s data type:
• Binary: an on/off or 1/0 value. This is also known
as a coil.
• Signed 16 bits: An integer value between -32,768
to 32,767.
• Signed 32 bits: An integer value between -
2,147,483,648 to 2,147,483,647.
• Signed 64 bits: An integer value between -
9,223,372,036,854,775,808 to
9,223,372,036,854,775,807.
• Unsigned 16 bits: An integer value between 0
through 65,535.
• Unsigned 32 bits: An integer value between 0 to
4,294,967,295.
• Single Precision Floating Point: A value between
-3.4×1038 to +3.4×1038.
• Double Precision Floating Point: A value
between -1.7×10308 to +1.7×10308.
Data Units The data units read from Input Register type control
points.
Access type The control point’s access type:
• Read Only: The control point can only be read.
When this value is selected, the Resource Bind-
ing section is displayed in the lower part of the
screen.
• Read Write: The control point can be read and
written to.
• Write Only: The control point can only be written
to.
Default value When communication with the Modbus device has
been lost, this becomes the block’s output value for this
control point.
Update interval The control point’s sampling frequency.
EC-gfxProgram 771
Parameters Description
Units The data units used in the EC-gfxProgram logic for
Input Register type control points.
By default, it is the same as the Data Unit specified
above, but you can change it.
If this unit is changed to another unit in the same cate-
gory, the Scale and the Offset used to convert the
value are calculated automatically and cannot be
changed.
If this unit is changed to a unit in another category, you
must set the Scale and Offset that will be used to con-
vert the value.
Scale For Input Register and read-only Analog Output
Holding Register type control points, the scale used to
convert the unit type read from the control point to the
unit type used in the EC-gfxProgram logic.
Offset For Input Register and read-only Analog Output
Holding Register type control points, a constant value
that is applied to the control point’s value to compen-
sate for reading errors, for example.
Enabled Check this box to bind a BACnet resource to your read-
only Modbus point. When set, the Resource Type and
Resource Instance fields are displayed below.
Resource type The drop-down list allows you to select one of the
resource types that are currently used in the project
and that can be bound to the Modbus point (Analog
Values, Binary Values, Multi-State Values, etc).
Resource Use this drop-down list to select the specific object to
instance which you want to bind the Modbus point. Only
resources of the type selected in the Resource Type
field are included in the list.
Click Configure to access the configuration of the cor-
responding resource. See the description of the corre-
sponding block object.
Write priority If the resource type selected in the Resource Type
field is a commandable object, this field is displayed to
allow you to set the BACnet priority to use when writing
to the BACnet object.
772 EC-gfxProgram
Making Modbus The inputs and outputs of the Modbus Device block can be linked to BACnet
values available objects and used in ENVYSION graphics, for example, by connecting the
in ENVYSION Modbus block’s output ports to Analog Value or Binary Value blocks.
Multi Sensor (ECL Series expansion module)
Description Used to interface with a Multi Sensor expansion module that is connected to a
controller’s subnetwork bus. This block is only available with controller models
that support this expansion module. See the controller’s datasheet for more
information about the number of expansion modules that are supported.
Number of 4
blocks
Advanced Resources Configuration, Advanced Multi Sensor configuration, Network
configuration Properties Configuration window (ECL, ECB & ECY Series), Find All Refer-
ences (ECL, ECB & ECY Series), Copy From, Configure Ports
EC-gfxProgram 773
Input(s)
Port Type Range Description
SensorZone Numeric 0 to 30 ID used to select the commands only from a specific
remote control’s ID channel. When set to 0, this
block will accept commands from any ID channel.
A remote control can be set to any one of 31 ID
channels. By pairing a remote control to a zone
controller (by using a common ID channel number
between 1 and 30) prevents a user from being able
to control another zone controller that is using
another ID channel number. This is useful in open
space offices or when walls are made of glass.
Output(s)
Port Type Range Description
SensorSpace Numeric -40°C to 150°C- The current room temperature measured at the
Temp 40°F to 302°F Multi Sensor. According to your project’s internal
Measurement System setting in Project
properties - (Metric or US units), the units for the
output are in Celsius or Fahrenheit.
NOTE: This will be NAN for 5 minutes after ini-
tial power up.
SensorSpace Digital 0 or 1 For the SensorSpaceTemp output: See Out-of-
Temp Service.
OutOfService
SensorSpace Digital 0 or 1 For the SensorSpaceTemp output: This is
Temp Fault logically True (1) if the Reliability property does
not have a value of No Fault Detected,
otherwise logical False (0).
SensorSpace Enum See Description For the SensorSpaceTemp output: When
Temp communication to the Multi Sensor is lost, this
Reliability becomes Communication Failure. When the
space temperature sensor is not equipped on
the current Multi Sensor model, or for the first 5
minutes after initial power up, this becomes
Unreliable Other. Otherwise this is No Fault
Detected.
Sensor Numeric 0 to 4000 The current room light level in Lux measured at
LuxLevel the Multi Sensor.
Sensor Digital 0 or 1 For the SensorLuxLevel output: See Out-of-
LuxLevel Service.
OutOfService
774 EC-gfxProgram
Port Type Range Description
Sensor Digital 0 or 1 For the SensorLuxLevel output: This is
LuxLevel logically True (1) if the Reliability property does
Fault not have a value of No Fault Detected,
otherwise logical False (0).
Sensor Enum See Description For the SensorLuxLevel output: When
LuxLevel communication to the Multi Sensor is lost, this
Reliability becomes Communication Failure otherwise
this is No Fault Detected.
SensorMotio Digital 0 or 1 Motion measured at the Multi Sensor.
n
Remote Numeric +5°C to The current room temperature measured at the
SpaceTemp +45°C41°F to remote control. According to your project’s
113°F internal Measurement System setting in
Project properties - (Metric or US units), the
units for the output are in Celsius or Fahrenheit.
Remote Digital 0 or 1 For the RemoteSpaceTemp output: See Out-of-
SpaceTemp Service.
OutOfService
Remote Digital 0 or 1 For the RemoteSpaceTemp output: This is
SpaceTemp logically True (1) if the Reliability property does
Fault not have a value of No Fault Detected,
otherwise logical False (0).
Remote Enum See Description When communication to the Multi Sensor is lost,
SpaceTemp this becomes Communication Failure. When
Reliability communication from the remote control times
out, this becomes Unreliable Other. Otherwise
this is No Fault Detected.
Remote Numeric ±3 The current remote control’s setpoint offset
Setpoint setting.
Remote Digital 0 or 1 Outputs a pulse when user activity updates the
Setpoint remote control’s setpoint.
Update
Remote Digital UNOCCUPIED The current remote control’s occupancy setting.
Occupancy (0)
OCCUPIED (1)
Remote Digital 0 or 1 Outputs a pulse when user activity updates the
Occupancy remote control’s occupancy setting.
Update
EC-gfxProgram 775
Port Type Range Description
RemoteFan Enum -1 to 3 The current remote control’s fan speed setting.
Speed
• -1 = AUTO
• 0 = OFF
• 1 = LOW
• 2 = MED
• 3 = HI
RemoteFan Digital 0 or 1 Outputs a pulse when user activity updates the
Speed remote control’s fan speed setting.
Update
Group1 to Enum 0 to 7 The current user value sent by the remote
Group 8 control:
• Light stop (0): Stop all light dimming com-
mands. This command is received after a
user releases a light command button.
• Light up (1): Increase the lighting intensity.
• Light down (2): Lower the lighting intensity.
• Sunblind up (3): Raise the sunblind /
shade.
• Sunblind down (4): Lower the sunblind /
shade.
• Sunblind rotation up (5): Rotate the sun-
blind / shade up.
• Sunblind rotation down (6): Rotate the
sunblind / shade down.
• Sunblind stop (7): Stop all sunblind move-
ment. This command is received after a
user releases a sunblind command button.
776 EC-gfxProgram
Port Type Range Description
LastGroupUp Enum 0 to 10 When a command is received from the remote
dated control, this value indicates the group or range
of groups that the command was for.
• 0 = Group 1-2
• 1 = Group 1
• 2 = Group 2
• 3 = Group 3
• 4 = Group 4
• 5 = Group 5
• 6 = Group 6
• 7 = Group 7
• 8 = Group 8
• 9 = Group 1-4
• 10 = Group 1-8
LastGroup Enum 0 to 7 The last command received from the remote
Command control.
• Light stop (0): Stop all light dimming com-
mands. This command is received after a
user releases a light command button.
• Light up (1): Increase the lighting intensity.
• Light down (2): Lower the lighting intensity.
• Sunblind up (3): Raise the sunblind /
shade.
• Sunblind down (4): Lower the sunblind /
shade.
• Sunblind rotation up (5): Rotate the sun-
blind / shade up.
• Sunblind rotation down (6): Rotate the
sunblind / shade down.
• Sunblind stop (7): Stop all sunblind move-
ment. This command is received after a
user releases a sunblind command button.
GroupUpdate Digital 0 or 1 Outpus a pulse when user activity updates the
remote control’s gorup setting.
Number Integer – The current block number. This is set through
Number in the Block’s Properties pane.
EC-gfxProgram 777
Block properties See also Common block properties.
Property Type Range Default Description
Number Menu See Multi The block number. The number of
Description Sensor 1 Multi Sensor block instances
supported by a controller is shown in
this drop-down list or in the Statistics
pane. Use this drop-down menu to
select a physical Multi Sensor module
connected to this controller. This
corresponds to the module’s subnet
ID number.
NOTE: When a new block instance is
added to the programming
sheet, the block’s number is
incremented to the next avail-
able block number according
to the current Auto Increment
setting. See Auto increment
(ECP & ECL Series and EBC
Series controllers only).
Advanced Multi Configuration parameters for this block are set in the Resources Configura-
Sensor tion window.
configuration
Figure 470: Multi Sensor Configuration window
Parameter Description
Sensor When the multi sensor is equipped with a temperature
temperature probe, the offset is a constant value that is applied to
offset the temperature reading to compensate for reading
errors, that is, to perform sensor calibration.
For example, if the actual room temperature is 72ºF but
the sensor reading is 74ºF, an offset of -2ºF can be
applied to correct the error.
778 EC-gfxProgram
Parameter Description
Lux offset When the multi sensor is equipped with a light sensor,
the offset is a constant value that is applied to the light
sensor’s reading to compensate for reading errors, that
is, to perform sensor calibration.
For example, if the actual room’s lighting level is 500
lux but the sensor reading is 550 lux, an offset of -50
lux can be applied to correct the error.
Remote When the multi sensor is used with a remote control
temperature that reads the current room temperature, the offset is a
offset constant value that is applied to the temperature
reading to compensate for reading errors, that is, to
perform sensor calibration.
For example, if the actual room temperature is 72ºF but
the sensor reading is 74ºF, an offset of -2ºF can be
applied to correct the error.
Motion When the multi sensor is equipped with a motion
sensitivity sensor, this sets the number of beams that must be
broken before the motion detector is activated. Setting
a higher number requires that there is either greater
movement or the object must be relatively larger to
activate the motion detector.
Remote timeout The maximum time period between received updates
(whether or not the value has changed).
Setting this to zero disables this feature. When
enabled, the recommended setting for this value is
twice the max send time configured on the remote
control.
A max receive timeout failure occurs if an update is not
received within the time period set in the textbox. On a
max receive timeout failure, the block shows a fault
output for the related sensor.
For the LONWORKS Properties, See Network Properties Configuration win-
dow (ECL, ECB & ECY Series).
EC-gfxProgram 779
Multi Sensor (ECB & ECY Series expansion mod-
ules)
Description Used to interface with a Multi Sensor expansion module that is connected to a
controller’s subnetwork bus. This block is only available with controller models
that support this expansion module. See the controller’s datasheet for more
information about the number of expansion modules that are supported.
Number of For ECB Series controllers: 4
blocks
For ECY Series controllers: see Supported number of BACnet objects with an
ECY Series controller.
Advanced Resources Configuration, Advanced Multi Sensor configuration, Network
configuration Properties Configuration window (ECL, ECB & ECY Series), Find All Refer-
ences (ECL, ECB & ECY Series), Copy From, Configure Ports, Alarms (ECB
& ECY Series) (ECY Series only)
780 EC-gfxProgram
Input(s)
Port Type Range Description
SensorZone Numeric 0 to 30 ID used to select the commands only from a specific
remote control’s ID channel. When set to 0, this block
will accept commands from any ID channel.
A remote control can be set to any one of 31 ID
channels. By pairing a remote control to a zone
controller (by using a common ID channel number
between 1 and 30) prevents a user from being able to
control another zone controller that is using another ID
channel number. This is useful in open space offices
or when walls are made of glass.
Output(s)
Port Type Range Description
SensorSpace Numeric -40°C to 150°C The current room temperature measured at
Temp the Multi Sensor. According to your project’s
-40°F to 302°F
internal Measurement System setting in
Project properties - (Metric or US units), the
units for the output are in Celsius or
Fahrenheit.
NOTE: This will be NAN for 5 minutes after ini-
tial power up.
SensorSpace Digital 0 or 1 For the SensorSpaceTemp output: See Out-
Temp of-Service.
OutOfService
SensorSpace Digital 0 or 1 For the SensorSpaceTemp output: This is
Temp Fault logically True (1) if the Reliability Property
does not have a value of No Fault Detected,
otherwise logical False (0).
SensorSpace Enum See Description For the SensorSpaceTemp output: When
Temp communication to the Multi Sensor is lost, this
Reliability becomes Communication Failure. When the
space temperature sensor is not equipped on
the current Multi Sensor model, or for the first
5 minutes after initial power up, this becomes
Unreliable Other. Otherwise this is No Fault
Detected.
SensorLux Numeric 0 to 4000 The current room light level in Lux measured
Level at the Multi Sensor.
SensorLux Digital 0 or 1 For the SensorLuxLevel output: See Out-of-
Level Service.
OutOfService
EC-gfxProgram 781
Port Type Range Description
SensorLux Digital 0 or 1 For the SensorLuxLevel output: This is
Level Fault logically True (1) if the Reliability property
does not have a value of No Fault Detected,
otherwise logical False (0).
SensorLux Enum See Description For the SensorLuxLevel output: When
Level communication to the Multi Sensor is lost, this
Reliability becomes Communication Failure otherwise
this is No Fault Detected.
SensorMotio Digital 0 or 1 Motion measured at the Multi Sensor.
n
Remote Numeric +5°C to +45°C The current room temperature measured at
SpaceTemp the remote control. According to your project’s
41°F to 113°F
internal Measurement System setting in
Project properties - (Metric or US units), the
units for the output are in Celsius or
Fahrenheit.
Remote Digital 0 or 1 For the RemoteSpaceTemp output: See Out-
SpaceTemp of-Service.
OutOfService
Remote Digital 0 or 1 For the RemoteSpaceTemp output: This is
SpaceTemp logically True (1) if the Reliability property
Fault does not have a value of No Fault Detected,
otherwise logical False (0).
Remote Enum See Description When communication to the Multi Sensor is
SpaceTemp lost, this becomes Communication Failure.
Reliability When communication from the remote control
times out, this becomes Unreliable Other.
Otherwise this is No Fault Detected.
Remote Numeric ±3 The current remote control’s setpoint offset
Setpoint setting.
Remote Digital 0 or 1 Outputs a pulse when user activity updates
Setpoint the remote control’s setpoint.
Update
Remote Digital UNOCCUPIED (0) The current remote control’s occupancy
Occupancy setting.
OCCUPIED (1)
Remote Digital 0 or 1 Outputs a pulse when user activity updates
Occupancy the remote control’s occupancy setting.
Update
782 EC-gfxProgram
Port Type Range Description
RemoteFan Enum 1 to 5 The current remote control’s fan speed
Speed setting.
• 1 = AUTO
• 2 = OFF
• 3 = LOW
• 4 = MED
• 5 = HI
RemoteFan Digital 0 or 1 Outputs a pulse when user activity updates
Speed the remote control’s fan speed setting.
Update
Group1 to Enum 1 to 8 The current user value sent by the remote
Group 8 control:
• Light stop (1): Stop all light dimming
commands. This command is received
after a user releases a light command but-
ton.
• Light up (2): Increase the lighting inten-
sity.
• Light down (3): Lower the lighting inten-
sity.
• Sunblind up (4): Raise the sunblind /
shade.
• Sunblind down (5): Lower the sunblind /
shade.
• Sunblind rotation up (6): Rotate the sun-
blind / shade up.
• Sunblind rotation down (7): Rotate the
sunblind / shade down.
• Sunblind stop (8): Stop all sunblind
movement. This command is received
after a user releases a sunblind command
button.
EC-gfxProgram 783
Port Type Range Description
LastGroup Enum 0 to 10 When a command is received from the remote
Updated control, this value indicates the group or range
of groups that the command was for.
• 0 = Group 1-2
• 1 = Group 1
• 2 = Group 2
• 3 = Group 3
• 4 = Group 4
• 5 = Group 5
• 6 = Group 6
• 7 = Group 7
• 8 = Group 8
• 9 = Group 1-4
• 10 = Group 1-8
LastGroup Enum 1 to 8 The last command received from the remote
Command control.
• Light stop (1): Stop all light dimming
commands. This command is received
after a user releases a light command but-
ton.
• Light up (2): Increase the lighting inten-
sity.
• Light down (3): Lower the lighting inten-
sity.
• Sunblind up (4): Raise the sunblind /
shade.
• Sunblind down (5): Lower the sunblind /
shade.
• Sunblind rotation up (6): Rotate the sun-
blind / shade up.
• Sunblind rotation down (7): Rotate the
sunblind / shade down.
• Sunblind stop (8): Stop all sunblind
movement. This command is received
after a user releases a sunblind command
button.
GroupUpdate Digital 0 or 1 Outputs a pulse when user activity updates
the remote control’s group setting.
784 EC-gfxProgram
Port Type Range Description
Number Integer – The current block number. This is set through
Number in the Block’s Properties pane.
Block properties See also Common block properties.
Property Type Range Default Description
Number Menu See Multi The block number. The number of Multi
Description Sensor 1 Sensor block instances supported by a
controller is shown in this drop-down list
or in the Statistics pane. Use this drop-
down menu to select a physical Multi
Sensor module connected to this
controller.
NOTE: When a new block instance is
added to the programming
sheet, the block’s number is
incremented to the next avail-
able block number according to
the current Auto Increment set-
ting. See Auto increment (ECP
& ECL Series and EBC Series
controllers only) or Auto incre-
ment (ECY Series controllers
only).
Advanced Multi In the Resources Configuration tree, the Multi Sensor branch allows you to
Sensor adjust sensor operation. First you must add a Multi Sensor instance to Multi
configuration Sensors in the Resources Configuration tree (see Adding resource block
instances to the resource tree), and then you configure the Multi Sensor
parameters individually. For each individual sensor property, see Resource
block configuration parameter.
When the Multi Sensor is so equipped, according to the model, sensor read-
ings for sensor temperature, Lux, remote temperature, and motion are read.
The Object name is used to identify this input in the Resources Configuration
and on the controller’s operator interface or on the connected ECx-Display (if
equipped).
EC-gfxProgram 785
For each Multi Sensor tree entry, BACnet alarms can be configured. When
Enable alarms is set, the Multi Sensor block makes an AlarmSetpoint input
port available to dynamically offset the High limit and Low limit values. See
Alarms (ECB & ECY Series) to configure the alarm parameters.
Figure 471: Multi Sensor configuration window
Parameter Description
Sensor When the multi sensor is equipped with a temperature
temperature probe, the offset is a constant value that is applied to
offset the temperature reading to compensate for reading
errors, that is, to perform sensor calibration.
For example, if the actual room temperature is 72ºF but
the sensor reading is 74ºF, an offset of -2ºF can be
applied to correct the error.
Lux offset When the multi sensor is equipped with a light sensor,
the offset is a constant value that is applied to the light
sensor’s reading to compensate for reading errors, that
is, to perform sensor calibration.
For example, if the actual room’s lighting level is 500
lux but the sensor reading is 550 lux, an offset of -50
lux can be applied to correct the error.
Remote When the multi sensor is used with a remote control
temperature that reads the current room temperature, the offset is a
offset constant value that is applied to the temperature
reading to compensate for reading errors, that is, to
perform sensor calibration.
For example, if the actual room temperature is 72ºF but
the sensor reading is 74ºF, an offset of -2ºF can be
applied to correct the error.
786 EC-gfxProgram
Parameter Description
Motion When the multi sensor is equipped with a motion
sensitivity sensor, this sets the number of beams that must be
broken before the motion detector is activated. Setting
a higher number requires that there is either greater
movement or the object must be relatively larger to
activate the motion detector.
Sensor timeout The maximum time period between received updates
(whether or not the value has changed).
Remote timeout
Setting this to zero disables this feature. When
enabled, the recommended setting for this value is
twice the max send time configured on the remote
control.
A max receive timeout failure occurs if an update is not
received within the time period set in the textbox. On a
max receive timeout failure, the block shows a fault
output for the related sensor.
Network Value (ECB & ECY Series)
Description Used to read a value from or to write a value to any BACnet object available
on the BACnet intranetwork, according to the value’s configuration.
Number of For ECB Series controllers: The number of Network Value block instances
blocks supported by a controller is shown in the Number drop-down list in the Prop-
erties or Statistics panes.
For ECY Series controllers: see Supported number of BACnet objects with an
ECY Series controller.
Advanced Resources Configuration, Advanced Network Value configuration (ECB
configuration Series), Advanced Network Object configuration (ECY Series), Find All Refer-
ences (ECL, ECB & ECY Series), Copy From, Configure Ports
For more information about BACnet objects, see BACnet objects, services,
and data priority, Reading and writing network points, and Commandable
object priority array levels.
Related blocks Generic Network Value (ECB & ECY Series)
EC-gfxProgram 787
Input(s)
Port Type Range Description
Trigger Digital 0 or 1 Forces a read or write action as soon as possible.
Priority Integer 1 to 16 For a Commandable value only, the value at the
(Output Input is written at the priority level specified at this
mode only) input. If a value is not linked to this input, the value
at the Input is written into the default priority level.
See Commandable object priority array levels.
Input (Output Numeric ±3.4028×1038 The value to be sent to the remote device on the
mode only) BACnet intranetwork.
TriggerTrend Digital 0 or 1 When Trend Logs are enabled for this object and
Log (ECY the Logging Type is set to Triggered, a pulse at
Series this input forces the present value to be recorded
controllers) in the object’s trend log. See Trending (ECY
Series).
Output(s)
Port Type Range Description
Output (Input Numeric ±3.4028×1038 The value from the remote device made available
mode only) on the BACnet intranetwork.
NOTE: Any change in the measurement system of
the project results in no change to the out-
put value. For example, no conversion is
made.
Status Digital See Communication failure alarm status. See Status
Description output.
Update Digital 0 or 1 When configured to Input mode, this outputs a
pulse (1) when a value is written to the BACnet
object.
When configured to Output mode, this outputs a
pulse (1) when the current controller receives a
confirmation from the target controller that the
value has been written to properly. If the output is
configured as a broadcast COV (Send Global
Broadcast COV or Send Local Broadcast
COV), this outputs a pulse to indicate that the
value has been sent, however it does not mean
that the value has been correctly received as there
is no reception confirmation provided when using
broadcast COV.
Number Integer - The current block number. This is set through
Number in the Block’s Properties pane.
788 EC-gfxProgram
Block properties See also Common block properties.
Property Type Range Default Description
Number Menu See Network Use this drop-down menu to select an
Description Value 1 instance of this block. See Number of
blocks for the number of block instances
supported by the current controller
model.
NOTE: When a new block instance is
added to the programming
sheet, the block’s number is
incremented to the next avail-
able block number according to
the current Auto Increment set-
ting. See Auto increment (ECP
& ECL Series and EBC Series
controllers only) or Auto incre-
ment (ECY Series controllers
only).
Status output The Status output can have the following values.
Parameter Description
Not received (-2) The value was not received from the BACnet object.
Not sent (-1) The value was not sent to the BACnet object.
No error (0) Normal operation
Service request A request has been made to execute a service for
denied (1) which the requesting BACnet device does not have the
appropriate authorization.
Missing required A parameter required for the execution of a service
parameter (2) request has not been supplied.
Other error (3) This error code is returned for a reason other than any
other error shown here.
Unknown A Property_Identifier has been specified in a service
property (4) parameter that is unknown or unsupported in the
addressed BACnet device for objects of the referenced
object type.
Property is not An attempt has been made to access a property as an
an array (5) array however the property does not have an array
datatype.
Write access Write to an object was denied.
denied (6)
EC-gfxProgram 789
Parameter Description
Invalid array An attempt was made to access an array property
index (7) using an array index that is outside the range permitted
for this array.
Invalid data type The data type of a property value specified in a service
(8) parameter does not match the data type of the property
referenced by the specified Property_Identifier.
Value out of An attempt has been made to write to a property with a
range (9) value that is outside the range of values defined for the
property.
Response timed A response has timed out.
out (10)
Request timed A request timed out before a response was received
out (11) from the remote device.
Request queue New requests cannot be made as the queue in already
full (12) full with previous requests.
Response New responses cannot be made as the queue in
queue full (13) already full with previous responses.
Update failed A property could not be updated.
(14)
Unknown object An Object_Identifier has been specified for an object
(15) that does not exist in the object database of the
addressed BACnet device.
Unsupported An object type has been specified in a service
object type (16) parameter that is unknown or unsupported in the
addressed BACnet device.
Read access An attempt has been made to read the properties of an
denied (17) object defined as inaccessible through the BACnet
protocol read services.
790 EC-gfxProgram
Advanced Network Value configuration (ECB Series)
In the Resources Configuration tree, the Network Value branch allows you to
configure various parameters such as the read or write mode, default value,
poll interval, etc. to be specified.
There are two ways to configure a Network Value Input or Output: Database
Device or Manual.
Database Device Use the Database Device to select a Network Variable on a controller that is
configuration currently online.
type
In Configuration type, select Database.
Figure 472: Network Value Input / Output configuration window for a device present in
the BACnet network database
EC-gfxProgram 791
Manual Set the Configuration type to Manual to configure the network variable
configuration according to the known details of the remote controller’s network point. In
type Configuration type, select Manual.
Figure 473: Manual Network Variable Input / Output configuration window
Network The following table describes the network configuration parameters for ECB
configuration Series controllers.
parameters (ECB
Series)
Parameter Mode Type Description
Service Input Database Sets the way the network object is to be written or
read. See Reading and writing network points.
Output Manual
Device path Input Database The path to the device on the network. Click to
Output select the device that has the network point to be
written or read.
Object Input Database Select the object that has the network point to be
written / read.
Output
Current Input Manual Set this to read the network value from the currently
device connected device.
Device Input Manual This is the remote device’s Device ID.
instance
Output
Object type Input Manual Select the object type to read from or to write to.
This can also be set to any numeric value
Output
corresponding to a custom object type.
792 EC-gfxProgram
Parameter Mode Type Description
Object Input Manual The object number to read or write.
instance
Output
Property Input Database Select the property (BACnet object) from the object
to be written or read. This can also be set to any
Output Manual
numeric value to read from or to write to a custom
property.
Data type Input Database The data type of the selected property (shown for
information purposes). This must be selected when
Output Manual
using a custom property.
Write interval Output Database The time period between writing a network variable
on the network (whether or not the variable's value
Manual
has changed).
Default value Input Database The block’s output when a Max receive time failure
occurs (a network value update is not received on
Manual
the network within the time period set in the textbox).
On a Max receive time failure, an alarm is signaled
at the Status output (Response timed out (10) or
Request timed out (11)) and the output changes to
the Default value.
Poll interval Input DatabaseMa The time period between polling a network variable
nual on the network (whether or not the variable's value
has changed).
Subscription Input DatabaseMa The duration of a COV subscription. See also
time nual Reading and writing network points.
Max receive Input DatabaseMa The maximum time period between received
time nual updates of the network variable on the network
(whether or not the variable's value has changed).
The max receive time is also known as the
“heartbeat”.
Setting this to zero disables this feature. When
enabled, the recommended setting for this value is
twice the max send time configured for the
corresponding BACnet object.
A max receive time failure occurs if a network value
update is not received on the network within the time
period set in the textbox. On a max receive time
failure, the output changes to the Default value.
The appropriate alarm and status bits will be
updated on a max receive time failure.
EC-gfxProgram 793
Advanced Network Object configuration (ECY Series)
To access the configuration for a Network Value, see Resources Configura-
tion. The Network Value Configuration window allows various parameters
such as the read or write mode, default value, poll interval, etc. to be speci-
fied.
Network Object Figure 474: Network Object General configuration options
general options
Parameter Description
Object name The Network Object’s name.
Description Description of the Network Object.
Controller Indicates whether the Device Instance, Object Instance
specific and Operation are considered "controller specific" and
thus will not be overwritten when the project is re-syn-
chronized on the controller.
NOTE: The Operation is kept as long as it is not
changed from a Write to Read function, or from
Read to Write.
Best practice when first using Controller Specific
configurations in existing projects:
1. Create a backup of the project on each controller.
2. Open the reference project that you want to down-
load to multiple devices.
3. Flag the Controller Specific checkbox for the appli-
cable Network Object and EnOcean resources.
4. Save and Synchronize the project for all controllers
to synchronize the Project Identifiers.
WARNING: When you open and save projects on indi-
vidual controllers, each project gets
assigned a different project identifier. If you
have flagged resource configurations as
controller specific in those projects, and
you then download a reference project to
all the controllers, these configurations will
be overwritten by those in the reference
project since the identifiers of the reference
project being downloaded and the project
in the controller don't match.
794 EC-gfxProgram
Network Value Select the mode of the Network Value block:
operation mode
• Read Remote Property to read a value from a BACnet object instance
located on another network-connected controller.
Figure 475: Read Remote Property configuration window
• Write Remote Property to write a value to a BACnet object instance
located on another network-connected controller.
Figure 476: Write Remote Property configuration window
EC-gfxProgram 795
• Read Local Property to read a value from a BACnet object instance on
the current controller.
Figure 477: Read Local Property configuration window
• Write Local Property to write a value to a BACnet object instance on the
current controller.
Figure 478: Write Local Property configuration window
796 EC-gfxProgram
• Remote Object to write or read a value from a BACnet object instance on
another network-connected controller. Remote Object network values that
are added from remote devices can be used in ENVYSION graphs (see
the ENVYSION User Guide).
Figure 479: Remote Object configuration window
Network The following table describes the network configuration parameters for ECY
configuration Series controllers.
parameters (ECY
Series)
Operation
Parameter Description
Mode
Device instance Read This is the remote device’s Device ID.
Write
Object type Read Select the object type to read from or to write to. This can also
be set to any numeric value corresponding to a custom object
Write
type.
Object instance Read The object number to read or write.
Write
EC-gfxProgram 797
Operation
Parameter Description
Mode
Property Read Select the property (BACnet object) from the object to be
identifier written or read. This can also be set to any numeric value to
Write
read from or to write to a custom property.
Data type Write The data type of the selected property (shown for information
purposes). This must be selected when using a custom
property.
Write interval Write The time period between writing a network variable on the
network (whether or not the variable's value has changed).
Read method Read The following read methods are supported:
• Poll: Read polling makes a request to a network device to
provide the value of a network point at a regular time inter-
val. Should the value change immediately after the value
was polled, the update will occur only when the device is
polled again. The polling frequency should not be set too
high as this can create excessive network traffic. The read
method is supported at minimum by all network devices.
• Subscribe COV: Subscribe as a client to an object for
change-of-value reporting. The remote device (server)
watches the object property value, the subscription list,
and the change criteria. The change criteria are deter-
mined by a change in value, and throttling rules for the
minimum and maximum period between object value
transmissions. When the change criteria for the value are
met, the server sends COV notifications for the new value
to the subscribed clients.
Clients return a confirmation message to the server to vali-
date that the message was received. This adds extra traf-
fic on the network. If a confirmation is not received, the
COV notification is resent.
NOTE: Not all BACnet devices support this service and often
have a limited number of subscriptions supported.
• Receive Broadcast: Instead of regularly polling an object
for its value, this allows a device to push a value to the
receiving controller only when the value has changed at
the remote controller. This method is useful to reduce net-
work congestion as information is transmitted only when
necessary. The remote controller must be configured for
Send Broadcast COV for the property value. If the remote
controller is an ECY Series controller, configure the Broad-
cast Mode for the BACnet object that is to send the value
in the Resources Configuration. See also BACnet network
properties.
798 EC-gfxProgram
Operation
Parameter Description
Mode
Confirmed COV Read When enabled, clients return a confirmation message to the
server to validate that the message was received. This adds
extra traffic on the network. If a confirmation is not received,
the COV notification is resent.
NOTE: Not all BACnet devices support this service and often
have a limited number of subscriptions supported.
Poll interval Read The time period between polling a network variable on the
network (whether or not the variable's value has changed).
Fallback poll Read This sets the period after which the controller will poll the
interval network variable should the COV update fail to arrive (due to
COV subscription failure, for example).
COV Read When set, the controller tries to use COV reporting for devices
Subscription that support this service. This value sets the duration of a COV
time subscription. See also Reading and writing network points. Six
hours (21600 seconds) is a reasonable setting for this
parameter.
Max receive Read The maximum time period between received updates of the
time network variable on the network (whether or not the variable's
value has changed). The max receive time is also known as
the “heartbeat”.
Setting this to zero disables this feature. When enabled, the
recommended setting for this value is twice the max send time
configured for the corresponding BACnet object.
A max receive time failure occurs if a network value update is
not received on the network within the time period set in the
textbox. On a max receive time failure, the output changes to
the Default value.
The appropriate alarm and status bits will be updated on a max
receive time failure.
Default value Read The block’s output when a Max receive time failure occurs (a
network value update is not received on the network within the
time period set in the textbox). On a Max receive time failure,
an alarm is signaled at the Status output (Response timed
out (10) or Request timed out (11)) and the output changes
to the Default value.
Min send time Write The minimum time period that must pass before sending a new
update of the network variable on the network. If the value of
the network variable changes, an update will only be sent after
this time expires.
Setting the min send time to 0 disables it.
COV Increment Write The minimum change in value that will cause a value to be
propagated on the network.
EC-gfxProgram 799
Discovering Remote Objects
You can add remote objects to Network Values or Devices. However, to use
these objects in ENVYSION graphics, they must be added to Devices. To dis-
cover remote objects:
1. Right-click Values or Devices under Network Objects, or an existing
remote device, and select Discover Remote Objects.
2. In the Remote BACnet Device Object Selection window, click to open
the Discovery Parameters window.
3. Enter the parameters needed to optimize the discovery process for your
needs. Click OK. You can repeat the discovery process as needed.
800 EC-gfxProgram
Parameter Description
Clear Device Devices that were previously discovered are kept
Cache in the device’s cache and are not removed from
the list unless the device is rebooted or a new
discovery is performed with this option checked.
Check this option if you make sure your discovery
list is up to date with the devices available on the
network at this time and based on your current
discovery parameters.
If you are discovering small batches of devices at
a time and are running the discovery process
several times, make sure you uncheck this box
after the first run. Otherwise, the list of discovered
devices will be overridden every time you discover
new devices.
Use Device Check this option to limit the range of device
Instance Range instances that will be searched for on the network.
Since the discovery process can be time
consuming, this can be useful if you are
discovering devices on a big network.
For instance, you may choose to split the
discovery process in smaller consecutive batches
of devices.
Device Instance If you want to limit the discovery to devices within
Range Low Limit a specific device instance range, enter the Device
/ Device Instance Instance Low and High limits.
Range High Limit
Devices with an instance outside of this range will
not be included in the list of discovered devices.
Network Local: Only sends a discovery request to devices
connected on the same local network (LAN) as the
current device.
Broadcast: Sends a discovery request
simultaneously to every device connected to the
same Ethernet network as the current device.
Specific: Only sends a discovery request to
devices connected to the network with the address
specified in the Network Address field.
Network Address Enter the address of the specific network on which
you want to discover devices.
Timeout Enter the maximum amount of time, in seconds, to
complete the discovery process on the network.
After this time is elapsed, the process is stopped
and is considered completed.
EC-gfxProgram 801
4. The devices discovered on the network are listed on the left of the
Remote BACnet Device Object Selection window. Select one or more
start discovering their points.
A symbol ( ) indicates that the controller‘s points are being discovered
and a checkmark ( ) appears when the discovery is complete.
While points are being loaded in the controller, a status bar at the bottom
of the window indicates the progression. You can click Stop to pause the
loading process at any time.
5. Once points are discovered, select a device on the left to list its points on
the right of the window. By default, the points from the last selected
device are shown.
6. Select one or more points and double-click or click Add to add them to
your project. Repeat as needed to add points from different devices.
WARNING: Remote points are polled as soon as they are added in the
Resource Configuration window even if they are not used in the
project‘s logic or graphics. To avoid overloading the network, it is
recommended that you only add the points necessary for the
project.
7. Click Close when you are done adding points to return to the Resource
Configuration window.
802 EC-gfxProgram
8. The points you added to your project are either:
• Given the next available Network Value instance number (if you
added then under Values).
• Grouped under their respective device (if you added them under
Devices).
EC-gfxProgram 803
Reusing configured devices
Once you have added points to a device (e.g. a VAV), you can either duplicate
this device to add one or more devices with the same points to your current
project, or you can save your configuration as a Device Template to be able to
reuse it in other projects.
Duplicating You can create one or more copies of a remote device and all its points to
remote devices quickly add similar devices to the same project. To duplicate a remote device:
1. Right-click the device you want to duplicate and click Duplicate.
2. In the Duplicate Remote Device window, specify the step by which to
increment device instances, the number of copies to create as well as the
start number of the first duplicated device.
3. To associate the duplicates with remote devices, select each one and
click Select device to access the Remote Device Selection window.
4. Select the device you want to associate with the duplicate. Click OK.
Saving and If you plan on reusing a remote device configuration (e.g., a VAV), you can
applying device save a remote device and its points as a template. that you can then apply to
templates to remote devices in other projects. To save a remote device as a remote tem-
remote devices plate and apply it to devices:
1. Right-click the device you want to save as a template and click Save As
Device Template.
2. In the Save As Remote Device Template window, give a name to your
template (the default name is the original device’s name) and select the
folder where you want to save it (by default, the My Remote BACnet
Device Templates folder is used).
804 EC-gfxProgram
To apply a device template to devices in a project:
1. Right-click Devices and click Add or Add With Options to manually add
the number of devices you need with the template’s configuration.
2. Select the added device(s), right-click, and click Load Device Template.
3. In the Load Remote Device Template window, select the template you
want to apply and click OK.
You can right-click any remote device template in the list to open the file’s
location. This can be useful to create backup copies of a project’s device tem-
plates.
4. To select the Device instance for these devices, select each device and
manually enter a device instance or click Select device to access the
Remote Device Selection window.
5. Select the device you want to associate with the remote device. Click OK.
Network The following Diagnostics tab provides information on live values passing
diagnostics through the ports of the controller. By default, the live values are displayed.
You can stop and restart the streaming of the live values using the Stop Live
Values/Start Live Values button.
You can use the General and IP Port metrics in this tab to monitor your net-
work‘s performance after adding remote objects to the project.
EC-gfxProgram 805
If your network’s performance seems slow, you can:
• Reduce the number of remote devices in the project.
• Reduce the number of remote points in each device.
• Reduce the number of points with generated trend logs, as this doubles
the traffic on the network for each point.
• Make sure the Confirmed COV option is unchecked whenever possible
for points with the Subscribe COV read method.
• Increase the Poll interval for points with the Polled read method.
Network Variable Input (ECP Series)
Description Used to interface with any network variable input (NVI) that has a length of 1
or 2 bytes (SNVT or UNVT). The user can read and write to the Network Vari-
able Input blocks directly through a corresponding nviFP_xx (xx = input num-
ber). See also LONWORKS network description.
Depending on the SNVT type of the block, the default value will change. It is
useful to know the default value of the block to quickly detect when there is
some kind of network fault like a heartbeat failure since it is the default value
that will appear on the NVI.
806 EC-gfxProgram
If a SNVT_scene, SNVT_state, or SNVT_switch type is used, SNVT Conver-
sion blocks can be used to demux the output of a Network Variable Input
block. For more information on this category see SNVT Conversions (ECP
Series specific blocks).
Different output ports are available depending on the Network Variable Input
number selected:
Output Ports NVI 1 to 12 NVI 13 to 14 NVI 15 to 17
Output
Com Failure
Update
HiSel
HiSel Subnet Id
HiSel Node Id
LowSel
LowSel Subnet Id
LowSel Node Id
Sum
Avg
Configuration The SNVT type that has been selected in the Change Type (ECP & ECL
Type display Series) window is shown at the bottom of the block as shown below.
SNVT Type Identification
Number of 17
blocks
Advanced Resources Configuration, Advanced configuration, Change Type (ECP & ECL
configuration Series), Edit Value (ECP Series), Copy From, Configure Ports
Input(s) N/A
EC-gfxProgram 807
Output(s)
Port Type Range Description
Output See See The outputs are defined according to the
Description Description SNVT or UNVT type selected.
NOTE: Any change in the measurement sys-
tem of the project results in no change
to the output value. For example, no
conversion is made.
Com Failure Digital 0 or 1 Communication failure alarm status. Becomes
True when the Max receive time (in Advanced
configuration) has expired.
Update Digital 0 or 1 Outputs a pulse when the network variable is
updated by the network.
HiSel Numeric -83886.08 to Highest value among the fan in inputs.
83886.07
HiSel Subnet Id Integer 0 to 83886 Subnet ID of the input with the highest value.
HiSel Node Id Integer 0 to 83886 Node ID of the input with the highest value.
LowSel Numeric -83886.08 to Lowest value among the fan in inputs.
83886.07
LowSel Subnet Integer 0 to 83886 Subnet ID of the input with the lowest value.
Id
LowSel Node Integer 0 to 83886 Node ID of the input with the lowest value.
Id
Sum Numeric -83886.08 to The sum of all the values of the fan in inputs.
83886.07
Avg Numeric -83886.08 to The average value of the fan in inputs.
83886.07
NOTE: NVI 15 to 17 support a maximum of 80 Fan In connections in total.
808 EC-gfxProgram
Block properties
Property Type Range Default Description
(Name) String Unlimited Network Name of the block.
Variable Input
When the option Automatically rename
network variable when changing a
block name is set and when you are
using an LNS Network management tool,
this name is written to the associated
network variable, or if you are using EC-
Net, this name is written to the
DisplayName field of the network
variable. This makes identification easier
when making network connections to the
Network Variable Outputs of other
devices or HMIs.
NOTE: Changing the NVI name in the
LNS database or the Display
Name in EC-Net does not update
the name in this application.
Format Menu See – The format of the SNVT type selected.
Description The available formats vary depending on
the type of SNVT used.
NOTE: Any format change results in the
output value being converted. If
the format is changed, the project
code needs to be rebuilt.
Number Menu 1 to 17See Network Use this drop-down menu to select from
Description Variable Input the 17 available block instances.
1
NOTE: When a new block instance is
added to the programming sheet,
the block’s number is incre-
mented to the next available
block number according to the
current Auto Increment setting.
See Auto increment (ECP & ECL
Series and EBC Series control-
lers only).
EC-gfxProgram 809
Advanced The Network Variable Input Configuration window allows the maximum
configuration receive time and persistent state to be specified.
Figure 480: Network Variable Input Configuration window
Parameter Description
Max receive The maximum time period between received updates
time of the network variable on the network (whether or not
the variable's value has changed). The max receive
time is also known as the “heartbeat”.
Setting this to zero disables this feature. When
enabled, the recommended setting for this value is
twice the max send time configured for the
corresponding Network Variable Output (ECP Series).
A max receive time failure occurs if a network variable
update is not received on the network within the time
period set in the textbox. On a max receive time failure,
the device will go into alarm, the device status will be
updated to indicate a failure, and the NVI will return to
its default value.
The appropriate alarm and status bits will be updated
on a max receive time failure.
NOTE: Max receive time only applies to NVIs that are
bound.
Persistent When a network variable is marked as persistent, the
network variable value is written to the EEPROM. Once
written to the EEPROM, the network variable value is
preserved during power failures and resets. Every time
a new network variable value is received, the new
value is written into the EEPROM.
WARNING: If the network variable is constantly changing and if it is received
from the network on every change, the network variable could
exhaust the ability of the EEPROM to store it in permanent mem-
ory. In this case, do not select the Persistent option.
810 EC-gfxProgram
NOTE: When the persistent option is selected, only future value changes of
the NVI are written to the EEPROM. That is, the moment you select
the persistent option, the current value of the NVI is not immediately
stored in the EEPROM.
The persistent option is ignored for NVIs that are bound.
Synchronize Synchronize Bindings updates Network Variable Inputs 15 to 17 (fan in
bindings inputs) after a new binding is made. These fan in network variable inputs use
a static table to record the values of the bound variables.
NOTE: This advanced configuration is accessible directly through Network
Variable Input blocks 15 to 17.
The static table needs to be refreshed (by selecting Synchronize
Bindings) every time a new binding is made in order to keep track of
which values are coming from which devices.
EC-gfxProgram 811
Network Variable Input (ECL Series)
Description Used to interface with any network variable output (NVO) that has a length up
to 31 bytes (SNVT or UNVT) or with an HMI. The user can read and write to
the Network Variable Input blocks directly through a corresponding nviFP xx
(xx = input number). See also LONWORKS network description.
The NVI Blocks are dynamic and the number of their input and output ports
vary depending on which SNVT or UNVT type has been selected. However,
each NVI Block has a common input which is the FanInNumber and the five
following common outputs: TypeIndex, FanInCount, Update, Com Failure
and Subnet and Node Id.
Configuration The SNVT type that has been selected in the Change Type (ECP & ECL
Type display Series) window is shown at the bottom of the block as shown below.
SNVT Type Identification
Fan In support All Network Variables support Fan In, up to a maximum of 255 bindings per
NVI. See Using LONWORKS network variables to fan in values from many con-
trollers.
Slim format This block can be collapsed into a slim format. See Collapsed in Common
support block properties.
Number of The number of Network Value block instances supported by a controller is
blocks shown in the Number drop-down list in the Properties or Statistics panes.
Persistence Network Variable Inputs configured as configuration properties are persistent;
this allows a value to be saved during a controller power cycle or reset. See
Persistent values (ECL, ECB & ECY Series controllers).
Advanced Resources Configuration, Advanced configuration, Set Value, Change Type
configuration (ECP & ECL Series), Find All References (ECL, ECB & ECY Series), Copy
From, Configure Ports
Related blocks Generic Network Variable Input (ECL Series)
812 EC-gfxProgram
Input(s)
Port Type Range Description
Input See See The inputs are defined according to the SNVT or
Description Description UNVT type selected. See also the Format option
in this block’s Properties.
This port will typically be linked to project code
that overrides the value of a Network Variable
Input when for example, the current network
value is not supported by this controller or is out
of range. By placing a value at this port, it can
be polled by other controllers so they can be
aware of this controller’s current treatment of
this Network Variable Input and to react
accordingly.
This is typically coded by linking the Output port
to project code that detects when the value is
out-of-range. When out-of-range, this project
code activates a Conditional Custom Block that
writes an appropriate value to the Input port.
See Overriding the current network value when
it is out-of-range project code example.
NOTE: For a structured network variable type,
there will be two or more inputs.
FanInNumber Integer 0-255 Selects the FanIn number of a value to be read.
The FanInNumber port affects the Output, Com
Failure and Subnet and Node Id ports. See also,
Using a LonWorks Network Variable to Fan in
Values From Many Controllers.
If this input is not connected or is set to 0, the
Output value is the last received network value.
Some Output values and SubnetNodeIds are
shown more often according to the transmission
frequency of these values from other controllers.
Output(s)
Port Type Range Description
Output See See The outputs are defined according to the SNVT
Description Description or UNVT type selected. See also the Format
option in this block’s Properties.
NOTE: For a structured network variable type,
there will be two or more outputs.
EC-gfxProgram 813
Port Type Range Description
Number Integer See The block number. The number of Network
Description Value block instances supported by a controller
is shown in the Statistics pane.
TypeIndex Integer See Network variable type index.
Description
NOTE: For UNVT, multiply the manufacturer
index by 1000 and then add the type
index.
For example: If using UNVT_x of type 1 in the
DRF of manufacturer id 131, the resulting Type
Index is 131001.
FanInCount Integer 0-255 Number of fan in values available in the fan in
table.
ComFailure Digital 0 or 1 Communication failure alarm status. Becomes
True when the COV max receive time (for an
nvo) has expired.
Update Digital 0 or 1 Outputs a pulse when the NV is updated.
Subnet NodeId Integer See Network variable update Subnet and Node Id
Description source address.
The source address is the Subnet id (1 to 255)
multiplied by 1000 and then add the node id.
For example: Address 1005 has a Subnet id of 1
and a Node id of 5.
814 EC-gfxProgram
Block properties See also Common block properties.
Property Type Range Default Description
Format Menu See See Click to select a format that
Description Description corresponds to the units type
the block is to use for the Input
and Output ports of the block.
For example, because all
values sent on a LONWORKS
network are in SI (metric)
values, a temperature on a
LONWORKS network is sent in
degrees Celsius. By setting the
Format to a US type such as
SNVT_temp#US, the value is
converted at the Output to
degrees Fahrenheit with ºF as
the unit.
See also Change Type (ECP &
ECL Series).
Manual Menu True or False False When set to True, the name to
Network Name be shown on the network for
this Network Variable Input can
be freely edited in the
NetworkName property.
When set to False, either the
default NVI name or the NVI
block name is used according
to the EC-gfxProgram option
Automatically rename
network variable when
changing a block name is set
(see EC-gfxProgram Options,
Network tab).
EC-gfxProgram 815
Property Type Range Default Description
Network Name String – See The current name used to
Description identify this Network Variable
Input on the network. When
ManualNetworkName is set to
True, this name can be freely
edited. It should be less than 85
characters.
When you are using an LNS
Network management tool, this
name is written to the
associated network variable, or
if you are using EC-Net, this
name is written to the
DisplayName field of the
network variable. This makes
identification easier when
making network connections to
the Network Variable Outputs of
other devices or HMIs.
NOTE: Changing the NVO
name in the LNS data-
base or the Display
Name in EC-Net does
not update the name in
this application.
Number Menu See Network Use this drop-down menu to
Description Variable select an instance of this block.
Input 1 See Number of blocks for the
number of block instances
supported by the current
controller model.
NOTE: When a new block
instance is added to the
programming sheet, the
block’s number is incre-
mented to the next
available block number
according to the current
Auto Increment setting.
See Auto increment
(ECP & ECL Series and
EBC Series controllers
only).
Advanced In the Resources Configuration tree, the Network Variable Input branch allows
configuration you to configure the mode, maximum receive time and default value. Set the
816 EC-gfxProgram
network properties as shown below (refer to the controller’s Functional Profile
in its datasheet). See also Typical controller internal points.
Figure 481: Network Variable Input Configuration window
Parameter Description
Mode Changes how the controller manages the default value.
• Standard Network Variable: The network variable
is used as a standard NVI. In this mode, the value
of the variable will change to its default value when
the COV max receive time (for an nvo) has expired.
Both of the following options change the network
variable and its associated SCPTdefOutput to
functionally become an nci configuration property. As
such, when this network variable is written to, the value
is mirrored (propagated) to the associated
SCPTdefOutput configuration property and vice versa,
as they are now one item.
• Non-controller-specific Configuration: The
Value set below can be pushed into the controller’s
SCPT network variable during Project Synchroni-
zation when the Reinitialize non-controller spe-
cific values and constants option is selected.
• Controller-specific Configuration: The Value set
below can be pushed into the controller’s SCPT
network variable during Project Synchronization
when the Reinitialize controller specific values
and constants option is selected.
See Reinitialize controller specific values and
constants and Reinitialize non-controller specific
values and constants in Download to device and
download to multiple devices synchronization options
for more information about synchronization options.
EC-gfxProgram 817
Parameter Description
Default Value The Default value will be effective under the following
conditions: The NVI was never updated or no update is
performed before the end of the Max receive time
interval (for example, 600 seconds). The content of the
Default Output value is dynamic and differ according
with the NVI type selected. See Change Type (ECP &
ECL Series).
COV Max The maximum time period between received updates
receive time of the network variable on the network (whether or not
the variable's value has changed).
Setting this to zero disables this feature. When
enabled, the recommended setting for this value is
twice the max send time configured for the
corresponding network variable output.
A max receive time failure occurs if a network variable
update is not received on the network within the time
period set in the textbox. On a max receive time failure,
the NV will go into alarm, and the NVI will return to its
default value.
For each fan in value (if using fan in), the maximum
receive time is rounded up to the next higher whole
minute. For example, when Max receive time is set to
121 seconds; the value applied in reality will be 180
seconds.
When a controller is equipped with an operator’s
interface / ECx-Display (color LCD screen), set the
Max receive time to 0 if this NVI is unbound (has no
binding to it) and there is a need to allow an operator to
use the Set Value feature for this NVI through this
operator interface.
Change type The Change Type window has all the SNVT types that can be assigned to the
block. It is typically used when there is a need to modify the variable type
before creating a binding. Set the associated NVO on the other controller(s) to
the same SNVT variable type.
NOTE: If you change an NVI’s type in an external network management tool,
this will have no effect on the Network Variable Input block’s format
and configuration. It is recommended to use only EC-gfxProgram to
change the NVI type.
818 EC-gfxProgram
Figure 482: Change Type window
Parameter Description
Network variable The name of the network variable as shown in the
name NetworkName property (in Block’s Properties pane).
When you are using an LNS Network management
tool, this name is written to the associated network
variable, or if you are using EC-Net, this name is
written to the DisplayName field of the network
variable. This makes identification easier when making
network connections to the Network Variable Outputs
of other devices or HMIs.
Current type The current network variable type. If the type is
changed, this field is updated.
Current type The current network variable type length. If the type is
length changed, this field is updated.
Option When selected, lists only the network variable types
with the same length as the Current type length.
Type file Select a type file from the drop-down list. All available
type files from the device resource file catalog
(standard and manufacturer defined) are listed. The
Types will change based on the .TYP file selected.
Types Select a type from the list. All types contained within
the selected .TYP file are listed and sorted by Name,
Field or Length.
EC-gfxProgram 819
The Network Variable Input Block inputs and outputs shown change accord-
ing to the SNVT type you choose. This is based on the Echelon standard for
network variables. For example, the SNVT_hvac_status SNVT type has the
following inputs and outputs.
Figure 483: Network Variable Input block inputs and outputs for the
SNVT_hvac_status SNVT type
Overriding the The following project code overrides the value of the Network Variable Input
current network when the current network value is out of range by placing the DefaultValue at
value when it is the Input where it can be polled by other controllers so they can be aware of
out-of-range this controller’s current treatment of this Network Variable Input and to react
project code accordingly.
example
Figure 484: Code example that overrides the current network value when it is out-of-range
Figure 485: The Reset nviSetpoint Consitional Custom Block contents
820 EC-gfxProgram
Using LONWORKS Fan In is a connection where the same Network Variable Output (NVO) from
network many controllers (source devices) are sent to a single Network Variable Input
variables to fan (NVI) of another controller. However two or more NVOs from the same source
in values from controller (device) should not be bound to a single NVI Fan In of another con-
many controllers troller as the value of one NVO will overwrite the value of the second NVO in
the NVI Fan In. Under most circumstances, you will want to avoid this as it will
cause unpredictable results.
Figure 486: Network binding configuration to avoid
Normally, the individual NVOs should be separately bound to the correspond-
ing individual NVI Fan-Ins of another controller, which results in predictable
behavior.
Figure 487: Network binding configuration that is normally used
EC-gfxProgram 821
Updates from the sending controllers (NVOs) are made at pre-determined
intervals to keep the receiving controller up to date with performance parame-
ters of the sending controllers.
To do this, the application controller records the output value from each LON-
WORKS zone controller and the corresponding Subnet and Node id into a table
according to the order these values are collected (up to a maximum of 255
NVOs per NVI). The order in which these values are collected is called the
FanInNumber. The Maximum receive time configuration value sets a time-out
for values that are not updated regularly, thus flagging a communication fail-
ure.
For example: As shown in the figure below, the Application Controller analy-
ses these zone controller outputs through a For Loop process to calculate the
minimum, maximum, or average space temperature values. The Zone Con-
trollers #1, #2 and #3 send different nvoSpaceTemp values which are updated
with their relative Subnet and Node id. The Application Controller writes
Temp1, Temp2 and Temp3 in an entry table. Then, these Zone Controller
nviSpaceTemp values are processed with a For Loop (on the Application Con-
troller) to find the Minimum, Maximum, and Average values of the Zone con-
troller NVOs. The Count is also found - this is the number of Zone Controllers
being processed for the purpose of the calculation.
Figure 488: Network variable Fan In example
822 EC-gfxProgram
Programming A For Loop (ECL, ECB & ECY Series) block executes project code created on
code example: the associated Programming Sheet a pre-determined number of times as set
Using a Network by the StartIndex and StopIndex at each controller scan cycle. In the follow-
Variable Input ing example, a For Loop block is used to iterate through a range of Network
with a For Loop Variable Inputs to find the instantaneous maximum value (high select) as fol-
lows: On a Programming Sheet, add a For Loop (ECL, ECB & ECY Series)
to find the
block with an Internal Constant block set to 1 as shown below. For conve-
maximum value
nience, the FanInCount of the same Network Variable Input NVI is used to
of a range of automatically detect the available number of bound network variables
Network Variable (thereby making the project code more generic).
Inputs
Figure 489: A For Loop is used to find the maximum value range of network variable inputs
Double-click the For Loop block to open its programming sheet.
Within the For Loop block is the project code that finds the highest value. The
Equal block resets the Maximum block with a large negative value (-
3.0428X1038) that is normally out of range of the maximum values being
tested for, when the loop is at the start of its cycle. The Network Variable
Input block uses the output of the For Loop to scan through the Network
Variable Input values of the network connected controllers: The Output of the
Loop Info block iterates integer values starting from the StartIndex up to the
StopIndex. This selects the Network Variable Input instance at the FanIn-
Number, the value of which is made available on its Output. This is com-
pared with the Maximum block to select the larger of the two numbers: The
current Network Variable Input or the highest number from previous For
Loop iterations. The result of the comparison is sent to the Exported Output
block (named as Maximum). The Exported Output block appears as the
Maximum output port on the For Loop block.
Figure 490: Code to find the maximum value of a range of Network Variable Inputs
As with a Custom block, an Exported Input can be used to add an input port
on the For Loop block to make values available within the associated For
Loop programming sheet. See Adding exported inputs and exported outputs.
The maximum number of network fan in is limited by two factors:
EC-gfxProgram 823
• For a fan in, each network variable input (NVI) can support a maximum of
255 bindings.
• The controller has reserved 10 000 bytes of memory for fan in. The
amount of memory that each fan in NVI uses can be calculated as fol-
lows:
For example, if you want to use 35 fan in NVIs on a controller, each being
4-bytes, the maximum number of bindings per NVI can be calculated as
follows:
Network Variable Output (ECP Series)
Description Used to interface with any network variable output (NVO) of any type of either
1- or 2-bytes in length (SNVT or UNVT). The user can read the Network Vari-
able Output blocks directly through a corresponding nvoFP_xx (xx = output
number). See also LONWORKS network description.
If a SNVT_scene, SNVT_state or SNVT_switch type is required; SNVT Con-
version blocks can be used to mux values and send them to a Network Vari-
able Output block. For more information on this category see SNVT
Conversions (ECP Series specific blocks).
Configuration The SNVT type that has been selected in the window is shown at the bottom
Type display of the block as shown below.
SNVT Type Identification
Number of 17
blocks
Advanced Advanced configuration, Change Type (ECP & ECL Series), Copy From, Con-
configuration figure Ports
824 EC-gfxProgram
Input(s)
Port Type Range Description
Input See See The input range is defined according to the SNVT or
Description Description UNVT type selected.
Output(s)
Port Type Range Description
Output See See The output range is defined according to the SNVT or
Description Description UNVT type selected.
Block properties See also Common block properties.
Property Type Range Default Description
(Name) String Unlimited Network Name of the block.
Variable
When the option Automatically rename
Output
network variable when changing a
block name is set (see EC-gfxProgram
Options) and when you are using an LNS
Network management tool, this name is
written to the associated network variable,
or if you are using EC-Net, this name is
written to the DisplayName field of the
network variable. This makes
identification easier when making network
connections to the Network Variable
Outputs of other devices or HMIs.
NOTE: Changing the NVO name in the
LNS database or the Display
Name in EC-Net does not update
the name in this application.
Format Menu See – The format of the SNVT type selected.
Description The available formats vary depending on
the type of SNVT used.
NOTE: Any format change results in the
output value being converted. If
the format is changed, the project
code needs to be rebuilt.
EC-gfxProgram 825
Property Type Range Default Description
Number Menu 1 to 17 Network Use this drop-down menu to select from
Variable the 17 available block instances.
See
Output 1
Description
NOTE: When a new block instance is
added to the programming sheet,
the block’s number is incremented
to the next available block number
according to the current Auto
Increment setting. See Auto incre-
ment (ECP & ECL Series and
EBC Series controllers only).
Advanced The Network Variable Output Configuration window allows the minimum and
configuration maximum send times to be specified. Network congestion occurs when net-
work variables are transmitted too frequently on the network. Network con-
gestion can be reduced by only transmitting network variables as frequently
as is necessary to meet the system requirements.
Figure 491: Network Variable Output Configuration window
Parameter Description
COV Min send The minimum time period that must pass between
time network variable updates on the network. If the value of
the network variable changes, an update will only be
sent after this time expires. Setting the min send time to
0 disables it. See Network Properties Configuration
window (ECL, ECB & ECY Series).
The min send time is often referred to as the "throttle".
826 EC-gfxProgram
Parameter Description
COV Max send The maximum time period between automatic
time transmissions of the network variable on the network
(whether or not the variable's value has changed).
Setting the max send time to 0 disables it. See Network
Properties Configuration window (ECL, ECB & ECY
Series).
The max send time is often referred to as the
"heartbeat"0.
If max receive time is configured for the corresponding
network variable input, the recommended setting for
this value is half the Max receive time value.
COV increment The minimum change in value that will cause a value to
be propagated on the network.
Network Variable Output (ECL Series)
Description Used to interface with any network variable input (NVI) of any type and length
(SNVT or UNVT) up to 31 bytes. The user can read the Network Variable Out-
put blocks directly through a corresponding nvoFP xx (xx = output number).
See also LONWORKS network description.
The NVO Blocks are dynamic and the number of their input and output ports
vary depending on which NVO block has been selected. However, each
SNVT type has a common output: TypeIndex.
Configuration The SNVT type that has been selected in the Change Type (ECP & ECL
Type display Series) window is shown at the bottom of the block as shown below.
SNVT Type Identification
Slim format This block can be collapsed into a slim format. See Collapsed in Common
support block properties.
Number of The number of Network Variable block instances supported by a controller is
blocks shown in the Number drop-down list in the Properties or Statistics panes.
EC-gfxProgram 827
Advanced Resources Configuration, Advanced configuration, Find All References (ECL,
configuration ECB & ECY Series), Copy From, Configure Ports
Related blocks Generic Network Variable Output (ECL Series)
Input(s)
Port Type Range Description
Input See See The inputs are defined according to the SNVT or UNVT
Description Description type selected. See also the Format option in this block’s
Properties.
NOTE: For a structured network variable type, there will
be two or more inputs.
Output(s)
Port Type Range Description
Output See See The outputs are defined according to the SNVT or
Description Description UNVT type selected. See also the Format option in
this block’s Properties.
NOTE: For a structured network variable type, there
will be two or more outputs.
Number Integer See The block number. The number of Network Value
Description block instances supported by a controller is shown in
the Statistics pane.
TypeIndex Integer See Network variable type index.
Description
NOTE: For UNVT, multiply the manufacturer index
by 1000 and then add the type index.
For example: If using UNVT_x of type 1 in the DRF
of manufacturer id 131, the resulting Type Index is
131001.
Block properties See also Common block properties.
828 EC-gfxProgram
Property Type Range Default Description
(Name) String Unlimited Network Name of the block.
Variable
When the option Automatically
Output 1
rename network variable when
changing a block name is set (see
EC-gfxProgram Options) and when
you are using an LNS Network
management tool, this name is written
to the associated network variable, or
if you are using EC-Net, this name is
written to the DisplayName field of the
network variable. This makes
identification easier when making
network connections to the Network
Variable Outputs of other devices or
HMIs.
NOTE: Changing the NVO name in
the LNS database or the Dis-
play Name in EC-Net does not
update the name in this appli-
cation.
Format Menu See See Click to select a format that
Description Description corresponds to the units type the
block is to use for the Input and
Output ports of the block.
For example, because all values sent
on a LONWORKS network are in SI
(metric) values, a temperature on a
LONWORKS network is sent in degrees
Celsius. By setting the Format to a
US type such as SNVT_temp#US,
the value at the Input is interpreted as
degrees Fahrenheit.
See also Change Type (ECP & ECL
Series).
Manual Menu True or False False When set to True, the name to be
Network shown on the network for this Network
Name Variable Output can be freely edited in
the NetworkName property.
When set to False, either the default
NVO name or the NVO block name is
used according to the option
Automatically rename network
variable when changing a block
name is set (see EC-gfxProgram
Options, Network tab).
EC-gfxProgram 829
Property Type Range Default Description
Network String – See The current name used to identify this
Name Description Network Variable Output on the
network. When
ManualNetworkName is set to True,
this name can be freely edited. It
should be less than 85 characters.
When you are using an LNS Network
management tool, this name is written
to the associated network variable, or
if you are using EC-Net, this name is
written to the DisplayName field of the
network variable. This makes
identification easier when making
network connections to the Network
Variable Inputs of other devices or
HMIs.
NOTE: Changing the NVO name in
the LNS database or the Dis-
play Name in EC-Net does not
update the name in this appli-
cation.
Number Menu See Network Use this drop-down menu to select an
Description Variable instance of this block. See Number of
Output 1 blocks for the number of block
instances supported by the current
controller model.
NOTE: When a new block instance is
added to the programming
sheet, the block’s number is
incremented to the next avail-
able block number according
to the current Auto Increment
setting. See Auto increment
(ECP & ECL Series and EBC
Series controllers only).
830 EC-gfxProgram
Advanced In the Resources Configuration tree, the Network Variable Output branch
configuration allows you to configure the minimum and maximum send times to be speci-
fied. Network congestion occurs when network variables are transmitted too
frequently on the network. Network congestion can be reduced by only trans-
mitting network variables as frequently as is necessary to meet the system
requirements. Set the network properties as shown below (refer to the control-
ler’s Functional Profile in its datasheet). See also Typical controller internal
points.
Figure 492: Network Variable Output Configuration window
See Network Properties Configuration window (ECL, ECB & ECY Series).
EC-gfxProgram 831
832 EC-gfxProgram
SmartSensor Module (ECP Series)
Description Used to interface with a SmartSensor connected to the controller’s SMRT ter-
minals. A SmartSensor is a user-friendly HMI that is used to view and change
space settings such as room temperature, temperature setpoints, fan speeds,
HVAC modes, etc. depending on the model configured. The user can read the
values and modes of the SmartSensor Module block directly through
nvoSmI1 to 5. Modify can be used to write to the values and modes of the
block by specifying the internal value type (SM_INPUT), the index (Smart
input number), the mode (Automatic or Manual), and the value (-83886.08 to
83886.07).
Number of 1
blocks
Advanced Advanced configuration, Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
Setpoint Numeric -83886.08 to The temperature setpoint. If this input receives a
+83886.07 change of value, it will override any setpoint set by
the user through the SmartSensor until there is
another change of value through this input or set by
the user.
Output(s)
Port Type Range Description
Temp Numeric 0 to 99.9 The current room temperature.
NOTE: Any change in the measurement system of
the project results in the output value being
converted.
EC-gfxProgram 833
Port Type Range Description
Setpoint Numeric 0 to 99.9 The current temperature setpoint. It is the last value
received from either the Setpoint Block input or set
by the user through the SmartSensor.
NOTE: Any change in the measurement system of
the project results in the output value being
converted.
FanSpeed Enum -1 to 5 The current fan speed being selected by the user
through the SmartSensor.
HVACmode Enum -1 to 20 The current HVAC mode being selected by the user
through the SmartSensor.
Override Digital 0 or 1 Value of the override (Bypass). The Override output
only emits a pulse, thus if it is required to stay on for
an extended period of time, a Min On Time or Latch
block should be utilized.
Block properties See Common block properties.
Advanced The Smart Sensor Module Configuration window has all the settings required
configuration to configure any type of Smart Sensor. Depending on the Smart Sensor Type
selected, the options available will vary.
General Figure 493: Smart Sensor Module Configuration window - General
834 EC-gfxProgram
Module selection
Parameter Description
Module type Select the type of Smart Sensor to be configured.
Enable all When selected, pressing any button (except the °C/°F
buttons override button) on the Smart Sensor puts the controller in
bypass mode if it was in unoccupied or standby modes.
If deselected, the controller cannot be put into bypass
mode by the Smart Sensor.
This option is only available for the Smart-Sensor
models that do not have an override button. Models
with an override button are always enabled.
Space
temperature
Parameter Description
Offset The offset is a constant value that is applied to the
sensor input reading to compensate for reading errors,
for example, to perform sensor calibration.
This is available in nvoSmI1 to nvoSmI5 as SpaceTemp.
Setpoint
Parameter Description
Setpoint read- When selected, the setpoint is read-only. If deselected,
only the setpoint is adjustable by room occupants.
Setpoint Select either a relative setpoint or absolute setpoint
input.
Min range This field is used to specify the value of the minimum
relative setpoint or absolute setpoint.
Max range This field is used to specify the value of the maximum
relative setpoint or absolute setpoint.
Temperature Select between Metric and U.S. temperature units to
Units be displayed on the Smart Sensor.
NOTE: The temperature units selected here do not
affect the temperature units used by the Smart-
Sensor Module block in EC-gfxProgram or
project.
EC-gfxProgram 835
This is available in nvoSmI1 to nvoSmI5 as Setpoint.
Parameter Description
Hvac Mode Check the HVAC modes that will be selectable by the
Options Smart Sensor.
Figure 494: HVAC Mode Options
This is available in nvoSmI1 to nvoSmI5 as HVACmode.
Mode Value Mode Value Mode Value
Auto 0 Test 7 Dehumidification 14
Heat 1 Emergency 8 Calibrate 15
heat
Morning 2 Fan only 9 Emergency cool 16
warmup
Cool 3 Free cool 10 Emergency 17
steam
Night 4 Ice 11 Max cool 18
purge
Precool 5 Max heat 12 Hvac load 19
Off 6 Economy 13 No load 20
Parameter Description
Fan Speed Check the fan speeds that will be selectable by the
Options Smart Sensor.
Figure 495: HVAC Mode Options
836 EC-gfxProgram
This is available in nvoSmI1 to nvoSmI5 as FanSpeed.
Mode Value Mode Value Mode Value
Auto Nul Low 1 High 3
Off 0 Medium 2 On 4
NOTE: Fan Speed Options and Hvac Mode Options are available for Smart
Sensor models that support these features.
Figure 496: Smart Sensor Module Configuration window - Display
WARNING: Because the rolling display feature is no longer supported, if your
project has a SmartSensor block configured for a Rolling Display,
a warning is shown during the build, but the project code is still
sent to the device. If you change the Rolling Display mode to
Static Display and click OK, the options for Display are removed
and you will no longer be able to configure a rolling display.
Only the item selected in Static Display Options will be shown on the Smart
Sensor device.
Parameter Description
Room When selected, the room temperature is displayed on
temperature the rolling/static display of the Smart Sensor.
Setpoint When selected, the setpoint is displayed on the rolling/
static display of the Smart Sensor.
Welcome When selected, the welcome message is displayed on
message the rolling/static display of the Smart Sensor. Set the
message in Welcome Message: Type in the welcome
message (maximum length of 8 characters per line).
EC-gfxProgram 837
Space Comfort Controller (ECL Series)
Description Used to interface (read and write) with the nviSpaceTemp, nvoSpaceTemp,
and nvoUnitStatus network variables. This block can read and write to the
nviSpaceTemp and nvoUnitStatus network variables.
Slim format This block can be collapsed into a slim format. See Collapsed in Common
support block properties.
Controller This block is available when used with a device that supports the LONMARK
support Space Comfort Controller (8500 series) object type. See the controller’s data-
sheet for the availability of this feature.
Number of 1
blocks
Advanced Resources Configuration, Advanced configuration, Find All References (ECL,
configuration ECB & ECY Series), Copy From, Configure Ports, Show/Hide Ports
Related blocks Roof Top Unit Profile LONMARK Object #8504 and Space Comfort Controller
AHU Profile LONMARK Object #8508
Input(s)
Port Type Range Description
nviSpace Temp Numeric -10°C to 50°C Overrides the space temperature network input
value.
The default value of +327.67°C (invalid space
temperature value) is used during controller
power-up and when an update has not been
received within the specified receive heartbeat
time.
nvoSpace Numeric -10°C to 50°C Provides the current space temperature on the
Temp network through nvoSpaceTemp.
838 EC-gfxProgram
Port Type Range Description
UnitMode Enum 0 to 20* Provides the current Space Comfort Controller
mode through nvoUnitStatus.
*: The following is the valid range of values:
1 = HVAC_HEAT: In heating mode.
2 = HVAC_MRNG_WRMUP: Morning warm-up
mode.
3 = HVAC_COOL: In cooling mode.
4 = HVAC_NIGHT_PURGE: Free cooling mode.
5 = HVAC_PRE_COOL: Morning cool-down
mode.
6 = HVAC_OFF: Unit off.
7 = HVAC_TEST: Special test mode, application
defined.
8 = HVAC_EMERG_HEAT: Emergency heat
mode.
9 = HVAC_FAN_ONLY: No heating or cooling
allowed.
12 = HVAC_MAX_HEAT: Maximum heating mode.
UnitHeat Numeric 0 to 100% Provides the current Primary Heat Output on the
Output Primary network through nvoUnitStatus.
UnitHeat Numeric 0 to 100% Provides the current secondary heat output on the
Output network through nvoUnitStatus.
Secondary
UnitCool Numeric 0 to 100% Provides the current primary cool output on the
Output network through nvoUnitStatus.
UnitEcon Numeric 0 to 100% Provides the current economizer output on the
Output network through nvoUnitStatus.
UnitFan Output Numeric 0 to 100% Provides the current fan speed output on the
network through nvoUnitStatus.
UnitIn Alarm Numeric 0 to 255 Alarm status: 0 Means there is no alarm.
Any non-zero value means there is an alarm.
255 means that alarming is disabled.
EC-gfxProgram 839
Output(s)
Port Type Range Description
nviSpace Numeric -10°C to 50°C The current space temperature value from the network
Temp or the nviSpaceTemp input.
The default value of +327.67°C (invalid space
temperature value) is used during controller power-up
and when an update has not been received within the
specified receive heartbeat time.
nvoSpace Numeric -10°C to 50°C The same value found at the nvoSpaceTemp input.
Temp This is useful to make the current input values
available at a second instance of this block.
UnitMode Enum 0 to 12 The same value found at the UnitMode input. This is
useful to make the current input values available at a
second instance of this block.
UnitHeat Numeric 0 to 100% The same value found at the UnitHeatOutputPrimary
Output input. This is useful to make the current input values
Primary available at a second instance of this block.
UnitHeat Numeric 0 to 100% The same value found at the
Output UnitHeatOutputSecondary input. This is useful to
Secondary make the current input values available at a second
instance of this block.
UnitCool Numeric 0 to 100% The same value found at the UnitCoolOutput input.
Output This is useful to make the current input values
available at a second instance of this block.
UnitEcon Numeric 0 to 100% The same value found at the UnitEconOutput input.
Output This is useful to make the current input values
available at a second instance of this block.
UnitFan Numeric 0 to 100% The same value found at the UnitFanOutput input.
Output This is useful to make the current input values
available at a second instance of this block.
UnitInAlar Numeric 0 to 255 The same value found at the UnitInAlarm input. This
m is useful to make the current input values available at
a second instance of this block.
Any non-zero value means there is an alarm.
255 Means that alarming is disabled.
Block properties See Common block properties.
840 EC-gfxProgram
Advanced Configuration parameters for this block are set in the Resources Configura-
configuration tion window. The Space Comfort Controller Configuration window allows the
maximum receive time, and the minimum and maximum send times to be
specified. Network congestion occurs when network variables are transmitted
too frequently on the network. Network congestion can be reduced by only
transmitting network variables as frequently as is necessary to meet the sys-
tem requirements. Set the network properties as shown below (refer to the
controller’s Functional Profile in its datasheet). See also Typical controller
internal points.
Figure 497: Space Comfort Controller Configuration window
See Network Properties Configuration window (ECL, ECB & ECY Series).
Subnet Extension (ECL Series)
EC-gfxProgram 841
Description Provides an interface to a range of extension modules that can be connected
to certain ECL Series controller models. See your controller’s datasheet for
more information about the number and type of extension modules that are
supported. The following Modbus Extension module types are available:
• IR Remote: A hand-held remote control. See Infrared Remote Extension
Module Inputs and Outputs.
• Allure EC-Smart-Comfort Sensor: A range of wall-mounted sensors with
models that have colored LED indicators, rotary knobs to adjust the set-
point offset and fan speed, and a push-button to apply occupancy over-
ride. See Sensor Extension Module Inputs and Outputs.
• Allure EC-Smart-Air Sensor series: A range of wall-mounted sensors with
models that sense temperature, humidity and CO2. See Sensor Exten-
sion Module Inputs and Outputs.
• RJ-9 Gateway: Interfaces with a range of sensors and extension modules
that use RJ-9 connectors for their communications bus.
Depending on the extension module type selected, the number and type of
block inputs and outputs will vary.
Advanced Resources Configuration, Adding an extension module, Modbus extension
configuration configuration, Configure Ports, Show/Hide Ports, Upgrade firmware for Sub-
net extensions
Block properties See also Common block properties.
Property Type Range Default Description
Extension Menu See Not Set The extension module instance. Click
Description the drop-down arrow to open the Adding
an extension module window, in which
you add a new extension module by
clicking Manage extension modules.
Sensing extension module inputs and outputs
The available input and output ports will vary according to the sensor model
selected.
Input(s)
Port Type Range Description
EffectSet Numeric null-3 to +3 Sets the setpoint value to be displayed on the sensor
PointOffset extension module when SetpointMode = 0. This input
is not active when SetpointMode = 1. Standalone
mode is activated when EffectSetPointOffset = null.
842 EC-gfxProgram
Port Type Range Description
Setpoint Digital 0 or 1 If 0, use the default mode with SetpointSteps = 3 and
Mode SetpointRange = 3. If 1, use the values found at the
SetpointSteps and SetpointRange inputs.
Setpoint Numeric 0 to 100 When a user turns the setpoint knob, the knob has
Steps detents that provide tactile feedback. This sets the
numbers of detent the knob must be turned to go from
0 (neutral position) to full range set by SetpointMode
and SetpointRange.
Setpoint Numeric 0 to 99.9 The permitted range over which a user can change a
Range setpoint with the sensor’s setpoint adjustment knob.
Occupancy Enum 0 to 7 Current occupancy state.
Status
0 = OC_OCCUPIED
1 = OC_UNOCCUPIED
2 = OC_BYPASS
3 = OC_STANDBY
4 to 7 = Standalone mode: OccupancyStatus is set by
the user at the sensor. This is the default value if this
port is not connected.
FanSpeed Enum -1 to 6 The fan speed.
Status
-1 = AUTO
0 = OFF
1 = LOW
2 = MED
3 = HIGH
4 to 6 = Standalone: FanSpeedStatus output is set by
the user at the sensor. This is the default value if this
port is not connected.
Error Digital 0 or 1 Sets the sensor extension module into a specific
display mode to show that something is wrong on the
module. For example, a user has set it to an
unsupported mode. This mode will fast blink the
Occupancy LED thereby overriding the Occupancy
display.
Intensity Numeric 0 to 20 Sets the intensity of the sensor extension module’s
LEDs. 0 turns off all LEDs. 20 sets LEDs that are ON
to maximum brightness.
The default value is 14 if this port is not connected.
EC-gfxProgram 843
Port Type Range Description
SleepTime Numeric 0 to 65000 When a user changes a sensor’s setting, the sensor’s
seconds indicator lights turn on. This sets the amount of time
the sensor’s indicator lights will stay on after the last
user’s change to a setting. If this is set to 0, the
sensor’s indicator lights never turn off.
Elevation Numeric 0 to 4877m The sensor’s current elevation above mean sea level.
(for CO2 This compensates for the CO2 gas density ratio found
0 to 16 000ft
models at higher elevations. This input must be set for any
only) elevation above 500ft (152m) to obtain the highest
elevation compensation accuracy: The sensor will
automatically compensate CO2 readings for a number
of factors including the current room temperature and
the elevation.
Output(s)
Port Type Range Description
SpaceTemp Numeric -40 to 150 The room’s temperature.
NOTE: Any change in the measurement system of
the project results in the output value being
converted.
CO2 Numeric 0 to 2000ppm The measured CO2 concentration.
Humidity Numeric 0 to 99.9 The room’s relative humidity.
Setpoint Numeric -99.9 to 99.9 The current temperature setpoint. This value is
Offset equal to EffectSetpointOffset input when there is
no user action. When the user changes the setpoint
and releases the sensor’s setpoint adjustment knob,
the modified value remains on this output port for 5
seconds after which the value returns to the
EffectSetpointOffset input value.
Occupancy Enum 0 to 3 Current occupancy state.
0 = OC_OCCUPIED (by pressing the sensor’s
occupancy button, a user has turned off the
occupancy LED)
1 = OC_UNOCCUPIED (by pressing the sensor’s
occupancy button, a user has turned on the
occupancy LED)
2 = OC_BYPASS
3 = OC_STANDBY
User action can only select 0 = OC_OCCUPIED or 1
= OC_UNOCCUPIED.
844 EC-gfxProgram
Port Type Range Description
FanSpeed Enum -1 to 3 The fan speed.
-1 = AUTO
0 = OFF
1 = LOW
2 = MED
3 = HIGH
Error Numeric 0 to 4 This is the fault status of the sensor extension
module
0 = No error
1 = CO2 Error
2 = Humidity Error
4 = Temperature Error
SetPoint Digital 0 or 1 Outputs a pulse when a user changes the setpoint
OffsetUpdate setting.
Occupancy Digital 0 or 1 Outputs a pulse when a user changes the
Update occupancy setting.
FanSpeed Digital 0 or 1 Outputs a pulse when a user changes the fan speed
Update setting.
DigitalInput Digital 0 or 1 When an option connector is present:
Update1 to
• With a short push or click (<800ms), this outputs
DigitalInput
a pulse when the user presses a button.
Update8
• With a long push (>800ms), this outputs a pulse
when the user first presses a button and another
pulse when the user releases the button.
DigitalInput1 Numeric 0 to 2 When an option connector is present, these digital
to inputs are used for a push button extension module
DigitalInput8 to control sunblind / shade movement, lighting, and /
or any other application:
0 = No action
1 = Long push (>800ms)
2 = Short push or click (<800ms)
EC-gfxProgram 845
RJ-9 Gateway inputs and outputs
The RJ-9 interfaces with a range of sensors and extension modules that use
RJ-9 connectors for their communications bus.
Input(s)
Port Type Range Description
EffectSet Numeric null-3 to +3 Sets the setpoint value to be displayed on the sensor
PointOffset extension module when SetpointMode = 0. This input
is not active when SetpointMode = 1. Standalone
mode is activated when EffectSetPointOffset = null.
Temperature Numeric null0 to 99.9 When the input is not null, this is the current room
temperature to be displayed. Standalone mode is
activated when Temperature = null; the device
displays its own temperature measurement.
NOTE: Any change in the measurement system of the
project results in the output value being con-
verted.
Occupancy Enum 0 to 7 Current occupancy state.
Status
0 = OC_OCCUPIED
1 = OC_UNOCCUPIED
2 = OC_BYPASS
3 = OC_STANDBY
4 to 7 = Standalone mode: OccupancyStatus is set by
the user at the sensor. This is the default value if this
port is not connected.
FanSpeed Enum -1 to 6 The fan speed.
Status
-1 = AUTO0 = OFF
1 = LOW
2 = MED
3 = HIGH
4 to 6 = Standalone: FanSpeedStatus output is set by
the user at the sensor. This is the default value if this
port is not connected.
846 EC-gfxProgram
Port Type Range Description
EcoVue Enum 0 to 4 Sets the Eco Vue icon display properties. To
encourage occupants to be as green as possible, the
Eco Vue icon can be programmed to show more
leaves when the occupant chooses a setpoint that
reduces energy use. This helps to promote awareness
for energy consciousness and to save operational
costs.
0: Automatic
1: Low energy efficiency
2: Moderate energy efficiency
3: Higher energy efficiency
4: Highest energy efficiency
SensorZone Numeric 0 to 7 This value forces a receiver to use a specific ID
channel. A receiver only accepts commands from
remote controls that are set to the same ID channel.
However, when the receiver’s ID channel is set to 0,
this block will accept commands from all remote
controls set to any ID channel. By pairing a remote
control to a zone controller (by using a common ID
channel number between 1 and 7) prevents a user
from being able to control another zone controller that
is using another ID channel number. This is useful in
open space offices or when walls are made of glass.
NOTE: The factory default ID channel for remotes and
receivers is 0. Once a remote is paired to a
receiver, the user can change the ID channel
on the remote, which will also change the ID
channel of the paired receiver at the same time
so that both the remote and receiver remain
paired on the same ID channel.
The receiver acts on the last command to
change the ID channel, either from the remote
control or from this input value.
EC-gfxProgram 847
Output(s)
Port Type Range Description
SpaceTemp Numeric -40 to 150 The room’s temperature.
NOTE: Any change in the measurement system of
the project results in the output value being
converted.
Setpoint Offset Numeric -99.9 to 99.9 The current temperature setpoint. This value is
equal to EffectSetpointOffset input when there is
no user action. When the user changes the setpoint
and releases the sensor’s setpoint adjustment knob,
the modified value remains on this output port for 5
seconds after which the value returns to the
EffectSetpointOffset input value.
Occupancy Enum 0 to 3 Current occupancy state.
0 = OC_OCCUPIED (by pressing the sensor’s
occupancy button, a user has turned off the
occupancy LED)
1 = OC_UNOCCUPIED (by pressing the sensor’s
occupancy button, a user has turned on the
occupancy LED)
2 = OC_BYPASS
3 = OC_STANDBY
User action can only select 0 = OC_OCCUPIED or 1
= OC_UNOCCUPIED.
FanSpeed Enum -1 to 3 The fan speed.
-1 = AUTO
0 = OFF
1 = LOW
2 = MED
3 = HIGH
848 EC-gfxProgram
Port Type Range Description
LastGroup Enum 0 to 10 When a command is received from the remote
Updated control, this value indicates the group or range of
groups that the command was for.
0 = Group 1-2
1 = Group 1
2 = Group 2
3 = Group 3
4 = Group 4
5 = Group 5
6 = Group 6
7 = Group 7
8 = Group 8
9 = Group 1-4
10 = Group 1-8
LastGroup Enum 0 to 7 The last command received from the remote control.
Command
Light stop (0): Stop all light dimming commands.
This command is received after a user releases a
light command button.
Light up (1): Increase the lighting intensity.
Light down (2): Lower the lighting intensity.
Sunblind up (3): Raise the sunblind / shade.
Sunblind down (4): Lower the sunblind / shade.
Sunblind rotation up (5): Rotate the sunblind /
shade up.
Sunblind rotation down (6): Rotate the sunblind /
shade down.
Sunblind stop (7): Stop all sunblind movement.
This command is received after a user releases a
sunblind command button.
EC-gfxProgram 849
Port Type Range Description
Group1 to Enum 0 to 7 The current user value sent by the remote control:
Group8
Light stop (0): Stop all light dimming commands.
This command is received after a user releases a
light command button.
Light up (1): Increase the lighting intensity.
Light down (2): Lower the lighting intensity.
Sunblind up (3): Raise the sunblind / shade.
Sunblind down (4): Lower the sunblind / shade.
Sunblind rotation up (5): Rotate the sunblind /
shade up.
Sunblind rotation down (6): Rotate the sunblind /
shade down.
Sunblind stop (7): Stop all sunblind movement.
This command is received after a user releases a
sunblind command button.
SetPoint Digital 0 or 1 Outputs a pulse when a user changes the setpoint
OffsetUpdate setting.
Occupancy Digital 0 or 1 Outputs a pulse when a user changes the
Update occupancy setting.
FanSpeed Digital 0 or 1 Outputs a pulse when a user changes the fan speed
Update setting.
MotionUpdate Digital 0 or 1 Outputs a pulse when motion is detected.
GroupUpdate Digital 0 or 1 Outputs a pulse when a user changes a light or
sunblind setting.
LuxLevel Numeric 0 to 4000 The current room light level in Lux measured at the
Multi Sensor.
850 EC-gfxProgram
Adding an extension module
The Extension Module window lists the configured extension modules. To
view this window, select this block on the Programming Sheet and in the
block’s Properties, click the drop-down arrow for Extension. This block
instance will use the extension module selected in this window.
Figure 498: Extension module window
Parameter Description
Delete
Selecting deletes the selected extension module.
Manage Opens the Modbus Extension Configuration window.
extension
modules
Modbus When adding an extension module, select the model type connected to the
extension controller in Modbus Extension and click OK.
configuration
Figure 499: Extension module model type selection
Select this block on the Programming Sheet and in the block’s Properties,
click the drop-down arrow for Extension and select the extension this block is
to use in the Extension Module Window (Figure 498).
EC-gfxProgram 851
Subnet Extension (ECB & ECY Series)
Description Provides an interface to a range of extension modules that can be connected
to certain ECB & ECY Series controller models. See your controller’s data-
sheet for more information about the number and type of extension modules
that are supported. The following Modbus Extension module types are avail-
able:
• IR Remote: A hand-held remote control.
• Allure EC-Smart-Comfort Sensor: A range of wall-mounted sensors with
models that have colored LED indicators, rotary knobs to adjust the set-
point offset and fan speed, and a push-button to apply occupancy over-
ride. See Sensor extension module inputs and outputs.
• Allure EC-Smart-Air Sensor series: A range of wall-mounted sensors with
models that sense temperature, humidity and CO2. See Sensor extension
module inputs and outputs.
• RJ-9 Gateway: Interfaces with a range of sensors and extension modules
that use RJ-9 connectors for their communications bus. See RJ Adapter
Gateway inputs and outputs.
Depending on the extension module type selected, the number and type of
block inputs and outputs will vary.
Advanced Resources Configuration, Adding an extension module, Modbus extension
configuration configuration, Configure Ports, Show/Hide Ports, Upgrade firmware for Sub-
net extensions
852 EC-gfxProgram
Block properties See also Common block properties.
Property Type Range Default Description
Extension Menu See Not Set The extension module instance. Click the
Description drop-down arrow to open the Adding an
extension module window, in which you add
a new extension module by clicking Manage
extension modules.
Sensor extension module inputs and outputs
The available input and output ports will vary according to the sensor model
selected.
Input(s)
Port Type Range Description
EffectSet Numeric null, Sets the setpoint value to be displayed on the
PointOffset sensor extension module when SetpointMode = 0.
-3 to +3
This input is not active when SetpointMode = 1.
Standalone mode is activated when
EffectSetPointOffset = null.
Setpoint Mode Digital 0 or 1 If 0, use the default mode with SetpointSteps = 3
and SetpointRange = 3. If 1, use the values found at
the SetpointSteps and SetpointRange inputs.
Setpoint Steps Numeric 0 to 100 When a user turns the setpoint knob, the knob has
detents that provide tactile feedback. This sets the
numbers of detent the knob must be turned to go
from 0 (neutral position) to full range set by
SetpointMode and SetpointRange.
Setpoint Range Numeric 0 to 99.9 The permitted range over which a user can change
a setpoint with the sensor’s setpoint adjustment
knob.
Occupancy Enum 1 to 8 Current occupancy state.
Status
1 = OC_OCCUPIED
2 = OC_UNOCCUPIED
3 = OC_BYPASS
4 = OC_STANDBY
5 to 8 = Standalone mode: OccupancyStatus is set
by the user at the sensor. This is the default value if
this port is not connected.
EC-gfxProgram 853
Port Type Range Description
FanSpeed Enum 1 to 8 The fan speed.
Status
1 = AUTO
2 = OFF
3 = LOW
4 = MED
5 = HIGH
6 to 8 = Standalone FanSpeedStatus output is set by
the user at the sensor. This is the default value if this
port is not connected.
Error Digital 0 or 1 Sets the sensor extension module into a specific
display mode to show that something is wrong on
the module. For example, a user has set it to an
unsupported mode. This mode will fast blink the
Occupancy LED thereby overriding the Occupancy
display.
Intensity Numeric 0 to 20 Sets the intensity of the sensor extension module’s
LEDs. 0 turns off all LEDs. 20 sets LEDs that are ON
to maximum brightness.
The default value is 14 if this port is not connected.
SleepTime Numeric 0 to 65000 When a user changes a sensor’s setting, the
seconds sensor’s indicator lights turn on. This sets the
amount of time the sensor’s indicator lights will stay
on after the last user’s change to a setting. If this is
set to 0, the sensor’s indicator lights never turn off.
Elevation (for Numeric 0 to 4877m The sensor’s current elevation above mean sea
CO2 models level. This compensates for the CO2 gas density
0 to 16 000ft
only) ratio found at higher elevations. This input must be
set for any elevation above 500ft (152m) to obtain
the highest elevation compensation accuracy: The
sensor will automatically compensate CO2 readings
for a number of factors including the current room
temperature and the elevation.
Output(s)
Port Type Range Description
SpaceTemp Numeric -40 to 150 The room’s temperature.
NOTE: Any change in the measurement system of
the project results in the output value being
converted.
854 EC-gfxProgram
Port Type Range Description
CO2 Numeric 0 to The measured CO2 concentration.
2000ppm
Humidity Numeric 0 to 99.9 The room’s relative humidity.
Setpoint Offset Numeric -99.9 to 99.9 The current temperature setpoint. This value is
equal to EffectSetpointOffset input when there is
no user action. When the user changes the setpoint
and releases the sensor’s setpoint adjustment knob,
the modified value remains on this output port for 5
seconds after which the value returns to the
EffectSetpointOffset input value.
Occupancy Enum 1 to 4 Current occupancy state.
1 = OC_OCCUPIED (by pressing the sensor’s
occupancy button, a user has turned off the
occupancy LED)
2 = OC_UNOCCUPIED (by pressing the sensor’s
occupancy button, a user has turned on the
occupancy LED)
3 = OC_BYPASS
4 = OC_STANDBY
User action can only select 1 = OC_OCCUPIED or 2
= OC_UNOCCUPIED.
FanSpeed Enum 1 to 5 The fan speed.
1 = AUTO
2 = OFF
3 = LOW
4 = MED
5 = HIGH
Error Numeric 0 to 4 This is the fault status of the sensor extension
module.
0 = No error
1 = CO2 Error
2 = Humidity Error
4 = Temperature Error
SetPoint Digital 0 or 1 Outputs a pulse when a user changes the setpoint
OffsetUpdate setting.
Occupancy Digital 0 or 1 Outputs a pulse when a user changes the
Update occupancy setting.
EC-gfxProgram 855
Port Type Range Description
FanSpeed Digital 0 or 1 Outputs a pulse when a user changes the fan speed
Update setting.
DigitalInput Digital 0 or 1 When an option connector is present:
Update1 to
• With a short push or click (<800ms), this outputs
DigitalInput
a pulse when the user presses a button.
Update8
• With a long push (>800ms), this outputs a pulse
when the user first presses a button and another
pulse when the user releases the button.
DigitalInput1 to Numeric 0 to 2 When an option connector is present, these digital
DigitalInput8 inputs are used for a push button extension module
to control sunblind / shade movement, lighting, and /
or any other application:
0 = No action
1 = Long push (>800ms)
2 = Short push or click (<800ms)
RJ Adapter Gateway inputs and outputs
The RJ-9 interfaces with a range of sensors and extension modules that use
RJ-9 connectors for their communications bus.
Input(s)
Port Type Range Description
EffectSet Numeric null Sets the setpoint value to be displayed on the
PointOffset sensor extension module when SetpointMode = 0.
-3 to +3
This input is not active when SetpointMode = 1.
Standalone mode is activated when
EffectSetPointOffset = null.
Temperature Numeric null When the input is not null, this is the current room
temperature to be displayed. Standalone mode is
0 to 99.9
activated when Temperature = null; the device
displays its own temperature measurement.
NOTE: Any change in the measurement system of
the project results in the output value being
converted.
856 EC-gfxProgram
Port Type Range Description
Occupancy Enum 1 to 8 Current occupancy state.
Status
1 = OC_OCCUPIED
2 = OC_UNOCCUPIED
3 = OC_BYPASS
4 = OC_STANDBY
5 to 8 = Standalone mode: OccupancyStatus is set
by the user at the sensor. This is the default value if
this port is not connected.
FanSpeed Enum 1 to 8 The fan speed.
Status
1 = AUTO
2 = OFF
3 = LOW
4 = MED
5 = HIGH
6 to 8 = Standalone: FanSpeedStatus output is set
by the user at the sensor. This is the default value if
this port is not connected.
EcoVue Enum 0 to 4 Sets the Eco Vue icon display properties. To
encourage occupants to be as green as possible,
the Eco Vue icon can be programmed to show more
leaves when the occupant chooses a setpoint that
reduces energy use. This helps to promote
awareness for energy consciousness and to save
operational costs.
0: Automatic
1: Low energy efficiency
2: Moderate energy efficiency
3: Higher energy efficiency
4: Highest energy efficiency
EC-gfxProgram 857
Port Type Range Description
SensorZone Numeric 0 to 7 This value forces a receiver to use a specific ID
channel. A receiver only accepts commands from
remote controls that are set to the same ID channel.
However, when the receiver’s ID channel is set to 0,
this block will accept commands from all remote
controls set to any ID channel. By pairing a remote
control to a zone controller (by using a common ID
channel number between 1 and 7) prevents a user
from being able to control another zone controller
that is using another ID channel number. This is
useful in open space offices or when walls are made
of glass.
NOTE: The factory default ID channel for remotes
and receivers is 0. Once a remote is paired
to a receiver, the user can change the ID
channel on the remote, which will also
change the ID channel of the paired receiver
at the same time so that both the remote and
receiver remain paired on the same ID chan-
nel.
The receiver acts on the last command to
change the ID channel, either from the
remote control or from this input value.
Output(s)
Port Type Range Description
SpaceTemp Numeric -40 to 150 The room’s temperature.
NOTE: Any change in the measurement system of
the project results in the output value being
converted.
Setpoint Offset Numeric -99.9 to 99.9 The current temperature setpoint. This value is
equal to EffectSetpointOffset input when there is
no user action. When the user changes the setpoint
and releases the sensor’s setpoint adjustment knob,
the modified value remains on this output port for 5
seconds after which the value returns to the
EffectSetpointOffset input value.
858 EC-gfxProgram
Port Type Range Description
Occupancy Enum 1 to 4 Current occupancy state.
1 = OC_OCCUPIED (by pressing the sensor’s
occupancy button, a user has turned off the
occupancy LED)
2 = OC_UNOCCUPIED (by pressing the sensor’s
occupancy button, a user has turned on the
occupancy LED)
3 = OC_BYPASS
4 = OC_STANDBY
User action can only select 1 = OC_OCCUPIED or 2
= OC_UNOCCUPIED.
FanSpeed Enum 1 to 5 The fan speed.
1 = AUTO
2 = OFF
3 = LOW
4 = MED
5 = HIGH
LastGroup Enum 0 to 10 When a command is received from the remote
Updated control, this value indicates the group or range of
groups that the command was for.
0 = Group 1-2
1 = Group 1
2 = Group 2
3 = Group 3
4 = Group 4
5 = Group 5
6 = Group 6
7 = Group 7
8 = Group 8
9 = Group 1-4
10 = Group 1-8
EC-gfxProgram 859
Port Type Range Description
LastGroup Enum 1 to 8 The last command received from the remote control.
Command
Light stop (1): Stop all light dimming commands.
This command is received after a user releases a
light command button.
Light up (2): Increase the lighting intensity.
Light down (3): Lower the lighting intensity.
Sunblind up (4): Raise the sunblind / shade.
Sunblind down (5): Lower the sunblind / shade.
Sunblind rotation up (6): Rotate the sunblind /
shade up.
Sunblind rotation down (7): Rotate the sunblind /
shade down.
Sunblind stop (8): Stop all sunblind movement.
This command is received after a user releases a
sunblind command button.
Group1 to Enum 1 to 8 The current user value sent by the remote control:
Group8
Light stop (1): Stop all light dimming commands.
This command is received after a user releases a
light command button.
Light up (2): Increase the lighting intensity.
Light down (3): Lower the lighting intensity.
Sunblind up (4): Raise the sunblind / shade.
Sunblind down (5): Lower the sunblind / shade.
Sunblind rotation up (6): Rotate the sunblind /
shade up.
Sunblind rotation down (7): Rotate the sunblind /
shade down.
Sunblind stop (8): Stop all sunblind movement.
This command is received after a user releases a
sunblind command button.
SetPoint Digital 0 or 1 Outputs a pulse when a user changes the setpoint
OffsetUpdate setting.
Occupancy Digital 0 or 1 Outputs a pulse when a user changes the
Update occupancy setting.
FanSpeed Digital 0 or 1 Outputs a pulse when a user changes the fan speed
Update setting.
MotionUpdate Digital 0 or 1 Outputs a pulse when motion is detected.
GroupUpdate Digital 0 or 1 Outputs a pulse when a user changes a light or
sunblind setting.
860 EC-gfxProgram
Port Type Range Description
LuxLevel Numeric 0 to 4000 The current room light level in Lux measured at the
Multi Sensor.
Sunblind Output (ECL Series expansion module)
Description Used to interface to a sunblind output of a sunblind / shade expansion module
that is connected to a controller’s subnetwork bus. This block is only available
with controller models that support this expansion module. This block can be
used to control horizontal / vertical blinds (with slat rotation angle) or shutters /
shades (without slat rotation angle).
Number of The number of sunblind outputs varies according to the number of connected
blocks sunblind modules, up to a maximum of 8 sunblind outputs. See the control-
ler’s datasheet for more information about the number of expansion modules
that are supported.
Each sunblind expansion module also has 4 multi-level inputs. See Light Sun-
blind Input (ECL Series Expansion Modules).
Advanced Resources Configuration, Managing Light and Sunblind module instances,
configuration Manage Light and Sunblind Modules window, Light and Sunblind module con-
figuration, Network Properties Configuration window (ECL, ECB & ECY
Series), Override and auto, Find All References (ECL, ECB & ECY Series),
Copy From, Configure Ports, Show/Hide Ports
Related blocks Light Output (ECL Series expansion modules), Light Sunblind Input (ECL
Series expansion modules)
EC-gfxProgram 861
Input(s)
Port Type Range Description
Function Enum Nul (-1) Sets the sunblind output action. See Function,
Translation, and Rotation Input truth table.
Off (0)
A new Translation or Rotation value is taken
On (1)
into account only when there is a change of
Down (2) Function value or the Trigger input is activated.
Up (3)
Stop (4)
State (5)
Translation Numeric 0 to 100% Set the sunblind position. See Function,
Translation, and Rotation Input truth table.
A new value is taken into account only when
there is a change of Function value or the
Trigger input is activated.
Rotation Numeric -359.98º to 360º Set the sunblind rotation angle. See Function,
Translation, and Rotation Input truth table.
A new value is taken into account only when
there is a change of Function value, the
Trigger input is activated, or there is a change
in either the Translation or Rotation input value
when the Function input is set to State.
Trigger Digital 0 or 1 Forces a write action of the current block’s
Rotation Input and Translation Input values to
the expansion module’s hardware. This is
necessary when you want to force the execution
of the same command again when there is no
change of value at the Function input.
For example, to lower the sunblind / shade by
10% and then later again by 10%, proceed as
follows: With the Rotation Input set to Nul, set
the Translation Input port to 10% and the
Function input to Down, then set the Trigger
input to 1 to again push the change to expansion
module’s output.
862 EC-gfxProgram
Function, There is interplay between the Function, Translation, and Rotation Input
Translation, and settings for this block. The following truth table explains the effect of input val-
Rotation Input ues on sunblind translation and rotation.
truth table
Function
Translation
Input Rotation Input Sunblind / Shade
Input “x” Description
Enumeration “α” Value1 Behavior
Value1
Value
Nul (-1) Any value / Any value / – Cancels the last command
Irrelevant Irrelevant of the Function,
Translation, and Rotation
inputs.
Off (0) Any value / Any value / Mode Off Take no action.
Irrelevant Irrelevant
On (1) Any value / Any value / Mode On Take no action.
Irrelevant Irrelevant
Down (2) Nul Nul Sunblind Sunblind / shade lowersa or
moves down until Stop value is received
at the Function input.
Nul 0° <= α <= 360° Relative slat Sunblind / shade rotatesa
angle the slats downwards by a
downwards relative angle of α.
For example, if the
Sunblind is a 0° and the
Rotation input value is 15°,
setting the Function input
to Down will angle the slat
angle to -15° (0° - 15°).
0 < x < 100% 0° <= α <= 360° Sunblind / Lowersa the sunblind /
slats move shade by x percent and
down rotatesa the slats
relatively downwards by a relative
angle of α.
If α = 0: At the new sunblind
position, the slat angle
remains unchanged.
0 < x < 100% Nul Sunblind Lowersa the sunblind /
moves down shade by x percent.
relatively
Up (3) Nul Nul Sunblind Sunblind / shade raisesa or
moves up until Stop value is received
relatively at the Function input.
EC-gfxProgram 863
Function
Translation
Input Rotation Input Sunblind / Shade
Input “x” Description
Enumeration “α” Value1 Behavior
Value1
Value
Nul 0° <= α <= 360° Relative slat Sunblind / shade rotatesa
angle the slats upwards by a
upwards relative angle of α.
For example, if the
Sunblind is a 0° and the
Rotation input value is 15°,
setting the Function input
to Up will angle the slat
angle to 15° (0° + 15°).
0 <= x <= 0° <= α <= 360° Sunblind / Raisesa the sunblind /
100% slats move shade by x percent and
upwards
rotatesa the slats upwards
relatively
by a relative angle of α.
If α = 0: At the new sunblind
position, the slat angle
remains unchanged.
0 <= x <= Nul Sunblind Raisesa the sunblind /
100% moves up shade by x percent.
relatively
Stop (4) Any value / Any value / Sunblind Stops the sunblind / shade
Irrelevant Irrelevant stops movement immediately.
State (5) 0 <= x <= Nul Setting Sets of the absolute
100% sunblind’s translation positiona as
position only defined by the Translation
input.
Nul -360 < α <= 360° Setting Sets of the absolute
sunblind’s rotation anglea as defined
slat angle by the Rotation input.
only
0 <= x <= -360 < α <= 360° Setting Sets the absolute sunblind /
100% Sunblind to shade translation positiona
position x
to x and slat rotation anglea
and to slat
to α.
angle α
a. Sunblind / shade translation and rotation always remains within the limits set
in the block’s advanced configuration. See Configure the Sunblind output.
864 EC-gfxProgram
Output(s)
Port Type Range Description
Translation Numeric 0 to 100% Effective value of the expansion module’s
Translation output.
Translation Numeric 0 to 100% Current translation position. This takes into
Feedback account any user command from a remote
control.
Translation Digital 0 or 1 See Out-of-Service.
OutOfService
Translation Fault Digital 0 or 1 This is logically True (1) if the Reliability
Property does not have a value of No Fault
Detected, otherwise logical False (0).
Translation Enum See When communication to the expansion module
Reliability Description is lost, this becomes Communication Failure.
If the configuration does not match the current
device, this becomes Configuration Error.
Otherwise this is No Fault Detected.
Translation Integer 0 to 4 The current active priority. See Priority levels in
Priority LONWORKS (ECL Series).
Rotation Numeric -359.98º to Effective value of the expansion module’s
360º Rotation output.
RotationFeedba Numeric -359.98º to Current rotation angle. This takes into account
ck 360º any user command from a remote control.
Rotation Digital 0 or 1 See Out-of-Service.
OutOfService
RotationFault Digital 0 or 1 This is logically True (1) if the Reliability
property does not have a value of No Fault
Detected, otherwise logical False (0).
Rotation Enum See When communication to the expansion module
Reliability Description is lost, this becomes Communication Failure.
If the configuration does not match the current
device, this becomes Configuration Error.
Otherwise this is No Fault Detected.
Rotation Priority Integer 0 to 4 The current active priority. See Priority levels in
LONWORKS (ECL Series).
Runtime Numeric 0 to 3.4028 × The output’s operating time in minutes for both
1038 translation and rotation combined.
Number Integer 1 to 8 The current block number. This is set through
Number in the Block’s Properties pane.
EC-gfxProgram 865
Block properties See also Common Block Properties.
Property Type Range Default Description
Number Menu See Sunblind The Sunblind Output block instance. Click
Description Output the drop-down arrow to open the
Managing Light and Sunblind module
instances window, in which you first add
light and sunblind modules by clicking
Manage Light and Sunblind Modules.
See Figure 501.
Once sunblind expansion modules have
been added to the controller, the Source
column shows the sunblind expansion
module on which the output is located.
Use this drop-down menu to select a
physical sunblind module output on a
connected expansion module.
The number of Sunblind Output block
instances supported by a controller is
shown in the Statistics pane.
Horizontal/ The following diagrams define the meaning of parameters used for this block.
Vertical blind Confirm these operational parameters with your blind (shade) manufacturer/
translation and installer.
rotation
Figure 500: Horizontal/Vertical blind translation and rotation example
866 EC-gfxProgram
Managing Light The configuration of the sunblind expansion module outputs, the light expan-
and Sunblind sion module outputs, and the light sunblind inputs are configured in the
module Resource Tree of the Resources Configuration under Light Sunblind Mod-
instances ules (see Figure 503). This lists the currently configured light and sunblind
modules as well as their input’s name, output’s name and module number
according to the light or sunblind expansion module currently connected to
the controller. This block instance will use the module’s input or output
selected in this window. The first light or sunblind outputs shown are from the
light or sunblind expansion module configured with the lowest subnetwork
address. Likewise, the highest light or sunblind outputs shown are from the
light or sunblind expansion module configured with the highest subnetwork
address.
Configuring the Configure the block’s inputs and outputs as follows.
block’s inputs
and outputs 1. Select the block that is to be configured.
2. Open the Properties Pane for the block.
3. Click the drop-down list arrow for the Number property.
Figure 501: Manage Module Instance window
Parameter Description
Source column The name of a previously configured light or sunblind
expansion module. They are arranged in sequential
order according to their subnet MAC address setting
(lowest MAC address first).
Number column This is the sequential order of sunblind or light outputs.
Name column The output’s name. The name of an output is the same
as the block’s name, when this output is selected for
the block.
Type column The light or sunblind expansion module type.
EC-gfxProgram 867
Parameter Description
Manage Light Opens Resources Configuration for module
and Sunblind configuration.
Modules
4. In the lower left corner of the Manage Module Instance window, click
Manage light and sunblind modules. See Figure 501.
5. Add an expansion module to the Resources list by right-clicking the Light
Sunblind Modules tree and selecting Add or Learn.
Figure 502: Light and Sunblind modules tree options
Parameter Description
Add Adds a module to the controller. In the Model type
drop-down, select the model of light or sunblind
expansion module. To configure the expansion module,
see Light and Sunblind module configuration.
Learn When the connection status for the controller is
Connected, this scans the controller’s subnetwork bus
for connected expansion modules, when each
expansion module has a unique subnet ID (MAC)
address on the controller’s subnet bus. Using this
feature will delete any previously configured expansion
modules.
NOTE: Learn is only available after 2 minutes of the
controller having been powered up. This infor-
mation is no longer available after 30 minutes.
Reboot the controller if Learn is unable to find
the connected modules (in Project Synchroni-
zation, select Download to device and
Reboot controller only).
868 EC-gfxProgram
6. The Resources Configuration allows you to configure all connected Light
and Sunblind Modules. In the Model type drop-down, select the model of
light or sunblind expansion module.
Figure 503: Manage Light and Sunblind Modules window
Each expansion module has the following options.
Figure 504: Expansion module drop-down menu
Parameter Description
Rename Rename the selected expansion module or output.
Renaming an expansion module changes its name
shown in the Source column in the Manage Module
Instance Window. See Figure • 9. The name of an
output is the same as the block’s name, when this
output is selected for the block.
Delete Deletes the selected expansion module.
7. In Default address, set the expansion modules’ subnet ID (MAC)
address for this expansion module instance.
Figure 505: Default address: setting an expansion module’s Subnet ID (MAC)
address
EC-gfxProgram 869
According to the model type selected, a default subnet ID address num-
ber is shown. This default subnet ID address number corresponds to the
default expansion modules’ subnet ID address when the expansion mod-
ules’ MAC DIP switch is set to 0 (or all off – the factory default position).
This eliminates the need to configure the expansion modules’ MAC DIP
switch when there are no more than one of each type of expansion mod-
ule connected to the controller’s subnet bus.
Auto-assigned Subnet ID Address when the expansion modules’ MAC
Expansion
DIP Switch is set to 0 (factory default position)
Module Model
Type
1 2 3 4
4 lights 230V
4 DALI buses
4 dimming lights
4 sunblinds 230V
4 sunblinds 24V
If there are two of the same type of expansion modules connected to the
controller’s subnet bus, you must set at least one of the two expansion
modules’ MAC DIP switch to a unique (that is, unused) subnet ID (MAC)
address and then set the same value in Default address.
8. To configure the expansion module, see Light and Sunblind module con-
figuration, below.
Light and Once one or more light or sunblind expansion modules have been added to
Sunblind module the Light and Sunblind Modules tree, expand a module and select a Light or
configuration Sunblind output, or a Light Sunblind Input to see its configuration screen.
For the LONWORKS Properties, see Network Properties Configuration win-
dow (ECL, ECB & ECY Series).
To configure:
• A light output, see Configure the Light Output
• A sunblind/shade output, see Configure the Sunblind output.
• A light or sunblind hardware input, see Configure a Light Sunblind Hard-
ware Input.
Configure the Configure a Light Output in the Resources Configuration as follows.
Light Output
870 EC-gfxProgram
Figure 506: Dimmable light output configuration (ECL)
Figure 507: Dimmable light output configuration (ECB)
Figure 508: Dimmable light output configuration (ECY)
Figure 509: DALI light output configuration (ECL)
Figure 510: DALI light output configuration (ECB)
Figure 511: DALI light output configuration (ECY)
EC-gfxProgram 871
Figure 512: On/Off light output configuration (ECL)
Figure 513: On/Off light output configuration (ECB)
Figure 514: On/Off light output configuration (ECY)
Parameter Description
Object name Used to identify this input in the and on the controller’s
operator interface (if equipped).
Description Description of the resource.
Color manage- Only available on ECY controllers. Sets the color man-
ment (for DALI- agement type for a lighting module that supports the
enabled outputs DALI Type 8 Command. The default None value dis-
only) ables color management. Select Tunable White if you
want to manage color temperature. Select RGB or
RGBW to manage light colors. As soon as you activate
color management, by selecting a value other than
None, the Color input port is added to the lighting mod-
ule. See Light Output (ECB & ECY Series expansion
modules).
Dimming Set how a lighting level change is handled with regard
management to the Dimming Time value.
(for dimming
From 0 to 100%: The dimming rate of change is
enabled outputs
constant, that is, Dimming Time defines the time for
only)
the lighting level to go from 0% to 100% or vice versa.
For example, a command to go from 20% to 70% will
take one-half the Dimming Time to be carried out.
From actual to next value: Any new commanded light
level always takes the same amount of time to be
carried out, as set by Dimming Time.
DALI transition: standard transition value as per the
DALI protocol. When this value is selected, the
transitions are managed directly by the ballast/driver
rather than the expansion module.
872 EC-gfxProgram
Parameter Description
Dimming time When Dimming management is set to Dimming
(for dimming Time, this sets the number of seconds for the light level
enabled outputs to go from 0 to 100% or vice versa. This can be
only) overridden (fade time = 0) when the block’s Dimming
Disabled input is set to 1.
When Dimming management is set to From actual to
next value, this sets the number of seconds for the
light level to go from its current value to the next
commanded value. This can be overridden (fade time =
0) when the block’s Dimming Disabled input is set to
1.
Default value This sets the expansion module’s output to this default
value when:
• The output has not been written to (is in an unexe-
cuted Conditional Custom Block for example).
• A light expansion module has lost communications
with the controller.
Common The current name used to identify this Network Variable
network name output on the network. See Network Properties
Configuration window (ECL, ECB & ECY Series).
Configure the Configure the Sunblind Output in the Resources Configuration as follows.
Sunblind output
Figure 515: 230V Sunblind Output configuration
EC-gfxProgram 873
Figure 516: 12-24V Sunblind Output configuration
Parameter Description
Object name Used to identify this input in the Resource Viewer and
on the controller’s operator interface (if equipped).
Boot delay The motor of some blinds / shades have electronics
that delay operation when power is first applied. Set
this to the actual amount of delay before the motor
reacts to being powered. See the blind / shade motor’s
datasheet for the amount of startup delay time to set.
Common The current name used to identify this Network Variable
network name output on the network. See Network Properties
Configuration window (ECL, ECB & ECY Series).
Translation time This sets the time for the blind / shade to go from its
fully retracted position to its fully deployed position or
vice versa.
Translation min This sets the blind’s / shade’s minimum position
position beyond which it will not retract as a percentage of the
total blind’s / shade’s translation movement.
Translation max This sets the blind’s / shade’s maximum position
position beyond which it will not deploy as a percentage of the
total blind’s / shade’s translation movement.
874 EC-gfxProgram
Parameter Description
Translation This sets the blind’s / shade’s default translation
default value position when:
• The output has not been written to (is in an unexe-
cuted Conditional Custom Block for example).
• A sunblind module has lost communications with
the controller.
Translation Set this option to invert the translation position, to
reverse action correct a wiring mistake.
Rotation time This sets the time for the blind / shade to rotate from
one extreme to the other, between Rotation abs min
position and Rotation abs max position.
Rotation steps When a blind / shade is commanded by a user (for
example, through a remote control), this slows-down
blind rotation by introducing rotation steps. This gives a
user enough time to react to the actual blind rotation.
This sets a percentage of the total rotation for each
rotation step that is then followed by a pause set by
Rotation inter-step delay.
For example, if this is set to 10%, and the blind’s /
shade’s total rotation is 90°, a user command will rotate
the blind in steps of 9° (10% × 90°), between the range
set by Rotation max position and Rotation min
position.
Rotation inter- Used in conjunction with Rotation steps, when a blind
step delay / shade is commanded by a user, this slows-down blind
rotation by introducing a time delay between rotation
steps.
Rotation abs min This sets the blind’s / shade’s minimum rotation
position position beyond which physically it cannot turn.
Rotation abs This sets the blind’s / shade’s maximum rotation
max position position beyond which physically it cannot turn.
Rotation min Though a blind can have a wide range of rotation, in
position practice a more restrictive range of rotation may be
required (for example, for security or esthetic reasons).
Used in conjunction with Rotation max position, this
sets the usable range of blind rotation.
This sets the blind’s / shade’s minimum effective
rotation position.
Rotation max Used in conjunction with Rotation min position, this
position sets the blind’s / shade’s maximum effective rotation
position.
EC-gfxProgram 875
Parameter Description
Rotation default This sets the blind’s / shade’s default rotation position
value when:
• The output has not been written to (is in an unexe-
cuted Conditional Custom Block for example).
• A sunblind module has lost communications with
the controller.
Rotation reverse Set this option to invert the rotation direction.
action
Configure a The light sunblind hardware input does not have to be configured.
Light Sunblind
Hardware Input
876 EC-gfxProgram
Sunblind Output (ECB & ECY Series expansion
module)
Description Used to interface to a sunblind output of a sunblind / shade expansion module
that is connected to a controller’s subnetwork bus. This block is only available
with controller models that support this expansion module. This block can be
used to control horizontal / vertical blinds (with slat rotation angle) or shutters /
shades (without slat rotation angle).
For ECY Series controllers, alarms that have been configured for this block
can be suppressed by turning off the block’s alarm management so that while
this mechanism is engaged, no alarms will be reported by the block. See
AlarmInhibit input (ECY Series controllers).
Number of The number of sunblind outputs varies according to the number of connected
blocks sunblind modules, up to a maximum of 8 sunblind outputs. See the control-
ler’s datasheet for more information about the number of expansion modules
that are supported.
Each sunblind expansion module also has 4 multi-level inputs. See Light Sun-
blind Input (ECB & ECY Series expansion modules).
Advanced Resources Configuration, Managing Light and Sunblind module instances,
configuration Manage Light and Sunblind Modules window, LLight and Sunblind module
configuration, Network Properties Configuration window (ECL, ECB & ECY
Series), Override and auto, Find All References (ECL, ECB & ECY Series),
Copy From, Configure Ports, Show/Hide Ports, Alarms (ECB & ECY Series)
(ECY Series only)
Related blocks Light Output (ECB & ECY Series expansion modules), Light Sunblind Input
(ECB & ECY Series expansion modules)
EC-gfxProgram 877
Input(s)
Port Type Range Description
Function Enum Nul (1) Sets the sunblind output action. See Function,
Translation, and Rotation Input truth table.
Off (2)
A new Translation or Rotation value is taken into
On (3)
account only when there is a change of Function
Down (4) value or the Trigger input is activated.
Up (5)
Stop (6)
State (7)
Translation Numeric 0 to 100% Set the sunblind position. See Function, Translation,
and Rotation Input truth table.
A new value is taken into account only when there is
a change of Function value or the Trigger input is
activated.
Rotation Numeric -359.98º to Set the sunblind rotation angle. See Function,
360º Translation, and Rotation Input truth table.
A new value is taken into account only when there is
a change of Function value, the Trigger input is
activated, or there is a change in either the
Translation or Rotation input value when the
Function input is set to State.
Priority Integer 1 to 16 The value at the Translation and Rotation inputs
are written at the priority level specified at this input.
If a value is not linked to this input, the value at the
Translation and Rotation inputs are written in
priority level 14. See Commandable object priority
array levels.
Trigger Digital 0 or 1 Forces a write action of the current block’s Rotation
Input and Translation Input values to the
expansion module’s hardware. This is necessary
when you want to force the execution of the same
command again when there is no change of value at
the Function input.
For example, to lower the sunblind / shade by 10%
and then later again by 10%, proceed as follows:
With the Rotation Input set to Nul, set the
Translation Input port to 10% and the Function
input to Down, then set the Trigger input to 1 to
again push the change to expansion module’s
output.
AlarmInhibit Digital 0 or 1 While set to True(1), no alarms will be reported by
the block. See AlarmInhibit input (ECY Series
controllers).
878 EC-gfxProgram
Function, There is interplay between the Function, Translation, and Rotation Input
Translation, and settings for this block. The following truth table explains the effect of input val-
Rotation Input ues on sunblind translation and rotation.
truth table
Function Translation
Input Input “x” Rotation Input Sunblind / Shade
Description
Enumeration Value1 “α” Value1 Behavior
Value
Nul (1) Any value / Any value / – Cancels the last command
Irrelevant Irrelevant of the Function,
Translation, and Rotation
inputs.
Off (2) Any value / Any value / Mode Off Take no action.
Irrelevant Irrelevant
On (3) Any value / Any value / Mode On Take no action.
Irrelevant Irrelevant
Down (4) Nul Nul Sunblind Sunblind / shade lowersa or
moves down until Stop value is received
at the Function input.
Nul 0° <= α <= 360° Relative slat Sunblind / shade rotatesa
angle the slats downwards by a
downwards relative angle of α.
For example, if the
Sunblind is a 0° and the
Rotation input value is 15°,
setting the Function input
to Down will angle the slat
angle to -15° (0° - 15°).
0 < x < 100% 0° <= α <= 360° Sunblind / Lowersa the sunblind by x
slats move
percent and rotatesa the
down
slats downwards by a
relatively
relative angle of α.
If α = 0: At the new sunblind
position, the slat angle
remains unchanged.
0 < x < 100% Nul Sunblind Lowersa the sunblind /
moves down shade by x percent.
relatively
Up (5) Nul Nul Sunblind Sunblind / shade raisesa or
moves up until Stop value is received
relatively at the Function input.
EC-gfxProgram 879
Function Translation
Input Input “x” Rotation Input Sunblind / Shade
Description
Enumeration Value1 “α” Value1 Behavior
Value
Nul 0° <= α <= 360° Relative slat Sunblind / shade rotatesa
angle the slats upwards by a
upwards relative angle of α.
For example, if the
Sunblind is a 0° and the
Rotation input value is 15°,
setting the Function input
to Up will angle the slat
angle to 15° (0° + 15°).
0 <= x <= 0° <= α <= 360° Sunblind / Raisesa the sunblind /
100% slats move shade by x percent and
upwards rotates1 the slats upwards
relatively by a relative angle of α.
If α = 0: At the new sunblind
position, the slat angle
remains unchanged.
0 <= x <= Nul Sunblind Raisesa the sunblind /
100% moves up shade by x percent.
relatively
Stop (6) Any value / Any value / Sunblind Stops the sunblind / shade
Irrelevant Irrelevant stops movement immediately.
State (7) 0 <= x <= Nul Setting Sets of the absolute
100% sunblind’s translation positiona as
position only defined by the Translation
input.
Nul -360 < α <= 360° Setting Sets of the absolute
sunblind’s rotation anglea as defined
slat angle by the Rotation input.
only
0 <= x <= -360 < α <= 360° Setting Sets the absolute sunblind /
100% Sunblind to shade translation positiona
position x
to x and slat rotation anglea
and to slat
to α.
angle α
a. Sunblind / shade translation and rotation always remains within the limits set
in the block’s advanced configuration. See Configure the Sunblind output.
880 EC-gfxProgram
Output(s)
Port Type Range Description
Translation Numeric 0 to 100% Effective value of the expansion module’s
Translation output.
Translation Numeric 0 to 100% Current translation position. This takes into
Feedback account any user command from a remote
control.
Translation Digital 0 or 1 See Out-of-Service.
OutOfService
Translation Digital 0 or 1 This is logically True (1) if the Reliability
Fault property does not have a value of No Fault
Detected, otherwise logical False (0).
Translation Enum See Description When communication to the expansion module
Reliability is lost, this becomes Communication Failure.
If the configuration does not match the current
device, this becomes Configuration Error.
Otherwise this is No Fault Detected.
Translation Integer 1 to 16 The current active priority for commandable
Priority objects. See Commandable object priority array
levels.
Rotation Numeric -359.98º to 360º Effective value of the expansion module’s
Rotation output.
Rotation Numeric -359.98º to 360º Current rotation angle. This takes into account
Feedback any user command from a remote control.
Rotation Digital 0 or 1 See Out-of-Service.
OutOfService
Rotation Fault Digital 0 or 1 This is logically True (1) if the Reliability
property does not have a value of No Fault
Detected, otherwise logical False (0).
Rotation Enum See Description When communication to the expansion module
Reliability is lost, this becomes Communication Failure.
If the configuration does not match the current
device, this becomes Configuration Error.
Otherwise this is No Fault Detected.
Translation Integer 1 to 16 The current active priority for commandable
Priority objects. See Commandable object priority array
levels.
Runtime Numeric 0 to 3.4028 × The output’s operating time in minutes for both
1038 translation and rotation combined.
Number Integer 1 to 8 The current block number. This is set through
Number in the Block’s Properties pane.
EC-gfxProgram 881
Block properties See also Conditional Custom Block.
Property Type Range Default Description
Number Menu See Sunblind The Sunblind Output block instance. Click
Description Output the drop-down arrow to open the
Managing Light and Sunblind module
instances window, in which you first add
light and sunblind modules by clicking
Manage Light and Sunblind Modules.
See Figure • 20.
Once sunblind expansion modules have
been added to the controller, the Source
column shows the sunblind expansion
module on which the output is located.
Use this drop-down menu to select a
physical sunblind module output on a
connected expansion module.
The number of Sunblind Output block
instances supported by a controller is
shown in the Statistics pane.
Horizontal/ The following diagrams define the meaning of parameters used for this block.
Vertical blind Confirm these operational parameters with your blind (shade) manufacturer/
translation and installer.
rotation
Figure 517: Horizontal/Vertical blind translation and rotation example
882 EC-gfxProgram
Managing Light The configuration of the sunblind expansion module outputs, the light expan-
and Sunblind sion module outputs, and the light sunblind inputs are configured in the
module Resource Tree of the Resources Configuration under Light Sunblind Mod-
instances ules (see Figure 519). This lists the currently configured light and sunblind
modules as well as their input’s name, output’s name and module number
according to the light or sunblind expansion module currently connected to
the controller. This block instance will use the module’s input or output
selected in this window. The first light or sunblind outputs shown are from the
light or sunblind expansion module configured with the lowest subnetwork
address. Likewise, the highest light or sunblind outputs shown are from the
light or sunblind expansion module configured with the highest subnetwork
address.
Configuring the Configure the block’s inputs and outputs as follows.
block’s inputs
and outputs 1. Select the block that is to be configured.
2. Open the Properties pane for the block.
3. Click the drop-down list arrow for the Number property.
Figure 518: Manage Module Instance window
Parameter Description
Source column The name of a previously configured light or sunblind
expansion module. They are arranged in sequential
order according to their subnet MAC address setting
(lowest MAC address first).
Number column This is the sequential order of sunblind or light outputs.
Name column The output’s name. The name of an output is the same
as the block’s name, when this output is selected for
the block.
Type column The light or sunblind expansion module type.
EC-gfxProgram 883
Parameter Description
Manage Light Opens the Resources Configuration for module
and Sunblind configuration.
Modules
4. In the lower left corner of the Manage Module Instance window, click
Manage light and sunblind modules. See Figure 518.
5. Add an expansion module to the Resources list by right-clicking the
Light Sunblind Modules tree and selecting Add or Learn.
Figure 519: Light and Sunblind Modules tree options
Parameter Description
Add Adds a module to the controller. In the Model type
drop-down, select the model of light or sunblind
expansion module. To configure the expansion module,
see Light and Sunblind module configuration.
Learn When the connection status for the controller is
Connected, this scans the controller’s subnetwork bus
for connected expansion modules. Using this feature
will delete any previously configured expansion
modules.
NOTE: Learn is only available after 2 minutes of the
controller having been powered up. This infor-
mation is discarded after 30 minutes. Reboot
the controller if you cannot see the connected
modules (in Project Synchronization, select
Download to device and Reboot controller
only).
884 EC-gfxProgram
6. The Manage Light and Sunblind Modules window allows you to configure
all connected Light and Sunblind Modules. In the Model type drop-down,
select the model of light or sunblind expansion module.
Figure 520: Expansion module drop-down menu
Parameter Description
Rename Rename the selected expansion module or output.
Renaming an expansion module changes its name
shown in the Source column in the Manage Module
Instance window (see Figure 518). The name of an
output is the same as the block’s name, when this
output is selected for the block.
Delete Deletes the selected expansion module.
7. In Default address, set the expansion modules’ subnet ID (MAC) address
for this expansion module instance.
Figure 521: Default address: seting an expansion module’s Subnet ID (MAC)
address
According to the model type selected, a default subnet ID address num-
ber is shown. This default subnet ID address number corresponds to the
default expansion modules’ subnet ID address when the expansion mod-
ules’ MAC DIP switch is set to 0 (or all off – the factory default position).
This eliminates the need to configure the expansion modules’ MAC DIP
switch when there are no more than one of each type of expansion mod-
ule connected to the controller’s subnet bus.
EC-gfxProgram 885
Auto-assigned Subnet ID Address when the expansion modules’ MAC
Expansion
DIP Switch is set to 0 (factory default position)
Module Model
Type
1 2 3 4
4 lights 230V
4 DALI buses
4 dimming lights
4 sunblinds 230V
4 sunblinds 24V
If there are two of the same type of expansion modules connected to the
controller’s subnet bus, you must set at least one of the two expansion
modules’ MAC DIP switch to a unique (that is, unused) subnet ID (MAC)
address and then set the same value in Default address.
8. To configure the expansion module, see Light and Sunblind module con-
figuration, below.
Light and Once one or more light or sunblind expansion modules have been added to
Sunblind module the Light and Sunblind Modules tree, expand a module and select a Light
configuration or Sunblind output, or a Light Sunblind Input to see its configuration
screen.
For the BACnet network properties, see Network Properties Configuration
window (ECL, ECB & ECY Series).
To configure:
• A light output, see Configure the Light Output.
• A sunblind / shade Output, see Configure the Sunblind output.
• A light or sunblind hardware input, see Light Sunblind Hardware Input
enumeration values.
886 EC-gfxProgram
Configure the Configure the Light Output as follows.
Light Output
Figure 522: Dimmable LIght Output configuration
Figure 523: DALI Light Output configuration
Figure 524: On/Off Light Output configuration
Parameter Description
Dimming Set how a lighting level change is handled with regards
management to the Dimming Time value.
(for dimming
From 0 to 100%: The dimming rate of change is
enabled outputs
constant, that is, Dimming Time defines the time for
only)
the lighting level to go from 0% to 100% or vice versa.
For example, a command to go from 20% to 70% will
take one-half the Dimming Time to be carried out.
From actual to next value: Any new commanded light
level always takes the same amount of time to be
carried out, as set by Dimming Time.
Dimming time When Dimming management is set to Dimming
(for dimming Time, this sets the number of seconds for the light level
enabled outputs to go from 0 to 100% or vice versa. This can be
only) overridden (fade time = 0) when the block’s Dimming
Disabled input is set to 1.
When Dimming management is set to From actual to
next value, this sets the number of seconds for the
light level to go from its current value to the next
commanded value. This can be overridden (fade time =
0) when the block’s Dimming Disabled input is set to
1.
EC-gfxProgram 887
Parameter Description
Default value This sets the expansion module’s output to this default
value when:
• The output has not been written to (is in an unexe-
cuted Conditional Custom Block for example).
• A light expansion module has lost communications
with the controller.
BACnet See Network Properties Configuration window (ECL,
Properties ECB & ECY Series).
Configure the Configure the Sunblind Output as follows.
Sunblind Output
Figure 525: 230V Sunblind Output configuration
888 EC-gfxProgram
Figure 526: 12-24V Sunblind Output configuration
Parameter Description
Object name BACnet object’s name by which this block is identified
on the BACnet network. This is used to identify this
block in the Resource Viewer and on the controller’s
operator interface (if equipped) and it is the name is
exposed on the BACnet network as the BACnet object
name.
Boot delay The motor of some blinds / shades have electronics
that delay operation when power is first applied. Set
this to the actual amount of delay before the motor
reacts to being powered. See the blind / shade motor’s
datasheet for the amount of startup delay time to set.
Translation time This sets the time for the blind / shade to go from its
fully retracted position to its fully deployed position or
vice versa.
Translation min This sets the blind’s / shade’s minimum position
position beyond which it will not deploy as a percentage of the
total blind’s / shade’s translation movement.
Translation max This sets the blind’s / shade’s maximum position
position beyond which it will not retract as a percentage of the
total blind’s / shade’s translation movement.
EC-gfxProgram 889
Parameter Description
Translation This sets the blind’s / shade’s default translation
default value position when:
• The output has not been written to (is in an unexe-
cuted Conditional Custom Block for example).
• A sunblind module has lost communications with
the controller.
Translation Set this option to invert the translation position, to
reverse action correct a wiring mistake.
Rotation time This sets the time for the blind / shade to rotate from
one extreme to the other, between Rotation abs min
position and Rotation abs max position.
Rotation steps When a blind / shade is commanded by a user (for
example, through a remote control), this slows-down
blind rotation by introducing rotation steps. This gives a
user enough time to react to the actual blind rotation.
This sets a percentage of the total rotation for each
rotation step that is then followed by a pause set by
Rotation inter-step delay.
For example, if this is set to 10%, and the blind’s /
shade’s total rotation is 90°, a user command will rotate
the blind in steps of 9° (10% × 90°), between the range
set by Rotation max position and Rotation min
position.
Rotation inter- Used in conjunction with Rotation steps, when a blind
step delay / shade is commanded by a user, this slows-down blind
rotation by introducing a time delay between rotation
steps.
Rotation abs min This sets the blind’s / shade’s minimum rotation
position position beyond which physically it cannot turn.
Rotation abs This sets the blind’s / shade’s maximum rotation
max position position beyond which physically it cannot turn.
Rotation min Though a blind can have a wide range of rotation, in
position practice a more restrictive range of rotation may be
required (for example, for security or esthetic reasons).
Used in conjunction with Rotation max position, this
sets the usable range of blind rotation.
This sets the blind’s / shade’s minimum effective
rotation position.
Rotation max Used in conjunction with Rotation min position, this
position sets the blind’s / shade’s maximum effective rotation
position.
890 EC-gfxProgram
Parameter Description
Rotation default This sets the blind’s / shade’s default rotation position
value when:
The output has not been written to (is in an unexecuted
Conditional Custom Block for example).
A sunblind module has lost communications with the
controller.
Rotation reverse Set this option to invert the rotation direction.
action
Light Sunblind The light sunblind hardware input uses the following enumeration values.
Hardware Input
enumeration • Off = 1: The hardware input is open-circuit.
values • On = 2: The hardware input is short-circuited.
• Pulse = 3: A momentary contact at the hardware input that lasts for less
than 200ms.
EC-gfxProgram 891
Wireless Module (ECP Series)
Description Used to interface with a wireless input.
There are 14 wireless inputs available and there are 18 module types such as
a temperature sensor with setpoint adjustment, universal switch, outdoor light
sensor, etc. Different output ports are available on the Wireless Module block
depending on the module type selected. Also some module types can use up
more than one wireless input.
For example, 1 temperature sensor module type with setpoint adjustment,
override button, and fan speed control uses up 3 wireless inputs for the tem-
perature, setpoint, and fan speed respectively (override does not use an
input).
The user can read the values and modes of the Wireless Module block
directly through nvoWrI1 to 14. nviModify can be used to write to the values
and modes of the block by specifying the internal value type (WR_INPUT),
the index (Wireless input number), the mode (Automatic or Manual), and the
value (-83886.08 to 83886.07).
Number of 14
blocks
Advanced Module, Advanced configuration, Learn
configuration
Input(s) N/A
Output(s)
Port Type Range Description
Temp Numeric 0 to 99.9 The room’s temperature.
NOTE: Any change in the measurement system of
the project results in the output value being
converted.
892 EC-gfxProgram
Port Type Range Description
Setpoint Numeric 0 to 99.9 The temperature setpoint being set by the wireless
device.
NOTE: Any change in the measurement system of
the project results in the output value being
converted.
RH Numeric 0 to 99.9 The room’s relative humidity.
Override Digital 0 or 1 Value of the override (Bypass). The Override output
only emits a pulse, thus if it is required to stay on for
an extended period of time, a Min On Time or Latch
block should be used.
NOTE: This output does not use up any of the 14
wireless inputs.
FanSpeed Enum -1 to 4 The fan speed. The values are defined as such:
-1 = ST_NUL (AUTO)
0 = ST_OFF
1 = ST_LOW
2 = ST_MED
3 = ST_HIGH
4 = ST_ON
Digital Digital 0 or 1 The status of a digital switch.
Lux Numeric 0 to 83886.07 The outdoor light intensity.
Buttonx Digital 0 or 1 The status of a digital switch.
(x=1 to 4)
Pulsex Digital 0 or 1 Outputs a pulse if a signal was sent from a digital
switch (either On or Off).
(x=1 to 4)
NOTE: This output does not use up any of the 14
wireless inputs.
Block properties See also Common block properties.
Property Type Range Default Description
Module Menu See Not Set The wireless module instance. Click the
Description drop-down arrow to open the Module
window, which provides access to the
Advanced configuration window and
lists the wireless modules.
EC-gfxProgram 893
Module The Module window lists the configured wireless modules and provides
access to the Advanced configuration window. This window displays the num-
ber, name, module type, and module ID of the wireless module. This block
instance will use the wireless module selected in this window.
Figure 527: Module window
Parameter Description
Delete
Selecting deletes the selected wireless module.
Add new module Opens the Advanced Configuration window.
Advanced The Wireless Module Configuration window has all the settings required to
configuration configure any type of wireless module including sensors, switches, digital
contacts, etc. Depending on the Module type selected, the options available
will vary. For the purposes of showing all the possible options in a particular
module type, the Temp Humidity Setpoint Override, and UniversalSwitch
types are shown below since between them they contain all the possible
options.
Temperature Figure 528: Wireless Module Configuration window
Type module
894 EC-gfxProgram
Module
information
Parameter Description
Module ID The Module ID is a unique hexadecimal identifier used
to identify each wireless sensor (similar to a Neuron ID
for a LONWORKS device). The Module ID of a wireless
sensor must be associated with the controller for
communication to take place. The controller discards
messages that are received from unknown sources.
Module type The wireless sensor type. The following is a list of all
module types supported by wireless-enabled
controllers. For a list of supported sensors, see
Supported EnOcean Wireless Sensor Profiles.
Learn This button opens the Learn window.
Space
temperature
Parameter Description
Offset The offset is a constant value that is applied to the
sensor input reading to compensate for reading errors,
for example, to perform sensor calibration.
Setpoint
Parameter Description
Min range This field is used to specify the value of the minimum
setpoint offset.
Max range This field is used to specify the value of the maximum
setpoint offset.
Humidity
Parameter Description
Offset The offset is a constant value that is applied to the
sensor input reading to compensate for reading errors,
for example, to perform sensor calibration.
EC-gfxProgram 895
Switch Type Figure 529: Wireless Module Configuration window - UniversalSwitch
modules
Module
information
Parameter Description
Module ID The Module ID is a unique hexadecimal identifier used
to identify each wireless sensor (similar to a Neuron ID
for a LONWORKS device). The Module ID of a wireless
sensor must be associated with the controller for
communication to take place. The controller discards
messages that are received from unknown sources.
Module type The wireless sensor type.
Number of Select the number of buttons on the switch from 1 to 4.
buttons
Learn This button opens the Learn window.
896 EC-gfxProgram
Button 1
Parameter Description
Offset Used to assign the inputs for switches.
If the universal wireless switch module has 1 switch, it
must be assigned an offset of B. If the universal
wireless switch module has 2 switches, offset A and B
should be assigned as shown below.
Figure 530: Wireless Double Switch (typical)
NOTE: C and D are additional offsets that would be
used for a universal wireless switch module
that has 4 switches.
Different manufacturers may specify different
offsets. Refer to their documentation for more
details.
Learn The Learn window allows the Wireless Module block to associate itself with a
wireless device. The window will close if the Wireless Module block receives
a valid signal from a wireless device when its Learn button is pressed or, if it
does not have a Learn button, when it senses a change of value. The window
can also be closed by clicking Stop Learning. This window will close auto-
EC-gfxProgram 897
matically after 30 minutes if no wireless device is learned or if the Stop Learn-
ing button is not pressed.
Figure 531: Learn window
Wireless Sensor (ECL Series)
Description Used to interface with a wireless input using standard EnOcean® profiles.
For the number of wireless inputs that are available for a device, refer to its
datasheet. Different output ports are available on the Wireless Sensor block
depending on the module type selected. Also some sensor types can use
more than one wireless inputs.
Slim format This block can be collapsed into a slim format. See Collapsed in Common
support block properties.
Number of The number of Wireless Sensor inputs supported by a controller is shown in
blocks the Statistics pane.
Advanced Resources Configuration, Sensor, Advanced configuration, Configure Ports,
configuration Show/Hide Ports
Input(s) N/A
Output(s)
Port Type Range Description
SpaceTemp Numeric See the EEP The room’s temperature. Any change in the
profile of the measurement system of the project results in
selected the output value being converted.
sensor
898 EC-gfxProgram
Port Type Range Description
Setpoint Numeric Varies The temperature setpoint offset being sent by
according to the wireless device. Any change in the
wireless device measurement system of the project results in
(usually -10 to the output value being converted.
10)
Humidity Numeric 0 to 99.9 The room’s relative humidity.
Occupancy Digital 0 or 1 The occupied / unoccupied state.
FanSpeed Enum 1 to 5 The fan speed. The values are defined as
such:
1 = ST_NUL (AUTO)
2 = ST_OFF
3 = ST_LOW
4 = ST_MED
5 = ST_HIGH
Illumination Numeric 0 to 1020 The light intensity.
0 to 510
300 to 30000
600 to 60000
Buttonx (x=1 to 4) Digital 0 or 1 The status of a digital switch.
InputStatus
Window Contact Digital 0 or 1 The status of a digital switch (a window
contact, key card presence, or slide switch).
KeyCard
SlideSwitch
Supply Voltage Numeric 0 to 5.1 Wireless sensor supply voltage.
PIR Digital 0 or 1 The status of the motion / occupancy sensor.
[ANY].OutOf Digital 0 or 1 See Out-of-Service.
Service
[ANY].Fault Digital 0 or 1 Logical True (1) if the Reliability property does
not have a value of No Fault Detected,
otherwise logical False (0).
Wireless Update Digital 0 or 1 Outputs a pulse when a valid EnOcean
telegram is received. For example, a user
presses a wireless switch button and the
transmission is received and decoded.
EC-gfxProgram 899
Port Type Range Description
RSSI Numeric -98 to -41 The current wireless sensor’s receive signal
strength measured in dBm. Wireless
Available with
operation is more reliable with stronger signal
wireless receivers
strength. See the Receiver signal strength
that support this
indication table in Sensor information shown
feature
below for more information.
NOTE: When troubleshooting signal reception
issues, connect this output port to a
Live Trend Log block to track signal
strength over time and to appraise the
effectiveness of any changes made to
receiver and sensor location.
Block properties See also Common block properties.
Property Type Range Default Description
Sensor Menu See – The wireless sensor instance. Click the drop-
Description down arrow to open the Sensor window, which
provides access to the Advanced configuration
window and lists the wireless sensors.
Sensor When a Wireless Sensor block is added to a programming sheet, it has no
output ports. First you must add a sensor by clicking Add new sensor found
when you click the drop-down arrow next to Sensor in the block’s properties.
This Opens the Advanced configuration window. Once a sensor has been
added, it is shown in the Sensor window list.
The Sensor window lists the configured wireless sensors and provides access
to the Advanced configuration window. This window displays the number,
name, sensor type, and sensor ID of the wireless module. This block instance
will use the wireless sensor selected in this window.
Figure 532: Wireless Sensor window (click the drop-down arrow next to Sensor in the block’s properties)
Parameter Description
Delete
Selecting deletes the selected wireless sensor.
900 EC-gfxProgram
Parameter Description
Add new sensor Opens the Wireless Sensor window. See Advanced
Configuration.
Advanced Configuration parameters for this block are set in the Resources Configura-
configuration tion window. The Wireless Sensor Configuration window has the settings
required to configure any type of wireless module including sensors, switches,
digital contacts, etc. Depending on the Sensor type selected, the options
available will vary.
Temperature Figure 533: Wireless Sensor Configuraiton window
Type module
Sensor
information
Property Description
Object name Used to identify this input in the Resource Viewer and
on the controller’s operator interface (if equipped).
Sensor ID The Sensor ID is a unique hexadecimal identifier used
to identify each wireless sensor. The Sensor ID of a
wireless sensor must be associated with the controller
for communication to take place. The controller
discards messages that are received from unknown
sources.
Sensor type The wireless sensor type and EEP profile number.
When a sensor is learned in, the sensor type may be
automatically detected (see the Learn button below). If
you are unable to learn in a sensor (the wireless
receiver is not currently connected to the controller, the
sensor does not send its sensor profile type, the
controller is not online, or the sensor is not in range),
you can select the sensor type from this drop-down list.
The EnOcean Equipment Profiles (EEP) is shown for
each sensor shown in this drop-down list.
EC-gfxProgram 901
Property Description
Learn This button opens the Learn window. For a list of
supported sensors, see Supported EnOcean Wireless
Sensor Profiles.
Receiver signal The wireless sensor’s receive signal strength
strength measured in dBm at the moment the sensor is learned
indication in. Wireless operation is more reliable with stronger
signal strength. Signal strength bars show the relative
receive signal power. See Table 25.
Available with
wireless
receivers that
support this
feature
Max Receive The maximum time period between updates received
Time from the wireless sensor.
Number of Select the number of buttons on the switch from 1 to 4.
buttons
Available when
a rocker switch
sensor type is
selected.
Table 25: Wireless signal strength
Wireless Signal
Bars Signal Quality Description
Strength
-50 to -41 dBm 5 Excellent Highest wireless reliability.
-62 to -51 dBm 4 Strong Excellent resistance to interference.
-73 to -63 dBm 3 Good
-85 to -74 dBm 2 Acceptable Moderate resistance to interference. Transmission
path reliability may be an issue. Consider
-98 to -86 dBm 1 Weak relocating the sensor or the wireless receiver to
improve transmission reliability or install a
repeater to increase signal strength.
902 EC-gfxProgram
Configuration Figure 534: Wireless Sensor Input Configuration window
Property Description
Object name The Wireless Sensor’s input descriptive name. This is
used to identify the input in the Resource Viewer and
on the controller’s operator interface or on the
connected ECx-Display (if equipped).
Common The current name used to identify this Network Variable
network name output on the network. See Network Properties
Configuration window (ECL, ECB & ECY Series).
Offset The offset is a constant value that is applied to the
sensor input reading to compensate for reading errors,
for example, to perform sensor calibration. For a
pushbutton, see Button.
Default value When the property cannot be read from the wireless
sensor, this is the fall back value to be used in lieu of
live data.
Options Normal: Select this for a 2-position on-off switch.
Momentary: Selects one of three enumerations:
Neutral (no button pressed), button 1 pressed, or
button 2 pressed. This can be used to dim lights or to
raise or lower a sunblind / shade.
Toggle: The output state inverts for each switch
activation.
Min range This field is used to specify the value of the minimum
setpoint offset.
Max range This field is used to specify the value of the maximum
setpoint offset.
Range Select the byte for the range of the light sensor. Refer
to the EnOcean equipment profile.
Max Value This sets the limit for the maximum value.
EC-gfxProgram 903
Button
Property Description
Offset Used to assign the inputs for switches.
If the universal wireless switch module has 1 switch, it
must be assigned an offset of B. If the universal
wireless switch module has 2 switches, offset A and B
should be assigned as shown below.
Figure 535: Wireless Double Switch (typical)
NOTE: C and D are additional offsets that would be
used for a universal wireless switch module
that has 4 switches.
Different manufacturers may specify different
offsets. Refer to their documentation for more
details.
Learn The Learn window allows the Wireless sensor block to associate itself with a
wireless device. The window will close if the Wireless sensor block receives
a valid signal from a wireless device when its Learn button is pressed or, if it
does not have a Learn button, when it senses a change of value. The window
can also be closed by clicking Stop Learning.
Figure 536: Learn window
904 EC-gfxProgram
Wireless Sensor (ECB Series)
Description Used to interface with a wireless input using standard EnOcean® profiles.
For the number of wireless inputs that are available for a device, refer to its
datasheet. Different output ports are available on the Wireless Sensor block
depending on the sensor type selected. Also some sensor types can use
more than one wireless input.
For ECB Series controllers only: Each wireless sensor is linked to a corre-
sponding BACnet object which follows the same value. Alarms (ECB & ECY
Series) are available with B-AAC or B-BC controller models only (see the con-
troller’s datasheet for more information).
Number of The number of Wireless Sensor input supported by a controller is shown in
blocks the Statistics pane.
Advanced Resources Configuration, Sensor, Advanced configuration, Alarms (ECB &
configuration ECY Series), Configure Ports, Show/Hide Ports
EC-gfxProgram 905
Input(s)
Port Type Range Description
[parameter] Numeric ±3.4028×1038 When alarms are enabled for this block (see
Alarm Setpoint Alarms (ECB & ECY Series)), a positive input
value increases the alarm setpoint values set in
the Resources Configuration’s Alarms
configuration (a negative value reduces the alarm
setpoint values): The High limit is now the High
limit value (set in the Resources Configuration’s
Alarms configuration for the block) plus
AlarmSetpoint and the Low limit is now the Low
limit value (set in the Resources Configuration’s
Alarms configuration for the block) plus
AlarmSetpoint. See Dynamic alarm activation
thresholds adjust.
NOTE: When the AlarmSetpoint input is discon-
nected, you must reset the controller (see
Project Synchronization) or connect a Null
Value (ECL, ECB & ECY Series) block to
this port so the controller will release this
port as being unconnected.
When the AlarmSetpoint input is discon-
nected, the High limit and Low limit can
be written to through the BACnet interface.
[parameter] Digital 0 or 1 When alarms are enabled for this block for a
AlarmValue digital value (see Alarms (ECB & ECY Series)),
this input overrides the alarm value set in the
Resources Configuration’s Alarms configuration
for the block.
NOTE: When the AlarmValue input is discon-
nected, you must reset the controller (see
Project Synchronization) or connect a Null
value (ECL, ECB & ECY Series) block to
this port so the controller will release this
port as being unconnected.
When the AlarmValue input is discon-
nected, the alarm value property can be
overwritten through the BACnet interface.
906 EC-gfxProgram
Output(s)
Port Type Range Description
SpaceTemp Numeric See the EEP The room’s temperature.
profile of the
selected NOTE: Any change in the measurement system of
sensor the project results in the output value
being converted.
Setpoint Numeric Varies The temperature setpoint offset being sent by the
according to wireless sensor.
wireless device
(usually -10 to NOTE: Any change in the measurement system of
10) the project results in the output value
being converted.
Humidity Numeric 0 to 99.9 The room’s relative humidity.
Occupancy Digital 0 or 1 The occupied / unoccupied state.
FanSpeed Enum 1 to 5 The fan speed. The values are defined as such:
1 = ST_NUL (AUTO)
2 = ST_OFF
3 = ST_LOW
4 = ST_MED
5 = ST_HIGH
Illumination Numeric 0 to 1020 The light intensity.
0 to 510
300 to 30000
600 to 60000
Buttonx (x=1 to Digital 0 or 1 The status of a digital switch.
4)
InputStatus
Window Digital 0 or 1 The status of a digital switch (a window contact,
Contact key card presence, or slide switch).
KeyCard
Slide Switch
Supply Voltage Numeric 0 to 5.1 Wireless sensor supply voltage.
PIR Digital 0 or 1 The status of the motion / occupancy sensor.
[ANY].OutOf Digital 0 or 1 See Out-of-Service.
Service
EC-gfxProgram 907
Port Type Range Description
[ANY].Fault Digital 0 or 1 Logical True (1) if the Reliability property does not
have a value of No Fault Detected, otherwise
logical False (0).
Wireless Digital 0 or 1 Outputs a pulse when a valid EnOcean telegram
Update is received. For example, a user presses a
wireless switch button and the transmission is
received and decoded.
RSSI Numeric -98 to -41 The current wireless sensor’s receive signal
strength measured in dBm. Wireless operation is
Available with
more reliable with stronger signal strength. See
wireless
the Receiver signal strength indication table in
receivers that
Sensor information shown below for more
support this
information.
feature
NOTE: When troubleshooting signal reception
issues, connect this output port to a Live
Trend Log block to track signal strength
over time and to appraise the effective-
ness of any changes made to receiver and
sensor location.
Block properties See also Common block properties.
Property Type Range Default Description
Sensor Menu See – The wireless sensor instance. Click the drop-
Description down arrow to open the Sensor window, which
provides access to the Advanced configuration
window and lists the wireless sensors.
Sensor When a Wireless Sensor block is added to a programming sheet, it has no
output ports. First you must add a sensor by clicking Add new sensor found
when you click the drop-down arrow next to Sensor in the block’s properties.
This Opens the Advanced configuration window. Once a sensor has been
added, it is shown in the Sensor window list.
The Sensor window lists the configured wireless sensors and provides access
to the Advanced Configuration window. This window displays the number,
908 EC-gfxProgram
name, sensor type, and sensor ID of the wireless sensor. This block instance
will use the wireless sensor selected in this window.
Figure 537: Wireless Sensor window ((click the drop-down arrow next to Sensor in the block’s properties)
Parameter Description
Delete
Selecting deletes the selected wireless sensor.
Add new sensor Opens the Wireless Sensor window. See Advanced
Configuration.
Advanced Configuration parameters for this block are set in the Resources Configura-
configuration tion window. The Wireless Sensor Configuration window has the settings
required to configure any type of wireless sensor including sensors, switches,
digital contacts, etc. Depending on the Sensor type selected, the options
available will vary.
Sensor
information
Parameter Description
Object name BACnet object’s name by which this block is identified
on the BACnet network. This is used to identify this
block in the Resource Viewer and on the controller’s
operator interface (if equipped) and it is the name is
exposed on the BACnet network as the BACnet object
name.
Sensor ID The Sensor ID is a unique hexadecimal identifier used
to identify each wireless sensor. The Sensor ID of a
wireless sensor must be associated with the controller
for communication to take place. The controller
discards messages that are received from unknown
sources.
EC-gfxProgram 909
Parameter Description
Sensor type The wireless sensor type and EEP profile number.
When a sensor is learned in, the sensor type may be
automatically detected (see the Learn button below). If
you are unable to learn in a sensor (the wireless
receiver is not currently connected to the controller, the
sensor does not send its sensor profile type, the
controller is not online, or the sensor is not in range),
you can select the sensor type from this drop-down list.
The EnOcean Equipment Profiles (EEP) is shown for
each sensor shown in this drop-down list.
Learn This button opens the Learn window. For a list of
supported sensors, see Supported EnOcean Wireless
Sensor Profiles.
Receiver signal The wireless sensors receive signal strength measured
strength in dBm at the moment the sensor is learned in.
indication Wireless operation is more reliable with stronger signal
strength. Signal strength bars show the relative receive
signal power. See Table 26.
Available with
wireless
receivers that
support this
feature
Max Receive The maximum time period between updates received
Time from the wireless sensor.
Number of Select the number of buttons on the switch from 1 to 4.
buttons See BACnet network properties.
Available when
a rocker switch
sensor type is
selected.
Table 26: Receiver signal strength indication
Wireless Signal
Bars Signal Quality Description
Strength
-50 to -41 dBm 5 Excellent Highest wireless reliability.
-62 to -51 dBm 4 Strong Excellent resistance to interference.
-73 to -63 dBm 3 Good
-85 to -74 dBm 2 Acceptable Moderate resistance to interference. Transmission
path reliability may be an issue. Consider
-98 to -86 dBm 1 Weak relocating the sensor or the wireless receiver to
improve transmission reliability or install a
repeater to increase signal strength.
910 EC-gfxProgram
Configuration Figure 538: Wireless Sensor Inputs Configuration window
Parameter Description
Offset The offset is a constant value that is applied to the
sensor input reading to compensate for reading errors,
for example, to perform sensor calibration. For a
pushbutton, see Button.
NOTE: When this value is changed, it becomes effec-
tive only when the next valid EnOcean telegram
is received. See also the WirelessUpdate out-
put port.
True text / false Assigns a Boolean format to the BACnet object, for
text example, On, Off. Click Configure to create a new
enumeration or add a new member to an enumeration.
See Creating and using enumerations (8-Bit).
Default When the property cannot be read from the wireless
sensor, this is the fall back value to be used in lieu of
Default state
live data.
Options Normal: Select this for a 2-position on-off switch.
Momentary: Selects one of three enumerations:
Neutral (no button pressed), button 1 pressed, or
button 2 pressed. This can be used to dim lights or to
raise or lower a sun blind.
Toggle: The output state inverts for each switch
activation.
Min range This field is used to specify the value of the minimum
setpoint offset.
Max range This field is used to specify the value of the maximum
setpoint offset.
Range Select the byte for the range of the light sensor. Refer
to the EnOcean equipment profile.
Max Value This sets the limit for the maximum value.
BACnet See Network Properties Configuration window (ECL,
Properties ECB & ECY Series).
EC-gfxProgram 911
Parameter Description
Alarm See Space temperature alarms configuration (for B-
AAC controllers only).
Button
Property Description
Offset Used to assign the inputs for switches.
If the universal wireless switch module has 1 switch, it
must be assigned an offset of B. If the universal
wireless switch module has 2 switches, offset A and B
should be assigned as shown below.
Figure 539: Wireless Double Switch (typical)
NOTE: C and D are additional offsets that would be
used for a universal wireless switch module
that has 4 switches.
Different manufacturers may specify different
offsets. Refer to their documentation for more
details.
Space When the present value goes beyond predefined thresholds, an alarm notifi-
temperature cation is sent to a list of other BACnet devices to warn of the fault condition.
alarms See Analog/Pulse input alarms.
configuration
(for B-AAC
controllers only)
912 EC-gfxProgram
Learn The Learn window allows the Wireless sensor block to associate itself with a
wireless device. The window will close if the Wireless sensor block receives
a valid signal from a wireless device when its Learn button is pressed or, if it
does not have a Learn button, when it senses a change of value. The window
can also be closed by clicking Stop Learning.
Figure 540: Learn window
EC-gfxProgram 913
LONMARK Objects (ECL Series)
Certain ECL Series controllers support the following LONMARK profiles:
• Unit Heater Profile LONMARK Object #8550
• Wall Unit Profile LONMARK Object #8540
• Roof Top Unit Profile LONMARK Object #8504 and Space Comfort Control-
ler AHU Profile LONMARK Object #8508
The following profiles are also supported by any controller that supports one
the above LonMark profiles:
• Hardwired Gas Detection Profile LONMARK Object #4310
• Hardwired Reticulation Profile LONMARK Object #4312
• Hardwired Full Ventilation Profile LONMARK Object #4313
• Hardwired Safety Instrumented System (SIS) Profile LONMARK Object
#4314
See the controller’s datasheet for the availability of these LONMARK Objects.
914 EC-gfxProgram
The programming logic that these blocks are used with must conform with the
expected behavior described in the related LONMARK profile in order to ensure
inter-operability with other networked devices. See http://www.lonmark.org/
for more information.
Unit Heater Profile LONMARK Object #8550
Description Used to present to the network the following LONMARK profile: Unit Heater
Profile #8550. The following profiles are also supported by any controller that
supports the above LONMARK profile: Hardwired Gas Detection Profile LON-
MARK Object #4310, Hardwired Reticulation Profile LONMARK Object #4312,
Hardwired Full Ventilation Profile LONMARK Object #4313, and Hardwired
Safety Instrumented System (SIS) Profile LONMARK Object #4314.
The LONMARK profile is chosen by the LonMarkObjectName option in the
block’s Properties pane. The block’s input and output ports change accord-
ingly.
Controller See the controller’s datasheet for the availability of this feature.
support
Number of Multiple blocks configured as the same LONMARK profile can be used in your
blocks code; however, the input and output ports of each block instance will act on
the same common network resources. The output ports of multiple block
instances can be used to provide network values throughout your code. For
input ports, use Configure Ports so that any given input port is exposed only
once among all block instances.
Advanced Advanced configuration, Configure Ports, Show/Hide Ports
configuration
EC-gfxProgram 915
Input(s)
Port Type Range Description
nviSetPoint Numeric 10°C to 35°C Provides the setpoint temperature network input
value.
The default value of +327.67°C (invalid setpoint
temperature value) is used during controller
power-up and when an update has not been
received within the specified receive heartbeat
time.
nviSpace Temp Numeric -10°C to 50°C Overrides the space temperature network input
value.
The default value of +327.67°C (invalid space
temperature value) is used during controller
power-up and when an update has not been
received within the specified receive heartbeat
time.
nvoSpace Numeric -10°C to 50°C Provides the current space temperature on the
Temp network through nvoSpaceTemp.
The default value of +327.67°C (invalid space
temperature value) is used during controller
power-up and when an update has not been
received within the specified receive heartbeat
time.
nvoFanStatus. Numeric 0 to 100% Provides the current fan status on the network
Value through nvoFanStatus.Value.
nvoFanStatus. Enum -1 Provides feedback for the current gas detection
State mode.
0
-1 = Nul.
1
0 = False.
1 = True.
916 EC-gfxProgram
Port Type Range Description
nvoUnitStatus. Enum -1 to 20* Provides the current Unit Heater mode through
Mode nvoUnitStatus.Mode.
*: The following is the valid range of values:
1 = HVAC_HEAT: In heating mode.
2 = HVAC_MRNG_WRMUP: Morning warm-up
mode.
4 = HVAC_NIGHT_PURGE: Free cooling mode.
6 = HVAC_OFF: Unit off.
7 = HVAC_TEST: Special test mode, application
defined.
8 = HVAC_EMERG_HEAT: Emergency heat
mode.
9 = HVAC_FAN_ONLY: No heating or cooling
allowed.
12 = HVAC_MAX_HEAT: Maximum heating mode.
nvoUnitStatus. Numeric 0 to 100% Provides the current Primary Heat Output on the
HeatOutput network through nvoUnitStatus. Default value:
Primary Null (invalid).
nvoUnitStatus. Numeric 0 to 100% Provides the current secondary heat output on the
HeatOutput network through nvoUnitStatus. Default value:
Secondary Null (invalid).
nvoUnitStatus. Numeric 0 to 100% Provides the current primary cool output on the
CoolOutput network through nvoUnitStatus. Default value:
Null (invalid).
nvoUnitStatus. Numeric 0 to 100% Provides the current economizer output on the
EconOutput network through nvoUnitStatus. Default value:
Null (invalid).
nvoUnitStatus. Numeric 0 to 100% Provides the current fan speed output on the
FanOutput network through nvoUnitStatus. Default value:
Null (invalid).
nvoUnitStatus. Numeric 0 to 255 Alarm status: 0 Means there is no alarm.
InAlarm
Any non-zero value means there is an alarm. See
the LONMARK profile for more information.
255 means that alarming is disabled.
EC-gfxProgram 917
Output(s)
Port Type Range Description
nviSetPoint Numeric 10°C to 35°C The current setpoint temperature value from the
network or the nviSetPoint input.
The default value of +327.67°C (invalid setpoint
temperature value) is used during controller
power-up and when an update has not been
received within the specified receive heartbeat
time.
nviSpace Temp Numeric -10°C to 50°C The current space temperature value from the
network or the nviSpaceTemp input.
The default value of +327.67°C (invalid space
temperature value) is used during controller
power-up and when an update has not been
received within the specified receive heartbeat
time.
nvoSpace Numeric -10°C to 50°C The same value found at the nvoSpaceTemp
Temp input. This is useful to make the current input
values available at a second instance of this
block.
nvoFanStatus. Numeric 0 to 100% The same value found at the
Value nvoFanStatus.Value input. This is useful to
make the current input values available at a
second instance of this block.
nvoFanStatus. Enum -1 Provides feedback for the current gas detection
State mode.
0
-1 = Nul.
1
0 = False.
1 = True.
nvoUnitStatus. Enum -1 to 20 The same value found at the
Mode nvoUnitStatus.Mode input. This is useful to
make the current input values available at a
second instance of this block.
nvoUnitStatus. Numeric 0 to 100% The same value found at the
HeatOutput nvoUnitStatus.HeatOutputPrimary input. This
Primary is useful to make the current input values
available at a second instance of this block.
nvoUnitStatus. Numeric 0 to 100% The same value found at the
HeatOutput nvoUnitStatus.HeatOutputSecondary input.
Secondary This is useful to make the current input values
available at a second instance of this block.
918 EC-gfxProgram
Port Type Range Description
nvoUnitStatus. Numeric 0 to 100% The same value found at the
CoolOutput nvoUnitStatus.CoolOutput input. This is useful
to make the current input values available at a
second instance of this block.
nvoUnitStatus. Numeric 0 to 100% The same value found at the
EconOutput nvoUnitStatus.EconOutput input. This is
useful to make the current input values available
at a second instance of this block.
nvoUnitStatus. Numeric 0 to 100% The same value found at the
FanOutput nvoUnitStatus.FanOutput input. This is useful
to make the current input values available at a
second instance of this block.
nvoUnitStatus.I Numeric 0 to 255 The same value found at the
nAlarm nvoUnitStatus.InAlarm input. This is useful to
make the current input values available at a
second instance of this block.
Block properties See also Common block properties.
Property Type Range Default Description
LonMark Menu See – Choose the LONMARK profile to be used
ObjectName Description with this block. The block’s input and
output ports change accordingly.
Wall Unit Profile LONMARK Object #8540
Description Used to present to the network the following LONMARK profile: Wall Unit Pro-
file #8540. The following profiles are also supported by any controller that
supports the above LONMARK profile: Hardwired Gas Detection Profile LON-
MARK Object #4310, Hardwired Reticulation Profile LONMARK Object #4312,
Hardwired Full Ventilation Profile LONMARK Object #4313, and Hardwired
Safety Instrumented System (SIS) Profile LONMARK Object #4314.
EC-gfxProgram 919
The LONMARK profile is chosen by the LonMarkObjectName option in the
block’s Properties pane. The block’s input and output ports change accord-
ingly.
Controller See the controller’s datasheet for the availability of this feature.
support
Number of Multiple blocks configured as the same LONMARK profile can be used in your
blocks code; however, the input and output ports of each block instance will act on
the same common network resources. The output ports of multiple block
instances can be used to provide network values throughout your code. For
input ports, use Configure Ports so that any given input port is exposed only
once among all block instances.
Advanced Advanced configuration, Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
nviEmerg Enum -1 to 5* Provides the current Wall Unit emergency override
Override mode. The following is the valid range of values:
0 = EMERG_NORMAL: Normal operation
(default)
1 = EMERG_PRESSURIZE: Start the pressurize
operation
2 = EMERG_DEPRESSURIZE: Start the
depressurize operation
3 = EMERG_PURGE: Start the purge operation
4 = EMERG_SHUTDOWN: shutdown all unit
functions
nviSpace Numeric -10°C to 50°C Overrides the space temperature network input
Temp value.
The default value of +327.67°C (invalid space
temperature value) is used during controller
power-up and when an update has not been
received within the specified receive heartbeat
time.
nviSetPoint Numeric 10°C to 35°C Provides the setpoint temperature network input
value.
The default value of +327.67°C (invalid setpoint
temperature value) is used during controller
power-up and when an update has not been
received within the specified receive heartbeat
time.
920 EC-gfxProgram
Port Type Range Description
nviApplic Enum -1 to 20* Provides the current Wall Unit mode through
Mode nvoUnitStatus.Mode.
*: The following is the valid range of values:
0 = HVAC_AUTO: Mode determined by unit
(default)
1 = HVAC_HEAT: In heating mode.
2 = HVAC_MRNG_WRMUP: Morning warm-up
mode.
3 = HVAC_COOL: In cooling mode.
4 = HVAC_NIGHT_PURGE: Free cooling mode.
5 = HVAC_PRE_COOL: Morning cool-down
mode.
6 = HVAC_OFF: Unit off.
7 = HVAC_TEST: Special test mode, application
defined.
8 = HVAC_EMERG_HEAT: Emergency heat
mode.
9 = HVAC_FAN_ONLY: No heating or cooling
allowed.
12 = HVAC_MAX_HEAT: Maximum heating mode.
13 = HVAC_ECONOMY: Economy mode.
14 = HVAC_DEHUMID: Dehumidification15 =
HVAC_CALIBRATE: Calibration mode -
manufacturer defined)
nvoSpace Numeric -10°C to 50°C Provides the current space temperature on the
Temp network through nvoSpaceTemp.
nvoDischAir Numeric 0°C to 100°C Provides the current discharge air temperature on
Temp the network through nvoDischAirTemp.
nvoDischAir Numeric 10°C to 35°C Provides the current discharge air temperature
Setpt setpoint on the network through
nvoDischAirSetpt.
EC-gfxProgram 921
Port Type Range Description
nvoUnitStatu Enum -1 to 20* Provides the current Wall Unit mode through
s.Mode nvoUnitStatus.Mode.
*: The following is the valid range of values:
1 = HVAC_HEAT: Controller is using heat
setpoints
2 = HVAC_MRNG_WRMUP: Morning warmup
3 = HVAC_COOL: Controller is using cool
setpoints
4 = HVAC_NIGHT_PURGE: Free cooling
5 = HVAC_PRE_COOL: Morning cooldown
6 = HVAC_OFF: No unit operation allowed
7 = HVAC_TEST: Special test mode,
manufacturer-defined
8 = HVAC_EMERG_HEAT: Emergency heat
9 = HVAC_FAN_ONLY: No heating or cooling
allowed
12 = HVAC_MAX_HEAT: Maximum heating-VAV
13 = HVAC_ECONOMY:14 = HVAC_DEHUMID:
Dehumidification
15 = HVAC_CALIBRATE: Calibration mode-
manufacturer defined
16 = HVAC_EMERG_COOL: Emergency cool
mode
17 = HVAC_EMERG_STEAM: Emergency steam
mode
18 = HVAC_MAX_COOL19 =
HVAC_HVC_LOAD20 = HVAC_NO_LOAD
nvoUnitStatu Numeric 0 to 100% Provides the current Primary Heat Output on the
s.HeatOutput network through nvoUnitStatus. Default value:
Primary Null (invalid).
nvoUnitStatu Numeric 0 to 100% Provides the current secondary heat output on the
s.HeatOutput network through nvoUnitStatus. Default value:
Secondary Null (invalid).
nvoUnitStatu Numeric 0 to 100% Provides the current primary cool output on the
s.CoolOutput network through nvoUnitStatus. Default value:
Null (invalid).
nvoUnitStatu Numeric 0 to 100% Provides the current economizer output on the
s.EconOutpu network through nvoUnitStatus. Default value:
t Null (invalid).
922 EC-gfxProgram
Port Type Range Description
nvoUnitStatu Numeric 0 to 100% Provides the current fan speed output on the
s.FanOutput network through nvoUnitStatus. Default value:
Null (invalid).
nvoUnitStatu Numeric 0 to 255 Alarm status: 0 Means there is no alarm.
s.InAlarm
Any non-zero value means there is an alarm. See
the LONMARK profile for more information.
255 means that alarming is disabled.
nvoEffect Numeric 10°C to 35°C Provides the current effective space temperature
Setpt setpoint on the network through nvoEffectSetpt.
Output(s)
Port Type Range Description
nviEmerg Enum -1 to 5 The same value found at the nviEmergOverride
Override input. This is useful to make the current input
values available at a second instance of this block.
nviSpace Numeric -10°C to 50°C The current space temperature value from the
Temp network or the nviSpaceTemp input.
The default value of +327.67°C (invalid space
temperature value) is used during controller
power-up and when an update has not been
received within the specified receive heartbeat
time.
nviSetPoint Numeric -10°C to 50°C The current setpoint temperature value from the
network or the nviSetPoint input.
The default value of +327.67°C (invalid setpoint
temperature value) is used during controller
power-up and when an update has not been
received within the specified receive heartbeat
time.
nviApplic Enum -1 to 20* The same value found at the nviApplicMode
Mode input. This is useful to make the current input
values available at a second instance of this block.
nvoSpace Numeric -10°C to 50°C The same value found at the nvoSpaceTemp
Temp input. This is useful to make the current input
values available at a second instance of this block.
nvoDischAir Numeric 0°C to 100°C The same value found at the nvoDischAirTemp
Temp input. This is useful to make the current input
values available at a second instance of this block.
EC-gfxProgram 923
Port Type Range Description
nvoDischAir Numeric 10°C to 35°C The same value found at the nvoDischAirSetpt
Setpt input. This is useful to make the current input
values available at a second instance of this block.
nvoUnitStatu Enum -1 to 20 The same value found at the
s.UnitStatus. nvoUnitStatus.Mode input. This is useful to make
Mode the current input values available at a second
instance of this block.
nvoUnitStatu Numeric 0 to 100% The same value found at the
s.HeatOutput nvoUnitStatus.HeatOutputPrimary input. This is
Primary useful to make the current input values available
at a second instance of this block.
nvoUnitStatu Numeric 0 to 100% The same value found at the
s.HeatOutput nvoUnitStatus.HeatOutputSecondary input.
Secondary This is useful to make the current input values
available at a second instance of this block.
nvoUnitStatu Numeric 0 to 100% The same value found at the
s.CoolOutput nvoUnitStatus.CoolOutput input. This is useful
to make the current input values available at a
second instance of this block.
nvoUnitStatu Numeric 0 to 100% The same value found at the
s.EconOutpu nvoUnitStatus.EconOutput input. This is useful
t to make the current input values available at a
second instance of this block.
nvoUnitStatu Numeric 0 to 100% The same value found at the
s.FanOutput nvoUnitStatus.FanOutput input. This is useful to
make the current input values available at a
second instance of this block.
nvoUnitStatu Numeric 0 to 255 The same value found at the
s.InAlarm nvoUnitStatus.InAlarm input. This is useful to
make the current input values available at a
second instance of this block.
nvoEffect Numeric -10°C to 50°C The same value found at the nvoEffectSetpt
Setpt input. This is useful to make the current input
values available at a second instance of this block.
Block properties See also Common Block Properties.
Property Type Range Default Description
LonMark Menu See – Choose the LONMARK profile to be
ObjectName Description used with this block. The block’s input
and output ports change accordingly.
924 EC-gfxProgram
Roof Top Unit Profile LONMARK Object #8504 and
Space Comfort Controller AHU Profile LONMARK
Object #8508
Description Used to present to the network the following LONMARK profiles: Roof Top Unit
Profile #8504 and Space Comfort Controller AHU Profile #8508. The following
profiles are also supported by any controller that supports one of the above
LONMARK profile: Hardwired Gas Detection Profile LONMARK Object #4310,
Hardwired Reticulation Profile LONMARK Object #4312, Hardwired Full Venti-
lation Profile LONMARK Object #4313, and Hardwired Safety Instrumented
System (SIS) Profile LONMARK Object #4314.
The LONMARK profile is chosen by the LonMarkObjectName option in the
block’s Properties Pane. The block’s input and output ports change accord-
ingly.
Controller See the controller’s datasheet for the availability of this feature.
support
Number of Multiple blocks configured as the same LONMARK profile can be used in your
blocks code; however, the input and output ports of each block instance will act on
the same common network resources. The output ports of multiple block
instances can be used to provide network values throughout your code. For
input ports, use Configure Ports so that any given input port is exposed only
once among all block instances.
Advanced Advanced configuration, Configure Ports, Show/Hide Ports
configuration
Related blocks Space Comfort Controller (ECL Series)
EC-gfxProgram 925
Input(s)
Port Type Range Description
nviSpace Temp Numeric -10°C to 50°C Overrides the space temperature network input
value.
The default value of +327.67°C (invalid space
temperature value) is used during controller
power-up and when an update has not been
received within the specified receive heartbeat
time.
nvoSpace Numeric -10°C to 50°C Provides the current space temperature on the
Temp network through nvoSpaceTemp.
The default value of +327.67°C (invalid space
temperature value) is used during controller
power-up and when an update has not been
received within the specified receive heartbeat
time.
nvoUnitStatus. Enum -1 to 20* Provides the current Space Comfort Controller
Mode mode through nvoUnitStatus.Mode.
*: The following is the valid range of values:
1 = HVAC_HEAT: In heating mode.
2 = HVAC_MRNG_WRMUP: Morning warm-up
mode.
3 = HVAC_COOL: In cooling mode.
4 = HVAC_NIGHT_PURGE: Free cooling mode.
5 = HVAC_PRE_COOL: Morning cool-down
mode.
6 = HVAC_OFF: Unit off.
7 = HVAC_TEST: Special test mode, application
defined.
8 = HVAC_EMERG_HEAT: Emergency heat
mode.
9 = HVAC_FAN_ONLY: No heating or cooling
allowed.
12 = HVAC_MAX_HEAT: Maximum heating
mode.
nvoUnitStatus. Numeric 0 to 100% Provides the current Primary Heat Output on the
HeatOutput network through nvoUnitStatus. Default value:
Primary Null (invalid).
nvoUnitStatus. Numeric 0 to 100% Provides the current secondary heat output on
HeatOutput the network through nvoUnitStatus. Default
Secondary value: Null (invalid).
926 EC-gfxProgram
Port Type Range Description
nvoUnitStatus. Numeric 0 to 100% Provides the current primary cool output on the
CoolOutput network through nvoUnitStatus. Default value:
Null (invalid).
nvoUnitStatus. Numeric 0 to 100% Provides the current economizer output on the
EconOutput network through nvoUnitStatus. Default value:
Null (invalid).
nvoUnitStatus. Numeric 0 to 100% Provides the current fan speed output on the
FanOutput network through nvoUnitStatus. Default value:
Null (invalid).
nvoUnitStatus.I Numeric 0 to 255 Alarm status: 0 Means there is no alarm.
nAlarm
Any non-zero value means there is an alarm.
See the LONMARK profile for more information.
255 means that alarming is disabled.
Output(s)
Port Type Range Description
nviSpace Temp Numeric -10°C to 50°C The current space temperature value from the
network or the nviSpaceTemp input.
The default value of +327.67°C (invalid space
temperature value) is used during controller
power-up and when an update has not been
received within the specified receive heartbeat
time.
nvoSpace Numeric -10°C to 50°C The same value found at the nvoSpaceTemp
Temp input. This is useful to make the current input
values available at a second instance of this
block.
nvoUnitStatus. Enum -1 to 20 The same value found at the
UnitStatus. nvoUnitStatus.Mode input. This is useful to
Mode make the current input values available at a
second instance of this block.
nvoUnitStatus. Numeric 0 to 100% The same value found at the
HeatOutput nvoUnitStatus.HeatOutputPrimary input. This
Primary is useful to make the current input values
available at a second instance of this block.
nvoUnitStatus. Numeric 0 to 100% The same value found at the
HeatOutput nvoUnitStatus.HeatOutputSecondary input.
Secondary This is useful to make the current input values
available at a second instance of this block.
EC-gfxProgram 927
Port Type Range Description
nvoUnitStatus. Numeric 0 to 100% The same value found at the
CoolOutput nvoUnitStatus.CoolOutput input. This is useful
to make the current input values available at a
second instance of this block.
nvoUnitStatus. Numeric 0 to 100% The same value found at the
EconOutput nvoUnitStatus.EconOutput input. This is
useful to make the current input values available
at a second instance of this block.
nvoUnitStatus. Numeric 0 to 100% The same value found at the
FanOutput nvoUnitStatus.FanOutput input. This is useful
to make the current input values available at a
second instance of this block.
nvoUnitStatus.I Numeric 0 to 255 The same value found at the
nAlarm nvoUnitStatus.InAlarm input. This is useful to
make the current input values available at a
second instance of this block.
Block properties See also Common block properties.
Property Type Range Default Description
LonMark Menu See – Choose the LONMARK profile to be
ObjectName Description used with this block. The block’s
input and output ports change
accordingly.
Hardwired Gas Detection Profile LONMARK Object
#4310
Description Used to present to the network the LONMARK profile: Hardwired Gas Detec-
tion Profile #4310.
The LONMARK profile is chosen by the LonMarkObjectName option in the
block’s Properties pane. The block’s input and output ports change accord-
ingly.
Controller See the controller’s datasheet for the availability of this feature.
support
928 EC-gfxProgram
Number of Multiple blocks configured as the same LONMARK profile can be used in your
blocks code; however, the input and output ports of each block instance will act on
the same common network resources. The output ports of multiple block
instances can be used to provide network values throughout your code. For
input ports, use Configure Ports so that any given input port is exposed only
once among all block instances.
Advanced Advanced configuration, Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
nviHwGas Numeric 0 to 100% Provides the current gas detection shut down value
Detection. on the network through nviHwGasDetection.Value.
Value
nviHwGas Enum -1 Provides the current gas detection mode.
Detection.
0 -1 = Nul.
State
1 0 = False.
1 = True.
nvoHwGas Numeric 0 to 100% Provides the current gas detection feedback value to
DetectionFb. indicate that a gas detection shutdown has occurred
Value on the network through
nviHwGasDetectionFb.Value.
nvoHwGas Enum -1 Provides feedback for the current gas detection
DetectionFb. mode.
0
State
-1 = Nul.
1
0 = False.
1 = True.
Output(s)
Port Type Range Description
nviHwGas Numeric 0 to 100% The same value found at the
Detection. nviHwGasDetection.Value input. This is useful to
Value make the current input values available at a second
instance of this block.
nviHwGas Enum -1 Provides the current gas detection mode.
Detection.
0 -1 = Nul.
State
1 0 = False.
1 = True.
EC-gfxProgram 929
Port Type Range Description
nvoHwGas Numeric 0 to 100% The same value found at the
DetectionFb. nviHwGasDetectionFb.Value input. This is useful
Value to make the current input values available at a
second instance of this block.
nvoHwGas Enum -1 Provides feedback for the current gas detection
DetectionFb. mode.
0
State
-1 = Nul.
1
0 = False.
1 = True.
SCPTdeflt Numeric 0 to 100% The configuration property determines which set of
Behave.Value values will be used on power up and
communications failure.
SCPTdeflt Numeric 0 or 1
Behave.State
Block properties See also Common block properties.
Property Type Range Default Description
LonMark Menu See – Choose the LONMARK profile to be used
ObjectName Description with this block. The block’s input and
output ports change accordingly.
Hardwired Fire Alarm Profile LONMARK Object #4311
Description Used to present to the network the LONMARK profile: Hardwired Fire Alarm
Profile #4311.
The LONMARK profile is chosen by the LonMarkObjectName option in the
block’s Properties pane. The block’s input and output ports change accord-
ingly.
Controller See the controller’s datasheet for the availability of this feature.
support
Number of Multiple blocks configured as the same LONMARK profile can be used in your
blocks code; however, the input and output ports of each block instance will act on
the same common network resources. The output ports of multiple block
instances can be used to provide network values throughout your code. For
930 EC-gfxProgram
input ports, use Configure Ports so that any given input port is exposed only
once among all block instances.
Advanced Advanced configuration, Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
nviHwFire Numeric 0 to 100% Provides the current fire alarm shut down value on
Alarm.Value the network through nviHwFireAlarm.Value.
nviHwFire Enum -1 Provides the current fire alarm shut down mode.
Alarm.State
0 -1 = Nul.
1 0 = False.
1 = True.
nvoHwFire Numeric 0 to 100% Provides the current fire alarm shut down feedback
AlarmFb. Value value to indicate that a fire alarm shutdown has
occurred on the network through
nvoHwFireAlarmFb.Value.
nvoHwFire Enum -1 Provides feedback for the current fire alarm shut
AlarmFb. State down mode.
0
-1 = Nul.
1
0 = False.
1 = True.
Output(s)
Port Type Range Description
nviHwFire Numeric 0 to 100% The same value found at the
Alarm.Value nviHwFireAlarm.Value input. This is useful to make
the current input values available at a second
instance of this block.
nviHwFire Enum -1 Provides the current fire alarm mode.
Alarm.State
0 -1 = Nul.
1 0 = False.
1 = True.
nvoHwFire Numeric 0 to 100% The same value found at the
AlarmFb. Value nvoHwFireAlarmFb.Value input. This is useful to
make the current input values available at a second
instance of this block.
EC-gfxProgram 931
Port Type Range Description
nvoHwFire Enum -1 Provides feedback for the current fire alarm mode.
AlarmFb. State
0 -1 = Nul.
1 0 = False.
1 = True.
SCPTdeflt Numeric 0 to 100% The configuration property determines which set of
Behave.Value values will be used on power up and
communications failure.
SCPTdeflt Numeric 0 or 1
Behave.State
Block properties See also Common block properties.
Property Type Range Default Description
LonMarkObject Menu See – Choose the LONMARK profile to be used
Name Description with this block. The block’s input and
output ports change accordingly.
Hardwired Reticulation Profile LONMARK Object
#4312
Description Used to present to the network the LONMARK profile: Hardwired Recirculation
Profile #4312.
The LONMARK profile is chosen by the LonMarkObjectName option in the
block’s Properties pane. The block’s input and output ports change accord-
ingly.
Controller See the controller’s datasheet for the availability of this feature.
support
Number of Multiple blocks configured as the same LONMARK profile can be used in your
blocks code; however, the input and output ports of each block instance will act on
the same common network resources. The output ports of multiple block
instances can be used to provide network values throughout your code. For
input ports, use Configure Ports so that any given input port is exposed only
once among all block instances.
932 EC-gfxProgram
Advanced Advanced configuration, Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
nviHw Numeric 0 to 100% Provides the current recirculation value on the
Recircula. network through nviHwRecircula.Value.
Value
nviHw Enum -1 Provides the current fire alarm mode.
Recircula.
0 -1 = Nul.
State
1 0 = False.
1 = True.
nvoHw Numeric 0 to 100% Provides the current recirculation feedback value to
RecirculaFb. indicate that a system is on Recirculation has
Value occurred on the network through
nviHwRecircula.Value.
nvoHw Enum -1 Provides feedback for the current fire alarm mode.
RecirculaFb.
0 -1 = Nul.
State
1 0 = False.
1 = True.
Output(s)
Port Type Range Description
nviHw Numeric 0 to 100% The same value found at the
Recircula. nviHwRecircula.Value input. This is useful to make
Value the current input values available at a second
instance of this block.
nviHw Enum -1 Provides the current fire alarm mode.
Recircula.
0 -1 = Nul.
State
1 0 = False.
1 = True.
nvoHw Numeric 0 to 100% The same value found at the
RecirculaFb. nviHwRecircula.Value input. This is useful to make
Value the current input values available at a second
instance of this block.
EC-gfxProgram 933
Port Type Range Description
nvoHw Enum -1 Provides feedback for the current fire alarm mode.
RecirculaFb.
0 -1 = Nul.
State
1 0 = False.
1 = True.
SCPTdeflt Numeric 0 to 100% The configuration property determines which set of
Behave.Valu values will be used on power up and
e communications failure.
SCPTdeflt Numeric 0 or 1
Behave.State
Block properties See also Common block properties.
Property Type Range Default Description
LonMark Menu See – Choose the LONMARK profile to be used
ObjectName Description with this block. The block’s input and
output ports change accordingly.
Hardwired Full Ventilation Profile LONMARK Object
#4313
Description Used to present to the network the LONMARK profile: Hardwired Full Ventila-
tion Profile #4313.
The LONMARK profile is chosen by the LonMarkObjectName option in the
block’s Properties pane. The block’s input and output ports change accord-
ingly.
Controller See the controller’s datasheet for the availability of this feature.
support
Number of Multiple blocks configured as the same LONMARK profile can be used in your
blocks code; however, the input and output ports of each block instance will act on
the same common network resources. The output ports of multiple block
instances can be used to provide network values throughout your code. For
input ports, use Configure Ports so that any given input port is exposed only
once among all block instances.
934 EC-gfxProgram
Advanced Advanced configuration, Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
nviHwFull Numeric 0 to 100% Provides the current full ventilation value on the
Vent.Value network through nviHwFullVent.Value.
nviHwFull Enum -1 Provides the current fire alarm mode.
Vent.State
0 -1 = Nul.
1 0 = False.
1 = True.
nvoHwFull Numeric 0 to 100% Provides the current full ventilation feedback value
VentFb.Value to indicate that a system is on full ventilation has
occurred on the network through
nviHwFullVentFb.Value.
nvoHwFull Enum -1 Provides feedback for the current fire alarm mode.
VentFb.State
0 -1 = Nul.
1 0 = False.
1 = True.
Output(s)
Port Type Range Description
nviHwFull Numeric 0 to 100% The same value found at the
Vent.Value nviHwFullVent.Value input. This is useful to
make the current input values available at a
second instance of this block.
nviHwFull Enum -1 Provides the current fire alarm mode.
Vent.State
0 -1 = Nul.
1 0 = False.
1 = True.
nvoHw Numeric 0 to 100% The same value found at the
FullVentFb. nviHwFullVentFb.Value input. This is useful to
Value make the current input values available at a
second instance of this block.
EC-gfxProgram 935
Port Type Range Description
nvoHw Enum -1 Provides feedback for the current fire alarm mode.
FullVentFb.
0 -1 = Nul.
State
1 0 = False.
1 = True.
SCPTdeflt Numeric 0 to 100% The configuration property determines which set
Behave.Value of values will be used on power up and
communications failure.
SCPTdeflt Numeric 0 or 1
Behave.State
Block properties See also Common block properties.
Property Type Range Default Description
LonMarkObject Menu See – Choose the LONMARK profile to be
Name Description used with this block. The block’s input
and output ports change accordingly.
Hardwired Safety Instrumented System (SIS) Profile
LONMARK Object #4314
Description Used to present to the network the LONMARK profile: Hardwired Safety Instru-
mented System (SIS) Profile #4314.
The LONMARK profile is chosen by the LonMarkObjectName option in the
block’s Properties pane. The block’s input and output ports change accord-
ingly.
Controller See the controller’s datasheet for the availability of this feature.
support
Number of Multiple blocks configured as the same LONMARK profile can be used in your
blocks code; however, the input and output ports of each block instance will act on
the same common network resources. The output ports of multiple block
instances can be used to provide network values throughout your code. For
input ports, use Configure Ports so that any given input port is exposed only
once among all block instances.
936 EC-gfxProgram
Advanced Advanced configuration, Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
nviHwSIS. Numeric 0 to 100% Provides the current safety instrumented system
Value value on the network through nvoHwSIS.Value.
nviHwSIS. Enum -1 Provides the current fire alarm mode.
State
0 -1 = Nul.
1 0 = False.
1 = True.
nvoHwSISFb. Numeric 0 to 100% Provides the current safety instrumented system
Value feedback value to indicate that a security alarm has
been received by the equipment and has been acted
upon through nvoHwSISFb.Value.
nvoHwSISFb. Enum -1 Provides feedback for the current fire alarm mode.
State
0 -1 = Nul.
1 0 = False.
1 = True.
Output(s)
Port Type Range Description
nviHw Numeric 0 to 100% The same value found at the nvoHwSIS.Value
Recircula. input. This is useful to make the current input values
Value available at a second instance of this block.
nviHw Enum -1 Provides the current fire alarm mode.
Recircula.
0 -1 = Nul.
State
1 0 = False.
1 = True.
nvoHwSISFb. Numeric 0 to 100% The same value found at the nvoHwSISFb.Value
Value input. This is useful to make the current input values
available at a second instance of this block.
nvoHwSISFb. Enum -1 Provides feedback for the current fire alarm mode.
State
0 -1 = Nul.
1 0 = False.
1 = True.
EC-gfxProgram 937
Port Type Range Description
SCPTdeflt Numeric 0 to 100% The configuration property determines which set of
Behave.Value values will be used on power up and
communications failure.
SCPTdeflt Numeric 0 or 1
Behave.State
Block properties See also Common block properties.
Property Type Range Default Description
LonMark Menu See – Choose the LONMARK profile to be used
ObjectName Description with this block. The block’s input and
output ports change accordingly.
Advanced The LONMARK Object Configuration window allows the maximum receive
configuration time, and the minimum and maximum send times to be specified. Network
congestion occurs when network variables are transmitted too frequently on
the network. Network congestion can be reduced by only transmitting network
variables as frequently as is necessary to meet the system requirements. Set
the network properties as shown below (refer to the controller’s Functional
Profile in its datasheet). See also Typical controller internal points.
Figure 541: Typical LonMark Object Configuration window
See Network Properties Configuration window (ECL, ECB & ECY Series).
938 EC-gfxProgram
Logic
Logic blocks evaluate the binary values at two or more inputs according to the
block’s Boolean logic.
The following blocks are available in this category:
• And
• Multiplexer
• Not
• Or
• Selector
• Switch
• Xor
NOTE: Any non-zero value is evaluated as On (1). For more information, see
Data types. For clarity, the text in this section refers to all non-zero val-
ues simply as On or 1.
Example Logic blocks are common components in any type of code. They are very
useful for digital sequences, for example, turning components On and Off.
Below is an example of how a Fan (Hardware Output block) is started based
on a Schedule (Schedule, Multiplexer, and Internal constant blocks), Freeze,
and (And block) Smoke Detection inputs (Hardware Input and Not blocks).
Figure 542: Logic example
The Multiplexer block converts the enumerated occupancy modes into Bool-
ean values. Thus, if occupied mode is selected, the Multiplexer block output is
1. Otherwise, if unoccupied or standby mode is selected, the Multiplexer block
output is 0. The Not blocks check the Freeze and smoke detection inputs
(Hardware Input blocks) and output On if the inputs are Off and Off if the
inputs are On. Finally the And block checks the outputs of the Multiplexer and
Not blocks and if all are outputting an On value, for example, the unit is in
occupied mode and there is no ice or smoke detected, then the And block
outputs an On value and thus turns On the Fan (Hardware Output block).
Otherwise, if any one of the inputs to the And block are Off, then the And
EC-gfxProgram 941
block outputs an Off value and the Fan (Hardware Output block) is turned
Off.
And
Description Used to perform a standard And logic function.
The output will be On (1) if all connected inputs are On (1).
The output will be Off (0) if any connected input is Off (0).
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
Inputx Digital 0 or 1 Block input.
(x=1 to 10)
NOTE: Two inputs are always visible. The other eight pos-
sible inputs can be added by the user through the
Configure Ports window.
Output(s)
Port Type Range Description
Output Digital 0 or 1 Block output.
Because Null has no value, logic operations with a Null
input behave in a unique way. The truth table for an And
logic operation with Null is shown in Table 27.
942 EC-gfxProgram
Table 27: AND logic operation with Null
Input Any Input Other Output
0 0,1,Null 0
1 1 1
Null Null Null
Block properties See Common block properties.
Multiplexer
Description Used to select one of the values presented at 10 inputs based on an integer
value from 0 to 9 (Select input).
Advanced Configure Ports, Show/Hide Ports
configuration
EC-gfxProgram 943
Input(s)
Port Type Range Description
32-Bit 8-Bit
Inputx Numeric ±3.4028×1038 -83886.08 to The value outputted when the Select
+83886.07 input receives an x signal.
(x=0 to 9)
For example, if the Select input
receives a value of 3, the value in
Input3 will be outputted.
NOTE: Two inputs are always visible.
The other eight possible inputs
can be added by the user
through the Configure Ports win-
dow.
Select Integer 0 to 9 Select the block’s input to send to the
Output port. Receives an integer from 0
to 9.
NOTE: All inputs that are to be selected
must be linked to a value.
If this input value is higher than any
configured Input port, the block’s
Output value is that of the highest
configured Input port. If this input value
is negative or Null, or if an unconfigured
input is selected, the output of this block
will be 0.
Output(s)
Port Type Range Description
32-Bit 8-Bit
Output Numeric ±3.4028×1038 -83886.08 to Block output.
+83886.07
Block properties See Common block properties.
Example The Multiplexer block can be used for standard switching operations
between multiple inputs. The example below shows how this block can be
944 EC-gfxProgram
used to switch HVAC modes through the use of Pid, SmartSensor Module
(ECP Series), Comparator, Switch, and Internal constant blocks.
Figure 543: Multiplexer block example
The Multiplexer block is controlled by the SmartSensor Module block.
When the Multiplexer block receives an HVAC_AUTO (0) value, Input0 is acti-
vated, for example, the Output of the created project code in the upper part of
the example. When it receives other values, the corresponding input of the
Multiplexer block is activated. The Output of the Multiplexer block is sent back
to the SmartSensor Module block to be displayed.
Not
Description Used to perform a standard Not logic function, that is, will reverse a digital
value.
The output will be On (1) if the input is Off (0).
The output will be Off (0) if the input is On (1).
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
Input Digital 0 or 1 Block input.
EC-gfxProgram 945
Output(s)
Port Type Range Description
Output Digital 0 or 1 Block output.
Because Null has no value, logic operations with a Null input
behave in a unique way. The truth table for the Not logic
operation with Null is shown in Table 28.
Table 28: NOT logic operation with null
Input Output
0 1
1 0
Null Null
Block properties See Common block properties.
Or
Figure 544: Description
Used to perform a standard Or logic function.
The output will be On (1) if any connected input is On (1).
The output will be Off (0) if all connected inputs are Off (0).
Advanced Configure Ports
configuration
946 EC-gfxProgram
Input(s)
Port Type Range Description
Inputx Digital 0 or 1 Block input.Two inputs are always visible.
(x=1 to 10)
NOTE: The other eight possible inputs can be added by the
user through the Configure Ports window.
Output(s)
Port Type Range Description
Output Digital 0 or 1 Block output.
Because Null has no value, logic operations with a Null input
behave in a unique way. The truth table for an Or logic
operation with Null is shown in Table 29.
Table 29: OR logic operation with Null
Input Any Input Other Output
0 0 or Null 0
1 0, 1, or Null 1
Null Null Null
Block properties See Common block properties.
Selector
Description Used to exclusively assign a given value (from the Input port) to one of the 10
outputs based on the specified output's number (from the Select port) using a
value from 0 to 9.
EC-gfxProgram 947
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
32-Bit 8-Bit
Input Numeric ±3.4028×1038 -83886.08 to The value outputted in one of the 10
+83886.07 output ports. The output port is specified
in the Select port.
If no specific value is provided in this
port, a value of 0 is outputted by default.
Select Integer 0 to 9 The output where the input value is
outputted, by specifying the output
number (between 0 and 9).
For example, if the Select input is linked
to a value of 6, the value currently
coming from the Input port will be
outputted in Output 6.
All other outputs will output the value
currently coming from the Default port
or display a Null value if no specific
default value is provided.
Default Integer Select the default value to be outputted
on the output ports when the ports are
not selected. If no specific value is
provided in this port, a value of Null is
outputted by default.
NOTE: By default, this port is not dis-
played. It can be added through
the Configure Ports window.
Outputs(s)
Port Type Range Description
32-Bit 8-Bit
Outputx Numeric ±3.4028×1038 -83886.08 to Block outputs.
+83886.07
(x=0 to 9)
948 EC-gfxProgram
Examples In the following figure, the Selector block is used to select a position. The
selected position outputs a value other than a null value.
Figure 545: Selector block as a position selector
In the following figure, the Selector block is used to output a specific value at a
given position. Only the selected position outputs the value otherwise it out-
puts a null value.
Figure 546: Selector block as a value selector
In the following figure, the Selector block is used to output a value of 1 to a
given position. Only the selected position outputs 1 otherwise the output is 0.
The Default port has been added through the Configure Ports window and
the port has been linked to show an output of 0 rather than a null value.
EC-gfxProgram 949
Switch
Description Used to select between two values based on a Boolean condition. This block
outputs one value if it selects an On value and another value if it selects an
Off value.
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
32-Bit 8-Bit
On Numeric ±3.4028×1038 -83886.08 to The value outputted when the Select
+83886.07 input receives an On (1) signal.
Off Numeric ±3.4028×1038 -83886.08 to The value outputted when the Select
+83886.07 input receives an Off (0) signal.
Select Integer ±3.4028×1038 -83886.08 to Select the block’s input On or Off value
+83886.07 to send to the Output port. A positive
input greater than or equal to 1 selects
the value at the On input as the Output.
A value less than 1 selects the value at
the Off input as the Output.
A Null input selects the value at the Off
input as the Output.
Output(s)
Port Type Range Description
32-Bit 8-Bit
Output Numeric ±3.4028×1038 -83886.08 to Block output.
+83886.07
Block properties See Common block properties.
Example The Switch block can be used for standard switching operations between two
inputs. The example below shows how this block can be used to switch On an
950 EC-gfxProgram
Outdoor Air Damper Position Pid block through the use of Schedule, Vari-
able Enum, Multiplexer, Linear, and Internal constant blocks to control an
Outdoor Air Damper (Hardware Output block).
Figure 547: Switch block example
The Switch block is controlled by the Variable Enum block. For example,
when the Switch block receives an On value, free cooling is enabled, and the
Output of the Pid block is activated. When it receives an Off value, free cool-
ing is disabled, and the output is 0%. The Output of the Switch block is sent to
the Linear block where it is interpolated to give the Outdoor Air Damper
(Hardware Output block) position.
Xor
Description Used to perform a standard Xor logic function.
The output will be On (1) if an odd number of inputs are On (1).
The output will be Off (0) if either all connected inputs are Off (0) or if even
numbers of inputs are On (1).
Advanced Configure Ports, Show/Hide Ports
configuration
EC-gfxProgram 951
Input(s)
Port Type Range Description
Inputx Digital 0 or 1 Block input.
(x=1 to 10)
NOTE: Two inputs are always visible. The other eight pos-
sible inputs can be added by the user through the
Configure Ports window.
Output(s)
Port Type Range Description
Output Digital 0 or 1 Block output.
Because Null has no value, logic operations with a Null
input behave in a unique way. The truth table for an Xor
logic operation with Null is shown in Table 30.
Table 30: XOR logic operation with Null
Input 1 Input 2 Output
0 0 0
1 0 1
0 1 1
1 1 0
0 Null 0
1 Null 0
Null 0 0
Null 1 0
Null Null Null
Block properties See Common block properties.
952 EC-gfxProgram
Logic (Binary)
Binary logic blocks perform bitwise logical operations on two or more bit pat-
terns at the level of the individual bits representing the values found at the
block’s inputs.
The following blocks are available in this category:
• Bitwise And (ECL, ECB & ECY Series)
• Bitwise Or (ECL, ECB & ECY Series)
• Left Bit Shift (ECL, ECB & ECY Series)
• Right Bit Shift (ECL, ECB & ECY Series)
EC-gfxProgram 953
Bitwise And (ECL, ECB & ECY Series)
Description Used to perform a standard bitwise And logic function on the binary value
found at each input. This is done by representing all input values in binary and
performing a logical And operation on the corresponding binary values.
A bitwise And is shown below for two 8-Bit values.
Input1 0 1 1 0 0 1 0 1 =101
Input2 And 1 1 0 0 1 1 0 0 =204
Output = 0 1 0 0 0 1 0 0 =68
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
Inputx Numeric 0 to 16777216 Block input.
(x=1 to 10)
NOTE: Two inputs are always visible. The other
eight possible inputs can be added by the
user through the Configure Ports window.
If any input Is Null (ECL, ECB & ECY Series), the
output is 0.
Output(s)
Port Type Range Description
Output Numeric 0 to 16777216 Block output.
954 EC-gfxProgram
Block properties See Common block properties.
Bitwise Or (ECL, ECB & ECY Series)
Description Used to perform a standard bitwise Or logic function on the binary value found
at each input. This is done by representing all input values in binary and per-
forming a logical Or operation on the corresponding binary values.
A bitwise Or is shown below for two 8-Bit values.
Input1 0 1 1 0 0 1 0 1 =101
Input2 Or 1 1 0 0 1 1 0 0 =204
Output = 1 1 1 0 1 1 0 1 =237
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
Inputx Numeric 0 to Block input.
16777216
(x=1 to 10)
NOTE: Two inputs are always visible. The other eight
possible inputs can be added by the user
through the Configure Ports window.
A Null input has the equivalent effect of being zero (0).
Block properties See Common block properties.
EC-gfxProgram 955
Left Bit Shift (ECL, ECB & ECY Series)
Description Used to shift the binary representation of a value of up to 32 bits to the left by
a specified number of bit positions. Each shift to the left multiplies the value at
the input by 2.
A shift by 2 bit positions to the left is shown below.
Input 2 left 0 0 1 0 1 0 0 0 =40
Output = 1 0 1 0 0 0 0 0 =160
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
Input Numeric 0 to 232 Block input. A Null input has the equivalent effect of being
zero (0).
Bits Numeric 0 to 32 The number of bit positions the input value is to be shifted
to the left. A Null input has the equivalent effect of being
zero (0).
Output(s)
Port Type Range Description
Output Numeric 0 to 232 Block output.
NOTE: Bits that are shifted out of the 32-Bit register are
dropped (lost).
Block properties See Common block properties.
956 EC-gfxProgram
Right Bit Shift (ECL, ECB & ECY Series)
Description Used to shift the binary representation of a value of up to 32 bits to the right by
a specified number of bit positions. Each shift to the right divides the value at
the input by 2.
A shift by 2 bit positions to the right is shown below.
Input 2 right 0 0 1 0 1 0 0 0 =40
Output = 0 0 0 0 1 0 1 0 =10
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
Input Numeric 0 to 232 Block input. A Null input has the equivalent effect of being
zero (0).
Bits Numeric 0 to 32 The number of bit positions the input value is to be shifted to
the right. A Null input has the equivalent effect of being zero
(0).
Output(s)
Port Type Range Description
Output Numeric 0 to 232 Block output.
NOTE: Bits that are shifted out of the 32-Bit register are
dropped (lost).
Block properties See Common block properties.
EC-gfxProgram 957
Math
Math blocks evaluate the values at two or more inputs according to the block’s
mathematical operator.
The following blocks are available in this category depending on the platform:
• Absolute
• Add
• Average
• Cosine (ECL, ECB & ECY Series)
• Divide
• Inverse Cosine (ECL, ECB & ECY Series)
• Inverse Sine (ECL, ECB & ECY Series)
• Inverse Tangent (ECL, ECB & ECY Series)
• Ln (ECL, ECB & ECY Series)
• Log (ECL, ECB & ECY Series)
• Maximum
• Min/Max/Average
• Minimum
• Modulus
• MulDiv
• Multiply
• Power (ECL, ECB & ECY Series)
• Sine (ECL, ECB & ECY Series)
• Square Root
• Subtract
• Summation
• Tangent (ECL, ECB & ECY Series)
Example Math blocks are used to create mathematical functions. The example below
shows how a Celsius value from a Constant Numeric (ECP Series) block can
be converted to a Fahrenheit value through the use of a Multiply and Add
block, as well as a pair of Internal constant blocks.
Figure 548: Math example
958 EC-gfxProgram
The Multiply block outputs the result of the multiplication between the Celsius
value coming from the Constant Numeric block and a constant value of 1.8
from an Internal Constant block. The Add block then adds the Output of the
Multiply block and a constant value of 32 from an Internal Constant block. The
Output of the Add block is the converted Fahrenheit value. In the above
example the result is calculated as follows:
Avoid Overflow and Underflow
As a result of a calculation, the input values may cause an overflow or under-
flow on the block’s Output. This can be avoided by using a Limit block at the
block’s Input, Output, or both.
Controller Type Underflow Limit Overflow Limit
ECP Series <-83886.08 >83886.07
controller: Signed
24-Bit number with
two decimal places
ECL, ECB & ECY <-3.4028×1038 >3.4028×1038
Series controller2:
32-Bit floating-point Any value lower than Any value greater than the
numeric precision the minimum value maximum value will be
will be considered considered "infinite".
"minus infinite".
Entering Floating-Point numbers and Null values in
a dialog box
Large numbers are entered into a dialog box using a special format. For
example, 2.385X1012 is entered into a dialog box as 2.385E+12. A null value
is typed in as null.
EC-gfxProgram 959
Absolute
Description The block will output the absolute value of the connected input, that is, a neg-
ative value is changed to positive and a positive value is unchanged.
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
32-Bit 8-Bit
Input Numeric ±3.4028×1038 -83886.07 to Block input. For a Null Input value,
+83886.07 see below.
NOTE: For ECP Series controllers, -
83886.08 is not a value sup-
ported by the Absolute block.
If such a value were to be
inputted then the block will
output a value of 83886.07.
Output(s)
Port Type Range Description
32-Bit 8-Bit
Output Numeric 0 to 3.4028×1038 0 to The absolute value of the input. For
83886.07 ECL, ECB & ECY Series controllers: If
the Input to this block is not Null, then
the block’s output is the normal result.
If the Input to this block is Null, then
the Output of this block is always
Null.
Block properties See Common block properties.
960 EC-gfxProgram
Add
Description Used to perform a standard addition operation. The block will output the sum
value of all the connected inputs. The addition is calculated as follows:
Be aware that as a result of the calculation, the input values may cause an
overflow or underflow on the Output.
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
32-Bit 8-Bit
Inputx Numeric ±3.4028×1038 -83886.08 to Block input. For a Null Input value,
+83886.07 see below.
(x=1 to 10)
NOTE: Two inputs are always visi-
ble. The other eight possible
inputs can be added by the
user through the Configure
Ports window.
EC-gfxProgram 961
Output(s)
Port Type Range Description
32-Bit 8-Bit
Output Numeric ±3.4028×1038 -83886.08 to The sum value of the inputs. For ECL,
+83886.07 ECB & ECY Series controllers: If no
Input to this block is Null, then the
block’s output is the normal result. If one
or more Inputs to this block are Null,
then the Output of this block is always
Null.
Block properties See Common block properties.
Average
Description Used to calculate the average value of the inputs. The average value is calcu-
lated as follows:
Be aware that the summation of the values of the connected inputs may
cause an overflow or underflow on the Output
Advanced Configure Ports, Show/Hide Ports
configuration
962 EC-gfxProgram
Input(s)
Port Type Range Description
32-Bit 8-Bit
Inputx Numeric ±3.4028×1038 -83886.08 to Block input. For a Null Input value,
+83886.07 see below.
(x=1 to 10)
NOTE: Two inputs are always visible.
The other eight possible
inputs can be added by the
user through the Configure
Ports window.
Output(s)
Port Type Range Description
32-Bit 8-Bit
Output Numeric ±3.4028×1038 -83886.08 to The average value of the inputs. For
+83886.07 ECL, ECB & ECY Series controllers: If
a Null value is present on one or more
Input ports, but not on all Input ports,
then these input ports are not taken
into account to calculate the output
value. For example, if 3 out of 10
inputs are Null, then the output value
is calculated based on the values of
the remaining 7 inputs. If all Input
values to this block are Null, then the
Output value of this block is always
Null.
Block properties See Common block properties.
Example See the Example in the Min/Max/Average block section.
EC-gfxProgram 963
Cosine (ECL, ECB & ECY Series)
Description Used to perform a standard trigonometric cosine operation in radians on the
connected input. The cosine is calculated as follows:
where
A graph of the cosine function is shown below.
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
Input Numeric ±3.4028×1038 Block input in radians (radian = degrees * p / 180).
For a Null Input value, see below.
964 EC-gfxProgram
Output(s)
Port Type Range Description
Output Numeric -1 to 1 The cosine of the input. If the Input to this block is not Null,
then the block’s output is the normal result. If the Input to
this block is Null, then the Output of this block is always
Null.
Block properties See Common block properties.
Divide
Description Used to perform a standard division operation. The block will output the divi-
sion value of the connected inputs. The division is calculated as follows:
NOTE: Be aware that as a result of the calculation, if Input2 is between -1
and 1 it may cause an overflow or underflow on the Output (use the
Limit block to avoid this if necessary).
If Input2 is equal to 0 and Input1 has a positive value, then the block
will output the maximum value. If Input2 is equal to 0 and Input1 has
a negative value, then the block will output the minimum value.
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
32-Bit 8-Bit
Input1 Numeric ±3.4028×1038 -83886.08 to Block input. The dividend. For a Null
+83886.07 Input value, see below.
Input2 Numeric ±3.4028×1038 -83886.08 to Block input. The divisor. For a Null
+83886.07 Input value, see below.
EC-gfxProgram 965
Output(s)
Port Type Range Description
32-Bit 8-Bit
Output Numeric ±3.4028×1038 -83886.08 to The division value or quotient of the
+83886.07 inputs. For ECL, ECB & ECY Series
controllers: If no Input to this block
is Null, then the block’s output is the
normal result. If one or more Inputs
to this block are Null, then the
Output of this block is always Null.
Block properties See Common block properties.
Inverse Cosine (ECL, ECB & ECY Series)
Description Used to perform a standard trigonometric inverse cosine (arccos) operation
on the connected input. The inverse cosine is defined as follows:
For , if
A graph of the inverse cosine function is shown below.
Advanced Configure Ports, Show/Hide Ports
configuration
966 EC-gfxProgram
Input(s)
Port Type Range Description
Input Numeric -1 to 1 Block input. For a Null Input value, see below.
NOTE: If the Input is out of range, then the Output of
this operator is Null.
Output(s)
Port Type Range Description
Output Numeric 0 to The inverse cosine of the input. If the Input to this block
3.14159274 is not Null, then the block’s output is the normal result. If
the Input to this block is Null, then the Output of this
block is always Null.
Block properties See Common block properties.
Inverse Sine (ECL, ECB & ECY Series)
Description Used to perform a standard trigonometric inverse cosine (arcsin) operation on
the connected input. The inverse sine is defined as follows:
For , if
A graph of the inverse sine function is shown below.
Advanced Configure Ports, Show/Hide Ports
configuration
EC-gfxProgram 967
Input(s)
Port Type Range Description
Input Numeric -1 to 1 Block input. For a Null Input value, see below.
NOTE: If the Input is out of range, then the Output of
this operator is Null.
Output(s)
Port Type Range Description
Output Numeric -1.57079637 to The inverse sine of the input. If the Input to this block
1.57079637 is not Null, then the block’s output is the normal result.
If the Input to this block is Null, then the Output of this
block is always Null.
Block properties See Common block properties.
Inverse Tangent (ECL, ECB & ECY Series)
Description Used to perform a standard trigonometric inverse tangent (arctan) operation
on the connected input. The inverse tangent is calculated as follows:
For , if
A graph of the inverse tangent function is shown below.
Advanced Configure Ports, Show/Hide Ports
configuration
968 EC-gfxProgram
Input(s)
Port Type Range Description
Input Numeric ±3.4028×1038 Block input. For a Null Input value, see below.
Output(s)
Port Type Range Description
Output Numeric -1.57079637 to The inverse tangent of the input. If the Input to this
1.57079637 block is not Null, then the block’s output is the normal
result. If the Input to this block is Null, then the Output
of this block is always Null.
Block properties See Common block properties.
Ln (ECL, ECB & ECY Series)
Description Used to perform a standard natural logarithm operation on the connected
input. The natural logarithm uses the base e which approximately equals
2.718281828.
A graph of the natural logarithm function is shown below.
NOTE: If the Input is 0, then the Output of this operator is -. If the Input is
negative, then the Output of this operator is Null
EC-gfxProgram 969
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
Input Numeric 0 to 3.4028×1038 Block input. For a Null Input value, see below.
Output(s)
Port Type Range Description
Output Numeric -87.49 to 88.72 The natural logarithm of the input. If the Input to
this block is not Null, then the block’s output is the
normal result. If the Input to this block is Null, then
the Output of this block is always Null.
Block properties See Common block properties.
Log (ECL, ECB & ECY Series)
Description Used to perform a standard base-10 logarithm operation on the connected
input.
A graph of the base-10 logarithm function is shown below.
NOTE: If the Input is 0, then the Output of this operator is -. If the Input is
negative, then the Output of this operator is Null.
970 EC-gfxProgram
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
Input Numeric 0 to 3.4028×1038 Block input. For a Null Input value, see below.
Output(s)
Port Type Range Description
Output Numeric -38 to 38.53 The logarithm of the input. If the Input to this block is
not Null, then the block’s output is the normal result.
If the Input to this block is Null, then the Output of
this block is always Null.
Block properties See Common block properties.
Maximum
Description Used to output the highest (maximum) value of the inputs.
Advanced Configure Ports, Show/Hide Ports
configuration
EC-gfxProgram 971
Input(s)
Port Type Range Description
32-Bit 8-Bit
Inputx Numeric ±3.4028×1038 -83886.08 to Block input. For a Null Input value,
+83886.07 see below.
(x=1 to 10)
NOTE: Two inputs are always visi-
ble. The other eight possible
inputs can be added by the
user through the Configure
Ports window.
Output(s)
Port Type Range Description
32-Bit 8-Bit
Output Numeric ±3.4028×1038 -83886.08 to The maximum value of the inputs.
+83886.07 For ECL, ECB & ECY Series
controllers: If no Input to this block
is Null, then the block’s output is the
normal result. If one or more Inputs
to this block are Null, then the
Output of this block is always Null.
Block properties See Common block properties.
Example See the Example in the Min/Max/Average block section.
972 EC-gfxProgram
Min/Max/Average
Description Used to calculate the minimum, maximum, and average value of the inputs.
The average value is calculated as follows:
NOTE: Be aware that the summation of the values of the connected inputs
may cause an overflow or underflow on the Output.
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
32-Bit 8-Bit
Inputx Numeric ±3.4028×1038 -83886.08 to Block input. For a Null Input value,
+83886.07 see below.
(x=1 to 10)
NOTE: Two inputs are always visi-
ble. The other eight possible
inputs can be added by the
user through the Configure
Ports window.
EC-gfxProgram 973
Output(s)
Port Type Range Description
32-Bit 8-Bit
Minimum Numeric ±3.4028×1038 -83886.08 to The minimum value of the inputs. For
+83886.07 ECL, ECB & ECY Series controllers: If
a Null value is present on one or more
Input ports, but not on all Input ports,
then these input ports are not taken
into account to calculate the output
values. For example, if 3 out of 10
inputs are Null, then the output values
are calculated based on the values of
the remaining 7 inputs. If all Input
values to this block are Null, then the
Output values of this block are
always Null.
Maximum Numeric ±3.4028×1038 -83886.08 to The maximum value of the inputs. For
+83886.07 ECL, ECB & ECY Series controllers: If
a Null value is present on one or more
Input ports, but not on all Input ports,
then these input ports are not taken
into account to calculate the output
values. For example, if 3 out of 10
inputs are Null, then the output values
are calculated based on the values of
the remaining 7 inputs. If all Input
values to this block are Null, then the
Output values of this block are
always Null.
Average Numeric ±3.4028×1038 -83886.08 to The average value of the inputs. For
+83886.07 ECL, ECB & ECY Series controllers: If
a Null value is present on one or more
Input ports, but not on all Input ports,
then these input ports are not taken
into account to calculate the output
values. For example, if 3 out of 10
inputs are Null, then the output values
are calculated based on the values of
the remaining 7 inputs. If all Input
values to this block are Null, then the
Output values of this block are
always Null.
Block properties See Common block properties.
974 EC-gfxProgram
Example The Min/Max/Average block is used to evaluate a set of values. The example
below shows how this block can compare temperatures of different zones in a
space (Hardware Input blocks).
Figure 549: Min/Max/Average block example
The Min/Max/Average block outputs the minimum, maximum, and average
values of its inputs. In the above example the minimum value is 55°F being
received from zone 2, the maximum value is 80°F being received from zone 4
and the average value is:
Minimum
Description Used to output the lowest (minimum) value of the inputs.
Advanced Configure Ports, Show/Hide Ports
configuration
EC-gfxProgram 975
Input(s)
Port Type Range Description
32-Bit 8-Bit
Inputx Numeric ±3.4028×1038 -83886.08 to Block input. For a Null Input value,
+83886.07 see below. For a Null Input value, see
(x=1 to 10)
below.
NOTE: Two inputs are always visible.
The other eight possible
inputs can be added by the
user through the Configure
Ports window.
Output(s)
Port Type Range Description
32-Bit 8-Bit
Output Numeric ±3.4028×1038 -83886.08 to The minimum value of the inputs. For
+83886.07 ECL, ECB & ECY Series controllers: If
no Input to this block is Null, then the
block’s output is the normal result. If
one or more Inputs to this block are
Null, then the Output of this block is
always Null.
Block properties See Common block properties.
Example See the Example in the Min/Max/Average block section.
Modulus
Description The block will output the modulus value or remainder of the division between
the connected inputs.
For example:
Input1 = 10, Input2 = 2, then Output = 0
Input1 = 10, Input2 = 3, then Output = 1
976 EC-gfxProgram
Input1 = 10, Input2 = 4, then Output = 2
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
32-Bit 8-Bit
Input1 Integer ±3.4028×1038 ±83886 Block input. The dividend. For a Null Input
value, see below.
Input2 Integer ±3.4028×1038 ±83886 Block input. The divisor. For a Null Input
value, see below.
Output(s)
Port Type Range Description
32-Bit 8-Bit
Output Integer 0 to 3×1038 0 to The modulus value or remainder of the
83886 division. For ECL, ECB & ECY Series
controllers: If no Input to this block is Null,
then the block’s output is the normal result.
If one or more Inputs to this block are Null,
then the Output of this block is always Null.
Block properties See Common block properties.
EC-gfxProgram 977
MulDiv
Description The block multiplies two input values and divides the result by a third input
value. The muldiv is calculated as follows:
NOTE: For ECP Series controllers: Be aware that as a result of the calcula-
tion, the input values may cause an overflow (>83886.07) or under-
flow (<-83886.08) on the Output. Furthermore, you should avoid
having the Divider approach zero as the block will go into overflow
(use the Limit block to avoid this if necessary).
For example, the Input and Multiplier can both be ±83886.07; how-
ever the value of the Divider must bring the final result within the
range of -83886.08 to 83886.07.
For ECL, ECB & ECY Series controllers: Be aware that as a result of
the calculation, the input values may cause an overflow
(>3.4028×1038) or underflow (<-3.4028×1038) on the Output. Further-
more, you should avoid having the Divider approach zero as the
block will go into overflow (use the Limit block to avoid this if neces-
sary).
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
32-Bit 8-Bit
Input Numeric ±3.4028×1038 -83886.08 to Block input.
+83886.07
Multiplier Numeric ±3.4028×1038 -83886.08 to The multiplier.
+83886.07
Divider Numeric ±3.4028×1038 -83886.08 to The denominator.
+83886.07
978 EC-gfxProgram
Output(s)
Port Type Range Description
32-Bit 8-Bit
Output Numeric ±3.4028×1038 -83886.08 to The multiplication division value of the
+83886.07 inputs.
Block properties See Common block properties.
Multiply
Description Used to perform a standard multiplication operation. The block will output the
multiplication value of the connected inputs. The multiplication is calculated
as follows:
NOTE: Be aware that as a result of the calculation, the input values may
cause an overflow or underflow on the Output.
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
32-Bit 8-Bit
Inputx Numeric ±3.4028×1038 -83886.08 to Block input. For a Null Input value,
+83886.07 see below.
(x=1 to 2)
EC-gfxProgram 979
Output(s)
Port Type Range Description
32-Bit 8-Bit
Output Numeric ±3.4028×1038 -83886.08 to The multiplication value of the inputs.
+83886.07 For ECL, ECB & ECY Series
controllers: If no Input to this block is
Null, then the block’s output is the
normal result. If one or more Inputs to
this block are Null, then the Output of
this block is always Null.
Block properties See Common block properties.
Power (ECL, ECB & ECY Series)
Description Raises the Input by an exponent as follows:
NOTE: Be aware that as a result of the calculation, the input values may
cause an overflow () on the Output.
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
Input Numeric ±3.4028×1038 The base. For a Null Input value, see below.
Exponent Numeric ±3.4028×1038 The exponent. For a Null Input value, see below.
980 EC-gfxProgram
Output(s)
Port Type Range Description
Output Numeric 0 to The resulting value. If no Input to this block is Null, then the
block’s output is the normal result. If one or more Inputs to
this block are Null, then the Output of this block is always
Null.
Block properties See Common block properties.
Sine (ECL, ECB & ECY Series)
Description Used to perform a standard trigonometric sine operation in radians on the
connected input. The sine is calculated as follows:
where
A graph of the sine function is shown below.
Advanced Configure Ports, Show/Hide Ports
configuration
EC-gfxProgram 981
Input(s)
Port Type Range Description
Input Numeric ±3.4028×1038 Block input in radians (radian = degrees * / 180). For
a Null Input value, see below.
Output(s)
Port Type Range Description
Output Numeric -1 to 1 The sine of the input. If the Input to this block is not
Null, then the block’s output is the normal result. If the
Input to this block is Null, then the Output of this block
is always Null.
Block properties See Common block properties.
Square Root
Description Used to perform a standard square root operation. The block will output the
square root value of the connected input.
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
32-Bit 8-Bit
Input Numeric 0 to 3.4028×1038 0 to 83886.07 Block input. For a Null Input value,
see below.
NOTE: Negative values at the Input are not supported by the Square Root
block. If such a value is inputted then the block outputs Null.
982 EC-gfxProgram
Output(s)
Port Type Range Description
32-Bit 8-Bit
Output Numeric 1.8446×1019 0 to 289.63 The square root value of the input. For
ECL, ECB & ECY Series controllers: If
the Input to this block is not Null, then
the block’s output is the normal result. If
the Input to this block is Null, then the
Output of this block is always Null.
Block properties See Common block properties.
Example The Square Root block can be used to perform a mathematical calculation.
The example below shows how air flow (Multiply block) is calculated based on
the Duct Area (Multiply and Internal constant blocks) and Air Velocity (Multiply
block), which is calculated by multiplying a constant 4005 (Internal Constant
block) by the square root (Square Root block) of the Supply Air Velocity Pres-
sure (Hardware Input block).
Figure 550: Square Root block example
The Square Root block outputs the square root of the Supply Air Velocity
Pressure, while the Multiply blocks output the Air Velocity, Duct Area, and
Flow respectively.
The above example is representative of the following equation:
Q = Air flow
pv = Supply air velocity pressure (0.87)
A = Duct area, L x W (2ft x 2ft or 4ft2)
EC-gfxProgram 983
Subtract
Description Used to perform a standard subtraction operation. The block will output the
subtraction value of the connected inputs. The subtraction is calculated as fol-
lows:
NOTE: Be aware that as a result of the calculation, the input values may
cause an overflow or underflow on the Output.
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
32-Bit 8-Bit
Input1 Numeric ±3.4028×1038 -83886.08 to Block input. The minuend. For a Null
+83886.07 Input value, see below.
Input2 Numeric ±3.4028×1038 -83886.08 to Block input. The subtrahend. For a
+83886.07 Null Input value, see below.
Output(s)
Port Type Range Description
32-Bit 8-Bit
Output Numeric ±3.4028×1038 -83886.08 to The subtraction value of the inputs.
+83886.07 For ECL, ECB & ECY Series
controllers: If no Input to this block is
Null, then the block’s output is the
normal result. If one or more Inputs to
this block are Null, then the Output of
this block is always Null.
Block properties See Common block properties.
984 EC-gfxProgram
Summation
Description Used to perform a standard summation operation based on a time interval.
The value of the input will be added to the previous value of the input over a
user-defined time interval. The value is then outputted from the block. The
summation is calculated as follows:
NOTE: Be aware that as a result of the calculation, the input values may
cause an overflow or underflow on the Output.
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
32-Bit 8-Bit
Input Numeric ±3.4028×1038 -83886.08 to Block input. For a Null Input value, see
+83886.07 below.
Reset Digital 0 or 1 Enabling this input (1) will reset the
output to 0.
Output(s)
Port Type Range Description
32-Bit 8-Bit
Output Numeric ±3.4028×1038 -83886.08 to The summation value of the input. For
+83886.07 ECL, ECB & ECY Series controllers: If
no Input to this block is Null, then the
block’s output is the normal result. If one
or more Inputs to this block are Null,
then the Output of this block is always
Null.
Count Numeric 0 to 0 to Number of times that the block has
3.4028×1038 83886.07 performed a summation operation.
EC-gfxProgram 985
Block properties See also Common block properties.
Property Type Range Default Description
TimeBase Menu See Second Select the unit of time: Second, Minute
Description or Hour.
NOTE: If the TimeBase is set to min-
utes, 59 seconds will be shown
as 0.98 minutes.
TimeInterval Integer 0 to 83886 0 The summation time interval.
0 to 3×1038
Example The Summation block can be used to perform a mathematical calculation.
The example below shows how the Daily Power Consumption (Variable
Numeric (ECP Series) block) of a Duct Heater (Hardware Output block) is
calculated (Summation, Multiply, and Internal constant blocks) everyday
(Real Time Clock, Variable Enum, Not Equal, and Conditional Custom
Block) by summing the Instantaneous Kilowatt Usage (Variable Numeric
block) every minute.
Figure 551: Summation block example
The Duct Heater (Hardware Output block) outputs the percentage of power
used by the equipment. The Multiply block multiplies this percentage by the
total power capacity of the equipment (5kW) and outputs the Instantaneous
Kilowatt Usage (Variable Numeric block). The Summation block takes this
value and adds it to the previous value every minute. The Multiply block then
multiplies this result by 24 hours so that after a day has passed, it outputs the
Daily Power Consumption (Variable Numeric block) in kilowatt hours (kWh).
The Real Time Clock, Variable Enum, Not Equal, and Conditional Custom
Blocks make up a sequence whereby the Summation block is reset after a
day has passed.
986 EC-gfxProgram
Tangent (ECL, ECB & ECY Series)
Description Used to perform a standard trigonometric tangent operation in radians on the
connected input. The tangent is calculated as follows:
where
A graph of the tangent function is shown below.
NOTE: Be aware that any positive or negative multiple of π minus π/2
( ) will cause an overflow or under-
flow on the Output
Advanced Configure Ports, Show/Hide Ports
configuration
EC-gfxProgram 987
Input(s)
Port Type Range Description
Input Numeric ±3.4028×1038 Block input in radians (radian = degrees * / 180). For a
Null Input value, see below.
Output(s)
Port Type Range Description
Output Numeric ±3.4028×1038 The tangent of the input. If the Input to this block is not
Null, then the block’s output is the normal result. If the
Input to this block is Null, then the Output of this block
is always Null.
Block properties See Common block properties.
988 EC-gfxProgram
nLight
The nLight blocks are the ECY Series controller gateway interface to nLight
and/or XPoint Wireless network as well as acting as the IP interface for Sen-
sorView software.
nLight Channel (ECY Series)
Description Provides an interface to the nLight network. nLight Channels are groups of
nLight devices exposed as Read/Write BACnet objects to the nLight
ECLYPSE controller. Channels are used to logically divide up a local zone or
system of nLight devices, thus simplifying operation by allowing synchronized
control through a single BACnet command. They provide a single integration
point for system integrators to display the occupancy state for a group of
occupancy sensors, or to set/display the relay state or dimming level for a
group of light fixtures. Channels also allow you to reduce the number of BAC-
net objects to map and to simplify device replacement operations.
The nLight Channel block is non-commandable. The most recently received
nLight network command supersedes any previously issued command.
Depending on the type (Switch or Occupancy) of the nLight channel that has
been discovered and selected for the nLight Channel block, the number and
the type of block inputs and outputs will vary. The nLight channels can be dis-
covered in completely automated (bulk), semi-manual, or manual mode. They
can be defined on-site, through a connection to the network, or off-site, in
which case a match will be needed afterwards.
Advanced Resources Configuration, Adding nLight channels, nLight Channel Points,
configuration Creating nLight Channel blocks, nLight Channel Calculator (ECY Series),
Generic nLight Channel (ECY Series), Configure Ports, Show/Hide Ports
Input(s)
Port Type Range Description
DimLevel (for Numeric 0 to 100% Sets the channel’s dimming output level (0 to 10
channels of the VDC).
Switch type)
RelayState (for Digital 0 or 1 Switches the lighting on or off for the channel.
channels of the
Switch type)
EC-gfxProgram 989
Output(s)
Port Type Range Description
Number Integer – The current block number. This number corre-
sponds to the nLight channel resource number
(the BACnet object ID).
DimLevel (for Numeric 0 to 100% Outputs the channel’s dimming level (0 to 10
channels of the VDC).
Switch type)
RelayState (for Digital 0 or 1 Outputs the channel’s relay state value: ON (1) or
channels of the OFF (0).
Switch type)
Occupied (for Digital 0 or 1 The actual occupancy state: Occupied (1) or
channels of the Unoccupied (0).
Occupancy type)
Occupied.Reli- Enum See Descrip- This provides an indication of whether the occu-
ability (for chan- tion pancy device is connected to the controller (No
nels of the fault detected (0)) or not (Communication failure
Occupancy type) (12)). See also Reliability property. A configura-
tion error identifies that the device’s configuration
is not valid. Only applicable to channels of the
Occupancy type.
Occupied.Fault Digital 0 or 1 Logical True (1) if the Reliability property's value
(for channels of is different from No Fault Detected, otherwise log-
the Occupancy ical False (0). Only applicable to channels of the
type) Occupancy type.
[Port].OutOfSer- Digital 0 or 1 See Out-of-Service. [Port] stands for RelayState,
vice DimLevel, or Occupancy.
[Port].Update Digital 0 or 1 Outputs a pulse when a value is written to the
BACnet object. [Port] stands for RelayState or
DimLevel, i.e. it is only applicable to channels of
the Switch type.
Block properties See also Common block properties.
Property Type Range Default Description
Number Menu See Not Set The nLight channel resource number. This num-
Description ber corresponds to the block number and to the
BACnet object ID. Once the nLight channel
resources have been added to your project (see
Adding nLight channels), click the drop-down
arrow to select the channel to use for the block.
990 EC-gfxProgram
Adding nLight channels
There are two methods of adding nLight channels to your resource tree,
depending on whether or not you are currently connected to your nLight net-
work. If you are connected to the network, you are in online mode. In this
case, you can directly import one or more nLight channels, i.e. retrieve the
channel data from the network: see Adding nLight channels from the network
(online mode). If you are not connected to the network, you can perform your
programming offline, in advance, and then match it with the real data on the
network: see Adding nLight channels not connected to the network (offline
mode).
NOTE: In addition, you can adopt a semi-automatic approach, by clicking
Select channel... or Import channel... as described in Adding nLight
channels not connected to the network (offline mode). In this case,
you can define part of your settings and your logic offline, and then
complete the definition by connecting to the nLight network.
Adding nLight If you are physically connected to your nLight network, you can perform an
channels from automatic addition of nLight channels, i.e discover the nLight channels in your
the network network as they have been defined in SensorView.
(online mode)
The connected nLight channels are discovered via the Resources Configura-
tion window. To add nLight channel resources in online mode, proceed as fol-
lows.
1. In the Home ribbon, click Open Configuration.
2. In the Resources Configuration window, right-click nLight > Channels
and select Import From Device.
EC-gfxProgram 991
This will open the nLight Channel Selector window. Select the desired
channel(s) and click Add. The added channel(s) will become visible in
the Resource Tree:
Once the needed nLight channels are available in your resource tree, you can
assign them to nLight Channel blocks. See Creating nLight Channel blocks.
Adding nLight You can use EC-gfxProgram to plan an nLight project in advance, before you
channels not connect to the physical nLight network. You can later switch to the online
connected to the mode, by connecting to the nLight network and synchronize your program-
network (offline ming with the real data.
mode)
NOTE: To transition from the offline to the online mode, ensure that all the
entered data are accurate, i.e. they correspond to the real nLight
channels’ data. To verify the consistency of your data, click the
button next to the Status field. For more information as to how to inter-
pret the various possible statuses, refer to Synchronizing a project
with devices on the network.
To add nLight channel resources in offline mode, proceed as follows.
1. In the Home ribbon, click Open Configuration.
2. In the Resources Configuration window, right-click nLight > Channels
and select Add.
992 EC-gfxProgram
3. Set the name and the description of your new channel in the correspond-
ing fields.
4. Unfold the Configuration section and set the Mode field to Manual.
[
5. Fill in the rest of the fields as described below.
Parameter Description
Channel mode Set the Channel mode (Global or Local). Channels are defined as
Local or Global in the SensorView software
Channel type Select the channel type: Switch or Occupancy. Switch channels
are used regulate the dimming output level (0 to 10 VDC) and the
relay state of the concerned nLight devices, while Occupancy
channels are used to manage the occupancy state for a group of
occupancy sensors. Selecting the Switch type automatically
creates the appropriate input and output ports, while the
Occupancy type creates output ports only. The ports can then be
displayed on the block using the Configure Ports command.
EC-gfxProgram 993
Parameter Description
Label The exact label of the nLight channel, as defined in SensorView.
If the Channel mode is Global, you need to fill in the exact label of
the nLight channel so that it can be identified and retrieved
automatically. Once you are connected to the network (i.e. you
have switched to online mode), click the button to the right of
the Status field. If the status is In Sync, the channel has been
successfully found and linked based on the provided label. See
Synchronizing a project with devices on the network for more
details.
NOTE: If you do not know the exact label of your channel, you can
use the Select channel... hyperlink, which will lead you to
the nLight Channel Selector window, where the data that
you have already set will be used as filters for the display.
Select the desired channel(s) and click Add.
If the Channel mode is Local, this field is populated automatically.
Device type This field is visible if the Channel mode is Local. It represents the
type of the interface between the controller and the connected
nLight devices. Choose Local interface if the devices are plugged
directly into the nLight interface of the controller. If they are plugged
into a Bridge, select either First Bridge or Specific: if there is only
one Bridge connected to your controller, it is recommended to
select First Bridge - in this way, the Bridge will be recognized
automatically, and you will not need to specify its identifier; if
several Bridges are connected to your controller, you must select
Specific, and then fill the Bridge identifier in the Device ID field.
The Local interface and First Bridge device types have their own
reserved range of resource numbers (BACnet object IDs). This
feature makes the identification of the channels faster and easier. It
is especially leveraged by the nLight Channel Calculator (ECY
Series) block to quickly identify a channel based on a set of criteria.
Zone (port) Specify the port (zone) number related to your nLight channel (from
1 to 3).
NOTE: Instead of filling in this field, once you are connected to your
network, you can use the Select channel... hyperlink next
to the Device type field, which will lead you to the nLight
Channel Selector window, where the data that you have
already set will be used as filters for the display. After you
have selected a channel, this field will be populated auto-
matically.
994 EC-gfxProgram
Parameter Description
Channel number Specify the channel number (from 1 to 16).
NOTE: Instead of filling in this field, once you are connected to your
network, you can use the Select channel... hyperlink next
to the Device type field. After you have selected a channel,
this field will be populated automatically.
6. As soon as you have connected to your real nLight network, click the
button in the Configuration section. If the status is In sync, the channel
has been successfully found and linked to your device. See Synchroniz-
ing a project with devices on the network for more details.
NOTE: If, at any time during the manual definition of the nLight channel
resource, you connect to your network, it is possible to switch to the
online mode, by setting the Mode field to Auto, and then by clicking
the Import channel... hyperlink next to the Channel mode field. This
will lead you to the nLight Channel Selector window, where the data
that you have already set will be used as filters for the display. Select
the desired channel(s) and click Add.
Creating nLight Channel blocks
To assign an nLight channel resource to a block, from the Toolbox, drag an
nLight Channel block onto the Programming Sheet.
With this block selected, in the block’s Properties, click the drop-down arrow
for Number and select an nLight channel from among the ones you have pre-
viously defined (see Adding nLight channels). The selected channel will be
the one that the block will represent in your logic.
EC-gfxProgram 995
nLight Channel Selector
The nLight Channel Selector window lists all the available nLight channels
depending on the invocation context of the sector form. The optional filter bar
can be used to find a channel based on a key word such as the channel type
or the channel label. The channels can also be sorted by column title.
The nLight Selector window presents information on the channel mode, the
channel type, the gateway type, the port (or zone), the channel number, and
the channel label.
Parameter Description
Channel mode Indicates the channel mode, as defined in SensorView: Global or
Local. Channels are Global when they are associated with more
than one Bridges and Local when they are associated with a single
Bridge.
996 EC-gfxProgram
Parameter Description
Channel type The channel type, as defined in SensorView: Switch or
Occupancy. Switch channels are used regulate the dimming output
level (0 to 10 VDC) and the relay state of the related nLight devices,
while Occupancy channels allow you to manage the occupancy
state for a group of occupancy sensors.
Device type The type of the interface between the controller and the connected
nLight devices. Local interface means that the devices are
plugged directly into the nLight interface of the controller. If the
channels are connected to a Bridge, the value is either First Bridge
(if a single Bridge is connected to the controller) or Specific (if
several Bridges are connected to the controller).
Device ID The Bridge identifier, when applicable.
Zone (port) The port (zone) number related to the nLight channel (from 1 to 3,
for a local interface, or 1 to 8 for a bridge).
Channel number The channel number (from 1 to 16).
Label The label of the nLight channel, as defined in SensorView.
Select the desired channel(s) and click Add.
The selected channels are added to the project. The progress bar allows you
to track the progress of the addition.
nLight Channel Points
The BACnet points are created under each nLight channel resource automat-
ically, depending on the configured channel type (Switch or Occupancy). All
the fields, except for Description, are set automatically.
EC-gfxProgram 997
Parameter Description
Object name Automatically generated object name consisting of the channel
name and the point type.
Description Type a description for the point object.
Object type The point object type.
Object instance The point object instance.
Mode The configuration mode of the channel (Manual or Auto).
Status The status of the channel: Unconfirmed, Not in Sync, Partially in
Sync, In Sync. For more information regarding these statuses, see
Synchronizing a project with devices on the network.
Feature The nLight feature corresponding to the point.
Synchronizing a project with devices on the network
Click nLight > Channels in the resource tree to have an overview of the
nLight channels in your project, as well as their status on the network, in the
Resource Summary section. These statuses can help you tell at a glance
whether your channels are properly synchronized with the network and find
the channels, if any, that require some troubleshooting.
998 EC-gfxProgram
Status Meaning
Unconfirmed The initial status. Remains unchanged until the first synchronization
attempt or until a click on the button.
Not in sync The nLight channel is not found on the network. The configuration
does not match anything discovered by the controller.
Partially in sync A channel with the specified configuration has been found on the
network, but its features do not completely match the configured
points.
To view which point(s) are not in sync, drill down in the channel’s
points in the resource tree until you find the point(s) with the
dedicated indicator.
In sync A channel with the specified configuration and features that entirely
match the configured points has been found on the network.
nLight Channel Calculator (ECY Series)
EC-gfxProgram 999
Description This block allows the system to compute the resource number of a reserved
nLight channel. This number represents the unique BACnet object ID that the
system will select from a reserved range [1-539] and assign it to an nLight
channel resource. Based on a specific configuration defined through its input
ports, the block is capable of computing the resource number of the corre-
sponding nLight channel resource.
NOTE: The nLight Channel Calculator block is designed for nLight chan-
nels whose nLight devices are plugged either directly into the nLight
interface of the controller or into the “first” Bridge. In other terms, the
calculation is only possible for reserved nLight channels, whose
Device type is Local interface of First bridge. It cannot be used to
compute the resource number of Global channels or Local channels
with the Specific Bridge interface type. For more details regarding
channel and device types, see the configuration of the nLight Channel
(ECY Series) block.
The nLight Channel Calculator block is typically used in combination with
the Generic nLight Channel block, which requires the resource number as
an input. Its main purpose is to provide the Generic nLight Channel block a
correct resource number in a variable context, on the basis of programmable
conditions (for example, the location of the channel’s devices may determine
their association with a given channel). In this way, a combination of an
nLight Channel Calculator and a Generic nLight Channel blocks can be
used in code snippets and function correctly in different setups, for different
controllers, without the user having to respecify the resource numbers, thus
reducing the programming effort.
Advanced Configure Ports, Show/Hide Ports, Generic nLight Channel (ECY Series),
configuration nLight Channel (ECY Series)
Input(s)
Port Type Range Description
ChannelType Integer 1 or 2 The channel type. Possible values:
1 = Switch
2 = Occupancy
The use of the nLight Channel Type standard enu-
meration allows you to display the corresponding
channel type label. For more details, refer to Creat-
ing and using enumerations (8-Bit).
1000 EC-gfxProgram
Port Type Range Description
DeviceType Integer 1 or 2 The device type, i.e. the type of the interface
between the controller and the connected nLight
devices. Possible values:
1 = Local interface
2 = First bridge
The use of the nLight Channel Device Type stan-
dard enumeration allows you to display the corre-
sponding device type label. For more details, refer to
Creating and using enumerations (8-Bit).
Zone Integer 1 to 3 / 1 The zone or port to which the channel is associated.
to 8 The value ranges from 1 to 3, if the Device type is
Local interface, and from 1 to 8, if the Device type
is First bridge.
ChannelNumber Integer 1 to 16 The channel number.
NOTE: For more details about these parameters, refer to the Advanced con-
figuration paragraph of the nLight Channel (ECY Series) block sec-
tion.
Output(s)
Port Type Range Description
Number Integer 1 to 539 The number of the resource as computed accord-
ing to the input parameters. If the input parame-
ters are invalid, this port will return the null value.
Block properties See also Common block properties.
nLight Channel Based on the values assigned to its input parameters (in this example, the
Resource values are provided by Internal Constant blocks referring to the nLight
Number Channel Type and nLight Channel Device Type enumerations), the nLight
Calculator Channel Calculator block computes the nLight channel resource number
Example (BACnet object ID) and sends it, through the Number output, to the Generic
nLight Channel block, which uses it to automatically identify and represent
the concerned nLight channel. As a result, the Generic nLight Channel out-
puts the actual values of the dimming level and relay state of the selected
Switch channel. The Occupied parameter is null since the channel is not of
the Occupancy type.
EC-gfxProgram 1001
nLight Device (ECY Series)
Description Provides an interface to the nLight network. nLight devices can be connected
to certain ECY Series controller models. See your controller’s datasheet for
more information about the number and type of nLight devices that are sup-
ported.
The nLight Device block is non-commandable. The most recently received
nLight network command supersedes any previously issued command.
Depending on the nLight device type discovered and selected, the number
and type of block inputs and outputs will vary accordingly. See the nLight
device documentation for a complete list of control inputs and outputs and
their definition.
When available, nLight devices internally manage alarms related to its opera-
tion. Such alarms are not BACnet alarm objects that are configured in EC-gfx-
1002 EC-gfxProgram
Program. However, the alarms are reported through the nLight Device block’s
alarm output ports as status information.
Advanced Resources Configuration, Adding nLight devices from the network, Alarms
configuration (ECB & ECY Series), Emergency override and emergency auto (ECB & ECY
Series), Override and auto, Set Value, Find All References (ECL, ECB & ECY
Series), Copy From, Configure Ports, Show/Hide Ports
Input(s)
Port Type Range Description
[ANY] Numeric – See the nLight device documentation for a complete
list of control inputs and their definition.
Integer
Digital
Dimming Output Numeric 0 to 100% Sets the device’s dimming 0 to 10 VDC output level.
Level (for devices
that support
dimming)
Relay State P1 Digital 0 or 1 Switches the lighting load ON or OFF.
Output(s)
Port Type Range Description
[ANY] Numeric – See the nLight device documentation for a
complete list of control outputs and their
Integer
definition.
Digital
Number Integer – The current block number.
Online Digital 0 or 1 This is the nLight device’s internal status as to its
network connectivity to other nLight devices.
Dimming Output Numeric 0 to 100% Actual light output value. This takes into account
Level P1 any nLight network commands from, for example,
an nLight network push button switch.
Relay State P1 Digital 0 or 1 Actual relay state. This takes into account any
nLight network commands from, for example, an
nLight network push button switch.
Dimming Input Numeric 0 to 100% This is the current value read at the device’s
Level (for devices dimming analog input.
that support a
dimming input)
EC-gfxProgram 1003
Port Type Range Description
[ANY]. Reliability Enum See This provides an indication of whether the device
Description is connected to the controller (No fault detected
(0)) or not (Communication failure (12)). See
also Reliability property. Configuration error
identifies that the device’s configuration is not
valid.
[ANY].Out Digital 0 or 1 See Out-of-Service.
OfService
[ANY].Fault Digital 0 or 1 Logical True (1) if the Reliability Property does not
have a value of No Fault Detected, otherwise
logical False (0).
[ANY]. InAlarm Digital 0 or 1 When Enable Alarms is set for this block and the
present value is outside of the High limit and
Low limit settings and taking into consideration
the Dead band and Time delay settings, this
output is On (1). See Alarms (ECB & ECY Series)
to configure the alarm settings.
NOTE: Setting or clearing High or Low in the
Limit enable options shown above has
no effect on the activation of this output.
[ANY]. ChangeOf Numeric 3.4028×1038 Cumulates the number of this value’s state
StateCount changes.
[ANY]. Elapsed Numeric 3.4028×1038 Cumulates the time this value is set to true (1).
ActiveTime
[ANY].Update Digital 0 or 1 Outputs a pulse when a value is written to the
BACnet object.
Block properties See also Common block properties.
Property Type Range Default Description
Number Menu See Not Set The extension nLight module instance. Once the
Description nLight network has been discovered, click the
drop-down arrow to select the nLight module to
use for the selected block. See Adding nLight
devices from the network.
Adding nLight devices from the network
Connected nLight devices are discovered in the Resources Configuration win-
dow. To add nLight devices and assign them to nLight Device blocks, proceed
as follows.
1. In the Home ribbon, click Open Configuration.
1004 EC-gfxProgram
2. In the Resources Configuration window, right-click nLight Devices and
select Import From Device.
Figure 552: Select Import From Device
The nLight Selector Window will appear with all available nLight devices
displayed. The optional search bar can be used to find a device, or they
can be sorted by column title.
Select the desired device or devices, and click Add.
Figure 553: Use the nLight Device Selector to select desired nLight Devices
EC-gfxProgram 1005
The selected devices are added to the project. You can track the progress
of the addition using the progress bar.
Figure 554: nLight Device Selector status bar
All nLight devices will appear in the Resource Tree.
Figure 555: Discovered nLight Devices in the Resource Configuration
3. From the Toolbox, drag an nLight Device block on the Programming
Sheet.
Figure 556: Drag an nLight Device on the Programming Sheet
1006 EC-gfxProgram
4. Select the nLight Device block on the Programming Sheet and in the
block’s Properties, click the drop-down arrow for Number. This block
instance will use the nLight device selected in this window.
Figure 557: Setting the nLight device to use with the selected block
The input and output ports on the nLight Device block appear according
to the control inputs and outputs supported by the selected nLight device
type.
Adding nLight devices not connected to the network
You can use EC-gfxProgram to plan an nLight project in advance, before you
connect to the physical nLight network. In that context, you can add devices
and either apply a pre-existing template to them, or manually create points to
represent the features you need to create your logic.
To add a new device, proceed as follows:
1. In the Home ribbon, click Open Configuration.
2. In the Resources Configuration window, right-click nLight > Devices and
select Add.
By default, new devices have the Manual mode.
• To manually add points to a device (when first configuring a model not
available in the pre-configured templates, for instance), see Manually
adding points to devices.
• To apply a pre-existing template to the device, see Applying a saved
configuration to a device.
EC-gfxProgram 1007
• To import the points from a device connected to the network, set the
mode to Automatic and select Import Device to access the nLight
Device Selector. See Adding nLight devices from the network.
Manually adding 1. Specify the Model of the nLight Device. This is used to classify the
points to devices devices in your project.
2. Right-click the new device and select Add Point.
3. Choose a point in the drop-down list. Click OK.
Repeat this step as needed to add the relevant points for your project.
4. From the Toolbox, drag an nLight Device block on the Programming
Sheet.
5. Select the nLight Device block on the Programming Sheet and in the
block’s Properties, click the drop-down arrow for Number. This block
instance will use the nLight device selected in this window.
1008 EC-gfxProgram
The input and output ports on the nLight Device block appear according
to the control inputs and outputs added for the selected nLight device
type.
Saving an nLight Once you have fully configured your nLight device, you can save the configu-
device ration as a template that you can then apply to other nLight devices in your
configuration as project. Proceed as follows:
a template
1. Right-click the device to use as a template and select Save as device
template.
2. Name your template and select the location where you want to save it.
Click OK.
NOTE: To modify an existing template, specify its exact identifier in the Save
as nLight device template window, and click Yes to replace the exist-
ing template.
3. From the Toolbox, drag an nLight Device block on the Programming
Sheet.
EC-gfxProgram 1009
4. Select the nLight Device block on the Programming Sheet and in the
block’s Properties, click the drop-down arrow for Number. This block
instance will use the nLight device selected in this window.
The input and output ports on the nLight Device block appear according
to the control inputs and outputs added for the selected nLight device
type.
Applying a saved Templates are provided for most nLight device models. You can also save
configuration to your own configurations as device templates (see above). To apply a template
a device to a device, proceed as follows:
1. Right-click an nLight device and select Load device template.
2. Select the nLight template you want to apply to the device. Click OK.
1010 EC-gfxProgram
NOTE: No link is kept between devices and the templates applied to them.
That is, if a template is modified after it was applied to one or more
devices, these modifications are NOT applied to the devices in ques-
tion.
3. From the Toolbox, drag an nLight Device block on the Programming
Sheet.
4. Select the nLight Device block on the Programming Sheet and in the
block’s Properties, click the drop-down arrow for Number. This block
instance will use the nLight device selected in this window.
The input and output ports on the nLight Device block appear according
to the control inputs and outputs added for the selected nLight device
type.
EC-gfxProgram 1011
Synchronizing a You can select nLight > Devices in the resource tree to have an overview of
project with the nLight devices in your project, as well as their status on the network.
devices on the These statuses can help you view at a glance whether your devices are prop-
network erly synchronized with the network and find the devices, if any, that require
some troubleshooting.
Status Meaning
Unconfirmed The initial status. Remains until the first synchronization
attempt.
Not in sync The nLight device is not found on the network. There
might be a mistake in the configuration.
1012 EC-gfxProgram
Status Meaning
Partially in sync A device with the specified ID has been found on the
network, but its features do not completely match the
configured points.
To view which point(s) are not in sync, drill down in the
device’s points in the resource tree until you find the
point(s) with the indicator.
In sync A device with the specified ID, and with features that
match the configured points, has been found on the
network.
Note that if you configure generic devices with very few
points, they may be In Sync with several different types
of nLight devices that count those points among their
many features. (ex: a device that only has the point
Online will be In Sync with every type of nLight devices
since they all have an Online feature).
When you create nLight devices, whether you add their points manually or
apply a template to them, you must then synchronize your configurations with
the devices on the network. To do so, proceed as follows:
1. Specify an identifier in the Identifier field, or click Select identifier to
open the nLight Device Selector window and select a device among those
connected on the network.
The device’s status will remain Unconfirmed or Not in sync until you
refresh its status after entering a valid identifier or select a device on the
network.
EC-gfxProgram 1013
2. After you have identified your devices, you must refresh their status to
synchronize them with the network.
• To refresh one device’s status, click in the configuration for that
device.
• To refresh the status for all the devices in your project at the same
time, right-click nLight > Devices in the resource tree, and select
Refresh Statuses.
When you synchronize your configuration with a device on the network, the
label, if any, is provided by SensorView. It cannot be modified in EC-gfxPro-
gram.
nLight Profile (ECY Series)
Description Provides an interface to the nLight network. nLight Profiles are used to control
groups of nLight Devices. For instance, they can turn on a group of lights
based on the output from an occupancy sensor or a schedule.
The nLight Profile block is non-commandable. The most recently received
nLight network command supersedes any previously issued command.
Advanced Resources Configuration, Manually adding nLight Profiles, Set Value, Find All
configuration References (ECL, ECB & ECY Series), Copy From, Configure Ports, Show/
Hide Ports
1014 EC-gfxProgram
Input(s)
Port Type Range Description
ProfileState Boolean True Enables or disables the
profile.
False
Output(s)
Port Type Range Description
ProfileState Boolean True Indicates whether the profile
is enabled or disabled.
False
Adding nLight Profiles from the network
Profiles can be imported from nLight devices connected to the network. To
add nLight profiles and assign them to nLight Profile blocks, proceed as fol-
lows.
1. In the Home ribbon, click Open Configuration.
2. In the Resources Configuration window, right-click nLight > Profiles and
select Import From Device.
EC-gfxProgram 1015
The nLight Profile Selector window will appear with all available nLight
profiles displayed. The optional search bar can be used to find a profile,
or they can be sorted by column title.
Select the desired profile or profiles, and click Add.
All nLight Profiles will appear in the Resource Tree.
3. From the Toolbox, drag an nLight Profile block on the Programming
Sheet.
4. Select the nLight Profile block on the Programming Sheet and in the
block’s Properties, click the drop-down arrow for Number. This block
instance will use the nLight profile selected in this window.
1016 EC-gfxProgram
Manually adding nLight Profiles
You can use EC-gfxProgram to plan an nLight project in advance, before you
connect to the physical nLight network. In that context, you can add profiles
and synchronize them with the devices connected to the network later on.
To add a new profile, proceed as follows:
1. In the Home ribbon, click Open Configuration.
2. In the Resources Configuration window, right-click nLight > Profiles and
select Add.
By default, new profiles have the Manual mode.
• You can manually enter the Profile’s exact name in SensorView.
When you connect to the nLight network, you can click to syn-
chronize your profile with the network.
• You can click Select profile to open the nLight Profile Selector win-
dow. You can then select the profile to synchronize with your nLight
profile resource. Note that you must already be connected to the
nLight network to perform this option.
EC-gfxProgram 1017
Psychrometric
Psychrometric blocks are used for psychrometric calculations.
The following blocks are available in this category:
• Actual Vapor Pressure (ECL, ECB & ECY Series)
• Air Density (ECL, ECB & ECY Series)
• Dew Point (ECL, ECB & ECY Series)
• Enthalpy (ECL, ECB & ECY Series)
• Heat Index (ECL, ECB & ECY Series)
• Humidity Ratio (ECL, ECB & ECY Series)
• Relative Humidity (ECL, ECB & ECY Series)
• Saturation Vapor Pressure (ECL, ECB & ECY Series)
• Wet Bulb (ECL, ECB & ECY Series)
Metric (SI) and The following units are used for Psychrometric blocks.
US (Imperial)
Units Property Metric (SI) US (Imperial)
Absolute Grams of moisture/Kg of Grains of moisture/Lb of
Humidity dry air (g/Kg) dry air (Grains/Lb)
Air Density Kg of dry air/m3 (Kg/ m3) lb of dry air/ft3 (lb/ ft3)
Atmospheric kPa Psi
Pressure
Dew point °C °F
Enthalpy KJ/Kg Btu/Lb
HeatIndex °C °F
Humidity Ratio (g/Kg) (Grains/lb)
Pressure kPa PSI
Relative % RH % RH
Humidity
Specific Volume m3/Kg of dry air (m3/Kg) ft3/lb of dry air (ft3/lb)
Temperature °C °F
Vapor Pressure mm of mercury inch of mercury
Wetbulb °C °F
1018 EC-gfxProgram
Actual Vapor Pressure (ECL, ECB & ECY Series)
Description Used to calculate the air density when supplied with the relative humidity and
dry air bulb temperature.
The actual vapor pressure is the partial pressure exerted by the water vapor
component present in air.
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Effective
Port Type Description
Rangea
Humidity Numeric 0 to 100% Air relative humidity (in % RH).
Temp Numeric 0 to 60°C Dry air bulb temperature (in °C or °F).
32 to 140°F
NOTE: The temperature unit follows the measurement
system of the project found in Project properties.
Output(s)
Effective
Port Type Description
Rangea
Output Numeric 0 to 45mm of Actual vapor pressure reading (in millimeters of mercury
mercury or inches of mercury).
0 to 1.9inches
NOTE: The pressure unit follows the measurement sys-
of mercury
tem of the project found in Project properties.
If no Input to this block is Null, then the block’s output is
the normal result. If one or more Inputs to this block are
Null, then the Output of this block is always Null.
a. The Effective Range is the range in which block operates appropriately. Use
the Limit block if necessary to limit the range as necessary.
Block properties See Common block properties.
EC-gfxProgram 1019
Air Density (ECL, ECB & ECY Series)
Description
Used to calculate the air density when supplied with the dry air bulb tempera-
ture and atmospheric pressure.
The air density is the mass per unit volume of air.
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Effective Rangea Description
Humidity Numeric 0 to 100% Air relative humidity (in %).
Temp Numeric 0 to 60°C Dry air bulb temperature (in °C or °F).
32 to 140°F
NOTE: The temperature unit follows the measure-
ment system of the project found in Project
properties.
Press Numeric 87 to 108.63kPa Atmospheric pressure (in kPa or psi).
12.62 to 15.76psi
NOTE: The pressure unit follows the measurement
system of the project found in Project prop-
erties.
a. The Effective Range is the range in which block operates appropriately. Use
the Limit block if necessary to limit the range as necessary.
1020 EC-gfxProgram
Output(s)
Port Type Effective Rangea Description
Output Numeric 0.83 to 1.38Kg/m3 Air density reading (kg of dry air/m3 (Kg/m3) or lb of
0.0519 to 0.0862lb/ dry air/ft3 (lb/ft3)).
ft3
NOTE: The air density unit follows the measurement
system of the project found in Project prop-
erties.
If no Input to this block is Null, then the block’s
output is the normal result. If one or more Inputs to
this block are Null, then the Output of this block is
always Null.
a. The Effective Range is the range in which block operates appropriately. Use
the Limit block if necessary to limit the range as necessary.
Block properties See Common block properties.
EC-gfxProgram 1021
Dew Point (ECL, ECB & ECY Series)
Description Used to calculate the air dew point (at atmospheric pressure) when supplied
with the dry air bulb temperature and humidity.
The dew point is the temperature at which air must be cooled, at constant
atmospheric pressure, for water vapor to condense into water.
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Effective Rangea Description
32-Bit 8-Bit
Humidity Numeric 1 to 100% 6.4 to 100% Air relative humidity (in %).
Temp Numeric 0 to 60°C 0 to 45°C Dry air bulb temperature (in °C or °F).
32 to 140°F 32 to 113°F
NOTE: The temperature unit follows
the measurement system of
the project found in Project
properties.
For ECL, ECB & ECY Series
controllers: If no Input to this block is
Null, then the block’s output is the
normal result. If one or more Inputs to
this block are Null, then the Output of
this block is always Null.
a. The Effective Range is the range in which block operates appropriately. Use
the Limit block if necessary to limit the range as necessary.
1022 EC-gfxProgram
Output(s)
Port Type Effective Rangea Description
32-Bit 8-Bit
Output Numeric -45.28 to 60°C 0 to 45°C Air dew point reading (in °C or °F).
-49.51 to 140.1°F 32 to 113°F
NOTE: The dew point unit follows the
measurement system of the
project found in Project Prop-
erties.
For ECL, ECB & ECY Series
controllers: If the Humidity
input is 0%, the Output is Null.
For ECP Series controllers:
This block has an accuracy of
±0.75°C or ±1.35°F.
a. The Effective Range is the range in which block operates appropriately. Use
the Limit block if necessary to limit the range as necessary.
Block properties See Common block properties.
Example The Dew Point block is used to calculate the dew point temperature of the air.
The example below shows how the Room Dew Point temperature (Dew Point
block) is calculated and sent to a Constant Numeric (ECP Series) block based
on the Room Relative Humidity and Room Temperature (Hardware Input
blocks).
Figure 558: Dew POint block example
EC-gfxProgram 1023
Enthalpy (ECL, ECB & ECY Series)
Description Used to calculate air enthalpy when supplied with the dry air bulb tempera-
ture, relative humidity, and atmospheric pressure.
The amount of heat energy contained in the air, expressed as a ratio of
energy to mass.
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Effective Rangea Description
32-Bit 8-Bit
Humidity Numeric 0 to 100% Air relative humidity (in %).
Temp Numeric 0 to 60°C 5 to 30°C Dry air bulb temperature (in
°C or °F).
32 to 140°F 41 to 86°F
NOTE: The temperature unit
follows the measure-
ment system of the
project found in Proj-
ect properties.
Press Numeric 87 to 108.63 kPa 87 to 108.63 kPa Atmospheric pressure (in kPa
or psi).
12.62 to 15.76 psi 12.62 to 15.75 psi
NOTE: The pressure unit fol-
lows the measure-
ment system of the
project found in Proj-
ect properties.
a. The Effective Range is the range in which block operates appropriately. Use
the Limit block if necessary to limit the range as necessary.
1024 EC-gfxProgram
Output(s)
Port Type Effective Rangea Description
32-Bit 8-Bit
Output Numeric 0 to 543.5 kJ/kg 5 to 108.22 kJ/kg Air enthalpy reading (in kJ/kg or
BTU/lb).
7.64 to 241.32 9.81 to 54.19
BTU/lb BTU/lb
NOTE: The enthalpy unit fol-
lows the measurement
system of the project
found in Project proper-
ties.
For ECP Series control-
lers: This block has an
accuracy of ±3%.
For ECL, ECB & ECY Series
controllers: If no Input to this
block is Null, then the block’s
output is the normal result. If
one or more Inputs to this block
are Null, then the Output of this
block is always Null.
a. The Effective Range is the range in which block operates appropriately. Use
the Limit block if necessary to limit the range as necessary.
Block properties See Common block properties.
Example The Enthalpy block is used to calculate the air enthalpy. The example below
shows how the Outdoor Air Enthalpy (Enthalpy block) is calculated and sent
to a Variable Numeric (ECP Series) block based on the Outdoor Air Relative
Humidity, Outdoor Air Temperature (Hardware Input blocks) and atmospheric
pressure (Internal constant block).
Figure 559: Enthalpy block example
EC-gfxProgram 1025
Heat Index (ECL, ECB & ECY Series)
Description Used to calculate heat index when supplied with the relative humidity and dry
air bulb temperature.
The heat index is a measure of the human-perceived equivalent temperature
for a given temperature - humidity combination.
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Effective Rangea Description
Humidity Numeric 40 to 100% Air relative humidity (in %).
Temp Numeric 25 to 60°C Dry air bulb temperature (in °C or °F).
77 to 140°F
NOTE: The temperature unit follows the measure-
ment system of the project found in Project
properties.
Output(s)
Port Type Effective Rangea Description
Output Numeric 25.68 to 339.05°C Air heat index reading (in °C or °F).
78.2 to 642.3°F
NOTE: The heat index unit follows the measurement
system of the project found in Project prop-
erties.
If no Input to this block is Null, then the block’s out-
put is the normal result. If one or more Inputs to this
block are Null, then the Output of this block is
always Null.
a. The Effective Range is the range in which block operates appropriately. Use
the Limit block if necessary to limit the range as necessary.
Block properties See Common block properties.
1026 EC-gfxProgram
Humidity Ratio (ECL, ECB & ECY Series)
Description Used to calculate humidity ratio when supplied with the relative humidity, dry
air bulb temperature, and atmospheric pressure.
The humidity ratio is the ratio of water vapor mass, per kilogram of dry air, at a
given atmospheric pressure.
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Effective Rangea Description
Humidity Numeric 0 to 100% Air relative humidity (in %).
Temp Numeric 0 to 60°C Dry air bulb temperature (in °C or °F).
32 to 140°F
NOTE: The temperature unit follows the measure-
ment system of the project found in Project
properties.
Press Numeric 87 to 108.63kPa Atmospheric pressure (in kPa or psi).
12.62 to 15.76psi
NOTE: The pressure unit follows the measure-
ment system of the project found in Project
properties.
a. The Effective Range is the range in which block operates appropriately. Use
the Limit block if necessary to limit the range as necessary.
EC-gfxProgram 1027
Output(s)
Port Type Effective Rangea Description
Output Numeric 0 to 185g/Kg Air humidity ratio reading (in g/Kg or Grains/lb).
0 to
NOTE: The humidity ratio unit follows the mea-
1256.07Grains/lb
surement system of the project found in
Project properties.
If no Input to this block is Null, then the block’s
output is the normal result. If one or more Inputs
to this block are Null, then the Output of this block
is always Null.
a. The Effective Range is the range in which block operates appropriately. Use
the Limit block if necessary to limit the range as necessary.
Block properties See Common block properties.
1028 EC-gfxProgram
Relative Humidity (ECL, ECB & ECY Series)
Description Used to calculate relative humidity when supplied with the dry air bulb tem-
perature, atmospheric pressure, and the air’s enthalpy.
The relative humidity is the ratio of the actual amount of water vapor in the air
divided by the amount of water vapor the air can hold when fully saturated
with moisture for a given air temperature, expressed as a percentage.
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Effective Rangea Description
Temp Numeric 0 to 60°C Dry air bulb temperature (in °C or °F).
32 to 140°F
NOTE: The temperature unit follows the measure-
ment system of the project found in Project
properties.
Press Numeric 87 to 108.63kPa Atmospheric pressure (in kPa or psi).
12.62 to 15.76psi
NOTE: The pressure unit follows the measure-
ment system of the project found in Project
properties.
Enthalpy Numeric 0 to 460kJ/kg Air enthalpy (in kJ/kg or BTU/lb).
0 to 205.04BTU/lb
NOTE: The enthalpy unit follows the measure-
ment system of the project found in Project
properties.
a. The Effective Range is the range in which block operates appropriately. Use
the Limit block if necessary to limit the range as necessary.
EC-gfxProgram 1029
Output(s)
Port Type Effective Rangea Description
Output Numeric 0 to 100% Air relative humidity reading (in % RH).
NOTE: For ECP Series controllers: This block has
an accuracy of ±3%.
If no Input to this block is Null, then the block’s
output is the normal result. If one or more Inputs
to this block are Null, then the Output of this block
is always Null.
a. The Effective Range is the range in which block operates appropriately. Use
the Limit block if necessary to limit the range as necessary.
Block properties See Common block properties.
1030 EC-gfxProgram
Saturation Vapor Pressure (ECL, ECB & ECY
Series)
Description Used to calculate saturation air pressure when supplied with the dry air bulb
temperature, atmospheric pressure, and the air enthalpy.
The saturation air pressure is the equilibrium vapor pressure for a given air
temperature above the flat surface of a body of water.
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Effective Rangea Description
Temp Numeric 0 to 60°C Dry air bulb temperature (in °C or °F).
32 to 140°F
NOTE: The temperature unit follows the measure-
ment system of the project found in Project
properties.
Output(s)
Port Type Effective Rangea Description
Output Numeric 4.58 to 148.78mm Saturation vapor pressure reading (mm of mercury
of mercury or inch of mercury).
0.18 to 5.86inch of If no Input to this block is Null, then the block’s
mercury output is the normal result. If one or more Inputs to
this block are Null, then the Output of this block is
always Null.
a. The Effective Range is the range in which block operates appropriately. Use
the Limit block if necessary to limit the range as necessary.
Block properties See Common block properties.
EC-gfxProgram 1031
Wet Bulb (ECL, ECB & ECY Series)
Description Used to calculate the wet bulb temperature (at atmospheric pressure) when
supplied with the dry air bulb temperature and humidity.
The wet bulb is the minimum temperature that can be achieved by purely
evaporative cooling of a ventilated water-wetted surface.
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Effective Rangea Description
32-Bit 8-Bit
Humidity Numeric 0 to 100% Air relative humidity (in % RH).
Temp Numeric 0 to 60°C 0 to 54.45°C Dry air bulb temperature (in °C or
°F).
32 to 140°F 32 to 130°F
NOTE: The temperature unit follows
the measurement system of
the project found in Project
properties.
a. The Effective Range is the range in which block operates appropriately. Use
the Limit block if necessary to limit the range as necessary.
1032 EC-gfxProgram
Output(s)
Port Type Effective Rangea Description
32-Bit 8-Bit
Output Numeric -5.35 to -5.32 to Wet bulb temperature reading (in °C
60°C22.37 to 54.44°C22.41 or °F).
140°F to 130°F
NOTE: The wet bulb temperature
unit follows the measure-
ment system of the project
found in Project properties.
For ECP Series controllers:
This block has an accuracy
of ±0.33°C or ±0.6°F.
If no Input to this block is Null, then
the block’s output is the normal
result. If one or more Inputs to this
block are Null, then the Output of
this block is always Null.
a. The Effective Range is the range in which block operates appropriately. Use
the Limit block if necessary to limit the range as necessary.
Block properties See Common block properties.
Example The Wet Bulb block is used to calculate the wet bulb temperature of the air.
The example below shows how the Outdoor Air Wet Bulb temperature (Wet
Bulb block) is calculated and sent to a Variable Numeric (ECP Series) block
based on the Outdoor Air Relative Humidity and Outdoor Air Temperature
(Hardware Input blocks).
Figure 560: Wet Bulb block example
EC-gfxProgram 1033
SNVT Conversions (ECP Series specific blocks)
For LONWORKS networks with ECP Series controllers, the SNVT Conversion
blocks are used to process structured 2-byte long SNVT types.
The following blocks are available in this category:
• SNVT_scene Demux (ECP Series)
• SNVT_scene Mux (ECP Series)
• SNVT_state Demux (ECP Series)
• SNVT_state Mux (ECP Series)
• SNVT_switch Demux (ECP Series)
• SNVT_switch Mux (ECP Series)
1034 EC-gfxProgram
SNVT_scene Demux (ECP Series)
Description Used to separate a SNVT_scene type into its two components: Function and
Scene_number.
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
SNVT_scene Numeric -83886.08 to Block input.
+83886.07
Output(s)
Port Type Range Description
Function Numeric -1 to 23 The Function component of SNVT_scene.
Scene_ number Enum 1 to 255 The Scene_number component of
SNVT_scene.
Block properties See Common block properties.
Example The SNVT_scene Demux block is used to separate a network variable of the
SNVT_scene type. The example below shows how nviLightControl (Network
Variable Input block) is demuxed (SNVT_scene Demux block) so that its
Scene_number can be used to control (Internal constant, Equal, And, Condi-
tional Custom Block, and Variable Numeric (ECP Series) blocks) a Light
(Hardware Output block).
EC-gfxProgram 1035
Figure 561: SNVT_scene Demux block example
The SNVT_scene Demux block receives a value from the Network Variable
Input block and separates it into its Function and Scene_number outputs. If
the Network Variable Input block is updated, the Function is SC_RECALL
and the Scene_number is 5, then the Scene 5 Lighting Conditional Custom
Block is Enabled and the Light (Hardware Output block) turns On. If the Net-
work Variable Input block is updated, the Function is SC_RECALL and the
Scene_number is 6, then the Scene 6 Lighting Conditional Custom Block is
Enabled and the Light (Hardware Output block) turns Off.
1036 EC-gfxProgram
SNVT_scene Mux (ECP Series)
Description Used to merge a SNVT_scene type from its two components: Function and
Scene_number.
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
Function Numeric -1 to 23 The Function component of SNVT_scene.
Scene_ number Integer 1 to 255 The Scene_number component of SNVT_scene.
Output(s)
Port Type Range Description
SNVT_scene Numeric -83886.08 to Block output.
+83886.07
Block properties See Common block properties.
Example The SNVT_scene Mux block is used to merge a network variable of the
SNVT_scene type. The example below shows how nvoLightControl (Network
Variable Output block) is muxed (SNVT_scene Mux block) based on a Bool-
ean (Multiplexer and Internal constant blocks) Schedule (Schedule block).
Figure 562: SNVT_scene Mux block example
The SNVT_scene Mux block receives a SC_RECALL value into its Function
input from the Internal Constant block and a value of 5 into its Scene_num-
ber input from the Multiplexer block, which makes Boolean values out of the
input it receives from the Schedule block. This Function and Scene_number
are then joined to create a network variable of the SNVT_scene type and is
sent to the Network Variable Output block.
EC-gfxProgram 1037
SNVT_state Demux (ECP Series)
Description Used to separate a SNVT_state type into its 16 bits: Bit0 - Bit15.
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
SNVT_state Numeric 0 to 655.35 Block input.
Output(s)
Port Type Range Description
Bitx Digital 0 or 1 The Bit component of SNVT_state.
(x=0 to 15)
Block properties See Common block properties.
1038 EC-gfxProgram
Example The SNVT_state Demux block is used to separate a network variable of the
SNVT_state type. The example below shows how nviFanSpeedCmd (Net-
work Variable Input block) is demuxed (SNVT_state Demux block) so that
its bits can be used to control 2 Evaporative Condenser Fans of 4 speeds
each (Hardware Output blocks).
Figure 563: SNVT_state Demux block example
The SNVT_state Demux block receives a value from the Network Variable
Input block and separates it into its appropriate bits. These bits are then sent
to Hardware Output blocks to control the speeds of evaporative condenser
fans.
EC-gfxProgram 1039
SNVT_state Mux (ECP Series)
Description Used to merge a SNVT_state type from its 16 bits: Bit0 to Bit15.
Advanced Configure Ports
configuration
Input(s)
Port Type Range Description
Bitx Digital 0 or 1 The Bit component of SNVT_state.
(x=0 to 15)
Output(s)
Port Type Range Description
SNVT_state Numeric 0 to 655.35 Block output.
Block properties See Common block properties.
1040 EC-gfxProgram
Example The SNVT_state Mux block is used to merge a network variable of the
SNVT_state type. The example below shows how nvoAlarmStatus (Network
Variable Output block) is muxed (SNVT_state Mux block) based on alarms
(Numeric Fault, Digital Fault, and Internal constant blocks) received from
Hardware Input and Hardware Output blocks.
Figure 564: SNVT_state Mux block example
The SNVT_state Mux block receives digital values from Digital Fault,
Numeric Fault, and Hardware Input blocks into its first 8 Bit inputs. These
Bits are then joined to create a network variable of the SNVT_state type and
is sent to the Network Variable Output block.
EC-gfxProgram 1041
SNVT_switch Demux (ECP Series)
Description Used to separate a SNVT_switch type into its two components: Value and
State.
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
SNVT_switch Numeric -83886.08 to Block input.
+83886.07
Output(s)
Port Type Range Description
Value Numeric 0 to 100.00 The Value component of SNVT_switch.
State Enum -1, 0, or 1 The State component of SNVT_switch.
Block properties See Common block properties.
Example The SNVT_switch Demux block is used to separate a network variable of the
SNVT_switch type. The example below shows how nviFanState (Network
Variable Input block) is demuxed (SNVT_switch Demux block) so that its
State can control a Fan and its Value can control a Variable Frequency Drive
(Hardware Output blocks).
Figure 565: SNVT_switch Demux block example
The SNVT_switch Demux block receives a value from the Network Variable
Input block and separates it into its Value and State outputs. The Value is sent
to control the speed of a Variable Frequency Drive (Hardware Output block)
and the State is sent to turn a Fan (Hardware Output block) On and Off.
1042 EC-gfxProgram
SNVT_switch Mux (ECP Series)
Description Used to merge a SNVT_switch type from its two components: Value and
State.
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
Value Numeric 0 to 100.00 The Value component of SNVT_switch.
State Enuma -1, 0, or 1 The State component of SNVT_switch.
a. For this input, any value equal to or less than -1 is evaluated as -1. Any value
between -0.99 and 0.99 is evaluated as 0 or False. Any value equal to or
greater than 1 is evaluated as 1 or True.
Output(s)
Port Type Range Description
SNVT_switch Numeric -83886.08 to +83886.07 Block output.
Block properties See Common block properties.
Example The SNVT_switch Mux block is used to merge a network variable of the
SNVT_switch type. The example below shows how nvoSupplyFanCmd (Net-
work Variable Output block) is muxed (SNVT_switch Mux block) based on
the output of a Supply Fan (Hardware Output, Multiply, and Internal con-
stant block).
Figure 566: SNVT_switch Mux block example
The SNVT_switch Mux block receives an On (1) value into its State input
from the Hardware Output block and a value of 100 into its Value input from
the Multiply block, which multiplies the On (1) value received from the Hard-
ware Output block by 100. This Value and State are then joined to create a
network variable of the SNVT_switch type and is sent to the Network Vari-
able Output block.
EC-gfxProgram 1043
Time
Time blocks are used to configure delays, schedules, and time events.The fol-
lowing blocks are available in this category:
• Calendar (ECL Series)
• Calendar (ECB & ECY Series)
• Min Off Time
• Min On Off Time
• Min On Time
• Real Time Clock (ECP Series)
• Real Time Clock (ECL Series)
• Real Time Clock (ECB & ECY Series)
• Schedule (ECP Series)
• Schedule (ECL Series)
• Schedule (ECB & ECY Series)
• Start Delay
• Start Stop Delay
• Stop Delay
• Timer (ECP Series)
• Timer (ECL Series)
• Timer (ECB & ECY Series)
1044 EC-gfxProgram
Calendar (ECL Series)
Description A calendar defines a number of “special events”. Typically they are used to
define days with scheduling exceptions (for example, holidays), and reference
them in a schedule. The calendar for this block must be configured for it to
operate; see Calendar and Schedule Tool (ECL, ECB & ECY Series).
This block is used to link the controller’s calendar to the code. The SNVT type
that has been selected in the Change Type (ECP & ECL Series) window is
shown at the bottom of the block as shown below.
SNVT Type Identification
Advanced Resources Configuration, Calendar and Schedule Tool (ECL, ECB & ECY
configuration Series), Advanced configuration, Change Type (ECP & ECL Series), Find All
References (ECL, ECB & ECY Series), Copy From, Configure Ports, Show/
Hide Ports
Number of The number of Calendar block instances supported by a controller is shown in
blocks the Statistics pane.
Related blocks Schedule (ECL Series), Real Time Clock (ECL Series)
Input(s) N/A
Output(s)
Port Type Range Description
Current State Enum See Current calendar status state as provided by the
description building controller. Only the enumeration
LonOccupancyEnum is supported. See Figure 617.
The default value for current_state (set in Advanced
configuration) indicates that the calendar is not
currently configured.
EC-gfxProgram 1045
Port Type Range Description
NextState Enum See Next calendar status state as provided by the
description building controller. Only the enumeration
LonOccupancyEnum is supported. See Figure 617.
The default value for next_state (set in Advanced
configuration) indicates that the calendar is not
currently configured.
TimeToNext Numeric -1 to 7 The number of days before the next state. The
State default value for time_to_next_state (set in
Advanced configuration) indicates that the calendar
is not currently configured.
NOTE: When this output is 7, this indicates that the
nextstate is 7 or more days in the future.
Number Integer See The block number. See Number of blocks for the
description number of block instances supported by the current
controller model. Use this drop-down menu to select
an instance of this block.
Block properties See Common block properties.
Advanced The Calendar Configuration window allows the minimum and maximum send
configuration times to be specified. Network congestion occurs when network variables are
transmitted too frequently on the network. Network congestion can be
reduced by only transmitting network variables as frequently as is necessary
to meet the system requirements. Set the network properties as shown below
(refer to the controller’s Functional Profile in its datasheet). See also Typical
controller internal points. The Default Output values become active once the
calendar has been configured - See Calendar and Schedule Tool (ECL, ECB
& ECY Series).
1046 EC-gfxProgram
Figure 567: Calendar configuraiton window
Parameter Description
Min send time See Network Properties Configuration window (ECL,
ECB & ECY Series).
Max send time See Network Properties Configuration window (ECL,
ECB & ECY Series).
current_state The calendar’s current output value.
next_state The calendar’s next output value that will be
effective as shown in time_to_next_state.
time_to_next_state The amount of time before the calendar will
transition to it next state as shown in next_state.
EC-gfxProgram 1047
Configuring a A calendar is linked to a schedule in EC-Net so that the calendar can override
Calendar on the the weekly schedule. This is used for example, for holiday or vacation sched-
EC-Net Station ules where the same calendar is reused for both holiday and vacation sched-
(ECL Series) ules. Only a limited number of schedule special events can be saved on a
controller. It is more efficient to reuse a calendar in this way as it saves space
to allow for more schedule special events. See Using schedules and calen-
dars. The number of special events a controller can support varies depending
on the controller model - see the controller’s datasheet for more information.
The following configuration methods are available to create, edit, and transfer
calendar information into a controller:
• By configuring both calendars and schedules with the Calendar and
Schedule Tool by launching it from EC-gfxProgram. See Calendar and
Schedule Tool (ECL, ECB & ECY Series).
• By configuring both calendars and schedules with the Calendar and
Schedule Tool LNS Plugin. See Calendar and Schedule Tool (ECL, ECB
& ECY Series).
• By configuring both calendars and schedules with the Calendar and
Schedule Tool by launching it from the desktop (this is called standalone
mode). See Calendar and Schedule Tool (ECL, ECB & ECY Series).
• By configuring both calendars and schedules in EC-Net. This configura-
tion method is shown below.
When a EC-Net building controller is used, it is best to configure both calen-
dars and schedules in EC-Net so that they are centralized for use by all parts
of the control network and by more than one controller. When a controller is
equipped with an operator’s interface / ECx-Display (color LCD screen),
changes made in the controller to calendars and schedules are synchronized
with EC-Net. For this to work:
• The controller must have the latest firmware downloaded into it. See
Upgrade firmware (for ECL Series or ECB Series controllers only).
• EC-Net must have the latest support pack installed.
• The controller object must be in a BcpLonNetwork.
• The associated calendars and schedules must have been previously con-
figured in the controller.
When a EC-Net building controller is not available, use the Calendar and
Schedule Tool. See Calendar and Schedule Tool (ECL, ECB & ECY Series).
Use only one configuration method at a time to avoid conflicts between
scheduling methods. It is sometimes possible to change from one configura-
tion method to the other without losing previously created calendars.
1048 EC-gfxProgram
Preferred The general order in which you should configure schedules and calendars is:
schedule and (1) Set the time and date in the controller’s real time clock (see Setting the
calendar time in the controller), (2) configure the schedules (see Creating schedules in
configuration EC-Net (ECL Series)), (3) optionally configure the calendars (see below), and
order (ECL then link a calendar to a schedule (see below).
Series)
Methods to Calendars can be created in EC-Net as follows:
create calendars
in EC-Net (ECL • If the controller currently has pre-existing calendars and schedules in it,
Series) they can be automatically recreated in EC-Net. See Importing pre-existing
calendars and schedules from the controller in EC-Net (ECL Series).
If the controller has no calendars in it, follow the procedure to create them.
See Creating schedules in EC-Net (ECL Series).
Creating In the EC-Net configuration mode, the EC-gfxProgram Calendar blocks
Calendars in EC- depend on calendars pre-configured in EC-Net. The following procedure
Net (ECL Series) shows how to do this with a controller that has not previously been configured
with a calendar in EC-Net.
1. Click the Open Palette button in the Palette side bar to open the Open
Palette selection window.
Figure 568: Opening the Open Palette window
NOTE: If the Palette side bar is not open in the Side Bar Pane, click
WindowsSide Bars Palette to add the Palette side bar.
EC-gfxProgram 1049
2. Select the distechControls palette from the Open Palette selection win-
dow and click OK. This will add the distechControls palette to your Pal-
ette side bar.
Figure 569: Open Palette window: select distechControls
3. From the Drivers > Lonworks > ProgrammableControllers > EC-gfx-
Program> Utilities folder in the distechControls palette, drag the Calen-
darSchedule object anywhere on the station. Only CalendarSchedule is
supported.
Figure 570: Adding the CalendarSchedule type to the station
1050 EC-gfxProgram
NOTE: The controller tree is found within the Driver > BcpLonNetwork tree of
the station.
4. Name the calendar and click OK. The CalendarSchedule object is added
to the database.
Figure 571: Accepting the installation of the CalendarSchedule object on the
station
The calendar will be configured in a later step.
5. Double-click Schedules under the controller in the Nav tree.
Figure 572: Double-clicking Schedules
EC-gfxProgram 1051
6. Click Discover. The Discovered pane shows the schedules and cal-
endars available for this controller.
Figure 573: Discovering the available calendars and schedules
7. Click a calendar instance in the Discovered pane that you want to config-
ure and drag it to the Database pane.
Figure 574: Adding a calendar to the Database
1052 EC-gfxProgram
8. In the Add popup window, modify the Supervisor Ord by clicking open.
Figure 575: Adding the calendar to the Database
9. Link the CalendarSchedule object to the calendar that was dragged in
from the palette. Select CalendarSchedule object and click OK.
Figure 576: Linking the controller’s schedule to the CalendarSchedule
10. Click OK.
11. Set the Execution Time to Daily at 1 AM with a Randomization interval
of 5 minutes.
NOTE: The schedule is synchronized with the device every time you modify
and save it. We recommend setting a daily schedule synchronization
so the calendar will be automatically pushed into the controller should
EC-gfxProgram 1053
the controller have to be replaced for maintenance purposes. Setting
this to once daily helps to minimize network traffic.
12. Set the calendar’s Name and click OK.
13. Double-click CalendarSchedule in the Nav tree found under the control-
ler.
Figure 577: Configuring the CalendarSchedule
Press F1 on the keyboard for information about how to configure a calen-
dar.
14. Add a calendar event: Click . Configure the Name of the
event, the Type, and the calendar days. Click OK.
Figure 578: Configuring the Calendar Event
15. Click Save. A calendar’s configuration is automatically pushed into the
controller when you click Save.
16. In EC-gfxProgram, synchronize your project with the controller. See Proj-
ect Synchronization.
1054 EC-gfxProgram
Calendar (ECB & ECY Series)
Description A calendar defines a number of “special events”. Typically they are used to
define days with scheduling exceptions (for example, holidays), and reference
them in a schedule. The calendar for this block must be configured for it to
operate: see Calendar and Schedule Tool (ECL, ECB & ECY Series). This
block is used to link the controller’s calendar to the code.
Advanced Resources Configuration, Calendar and Schedule Tool (ECL, ECB & ECY
configuration Series), Configure Ports, Show/Hide Ports
Number of For ECB Series controllers: The number of Calendar block instances sup-
blocks ported by a controller is shown in the Statistics pane.
For ECY Series controllers: see Supported number of BACnet objects with an
ECY Series controller.
Related blocks Schedule (ECB & ECY Series), Real Time Clock (ECB & ECY Series)
Input(s) N/A
Output(s)
Port Type Range Description
Current State Digital 0 or 1 Current scheduled status state as provided by the
building controller.
NextState Digital 0 or 1 Next scheduled status state as provided by the
building controller.
TimeToNext Numeric -1 to 7 The number of days before the next state. -1
State means that the calendar is not currently
configured.
NOTE: When this output is 7, this indicates that
the nextstate is 7 or more days in the
future.
Number Integer See The block number. See Number of blocks for the
description number of block instances supported by the
current controller model. Use this drop-down
menu to select an instance of this block.
EC-gfxProgram 1055
Block properties See Common block properties.
Configuring a A calendar is linked to a schedule in EC-Net so that the calendar can override
Calendar on the the weekly schedule. This is used for example, for holiday or vacation sched-
EC-Net Station ules where the same calendar is reused for both holiday and vacation sched-
(ECB Series) ules. Only a limited number of schedule special events can be saved on a
controller. It is more efficient to reuse a calendar in this way as it saves space
to allow for more schedule special events. See Using schedules and calen-
dars.
The following configuration methods are available to create, edit, and transfer
calendar information into a controller:
• By configuring both calendars and schedules with the Calendar and
Schedule Tool by launching it from EC-gfxProgram. See Calendar and
Schedule Tool (ECL, ECB & ECY Series).
• By configuring both calendars and schedules with the Calendar and
Schedule Tool by launching it from the desktop (this is called standalone
mode). See Calendar and Schedule Tool (ECL, ECB & ECY Series).
• By configuring both calendars and schedules in EC-Net. This configura-
tion method is shown below.
When a EC-Net building controller is used, it is best to configure both calen-
dars and schedules in EC-Net so that they are centralized for use by all parts
of the control network and by more than one controller. When a controller is
equipped with an operator’s interface / ECx-Display (color LCD screen),
changes made in the controller to calendars and schedules are synchronized
with EC-Net. For this to work:
• The controller must have the latest firmware downloaded into it. See
Upgrade firmware (for ECL Series or ECB Series controllers only).
• EC-Net must have the latest support pack installed.
• The controller object must be in a BcpBacnetNetwork.
When a EC-Net building controller is not available, use the Calendar and
Schedule Tool. See Calendar and Schedule Tool (ECL, ECB & ECY Series).
Use only one configuration method at a time to avoid conflicts between
scheduling methods See Figure 733.. It is sometimes possible to change from
one configuration method to the other without losing previously created calen-
dars.
Preferred The general order in which you should configure schedules and calendars is:
Schedule and (1) Set the controller’s real time clock through time synchronization service
Calendar (see Configuring time synchronization with EC-Net, (2) configure the sched-
Configuration ules (see Schedule (ECB & ECY Series)), (3) optionally configure the calen-
Order (ECB dars (see below), and then link a calendar to a schedule (see below).
Series)
1056 EC-gfxProgram
Method to Create When the controller has no calendars in it, calendars can be created in EC-
Calendars in EC- Net by following the Creating Calendars in EC-Net (ECB Series) procedure to
Net (ECB Series) create them.
Creating When the Calendar block is added to a Programming Sheet in EC-gfxPro-
Calendars in EC- gram, and the project is synchronized with the controller, a corresponding cal-
Net (ECB Series) endar is created in the EC-Net database for this controller. In this procedure,
you must first create the calendar in EC-gfxProgram and then setup the cal-
endar in EC-Net.
NOTE: When you remove a Calendar Block from the Programming Sheet, it
remains exposed to the BACnet network. To stop exposing this BAC-
net object to the network, use the EC-gfxProgram Synchronization
feature with Clear schedule’s configuration option selected. See
Project Synchronization for more information.
Whether the Calendar block is present on the Programming sheet or
not (the calendar is still exposed to the BACnet network, for example,
by synchronizing it at least once before deleting it), it will override the
Schedule block for any events configured in the calendar.
When a Calendar block is on an EC-gfxProgram programming sheet,
no connection needs to be made to the Calendar block for it to work
(this link is made in EC-Net by linking the Calendar to the Calendar-
Schedule – see Linking a calendar to a schedule in EC-Net (optional -
ECB Series)).
Configure the calendar in the EC-Net station as follows.
1. In EC-gfxProgram, add a Calendar Block to the Programming Sheet with
appropriate (Monitor) blocks connected to its outputs.
Figure 579: Calendar blocks on a Programming Sheet
2. Synchronize the project to expose this calendar object to EC-Net: Click
Synchronize in the Home ribbon. See Project Synchronization for more
information.
3. In EC-Net, log into the station.
EC-gfxProgram 1057
4. Create a EC-Net based calendar anywhere on the Station that will be
used to link to the controller’s calendar: Right-click a node in the Nav tree
and select Views, Wire Sheet.
Figure 580: Opening a Wire Sheet
5. Click the Open Palette button in the Palette side bar to open the Open
Palette selection window.
Figure 581: Opening the Open Palette window
NOTE: If the Palette side bar is not open in the Side Bar Pane, click Win-
dowsSide BarsPalette to add the Palette side bar.
6. Select schedule from the Open Palette selection window and click OK.
This will add the schedule palette to your Palette side bar.
Figure 582: Opening Palette window: Selecting schedule
1058 EC-gfxProgram
7. From the schedule Palette, drag a CalendarSchedule object to the Wire
Sheet.
Figure 583: Adding a CalendarSchedule to the Wire Sheet
8. Name the schedule and click OK. The CalendarSchedule object is
added to the station.
Figure 584: Naming the Calendar Schedule
The calendar will be configured in a later step.
9. In the Nav tree, double-click Schedules under the controller.
Figure 585: Double-click Schedules found under controller
EC-gfxProgram 1059
10. Select the Bacnet Schedule Export Manager.
Figure 586: Selecting the BACNet Schedule Export Manager
11. Click Discover to find all Schedule and Calendar Blocks that have been
synchronized with the controller.
Figure 587: Discovering all Schedule and Calendar blocks that were created on the controller
1060 EC-gfxProgram
12. Select the discovered Calendar and click the list arrow next to Add.
Select Device.
Figure 588: Adding the calendar to the Database
Parameter Description
Device When initially configuring a schedule, you must use this
option. Choose this option to import the calendar’s
configuration from the device during calendar creation.
Niagara Choose this option to keep the EC-Net database’s
configuration for the calendars.
13. Click Add.
14. Modify the Supervisor Ord by clicking open.
Figure 589: Adding the calendar to the Database
EC-gfxProgram 1061
15. Link the controller’s calendar to the CalendarSchedule that was created
on the Station. Select CalendarSchedule and click OK.
Figure 590: Linking the controller‘s calendar to the CalendarSchedule
16. Click OK.
1062 EC-gfxProgram
17. Set the Skip Writes parameter: Click .
Figure 591: Setting the Skip Writes parameter
18. Set the Skip Writes parameter as shown below. Click OK.
Figure 592: Setting the Skip Writes parameter values
If this is the first time you are setting this parameter, you will have to cre-
ate the parameters shown above, one row at a time, in the order shown.
To do so, click to add a new row and set the Key, Type, and Value.
You must type the Key values exactly as shown, respecting upper and
lowercase case characters.
19. Set the Execution Time to Daily at 1 AM with a Randomization interval
of 5 minutes.
NOTE: The calendar is synchronized with the device every time you modify
and save it. We recommend setting a daily calendar synchronization
so the calendar will be automatically pushed into the controller should
the controller have to be replaced for maintenance purposes. Setting
this to once daily helps to minimize network traffic.
EC-gfxProgram 1063
20. Set the calendar’s Name and click OK.
21. Make the calendar operational: Right click the calendar in the database
and select Actions, Execute.
Figure 593: Enabling the calendar
22. Right-click the CalendarSchedule, and select View > AX Slot Sheet.
Figure 594: Opening the CalendarSchedule’s slot sheet
1064 EC-gfxProgram
23. Right-click the slot shown as Action, Execute and select Config Flags.
Figure 595: Opening the CalendarSchedule‘s slot sheet
24. Deselect Hidden.
25. Click OK.
EC-gfxProgram 1065
26. Right-click CalendarSchedule and select Link Mark.
Figure 596: Selecting the Link Mark for the CalendarSchedule
27. Right-click the Calendar Export Object and select Link From “Calendar-
Schedule”.
Figure 597: Linking the CalendarSchedule to the calendar
1066 EC-gfxProgram
28. In the Link popup, under CalendarSchedule [Source] select Execute
and under the Calendar Export Object [Target] select Execute.
Figure 598: Linking the CalendarSchedule to the calendar
29. Click OK.
30. Open the CalendarSchedule’s configuration: Double-click the Calendar-
Schedule object on the Wire Sheet, as created in Step 7.
Figure 599: Double-click the CalendarSchedule to configure it.
EC-gfxProgram 1067
Adding events to Configure the new calendar schedule as necessary for the controller. Click
the calendar Add to add events. When done, click Save.
(ECB Series)
Figure 600: Configuring the calendar
NOTE: For more information about how to configure a schedule in EC-Net,
refer to the EC-Net User Guide normally found in \Niagara\[Niagara
Station & version]\docs\docUser on the C: drive or press F1 on the
keyboard.
A calendar’s configuration is automatically pushed into the controller when
you click Save.
1068 EC-gfxProgram
Min Off Time
Description Used to maintain the output in the Off state for a user-defined duration after a
falling edge (On-to-Off transition).
The current time unit configured through the TimeBase property in the Prop-
erties pane is shown at the bottom of the block as shown below.
TimeBase Setting
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
32-Bit 8-Bit
Input Digital 0 or 1 Block input.
EC-gfxProgram 1069
Port Type Range Description
32-Bit 8-Bit
MinOff Integer 0 to 3×1038s 0 to 65535s The minimum time that the output
will be maintained in the Off
0 to 1092.25m
0 to 5×1036m position before it can be turned On.
0 to 18.20h The units are set in TimeBase of
0 to
the block’s properties.
8.3333×1034h
Enable Digital 0 or 1 When set to On (1), the block will be
enabled and the output will follow
the MinOff timer. If set to Off (0)
then the output will directly follow
the input.
Output(s)
Port Type Range Description
32-Bit 8-Bit
Output Digital 0 or 1 The output value of the block.
RemTime Integer 0 to 3×1038s 0 to 65535s Count-down timer of the MinOff
remaining time, triggered on the
0 to 1092.25m
0 to 5×1036m falling edge of the Input.
0 to 18.20h
0 to
8.3333×1034h
Block properties See also Common block properties.
Property Type Range Default Description
TimeBase Menu See Second Select the unit of time: Second, Minute or
Description Hour.
NOTE: The TimeBase unit affects the value
range of MinOff.
If the TimeBase is set to minutes, 59
seconds will be shown as 0.98 min-
utes.
If the TimeBase is set to seconds,
you must enter a value of 1 second
or more.
Example See the Example in the Min On Time block section.
1070 EC-gfxProgram
Min Off Time If no Input to a Min Off Time block is Null, then the block’s output is the nor-
block operations mal result. If one or more Inputs to a Min Off Time block are Null, then the
with Null Output of the Min Off Time block is always False (0).
Min On Off Time
Description Used to maintain the output in the On state for a user-defined duration after a
rising edge (Off-to-On transition) and/or Off state for a user-defined duration
after a falling edge (On-to-Off transition).
The current time unit configured through the TimeBase property in the Prop-
erties pane is shown at the bottom of the block as shown below.
TimeBase Setting
Advanced Configure Ports, Show/Hide Ports
configuration
EC-gfxProgram 1071
Input(s)
Port Type Range Description
32-Bit 8-Bit
Input Digital 0 or 1 Block input.
MinOn Integer 0 to 3×1038s 0 to 65535s The minimum time that the output
will be maintained in the On position
0 to 1092.25m
0 to 5×1036m before it can be turned Off. The
0 to 18.20h units are set in TimeBase of the
0 to
block’s properties.
8.3333×1034h
MinOff Integer 0 to 3×1038s 0 to 65535s The minimum time that the output
will be maintained in the Off
0 to 1092.25m
0 to 5×1036m position before it can be turned On.
0 to 18.20h
0 to
8.3333×1034h
Enable Digital 0 or 1 When set to On (1), the block will be
enabled and the output will follow
the MinOff timer. If set to Off (0)
then the output will directly follow
the input.
Output(s)
Port Type Range Description
32-Bit 8-Bit
Output Digital 0 or 1 The output value of the block.
RemTime Integer 0 to 3×1038s 0 to 65535s Count-down timer of the:
0 to 1092.25m • MinOn remaining time, trig-
0 to 5×1036m
gered on the rising edge of the
0 to 18.20h
0 to Input.
8.3333×1034h • MinOff remaining time, trig-
gered on the falling edge of the
Input.
1072 EC-gfxProgram
Block properties See also Common block properties.
Property Type Range Default Description
TimeBase Menu See Second Select the unit of time: Second, Minute or
Description Hour.
NOTE: The TimeBase unit affects the value
ranges of MinOn and MinOff.
If the TimeBase is set to minutes, 59
seconds will be shown as 0.98 min-
utes.
If the TimeBase is set to seconds, you
must enter values of 1 second or
more.
Example See the Example in the Min On Time block section.
Min On Off Time If no Input to a Min On Off Time block is Null, then the block’s output is the
block operations normal result. If one or more Inputs to a Min On Off Time block are Null, then
with Null the Output of the Min On Off Time block is always Null.
Min On Time
Description Used to maintain the output in the On state for a user-defined duration after a
rising edge (Off-to-On transition).
EC-gfxProgram 1073
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
32-Bit 8-Bit
Input Digital 0 or 1 Block input.
MinOn Integer 0 to 3×1038s 0 to 65535s The minimum time that the output
will be maintained in the On position
0 to 1092.25m
0 to 5×1036m before it can be turned Off. The
0 to 18.20h units are set in TimeBase of the
0 to
block’s properties.
8.3333×1034h
Enable Digital 0 or 1 When set to On (1), the block will be
enabled and the output will follow
the MinOn timer. If set to Off (0)
then the output will directly follow
the input.
Output(s)
Port Type Range Description
32-Bit 8-Bit
Output Digital 0 or 1 The output value of the block.
RemTime Integer 0 to 3×1038s 0 to 65535s Count-down timer of the MinOn
remaining time, triggered on the
0 to 1092.25m
0 to 5×1036m rising edge of the Input.
0 to 18.20h
0 to
8.3333×1034h
Block properties See also Common block properties.
1074 EC-gfxProgram
Property Type Range Default Description
TimeBase Menu See Second Select the unit of time: Second, Minute or
Description Hour.
NOTE: The TimeBase unit affects the value
range of MinOn.
If the TimeBase is set to minutes, 59
seconds will be shown as 0.98 min-
utes.
If the TimeBase is set to seconds,
you must enter a value of 1 second
or more.
EC-gfxProgram 1075
Example The Min On Time block is used to keep an output On for a time period. The
example below shows how a pulsed override (bypass occupancy) command
(SmartSensor Module (ECP Series) block) is kept On for 60 minutes (Min On
Time and Internal constant blocks).
Figure 601: Min On Time block example
The Min On Time block receives its Input from the Override of the SmartSen-
sor Module block. When the Override turns On, the Min On Time block out-
puts an On value for 60 minutes. When the unoccupied mode is scheduled
and the override is turned On, the Switch blocks output bypass mode which is
sent and displayed on the SmartSensor Module block.
Min On Time If no Input to a Min On Time block is Null, then the block’s output is the nor-
block operations mal result. If one or more Inputs to a Min On Time block are Null, then the
with Null Output of the Min On Time block is always False (0).
1076 EC-gfxProgram
Real Time Clock (ECP Series)
Description Will supply and maintain real time for a controller.
Controller This block is available when used with a controller that has a built-in real time
support clock. See the controller’s datasheet for the availability of this feature.
For ECP Series controllers, see Real Time Clock Configuration Tool (ECP
Series).
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s) N/A
Output(s)
Port Type Range Description
Year Integer 2000 to 2100 The current 4-digit year.
Month Enum 1 to 12 The current month:
1 = January
2 = February
3 = March
4 = April
5 = May
6 = June
7 = July
8 = August
9 = September
10 = October
11 = November
12 = December
EC-gfxProgram 1077
Port Type Range Description
Day Integer 1 to 31 The current day of the month.
DayOfWeek Enum 0 to 6 The current day of the week.
1 = Monday
2 = Tuesday
3 = Wednesday
4 = Thursday
5 = Friday
6 = Saturday
7 = Sunday
Hour Integer 0 to 23 The current hour.
Minute Integer 0 to 59 The current minute of the hour.
Second Integer 0 to 59 The current second.
Block properties See Common block properties.
Real Time Clock (ECL Series)
Description Supplies and maintains real time for a controller. This block does not need to
be on a Programming Sheet to maintain time.
The time can be set through the configure dialog, in which you can click the
Synchronize button in the Real Time Clock Configuration screen (shown
below) to get the current time from the building controller.
The block is used to provide time values to EC-gfxProgram code, if required.
Controller This block is available when used with a controller that has a built-in real time
support clock. See the controller’s datasheet for the availability of this feature.
Advanced Resources Configuration, Advanced configuration, Configure Ports, Show/
configuration Hide Ports, LONWORKS Properties
1078 EC-gfxProgram
Input(s) N/A
Output(s)
Port Type Range Description
Year Integer 2000 to 2100 The current 4-digit year.
Month Enum 1 to 12 The current month:
1 = January
2 = February
3 = March
4 = April
5 = May
6 = June
7 = July
8 = August
9 = September
10 = October
11 = November
12 = December
Day Integer 1 to 31 The current day of the month.
DayOfWeek Enum 0 to 6 The current day of the week.
1 = Monday
2 = Tuesday
3 = Wednesday
4 = Thursday
5 = Friday
6 = Saturday
7 = Sunday
Hour Integer 0 to 23 The current hour.
Minute Integer 0 to 59 The current minute of the hour.
Second Integer 0 to 59 The current second.
Block properties See Common block properties.
EC-gfxProgram 1079
Advanced Configuration parameters for this block are set in the Resources Configura-
configuration tion window to set the controller’s clock.
Figure 602: Real Time Clock configuration window
Parameter Description
Date/time Click Read Device Time to view the controller’s current
time settings.
Click Synchronize to set the controller’s time to that of
your PC’s clock.
Enable Daylight Set to enable daylight saving time. Daylight saving time
Saving Time temporarily advances the clock forward in spring (by an
amount set in Offset - typically by one hour) and is
adjusted backward in autumn.
Month Set the date and time range (between the Start date
and the Stop date) during which Daylight Saving Time
Week
is to be active.
Day
Hour
Minute
Offset Sets the amount of time the daylight saving time is to
advance the controller’s clock.
1080 EC-gfxProgram
NOTE: Controllers require a network time synchronization pulse before the
real time clock becomes available as follows:
- Click the Synchronize button in the Real Time Clock Configura-
tion screen (shown above) to get the current time from the building
controller.
- For controllers without a battery (see the controller’s datasheet), a
network time synchronization pulse is required at each power-up
cycle.
- For controllers with a battery, a network time synchronization pulse is
required at initial power-up. A power outage cannot be longer than 20
days, otherwise a network time synchronization pulse is required upon
power-up. Such controllers need to be powered for a minimum of 20
hours to fully charge the battery.
Without a network time synchronization pulse, the default power-up
time starts at midnight, January 1, 2011.
LONWORKS Specify the network communication properties for the real time clock in the
Properties LONWORKS Properties tab. See Network Properties Configuration window
(ECL, ECB & ECY Series). See also Typical controller internal points. The
time can be set by binding the real time clock to a building controller. In the
case of a controller equipped with an operator interface or it is connected to
an ECx-Display, the nvoTimeDate can be bound to other controllers so as to
set their time. See also Linking, building, and trimming LONWORKS component
objects in EC-Net.
Real Time Clock (ECB & ECY Series)
Description Supplies and maintains real time for a controller. This block does not need to
be on a Programming Sheet to maintain time.
For ECY Series controllers, the time is configured in ENVYSION. See the
ENVYSION User Guide.
For ECB Series controllers, the time can be manually set during configuration
through the configure dialog, in which you can click the Synchronize button
in the Real Time Clock Configuration screen (shown below) to get the cur-
rent time from the building controller.
The block is used to provide time values to the EC-gfxProgram code, if
required.
EC-gfxProgram 1081
B-ASC, B-AAC, and B-BC listed controllers support BIBBS DM-MTS-A. This
supports the time-synchronization-recipients or utc-time-synchronization-
recipients properties which are used to synchronize this controller’s time at
regular intervals from another B-AAC or B-BC listed controller. Under this
scheme, this controller is added to the time-synchronization-recipients or utc-
time-synchronization-recipients recipient list of another controller that sup-
ports this property and acts as the time source.
B-AAC and B-BC listed controllers also support BIBBS Device Management-
TimeSynchronization-B (DM-TS-B). This property can be used to synchronize
the real time clock at regular intervals with other controllers that support the
time-synchronization-recipients or utc-time-synchronization-recipients proper-
ties. The following methods can be used together to transmit the time signal to
other controllers:
• Up to five controllers for time-synchronization-recipients can be defined
and up to five controllers for utc-time-synchronization-recipients can be
defined.
• The time-synchronization-recipients and utc-time-synchronization-recipi-
ents can be broadcast locally to all controllers on the same subnet of the
current controller, or it can be broadcast globally to all controllers on all
subnets.
Furthermore, any controller with a ComSensor connected to it, when properly
configured, allows the user to set the controller’s real time clock. ComSensor
time updates are also automatically propagated to other controllers on the
network once the DateTime edit scene has been configured. See Edit Date or
Time scene (ECB Series controllers).
Advanced Resources Configuration, Advanced configuration, Configure Ports, Show/
configuration Hide Ports, Setting the automatic time synchronization properties recipients
(B-AAC and B-BC listed controllers only), Configuring time synchronization
with EC-Net
Related blocks ComSensor (ECB & ECY Series)
Input(s) N/A
1082 EC-gfxProgram
Output(s)
Port Type Range Description
Year Integer 2000 to 2100 The current 4-digit year.
Month Enum 1 to 12 The current month:
1 = January
2 = February
3 = March
4 = April
5 = May
6 = June
7 = July
8 = August
9 = September
10 = October
11 = November
12 = December
Day Integer 1 to 31 The current day of the month.
DayOfWeek Enum 1 to 7 The current day of the week.
1 = Monday
2 = Tuesday
3 = Wednesday
4 = Thursday
5 = Friday
6 = Saturday
7 = Sunday
Hour Integer 0 to 23 The current hour.
Minute Integer 0 to 59 The current minute of the hour.
Second Integer 0 to 59 The current second.
Block properties See Common block properties.
EC-gfxProgram 1083
Advanced Configuration parameters for this block are set in the Resources Configura-
configuration tion window under System > Device to set the controller’s clock.
Figure 603: Real Time Clock Configuration window
Parameter Description
Date/time (ECB Click Read Device Time to view the controller’s current
Series time settings.
controllers only)
Click Synchronize to set the controller’s clock with the
building controller’s clock.
Time zone Set the controller’s time zone.
Synchronization The time period between pushing this controller’s time
Interval (B-AAC to all controllers specified in the Recipients List.
and B-BC listed Setting the Synchronization Interval to zero (0)
controllers only) disables this feature.
Align Interval (B- Aligns the Synchronization Interval to be on the hour
AAC and B-BC plus any Interval Offset.
listed controllers
When a Synchronization Interval is set to a value that
only)
divides evenly in to an hour (60 minutes) or day (1440
minutes), that is without a remainder, then when this
option is set, the beginning of the specified
Synchronization Interval will be aligned to the hour or
day, respectively plus any Interval Offset.
Interval Offset To prevent network traffic saturation, the moment when
(B-AAC and B- the Automatic Time Synchronization Property
BC listed messages are sent on the network can be offset by the
controllers only) amount of time set. Vary the amount of Interval Offset
between controllers so as to spread out Automatic
Time Synchronization Property messages on the
network.
NOTE: ECB Series controllers require a network time synchronization pulse
before the real time clock becomes available as follows:
- Click the Synchronize button in the Real Time Clock Configura-
tion screen (shown above) to get the current time from the building
controller.
1084 EC-gfxProgram
- For controllers without a battery (see the controller’s datasheet), a
network time synchronization pulse is required at each power-up
cycle.
- For controllers with a battery, a network time synchronization pulse is
required at initial power-up. A power outage cannot be longer than 20
days, otherwise a network time synchronization pulse is required upon
power-up. Such controllers need to be powered for a minimum of 20
hours to fully charge the battery.
Without a network time synchronization pulse, the default power-up
time starts at midnight, January 1, 2011.
Setting the The Automatic Time Synchronization Properties recipients are configured as
automatic time follows.
synchronization
properties Parameter Description
recipients (B-
AAC and B-BC Recipients List Shows the recipient controllers for Automatic Time
listed controllers Synchronization property. To add recipients, see
only) Adding recipient controllers to the automatic time
synchronization property.
Time Sync Set the controllers that support the time-
Recipients synchronization-recipients property and are to receive
the automatic time synchronization messages at
regular intervals.
UTC Time Sync Set the controllers that support the utc-time-
Recipients synchronization-recipients property and are to receive
the automatic time synchronization messages at
regular intervals.
NOTE: Controllers synchronized to UTC maintain their
clock at Greenwich Mean Time and use a time
zone offset to calculate the local time, as set in
Time zone in Figure 603.
Adding recipient The following Time Sync Recipients types are supported.
controllers to the
automatic time Parameter Description
synchronization
property Time Sync Set the controllers that support the time-synchronization-
Recipients recipients property and are to receive the automatic time
synchronization messages at regular intervals.
UTC Time Set the controllers that support the utc-time-synchronization-
Sync recipients property and are to receive the automatic time
Recipients synchronization messages at regular intervals.
Add the recipient controllers for Automatic Time Synchronization Property as
follows. Only select controllers support the time-synchronization-recipients
property.
1. Right-click the type of time synchronization and select Add.
EC-gfxProgram 1085
2. Type the recipient controller’s name.
3. Set the Recipient Type. The destination controller for real time clock syn-
chronization can be specified as follows:
• Device: BACnet device instance (ECB Series controllers only) – Click
Select device from database to open a list of devices in the data-
base. This is the preferred option when using EC-Net.
• Address: BACnet Node Address.
• Local Broadcast: Broadcast the time synchronization to all controllers
on the same subnet as this controller.
• Global Broadcast: Broadcast the time synchronization to all control-
lers on all subnets.
• Remote Broadcast: Broadcast the time synchronization to all control-
lers on another subnet than the one used by this controller.
NOTE: Should two or more controllers use schedules whose operation
between controllers are interdependent, ensure that these controllers
are all in the same Recipient list so that they receive the time update
simultaneously, thus keeping the events in the schedules between the
controllers synchronized.
Configuring time When a EC-Net building controller is used, it is best to use it to synchronize
synchronization the time to all controllers on the network.
with EC-Net
1086 EC-gfxProgram
1. Under BcpBacnetNetwork, double-click Local Device to open the prop-
erty sheet.
Figure 604: open the local decice’s property sheet
2. To add a time synchronization recipient, right click Time Synchronization
Recipients, and select Action > addElement. To add a UTC time syn-
chronization recipient, right click Utc Time Synchronization Recipients,
and select Action > addElement.
Figure 605: Adding an element to the Time Synchronization Recipients
Figure 606: Adding an element to the UTC Time Synchronization Recipients
3. Click and then resize the addElement window to make the content vis-
ible.
4. Set the first drop down to Address.
5. Set the MAC Address to synchronize the time with an individual controller,
set this controller’s Network Number and MAC Address. This requires
that for each controller to have its time synchronized, an addElement has
to be added to the Time Synchronization Recipients. By s
EC-gfxProgram 1087
6. Setting the MAC Address to 255, this broadcasts the time synchroniza-
tion message to all controllers on the specified Network Number.
Figure 607: Synchronize the time with one controller using the controller‘s
Network and MAC address
Figure 608: Synchronize with all controllers on the network (255 being a
broadcast message on the network)
7. Set the MAC Address Style to MSTP/Other. Click OK.
8. For controllers that do not have a battery backed up real time clock (refer
the controllers’ datasheet for this information), it is recommended to set
the Time Synchronization Interval to 5 minutes.
Figure 609: Setting the Time Synchronization Interval
1088 EC-gfxProgram
9. For each controller that is in the list of UTC Time Synchronization
Recipients (only), the UTC offset must be set according to the control-
ler’s time zone: Under each controller, double-click the Device Object to
open the property sheet. Set the controller’s UTC offset in minutes in
utcOffset.
Figure 610: For UTC Time Synchronization Recipients, set the controller‘s UTC
offset in minutes in utcOffset
Schedule (ECP Series)
Description Weekly schedules define regular, repeating, events by “time-of-day” and “day-
of-week.”
This block is used to link the controller’s schedule to the code. If nviSchedulex
(x = 1 or 2) is valid, this block will output the values from nviSchedule and the
user-defined schedule (Scheduler tool) is overridden (if applicable). If
nviSchedulex is invalid, this block will output the values from the user-defined
schedule (Scheduler tool). This block supports SNVT types of 1 byte
(SNVT_occupancy, SNVT_hvac_mode, etc.) and 4 bytes (SNVT_tod_event).
See Scheduler Configuration Tool (ECP Series).
Number of 2
blocks
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s) N/A
EC-gfxProgram 1089
Output(s)
Port Type Range Description
Current State Enum -1 to 3 Current scheduled status state based on the occup_t
enumeration. The values are defined as follows:
-1 = OC_NUL
0 = OC_OCCUPIED
1 = OC_UNOCCUPIED
2 = OC_BYPASS
3 = OC_STANDBY
NextState Enum 0 to 3 Next scheduled status state based on the occup_t
enumeration. The values are defined as follows:
0 = OC_OCCUPIED
1 = OC_UNOCCUPIED
2 = OC_BYPASS
3 = OC_STANDBY
NOTE: This output only works if the SNVT type is
SNVT_tod_event.
TimeToNext Numeric 0 to 65535 Time (in minutes) to the next status state.
State
NOTE: This output only works if the SNVT type is
SNVT_tod_event.
Com Failure Digital 0 or 1 Communication failure alarm status.
Block properties See also Common block properties.
Property Type Range Default Description
Number Menu 1 to 2 Schedule 1 Use this drop-down menu to select from
the 2 available block instances.
See
Description
NOTE: When a new block instance is
added to the Programming
Sheet, the block’s number is
incremented to the next avail-
able block number according to
the current Auto Increment set-
ting. See Auto increment (ECP
& ECL Series and EBC Series
controllers only).
1090 EC-gfxProgram
Schedule (ECL Series)
Description Weekly schedules define regular, repeating, events by “time-of-day” and “day-
of-week.” The schedule for this block must be configured for it to operate; see
Calendar and Schedule Tool (ECL, ECB & ECY Series).
This block is used to link the controller’s schedule to the code. The SNVT type
that has been selected in the Change Type (ECP & ECL Series) window is
shown at the bottom of the block as shown below.
SNVT Type Identification
Advanced Resources Configuration, Calendar and Schedule Tool (ECL, ECB & ECY
configuration Series), Advanced configuration, Change Type (ECP & ECL Series), Find All
References (ECL, ECB & ECY Series), Copy From, Configure Ports, Show/
Hide Ports
Number of The number of Schedule block instances supported by a controller is shown
blocks in the Statistics pane.
Related blocks Calendar (ECL Series), Real Time Clock (ECL Series)
Input(s) N/A
Output(s)
Port Type Range Description
Current State Enum See Current scheduled status state as provided by the
description building controller. Only the enumeration
LonOccupancyEnum is supported. See Figure 617.
The default value for current_state (set in Advanced
configuration) indicates that the schedule is not
currently configured or its Effective Period is not
active.
EC-gfxProgram 1091
Port Type Range Description
NextState Enum See Next scheduled status state as provided by the building
description controller. Only the enumeration LonOccupancyEnum
is supported. See Figure 617. The default value for
next_state (set in Advanced configuration) indicates
that the schedule is not currently configured or its
Effective Period is not active.
TimeToNext Numeric 0 to 3.4028 Time (in minutes) to the next status state. The default
State ×1038 value for time_to_next_state (set in Advanced
configuration) indicates that the schedule is not
currently configured or its Effective Period is not
active.
Number Integer See The block number.
description
Fault Digital 0 or 1 This indicates that the currently configured schedule in
the controller is incorrectly configured. This is logically
True (1) if the Reliability property does not have a value
of No Fault Detected, otherwise logical False (0).
Reliability Enum See This indicates that the currently configured schedule in
Description the controller is incorrectly configured. See Reliability
property.
Block properties See also Common block properties.
Property Type Range Default Description
Number Menu See Schedule 1 Use this drop-down menu to select an
Description instance of this block. See Number of
blocks for the number of block instances
supported by the current controller
model.
NOTE: When a new block instance is
added to the Programming
Sheet, the block’s number is
incremented to the next avail-
able block number according to
the current Auto Increment set-
ting. See Auto increment (ECP
& ECL Series and EBC Series
controllers only).
1092 EC-gfxProgram
Advanced Configuration parameters for this block are set in the Resources Configura-
configuration tion window to set the maximum receive time, and the minimum and maxi-
mum send times to be specified. Network congestion occurs when network
variables are transmitted too frequently on the network. Network congestion
can be reduced by only transmitting network variables as frequently as is nec-
essary to meet the system requirements. Set the network properties as shown
below (refer to the controller’s Functional Profile in its datasheet). See also
Typical controller internal points. The Default Output values become active
once the calendar has been configured in EC-Net - See Configuring a Calen-
dar on the EC-Net Station (ECL Series).
Figure 611: Schedule Configuration window
Parameter Description
Current state The schedule’s current output value.
Next state The schedule’s next output value that will be effective
as shown in time_to_next_state.
Time to next The amount of time before the schedule will transition
state to it next state as shown in next_state.
See Network Properties Configuration window (ECL, ECB & ECY Series).
Configuring a The following configuration methods are available to create, edit, and transfer
schedule on the schedule information into a controller:
EC-Net station
(ECL Series) • By configuring both calendars and schedules with the Calendar and
Schedule Tool by launching it from EC-gfxProgram. See Calendar and
Schedule Tool (ECL, ECB & ECY Series).
• By configuring both calendars and schedules with the Calendar and
Schedule Tool LNS Plugin. See Calendar and Schedule Tool (ECL, ECB
& ECY Series).
• By configuring both calendars and schedules with the Calendar and
Schedule Tool by launching it from the desktop (this is called standalone
mode). See Calendar and Schedule Tool (ECL, ECB & ECY Series).
EC-gfxProgram 1093
• By configuring both calendars and schedules in EC-Net. This configura-
tion method is shown below.
When a EC-Net building controller is used, it is best to configure both calen-
dars and schedules in EC-Net so that they are centralized for use by all parts
of the control network and by more than one controller. When a controller is
equipped with an operator’s interface / ECx-Display (color LCD screen),
changes made in the controller to calendars and schedules are synchronized
with EC-Net. For this to work:
• The controller must have the latest firmware downloaded into it. See
Upgrade firmware (for ECL Series or ECB Series controllers only).
• EC-Net must have the latest support pack installed.
• The controller object must be in a BcpLonNetwork.
• The associated calendars and schedules must have been previously con-
figured in the controller.
When a EC-Net building controller is not available, use the Calendar and
Schedule Tool. See Calendar and Schedule Tool (ECL, ECB & ECY Series).
Use only one configuration method at a time to avoid conflicts between
scheduling methods (see Figure 733). It is sometimes possible to change
from one configuration method to the other without losing previously created
schedules.
Preferred The general order in which you should configure schedules and calendars is:
schedule and (1) Set the time and date in the controller’s real time clock (see below), (2)
calendar configure the schedules (see below), (3) optionally configure the calendars
configuration (see Creating Calendars in EC-Net (ECL Series)), and then link a calendar to
order a schedule (see Linking a calendar to a schedule in EC-Net (optional)). See
also Using schedules and calendars.
1094 EC-gfxProgram
Setting the time Set the time in the controller.
in the controller
1. Drag a Real Time Clock block onto the Programming Sheet and double-
click it.
Figure 612: Real Time Clock configuration window
2. Click Synchronize to synchronize the controller’s clock with the building
controller’s clock. Click Read to confirm the correct time and date. Click
OK and delete the Real Time Clock block from the Programming Sheet.
Methods to Schedules can be created in EC-Net as follows:
create schedules
in EC-Net • If the controller currently has pre-existing schedules in it, they can be
automatically recreated in EC-Net. See Importing Pre-existing Calendars
and Schedules from the Controller into EC-Net (ECL Series).
• If the controller has no schedules in it, follow the Creating Schedules in
EC-Net (ECL Series) procedure to create them.
EC-gfxProgram 1095
Importing pre- If you want to create calendars and schedules in EC-Net’s database that have
existing been previously created in the controller as calendars and schedules, right-
calendars and click Schedules under the controller in the Nav tree and select Actions >
schedules from Create Schedules. This action creates EC-Net calendar and schedule
the controller in objects mapped to the device directly under the device object.
EC-Net (ECL
Figure 613: Creating the calendars and schedules in EC-Net’s database from the
Series) controller’s calendars and schedules
Creating In the EC-Net configuration mode, EC-gfxProgram Schedule blocks depend
schedules in EC- on schedules pre-configured in EC-Net. The following procedure shows how
Net (ECL Series) to do this with a controller that has not previously been configured with a cal-
endar in EC-Net.
1. Click the Open Palette button in the Palette side bar to open the Open
Palette selection window.
Figure 614: Opening the Open Palette window
NOTE: If the Palette side bar is not open in the Side Bar Pane, click Win-
dowsSide Bars Palette to add the Palette side bar.
1096 EC-gfxProgram
2. Select the distechControls palette from the Open Palette selection win-
dow and click OK. This will add the distechControls palette to your Pal-
ette side bar.
Figure 615: Open Palette window: select distechControls
3. From the Drivers > LonWorks > ProgrammableControllers > EC-gfx-
Program > Utilities folder in the distechControls palette, drag the
EnumSchedule object anywhere on the station. Only the EnumSched-
ule object is supported.
Figure 616: Adding the EnumSchedule object to the station
NOTE: The controller tree is found within the Driver > BcpLonNetwork tree
of the station.
EC-gfxProgram 1097
4. Click OK to add the EnumSchedule object to the scheduler. The sched-
ule will be configured in a later step.
5. Double-click Schedules under the controller in the Nav tree.
6. Click Discover. The Discovered pane shows the schedules and cal-
endars available for this controller.
7. Click a schedule instance in the Discovered pane that you want to con-
figure and drag it to the Database pane.
1098 EC-gfxProgram
8. In the Add popup window, modify the Supervisor Ord by clicking open.
9. Link the controller’s schedule to the EnumSchedule that was dragged in
from the palette. Select EnumSchedule and click OK.
10. Set the Execution Time to Daily at 1 AM with a Randomization interval
of 5 minutes.
EC-gfxProgram 1099
NOTE: The schedule is synchronized with the device every time you modify
and save it. We recommend setting a daily schedule synchronization
so the schedule will be automatically pushed into the controller should
the controller have to be replaced for maintenance purposes. Setting
this to once daily helps to minimize network traffic.
11. Set the schedule’s Name and click OK.
12. Double-click EnumSchedule in the Nav tree and select the Properties
tab.
13. The LonOccupancyEnum is the pre-configured facet. Click in Facet.
14. In Config Facets, at the end of the range row, click .
15. Click .
1100 EC-gfxProgram
16. Use only the LonOccupancyEnum facet for this schedule. Select Use
Frozen Enum in Range. The enumerations for this facet are shown
below.
Figure 617: Enumeration values for LonOccupancyEnum
17. Click OK to close the windows.
18. Set the Default Output: Deselect null. In the drop down list, select Unoc-
cupied.
19. Click Save.
EC-gfxProgram 1101
Adding events to Configure the new schedule as necessary for the controller. When done, click
the schedule Save. Add events to the schedule as follows.
Figure 618: Example of adding events to the weekly schedule
NOTE: For more information about how to configure a schedule in EC-Net,
refer to the EC-Net User Guide normally found in \Niagara\[Niagara
Station & version]\docs\docUser on the C: drive or press F1 on the
keyboard.
There are four major elements in the Scheduler interface, separated by tabs
in the view.
Parameter Description
Weekly Defines the regular (repeating) day-of-week schedule
Schedule events for each day of the week. Click and drag your
mouse on a day to select a time period for an event.
Special Events Special events override (and interact with) events in the
normal weekly schedule. A reference to a calendar can
also be made.
Properties Define the schedule's effective period, default output,
facets, and whether automatic special-event cleanup
occurs.
Summary Shows months with selectable days, including all
schedule event activity for any day selected.
A schedule’s configuration is automatically pushed into the controller when
you click Save.
1102 EC-gfxProgram
To view current state of a schedule (such as the current state, the next state,
and time to next state), right-click the Schedule (for example, device/Shed-
ule1) under the device in the Nav tree and select Views > Property Sheet
and expand the nvo (device/Shedule1/nvoSchedule_1).
Figure 619: Viewing schedule information
Finally, in EC-gfxProgram, synchronize your project with the controller. See
Project Synchronization. Make sure that Send schedule’s configuration is
deselected.
After having configured the schedules, you can optionally configure the calen-
dars if needed. See Calendar (ECL Series). If you configure a calendar, link it
to a schedule with the following procedure.
Linking a A calendar is linked to a schedule in EC-Net so that the calendar can override
calendar to a the weekly schedule. This is used for example, for holiday or vacation sched-
schedule in EC- ules where the same calendar is reused for both holiday and vacation sched-
Net (optional) ules. Only a limited number of schedule special events can be saved on a
controller. It is more efficient to reuse a calendar in this way as it saves space
to allow for more schedule special events. This procedure assumes a sched-
ule has been previously configured in EC-Net; to do so, see Configuring a
Calendar on the EC-Net Station (ECL Series).
EC-gfxProgram 1103
1. Double-click EnumSchedule in the Nav tree and select the Special
Events tab.
Figure 620: Configuring a calendar in a schedule
2. Add a special event: Click .
3. Give the special event a Name and set the Type to Reference. Select the
calendar this event is to reference in Calendars drop-down list of avail-
able calendars: make sure to click the appropriate calendar reference so
that it is highlighted. Click OK.
Figure 621: Selecting the calendar for this event (click it with your mouse)’
NOTE: Make sure that the calendar that you select is one that is exported to
the device (as created in the procedure above). Do not select a EC-
Net stand alone calendar.
1104 EC-gfxProgram
4. Set the duration for this event and the output (in Event Output) for this
event. For example, if this event is for the entire day, set the Event Start
to 12:00 AM and the Event Finish to 12:00 AM, then set the Event Out-
put to Unoccupied (first deselect null).
Figure 622: Setting the event duration and output
5. Click Save. The calendar’s configuration is automatically pushed to the
controller.
EC-gfxProgram 1105
Schedule (ECB & ECY Series)
Description Weekly schedules define regular, repeating, events by “time-of-day” and “day-
of-week.” The schedule for this block must be configured for it to operate: see
Calendar and Schedule Tool (ECL, ECB & ECY Series). This block is used to
link the controller’s schedule to the code.
Advanced Resources Configuration, Calendar and Schedule Tool (ECL, ECB & ECY
configuration Series), Find All References (ECL, ECB & ECY Series), Copy From, Config-
ure Ports, Show/Hide Ports
Number of For ECB Series controllers: The number of Schedule block instances sup-
blocks ported by a controller is shown in the Statistics pane.
For ECY Series controllers: see Supported number of BACnet objects with an
ECY Series controller.
Related blocks Calendar (ECB & ECY Series), Real Time Clock (ECB & ECY Series)
Input(s) N/A
Output(s)
Port Type Range Description
Current State Digital 0 or 1 Current scheduled status state as provided by
the building controller.
Unsigned 0 to 4294967296
Integer -2147483648 to
2147483648
Real ±
Enum () 0 to 4294967296
1106 EC-gfxProgram
Port Type Range Description
NextState Digital 0 or 1 Next scheduled status state as provided by
the building controller.
Unsigned 0 to 4294967296
Integer -2147483648
to2147483648
Real ±∞
Enum () 0 to 4294967296
TimeToNext Numeric 0 to 3.4028×1038 Time (in minutes) to the next status state. -1
State means that the schedule is not currently
configured or its Effective Period is not
active.
Number Integer See description The block number.
OutOfService Digital 0 or 1 See Out-of-Service.
Fault Digital 0 or 1 This indicates that the currently configured
schedule in the controller is incorrectly
configured. This is logically True (1) if the
Reliability property does not have a value of
No Fault Detected, otherwise logical False
(0).
Reliability Enum See Description This indicates that the currently configured
schedule in the controller is incorrectly
configured. See Reliability property.
Block properties See also Common block properties.
Property Type Range Default Description
Number Menu See Schedule 1 Use this drop-down menu to select an
Description instance of this block. See Number of blocks
for the number of block instances supported
by the current controller model.
NOTE: When a new block instance is added
to the Programming Sheet, the block’s
number is incremented to the next
available block number according to
the current Auto Increment setting.
See Auto increment (ECP & ECL
Series and EBC Series controllers
only) or Auto increment (ECY Series
controllers only).
EC-gfxProgram 1107
Configuring a The following configuration methods are available to create, edit, and transfer
schedule on the schedule information into a controller:
EC-Net Station
(ECB Series) • By configuring both calendars and schedules with the Calendar and
Schedule Tool by launching it from EC-gfxProgram. See Calendar and
Schedule Tool (ECL, ECB & ECY Series).
• By configuring both calendars and schedules with the Calendar and
Schedule Tool by launching it from the desktop (this is called standalone
mode). See Calendar and Schedule Tool (ECL, ECB & ECY Series).
• By configuring both calendars and schedules in EC-Net. This configura-
tion method is shown below.
When a EC-Net building controller is used, it is best to configure both calen-
dars and schedules in EC-Net so that they are centralized for use by all parts
of the control network and by more than one controller. When a controller is
equipped with an operator’s interface / ECx-Display (color LCD screen),
changes made in the controller to calendars and schedules are synchronized
with EC-Net. For this to work:
• The controller must have the latest firmware downloaded into it. See
Upgrade firmware (for ECL Series or ECB Series controllers only).
• EC-Net must have the latest support pack installed.
• The controller object must be in a BcpBacnetNetwork.
When a EC-Net building controller is not available, use the Calendar and
Schedule Tool. See Calendar and Schedule Tool (ECL, ECB & ECY Series).
Use only one configuration method at a time to avoid conflicts between
scheduling methods (see Figure 733). It is sometimes possible to change
from one configuration method to the other without losing previously created
schedules.
Preferred The general order in which you should configure schedules and calendars is:
schedule and
calendar 1. Set the controller’s real time clock through the time synchronization ser-
configuration vice. See Configuring time synchronization with EC-Net.
order (ECB 2. Configure the schedules (see below).
Series)
3. Optionally configure the calendars (see Creating Calendars in EC-Net
(ECB Series)), and then link a calendar to a schedule (see Linking a cal-
endar to a schedule in EC-Net (optional - ECB Series)). See also Using
Schedules and Calendars.
Method to create When the controller has no calendars in it, calendars can be created in EC-
schedules in EC- Net by following the Creating Calendars in EC-Net (ECB Series) procedure to
Net (ECB Series) create them.
1108 EC-gfxProgram
Creating When the Schedule block is added to a Programming Sheet in EC-gfxPro-
schedules in EC- gram, and the project is synchronized with the controller, a corresponding
Net (ECB Series) Schedule is created in the EC-Net database for this controller. In this configu-
ration mode, this schedule must then be configured in EC-Net.
NOTE: When you remove a Schedule Block from the Programming Sheet, it
remains exposed to the BACnet network. To stop exposing this BAC-
net object to the network, use the EC-gfxProgram Synchronization
feature with the Clear schedule’s configuration option selected. See
Project Synchronization for more information.
Configure the Schedule in the EC-Net station as follows.
1. Set the controller’s real time clock through the time synchronization ser-
vice. See Configuring time synchronization with EC-Net.
2. In EC-gfxProgram, add a Schedule Block to the Programming Sheet
with appropriate (Monitor) blocks connected to its outputs.
Figure 623: Schedule blocks on a programming sheet
3. Right-click the schedule block and select Build Schedule. The calendar
and schedule tool opens. For more information about the calendar and
schedule tool, see Calendar and Schedule Tool (ECL, ECB & ECY
Series).
Figure 624: Building the schedule in EC-gfxProgram’s schedule block
4. In Edit, select Change Schedule Type.
EC-gfxProgram 1109
5. In the Change Schedule Type window, set the Type to Boolean. Click
OK.
6. In the Schedule Default Value, deselect Null, and set Value to False.
7. Optional: Create a schedule that will be imported into EC-Net.
8. If you are using more than one schedule instance in your code, use the
schedule / calendar instance selector to select these other schedule
instances and set the type to Boolean and the default value to false for
each of these schedules. See Schedule/Calendar instance selector.
9. Send the schedule to the device. Select File > Save > Send to device.
1110 EC-gfxProgram
10. Close the calendar and schedule tool.
11. Synchronize the project with the controller. Set the following synchroniza-
tion options: Send schedule’s configuration and Compile code and
send it to device. See Project Synchronization for more information.
12. In EC-Net, log into the station.
13. Create a EC-Net based Schedule anywhere on the Station that will be
used to link to the controller’s Schedule: Right-click a node in the Nav tree
and select Views, Wire Sheet.
Figure 625: Open a Wire Sheet
14. Click the Open Palette button in the Palette side bar to open the Open
Palette selection window.
NOTE: If the Palette side bar is not open in the Side Bar Pane, click Win-
dowsSide Bars Palette to add the Palette side bar.
EC-gfxProgram 1111
15. Select schedule from the Open Palette selection window and click OK.
This will add the schedule palette to your Palette side bar.
Figure 626: Open Palette window: selecting schedule
16. From the schedule Palette, drag a BooleanSchedule object to the Wire
Sheet.
17. Name the EC-Net based schedule and click OK. The schedule will be
configured in a later step.
18. Right-click the EC-Net based schedule and select Copy to copy this
schedule’s Ord.
1112 EC-gfxProgram
19. Double-click Schedules under the controller.
20. Select the Bacnet Schedule Export Manager.
EC-gfxProgram 1113
21. Click Discover to find all Schedule and Schedule Blocks that have been
synchronized with the controller.
22. Drag the discovered Schedule into the Database. This imports the sched-
ule’s configuration from the device during schedule creation.
An alternate method to add the schedule that allows you to select the
schedule’s source. Select the discovered schedule and use the one of the
new Add button options: Click the list arrow next to Add to select the
Device option and then click Add.
Figure 627: Adding a schedule to the database
Parameter Description
Device When initially configuring a schedule, you must use this
option. Choose this option to import the schedule’s
configuration from the device during schedule creation.
1114 EC-gfxProgram
Parameter Description
Niagara Choose this option to keep the EC-Net database’s
configuration for the schedule.
23. Paste the EC-Net based schedule’s Ord into Supervisor Ord: select the
text in Supervisor Ord and press <ctrl>-v.
24. Set the Execution Time to Daily at 1 AM with a Randomization interval
of 5 minutes.
NOTE: The schedule is synchronized with the device every time you modify
and save it. We recommend setting a daily schedule synchronization
so the schedule will be automatically pushed into the controller should
the controller have to be replaced for maintenance purposes. Setting
this to once daily helps to minimize network traffic.
25. Set the schedule’s Name and click OK.
26. Enable the schedule to write to the BACnet object by selecting the sched-
ule in the Database and click Edit.
EC-gfxProgram 1115
27. Set the Skip Writes parameter: Click .
28. Set the priorityForWriting to true. Click OK.
Figure 628: Setting the Skip Writes parameter values
29. Click Save.
30. Make the Schedule operational: Right click the schedule in the database
and select Actions, Execute.
1116 EC-gfxProgram
31. Verify that the schedule is operational. Double-click the controller’s
schedule. Check that Fault Cause is blank, Out Of Service is false, and
the time of the Last Success is a minute ago.
If necessary, Set the Skip Writes parameter: Click and set the pri-
orityForWriting to true (see Figure 628). Click OK.
Figure 629: Verify the schedule‘s operation
32. Double-click the EC-Net based schedule’s configuration.
EC-gfxProgram 1117
Adding events to Configure the new schedule as necessary for the controller. When done, click
the schedule Save. Add events to the schedule as follows.
(ECB Series)
Figure 630: Configuring the schedule in the Weekly Schedule tab
There are four major elements in the Scheduler interface, separated by tabs
in the view.
Parameter Description
Weekly Defines the regular (repeating) day-of-week schedule
Schedule events for each day of the week. Click and drag your
mouse on a day to select a time period for an event.
Special Events Special events override (and interact with) events in the
normal weekly schedule. A reference to a calendar can
also be made.
Properties Define the schedule's effective period, default output,
facets, and whether automatic special-event cleanup
occurs.
Summary Shows months with selectable days, including all
schedule event activity for any day selected.
NOTE: For more information about how to configure a schedule in EC-Net,
refer to the EC-Net User Guide normally found in \Niagara\[Niagara
Station & version]\docs\docUser on the C: drive or press F1 on the
keyboard.
A schedule’s configuration is automatically pushed into the controller when
you click Save.
1118 EC-gfxProgram
After having configured the schedules, you can optionally configure the calen-
dars if needed. See Calendar (ECB & ECY Series). If you configure a calen-
dar, link it to a schedule with the following procedure.
Linking a A calendar is linked to a schedule in EC-Net so that the calendar can override
calendar to a the weekly schedule. This is used for example, for holiday or vacation sched-
schedule in EC- ules where the same calendar is reused for both holiday and vacation sched-
Net (optional - ules. Only a limited number of schedule special events can be saved on a
ECB Series) controller. It is more efficient to reuse a calendar in this way as it saves space
to allow for more schedule special events. This procedure assumes a sched-
ule has been previously configured in EC-Net; to do so, see Configuring a
Calendar on the EC-Net Station (ECB Series).
1. Double-click BooleanSchedule in the Nav tree and select the Special
Events tab.
Figure 631: Configuring a special event in a calendar
2. Add a special event: Click .
EC-gfxProgram 1119
3. Give the special event a Name and set the Type to Reference. Select the
calendar this event is to reference in Calendars drop-down list of avail-
able calendars: make sure to click the appropriate calendar reference so
that it is highlighted. Click OK.
Figure 632: Selecting the calendar for this event (click it with your mouse)
NOTE: Make sure that the calendar that you select is one that is exported to
the device (as created in the procedure above). Do not select a EC-
Net stand alone calendar.
4. Set the duration for this event and the output (in Event Output) for this
event. For example, if this event is for the entire day, set the Event Start
to 12:00 AM and the Event Finish to 12:00 AM, then set the Event Out-
put to False (first deselect null).
Figure 633: Setting the event duration and output
5. Click Save. A schedule’s configuration is automatically pushed into the
controller when you click Save.
1120 EC-gfxProgram
Start Delay
Description Used to provide a delay after a rising edge (Off-to-On transition) before turn-
ing the output On. The input must remain On for the duration of the delay
before the block’s output will be turned On.
The current time unit configured through the TimeBase property in the Prop-
erties pane is shown at the bottom of the block as shown below.
TimeBase Setting
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
32-Bit 8-Bit
Input Digital 0 or 1 Block input.
Delay Integer 0 to 3×1038s 0 to 65535s The minimum time that the input
must stay On before the output is
0 to 1092.25m0
0 to 5×1036m turned On. The units are set in
to 18.20h
TimeBase of the block’s properties.
0 to
8.3333×1034h
EC-gfxProgram 1121
Port Type Range Description
32-Bit 8-Bit
Enable Digital 0 or 1 When set to On (1), the block will be
enabled and the output will follow
the Delay timer. If set to Off (0) then
the output will directly follow the
input.
Output(s)
Port Type Range Description
32-Bit 8-Bit
Output Digital 0 or 1 The output value of the block.
RemTime Integer 0 to 3×1038s 0 to 65535s Count-down timer of the Delay
remaining time, triggered on the
0 to 1092.25m
0 to 5×1036m rising edge of the Input.
0 to 18.20h
0 to
8.3333×1034h
Block properties See also Common block properties.
Property Type Range Default Description
TimeBase Menu See Second Select the unit of time: Second, Minute or
Description Hour.
NOTE: The TimeBase unit affects the
value range of Delay.
If the TimeBase is set to minutes,
59 seconds will be shown as 0.98
minutes.
If the TimeBase is set to seconds,
you must enter a value of 1 sec-
ond or more.
1122 EC-gfxProgram
Example The Start Delay block is used to delay turning On an output by a defined time
period. The example below shows how the increase (Variable Numeric (ECP
Series), Switch, Add, and Internal constant blocks) of the Effective Static
Pressure Setpoint (Variable Numeric block) is delayed (Start Delay and
Internal Constant blocks) when one of the dampers (Network Variable
Input block) is open more than 90% (Greater or Equal and Internal Constant
block).
Figure 634: Start Delay block
The Start Delay block receives an On Input when it is outputting an Off value
and when one of the dampers is greater than 90%. If after 3 minutes, the Start
Delay block is still receiving an On Input, it will Output an On value and start
increasing the Effective Static Pressure Setpoint (Variable Numeric block) by
0.1”WC.
Start delay block If no Input to a Start Delay block is Null, then the block’s output is the normal
operations with result. If one or more Inputs to a Start Delay block are Null, then the Output of
Null the Start Delay block is always False (0).
EC-gfxProgram 1123
Start Stop Delay
Description Used to provide a delay after a rising edge (Off-to-On transition) before turn-
ing the output On and/or after a falling edge (On-to-Off transition) before turn-
ing the output Off. The input must remain On for the duration of the start delay
before the block’s output will be turned On. The input must remain Off for the
duration of the stop delay before the block’s output will be turned Off.
The current time unit configured through the TimeBase property in the Prop-
erties pane is shown at the bottom of the block as shown below.
TimeBase Setting
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
32-Bit 8-Bit
Input Digital 0 or 1 Block input.
1124 EC-gfxProgram
Port Type Range Description
32-Bit 8-Bit
StartDelay Integer 0 to 3×1038s 0 to 65535s The minimum time that the input
must stay On before the output is
0 to 1092.25m
0 to 5×1036m turned On. The units are set in
0 to 18.20h TimeBase of the block’s properties.
0 to
8.3333×1034h
StopDelay Integer 0 to 3×1038s 0 to 65535s The minimum time that the input
must stay Off before the output is
0 to 1092.25m
0 to 5×1036m turned Off.
0 to 18.20h
0 to
8.3333×1034h
Enable Digital 0 or 1 When set to On (1), the block will be
enabled and the output will follow
the StartDelay and StopDelay
timers. If set to Off (0) then the
output will directly follow the input.
Output(s)
Port Type Range Description
32-Bit 8-Bit
Output Digital 0 or 1 The output value of the block.
RemTime Integer 0 to 3×1038s 0 to 65535s Count-down timer of the:
0 to 1092.25m • StartDelay remaining time, trig-
0 to 5×1036m
gered on the rising edge of the
0 to 18.20h
0 to Input.
8.3333×1034h • StopDelay remaining time, trig-
gered on the falling edge of the
Input.
EC-gfxProgram 1125
Block properties See also Common Block Properties.
Property Type Range Default Description
TimeBase Menu See Second Select the unit of time: Second, Minute or Hour.
Description
NOTE: The TimeBase unit affects the value
ranges of StartDelay and StopDelay.
If the TimeBase is set to minutes, 59
seconds will be shown as 0.98 minutes.
If the TimeBase is set to seconds, you
must enter a value of 1 second or more.
Example See the Example in the Start Delay block section.
Start Stop Delay If no Input to a Start Stop Delay block is Null, then the block’s output is the
block operations normal result. If one or more Inputs to a Start Stop Delay block are Null, then
with Null the Output of the Start Stop Delay block is always Null.
Stop Delay
Description Used to provide a delay after a falling edge (On-to-Off transition) before turn-
ing the output Off. The input must remain Off for the duration of the delay
before the block’s output will be turned Off.
The current time unit configured through the TimeBase property in the Prop-
erties pane is shown at the bottom of the block as shown below.
1126 EC-gfxProgram
TimeBase Setting
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
32-Bit 8-Bit
Input Digital 0 or 1 0 or 1 Block input.
Delay Integer 0 to 3×1038s 0 to 65535s The minimum time that the input
must stay Off before the output is
0 to 1092.25m
0 to 5×1036m turned Off. The units are set in
0 to 18.20h TimeBase of the block’s properties.
0 to
8.3333×1034h
Enable Digital 0 or 1 0 or 1 When set to On (1), the block will be
enabled and the output will follow
the Delay timer. If set to Off (0) then
the output will directly follow the
input.
Output(s)
Port Type Range Description
32-Bit 8-Bit
Output Digital 0 or 1 The output value of the block.
RemTime Integer 0 to 3×1038s 0 to 65535s Count-down timer of the Delay
remaining time, triggered on the
0 to 1092.25m
0 to 5×1036m falling edge of the Input.
0 to 18.20h
0 to
8.3333×1034h
EC-gfxProgram 1127
Block properties See also Common block properties.
Property Type Range Default Description
TimeBase Menu See Second Select the unit of time: Second, Minute or
Description Hour.
NOTE: The TimeBase unit affects the value
range of Delay.
If the TimeBase is set to minutes, 59
seconds will be shown as 0.98 min-
utes.
Stop Delay block If no Input to a Stop Delay block is Null, then the block’s output is the normal
operations with result. If one or more Inputs to a Stop Delay block are Null, then the Output of
Null the Stop Delay block is always False (0).
Timer (ECP Series)
Description Used to time an event, process, activity, etc. such as the amount of time that a
piece of equipment has been running.
Number of The number of Timer block instances supported by a controller is shown in the
blocks Number drop-down list in the Properties Pane or in the Statistics pane.
Advanced Copy From, Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
Input Digital 0 or 1 Block input. If On (1), the timer is started. If Off (0), the
timer is stopped.
Reset Digital 0 or 1 Enabling this input (1) will reset the output to 0.
Output(s)
Port Type Range Description
Output Integer 0 to 65535 The time count. The time count will stop automatically
when the range limit is reached.
1128 EC-gfxProgram
Block properties See also Common block properties.
Property Type Range Default Description
IntervalType Menu See Second Select the unit of time: Second, Minute, or
Description Hour.
Number Menu See Timer 1 Use this drop-down menu to select an
Description instance of this block. See Number of blocks
for the number of block instances supported
by the current controller model.
NOTE: When a new block instance is added
to the Programming Sheet, the
block’s number is incremented to
the next available block number
according to the current Auto Incre-
ment setting. See Auto increment
(ECP & ECL Series and EBC Series
controllers only).
Persist Menu See False When this option is True, the output value is
Description preserved during any type of reset.
Timer (ECL Series)
Description Used to time an event, process, activity, etc. such as the amount of time that a
piece of equipment has been running.
Configuration The current time unit configured in the Advanced configuration is shown at the
type bottom of the block as shown below.
Time Configuration
Number of The number of Timer block instances supported by a controller is shown in the
blocks Number drop-down list in the Properties or Statistics panes.
Persistence The current value is persistent; this allows a value to be saved during a con-
troller power cycle or reset. See Persistent values (ECL, ECB & ECY Series
controllers).
EC-gfxProgram 1129
Advanced Resources Configuration, Advanced configuration, Find All References (ECL,
configuration ECB & ECY Series), Copy From, Configure Ports, Show/Hide Ports
Related blocks Generic Timer (ECL Series)
Input(s)
Port Type Range Description
Input Digital 0 or 1 Block input. If On (1), the timer is started. If Off (0), the
timer is stopped.
InitValue Numeric 0 to Sets the starting value of the timer. The units are set in
429496736 Time base in the Advanced configuration.
Reset Digital 0 or 1 Enabling this input (1) will reset the output to the
InitValue value.
Output(s)
Port Type Range Description
Output Numeric 0 to The time count. The time count will stop automatically
429496736 when the range limit is reached.
Number Integer – The current block number.
Block properties See also Common block properties.
Property Type Range Default Description
Number Menu See Timer 1 Use this drop-down menu to select an
Description instance of this block. See Number of blocks
for the number of block instances supported
by the current controller model.
NOTE: When a new block instance is added
to the Programming Sheet, the
block’s number is incremented to
the next available block number
according to the current Auto Incre-
ment setting. See Auto increment
(ECP & ECL Series and EBC Series
controllers only).
Persist Menu See False When this option is True, the output value is
Description preserved during any type of reset. See
Persistent values (ECL, ECB & ECY Series
controllers).
1130 EC-gfxProgram
Advanced Configuration parameters for this block are set in the Resources Configura-
configuration tion window to set the timer’s direction and time base.
Figure 635: Timer Configuration window
Parameter Description
Object name The block’s resource name.
Timer direction Select the direction of the timer: to count-up or to count-
down.
Time base Select the unit of time: Seconds, Minutes, Hours, or
Days.
Timer (ECB & ECY Series)
Configuration The current time unit configured in the Advanced configuration is shown at the
type bottom of the block as shown below.
Time Configuration
Number of For ECB Series controllers: The number of Timer block instances supported
blocks by a controller is shown in the Number drop-down list in the Properties or Sta-
tistics panes.
For ECY Series controllers: see Supported number of BACnet objects with an
ECY Series controller.
Persistence The current value is persistent; this allows a value to be saved during a con-
troller power cycle or reset. See Persistent values (ECL, ECB & ECY Series
controllers).
Advanced Resources Configuration, Advanced configuration, Find All References (ECL,
configuration ECB & ECY Series), Copy From, Configure Ports, Show/Hide Ports
EC-gfxProgram 1131
Related blocks Generic Timer (ECB & ECY Series)
Input(s)
Port Type Range Description
Input Digital 0 or 1 Block input. If On (1), the timer is started. If Off (0), the
timer is stopped.
InitValue Numeric 0 to Sets the starting value of the timer. The units are set in
429496736 Time base in the Advanced configuration.
Reset Digital 0 or 1 Enabling this input (1) will reset the output to the
InitValue value.
Output(s)
Port Type Range Description
Output Numeric 0 to The time count. The time count will stop automatically
429496736 when the range limit is reached.
Number Integer See The block number.
description
Block properties See also Common block properties.
Property Type Range Default Description
Number Menu See Timer 1 Use this drop-down menu to select an
Description instance of this block. See Number of blocks
for the number of block instances supported
by the current controller model.
NOTE: When a new block instance is added
to the programming sheet, the
block’s number is incremented to
the next available block number
according to the current Auto incre-
ment (ECP & ECL Series and EBC
Series controllers only) or Auto
increment (ECY Series controllers
only).
Persist Menu See False When this option is True, the output value is
Description preserved during any type of reset. See
Persistent values (ECL, ECB & ECY Series
controllers).
1132 EC-gfxProgram
Advanced Configuration parameters for this block are set in the Resources Configura-
configuration tion window to set the timer’s operating parameters.
Figure 636: Timer Configuration window
Parameter Description
Object name BACnet object’s name by which this timer is identified
on the BACnet network.
The block’s resource name in Object name and an
optional description in Description. For certain
objects, the block’s resource name is exposed on the
BACnet network as the BACnet object name.
Description (ECY An optional description for this object.
Series only)
Timer direction Select the direction of the timer: to count-up or to
count-down.
Time base Select the unit of time: Seconds, Minutes, Hours, or
Days.
For ECY Series controllers, see also Resources Configuration.
EC-gfxProgram 1133
Tools
Tools are blocks that are used to help program developers keep their project
code organized.
The following blocks are available in this category:
• Live Trend Log
• Monitor
• Reference Hub
• Reference Target
• Text
1134 EC-gfxProgram
Live Trend Log
Description Shows a variable’s trend or variation with respect to another variable or to
time. This block is ideal for analyzing cause and effect within a controlled sys-
tem, and for debugging.
For example, use Live Trend Log to view the performance of a process by
assigning one or more control variables to the Y-axis and time as the X-axis.
You can then see the system response.
NOTE: The Live Trend Log can be directly launched from the Pid Loop block.
See Pid Loop (ECL Series) and Pid Loop (ECB & ECY Series).
The Live Trend Log block is not intended to be used as an administra-
tor tool for ongoing surveillance as it consumes too many network
resources in this mode.
Network variable data is refreshed according to their minimum send time.
Care should be taken when interpreting the results shown by Live Trend Log
due to these delays, and its impact on data correlation.
Advanced Viewing a Live Trend Log, Configure Ports, Show/Hide Ports
configuration
Related blocks Pid Loop (ECL Series), Pid Loop (ECB & ECY Series)
Input(s)
Port Type Range Description
32-Bit 8-Bit
XValue Numeric ±3.4028×1038 -83886.08 to Horizontal deflection input. This
+83886.07 input is available only when the
property TimeBaseLog is set to
False.
YValue Numeric ±3.4028×1038 -83886.08 to Vertical deflection input.
+83886.07
Yx
NOTE: By default, one input is
(x=1 to 4) available. More inputs can
be added through the Num-
berOfInputs in the Block’s
Properties pane.
EC-gfxProgram 1135
Output(s) Live plot of X and Y-axes data is graphed in a separate window. See Viewing
a Live Trend Log.
Block properties See also Common block properties.
Property Type Range Default Description
32-Bit 8-Bit
LogInterval Numeric ±3.4028×1038 -83886.08 to 1000 The data point refresh
+83886.07 rate of the graph (in
milliseconds).
NumberOf Integer 1 to 4 1 The number of trend input
Inputs values to plot.
TimeBase Menu True or False True When set to True, the X-
Log axis advances in time
(seconds). When set to
False, the X-axis is
controlled by the XValue
input.
Viewing a Live Trend Log
View a Live Trend Log as follows.
1. Connect the inputs of the Live Trend Log block to the outputs of blocks
that are to be measured.
2. To send a project to the device, click the Build And Send button on the
Home ribbon, Project buttons or synchronize the project with the device,
click Synchronize (see Synchronizing a project with a device).
3. Debugging a Project; click the Start button on the Home ribbon, Debug-
ging buttons.
1136 EC-gfxProgram
4. Double-click the Live Trend Log block.
Figure 637: Live Trend Log overview (project in Debug mode)
Scrollbar Trend Point Series Ribbon Bar: Trend
Inspection and Data Points Home Tab Legend
Details
Click a Trend Legend to bring the selected trend forward and to change the
scale of the X and Y-axes to that of the selected trend.
Trend point By hovering your mouse in the Live Trend Log will highlight the data point, the
inspection and value of which is shown in the lower left corner.
data details
EC-gfxProgram 1137
Live Trend Log Home ribbon buttons
The Live Trend Log’s Home ribbon has buttons for view magnification (zoom),
View, Style, and Align.
Parameter Description
Zoom In Magnifies the scale of the Y-axis when the Change
(Vertical) Value Range is set to a value (found under Range and
Zoom).
Zoom In Magnifies the scale of the X-axis.
(Horizontal)
Range and Auto Range: This dynamically scales the Y-axis
Zoom according to the range of data values being plotted. This
disables the Zoom In (Vertical) button.
Change Value Range: This sets a fixed range for the Y-
axis on which data will be plotted.
Zoom Out Shrinks the scale of the Y-axis when the Change Value
(Vertical) Range is set to a value (found under Range and
Zoom).
Zoom Out Shrinks the scale of the X-axis.
(Horizontal)
Previous View Goes back to the previous zoom level.
Next View Goes forward to the previous zoom level.
Initial View Goes to the default zoom level.
Pause Pauses the scrolling of the X-axis.
Clear All Series Clears all plotted trend data.
Data
Show/Hide Show/hide the plotted trend data for a Y-axis input.
Change Color Change Background Color: Sets the background color
of the trend plot.
Change Series Color: Sets the color of a Y-axis input.
Line Weight Sets the line thickness of Y-axis input trend plot line and
of the trend plot’s X and Y-axes.
Line Pattern Sets the trend plot line’s type (solid, dash, dot) of a Y-
axis input.
1138 EC-gfxProgram
Parameter Description
Line Style Sets the trend plot line’s Y-axis presentation style:
Curve: Smooths the trend plot line’s data points to
create a continuous presentation.
Line: Plot a straight line between data points. This is the
most accurate viewing mode available.
Step: Plot the data points in discrete steps.
Point Pattern Show Series Points: Marks the raw data points on the
plot with symbols. See Figure 637.
Axis Auto Align Axis: Automatically sets the Y-axis the
display is to center on.
Align Axis by Value: Sets the Y-axis trend the is to
center on.
Show Multiple Vertical Axes: Shows a scaled Y-axis
for each trend.
Live Trend Log Tools ribbon buttons
The Live Trend Log’s Tools ribbon has buttons to import and export Live
Trend Log configuration information, export trend plot data, and set the Live
Trend Log’s configuration.
Parameter Description
Import Loads a previously saved Live Trend Log’s configuration
Configuration file.
from File
Export Saves the current Live Trend Log’s configuration to a file
Configuration on your PC.
from File
Export Data to Saves the current Live Trend Log’s data to a CSV file on
File your PC. This file can be opened by most spreadsheet
software.
EC-gfxProgram 1139
Parameter Description
Setting Configure: When the Live Trend Log is launched from
the Pid Loop block: this allows you to change the Pid
Loop block’s advanced configuration parameters on the
fly so as to allow you to tune the PID loop’s response.
This is available when the parameter’s value has not
been set at any instance of the Pid Loop block’s
corresponding input port. See Pid Loop (ECL Series)
and Pid Loop (ECB & ECY Series) for an explanation of
the parameters shown.
Change Setpoint: When the Live Trend Log is launched
from the Pid Loop block (ECL, ECB & ECY Series
controllers only): this allows you to temporarily override
the PID loop’s setpoint input. Doing so allows you to
view the system response to the current PID loop
parameters.
Show Legend: When set, this shows the legend for
each of the Live Trend Log’s Y-axis inputs. See Figure
637.
Show Scrollbar Only When Mouse Enters: When set,
this shows the scrollbar only when your mouse pointer is
within the Live Trend Log window. See Figure 637.
Show Multiple Horizontal Axis: Shows a scaled X-axis
for each trend.
Show Multiple Vertical Axes: Shows a scaled Y-axis
for each trend.
Change Maximum Count: The number of data points
per trend to be recorded (memory depth) before the data
is discarded (first in, first out).
1140 EC-gfxProgram
Monitor
Description Used to monitor values in the program. It is primarily used to debug project
code or to provide connections to block outputs that require connections (see
Connection Rules).
Quickly add a Monitor to an output port of a block, right-click the output port
and select Link to in the list and then Monitor.
Quickly add Monitor blocks to all unconnected output ports of one or more
selected blocks as follows:
• Press Ctrl+Space.
• Right-click the top title area of the block and select Monitor All. See Fig-
ure 138.
Advanced Configure Ports, Show/Hide Ports
configuration
Input(s)
Port Type Range Description
32-Bit 8-Bit
Input Numeric ±3.4028×1038 -83886.08 to Block input.
+83886.07
Output(s) N/A
Block properties See also Common block properties.
Property Type Range Default Description
Watch String Unlimited – When set with a name, the current value of
Variable the Monitor is shown in the Watch List during
debugging. See Watch List.
EC-gfxProgram 1141
Reference Hub
Description Used with Reference Target blocks to keep the Programming Sheet clean,
that is, without too many connectors and thus easier to see where connec-
tions are going. It also allows blocks on different documents to be connected.
A shortcut allows a block’s output to be quickly connected to a Reference
Hub. See Connection via references.
Double-clicking a Reference Hub (or right-click and select Find All Refer-
ences (ECL, ECB & ECY Series)) finds all Reference Target blocks that are
connected to the Reference Hub.
Advanced Find All References (ECL, ECB & ECY Series)
configuration
Input(s) N/A
Output(s) N/A
Block properties See also Common block properties.
Property Type Range Default Description
TagName String Unlimited - Reference tag name to link to target.
NOTE: When Assign tag name to linked reference hub is set in the Tools
menu, EC-gfxProgram Options screen, linking to a Reference Hub
block will automatically assign to it the name the source block being
linked.
If the name for the Reference Hub block already exists, an automati-
cally incremented number is added to the end of the block name.
1142 EC-gfxProgram
Reference Target
Description Used with Reference Hub blocks to keep the Programming Sheet clean, that
is, without too many connectors and thus easier to see where connections are
going. It also allows blocks on different documents to be connected.
A shortcut allows a block’s input to be quickly connected to a Reference Tar-
get. See Connection via references.
Double-clicking a Reference Target (or right-click and select Go To Source)
finds the Reference Hub block that is connected to the Reference Target.
Advanced Go To Source
configuration
Input(s) N/A
Output(s) N/A
Block properties See also Common block properties.
Property Type Range Default Description
TagName Menu See - Select a tag name to link target to the
Description desired hub.
Go To Source Go To Source highlights the Reference Hub block linked to the Reference
Target block, or by double-clicking the Reference Target block. These two
blocks are linked by Tag Names.
NOTE: This advanced configuration is accessible directly through the Refer-
ence Target block.
EC-gfxProgram 1143
Text
Description Used to write comments or explanations about the program. Can type across
multiple lines and can copy-paste text from other sources, documents, etc.
Formatting from the source document may be preserved when the UseRTF
Property is set to True. See About RTF Text.
NOTE: The block will not consume any project code space. However, it will
increase the size of the project code backup on the controller.
Input(s) N/A
Output(s) N/A
Block properties See also Common block properties.
Property Type Range Default Description
Alignment Menu See Left The text alignment. Select Left, Right,
Description or Center.
BackColor Menu See Transparent Select the background color.
Description
BackColor Menu See Solid Select the background color style: Solid
Style Description or Gradient. When set to Gradient, the
color blends from the BackColor color
to the GradientColor.
BorderColor Menu See Black Select the border color.
Description
BorderDash Menu See Solid Select the border type: Solid or one of
Style Description many broken line styles.
BorderVisible Menu See False Select the border to be visible (True) or
Description not (False).
BorderWidth Integer 1 to 10 1 The line weight of the border.
CornerStyle Menu See Square Select the corner type: Round or
Description Square.
Description String Unlimited – Description of the block.
1144 EC-gfxProgram
Property Type Range Default Description
Fonta String – Arial, 7pt Place your mouse cursor over this field
and click the button in the Font field
to set the font type, style, size, and
effects. (or expand with the + to modify
the Font components).
Font Namea Menu See Arial Select the font type.
Description
Font Sizea Integer – 7 The font size.
Font Bolda Menu See False Select the font to be bold (True) or not
Description (False).
Font Italica Menu See False Select the font to be italic (True) or not
Description (False).
Font Menu See False Select the font to be underlined (True)
Underlinea Description or not (False).
Font Menu See False Select the font to be strikeout (True) or
Strikeouta Description not (False).
ForeColora Menu See Black Select the font face color.
Description
Gradient Menu See White Select the second color when
Colora Description BackColorStyle is set to Gradient.
Texta String Unlimited – Text of the block. Place your mouse
cursor over this field and click the
button in the Text field to type text
across multiple lines.
UseRTF Menu See False When set to True, you can paste
Description formatted text into the Text Block. See
About RTF Text, below.
When set to False, only plain text is
supported with the formatting set in the
Properties above that are uniformly
applied to all text content.
a. These properties are only available when UseRTF is set to False.
EC-gfxProgram 1145
About RTF Text RTF Text content can be copied from design documents (created in a word-
processing program) including pictures (created in a drawing program) and
pasted into the Text block when the UseRTF property is set to True. The for-
matting of pasted text will be preserved as best as possible, especially when
the source text comes from a word-processing program that supports rich text
format when copying and pasting.
The text box can be resized by the reshape handles located on the border of
the Text block.
NOTE: Do not add too many pictures if you intend to backup the project code
to the controller.When the Backup code to device option is selected
during Project Synchronization, all RTF Text content will be backed up
to the controller, including pictures.
Pictures can especially take a lot of memory space on the controller.
One solution is to first reduce picture size by using the compress pic-
tures feature (if available) in your word-processing program before
copying content to the Text Block.
1146 EC-gfxProgram
VAV
VAV blocks are used to interface with the flow sensor and actuator of a pro-
grammable VAV controller for single-duct and dual-duct applications.
The following blocks are available in this category:
• Actuator Control (ECL Series)
• Actuator Control (ECB & ECY Series)
• Damper Control (ECP Series)
• Diff Pressure (ECL Series)
• Diff Pressure (ECB Series)
• VAV Differential Pressure (ECY Series)
• Flow Calculation (ECL Series)
• Flow Calculation (ECB & ECY Series)
• Flow Sensor (ECP Series)
• Internal Actuator (ECL Series)
• Internal Actuator (ECB & ECY Series)
EC-gfxProgram 1147
Actuator Control (ECL Series)
Description Used to interface with the VAV controller’s damper actuator for flow control.
For a project code example of how to use this block, see Actuator Control
block example.
Advanced Resources Configuration, Configure Ports, Show/Hide Ports
configuration
Related blocks Internal Actuator (ECL Series)
Input(s)
Port Type Range Description
Flow Numeric 0 to Actual flow value read from the sensor input.
3.4028×1038
FlowSP Numeric 0 to Airflow setpoint.
3.4028×1038
MaxFlowSP Numeric 0 to The maximum flow setpoint for the VAV. Used
3.4028×1038 internally by the damper control algorithm to calculate
the next damper movement.
1148 EC-gfxProgram
Port Type Range Description
DamperResp Numeric 0 to 100 A multiplier (in %) applied to the calculated damper
movement. It is used to adjust the reaction speed of
the damper.
For example, say the controller determines that the
damper should move for 30 seconds to achieve the
desired setpoint. If the damper response is set to 20%,
the damper will move for 6 seconds (20% X 30
seconds). The controller then waits for a few seconds
and performs a new calculation to determine how
much the damper should be moved. This iterative
process prevents the damper from overshooting and
prevents hunting (oscillation). Minimizing hunting
reduces wear on the damper actuator, irregular air
flow, and variations in system noise levels.
WARNING: Do not set this input to zero or close to
zero, as little or no damper movement will
be possible (the system will be over-
damped or will become unresponsive).
If DamperResp is not linked, the default value is 15%.
DamperFeed Numeric 0 to 100 The feedback of the damper’s actual position (from the
back Internal Actuator (ECL Series)’s Damper Feedback
output port).
ControlMode Digital 0 or 1 If set to 0, damper operation is automatic. The Flow
and FlowSetPt inputs determine the appropriate
position of the damper motor (the damper position is in
equilibrium when the Flow input equals the FlowSetPt
input).
If set to 1, damper operation is manual. In this case
the internal control loop is overridden and the
DamperPos input determines the position of the
damper motor (the damper position is in equilibrium
when DamperPos output equals DamperPos Input.
If ControlMode is not linked, the default value is
0(AUTO).
DamperPos Numeric 0 to 100 Damper position override.
If DamperPos is not linked, the default value is 0%.
Output(s)
Port Type Range Description
DamperCmd Numeric 0 to 100 Damper command.
Block properties See Common block properties.
EC-gfxProgram 1149
Actuator Control The Reference Hub supplies the operating requirements for the Actuator
block example Control block. The damper feedback from the Internal Actuator (ECL
Series)’s Damper Feedback output port sends the damper’s actual position
so that the Actuator Control block can calculate the next actuator command.
Figure 638: Actuator Control block example
Actuator Control (ECB & ECY Series)
Description Used to interface with the VAV controller’s damper actuator for flow control.
Advanced Resources Configuration, Configure Ports, Show/Hide Ports, Alarms (ECB &
configuration ECY Series)
Input(s)
Port Type Range Description
Flow Numeric 0 to Actual flow value read from the sensor input.
3.4028×1038
FlowSP Numeric 0 to Airflow setpoint.
3.4028×1038
MaxFlowSP Numeric 0 to The maximum flow setpoint for the VAV. Used
3.4028×1038 internally by the damper control algorithm to calculate
the next damper movement.
1150 EC-gfxProgram
Port Type Range Description
DamperResp Numeric 0 to 100 A multiplier (in %) applied to the calculated damper
movement. It is used to adjust the reaction speed of
the damper.
For example, say the controller determines that the
damper should move for 30 seconds to achieve the
desired setpoint. If the damper response is set to 20%,
the damper will move for 6 seconds (20% X 30
seconds). The controller then waits for a few seconds
and performs a new calculation to determine how
much the damper should be moved. This iterative
process prevents the damper from overshooting and
prevents hunting (oscillations). Minimizing hunting
reduces wear on the damper actuator, irregular air
flow, and variations in system noise levels.
WARNING: Do not set this input to zero or close to
zero, as little or no damper movement will
be possible (the system will be over-
damped or will become unresponsive).
If DamperResp is not linked, the default value is 15%.
DamperFeed Numeric 0 to 100 The feedback of the damper’s actual position.
back
ControlMode Digital 0 or 1 If set to 0, damper operation is automatic. The Flow
and FlowSetPt inputs determine the appropriate
position of the damper motor (the damper position is in
equilibrium when the Flow input equals the FlowSetPt
input).
If set to 1, damper operation is manual. In this case
the internal control loop is overridden and the
DamperPos input determines the position of the
damper motor (the damper position is in equilibrium
when DamperPos output equals DamperPos Input.
If ControlMode is not linked, the default value is
0(AUTO).
DamperPos Numeric 0 to 100 Damper position override.
If DamperPos is not linked, the default value is 0%.
Output(s)
Port Type Range Description
DamperCmd Numeric 0 to 100 Damper command.
Block properties See Common block properties.
EC-gfxProgram 1151
Actuator Control The Analog Value (ECB & ECY Series) blocks supply the operating require-
block example ments for the Actuator Control block.
Figure 639: Actuator Control block example
Damper Control (ECP Series)
Description Used to interface with the VAV controller’s damper actuator for flow control.
The user can read the value of the DamperPos on the network through
nvoDamperPos. nviFlowOverride can be used to set the damper position by
specifying the state (HVO_OFF, HVO_POSITION, HVO_FLOW_VALUE,
HVO_FLOW_PERCENT, HVO_OPEN, HVO_CLOSE, HVO_MINIMUM,
HVO_MAXIMUM), the percent (if applicable) and the flow (if applicable).
Advanced Advanced configuration, Network Variable
configuration
Controller ECP Series Programmable VAV / VAVS controllers.
support
Input(s)
Port Type Range Description
Flow Numeric 0 to Actual flow value read from the sensor input.
83886.07
FlowSetPt Numeric 0 to Flow setpoint.
83886.07
This value can be read from nvoFlowSetpoint.
1152 EC-gfxProgram
Port Type Range Description
ControlMode Digital 0 or 1 If set to 0, damper operation is automatic. The Flow and
FlowSetPt inputs determine the appropriate position of
the damper motor (the damper position is in equilibrium
when the Flow input equals the FlowSetPt input).
If set to 1, damper operation is manual. In this case the
internal control loop is overridden and the DamperPos
input determines the position of the damper motor (the
damper position is in equilibrium when DamperPos
output equals DamperPos Input.
DamperPos Numeric 0 to 100.00 Damper position override.
Output(s)
Port Type Range Description
DamperCmd Numeric 0 to 100.00 Damper command.
DamperPos Numeric 0 to 100.00 Actual damper position.
This value can be read from nvoDamperPos.
Block properties See Common block properties.
Advanced The Damper Control Configuration window has all the settings required to
configuration configure a damper.
EC-gfxProgram 1153
Damper
Figure 640: Damper Control Configuration window - Damper
Parameter Description
Damper type Select whether an Internal or an External actuator is
being used. If Internal is selected, the controller’s onboard
actuator is enabled and controlled by this block. If
External is selected, the controller’s onboard actuator is
disabled, the settings in this window are grayed out, and
the device cannot be used with an external actuator.
NOTE: When an External damper type is selected, this
block can only be used to interface with certain
NVs belonging to this block.
Initialization
Parameter Description
Initialize Resets the damper position and calculates the total number
Damper of steps between the stops.
Use this option if the mechanical stops on the actuator have
been moved to limit the range of movement of the damper.
NOTE: The actuator mechanical stops should be moved
only to limit damper movement from going under 0%
or over 100%.
1154 EC-gfxProgram
Configuration
Parameter Description
Drive time Used to specify the time that the damper will take to go from
the fully closed position to the fully open position or vice-
versa.
The damper drive time can be set to between 45 seconds
and 150 seconds. However, it is recommended to use the
default value of 95 seconds for the built-in actuator (to have
the most torque and for quiet operation).
For the built-in actuator in normal control, the lower the drive
time is set, the faster the actuator will move from fully open
to fully closed and vice versa. Likewise, the higher the drive
time is set, the slower the actuator will move from fully open
to fully closed and vice versa.
Damper A multiplier (in %) applied to the calculated damper
response movement. It is used to adjust the reaction speed of the
damper.
For example, say the controller determines that the damper
should move for 30 seconds to achieve the desired setpoint.
If the damper response is set to 20%, the damper will move
for 6 seconds (20% X 30 seconds). The controller then waits
for a few seconds and performs a new calculation to
determine how much the damper should be moved. This
iterative process prevents the damper from overshooting
and prevents hunting (oscillations). Minimizing hunting
reduces wear on the damper actuator, irregular air flow, and
variations in system noise levels.
WARNING: Do not set this to zero or close to zero, as little
or no damper movement will be possible (the
system will be overdamped or will become unre-
sponsive).
The value entered in this field is written to
UCPTdamperResponse.
Direction Used to specify the direction (Clockwise or Counter
Clockwise) in which the actuator rotates to open the
damper.
EC-gfxProgram 1155
Network Variable Figure 641: Damper Control Configuration window - Network Variable
Parameter Description
Min send The minimum time period that must pass between network
time variable updates on the network for the network variable
shown immediately above. If the value of the network
variable changes, an update will only be sent after this time
expires. Setting the min send time to 0 disables it. See
Network Properties Configuration window (ECL, ECB & ECY
Series).
The min send time is often referred to as the "throttle".
Max send The maximum time period between automatic transmissions
time of the network variable on the network (whether or not the
variable’s value has changed) for the network variable
shown immediately above. Setting the max send time to 0
disables it. See Network Properties Configuration window
(ECL, ECB & ECY Series).
The max send time is often referred to as the "heartbeat".
If max receive time is configured for the corresponding
network variable output, the recommended setting for this
value is half the Max receive time value.
1156 EC-gfxProgram
Diff Pressure (ECL Series)
Description Provides the differential pressure reading from VAV controllers equipped with
a built-in differential pressure sensor.
Advanced Resources Configuration, Network Properties Configuration window (ECL,
configuration ECB & ECY Series), Configure Ports, Show/Hide Ports
Controller ECL Series VAV controllers.
support
Related blocks Flow Calculation (ECL Series)
Input(s)
Port Type Range Description
DoZero Digital 0 or 1 Used to zero the flow reading of a VAV box to allow the
calibration of the flow sensor. When set to True (1), the
differential pressure is set to zero.
Output(s)
Port Type Range Description
Output Numeric 0 to 500Pa Differential pressure reading from the VAV controller.
0 to
2inches
water
column
Block properties See Common block properties.
Example See Flow Calculation block example (ECL Series).
EC-gfxProgram 1157
Diff Pressure (ECB Series)
Description Provides the differential pressure reading from VAV controllers equipped with
a built-in differential pressure sensor.
Advanced Network Properties Configuration window (ECL, ECB & ECY Series), Config-
configuration ure Ports, Show/Hide Ports
Controller ECB Series VAV controllers.
support
Related blocks Flow Calculation (ECB & ECY Series)
Input(s)
Port Type Range Description
DoZero Digital 0 or 1 Used to zero the flow reading of a VAV box to allow the
calibration of the flow sensor. When set to True (1), the
differential pressure is set to zero.
Output(s)
Port Type Range Description
Output Numeric 0 to 500Pa Differential pressure reading from the VAV controller.
0 to
2inches
water
column
Block properties See Common block properties.
Example See Flow Calculation Block Example.
1158 EC-gfxProgram
VAV Differential Pressure (ECY Series)
Description Provides the differential pressure reading from VAV controllers equipped with
a built-in differential pressure sensor.
Advanced Resources Configuration, Find All References (ECL, ECB & ECY Series),
configuration Copy From, Configure Ports, Show/Hide Ports, Alarms (ECB & ECY Series)
(ECY Series only)
Controller ECY Series VAV controllers.
support
Related blocks Flow Calculation (ECB & ECY Series)
Input(s)
Port Type Range Description
DoZero Digital 0 or 1 Used to zero the flow reading of a VAV box to allow the
calibration of the flow sensor. When set to True (1), the
differential pressure is set to zero.
Output(s)
Port Type Range Description
Output Numeric 0 to 500Pa Differential pressure reading from the VAV controller.
0 to
2inches
water
column
Block properties See Common Block Properties.
Example See Flow Calculation block example.
EC-gfxProgram 1159
Flow Calculation (ECL Series)
Description Used to calculate the airflow based on the differential pressure according to
the following formula: Flow = KFactor √.
Advanced Configure Ports, Show/Hide Ports
configuration
Related blocks Diff Pressure (ECL Series)
Input(s)
Port Type Range Description
DiffPressure Numeric 0 to 500Pa Used to calculate the airflow based on the differential
pressure. The input typically comes from the Diff
0 to 2inches
Pressure (ECL Series) block. See Flow Calculation
water column
block example (ECL Series).
KFactor Numeric 0 to Sets the K-Factor provided by the VAV box / Pitot tube
3.4028×1038 manufacturer. In imperial units, the K-Factor
represents the airflow in CFM at 1 inch of water
column. In SI (Metric units), the K-Factor represents
the airflow in liter per second at 1 Pascal.
When the KFactor input is linked to a Network
Variable Input, Numeric Constant (ECL Series), or
Numeric Value (ECL Series) block, the Flow
Calculation block can assign the K-Factor it has
calculated from the FlowCalib input to the linked
block. See Flow Calculation block example (ECL
Series).
KFactorNum Numeric 0 to 100 When the KFactor input is linked to a Network
Variable Input, Numeric Constant (ECL Series), or
Numeric Value (ECL Series) block, this input should
be connected to the linked block’s Number output. By
doing so allows the Flow Calculation block to assign
the K-Factor it has calculated from the FlowCalib
input to the linked block. See Flow Calculation block
example (ECL Series).
1160 EC-gfxProgram
Port Type Range Description
FlowCalib Numeric 0 to Used to calibrate the airflow reading.
3.4028×1038 To use the flow calibration feature, see Flow
Calculation block example (ECL Series).
When this input equals 0, the block calculates the flow
according to the following calculation:
When this input is greater than 0, the airflow reading is
calibrated according to the following calculation:
The following is the typical calibration procedure:
1. Open the VAV box to the preferred position (typi-
cally 85%).
2. Use a capture hood/flow hood to record the airflow
that is passing through the VAV box.
3. Enter the measured air flow at this input.
FlowCalib Numeric 0 to 100 When the FlowCalib input is linked to a Network
Num Variable Input, Numeric Constant (ECL Series), or
Numeric Value (ECL Series) block, this input must be
connected to the linked block’s Number output. By
doing so, this allows the Flow Calculation block to
reset the linked block’s value once the flow calibration
is complete. See Flow Calculation block example
(ECL Series).
Output(s)
Port Type Range Description
Flow Numeric 0 to Actual airflow rate.
3.4028×1038
Block properties See Common block properties.
EC-gfxProgram 1161
Flow Calculation If only DiffPressure and Kfactor block inputs are linked, this block will output
block example the flow. If you want to use the FlowCalib option, all block inputs must be
(ECL Series) linked and:
• The Kfactor input must be linked to any one of the following types of
blocks: Network Variable Input, Numeric Constant (ECL Series), or
Numeric Value (ECL Series).
• The KfactorNum input must be linked to the Number port of the block
linked to the Kfactor input.
• The FlowCalib input must be linked to any one of the following types of
blocks: Network Variable Input, Numeric Constant (ECL Series), or
Numeric Value (ECL Series).
• The FlowCalibNum input must be linked to the Number port of the block
linked to the FlowCalib block.
When the FlowCalib and KFactor inputs are linked to Network Variable
Input, Numeric Constant (ECL Series), or Numeric Value (ECL Series)
blocks, and the calibration is complete, the Flow Calculation block sets the
value of the block linked to the FlowCalib input to 0 and assigns the newly
calculated K-Factor value to the block linked to the KFactor input.
To calibrate the K-Factor in the example below, set the Network Variable
Input 27 (nciFlowCalib) block to the measured air flow (measured with a flow
hood).
Figure 642: Flow Calculation block example
1162 EC-gfxProgram
Flow Calculation (ECB & ECY Series)
Description Used to calculate the airflow based on the differential pressure according to
the following formula:
Advanced Configure Ports, Show/Hide Ports
configuration
Related blocks Diff Pressure (ECB Series), VAV Differential Pressure (ECY Series)
Input(s)
Port Type Range Description
DiffPressure Numeric 0 to 500Pa Used to calculate the airflow based on the differential
pressure. The input typically comes from the Diff
0 to 2inches
Pressure (ECB Series) or VAV Differential Pressure
water column
(ECY Series) Block.
KFactor Numeric 0 to Sets the K-Factor provided by the VAV box / Pitot tube
3.4028×1038 manufacturer. In imperial units, the K-Factor
represents the airflow in CFM at 1 inch of water
column. In SI (Metric units), the K-Factor represents
the airflow in liter per second at 1 Pascal.
When the KFactor input is linked to an Analog Value
(ECB & ECY Series) block, the Flow Calculation
block can assign the K-Factor it has calculated from
the FlowCalib input to the Analog Value block.
KFactorNum Numeric 0 to 100 When the KFactor input is linked to an Analog Value
(ECB & ECY Series) block, it should be connected to
the block’s Number output. Doing so allows the Flow
Calculation block to assign the K-Factor it has
calculated from the FlowCalib input to the Analog
Value block. See Flow Calculation block example.
EC-gfxProgram 1163
Port Type Range Description
FlowCalib Numeric 0 to Used to calibrate the airflow reading.
3.4028×1038
To use the flow calibration feature, see Flow
Calculation block example.
When this input equals 0, the block calculates the flow
according to the following calculation:
When this input is greater than 0, the airflow reading is
calibrated according to the following calculation:
The following is the typical calibration procedure:
1. Open the VAV box to the preferred position (typi-
cally 85%).
2. Use a capture hood/flow hood to record the airflow
that is passing through the VAV box.
3. Enter the measured air flow at this input.
FlowCalib Numeric 0 to 100 When the FlowCalib input is linked to an Analog
Num Value (ECB & ECY Series) block, it must be
connected to the block’s Number output. Doing so
allows the Flow Calculation block to reset the value
in the Analog Value block to 0 once the flow
calibration is complete. See Flow Calculation block
example.
Output(s)
Port Type Range Description
Flow Numeric 0 to Actual airflow rate.
3.4028×1038
Block properties See Common block properties.
1164 EC-gfxProgram
Flow Calculation If only Diff Pressure (ECB Series) / VAV Differential Pressure (ECY Series)
block example and Kfactor block inputs are linked, this block will output the flow. If you want
to use the FlowCalib option, all block inputs must be linked and:
• The Kfactor input must be linked to an Analog Value (ECB & ECY Series)
block.
• The KfactorNum input must be linked to the Number port of the Analog
Value block linked to the Kfactor input.
• The FlowCalib input must be linked to an Analog Value block.
• The FlowCalibNum input must be linked to the Number port of the Ana-
log Value block linked to the FlowCalib input.
When the FlowCalib and KFactor inputs are linked to Analog Value blocks,
and the calibration is complete, the Flow Calculation block sets the value of
the Analog Value block connected to the FlowCalib input to 0 and assigns
the newly calculated K-Factor value to the Analog Value block linked to the
KFactor input.
To calibrate the K-Factor in the example below, set the FlowCalib Analog
Value block to the measured air flow (measured with a flow hood).
Figure 643: Flow Calculation block example
EC-gfxProgram 1165
Flow Sensor (ECP Series)
Description Used to interface with the VAV controller’s differential pressure sensor input to
measure airflow and calculate the flow setpoint by balancing the VAV through
one of several calibration methods. The user can read the values of the Pres-
sure, Flow, and FlowSetpoint on the network through nvoDiffPressure, nvoAir-
Flow, and nvoFlowSetpoint respectively. nviFlowCalib can be used to
calibrate the flow sensor by specifying the command (NORMAL_OPERA-
TION, GOTO_PERCENT, GOTO_FLOW, DO_ZERO_CALIB,
DO_HI_POINT_CALIB, RESET_CALIBRATION, DO_DAMPER_INIT), the
percent (if applicable) and the flow (if applicable).
Advanced Advanced configuration
configuration
Controller ECP Series Programmable VAV / VAVS controllers.
support
Input(s)
Port Type Range Description
MinFlow Numeric 0 to 11526.66 CFM Minimum flow (in CFM, l/s, or m3/h).
0 to 5439.97l/s
0 to 19583.91 m3/h
MaxFlow Numeric 0 to 11526.66 CFM Maximum flow (in CFM, l/s, or m3/h).
0 to 5439.97l/s
0 to 19583.91 m3/h
Demand Numeric 0 to 100.00 Flow demand (in %).
ZeroCalib Digital 0 or 1 Takes a reading for the zero flow calibration point (Zero
calibration) on the rising edge. Close the damper fully
before triggering this input.
1166 EC-gfxProgram
Output(s)
Port Type Range Description
Pressure Numeric 0 to Actual air pressure.
83886.07
This value can be read from nvoDiffPressure.
Flow Numeric 0 to Actual flow value read from the sensor input.
83886.07
This value can be read from nvoAirFlow.
FlowSetpoint Numeric 0 to Flow setpoint.
83886.07
When connected to the FlowSetpoint input of the
Damper Control (ECP Series) block, this value can be
read from nvoFlowSetpoint.
Block Properties See also Common block properties.
Property Type Range Default Description
FlowFormat Menu See – The format of the flow. The available formats
Description are:
SNVT_flow#SI
SNVT_flow#US
UNVT_flow#SI_m3h
Pressure Menu See – The format of the differential pressure. The
Format Description available formats are:
SNVT_press_p#SI
SNVT_press_p#US
UNVT_press_p#US_milli
Advanced The Flow Sensor Configuration window has all the settings required to config-
configuration ure a flow sensor.
EC-gfxProgram 1167
Flow Sensor Tab
Figure 644: Flow Sensor Configuration window - Flow Sensor
Zero Calibration
Parameter Description
Calibrate Takes a reading for the zero flow calibration point. Close the
damper fully before taking the reading. Once the calibration
is complete, the Zero calibration done indicator will turn
green.
NOTE: This calibration overrides the factory zero calibration.
To go back to the factory zero calibration, the Reset
Calibration button must be pressed.
1168 EC-gfxProgram
Flow Configuration
Parameter Description
Operation Used to specify whether VAV or VVT mode is being used.
mode This option can also be used to force a VAV to operate as a
VVT.
If VVT mode is selected, a 1 is written to the bit4 field of
UCPTobjectOptions. If VAV mode is selected, a 0 is written.
NOTE: If VVT mode is selected, this block can still be placed
in a project, but it will only calculate the flow setpoint
and not the flow itself.
Balancing K-Factor: Select this option to balance the VAV box using
mode the K-Factor.
Pitot Factor and Duct Area: Select this option to balance
the VAV box using the Pitot factor and Duct area.
Hi Point Calibration: Select this option to balance the VAV
box using a high calibration point value. When the high value
option is used, the damper can be adjusted so that the
airflow is relatively close to the MaxFlow and then a
calibration is performed by entering the reading in the Hi
point calibration field and pressing the Calibrate button.
Once the calibration is complete, the Calibration done
indicator will turn green.
Hi point Adjust the damper so that the airflow is relatively close to the
calibration maximum possible flow then enter this airflow reading in this
field and click the Calibrate button.
NOTE: This field is only available when using the Hi Point
Calibration balancing mode.
Calibrate Takes a reading for the high calibration point. Once the
calibration is complete, the Calibration done indicator will
turn green.
NOTE: This button is only available when using the Hi Point
Calibration balancing mode.
EC-gfxProgram 1169
Parameter Description
Pitot factor Most VAV box / Pitot tube manufacturers create their Pitot
tubes in a manner that it amplifies the differential pressure
by a certain factor. Contact them to acquire the value of this
factor if they have not provided it.
The Pitot factor is therefore a divider that is applied to the
differential pressure reading that compensates for varying
characteristics and flow effects in VAV box equipment and
pickup probes, for example, the amplification factor. The
Pitot factor must be entered along with the Duct area to
ensure precise automatic calibration.
NOTE: This field is only available when using the Pitot Fac-
tor and Duct Area balancing mode.
Duct area This value is used to perform a calibration of the VAV box by
using the Pitot factor to calculate the K-Factor.
NOTE: This field is only available when using the Pitot Fac-
tor and Duct Area balancing mode.
Calculate Opens the Duct Area Calculator window.
duct area
NOTE: This field is only available when using the Pitot Fac-
tor and Duct Area balancing mode.
K-Factor Enter the K-Factor provided by the VAV box / Pitot tube
manufacturer here if using the K-Factor balancing mode.
The K-Factor is calculated by the Pitot factor and Duct area
when using the Pitot Factor and Duct Area balancing
mode.
The value entered in this field is written to UCPTkfactor.
Nominal The expected airflow when the damper is fully open. It is also
flow used to determine the next damper movement.
NOTE: The default value (422 litres/second; 894 cfm) for
Nominal Flow must be modified to reflect the actual
expected airflow value when the damper is fully
open.
The value for Nominal Flow can be no less than 5 litres/
second (11 cfm).
The value entered in this field is written to
SCPTnomAirFlow.
Reset Resets the calibration and flow readings. This button returns
Calibration the controller to the uncalibrated state allowing a
recalibration to be performed.
1170 EC-gfxProgram
Parameter Description
Normal Terminates calibration mode and puts the controller back
Operation into normal operation. While the controller is in calibration
mode it will not respond to control demands. The controller
automatically goes into normal operation when the
configuration window is closed.
Flow Controls
Parameter Description
Differential The current differential pressure reading.
pressure
This value can be read from nvoDiffPressure.
Use filter on When selected, a low-pass filter is activated that greatly
differential reduces the effect of input signal noise that originates from
pressure air flow turbulence found in the duct where the differential
pressure flow-sensor probe is located. It is highly
recommended to enable this setting to reduce
unnecessary damper movements thus extending the
useful actuator lifespan.
Actual flow The real-time air flow that is being supplied to the zone.
The flow reading will only be available if the controller has
been calibrated.
This value can be read from nvoAirFlow.
Flow Sets the airflow that the damper needs to permit.
command
Goto Flow Moves the damper to permit the airflow specified in the
Flow command field.
Flow setpoint The setpoint of the flow so that the value specified in the
Flow command field is reached.
This value can be read from nvoFlowSetpoint.
Internal Damper Controls
Parameter Description
Damper The real-time damper position.
position
This value can be read from nvoDamperPos.
Damper Sets the position of the damper to the percentage
command specified (0% is fully closed and 100% is fully open).
Goto Position Moves the damper to the position specified in the Damper
command field.
EC-gfxProgram 1171
Network Variable tab
Figure 645: Flow Sensor Configuration window - Network Variables
nvoDiffPressure/nvoAirFlow/nvoFlowSetpoint
Parameter Description
Min send The minimum time period that must pass between network
time variable updates on the network for the network variable
shown immediately above. If the value of the network
variable changes, an update will only be sent after this time
expires. Setting the min send time to 0 disables it. See
Network Properties Configuration window (ECL, ECB & ECY
Series).
The min send time is often referred to as the "throttle".
Max send The maximum time period between automatic transmissions
time of the network variable on the network (whether or not the
variable’s value has changed) for the network variable
shown immediately above. Setting the max send time to 0
disables it. See Network Properties Configuration window
(ECL, ECB & ECY Series).
The max send time is often referred to as the "heartbeat".
If max receive time is configured for the corresponding
network variable output, the recommended setting for this
value is half the Max receive time value.
1172 EC-gfxProgram
VAV balancing A VAV can be balanced either through EC-gfxProgram or the network inter-
method face.
VAV balancing through EC-gfxProgram
There are 4 basic steps to balancing a VAV through EC-gfxProgram:
1. Zero point calibration.
a. Open the Advanced configuration window of the Flow Sensor block
and select the Flow Sensor Tab.
b. Click the Calibrate button in the Zero Calibration section. The Zero
calibration done indicator will turn from to . .
2. Flow-Pressure Relationship Definition:
K-Factor:
a. Select K-Factor from the Balancing mode drop-down menu.
b. Enter the K-Factor provided by the VAV box / Pitot tube manufacturer
in the K-Factor box.
c. Enter the nominal flow in the Nominal flow box.
d. Click Apply. The Calibration done indicator will turn from to . .
Pitot Factor and Duct Area:
a. Select Pitot Factor and Duct Area from the Balancing mode drop-
down menu.
b. Enter the Pitot Factor provided by the VAV box / Pitot tube manufac-
turer in the Pitot factor box.
c. Enter the duct area in the Duct area box or use the Duct Area Calcu-
lator window.
d. Click Apply. The Calibration done indicator will turn from to . .
High point calibration balancing mode:
a. Select Hi Point Calibration from the Balancing mode drop-down
menu.
b. Adjust the damper position to get close (±5%) to the maximum flow by
entering values in the Damper command box and click the Goto
Position button.
c. Use the capture hood/flow hood to record the airflow that is passing
through the VAV box.
d. Repeat steps 2 and 3 until a satisfactory maximum flow is reached.
e. Wait until the differential pressure stabilizes then enter the capture
hood/flow hood reading in the Hi point calibration box.
f. Click the Calibrate button in the Flow Configuration section. The Cal-
ibration done indicator will turn rom to . .
EC-gfxProgram 1173
3. Validating the minimum flow accuracy.
a. Enter a value close to 0 in the Flow command box and click the
Goto Flow button.
b. Use the capture hood/flow hood to record the airflow that is passing
through the VAV box.
c. If the measured airflow is close (±5%) to the Flow command, go on
to validate the maximum flow accuracy. If the measured airflow is
greater than 5% above the Flow command, decrease the K-Factor
and measure the airflow again. If the measured airflow is less than
5% below the Flow command, increase the K-Factor and measure
the airflow again.
d. Repeat steps 2 and 3 until a satisfactory airflow is reached.
4. Validating the maximum flow accuracy.
a. Enter the maximum flow (Hi point or nominal flow) in the Flow com-
mand box and click the Goto Flow button.
b. Use the capture hood/flow hood to record the airflow that is passing
through the VAV box.
c. If the measured airflow is close (±5%) to the Flow command, then
the VAV is balanced. If the measured airflow is greater than 5% above
the Flow command, decrease the K-Factor and measure the airflow
again. If the measured airflow is less than 5% below the Flow com-
mand, increase the K-Factor and measure the airflow again.
d. Repeat steps 2 and 3 until a satisfactory airflow is reached.
NOTE: Although it is not a must, it is good practice to reset the calibration if a
previous flow calibration was performed and a new one is about to be
performed.
VAV balancing through the Network Interface
The same procedure outlined above can be used to balance a VAV using the
network interface. The following NVIs, NVOs, and CPs can be used:
• nviFlowCalib
• nviFlowOverride
• nvoDiffPressure
• nvoAirFlow
• nvoFlowSetpoint
• nvoDamperPos
• UCPTkfactor
• SCPTnomAirFlow
1174 EC-gfxProgram
Duct Area The Duct Area Calculator window allows the duct area to be conveniently
Calculator determined. The duct area is only used when the Pitot factor and Duct Area
Balancing mode is selected
Figure 646: Duct Area Calculator window
Parameter Description
Duct Shape Specify whether the duct is Round or Rectangular.
Depending on the type of duct that is selected, the
window will allow information to be entered for a
Round duct or a Rectangular duct.
Round When the Duct diameter is entered, the Calculated
area field will automatically be updated.
Rectangle When the Duct width and Duct height are entered,
the Calculated area field will automatically be
updated.
Calculated area The result of the area calculation.
EC-gfxProgram 1175
Internal Actuator (ECL Series)
Description Used to interface with the VAV controller’s damper actuator for flow control
with controllers equipped with a built-in actuator. For a project code example
of how to use this block, see Actuator Control block example.
When the block’s DamperCmd input is in Fault, the DamperCmd output
defaults to 50%.
Advanced Resources Configuration, Advanced configuration, Initialization, Configure
configuration Ports, Show/Hide Ports
Controller ECL Series VAV controllers.
support
Related blocks Actuator Control (ECL Series)
Input(s)
Port Type Range Description
DamperCmd Numeric 0 to 100 Damper command.
Speed Numeric 45 to 95 The number of seconds required for the actuator to
perform 95º of actuator travel. Any value outside of 45 to
95 seconds has the effect of this being set to 95
seconds.
Direction Digital 0 or 1 Used to specify the direction (Clockwise or Counter
Clockwise) in which the actuator rotates to open the
damper. A True (1) input directs a Counter Clockwise
rotation to open the damper. A False (0) input directs a
Clockwise rotation to open the damper.
Initialize Digital 0 or 1 A True (1) input resets the damper position and
calculates the total number of steps between the stops.
Use this option if the mechanical stops on the actuator
have been moved to limit the range of movement of the
damper.
NOTE: The actuator mechanical stops should be moved
only to limit damper movement from going under
0% or over 100%.
1176 EC-gfxProgram
Output(s)
Port Type Range Description
DamperC Numeric 0 to 100 The current Damper command.
md
DamperFe Numeric 0 to 100 Actual damper position.
edback
Opening Digital 0 or 1 When the damper is opening, this output is True (1)
otherwise it is False (0).
Closing Digital 0 or 1 When the damper is closing, this output is True (1)
otherwise it is False (0).
Priority Numeric 0 to 4 The current active priority. See Priority levels in
LONWORKS (ECL Series).
Block properties See Common block properties.
Advanced Configuration parameters for this block are set in the Resources Configura-
configuration tion window.
Figure 647: Internal Actuator Configuration window - LONWORKS properties
See Network Properties Configuration window (ECL, ECB & ECY Series).
EC-gfxProgram 1177
Initialization This resets the damper position and calculates the total number of steps
between the stops. Use this option if the mechanical stops on the actuator
have been moved to limit the range of movement of the damper. To initialize
the Internal Actuator, right click it and select Initialize.
Figure 648: Initializing the Internal Actuator
NOTE: The actuator mechanical stops should be moved only to limit damper
movement from going under 0% or over 100%.
1178 EC-gfxProgram
Internal Actuator (ECB & ECY Series)
Description Used to interface with the VAV controller’s damper actuator for flow control.
When the block’s DamperCmd input is in Fault, the DamperCmd output
defaults to 50%.
Advanced For ECB Series Controllers: Resources Configuration, Actuator Control block
configuration example, Initialization, Configure Ports, Show/Hide Ports
For ECY Series controllers: Resources Configuration, Flow Calculation block
example, Emergency override and emergency auto (ECB & ECY Series),
Override and auto, Set Value, Initialization, Find All References (ECL, ECB &
ECY Series), Copy From, Configure Ports, Alarms (ECB & ECY Series) - ECY
Series only
Controller ECB & ECY Series VAV controllers.
support
Input(s)
Port Type Range Description
Priority Integer 1 to 16 For a Commandable value only, the value at the
DamperCmd is written at the priority level specified at
this input. If a value is not linked to this input, the value
at the DamperCmd is written in priority level 14. See
Commandable object priority array levels.
DamperC Numeric 0 to 100 Damper command.
md
Speed Numeric 45 to 95 The number of seconds required for the actuator to
perform 95º of actuator travel. Any value outside of 45 to
95 seconds has the effect of this being set to 95
seconds.
Direction Digital 0 or 1 Used to specify the direction (Clockwise or Counter
Clockwise) in which the actuator rotates to open the
damper. A True (1) input directs a Counter Clockwise
rotation to open the damper. A False (0) input directs a
Clockwise rotation to open the damper.
EC-gfxProgram 1179
Port Type Range Description
Initialize Digital 0 or 1 A True (1) input resets the damper position and
calculates the total number of steps between the stops.
Use this option if the mechanical stops on the actuator
have been moved to limit the range of movement of the
damper.
NOTE: The actuator mechanical stops should be moved
only to limit damper movement from going under
0% or over 100%.
Output(s)
Port Type Range Description
DamperCmd Numeric 0 to 100 The current Damper command.
DamperFeedback Numeric 0 to 100 Actual damper position.
Opening Digital 0 or 1 When the damper is opening, this output is True (1)
otherwise it is False (0).
Closing Digital 0 or 1 When the damper is closing, this output is True (1)
otherwise it is False (0).
Priority Integer 1 to 16 The current active priority for commandable objects.
See Commandable object priority array levels.
Block properties See Common block properties.
Advanced For ECB Series Controllers: configure the BACnet object properties for this
configuration block in the Internal Actuator Configuration window. See below.
For ECY Series controllers: configure the BACnet object properties for this
block in the Resources Configuration.
Configure Configuration parameters for this block are set in the Resources Configura-
actuator position tion window. Configure the network properties for the:
and actuator
setpoint (ECB • Damper command value under Actuator Command.
Series
Controllers Only)
1180 EC-gfxProgram
• Damper position value under Actuator Position.
Figure 649: Damper Control Configuration window – Damper
See Network Properties Configuration window (ECL, ECB & ECY Series).
Initialization This resets the damper position and calculates the total number of steps
between the stops. Use this option if the mechanical stops on the actuator
have been moved to limit the range of movement of the damper. To initialize
the Internal Actuator block, right click the Internal Actuator block and select
Initialize.
Figure 650: Initializing the Internal Actuator
NOTE: The actuator mechanical stops should be moved only to limit damper
movement from going under 0% or over 100%.
EC-gfxProgram 1181
1182 EC-gfxProgram
Block Actions
CHAPTER 7
Block Actions
Aside from the block configuration that can be done directly to the block or
through the Properties pane, every block (except Reference Hub and Text
blocks) is able to access one or more advanced configuration windows.
Blocks have a default action when double-clicked. The default action for a
block is shown in bold when you right-clicking on it.
Topics
Advanced configuration windows overview
Opening a block action
Set Constant (ECL Series)
Set Value
View content
Format Editor
Creating and using enumerations (8-Bit)
Creating and using enumerations (ECP Series)
Creating and using enumerations (ECL Series)
Enumeration Picker (ECP & ECL Series)
Format Selection
Edit Value (ECP Series)
Edit Mode and Value (ECP Series)
Emergency override and emergency auto (ECB & ECY Series)
Override and auto
Find All References (ECL, ECB & ECY Series)
Copy From
Configure Ports
Show/Hide Ports
Set and reset timer (ECY series)
Replacing blocks
Network Properties Configuration window (ECL, ECB & ECY Series)
Change Type (ECP & ECL Series)
Alarms (ECB & ECY Series)
Viewing a trend log (ECY Series)
EC-gfxProgram 1183
Advanced configuration windows overview
The following is a list of all advanced configuration windows that can be
opened either directly from a block or through other configuration windows:
• Configure (see the block for details). For ECY Series controllers, see
Resources Configuration. To add a resource in the Resources Configura-
tion window, see Adding resource block instances to the resource tree.
• Opening a block action
• Set Constant (ECL Series)
• Set Value
• View content
• Format Editor
• Creating and using enumerations (8-Bit)
• Creating and using enumerations (ECP Series)
• Creating and using enumerations (ECL Series)
• Enumeration Picker (ECP & ECL Series)
• Format Selection
• Edit Value (ECP Series)
• Edit Mode and Value (ECP Series)
• Emergency override and emergency auto (ECB & ECY Series)
• Override and auto
• Copy From
• Initialize (see Internal Actuator (ECB & ECY Series))
• Configure Ports
• Show/Hide Ports
• Network Properties Configuration window (ECL, ECB & ECY Series)
• Change Type (ECP & ECL Series)
• Alarms (ECB & ECY Series)
• Synchronize Bindings (see Network Variable Input (ECP Series))
• Learn (see Wireless Module (ECP Series))
• Go To Source
• Edit Text (see Text)
1184 EC-gfxProgram
Block Actions
Opening a block action
These advanced configuration windows can be opened by any of the follow-
ing methods:
• Right-clicking the block and selecting the advanced configuration window
name.
Figure 651: Opening advanced configuration windows through Block pop-up
menu
• Selecting the block and clicking the advanced configuration window name
in the Properties pane (the blue hyperlinks at the bottom).
Figure 652: Opening advanced configuration windows through the Properties
Pane
• Right-click an input or output in the and select the Configure option from
the drop down list (for ECL, ECB & ECY Series controllers only). See
Resource Viewer for more information.
EC-gfxProgram 1185
Set Constant (ECL Series)
Configuration parameters for these blocks are set in the Resources Configu-
rationwindow. For Boolean Constant (ECL Series), Enum Constant (ECL
Series), and Numeric Constant (ECL Series) blocks, this forces the output of
these blocks to assume a user-set value.
Figure 653: Set constant value configuration
Parameter Description
Initial value The Value this block is to assume.
If an enumeration format has been applied to the block, the Edit Value window
will display a combo box for you to select an enumeration value.
Right-click the block and select Set Constant as follows.
Figure 654: Selecting Set Constant
NOTE: Large numbers are entered into a dialog box using a special format.
For example, 2.385X1012 is entered into a dialog box as 2.385E+12.
A null value is typed in as null.
1186 EC-gfxProgram
Block Actions
Set Value
NOTE: Large numbers are entered into a dialog box using a special format.
For example, 2.385X1012 is entered into a dialog box as 2.385E+12.
A null value is typed in as null.
ECL Series The Set Value window, available with ECL Series controllers only, allows the
controllers mode and value of the block to be set according to the format that has been
applied to the block. The mode can be set to either Manual, in which case the
value entered will be set as a constant, or to Automatic, in which case the
value received as an input from another block or the value of the attached
device will be read.
For a Variable Numeric (ECP Series) and Hardware Input block, any decimal
value (±3.4028×1038) can be set. For an Enum Value (ECL Series) block, any
integer value between -128 and 127 can be set. For a Hardware Output
block, any decimal value between 0 and 100 can be set. If an enumeration
format has been applied to the block, the Edit Value window will display a
combo box for you to select an enumeration value.
NOTE: This advanced configuration window is accessible directly through the
Enum Value (ECL Series) block.
Figure 655: Set Value window
If an enumeration format has been applied to the block, the Edit Value window
will display a combo box for you to select an enumeration value.
NOTE: For a Floating Pair block, setting the mode to Manual or Automatic
will set the PositionMode output to Manual or Automatic.
ECB & ECY For Hardware Output, Analog Value (ECB & ECY Series), Digital Value, and
Series Multi State Value (ECB & ECY Series) Blocks, this forces an output to assume
controllers a user-set value at any priority level. See Commandable object priority array
levels. This is not available for the Hardware Input Block.
EC-gfxProgram 1187
Figure 656: Set value configuration
Parameter Description
Value [Unit] The Present Value (including Null) and its associated
unit (for commandable values). To revert to the default
value, set the value to Null.
Write priority For a Commandable value, set the BACnet priority to
use when writing to the BACnet object. See Command-
able object priority array levels.
Out of service Set this value to be out of service. See Out-of-Service.
For blocks that support multiple BACnet objects at once, select through the
BACnet object to set the action.
Figure 657: Selecting override or auto for a block that supports multiple BACnet
objects at once
View content
View Content opens a programming sheet where the project code within Cus-
tom block, Conditional Custom Block, or For Loop (ECL, ECB & ECY Series)
can be viewed and created.
NOTE: This advanced configuration is accessible directly through the Condi-
tional Custom, Custom, and For Loop blocks by double-clicking the
block.
1188 EC-gfxProgram
Block Actions
Figure 658: View content
When viewing project code inside a Conditional Custom Block, a Custom
block, or a For Loop (ECL, ECB & ECY Series), and you want to return to the
Conditional Custom Block, Custom Block, or For Loop block object, right-
click a blank area of the programming sheet and select Show in Containing
Page. See Show in Containing Page.
Format Editor
The Format Editor window has all the formats that can be assigned to the
selected output port of a EC-gfxProgram block. When an output port is
assigned a format, enumeration or any type of unit, this does not affect the
actual value of the output, but it adds text after the value or it converts the
value into a text in the case of enumerations.
Even if the project’s measurement system is changed, only the displayed for-
mat, enumeration or unit will change, that is, the value is not converted.
This advanced configuration window is accessible:
• Through the Configure Ports window by clicking Format.
• Through the Resources Configuration window by clicking (Format).
• By right-clicking one or more selected blocks on the programming sheet
and selecting the Format from the selection.
NOTE: When a controller is equipped with an operator interface or it is con-
nected to an ECx-Display, the format must be correctly configured for
the value’s unit to be correctly shown on the LCD screen. See LCD
interface supported units.
EC-gfxProgram 1189
Figure 659: Format editor window
Parameter Description
Provides quick access to favorite and recently-used
formats. See Favorite and recently-used formats.
Boolean Assigns a Boolean format to the output, for example,
On, Off. A Quick select drop-down menu provides
quick access to a number of standard Boolean true/
false texts, or any custom true/false text can be set in
True text and False Text.
Enumeration Assigns enumerations to the output. An enumeration is
assigned to an output to provide a descriptive meaning
to the output based on a type of mode. For example,
instead of outputting a value of 3 for an HVAC mode,
an output can be assigned an enumeration so that it
will output HVAC_COOL (which corresponds to a value
of 3), which is much more descriptive than the numeric
value in of itself.
For more information about how to select or create an
enumeration, see Creating and using enumerations (8-
Bit), Creating and using enumerations (ECP Series),
and Creating and using enumerations (ECL Series).
Engineering Assigns a unit to the output from a pre-defined list
Units (drop-down menu).
Numeric Value + Assigns no format to the output and leaves it as a
Text numeric value. Text appends a unit from a pre-defined
list (drop-down menu) or you can type the necessary
unit.
NOTE: When a controller is equipped with an operator
interface or it is connected to an ECx-Display,
this format type is not supported by the. See
LCD interface supported units.
1190 EC-gfxProgram
Block Actions
Parameter Description
LonMark Format Click Select to open the Format Selection window.
If Auto select format is checked, the formatted output
follows the measurement system of the project (Metric
or US). If unchecked, the formatted output follows the
measurement system specified by the LonMark format
(SI or US).
Units displays the unit that will be assigned to the
selected output.
Favorite and Favorite and recent formats permit instant recall of formats:
recently-used
formats • That you have added to the favorites list as Favorite Formats.
• Any recently-used format (history) as Recent Formats.
Figure 660: Favorite and recent formats list
Parameter Description
List of Favorite List of favorite formats. Click an entry to select it as the
Formats format to be used.
Add to Favorites Add the currently-selected format to the list of favorite
formats.
Manage Favor- Allows you to delete a format from the list of Favorite
ites Formats. Right-click a format and select Delete from
the list.
List of Recent List of recently-used formats. Click an entry to select it
Formats as the format to be used.
Clear Recent Removes all recently-used formats from the Recent
List Formats list.
This list can be directly accessed through the Configure Ports window by
clicking the arrow on the right of Format.
EC-gfxProgram 1191
Figure 661: Quick-access to the favorite and recent formats lists
Creating and using enumerations (8-Bit)
This advanced configuration window is accessible through the Format Editor
window or through the Resources Configuration for the Multi State Value
(ECB & ECY Series), multistate output, or multistate input (DIGITAL and MUL-
TI_LEVEL).
Format editor
If you have already created enumerations for your project, select the Enumer-
ation Format Type and select an enumeration from the Enumeration drop-
down list.
Figure 662: Selecting an enumeration that already has been configured
1192 EC-gfxProgram
Block Actions
Click for quick access to favorite and recently-used formats. See Favorite
and recently-used formats.
To create a new enumeration, modify an existing enumeration, or to import /
export your project’s enumerations, select the Enumeration Format Type
and click Configure to open the Enumerations Configuration window.
According to the type of controller, enumeration type can only be created or
modified as follows.
Controller
Description
Model
ECY Series Only Custom Enumerations can only be created or
modified.
ECB Series Both Custom Enumerations and State Text Enumer-
ations can be created or modified.
NOTE: State Text Enumerations are the only enumer-
ations that are supported by BACnet objects
within the controller and should be preferen-
tially used.
For ECB Series controllers, the following limitations apply:
• A multistate value, multistate output, or multistate input can only be in the
range of 1 to 255.
• The number of enumerations are limited to a selection of pre-existing
BACnet enumerations found under State Text Enumerations.
• Each enumeration cannot have more than 32 members for a multilevel
input.
• Value ranges are not supported.
• The sequence of the enumeration members is auto-incremented starting
at 1, and must be entered in order (the sequence cannot be later
changed).
EC-gfxProgram 1193
Figure 663: Selecting a BACnet Enumeration that has previously been configured
(ECB Series)
For ECY Series controllers, the following limitations apply:
• A multistate value, multistate output, or multistate input can only be in the
range of 1 to 255. ECY Series controllers will remap values that are out-
side of this range so that the values will fall within the standard BACnet
enumeration range of 1 to 255. The Value column shows the value or
range of value (including zero and negative numbers) that are converted
into an enumeration value shown in the Multi State Value column.
• The number of enumerations are limited to a selection of pre-existing
BACnet enumerations.
• Each enumeration cannot have more than 32 members for a multilevel
input.
• The sequence of the enumeration members is auto-incremented starting
at 1. The order will be resorted as new members are added to the enu-
meration.
1194 EC-gfxProgram
Block Actions
Figure 664: Selecting a BACnet enumeration that has previously been configured
(ECY Series)
Right-click entries in the Custom Enumerations and State Text Enumera-
tions (ECB Series controllers only) tree for options.
Figure 665: Enumeration drop-down menu
Parameter Description
Rename Renames the selected enumeration.
Delete Deletes the selected enumeration.
Add Member Adds a member to an enumeration.
Each enumeration has two or more members (modes).
EC-gfxProgram 1195
Figure 666: Member drop-down menu
Parameter Description
Add Member Creates a new member for the selected enumeration.
Edit Edit the value(s) of the selected member.
Delete Deletes the selected member.
Setting an enumeration range (ECY Series control-
lers)
A member can be a value or a range of values.
Figure 667: Set a value or a range of values in Edit Enumeration Member
Parameter Description
Name Set the name for this enumeration member (mode).
Fixed Value Set the Value for this enumeration member.
Range Set a range of values for this enumeration member. Set
the Low Limit (greater than or equal) and the High
Limit (less than) to define the bounds of the range.
1196 EC-gfxProgram
Block Actions
Importing and exporting enumerations
You can export the enumerations that are part of your current project to a file
so you can import and use them in other projects. Click Export Enumeration
to do so. This creates an .enum file that you save on your PC. Share this file
by any available file transfer method (Email file attachment, ftp upload, etc.).
To import the enumerations you have previously exported from another proj-
ect, select Custom Enumerations in the Enumerations tree and click
Import Enumeration.
Creating and using enumerations (ECP Series)
This advanced configuration window is accessible through the Format Editor-
window or directly through the Constant Enum (ECP Series) and Variable
Enum blocks.
If you have already created enumerations for your project, select the Enumer-
ation Format Type and select an enumeration from the Enumeration drop
down list.
Figure 668: Selecting an enumeration that has already been configured
To create a new enumeration, modify an existing enumeration, or to import /
export your project’s enumerations, select the Enumeration in Format Type
and click Configure to open the Enumerations Configuration window.
EC-gfxProgram 1197
Figure 669: Selecting an enumeration that already has been configured
Figure 670: Format drop-down menu
Parameter Description
New Creates a new enumeration.
Rename Renames the selected enumeration.
Delete Deletes the selected enumeration.
Each enumeration has two or more members (modes).
Figure 671: Format drop-down menu
Parameter Description
New Creates a new member for the selected enumeration.
Edit Edit the value(s) of the selected member.
1198 EC-gfxProgram
Block Actions
Parameter Description
Delete Deletes the selected member.
A member can be a value or a range of values.
Figure 672: Set a value or a range of values in Edit Enumeration Member
Parameter Description
Name Set the name for this enumeration member (mode).
Fixed Value Set the Value for this enumeration member.
Range Set a range of values for this enumeration member. Set
the Low Limit (greater than or equal) and the High
Limit (less than) to define the bounds of the range.
You can export the enumerations that are part of your current project to a file
so you can import and use them in other projects. Click Export Enumeration
to do so. This creates an .enum file that you save on your PC. Share this file
by any available file transfer method (Email file attachment, ftp upload, etc.).
To import the enumerations you have previously exported from another proj-
ect, click Import Enumeration.
Creating and using enumerations (ECL Series)
This advanced configuration window is accessible through the Format Editor
window or through the advanced configuration of the Multi State Value (ECB &
ECY Series) or Hardware Input (Digital and Multilevel).
EC-gfxProgram 1199
Format editor
If you have already created enumerations for your project, select the Enumer-
ation Format Type and select an enumeration from the Enumeration drop-
down list.
Figure 673: Selecting an enumeration that already has been configured
To create a new enumeration, modify an existing enumeration, or to import /
export your project’s enumerations, select the Enumeration Format Type
and click Configure to open the Enumerations Configuration window. Enu-
merations can only be created or modified in the Custom Enumerations
tree.
Enumerations created in the Custom Enumerations tree support value
ranges - Setting an enumeration range. The sequence of the enumeration
members is auto-incremented starting at 1, and must be entered in order (the
sequence cannot be later changed). Enumeration members can have values
that range from -128 to 127.
Figure 674: Selecting an enumeration that already has been configured
Right-click entries in the Custom Enumerations tree for options.
1200 EC-gfxProgram
Block Actions
Figure 675: Enumeration drop-down menu
Parameter Description
Rename Renames the selected enumeration.
Delete Deletes the selected enumeration.
Add Member Adds a member to an enumeration.
Each enumeration has two or more members (modes).
Figure 676: Member drop-down menu
Parameter Description
Add Member Creates a new member for the selected enumeration.
Edit Edit the value(s) of the selected member.
Delete Deletes the selected member.
EC-gfxProgram 1201
Setting an enumeration range
A member can be a value or a range of values.
Figure 677: Set a value or a range of values in Edit Enumeration Member
Parameter Description
Name Set the name for this enumeration member (mode).
Fixed Value Set the Value for this enumeration member.
Range Set a range of values for this enumeration member. Set
the Low Limit (greater than or equal) and the High
Limit (less than) to define the bounds of the range.
Importing and exporting enumerations
You can export the enumerations that are part of your current project to a file
so you can import and use them in other projects. Click Export Enumeration
to do so. This creates an .enum file that you save on your PC. Share this file
by any available file transfer method (Email file attachment, ftp upload, etc.).
To import the enumerations you have previously exported from another proj-
ect, select Custom Enumerations in the Enumerations tree and click
Import Enumeration.
1202 EC-gfxProgram
Block Actions
Enumeration Picker (ECP & ECL Series)
The Enumeration Picker window has all the enumerations that can be
assigned to the selected output. An enumeration is assigned to an output to
provide a descriptive meaning to the output based on a type of mode. For
example, instead of outputting a value of 3 for an HVAC mode, an output can
be assigned an enumeration so that it will output HVAC_COOL (which corre-
sponds to a value of 3), which is much more descriptive than the numeric
value in of itself.
This advanced configuration window is accessible through the Format Editor
window or directly through the Constant Enum (ECP Series) and Variable
Enum (ECP Series) blocks.
Figure 678: Enumeration Picker window
Parameter Description
Type File Select a type file from the drop-down list. All available
type files from the device resource file catalog (stan-
dard and manufacturer defined) are listed. The Enu-
merations will change based on the .TYP file selected.
Enumerations Select an enumeration from the list. All enumerations
contained within the selected .TYP file are listed and
sorted by Name or Index.
EC-gfxProgram 1203
Parameter Description
Values Displays a list of values contained within the selected
enumeration sorted by Name or Value. Each value cor-
responds to an integer value.
For example, in the above figure, the enumeration val-
ues for hvac_t correspond to integer values as follows:
-1 = Nul
0 = Auto
1 = Heat
2 = Mrng Wrmup
3 = Cool, etc.
Format Selection
The Format Selection window has all the SNVT and SCPT format types that
can be assigned to the selected output. A format is assigned to an output to
provide a context for the value outputted. For example, an output value of 74
does not provide much meaning to the user by itself, but if the value is fol-
lowed by °F, then the user immediately understands that the value is a tem-
perature.
This advanced configuration window is accessible through the Format editor
window.
1204 EC-gfxProgram
Block Actions
Figure 679: Format Selection window
Parameter Description
Options Select the formats to be displayed from the drop-down
menu: Network Variable Formats, Configuration Prop-
erty Formats or Both.
Format File Select a format file from the drop-down list. All avail-
able format files from the device resource file catalog
(standard and manufacturer defined) are listed. The
Formats will change based on the .FMT file selected.
Formats Select a format from the list. All formats contained
within the selected .FMT file are listed and sorted by
Name, Field or Length.
EC-gfxProgram 1205
Edit Value (ECP Series)
The Edit Value window, available with ECP Series controllers only, allows the
value of the block to be set according to the format that has been applied to
the block when the controller is Online. The following value ranges are valid.
Block Type Value Range
Constant Numeric (ECP Series) Any decimal value (between -83886.08
and +83886.07)
Constant Enum (ECP Series) Any integer value between -128 and
127
Network Variable Input (ECP The value(s) that can be set depend on
Series) the SNVT type of the block
For ECL Series Controller, configuration parameters for these blocks are set
in the Resources Configuration window.
If an enumeration format has been applied to the block, the Edit Value window
will display a combo box for you to select an enumeration value.
Figure 680: Edit Value window
Edit Mode and Value (ECP Series)
The Edit Mode and Value window, available with ECP Series controllers only,
allows the mode and value of the block to be set according to the format that
has been applied to the block when the controller is Online. The mode can be
set to either Manual, in which case the value entered will be set as a con-
stant, or to Automatic, in which case the value received as an input from
another block or the value of the attached device will be read. For a Variable
Numeric (ECP Series) and Hardware Input (ECP Series) block, any decimal
value (-83886.08 to 83886.07) can be set. For a Variable Enum (ECP Series)
block, any integer value between -128 and 127 can be set. For a Hardware
Output (ECP Series) block, any decimal value between 0 and 100 can be set.
If an enumeration format has been applied to the block, the Edit Mode and
Value window will display a combo box for you to select an enumeration
value.
This advanced configuration window is accessible directly through the Vari-
able Numeric (ECP Series), Variable Enum (ECP Series), Hardware Input
1206 EC-gfxProgram
Block Actions
(ECP Series), Hardware Output (ECP Series), SmartSensor Module (ECP
Series) and Wireless Module (ECP Series) blocks.
Figure 681: Edit Mode and Value window
NOTE: For a Floating Pair block, setting the mode to Manual or Automatic
will set the PositionMode output to Manual or Automatic.
Emergency override and emergency auto (ECB &
ECY Series)
For a commandable value, this sets or clears a block’s output value at priority
level 1 as follows when the controller is Online. This is not available for the
Hardware Input Block.
Table 31: Emergency override and emergency auto definitions
Property Description
Emergency Forces an output to assume a user-set value at priority
Override level 1. See Commandable object priority array levels.
Emergency Auto Clears an Emergency Override value at priority level
1.
Right-click one or more blocks the block and select Emergency Override or
Emergency Auto as follows.
NOTE: If you select blocks of the same type, you can perform the following
actions: Emergency Override, Emergency Auto, Override, Auto, and
Set Value.
If you select blocks of different types, you can only perform an Emer-
gency Auto or Auto on the selected blocks.
EC-gfxProgram 1207
Figure 682: Selecting emergency override or emergency auto
NOTE: To easily set or clear the output value at priority level 1 for several
blocks throughout the project, open the Resource Viewer, right-click
these blocks, and select Emergency Override or Emergency Auto.
NOTE: Large numbers are entered into a dialog box using a special format.
For example, 2.385X1012 is entered into a dialog box as 2.385E+12.
A null value is typed in as null.
Override and auto
For Hardware Input, Hardware Output Blocks, and network objects, set or
clear a block’s input or output value by right-clicking one or more blocks the
block and selecting either Override or Auto as follows when the controller is
Online.
NOTE: If you select blocks of the same type, you can perform the following
actions: Emergency Override, Emergency Auto, Override, Auto, and
Set Value.
If you select blocks of different types, you can only perform an Emer-
gency Auto or Auto on the selected blocks.
Figure 683: Selecting override or auto
NOTE: To easily set or clear the output value for several blocks throughout
the project, open the Resource Viewer, right-click these blocks, and
select Override or Auto.
1208 EC-gfxProgram
Block Actions
For blocks that support multiple BACnet objects at once, select through the
BACnet object to set the action.
Figure 684: Selecting override or auto for a block that supports multiple BACnet
objects at once
When Override is selected, set the value of the override in the dialog box and
click OK to apply the value.
NOTE: Large numbers are entered into a dialog box using a special format.
For example, 2.385X1012 is entered into a dialog box as 2.385E+12.
A null value is typed in as null.
ECL Series Sets or clears a block’s input or output value as follows when the controller is
controllers Online.
Table 32:
Hardware Output
Hardware
Property Block / LONWORKS Description
Input Block
Objecta
Override Forces the input to assume a user-set
value as its present value. The Out-of-
Service flag will be set. This uses the
nviModify mechanism to override the
value at priority level 2. See Priority lev-
els in LONWORKS (ECL Series).
Forces an output to assume a user-set
value.
Auto Clears an Override value and the Out-
of-Service flag will be cleared.
Clears an Override value.
Enum Value (ECL Series), Boolean Value (ECL Series), and Numeric Value
(ECL Series) Blocks
EC-gfxProgram 1209
For ECB & ECY Sets or clears a block’s input or output value as follows when the controller is
Series Online.
controllers
Table 33: Override and auto definitions
Hardware
Hardware Output (ECB
Input (ECB & & ECY Series)
Property Description
ECY Series) Block /
Block BACnet
Objecta
Override Forces the input to assume a user-set value as
its present value. The Out-of-Service flag will be
set.
Forces an output to assume a user-set value at
priority level 8. See Commandable object prior-
ity array levelss.
Auto Clears an Override value and the Out-of-Servi-
cee flag will be cleared.
Clears an Override value at priority level 8.
Analog Value (ECB & ECY Series), Binary Value (ECB & ECY Series), and
Multi State Value (ECB & ECY Series) Blocks
1210 EC-gfxProgram
Block Actions
Find All References (ECL, ECB & ECY Series)
For blocks that have numbers, select Find All References to search for
instances of this block on all Programming Sheets by right-clicking the block
and selecting Find All References as follows.
Figure 685: Selecting Find All References
The object(s) that use the resource are listed in the Search Results pane.
Double-click a search result to focus the programming sheet on that object,
which is shown highlighted.
Copy From
The Copy From window applies to resource blocks that have a block number
property. If there is another instance of the same type of block in the project,
one block can copy the configuration from another block through this window.
Figure 686: Copy From window
Right-click the block that is to receive the configuration from another block
and select Copy From as follows.
Figure 687: Selecting Copy From
EC-gfxProgram 1211
Configure Ports
The Configure Ports window lists all the input and output ports available for
the selected block. To make a port visible or hidden, simply check or deselect
the associated box. There is also a context menu shortcut to show or hide an
input or output port - see Show/Hide Ports.
Not all ports are visible by default when a block is dropped into the program-
ming sheet; therefore it is a good practice to always check the Configure Ports
window until you are more familiar with the properties of each block. In some
special cases, new ports become available when the Block’s Properties pane
are modified (for example, block numbers 13 to 17 of the Network Variable
Input block reveal additional outputs ports).
Ports with connection indicators (has the or symbol or are highlighted
blue in the Configure Ports window) and ports without connection indicators
(there is no or symbol at the port), but that are connected (highlighted
orange in the Configure Ports window), cannot be deselected, that is, they
cannot be hidden.
This advanced configuration window is accessible directly through all blocks
except the Text, Reference Hub and Reference Target blocks.
Control points can automatically be created in the EC-Net platform. When
possible: The name, format, and unit configured in EC-gfxProgram are auto-
matically exported to EC-Net. See Conversion of EC-gfxProgram formats to
EC-Net control points and Conversion of EC-gfxProgram formats to EC-Net
control points.
Right-click the block and select Configure Ports as follows.
Figure 688: Selecting Configure Ports
1212 EC-gfxProgram
Block Actions
Figure 689: Configure Ports window
Parameter Description
Check All If the input list selected, checks all input ports and if the
output list is selected, checks all output ports.
Uncheck All If the input list is selected, this deselects all input ports
except ports with connection indicators and if the out-
put list is selected, this deselects all output ports except
ports with connection indicators.
Rename Makes the name of the selected port editable (applica-
ble to Custom Block and Conditional Custom Blocks
only).
Move Up Moves the selected port up one position (applicable to
Custom, Conditional Custom, and For Loop (ECL, ECB
& ECY Series) blocks only) to increase the event’s pri-
ority.
Move Down Moves the selected port down one position (applicable
to Custom, Conditional Custom, and For Loop (ECL,
ECB & ECY Series) blocks only) to decrease the
event’s priority.
EC-gfxProgram 1213
Parameter Description
Format Opens the Format Editor window. The Format Editor
can be opened by clicking the drop-down arrow beside
the Format button or by right-clicking an output port
listed.
NOTE: The CurrentState and NextState output for-
mats for Calendar and Schedule blocks must
be set in the schedule’s configuration. See
Default Schedule Enumeration Values for more
information about the output formats that
should be used.
See also Making an exported input automatic, optional, or mandatory.
Format drop- The Format drop-down menu lists the most recently used formats. To access
down menu this menu, select one or more output ports and click the drop-down arrow
located next to the Format button or right-click the selected output port(s).
NOTE: The number of most recently used formats that are listed can be
changed in the EC-gfxProgram Options window.
Figure 690: Format drop-down menu
Parameter Description
Clear Recent Clears the list of most recently used formats.
List
Edit Opens the Format Editor window.
Clear Format Clears the current format of the selected output.
1214 EC-gfxProgram
Block Actions
Context menu Right-click an output port to view a list of recently-used formats. Formats can
also be added to a list of favorites by clicking Add to Favorites.
Figure 691: Output Port format context menu
Show/Hide Ports
This context menu lists all the input and output ports available for the selected
block. To make a port visible or hidden, simply check or deselect the associ-
ated box.
Not all ports are visible by default when a block is dropped into the program-
ming sheet; therefore it is a good practice to always check the full range of
ports that are available with the Show/Hide Ports context menu until you are
more familiar with the properties of each block. In some special cases, new
ports become available when the Block’s Properties pane are modified (for
example, block numbers 13 to 17 of the Network Variable Input block reveal
additional outputs ports).
Ports with connection indicators (has the or symbol or are highlighted
blue in the Configure Ports window) and ports without connection indicators
(there is no or symbol at the port), but that are connected, cannot be
deselected, that is, they cannot be hidden.
This context menu is accessible directly through all blocks except the Text,
Reference Hub and Reference Target blocks.
Right-click the block and select Show/Hide Ports as follows.
EC-gfxProgram 1215
Figure 692: Selecting Show/Hide Ports
See also Making an exported input automatic, optional, or mandatory.
1216 EC-gfxProgram
Block Actions
Set and reset timer (ECY series)
Certain time-related blocks have access to the Set Timer Value and Reset
Timer options directly from the context menu.
• Right-click on a timer block, and select Set Time Value to directly set the
starting value.
• Right-click on a timer block, and select Reset Timer to directly reset the
output to the initial value.
NOTE: These options apply to these time-related blocks: Timer, StopDelay,
StartStopDelay StartDelay, MinOffTime, MinOnTime, MinOnOffTime,
and Summation.
EC-gfxProgram 1217
Replacing blocks
Blocks that can logically be replaced by a block of another type (for example,
Comparator blocks) or blocks that have a logical opposite (for example,
Count Down and Count Up blocks) can be replaced directly on the program-
ming sheet without deleting them and redoing their connections to other
blocks.
To replace one block:
1. Right-click the block to replace and select the new block from the drop-
down Replace Block option.
Figure 693: Replacing an existing block on the programming sheet
To replace several blocks at the same time:
1. Select the blocks to replace (ctrl+click).
2. Right-click one of the selected blocks and select the new block from the
drop-down Replace Block option.
All selected blocks will be replaced by a block of the selected type.
Network Properties Configuration window (ECL,
ECB & ECY Series)
Set a block’s network configuration parameters in the Resources Configura-
tion by right-clicking the block and selecting Configure as follows.
1218 EC-gfxProgram
Block Actions
Figure 694: Selecting Configure
Network properties
ECL Series network properties
Status network The network properties associated to the block can be set for the block’s
variable NVOs and NVIs.
configuration
Figure 695: Typical status network properties configuration tab
EC-gfxProgram 1219
Parameter Description
Object name A descriptive name given to this object.
Common net- This is the name of the structured network variable
work name used for displaying the actual value on the LONWORKS
network. Note that because a structured network vari-
able contains more than one value, the min and max
send time are common to all structured network vari-
ables associated to this structured network variable.
Click Configure to view and configure the structured
network variable properties.
See Program network variable configuration.
LonMark Prop- The name in the title is the name of the network vari-
erties able used for displaying the actual value on the LON-
WORKS network.
COV min send The minimum time period that must pass before the
time this network variable is transmitted even if there is a
change in value greater than the COV Increment value
during this time. If the value of the network variable
changes, an update will only be sent after this time
expires. Setting the min send time to 0 disables it.
The minimum send time is often referred to as the
"throttle".
COV max send The maximum time lapse allowed between COV notifi-
time cations for the network variable even if the value’s
change is not greater than the COV Increment value
during this time. Setting the max send time to 0 dis-
ables it.
The maximum send time is often referred to as the
"heartbeat".
If max receive time is configured for the corresponding
network variable input, the recommended setting for
this value is half the COV max receive time (for an nvo)
value.
COV Increment The minimum change in value that will cause a value to
be propagated on the network.
1220 EC-gfxProgram
Block Actions
Parameter Description
COV max The maximum time period between received updates
receive time (for of the network variable on the network (whether or not
an nvo) the variable’s value has changed).
Setting this to zero disables this feature. When
enabled, the recommended setting for this value is
twice the max send time configured for the correspond-
ing network variable output.
A max receive time failure occurs if a network variable
update is not received on the network within the time
period set. On a max receive time failure, the NV will go
into alarm, and the NVI will return to its default value.
For each fan in value (if using fan in), the maximum
receive time is rounded up to the next higher whole
minute. For example, when Max receive time is set to
121 seconds; the value applied in reality will be 180
seconds.
COV max The maximum time lapse allowed between received
receive time (for COV notifications from the network into the configured
an nvi) network variable input associated to this block (for
example, a hardware output) before it goes to the
default value.
Program A Program network variable usually groups together a number values into a
network variable structured network variable, shown in the Common Network Variables. For
configuration example, in Figure 695 (left window), the window shows that hardware inputs
1 to 7 are grouped together in nvoHwIn01_07 under Program. A setting for a
structured network variable applies to all other related blocks that use this
structured network variable. Set the network properties as shown below (refer
to the controller’s Functional Profile in its datasheet). See also Typical control-
ler internal points.
Parameter Description
Object name A descriptive name given to this object.
EC-gfxProgram 1221
Parameter Description
Network name This is the name of the structured network variable
used for displaying the actual value on the LONWORKS
network. Note that because a structured network vari-
able contains more than one value, the min and max
send time are common to all structured network vari-
ables associated to this structured network variable.
Click Configure to view and configure the structured
network variable properties.
COV max send The maximum time lapse allowed for the configured
time Program network variable to be transmitted. This is
also known as heartbeat.
COV min send The minimum time period that must pass before the
time configured Program network variable is transmitted.
This is also known as throttle.
BACnet network properties
For ECB & ECY Series controllers, set the network properties as shown
below in the Resources Configuration.
Figure 696: Typical network properties configuration window in the resources
configuration
Property Description
Broadcast mode See Broadcast mode.
(ECY Series
controllers only)
Object name The object name. This is how this object will be identi-
fied on the network.
Object unit The unit for the object.
Units (optional)
NOTE: When a controller is equipped with an operator
interface or it is connected to an ECx-Display,
the format must be correctly configured for the
value’s unit to be correctly shown on the LCD
screen. See LCD interface Supported Units.
1222 EC-gfxProgram
Block Actions
Property Description
True text / false Assigns a Boolean format to the BACnet object, for
text (for Binary example, On, Off. Click Configure to create a new
Values only) enumeration or add a new member to an enumeration.
(ECB Series See Creating and using enumerations (8-Bit).
controllers)
Enumeration Select a pre-existing enumeration from the list.
(ECB Series
controllers)
Configure Create a new enumeration or add a new member to an
enumeration. See Creating and using enumerations (8-
Bit).
COV min send When another device subscribes to the object for COV,
time this is the minimum time lapse allowed between COV
notifications even if there is a change in value greater
than the COV Increment value during this time. See
also Reading and writing network points.
COV max send When another device subscribes to the object for COV,
time this is the maximum time lapse allowed between COV
notifications even if the value’s change is not greater
than the COV Increment value during this time.
COV increment When another device subscribes to the object for COV,
this specifies the minimum change in value that will
cause a COV Notification to be issued to subscriber
COV-clients.
Default value This value is used when all priority levels are set to
Null.
Minimum on For Binary Values and Hardware outputs set to Digital
time mode, this sets a temporary override at priority level 6
for the minimum amount of time a binary value will be
true (1) when a rising edge is written to this object. See
Commandable object priority array levels.
Minimum off For Binary Values and Hardware outputs set to Digital
time mode, this sets a temporary override at priority level 6
for the minimum amount of time a binary value will be
false (0) when a falling edge is written to this object.
See Commandable object priority array levels.
Broadcast mode Instead of regularly polling an object for its value, when this option is set to
Local or Global, this allows a device to push a value to the receiving control-
ler only when the value has changed at the remote controller. This method is
useful to reduce network congestion as information is transmitted only when
necessary. The remote controller must be configured for Send Broadcast
COV for the property value.
• None: The object’s value will not be broadcast.
EC-gfxProgram 1223
• Local: Broadcast the value to all devices that share the same Network
Number (are on the same subnet).
• Global: Broadcast the value to all devices on all networks. This global
broadcast is passed on (repeated) by Building Controllers according to
their routing configuration.
For blocks that have Broadcast Mode set to Local or Global, the Trigger-
Broadcast input port becomes available. A pulse at this input triggers a
broadcast of the object’s present value on the local or global network.
Change Type (ECP & ECL Series)
The Change Type window has all the SNVT types that can be assigned to the
block. It is typically used when there is a need to modify the variable type
before creating a binding.
Change type for Set the associated NVO on the other controller(s) to the same SNVT variable
netwrok variable type.
inputs
NOTE: If you change an NVI’s type in an external network management tool,
this will have no effect on the Network Variable Input block’s format
and configuration. It is recommended to use only EC-gfxProgram to
change the NVI type.
Figure 697: Typical NVI Change Type window
1224 EC-gfxProgram
Block Actions
Parameter Description
Network variable The name of the network variable as shown in the Net-
name workName property (in the Block’s Properties pane).
When you are using an LNS Network management
tool, this name is written to the associated network vari-
able, or if you are using EC-Net, this name is written to
the DisplayName field of the network variable. This
makes identification easier when making network con-
nections to the Network Variable Outputs of other
devices or HMIs.
Current type The current network variable type. If the type is
changed, this field is updated.
Current type The current network variable type length. If the type is
length changed, this field is updated.
Option When selected, lists only the network variable types
with the same length as the Current type length.
Type file Select a type file from the drop-down list. All available
type files from the device resource file catalog (stan-
dard and manufacturer defined) are listed. The Types
will change based on the .TYP file selected.
Types Select a type from the list. All types contained within
the selected .TYP file are listed and sorted by Name,
Field or Length.
Change type for Set the associated NVI on the other controller(s) to the same SNVT variable
network variable type.
outputs
NOTE: If you change an NVO’s type in an external network management tool,
this will have no effect on the Network Variable Input block’s format
and configuration. It is recommended to use only EC-gfxProgram to
change the NVO type.
EC-gfxProgram 1225
Figure 698: Typical NVO Change Type window
Parameter Description
Network variable The name of the network variable.
name When the option Automatically rename network vari-
able when changing a block name is set (see EC-
gfxProgram Options) and when you are using an LNS
Network management tool, this name is written to the
associated network variable, or if you are using EC-
Net, this name is written to the DisplayName field of the
network variable. This makes identification easier when
making network connections to the Network Variable
Outputs of other devices or HMIs.
Current type The current network variable type. If the type is
changed, this field is updated.
Current type The current network variable type length. If the type is
length changed, this field is updated.
Option When selected, lists only the network variable types
with the same length as the Current type length.
Type file Select a type file from the drop-down list. All available
type files from the device resource file catalog (stan-
dard and manufacturer defined) are listed. The Types
will change based on the .TYP file selected.
1226 EC-gfxProgram
Block Actions
Parameter Description
Types Select a type from the list. All types contained within
the selected .TYP file are listed and sorted by Name,
Field or Length.
Alarms (ECB & ECY Series)
Alarms are available with B-AAC and B-BC controller models only (see the
controller’s datasheet for more information) and are configured in the
Resources Configuration window. When the present value goes beyond pre-
defined thresholds, a notification message (Alarm or Event) is sent to a list of
other BACnet devices to warn of the alarm condition.
For ECB Series Controllers: For Values type blocks (Analog Value (ECB &
ECY Series), Binary Value (ECB & ECY Series), Multi State Value (ECB &
ECY Series)), only commandable objects support alarms (for more informa-
tion, see Commandable and non-commandable values (ECB & ECY Series
controllers)).
Notification classes are used to route alarms to other devices that have the
same set of properties, priorities, and use for the alarm or event notification. In
addition, the requirement for the acknowledgment from a human operator can
also be set (for a notification message only). See Configuring alarm recipi-
ents. ECB Series controllers are limited to five Notification Classes.
When Enable alarms is set, and the block is in an alarm state, the block’s
InAlarm output port is True(1). Alarms can also be temporarily disabled - see
also AlarmInhibit input (ECY Series controllers).
The alarm configuration varies according to the block type and its configura-
tion.
Table 34: B-AAC and B-BC controller alarm support
Configuration Type Found in Block Configuration Information
Binary Value (for ECB Binary Value (ECB & ECY Binary value block and digital
Series controllers, this Series) input alarms
applies to Commandable
instances only)
Digital Hardware Input Hardware Input (ECB & ECY Binary value block and digital
Light Sunblind Input (ECY Series) input alarms
Series only) Light Sunblind Input (ECB &
ECY Series expansion mod-
ules)
EC-gfxProgram 1227
Table 34: B-AAC and B-BC controller alarm support
Configuration Type Found in Block Configuration Information
Digital Hardware Output Hardware Output Digital and pulse hardware out-
Pulse Hardware Output Light Output put alarm
(ECB Series controllers)
Light Output (on/off
instances - ECY Series
only)
Analog Value (for ECB Analog Value Analog/Pulse input alarms
Series controllers, this Light Output
applies to Commandable Sunblind Output
instances only) Actuator Control
Light Output (dimmable Internal Actuator
instances - ECY Series VAV Differential Pressure
only) ComSensor
Sunblind Output (ECY Multi Sensor
Series only)
VAV Actuator Position (ECY
Series only)
VAV Actuator Command
(ECY Series only)
VAV Differential Pressure
(ECY Series only)
ComSensor (ECY Series
only)
Multi Sensor (ECY Series
only)
Linear Hardware Input Hardware Input Analog/Pulse input alarms
Pulse Hardware Input
Linear Hardware Input
RTD & Thermistors Hard-
ware Input
Setpoint Offset Hardware
Input
Custom Hardware Input
Analog Hardware Output Hardware Output Analog/Pulse input alarms
PWM Hardware Output
ComSensor ComSensor Analog/Pulse input alarms
Wireless Sensor Wireless Sensor Analog/Pulse input alarms
Multi State Value (for ECB Multi State Value Multi state value block and multi-
Series controllers, this level input alarms
applies to Commandable
instances only)
Multilevel Hardware Input Hardware Input Multi state value block and multi-
level input alarms
1228 EC-gfxProgram
Block Actions
Dynamic alarm activation thresholds adjust
When alarms are enabled for a block and any of the following inputs are avail-
able on the block, the alarm threshold can be dynamically adjusted by that
input: AlarmSetpoint, AlarmValue, Feedback, SpaceTempAlarmSetpoint,
or HumidityAlarmSetpoint.
To see all available ports and to make them available to project code when
possible, see Configure Ports. For more information about how to use these
inputs, refer to the description provided for the individual block. Links to these
blocks are found in Table 34.
Using a variable When alarms are enabled for an Analog Value (ECB & ECY Series) block, by
setpoint for the applying a positive input value to the AlarmSetpoint input increases the
alarm activation alarm setpoint values set in the Resources Configuration’s Alarms configura-
on an analog tion for the block (a negative value reduces the alarm setpoint values): The
value block High limit is now the High limit value (set in the resources configuration’s
Alarms configuration for the block) plus AlarmSetpoint input and the Low
example
limit is now the Low limit value (set in the resources configuration’s Alarms
configuration for the block) plus AlarmSetpoint input.
Figure 699: Analog values block alarms configuration window (ECY Series)
For example, this is ideal to use when you have a variable setpoint and you
want an alarm to be triggered when the measured value falls outside a set tol-
erance limit, say ±2ºF.
With the above settings for the Analog Value (ECB & ECY Series) block’s
Alarms Configuration parameters (2 set in High Limit and -2 set in Low
Limit), an Input of 75 with an AlarmSetpoint of 72, the Analog Value 1
block’s InAlarm output is True (1). This is because the block’s Input of 75 is
higher than the total of the High limit setting of 2 and the AlarmSetpoint
input of 72, which is 74.
Figure 700: Debugging values for this example
NOTE: When the AlarmSetpoint input is disconnected, you must reset the
controller (see Project Synchronization) or connect a Null value (ECL,
ECB & ECY Series) block to this port so the controller will release this
port as being unconnected.
EC-gfxProgram 1229
Figure 701: Using a numm block to release the AlarmSetpoint input
NOTE: When a block has the InAlarm output, setting or clearing High or Low
in the Limit enable options shown above has no effect on the activa-
tion of this output.
When the AlarmSetpoint input is disconnected, the High limit and Low limit
can be written to through the BACnet interface.
Fan start-stop The project code to create an alarm for a fan failure is shown below. Hard-
alarm project ware Input 1 reads the Fan Status. When there is a mismatch between the
code example value at Input of Hardware Output 1 and the value at Feedback, and alarm
in generated according to the properties set in the Hardware Output 1’s
Resources Configuration, Alarms tab.
Figure 702: Fan failure alarm project code example
AlarmInhibit input (ECY Series controllers)
For certain blocks, alarms that have been configured in the block’s Alarm con-
figuration can be temporarily suppressed by turning off the block’s alarm man-
agement so that no alarms will be reported by the block during the time alarm
inhibit is active. If a Time delay has been set and the alarm is re-enabled (the
AlarmInhibit input is 0), this Time delay counter is reset so that an alarm can
only be reported after the Time delay period has expired. This can be used to
suppress alarms during startup (to reduce nuisance alarms) for example.
Alarm inhibit can be activated as follows:
• When the block’s AlarmInhibit input is set to True(1), no alarms will be
reported by the block.
• In the block’s Resources Configuration, Alarm section, configure a Binary
Value in the Inhibit Binary Value property. See Figure 699. When the
value of this Binary Value is set to True(1), no alarms will be reported by
the block. The value of the Binary Value set in the Inhibit Binary Value
property has priority over the block’s AlarmInhibit input.
NOTE: For hardware inputs, alarm inhibit does not suppress Check out of
range or Check signal fault alarms.
To suppress alarms that result from a value that is out of range (e.g., a
network value that is out of range during network startup) or for a con-
nected sensor that is warming up (e.g., during system power up), set
an appropriate value (e.g., 300 to 900 seconds) in Time delay in the
1230 EC-gfxProgram
Block Actions
Alarm configuration. Set the alarm configuration according to the
block type shown in Table 34.
Binary value block and digital input alarms
Figure 703: Binary value blick and digital input alarms configuration window
Parameter Description
Enable Alarms Set to enable the BACnet alarm profile for this
Enabled block. This also creates the alarm properties on
the associated BACnet object and it enables the
block’s Inalarm output: When the block is in an
alarm state, the block’s InAlarm output port is
True(1).
Alarm value The present value that will trigger the To offnor-
mal alarm.
NOTE: This value can be externally controlled
by connecting an input to the block’s
Feedback input. See the block’s Feed-
back input description for more informa-
tion.
Time delay The minimum amount of time that a value must
be out of limit before a To offnormal or To Fault
notification message is sent.
Time delay (Normal) This is the minimum amount of time that a value
(for ECY Series only) must be back within limits before a To normal
notification message is sent.
Notify type Set the type of notification message to be used:
Alarm: Send an alarm notification type.
Event: Send an event notification type.
EC-gfxProgram 1231
Parameter Description
Event enable Set the types of service status change that will
trigger a notification message:
To offnormal: The present value is equal to the
block’s Alarm value input for a period set by
Time delay, thus triggering a To offnormal noti-
fication message.
To fault: A communication problem with an
ECx-400 Series Extension module triggers a To
fault notification message.
To normal: The present value is not equal to the
block’s Alarm value input for a period set by
Time delay, thus triggering a To normal notifi-
cation message.
To offnormal message For ECY Series controllers, the event notifica-
To fault message tion message content is user-configurable. See
To normal message Notification message configuration (ECY Series
controllers).
Notification class Set the BACnet Notification Class Object that is
Notify class used to route alarms with the same similar set of
properties to one or more devices. See Config-
uring alarm recipients.
1232 EC-gfxProgram
Block Actions
Digital and pulse hardware output alarm
A command failure notification message (as set in Notify Type) can be trig-
gered when alarms are enabled for a Hardware Output block configured as a
Digital output, and the value at the block’s Feedback input port is not the
same as the present value for a time period set by Time delay. See Hardware
Output (ECB & ECY Series) and Digital to configure the Hardware Output
block.
Figure 704: Digital output alarm configuration window
Parameter Description
Enable Alarms Set to enable the BACnet alarm profile for this
Enabled block. This also creates the alarm properties on
the associated BACnet object and it enables the
block’s Inalarm output: When the block is in an
alarm state, the block’s InAlarm output port is
True(1).
Time delay The minimum amount of time that a value must
be out of limit before a To offnormal or To Fault
notification message is sent.
Time delay (Normal) This is the minimum amount of time that a value
(for ECY Series only) must be back within limits before a To normal
notification message is sent.
Notify type Set the type of notification message to be used:
Alarm: Send an alarm notification type.
Event: Send an event notification type.
EC-gfxProgram 1233
Parameter Description
Event enable Set the types of service status change that will
trigger a notification message:
To offnormal: The present value is not equal to
the block’s Feedback value input for a period
set by Time delay, thus triggering a To offnor-
mal notification message.
To fault: A communication problem with an
ECx-400 Series Extension module triggers a To
fault notification message.
To normal: The present value is equal to the
block’s Feedback value input for a period set by
Time delay, thus triggering a To normal notifi-
cation message.
To offnormal message For ECY Series controllers, the event notifica-
To fault message tion message content is user-configurable. See
To normal message Notification message configuration (ECY Series
controllers).
Notification class Set the BACnet Notification Class Object that is
Notify class used to route alarms with the same similar set of
properties to one or more devices. See Config-
uring alarm recipients.
1234 EC-gfxProgram
Block Actions
Analog/Pulse input alarms
Figure 705: Analog value block and pulse, linear and analog input and output alarms
configuration window
Parameter Description
Enable Alarms Set to enable the BACnet alarm profile for this block.
Enabled This also creates the alarm properties on the associ-
ated BACnet object and it enables the block’s Inalarm
output: When the block is in an alarm state, the block’s
InAlarm output port is True(1).
Limit enable Use the High limit threshold and/or Low limit thresh-
old for To offnormal notification message generation.
High limit When the Limit enable: High is set and the present
value goes above this threshold, the To offnormal noti-
fication message is triggered.
NOTE: This value can be externally controlled by con-
necting an input to the block’s AlarmSetpoint
input. See the block’s AlarmSetpoint input
description for more information.
Low limit When the Limit enable: Low is set and the present
value goes below this threshold, the To offnormal noti-
fication message is triggered.
NOTE: This value can be externally controlled by con-
necting an input to the block’s AlarmSetpoint
input. See the block’s AlarmSetpoint input
description for more information.
EC-gfxProgram 1235
Parameter Description
Dead band Specifies the signal range above the Low limit and
below the High limit in which no notification message
can be triggered or retriggered; that is, if the present
value oscillates around the Low limit or High limit but
remains within the range defined by this value.
Time delay The minimum amount of time that a value must be out
of limit before a To offnormal notification message is
sent.
Time delay (Nor- This is the minimum amount of time that a value must
mal) (for ECY be back within limits before a To normal notification
Series only) message is sent.
Notify type Set the type of notification message to be used:
Alarm: Send an alarm notification type.
Event: Send an event notification type.
Event enable Set the types of service status change that will trigger a
notification message:
To offnormal: The present value is outside the limits
set by Limit enable, High limit (plus the block’s
AlarmSetpoint value input), and Low limit (plus the
block’s AlarmSetpoint value input) for a period set by
Time delay, thus triggering a To offnormal notification
message.
To fault: A communication problem with an ECx-400
Series Extension module triggers a To fault notification
message.
To normal: The present value is inside the limits set by
Limit enable, High limit (plus the block’s AlarmSet-
point value input) minus Deadband, and Low limit
(plus the block’s AlarmSetpoint value input) plus
Deadband for a period set by Time delay, thus trigger-
ing a To normal notification message. See Figure 706.
To offnormal For ECY Series controllers, the event notification mes-
messageTo fault sage content is user-configurable. See Notification
messageTo nor- message configuration (ECY Series controllers).
mal message
Notification Set the BACnet Notification Class Object that is used to
classNotify class route alarms with the same similar set of properties to
one or more devices. See Configuring alarm recipients.
1236 EC-gfxProgram
Block Actions
Figure 706: Event operation example
Multi state value block and multilevel input alarms
Figure 707: Multi state value block and multilevel input alarms configuration window
Parameter Description
Enable Alarms Set to enable the BACnet alarm profile for this
Enabled block. This also creates the alarm properties on
the associated BACnet object and it enables the
block’s Inalarm output: When the block is in an
alarm state, the block’s InAlarm output port is
True(1).
Fault values The enumeration value to trigger a fault.
Alarm values The enumeration value to trigger an alarm.
Configure fault and Set the enumeration values to trigger a fault and
alarm values alarm. See Configuring fault and alarm values.
EC-gfxProgram 1237
Parameter Description
Time delay The minimum amount of time that a value must
equal any Alarm values member before a To
offnormal or To Fault notification message is
sent.
Time delay (Normal) This is the minimum amount of time that a value
(for ECY Series only) must be back within limits before a To normal
notification message is sent.
Notify type Set the type of notification message to be used:
Alarm: Send an alarm notification type.
Event: Send an event notification type.
Event enable Set the types of service status change that will
trigger a notification message:
To offnormal: The present value is the same as
any Alarm values for a period set by Time
delay, thus triggering a To offnormal notifica-
tion message.
To fault: The present value is the same as any
Fault values, thus triggering a To fault notifica-
tion message.
To normal: The present value does not match
any Alarm values for a period set by Time
delay, thus triggering a To normal notification
message.
To offnormal message For ECY Series controllers, the event notifica-
To fault message tion message content is user-configurable. See
To normal message Notification message configuration (ECY Series
controllers).
Notification class Set the BACnet Notification Class Object that is
Notify class used to route alarms with the same similar set of
properties to one or more devices. See Config-
uring alarm recipients.
Configuring fault According to the enumeration selected for the block, the values for the enu-
and alarm values meration are shown. Any enumeration value can be selected to send either a
fault or alarm notification according to the enumeration’s present value.
1238 EC-gfxProgram
Block Actions
Figure 708: Fault and alarm configuration window
Notification message configuration (ECY Series
controllers)
For ECY Series controllers, the event notification message content is user-
configurable. This allows you to type free text (a description for example) with
variables based on the value of any controller BACnet object.
A drop down list (Insert variable) provides quick access to pre-defined vari-
ables for the most commonly-used BACnet objects.
Table 35: Notification message variable description
Variable Description
Device name This is set in set in the BACnet Settings screen in the
controller’s Web Configuration Interface.
Notification The text of the Notify class set for this object.
class name
Object name The text of the Object name set for this object.
Object descrip- The text of the Description set for this object.
tion
Object unit The text of the Units set for this object.
Object present The object’s present value.
value
Object event The object’s event notification type (To offnormal, To
state fault, To normal).
Object high limit The object’s current alarm high limit threshold.
Object low limit The object’s current alarm low limit threshold.
EC-gfxProgram 1239
However, you can create a variable that will be sent in the event notification
message based on the value of any controller BACnet object as follows.
Figure 709: Constructing a variable
B
A C D
Item Description
A A variable is always enclosed in curly brackets {}.
B OPTIONAL: The variable’s source:
• D: the current device
• N: the notification class configured for the current object
• O: the current object. This is the default option when this
parameter is not specified
C Any controller BACnet object property name. For example, if the
controller is operating under EC-Net, you can view a list of the
controllers’ current BACnet object under the Station > Config >
Drivers > BcpBacnetNetwork > [ECY Series controller name] >
Config. See also the controller’s PICS and BACnet standards doc-
umentation.
D OPTIONAL: The format of numeric values can be truncated for
cleaner user-interface presentation. Two operators are commonly
used: 0 and #.
For example,
• if the object’s numeric value is 2.265487, the following opera-
tors have the effect shown:
0 becomes 2
0.0 becomes 2.3
0.00 becomes 2.27
# becomes 2
#.# becomes 2.3
#.## becomes 2.27
• if the object’s numeric value is 2.0, the following operators
have the effect shown:
0 becomes 2
0.0 becomes 2.0
0.00 becomes 2.00
# becomes 2
#.# becomes 2
1240 EC-gfxProgram
Block Actions
For example, the following is an example of an event message that shows
free text combined with variables.
Coolant Tank Level {D.PresentValue:0.00} is {EventState}.
Configuring alarm recipients
ECB Series controllers support BACnet notification messages only. ECY
Series controllers support both BACnet notification messages and Email noti-
fication messages.
The following procedures must be carried out for a notification messages
(alarm or event) to be sent to a recipient.
• The notification class must be configured, and the recipient for each noti-
fication class must be configured. See BACnet notification class configu-
ration and Adding a new BACnet notification recipient.
• The device that receives the BACnet notification messages must also be
configured, for example in EC-Net. See About alarms with the EC-Net
platform.
• For ECY Series controllers, notification messages can also be sent to an
Email recipient. See Configuring a notification class to send email alerts
(ECY Series).
BACnet notification class configuration
BACnet Notification Class Objects are used to route notification messages
with a similar set of properties to one or more recipients (devices). Set the
Notification Class parameters as shown below. See Adding resource block
instances to the resource tree to add Notification Classes to the Resources
Configuration tree.
Figure 710: Notification class resources configuration tree notification class (ECY
Series)
Parameter Description
Notification Classes The five notification classes. Click one to edit its
properties on the right.
To offnormal prioritya A user-defined value used to prioritize offnormal
events and alarms that are coming from different
controllers and notification classes. For example, a
B-OWS can sort alarms from different controllers
when each one uses a unique priority value.
EC-gfxProgram 1241
Parameter Description
To fault prioritya A user-defined value used to prioritize fault events
and alarms that are coming from different control-
lers and notification classes. For example, a B-
OWS can sort alarms from different controllers
when each one uses a unique priority value.
To normal prioritya A user-defined value used to prioritize normal
events and alarms that are coming from different
controllers and notification classes. For example, a
B-OWS can sort alarms from different controllers
when each one uses a unique priority value.
Ack required Sets whether an acknowledgment is required for
To offnormal, To fault, and To normal event tran-
sitions.
Recipient List Contains a list of devices to be informed when an
event or alarm message needs to be sent. Click
to edit a recipient’s properties (See Adding a
new BACnet notification recipient for more infor-
mation). Click to delete a recipient from the
Recipient List.
Add new recipient Click to add a new recipient. See Adding a new
BACnet notification recipient.
a) BACnet defines a priority range of 0 to 255 according to the following table.
Alarm or Event
Network Priority
Priority
00-63 Life Safety message
64-127 Critical Equipment message
128-191 Urgent message
192-255 Normal message
Adding a new For ECB Series controllers, each of the five notification classes specifies one
BACnet to five destination devices (list of recipients) that will receive notification mes-
notification sages for this notification class from the current controller.
recipient
For ECY Series controllers, see Adding resource block instances to the
resource tree to add Recipients to the Resources Configuration tree.
1242 EC-gfxProgram
Block Actions
Figure 711: Recipient resources configuration (ECY Series)
Parameter Description
Days of week The days of the week that notification messages will be
sent to this recipient.
Start time The time of day that notification messages will be sent
End time to this recipient.
Process identi- Sets the process identifier within the recipient device.
fier The process identifier is a number that is only under-
stood by the destination device to signify what the cur-
rent notification means, and its appropriate treatment.
In EC-Net, this is the Niagara Process Id (see About
alarms with the EC-Net platform).
Notifications Sets whether confirmed or unconfirmed notifications
are to be sent to the destination device. Confirmed noti-
fication increases the traffic on the network and
enables APDU Retry.
Transitions Set to enable the event types to be sent to the destina-
tion device.
Recipient The destination device (recipient to receive notification
messages) can be specified as follows:
• BACnet Node Address
• BACnet device instance – Click Select device
from database to open a list of devices in the data-
base. This is the preferred option when using EC-
Net.
About alarms with the EC-Net platform
The EC-Net platform can only accept notification messages sent to a single
Niagara Process Id. This is set by double-clicking Alarms under Station,
Config, Drivers, BcpBacnetNetwork, [device] in the Nav tree. The Niagara
Process Id must be the same value set for Process Identifier in the Notifi-
cation Recipient Configuration window (see Figure 711).
EC-gfxProgram 1243
Figure 712: Alarms configuration in EC-Net
WARNING: For notification messages to work efficiently with the EC-Net Plat-
form, you must build the control points in EC-Net for all EC-gfx-
Program objects that are configured to generate an alarm. To do
this, see Automatic generation of control points from EC-gfxPro-
gram code.
If there is an alarm for a point for which no control point was cre-
ated in EC-Net, the alarm will take approximately 10 seconds
more to resolve. Also, the alarm source’s control point’s name
will not be shown to the console’s recipient.
Configuring a notification class to send email alerts
(ECY Series)
For ECY Series controllers, notification messages can be sent to an Email
recipient. For this, the following elements need to be configured.
• First create one or more Email accounts that will be used to send notifica-
tion messages to recipients. The controller uses a network connected
Email provider’s SMTP server to send out-going Email. See below.
• Once an Email account is created, it is then used in the Notification Class
configuration - see Adding a new email recipient.
1244 EC-gfxProgram
Block Actions
Adding a new For the controller to send an Email message, the controller must be able to
email account log into a previously-configured Email account or SMTP server. An SMTP
server handles Internet mail delivery and may be provided by your Internet
Service Provider, or by Gmail for example. Thus, the required configuration
parameters are normally provided by your ISP or mail service provider.
To add Email Recipients to the Resources Configuration tree, see Adding
resource block instances to the resource tree.
Figure 713: Email server settings
Parameters Description
Hostname The Email provider’s SMTP server’s name.
Port The port number used to connect to the SMTP server.
Account The host name of the Email provider’s out-going Email
server. For example, smtp.example.com.
NOTE: Create a Gmail and Hotmail account to be used
for this purpose only. For example Headquar-
[email protected].
If you use a personal Email account for this
controller’s Email account, it may not work as
some Email servers have security that prevents
it from sending email from an unrecognized
device that is different from the device you nor-
mally use to send Email messages with.
Use authentica- Set this option if the Email account requires the use of
tion a username and password to send Email.
Username Your user name for this account. Some Email providers
require the full Email address as the user name.
Password The Email password you use to sign in to the account.
EC-gfxProgram 1245
Parameters Description
Encryption Some Email provider’s SMTP server use encryption to
secure the communications channel between the con-
troller and the Email server to prevent eves dropping.
Set the encryption mode used by the SMTP server if
necessary: SSL (Secure Sockets Layer) or TLS (Trans-
port Layer Security) encryption.
Connection tim- This is the maximum amount of time a message should
eout take to be transmitted to the Email provider’s SMTP
server before the controller assumes that the connec-
tion to the SMTP server has failed.
Typical email The following are the Email settings for Gmail and Hotmail services.
settings for
gmail and Parameters Gmail Hotmail
hotmail
Hostname Gmail Hotmail
Port Select according to the 587
encryption used.TLS:
587SSL: 465
Account smtp.gmail.com smtp.live.com
Use authentica- Set Set
tion
Username Full Gmail address. For Full Hotmail address. For
example, exam- example, example@hot-
[email protected] mail.com
Password Your Gmail password Your Hotmail password
Encryption TLS or SSL TLS
Connection tim- 10 10
eout
Sending a test A test Email message can be sent from an Email account to verify that it has
email been properly configured.
1246 EC-gfxProgram
Block Actions
Figure 714: Sending test email messages
Parameters Description
Test From This This sends a test Email message using the current
PC Email account settings from your PC. If the test Email is
received, the current Email account settings are valid.
If the controller in online and has internet connectivity, it
is best to use the Test From Device option.
Test From This sends a test Email message using the current
Device Email account settings from the connected controller.
The controller must be online and have internet con-
nectivity for this test to work. If the controller is not
online, then try the Test From This PC option.
If a test Email is received, the current Email account
settings and network configuration are valid.
Adding a new The controller’s Email service supports message texts created using UTF-8
email recipient character encoding only. To add Email Recipients to the Resources Configu-
ration tree, see Adding resource block instances to the resource tree.
EC-gfxProgram 1247
Figure 715: Email recipient resources configuration (ECY Series)
Parameter Description
Name The given name for this recipient.
Days of week The days of the week that Email notification messages
will be sent to this recipient.
Start timeEnd The time of day that Email notification messages will be
time sent to this recipient.
Transitions Set to enable the event types to be sent to the destina-
tion device.
Account Select the Email account to use to send notification
messages. Click to add a new Email account. Click
Configure to configure the selected Email account.
See Adding a new email account.
Body format The text format used for the Body text can be either
plain text or it can use HTML formatted text. HTML for-
matted text can use hyperlinks to Web pages and
graphics. In this case, use an HTML editor to create
HTML code and paste it into the Body text box.
1248 EC-gfxProgram
Block Actions
Parameter Description
From name The sender’s name that is to appear in the received
Email. Free text and variables can be used. See Table
36 for the definition of the variables that can be used.
To The Email addresses of the primary recipients of the
notification message. When two or more recipients are
listed, separate their Email addresses by commas (,).
For example, [email protected], [email protected]...
Cc The Email addresses of the secondary (informational)
recipients of the notification message. When two or
more recipients are listed, separate their Email
addresses by commas (,).
Bcc The Email addresses of extra recipients of the notifica-
tion message that are not seen by To and Cc recipi-
ents. When two or more recipients are listed, separate
their Email addresses by commas (,).
Subject This provides a summary or indicates the nature of the
message. Only UTF-8 character encoding can be
used.
Insert variable This inserts a variable into the current cursor position in
the Subject line or in the Body. See Table 36 for the
definition of these variables.
Body According to the Body format setting, this is the Email
message to be sent. Only UTF-8 character encoding
can be used.
A drop down list (Insert variable) provides quick access to pre-defined vari-
ables to use in Email messages.
Table 36: Email message variable descriptions
Variable Description
Device name This is set in set in the BACnet Settings screen in the
controller’s Web Configuration Interface.
Notification The text of the Notify class set for this object.
class name
Object name The text of the Object name set for this object.
Object descrip- The text of the Description set for this object.
tion
Object event The object’s event notification type (To offnormal, To
state fault, To normal).
EC-gfxProgram 1249
Table 36: Email message variable descriptions
Variable Description
Event process The process identifier used by the recipient device. The
identifier process identifier is a number that is only understood
by the destination device to signify what the current
notification means, and its appropriate treatment. See
Adding a new BACnet notification recipient.
Event device The BACnet network address (Node ID) of the device
identifier that is generating the event.
Event object The BACnet object identifier of the object that initiates
identifier the notification.
Event time The time the event occurred.
stamp
Event notifica- The BACnet Notification Class Object that is used to
tion class route alarms with the same similar set of properties to
one or more devices. See Configuring alarm recipients.
Event priority The relative alarm prioritization for processing:
00 to 63: Life Safety message
64 to 127: Critical Equipment message
128 to 191: Urgent message
192 to 255: Normal message
Event type Indicates the type of event transition that was used to
detect the event occurrence: To offnormal, To fault, To
normal.
Event message The text associated with the event.
Event notifica- The notification message type. Either ALARM or
tion type EVENT.
Event ack Indicates whether an acknowledgement is required for
required To offnormal, To fault, and To normal event transi-
tions.
Event from state The point’s alarm status prior to the alarm event.
Event to state The point’s alarm status at the moment of the alarm
event: Normal, Off Normal, and Fault.
Event values The value of the alarm event.
1250 EC-gfxProgram
Block Actions
Viewing a trend log (ECY Series)
When trending has been enabled for a programming block (see Resources
Configuration), the following options are available by right-clicking the pro-
gramming block on the programming sheet.
Figure 716: Opening a trend log
Property Description
View Trend Log Opens the trend log for the selected resource. See
History below.
Clear Trend Log Clears the trend log history for the selected resource.
When View Trend Log History is selected, the trend log is then shown for the
block.
Figure 717: Viewing a trend log
The Reload button in the Home ribbon bar reloads data from the device Note
that this operation may be time consuming, since all the points saved in the
device will be loaded For more information about the Trend Log window, see
Live Trend Log Home ribbon buttons and Live Trend Log Tools ribbon buttons.
EC-gfxProgram 1251
1252 EC-gfxProgram
The Toolbox Builder Tool
CHAPTER 8
The Toolbox Builder Tool
This chapter describes the toolbox Builder user interface including the differ-
ent toolbars, menus, and utility panes. It also provides a detailed explanation
of how to use the Toolbox Builder to create your own custom toolbox file (with
a .dll extension). Other program developers can then use the blocks created
in a custom toolbox once they have installed the toolbox file on their PC.
Topics
Toolbox tool overview
Overview of the toolbox builder user interface
Toolbox builder main menu toolbar
Using toolboxes
Creating a new toolbox
Creating a new toolbox with the toolbox builder
Toolbox troubleshooting
EC-gfxProgram 1253
Toolbox tool overview
What is a A toolbox is a file (with a .dll extension) that adds new programming blocks
toolbox? when installed on a PC with EC-gfxProgram. Toolboxes allow you to:
• Standardize and reuse project code in your organization by sharing tool-
boxes.
• Complete jobs faster and simplify field support by providing technicians
with tested, non-modifiable, application-specific blocks that are known to
work.
• Centralize the maintenance of a block’s logic and updates to be easily
applied to user’s code.
A toolbox is made from one or more code snippets (refer to Code Library).
Each of these code snippets are created from the root of a Custom block or a
Conditional Custom Block. For more information, refer to Creating a new tool-
box.
1254 EC-gfxProgram
The Toolbox Builder Tool
Overview of the toolbox builder user interface
The Toolbox Builder User Interface (UI) was developed to follow Windows UI
standards. The UI employs a number of easy-to-use and dynamic utility
panes and toolbars.
Figure 718: Toolbox builder user interface (UI)
Item Description Item Description
1 Properties Pane 4 Preview pane of how the toolbox will appear
when installed in EC-gfxProgram.
2 Main Menu Toolbar 5 Descriptive text for how to fill in the selected
Properties Pane field.
3 Tree View pane of the toolbox, 6 Build Output pane shows a log of the
groups, and blocks. toolbox build process. If the build is
unsuccessful, check this log for an
indication as to the problem.
EC-gfxProgram 1255
Toolbox builder main menu toolbar
The Main Menu toolbar is situated at the top of the Toolbox Builder tool. This
toolbar contains the commands and options that are needed to manage and
use the Toolbox Builder.
File This menu contains functions essential for starting, saving, and managing
your project.
Figure 719: File menu
Parameter Description
New Toolbox Creates a new toolbox.
Open Toolbox Opens a toolbox that was previously saved on your
Project PC’s file system. The Open window is used to locate
and open a .tbx file from the PC.
Close Closes the current toolbox.
Save Saves the current toolbox onto your PC’s file system.
The current toolbox can also be saved by pressing
Ctrl+S on the keyboard.
Save As Saves the current project under another filename.
Open Toolbox This opens the EC-gfxProgram Toolbox file directory in
Folder Windows Explorer.
Recent Projects Displays the most recently opened toolboxes. Select
an entry to open the toolbox.
Quit Exits the Toolbox Builder tool. If there is any unsaved
work in the toolbox, a prompt window will appear
asking if the toolbox is to be saved.
1256 EC-gfxProgram
The Toolbox Builder Tool
Toolbox This menu contains all the commands necessary to add groups and blocks to
a toolbox, or to remove a group or block from a toolbox.
Figure 720: Toolbox menu
Parameter Description
Add New Group When the toolbox is selected in the Tree View pane,
this adds a new group. Refer to Toolbox structure.
Add New When a group is selected in the Tree View pane, this
Snippet adds a new snippet to the group. Once a snippet is
added to the toolbox, it becomes a block. Refer to
Toolbox structure.
Create the snippet in any EC-gfxProgram project. The
snippet must be created from a Custom block or a
Conditional Custom Block.
Delete Deletes the selected group or block in the Tree View
pane.
Rename Renames the selected group or block in the Tree View
pane.
Build This menu contains commands to build the toolbox and to view the build log.
Figure 721: Build menu
Parameter Description
Build Toolbox Builds the toolbox and checks for any errors.
Show Build Shows the Build Output pane. This is a log of the
Output toolbox build process. If the build is unsuccessful,
check this log for an indication as to the problem.
EC-gfxProgram 1257
Using toolboxes
Toolbox Namespace is an attribute that you assign a string starting with a letter and
versioning contains any combination of letters and numbers including period (.). It usually
is represented as <YourCompanyShortName>.<YourToolboxName>.
EC-gfxProgram uses the Namespace attribute in combination with the snippet
Programmatic name to identify the specific block in the toolbox. When toolbox
users update to a new toolbox version and a project is opened, blocks that
use both the same Namespace and Programmatic Name are updated every-
where they are used. Refer to Maintaining backwards compatibility.
By changing the Namespace attribute or Programmatic Name from a previ-
ously issued toolbox, you are creating a project code fork where there is no
backward compatibility with any previous toolbox version.
Maintaining When you want to update a block in a toolbox while maintaining backwards
backwards compatibility, you must observe the following points:
compatibility
• Ensure your toolbox uses the same Namespace variable attribute as the
previous toolbox version.
• Ensure the blocks in the toolbox use the same Programmatic Name vari-
able attribute as the blocks found in the previous toolbox version.
• Ensure that you do not delete a port or change the name of a port in the
Custom block / Conditional Custom Block used to create the code snip-
pet.
• Ensure that if you add a port, that it is defined as optional in the Custom
block / Conditional Custom Block used to create the code snippet. Other-
wise, when a user opens a project, they will receive a compilation error
and reprogramming for this new input will be required.
When a new toolbox is incompatible with the previous version, you should
change the toolbox’s filename and the Namespace variable to make a version
fork in the project code tree.
An alternate solution is to create a toolbox group for old blocks that are not to
be used and put old blocks in that group. This allows older projects to be
opened without requiring reprogramming as the Namespace and Program-
matic Name attributes are still available for the old blocks in the toolbox.
1258 EC-gfxProgram
The Toolbox Builder Tool
Toolbox version You can give a toolbox a version number. This is useful if you have two ver-
number sions of a toolbox file with the same Namespace and you want to know which
is the most recent, you can right-click the file in Microsoft Windows Explorer
and select Properties. Under the Details tab, you can see the toolbox’s ver-
sion number.
Information about the selected toolbox (including the version) can also be
viewed by clicking .
Figure 722: Click to view information about the selected toolbox
EC-gfxProgram 1259
Creating a new toolbox
Toolbox A toolbox can contain one or more groups and each group contains one or
structure more toolbox blocks. This structure is shown below.
Figure 723: The toolbox structure (toolbox name, group name, and block name) shown
in EC-gfxProgram
Toolbox creation The following is an overview of the steps to create a Toolbox.
overview
1. Create a Code Snippet from a single Custom block / Conditional Custom
Block (root Custom block). It is in this Custom block / Conditional Custom
Block you will create the project code for your toolbox block.
2. Create a toolbox with the Toolbox Builder.
3. Create one or more Groups within the toolbox.
4. Create one or more Blocks within a group.
5. Build the toolbox.
6. Restart EC-gfxProgram to make the new toolbox available for testing.
7. Share the toolbox file within your organization.
Prerequisites for The root Custom block used to create the code snippet cannot use any blocks
creating a new that use countable resources that are found in the Resource Viewer.
toolbox
Procedure to A toolbox block is created from the code snippet you create in this procedure.
create a code
snippet for a NOTE: You must validate your project code to ensure it builds without errors
toolbox block before making it into a toolbox block. The Toolbox Builder does not
validate the snippet code used to make a block
Create this code snippet as follows.
1. Add a Custom block / Conditional Custom Block to any project (this is the
root Custom block).
2. Double-click the root Custom block to go to the programming sheet for the
Custom block / Conditional Custom Block.
3. Add blocks to the programming sheet and connect them as you usually
would do to create valid code. Add Exported Inputs and Exported Outputs
to serve as the inputs and output connectors of the future block.
1260 EC-gfxProgram
The Toolbox Builder Tool
4. Return to the page of the root Custom block. See Show in Containing
Page.
5. Right-click the root Custom block and select Save As Code Snippet.
6. Give the code snippet a name and select the library where the snippet is
to be stored in the Add To Library window.
7. Find the snippet you just created in the Code Library and right-click it.
8. Select Export To File.
NOTE: Use a filename that only has alphanumeric characters. Filenames with
non-alphanumeric characters will be renamed by the Toolbox Builder
when they are imported to Snippets.
The snippet’s filename is used as the Block’s Programmatic Name by
default. See Create a block for more information.
9. Save the snippet on your PC.
Now you are ready to create a toolbox in which this snippet will become a
block. Repeat this procedure to make a toolbox with more than one block.
WARNING: Ensure you save and backup your project and snippet files
(source files). Only with these files can you update or modify a
toolbox in the future. It is impossible to recreate source files from
a toolbox.
EC-gfxProgram 1261
Creating a new toolbox with the toolbox builder
Create a toolbox Create a new toolbox as follows.
1. In the Tools menu of EC-gfxProgram, select Toolbox Builder. The Toolbox
Builder window opens.
Figure 724: The Toolbox Builder window
2. Enter the properties for the new toolbox in the following fields.
Figure 725: Setting the properties of the new toolbox
1262 EC-gfxProgram
The Toolbox Builder Tool
Parameter Description
Company Your company's name.
Copyright Your company's Copyright text.
Description Toolbox description text.
Filename Filename of the toolbox .dll file (required field).
Title The name of the toolbox shown in the EC-gfxProgram
drop-down selection.
Figure 726: Setting the Name of the Toolbox in the Toolbox
Drop-down List
Trademark Your company's Trademark text.
Version The version number for this toolbox. This is useful to
distinguish one version of a toolbox from another
toolbox file with the same Namespace. The version
number can be viewed by right-clicking the file in
Microsoft Windows Explorer and select Properties.
Under the Details tab, you can see the toolbox’s
version number.
Information about the selected toolbox (including the
version) can also be viewed by clicking (see Figure
726).
Namespace A unique name for this toolbox, usually in the form of
<CompanyName>.<ToolboxName> (required field).
This is the name that EC-gfxProgram uses to identify a
toolbox so as to maintain lineage (compatibility) with
future versions of this toolbox. All blocks in this toolbox
are internally identified with this Namespace in
combination with the Programmatic name. When you
update this toolbox and maintain the same
Namespace, the updated project code of the new
toolbox will be used everywhere in place of the
previous version the next time the project’s project
code is built and synchronized with the device. Refer to
Maintaining backwards compatibility.
Project File Path and filename for this toolbox project file (once the
toolbox has been saved). This property is view only.
Target File Path and filename for the generated toolbox .dll file.
This property is view only.
EC-gfxProgram 1263
Create a group Create a group as follows.
1. In the Toolbox menu, select Add New Group.
2. Enter the properties for the new group in the following fields.
Figure 727: Setting the group properties
Parameter Description
Description Toolbox Group description text.
Name The name of the group to be shown in the toolbox
explorer bar (required field).
Create a block Create a block as follows.
1. With the group selected, in the Toolbox menu, select Add New Snippet.
2. Find and select the snippet you saved in your file system in Procedure to
create a code snippet for a toolbox block. The snippet is added to the
group as a block.
1264 EC-gfxProgram
The Toolbox Builder Tool
3. Enter the properties for the new block in the following fields.
Figure 728: Setting the properties of the new toolbox
Parameter Description
Display Name The name for the block to be shown in the toolbox
explorer bar (required field).
Icon When this field is selected, click to select an image
file to be used as an icon for this block. Icons must be
48 X 48 pixels or less. Icons are saved in the database
with the toolbox. Icons of 16 X 16 pixels are
recommended as this uses the least space in the
database. When set, a thumbnail of the bitmap image
is shown.
File Path and filename for the snippet that is the source for
this block. When this field is selected, click to select
another snippet file as the source for this block.
Programmatic A unique name for this block that starts with a letter and
Name contains any combination of alphanumeric characters
(required field). This is the name that EC-gfxProgram
uses to identify a block so as to maintain lineage
(compatibility) with future versions of this block. When
you update this block with a new code snippet, the
updated project code will be used everywhere in place
of the previous version the next time the project’s
project code is built and synchronized with the device.
Refer to Maintaining backwards compatibility.
EC-gfxProgram 1265
Build the toolbox Build the toolbox as follows.
1. In the Build menu, select Build Toolbox. Wait for the Build Succeeded
message to be shown in the lower left corner.
2. If for any reason, the toolbox could not be built, the Build output form will
show up with detailed logs to troubleshoot the situation. The Build Failed
message will be shown in the lower left corner.
3. Restart EC-gfxProgram to make the new toolbox available for use.
Sharing a A Toolbox file can be shared with colleagues by sending them the toolbox .dll
toolbox file. Proceed as follows:
1. Open the Toolbox Builder application.
2. Click the File menu and select Open Toolbox Folder. Windows Explorer
opens to show the Toolbox file directory.
3. Send the toolboxes by any available file transfer method (Email file
attachment, ftp upload, etc.).
NOTE: If you create a toolbox that refers to another toolbox (contains a block
that was created with one or more blocks from another toolbox), the
first toolbox is dependent on the second. Because of this dependency,
all toolboxes that are required to make a block work must be sent
together and installed on the target project code development PC.
Installing or Installing a Toolbox file on a PC makes the programming blocks of that tool-
updating a box available to the graphical programming tool. Installing an updated Tool-
toolbox box file on a PC will update the project code for those toolbox blocks
wherever they are used in a project, so long as the toolbox’s internal Name-
space variable attribute and the Programmatic Name attributes variables for
the blocks are the same as those of the old toolbox (refer to Maintaining back-
wards compatibility). Toolbox files have a version number to help to know
which file is the latest; see Toolbox version number.
To install a Toolbox file on a PC, proceed as follows.
1. Open the Toolbox Builder application on the target PC.
2. Click the File menu and select Open Toolbox Folder. Windows Explorer
opens to show the Design Toolbox file directory.
3. Save the updated toolbox file(s) into the above directory. Overwrite the
old files with the new ones being copied if necessary.
4. Close the Toolbox Builder application.
5. Restart EC-gfxProgram if it is currently running.
6. Load your project code.
7. Build the project and send it to the device.
1266 EC-gfxProgram
The Toolbox Builder Tool
Toolboxes are If a project uses one or more blocks from a toolbox, the entire toolbox is saved
saved in the in the LNS or EC-Net database for that device if it has not already been saved
database there or the version saved there is out of date. Toolboxes are never saved on
the device with the project as is the case with code. If you open a project from
the database that uses a toolbox that is not currently installed on your PC, the
necessary toolboxes will be uploaded to the PC from the database.
NOTE: If the toolbox (with the same filename) is already available on the proj-
ect code development PC, it is this version of the toolbox that will be
used when opening and generating the project code for the project.
See also Toolbox Version Number for how to identify a toolbox ver-
sion.
When you load a EC-gfxProgram project that uses blocks from toolbox that do
not exist on your PC, EC-gfxProgram will ask you if it can look for the right
toolbox in the database (EC-Net or LNS) so that the blocks in your project can
be resolved.
Figure 729: Click Yes for EC-gfxProgram to look for the toolbox in the database
Available LNS and EC-Net databases can store at maximum 192 kB of toolboxes. EC-
storage space gfxProgram uses the ZIP compression algorithm to optimize toolbox space
for toolboxes in usage of the toolboxes used for a given project in the database. However, if
the database the ZIPed toolboxes are too large for this 192 kB file size limit, the toolboxes
will not be backed up in the database.
EC-gfxProgram 1267
Toolbox troubleshooting
Unavailable When you open a project that uses a block from a toolbox that is not available
block on your PC, EC-gfxProgram asks if you want to try to retrieve the toolbox from
the database. If the toolbox cannot be found, the block is flagged with “The
object “[object name]” is not supported by the current device.” errors in
the Error List.
This is due to EC-gfxProgram not being able to find any block with a matching
toolbox Namespace variable and / or block Programmatic Name variable attri-
butes. Technically, the block type could not be resolved by EC-gfxProgram.
Figure 730: Unavailable blocks are shown in red
In this case, the Namespace, Programmatic Name, and toolbox name of the
unavailable block is shown in the Error List.
This situation can be solved by:
• Installing the necessary toolbox on your PC as identified in the Error List.
• Deleting the block.
The missing toolbox can also be resolved if it was saved in the database.
(See Toolboxes are saved in the database). Re-open the project and when
EC-gfxProgram asks if you want to try to retrieve the toolbox from the data-
base, click Yes.
Deleting a When EC-gfxProgram is started, it copies all Toolbox files found in the above
toolbox from mentioned Design Toolbox file directory to the RunTime directory located just
your PC above the Design directory.
To delete a Toolbox file, you must delete it from both the Design and Run-
Time directories.
Figure 731: The Design and RunTime directories
NOTE: Make sure that no project refers to the toolbox you are deleting. Other-
wise, if the toolbox was saved in the database, then it will be down-
loaded as soon a project that refers to it is loaded.
1268 EC-gfxProgram
Calendar and Schedule Tool (ECL, ECB & ECY Series)
CHAPTER 9
Calendar and Schedule Tool (ECL, ECB
& ECY Series)
This chapter explains how to configure calendars and schedules on ECL
Series and ECB & ECY Series controllers with the Calendar and Schedule
Tool.
Topics
Using schedules and calendars
Calendar and schedules configuration overview (ECL, ECB & ECY Series)
Getting started on the calendar and schedule tool
Overview of the calendar and schedule user interface
File menu
Home ribbon
Current view
Shortcuts
Schedule/Calendar instance selector
About the calendar and scheduler
Configuring a schedule (calendar and schedule tool)
Configuring a calendar (Calendar and Schedule tool)
EC-gfxProgram 1269
Using schedules and calendars
Schedules are typically used to define a weekly schedule for example, the
work week can be defined as Monday through Friday with working hours from
8:00 a.m. to 5:00 p.m. Schedules also have special events that take priority
over the weekly schedule. A special event can be a reference to a calendar.
Calendars on the other hand let you globally specify holidays and other spe-
cial days in one place. A calendar can then be referenced in multiple sched-
ules, allowing you to create recurring holidays only one time that will change
the behavior of many schedules. This is shown below.
Figure 732: Inter-relation between schedules and calendars
NOTE: For ECL Series and ECB Series controllers: A schedule can have up
to 5 or 10 special events depending on the controller model - see the
controller’s datasheet for more information. A calendar can have up to
50 calendar events. Using calendars increases the total number of
“special events” a controller can manage.
1270 EC-gfxProgram
Calendar and Schedule Tool (ECL, ECB & ECY Series)
Calendar and schedules configuration overview
(ECL, ECB & ECY Series)
The following configuration methods are available to create, edit, and transfer
both calendar and schedule information into a controller:
• By configuring both calendars and schedules with the Calendar and
Schedule Tool by launching it from EC-gfxProgram, shown below as
Method A.
• By configuring both calendars and schedules with the Calendar and
Schedule Tool LNS Plugin, shown below as Method B.
• By configuring both calendars and schedules with the Calendar and
Schedule Tool by launching it from the desktop (this is called standalone
mode). When connecting to a controller on the EC-Net platform, connec-
tion Method A is used (shown below). When connecting to a controller on
the LNS platform, connection Method B is used.
Only one configuration method should be used at a time so as to avoid con-
flicts between these methods. However, it is sometimes possible to change
from one configuration method to another while conserving previously created
calendars and schedules as best as possible.
Figure 733: Overview of the calendar and schedule configuration methods
Application The Calendar and Schedule Tool (including the LNS plug-in) is ideal for con-
trol networks that have no building controller or HMI.
When a EC-Net building controller is used, it is best to configure both sched-
ules and calendars in EC-Net so that they are centralized for use by all parts
of the control network by more than one controller (do not use this Calendar
and Schedule Tool). To configure a schedule or calendar in EC-Net.
EC-gfxProgram 1271
Getting started on the calendar and schedule tool
Prerequisite The following requirements must be met before starting.
steps
1. Launch the Calendar and Schedule Tool:
• In EC-gfxProgram, add a Calendar or Schedule block to the pro-
gramming sheet. Right-click the block and select Build Calendar or
Build Schedule to open the Calendar and Schedule Tool.
• For ECL Series controllers: In LNS, right-click the device and select
Plug-Ins (Device) > Scheduler to open the Calendar and Schedule
Tool.
• For ECL Series and ECB Series controllers: Launch it from your
desktop. This is called the standalone mode.
• Once the Calendar and Schedule Tool is open, any calendar or
schedule instance can be configured on the current controller.
2. Select the schedule or calendar instance you want to configure. See
Schedule/Calendar instance selector.
3. For ECB & ECY Series controllers only: Each schedule has its own data
type. Set the data type for this instance. See Change schedule type.
4. For ECB & ECY Series controllers only: If the data type is an enumera-
tion, set the enumeration type. See Enumeration list editor (ECB & ECY
Series controllers only).
5. Set the default value for this schedule instance. Each schedule instance
is set individually. See Schedule default value.
Configuration Proceed with schedule or calendar configuration as follows.
steps
1. Configure the schedule or calendar. See Configuring a schedule (calen-
dar and schedule tool) and Configuring a calendar (Calendar and Sched-
ule tool).
2. Save the schedules and calendars to the controller or to the database.
Use either the Save To Device or Save To Database option. See File
menu.
3. Schedules and calendars can be saved as an xml file. By saving the cur-
rent configuration as a template, it can then be imported when this tool is
connected to another controller. Modifications can then be made before
the schedule or calendar configuration is saved to that controller or data-
base.
NOTE: The time format (AM/PM or 24 hour clock) is shown in the user inter-
face according to your PC’s regional settings.
1272 EC-gfxProgram
Calendar and Schedule Tool (ECL, ECB & ECY Series)
Resolving Calendars and schedules can be modified through a number of methods (see
schedule / Calendar and schedules configuration overview (ECL, ECB & ECY Series)).
calendar When opening the Calendar and Schedule Tool in EC-gfxProgram, the follow-
conflicts (ECL ing window may appear. It indicates that the calendar or schedule saved in
Series & ECB your EC-gfxProgram project is different from the calendar or schedule saved
in the database. This occurs when:
Series)
• The calendars and schedules have been configured with the Calendar
and Schedule Tool in LNS or in standalone mode (Calendar and Sched-
ule Tool launched from your PC).
• A EC-Net building controller is used to configure the calendars and
schedules for a controller, any changes to calendars and schedules made
locally in the controller through the operator’s interface / ECx-Display
(color LCD screen) are synchronized with the EC-Net building controller’s
database, when the controller is a client of a BcpBacnetNetwork or a
BcpLonNetwork.
For more information about these configuration modes, see Calendar and
schedules configuration overview (ECL, ECB & ECY Series).
Figure 734: Schedule/Calendar conflict resolution selection
Parameter Description
Use the Replace the calendar / schedule in the database by the
calendar / one stored in the EC-gfxProgram project.
schedule in the
project
EC-gfxProgram 1273
Parameter Description
Use the Replace the calendar / schedule in the EC-gfxProgram
calendar / project by the one stored in the database.
schedule in the
database
Do this for the Set this to automatically repeat the above selected
next x conflict option for the remaining calendar / schedule conflicts.
Uploading When a controller is equipped with an operator’s interface / ECx-Display
calendars and (color LCD screen), changes to calendars and schedules made locally in the
schedules from controller through the LCD screen are not propagated to any database that
controllers the Calendar and Schedule Tool uses.
equipped with an
NOTE: When a EC-Net building controller is used to configure the calendars
operator’s
and schedules for a controller, changes to calendars and schedules
interface / ECx-
made locally in the controller through the operator’s interface are syn-
Display (color chronized with the EC-Net building controller’s database, when the
LCD display) controller is a client of a BcpBacnetNetwork or a BcpLonNetwork. See
(ECL Series & Calendar and schedules configuration overview (ECL, ECB & ECY
ECB Series) Series).
If you suspect that a calendar or schedule may have been modified directly on
the controller through the controller’s LCD screen and you want to keep this
information, perform an Import From Device action (see File menu) when
you first open the Calendar and Schedule Tool.
1274 EC-gfxProgram
Calendar and Schedule Tool (ECL, ECB & ECY Series)
Overview of the calendar and schedule user inter-
face
The Calendar and Schedule user interface (UI) was developed to follow Win-
dows UI standards. The UI employs a number of easy-to-use menus and tool-
bar.
Figure 735: Calendar and schedule tool user interface (UI)
2 5
6
3
7
4
Item Description Item Description
1 File Menu: Contains the commands 2 The current view. See Current view.
and options that are needed to
manage and use the Calendar and
Scheduler. See File menu.
Home Ribbon: Provides quick
access to features that are contained
in the Main Menu. See Home ribbon.
3 The Weekly Schedule view. See 4 A previously created event. See Creating
Weekly schedule. an event.
5 The currently selected schedule or 6 Set or fine tune the selected event’s
calendar instance being configured. properties. See Changing the event’s
See Schedule/Calendar instance properties and Setting a Setting a special
selector. event’s properties.
EC-gfxProgram 1275
Item Description Item Description
7 A default value is the value that will be 8 The Status Bar shows the name of the
effective when there is no active connected device, the network interface
event. See Schedule default value. used to make the connection, and the
connection status.
The date and time is read from the device.
When the controller is offline, the date and
time is hidden.
NOTE: The controller’s time is not used to
calculate if a Special Event is cur-
rently Active or Inactive. See Spe-
cial events.
1276 EC-gfxProgram
Calendar and Schedule Tool (ECL, ECB & ECY Series)
File menu
The File menu contains the commands and options that are needed to man-
age and use the Calendar and Scheduler.
About XML file Schedules and calendars can be saved onto your PC in an XML file format.
formats An XML file contains the complete information about schedule/calendar (data,
special event’s names, and enumeration members information).
File menu Figure 736: File menu options
options
Parameter Description
Select Device Opens the Select Device window. Select the device on
(Standalone the current network to connect to.
Mode Only)
For more information about the different modes to
launch the Calendar and Schedule Tool, see
Prerequisite Steps.
Save > Save To For ECY Series controllers, saves the current calendar
Database and schedule in the gfx project file, so it can later be
sent to a device when the project is synchronized.
For ECL & ECB Series controllers: Saves the current
calendar and schedule instances to the EC-Net or LNS
database.
Save > Send To For ECY Series controllers: Saves the current calendar
Device and schedule instances to the currently connected
device (when connected).
For ECL & ECB Series controllers: Saves the current
calendar and schedule instances to the EC-Net or LNS
database, and then to the currently connected device
(when connected).
Save > Save To Saves the current calendar and schedule instances to
File a file as an .xml format.
EC-gfxProgram 1277
Parameter Description
Import > Import For ECY Series controllers, imports the calendar and
From Database schedule instances from the gfx file. Note that this
option is only possible if a calendar and schedule
instance has previously been saved in the gfx file
(Save to Database).
For ECL & ECB Series controllers: Imports the
calendar and schedule instances from the EC-Net or
LNS database.
Import > Import Imports the calendar and schedule instances from the
From Device currently connected device.
Import > Import Imports the calendar and schedule instances from an
From File .xml file.
Copy > Copy Copies a schedule / calendar from another schedule /
From Schedule / calendar instance to the currently selected schedule /
Calendar calendar instance on the currently connected device.
Copy > Copy To Copies a schedule / calendar from currently selected
Schedules / schedule / calendar instance to one or more other
Calendars schedule / calendar instances on the currently
connected device.
Clear > Current Removes all events and configuration information from
Schedule the calendar or schedule currently selected by the
Schedule/Calendar instance selector.
Clear > All Removes all events and configuration information from
Schedules and all calendar and schedule instances being configured
Calendars for the current controller.
Remove > Completely removes from the controller the calendar or
Current schedule currently selected by the Schedule/Calendar
Schedule / instance selector.
Calendar from
Device (ECB
Series
controllers only)
Remove > All Completely removes all calendar and schedule
Schedules and instances from the current controller.
Calendars from
Device (ECB
Series
controllers only)
Connect To Opens a controller connected to a building controller so
Server it can be configured. This opens the Connect To
(Standalone Server window. Once the Connect To Server window
Mode Only) is open, press F1 for additional information.
Close Quit this application.
1278 EC-gfxProgram
Calendar and Schedule Tool (ECL, ECB & ECY Series)
Select device The Select Device window displays the devices available on the current net-
work and allows one to be selected so as to open it in an application for con-
figuration purposes.
Figure 737: Select Devices window
Clear Show only current device type to show all devices available on the
network.
EC-gfxProgram 1279
Home ribbon
Figure 738: Home ribbon
Parameter Description
New Event According to the current context, this creates a new
weekly event in the Weekly Schedule tab or a special
day in the Special Event tab. When in a schedule, see
Configuring a schedule (calendar and schedule tool).
When in a calendar, see Configuring a calendar
(Calendar and Schedule tool).
Rename Rename the selected schedule or calendar. This is the
Schedule / name by which the schedule or calendar will be
Calendar identified on the network.
Change Select the data type for the current calendar or
Schedule / schedule. See Change schedule type.
Calendar Type
Copy Copies a selected calendar or schedule event (a
weekly event in the Weekly Schedule tab or an event in
the Special Event tab) and keeps it temporarily in
memory so that it can be added to another calendar or
schedule. Use the Paste command to add the copied
calendar or schedule entry to the new location. A
calendar or schedule entry can also be copied by
pressing Ctrl+C on the keyboard.
Paste Used in conjunction with the Copy command. After
selecting the new location for the copied calendar or
schedule entry, use the Paste command to place the
calendar or schedule entry in the new location. A
calendar or schedule entry can also be pasted by
pressing Ctrl+V on the keyboard.
Delete Deletes a selected calendar or schedule entry. A
calendar or schedule entry can also be deleted by
pressing Delete on the keyboard.
Message History Lists all system or network errors.
1280 EC-gfxProgram
Calendar and Schedule Tool (ECL, ECB & ECY Series)
Parameter Description
Current View This displays the current view:
• The Weekly Schedule view. See Weekly schedule.
• The Special Events view. See Special events.
• The Effective Period view. See Effective period.
Change A built in default enumeration that cannot be modified is also provided, when
schedule type the Change type screen is configured as shown in Figure 739 (Type is set to
Enumerated and Enum is set to Occupancy). See also Default schedule enu-
meration values for this enumeration’s values.
Schedules support a number of data types. Each schedule can be set to any
one of these data types.
Select Change Schedule Type from the Edit menu.
Figure 739: Change type
The following event data types are supported.
Type Description
Boolean Assigns a binary format to the output of True (1) and
False (0).
Numeric Any decimal number in the range of -3.40282347 X
1038 to 3.40282347 X 1038.
EC-gfxProgram 1281
Type Description
Enumerated Assigns enumerations to the output. An enumeration is
assigned to an output to provide a descriptive meaning
to the output based on a type of mode. For example,
instead of outputting a value of 3 for an HVAC mode,
an output can be assigned an enumeration so that it
will output HVAC_COOL (which corresponds to a value
of 3), which is much more descriptive than the numeric
value in of itself. See Enumeration list editor (ECB &
ECY Series controllers only).
When a schedule has been configured and the data type is changed, the
event values are converted as best as possible to the format of the newly
selected data type. However, changing the data type will require that you ver-
ify and if necessary set the value of all events and the default value.
Enumeration list This item is available only when the data type is set to Enumeration. The enu-
editor (ECB & meration editor allows you to create an enumeration, to change the number of
ECY Series members in an enumeration, or to change an enumeration member’s proper-
controllers only) ties.
Click Create or Edit in the Change Schedule Type window.
Figure 740: Enumeration List editor
Parameter Description
Add Add a member to the current enumeration.
Remove Deletes the currently selected member from the
enumeration.
Enum Name The enumeration’s name, for example Occupancy.
Name Sets the display name for this member that will be
shown in the interface when this enumeration member
is active.
1282 EC-gfxProgram
Calendar and Schedule Tool (ECL, ECB & ECY Series)
Parameter Description
NumericValue Sets the member’s value.
or Click to change the order of the selected enumeration
member by moving it up or down in the Members list.
Help These buttons are used to access the EC-gfxProgram’s help file, as well as
the version and build number in About.
Figure 741: Help
Parameter Description
Help Opens the EC-gfxProgram’s Help system for the
currently selected screen.
Content Opens the EC-gfxProgram’s Help system table of
contents.
EC-gfxProgram 1283
Current view
The current view buttons are only available when a schedule is selected in the
Schedule/Calendar instance selector.
Figure 742: Current view buttons
Parameter Description
Weekly Displays the Weekly Schedule view. See Weekly
Schedule schedule.
Special Events Displays the Special Events view. See Special events.
Effective Period Displays the Effective Period view. See Effective
period.
1284 EC-gfxProgram
Calendar and Schedule Tool (ECL, ECB & ECY Series)
Shortcuts
Several commands have a keyboard shortcut associated with them for more
rapid use. The table below contains all the commands that have a keyboard
shortcut associated with them.
Parameter Description
Ctrl+S Save the current calendars and schedules to the EC-Net or
LNS database.
Ctrl+C Copy a selected calendar or schedule entry and keeps it
temporarily in memory so that it can be added to another
calendar or schedule.
Ctrl+V Paste a copied calendar or schedule entry to the current
location.
Delete Delete the selected calendar or schedule entry.
Ctrl+R Rename the selected schedule or calendar. This is the name
by which the schedule or calendar will be identified on the
network.
EC-gfxProgram 1285
Schedule/Calendar instance selector
The schedule / calendar instance selector allows you to choose which one of
the Schedule / Calendar Instances to configure. The properties and configura-
tion information is shown for the selected Schedule / Calendar Instance.
Figure 743: Schedule/Calendar instance selector
For ECL Series and ECB Series controllers: Right-click a schedule or calen-
dar in the Instance Selector to rename it. This is the name by which the
schedule or calendar will be identified on the network.
Figure 744: Renaming a schedule/calendar instance
1286 EC-gfxProgram
Calendar and Schedule Tool (ECL, ECB & ECY Series)
About the calendar and scheduler
The following topics explain concepts necessary to know about this applica-
tion.
Schedule The Effective Period for a schedule defines the period during which the cur-
hierarchy rently selected schedule instance is active or inactive. When the schedule
instance is inactive, the schedule block’s TimeToNextState output is -1.
When the Effective Period for a schedule instance is active, there are three
types of schedule priority assigned to them should there be any conflict
between them. The current highest level schedule event will have precedence
over a lower priority schedule event.
Type Priority Description
Special 1 (highest) Special Events define a number of “Special Days” in the currently
Events selected schedule instance. Within Special Events, the priority of
Special Events is set by the order in which they are listed.
Weekly 2 Weekly schedules define regular, repeating, events by “time-of-day”
Schedule and “day-of-week.”
Schedule 3 (lowest) When no schedule event is active, the default value becomes
Default Value active. See Schedule default value.
EC-gfxProgram 1287
Schedule default A default value is configured that will be effective when there is no active
value event. This is set in the Weekly Schedule tab for each individual schedule as
shown below.
Figure 745: Setting the default value in the Weekly Schedule tab
NOTE: For ECL Series controllers, there are two types of null values available
that are not the same and are not interchangeable:
- Null output: Set the Schedule Default Value Null tick box. When
active, this outputs the Null value (which indicates ‘no value’) at the
block’s output port(s). This value is compatible with the Is Null block.
- Nul: Selected from the Schedule Default Value drop-down list Setting
the Default Value in the Weekly Schedule Tab). This is an enumerated
value of the SNVT_occupancy enumeration. When active, this outputs
-1 at the block’s output port(s). This value is not compatible with the Is
Null block.
Default schedule The following default schedule occupancy enumeration is built in to the Calen-
enumeration dar and Schedule Tool. These values are sent to the project code connected
values to the Schedule block.
SNVT_occupancy
Enumeration Values Enumeration Values for
Enumeration for ECL Series ECB & ECY Series
Controllers Controllers
(unalterable)
Nul -1 –
Occupied 0 1
Unoccupied 1 2
Bypass 2 3
Standby 3 4
1288 EC-gfxProgram
Calendar and Schedule Tool (ECL, ECB & ECY Series)
For ECB & ECY Series controllers only; you can also set the data type and
freely create your own schedule enumeration. See Change schedule type.
Default calendar The following default calendar active/inactive Boolean value is built in to the
enumeration Calendar and Schedule Tool. These values are sent to the project code con-
values nected to the Calendar block.
Enumeration Boolean Value
Active 1
Inactive 0
Setting event In the Schedule’s Special Events tab and in the Calendar, each event prop-
properties erty has an Any selection for properties such as weekday, day-of-month,
month-of-year, year, and so on. When an event property is set to Any, it
means that the range for this property is unlimited. A working event configura-
tion must normally have at least one property set with a value other than Any.
If all event properties are set to Any, the event will always be active.
The result of all property selections are additive, to combine to exclude the
rest. For example, if you select weekday of Wednesday, 6th day of the month
in any year: If the month does not have a Wednesday that falls on the 6th day,
then there will be no event for that month.
For the Schedule’s Effective Period tab, setting all properties for the Start
Period and End Period to Any will make the Schedule always active.
Selecting a In the Schedule’s Special Events and Effective Period tabs and in the Cal-
month in a endar, you can change the month displayed as shown below.
calendar
Figure 746: Changing the month displayed
Click these arrows to move
ahead or back a month
Click a month’s title and
then select another
month
EC-gfxProgram 1289
Configuring a schedule (calendar and schedule tool)
Schedule view The following schedule types are available:
• Weekly schedule
• Special events
• Effective period
Figure 747: schedules view selector
Weekly schedule Weekly schedules define regular, repeating, events by “time-of-day” and “day-
of-week.” At a minimum, up to three distinct events can be configured for each
day. Special Events have priority over the Weekly Schedule – see Schedule
hierarchy. A default value is configured that will be effective when there is no
active event for this calendar instance.
Figure 748: Weekly schedule
Any existing events appear as medium blue-colored blocks, while unsched-
uled (default output) time appears in white or light blue.
Events that are out-of-view due to where the screen is scrolled, an indicator
arrow shows the existence of this event; click it to view the event.
Figure 749: Out-of-view Event arrow indicator
1290 EC-gfxProgram
Calendar and Schedule Tool (ECL, ECB & ECY Series)
Creating an Add a new event as follows:
event
1. Click in a day at the approximate event start time, hold and drag down to
select the start and finish time.
2. Release the mouse button. The event remains selected (shown in dark
blue).
NOTE: Try this shortcut: With the keyboard, type the first letter of the value to
select the event’s value. Press <Enter> to use the value previously
selected last time. For example, type "o" to create an event with the
value of "Occupied" (when Occupied is available as a value).
3. Right-click the event and select New Event. A drop-down menu appears
in the event.
4. Select the value for the event. This is the value that will be sent to project
code when this event is active.
5. Click elsewhere in the week. The selected value is accepted.
NOTE: For ECB Series controllers: If the event data type is an enumeration,
you can use the default enumeration, or you can define an enumera-
tion by selecting Change Schedule Type from the Edit menu. See
Enumeration list editor (ECB & ECY Series controllers only).
EC-gfxProgram 1291
Changing the With any event selected:
event’s
properties • Click on the event and drag on the event’s top or bottom edge to change
its start or finish time (in broad increments).
Figure 750: Adjusting an event’s start or finish time
Fine tuning buttons
The selected event
Adjust an Event’s Start or
Finish Time
• Fine tune the start and finish time by selecting the hours portion or min-
utes portion and using the controls (up / down fine tuning buttons), or click
and type values in directly in Start Time and End Time.
• Set the event’s value in Value
• Set the event’s value with the keyboard:
• Type the first letter of the value to select the value for the event
• Press <Enter> and then use the up / down arrow (<↑> / <↓>) to select
a value. Press <Enter> again to accept the value.
• With the mouse, drag and drop an event to a new location to change its
start time or day.
Figure 751: Moving an event to a new location
NOTE: For any event, start time is inclusive, and the event extends to (but is
exclusive of) the end time. In other words, there is no output glitch
between adjacent events, even across days. For example, if a Mon-
day event ends at midnight, then a Tuesday event starts at midnight,
the schedule output is continuous (provided both events have the
same value).
1292 EC-gfxProgram
Calendar and Schedule Tool (ECL, ECB & ECY Series)
Resolving event When there is a Weekly Schedule configuration error, events are shown in red
errors and an Event Error description of the error is provided in the lower left corner.
Figure 752: Typical event error
Weekly Schedule configuration errors include:
• Overlapping events: An event must finish before another event can start.
However, events can touch. Drag or resize the events so they do not
overlap.
• Maximum number of events per day exceeded: When this error is shown,
reduce the number of events in that day. No more than three distinct
events per day can be configured, however when adjacent events are
added, it is possible to make a valid configuration with up to six adjacent
events per day.
• Crossing multiple days event: An event cannot start on one day and finish
on another day. Adjust the event to be on one day and create another
event on the second day with the same value.
Special events Special Events define a number of “Special Days” in the currently selected
schedule instance. Typically, you use them to define days with scheduling
exceptions (for example, holidays). Special Events have priority over the
Weekly Schedule – see Schedule hierarchy. A special Event can reference a
previously configured Calendar Event.
Existing Special Events (if any) are listed in the central area. When you select
a Special Event, the applicable day(s) for this Special Event are highlighted in
the calendar on the left, and the associated time-of-day events are displayed
on the right-side.
NOTE: The Date Status column shows if this event is currently active. For
display purposes, this status is calculated from your PC’s current time
and not from the controller’s time (as the controller may be offline).
Should the controller’s real time clock be set for a time zone other
EC-gfxProgram 1293
than your PC’s time clock (or if the clocks are poorly synchronized), an
event’s Date Status may not represent the actual controller’s status.
Figure 753: Special events
The effective time of Special Events can overlap. In the case of overlap, only
the highest priority Special Event will be active. Special Event priority is set by
the order in which they are listed. To change the order in which Special Events
are shown, right-click the event and select Up or Down, or select the event
and click (move up) or (move down) in the toolbar.
Figure 754: Changing a special event’s priority
Creating a Configure a Special Event as follows:
special event
1. In the calendar pane (on the left side), select the calendar dates for the
special event:
• Click a calendar date
1294 EC-gfxProgram
Calendar and Schedule Tool (ECL, ECB & ECY Series)
• Click and drag to select a range of calendar dates.
• Hold-down Ctrl key on the keyboard, and click a number of calendar
dates.
2. Right-click your selection, or one of the selections.
Figure 755: Right-click a calendar dare or a range of calendar dates for a selection of options
3. Select an option that is appropriate to your needs.
Parameter Description
New Event This creates a new Special Event (the default is the first
day of every month).
This Day / Create an event for each individual selected day.
These Days
Day(s) Of Month Create events for the selected days in all months.
This Date Range Create an event for the selected range of days.
Date Range of Create an event for the selected range of days for all
Month months.
These Weeks Create events spanning the entire calendar week
(Date Range) where a selection has been made.
EC-gfxProgram 1295
Parameter Description
Weeks in Month Create events spanning entire weeks in which a
selection has been made in the current calendar
month.
NOTE: The first week is from the 1st to the 7th, the sec-
ond week is from the 8th to the 14th, the third
week is from the 15th to the 21st, the fourth
week is from the 22nd to the 28th (if applicable),
the fifth week is from the 29th to the 31st (if
applicable).
Weeks in All Create events spanning the entire weeks in which a
Months selection has been made in all calendar months.
NOTE: The first week is from the 1st to the 7th, the sec-
ond week is from the 8th to the 14th, the third
week is from the 15th to the 21st, the fourth
week is from the 22nd to the 28th (if applicable),
the fifth week is from the 29th to the 31st (if
applicable).
Week Days In Create events for each selected day of the week for the
Month current month.
Week Days Create events for each selected day of the week for all
years.
Days > 1st Day Create an event for the selected day for all months.
to 31st Day and
Last Day
Week Days > Create an event for the selected day of the week for all
Sunday to months.
Saturday
Weeks > 1st Create an event the entire selected week of the week
for all months.
Week to 5th
Week and Last
Week NOTE: The first week is from the 1st to the 7th, the sec-
ond week is from the 8th to the 14th, the third
week is from the 15th to the 21st, the fourth
week is from the 22nd to the 28th (if applicable),
the fifth week is from the 29th to the 31st (if
applicable).
4. Create an event that defines the time range during which the Special
Event is active.
1296 EC-gfxProgram
Calendar and Schedule Tool (ECL, ECB & ECY Series)
Setting a special With any Special Event selected, select the Properties tab to the right and
event’s configure the Special Event’s properties. See also Setting event properties.
properties
Figure 756: Setting a special event’s properties
Parameter Description
Name Set the name for the Special Event.
Type Set the Special Event’s data type.
Week Day Specifies a day of the week, Sunday to Saturday.
Day Specifies a specific day of the month including the last
day of the month (which varies from month to month).
Month Specifies a specific month or even or odd months of the
year.
Year Specifies a specific year.
Select Date Specifies a specific day. Click to open the
calendar.
Click the left arrow (<) or right arrow (>) to show the
previous or subsequent calendar month. Click a date in
the calendar to select that day, month, and year.
When a Special Event’s property is set to Any, it means that the range for this
property is unlimited. A working configuration must normally have at least one
property set with a value other than Any. Properties are additive, to combine
EC-gfxProgram 1297
to exclude the rest. See Setting a Setting a special event’s time-of-day event
properties.
Parameter Description
Date Selects a day or a series of weekdays, dates, months
or years.
For example, the above setting selects every
Wednesday in the calendar as a Special Event.
Date Range Selects a range of days.
For example, the above setting selects the first three
days of every month as a Special Event.
Week And Day Selects a series of weekdays, week in a calendar
month, or months.
For example, the above setting selects every
Wednesday in the calendar as a Special Event.
1298 EC-gfxProgram
Calendar and Schedule Tool (ECL, ECB & ECY Series)
Parameter Description
Reference Select a Calendar that will override this Schedule. To
create a calendar event, see Calendar events.
Special selection The number of days in a calendar month varies according to the month, and
options for February, whether it is a leap year. Due to this, there is the option in Day to
select the last day of the month which automatically selects the last day of the
month, regardless of the month.
Figure 757: Setting a special event’s properties
Also, for Month, there is the option to select all even months (February, April,
June, August, October, December), or to select all odd months (January,
March, May, July, September, November).
Setting a special With any Special Event selected, select the Events tab to the right and config-
event’s time-of- ure the time range during which the Special Event is active (time-of-day
day event event). At a minimum, up to three distinct time-of-day events can be config-
properties ured for each Special Event. See also Changing the event’s properties.
NOTE: For ECB Series controllers: If the event data type is an enumeration,
you can use the default enumeration, or you can define an enumera-
EC-gfxProgram 1299
tion by selecting Change Schedule Type from the Edit menu. See
Enumeration list editor (ECB & ECY Series controllers only).
Figure 758: Setting a special event’s properties
Parameter Description
Value Set the time-of-day event’s value for the Special Event.
Start Time Set the time-of-day event’s start and stop time. Fine
tune the start and finish time by selecting the hours
End Time
portion or minutes portion and using the controls (up /
down arrow), or click and type values in directly in Start
Time and End Time.
Resolving When there is a Special Event configuration error, the error is shown in the
special event Date Status column for the special Event. Special Event configuration errors
errors include:
• No time period defined: This is a user warning that a Special Event must
have a time period defined in the Event tab. See Setting a special event’s
time-of-day event properties.
• Invalid configuration: This is a user warning that a Special Event’s Proper-
ties are ambiguous: A Special Event cannot have its Week Day, Day,
Month, and Year all set to Any while in the Event tab, no event has been
created.
• Maximum number of events per day exceeded: When this error is shown,
reduce the number of events in that day. No more than three distinct
events per day can be configured, however when adjacent events are
added, it is possible to make a valid configuration with up to six adjacent
events per day.
• Invalid Date: A date was specified that cannot exist, for example, Febru-
ary 30th. Select a valid date or for example, use the Last Day option
1300 EC-gfxProgram
Calendar and Schedule Tool (ECL, ECB & ECY Series)
which automatically selects the last day of the month according to the
actual number of days in a given month. See Special selection options.
• When the Type is set to Reference: The calendar being referenced must
be properly configured.
Effective period Effective Period defines the period during which the currently selected sched-
ule instance is active or inactive (see Schedule hierarchy).
Figure 759: Effective period
Setting the Configure a Date Range as follows:
effective period
1. In the calendar pane, click and drag to select a range of calendar dates.
2. Right-click your selection.
Figure 760: Right-click a calendar date or a range of calendar dates for a selection of options
3. Select an option that is appropriate to your needs.
Parameter Description
This Date Range Create an event for the selected range of days.
Date Range of Create an event for the selected range of days for all
Month months.
EC-gfxProgram 1301
Changing the Set the Effective Period’s start and end period as follows.
effective period’s
properties Figure 761: Setting a date range’s properties
Parameter Description
Day Specifies a specific day of the month including the last
day of the month (which varies from month to month).
Month Specifies a specific month or even or odd months of the
year.
Year Specifies a specific year.
Select Date Specifies a specific day. Click to open the
calendar.
Click the left arrow (<) or right arrow (>) to show the
previous or subsequent calendar month. Click a date in
the calendar to select that day, month, and year.
When a Date Range’s property is set to Any, it means that the range for this
property is unlimited. See also Setting event properties.
Resolving When there is an Effective Period configuration error, the calendar is shown in
effective period pink and an error description is provided in the lower left corner. Special Event
errors configuration errors include:
• Invalid Date: A date was specified that cannot exist, for example, Febru-
ary 30th. Select a valid date to correct the error.
1302 EC-gfxProgram
Calendar and Schedule Tool (ECL, ECB & ECY Series)
Configuring a calendar (Calendar and Schedule tool)
Calendar events Calendar events define a number of “special event days” in the currently
selected calendar instance. Typically, you use them to define days with
scheduling exceptions (for example, holidays), and reference them in a
schedule’s “Special Events” configuration.
Existing calendar events (if any) are listed in the central area. When you
select a calendar event, the applicable day(s) for these days for this calendar
event are highlighted in the calendar on the left, and the associated time-of-
day events are displayed on the right-side.
Figure 762: Calendar event
The effective time of Calendar Events can overlap. In the case of overlap,
only the highest priority Calendar Event will be active. Calendar Event priority
is set by the order in which they are listed. To change the order in which Cal-
endar Events are shown, right-click the event and select Up or Down, or
select the event and click (move up) or (move down) in the toolbar.
Figure 763: Changing a calendar event‘s priority
EC-gfxProgram 1303
Creating a Configure a calendar event as follows:
calendar event
1. In the calendar pane (on the left side), select the calendar dates for the
Calendar Event:
• Click a calendar date
• Click and drag to select a range of calendar dates.
• Hold-down Ctrl key on the keyboard, and click a number of calendar
dates.
2. Right-click your selection, or one of the selections.
Figure 764: Right-click a calendar date or a range of calendar dates for a selection of
options
3. Select an option that is appropriate to your needs.
Parameter Description
New Event This creates a new calendar event for the selected day.
This Day / Create an event for each individual selected day.
These Days
Day(s) Of Month Create events for the selected days in all months.
This Date Range Create an event for the selected range of days.
Date Range of Create an event for the selected range of days for all
Month months.
These Weeks Create events spanning the entire calendar week
(Date Range) where a selection has been made.
1304 EC-gfxProgram
Calendar and Schedule Tool (ECL, ECB & ECY Series)
Parameter Description
Weeks in Month Create events spanning entire weeks in which a
selection has been made in the current calendar
month.
NOTE: The first week is from the 1st to the 7th, the sec-
ond week is from the 8th to the 14th, the third
week is from the 15th to the 21st, the fourth
week is from the 22nd to the 28th (if applicable),
the fifth week is from the 29th to the 31st (if
applicable).
Weeks in All Create events spanning the entire weeks in which a
Months selection has been made in all calendar months.
NOTE: The first week is from the 1st to the 7th, the sec-
ond week is from the 8th to the 14th, the third
week is from the 15th to the 21st, the fourth
week is from the 22nd to the 28th (if applicable),
the fifth week is from the 29th to the 31st (if
applicable).
Week Days In Create events for each selected day of the week for the
Month current month.
Week Days Create events for each selected day of the week for all
years.
Days > 1st Day Create an event for the selected day for all months.
to 31st Day and
Last Day
Week Days > Create an event for the selected day of the week for all
Sunday to months.
Saturday
Weeks > 1st Create an event the entire selected week of the week
for all months.
Week to 5th
Week and Last
Week NOTE: The first week is from the 1st to the 7th, the sec-
ond week is from the 8th to the 14th, the third
week is from the 15th to the 21st, the fourth
week is from the 22nd to the 28th (if applicable),
the fifth week is from the 29th to the 31st (if
applicable).
EC-gfxProgram 1305
Setting a With any calendar event selected, configure the event’s properties.
calendar event‘s
properties Figure 765: Setting a calendar event‘s properties
Parameter Description
Name Set the calendar event’s name.
Type Set the calendar event’s data type.
Week Day Specifies a day of the week, Sunday to Saturday.
Day Specifies a specific day of the month including the last
day of the month (which varies from month to month).
Month Specifies a specific month or even or odd months of the
year.
Year Specifies a specific year.
Select Date Specifies a specific day. Click to open the
calendar.
Click the left arrow (<) or right arrow (>) to show the
previous or subsequent calendar month. Click a date in
the calendar to select that day, month, and year.
When a Calendar Event’s property is set to Any, it means that the range for
this property is unlimited. A working configuration must normally have at least
one property set with a value other than Any. Properties are additive, to com-
bine to exclude the rest. See Setting a special event’s time-of-day event prop-
erties. See also Special selection options.
1306 EC-gfxProgram
Calendar and Schedule Tool (ECL, ECB & ECY Series)
Parameter Description
Date Selects a day or a series of weekdays, dates, or
months.
For example, the above setting selects every
Wednesday in the calendar as an event.
Date Range Selects a range of days.
For example, the above setting selects the first three
days of every month as an event.
Week And Day Selects a series of weekdays, week in a calendar
month, or months.
For example, the above setting selects every
Wednesday in the calendar as an event.
EC-gfxProgram 1307
Resolving When there is a Calendar Event configuration error, the error is shown in the
calendar event Date Status column for the Calendar Event. Calendar Event configuration
errors errors include:
• When the Type is set to Reference: The calendar being referenced must
be properly configured.
• When the Type is set to Date Range: The start date must be earlier than
or the same as the end date.
• Invalid Date: A date was specified that cannot exist, for example, Febru-
ary 30th. Select a valid date or for example, use the Last Day option
which automatically selects the last day of the month according to the
actual number of days in a given month. See Special selection options.
1308 EC-gfxProgram
Scheduler Configuration Tool (ECP Series)
CHAPTER 10
Scheduler Configuration Tool (ECP
Series)
For ECP Series controllers, this chapter provides a procedure to quickly setup
a schedule for controllers that support this feature as well as a comprehensive
description of the entire tool. This chapter follows the same organization as
the tool itself in order to help configure a schedule in a logical fashion.
Topics
Quick start guide
Calendar
Week schedules
Special day schedules
Options
Data Manage
Object Manage
Message Logger
EC-gfxProgram 1309
Quick start guide
This section describes how to quickly setup a schedule through the Scheduler
configuration tool.
1. Launch the Scheduler configuration tool for Schedule 1.
2. Select the Week Schedules module from the Menu window of the Sched-
uler configuration tool.
3. Select the desired day to configure from the Select Day drop-down
menu. Enter a time in the Time field and an enumeration state from the
Enumeration drop-down menu. The figure below shows a scheduling
example for the Monday of every week. In this example, the 8:00 to 12:00
shift is configured as Event 1. The 13:00 to 18:00 evening shift is config-
ured as Event 3.
Figure 766: Monday schedule example
4. Configure the rest of the days of the week in a similar manner. Identical
schedules can be setup for different days by clicking the Copy button in
the configured day, selecting another day from the Select Day drop-down
menu and clicking the Paste button.
5. Select the Special Day Schedules module from the Menu window of the
Scheduler configuration tool to configure holiday or special day sched-
ules. There are four special day schedules that can be configured.
1310 EC-gfxProgram
Scheduler Configuration Tool (ECP Series)
6. Select the special day from the Special Day Schedules drop-down
menu. To change the name of the special day, click the […] button next to
the menu. Enter the name of the special day and click OK.
Figure 767: Changing the name of the special day
7. Configure the special day by entering a Time and state (Enumeration) as
in the Week Schedules screen.
Figure 768: Special Day Schedules example
8. Select the Calendar module from the Menu window of the Scheduler con-
figuration tool.
9. Click Assign Schedule under Calendar Mode. Select the special day to
assign to the calendar by selecting it from the Select Special Day drop-
down menu.
10. Browse the months by clicking on the Next and Previous buttons. Once
the month and day is found where the special day is to be assigned, sim-
ply click on it with the mouse and a grey number will appear which corre-
sponds to the Special Day Schedule selected in the Special Day
Schedules drop-down menu. So if special day 1 has been selected, then
EC-gfxProgram 1311
the number 1 will appear in grey on the day selected in the calendar as
shown in the figure below.
Figure 769: Assigning the special day to the calendar module
11. Select View Schedule under Calendar Mode. Confirm the accuracy of
the schedules by selecting a day in the calendar and checking to see if
the appropriate day schedule appears. Click OK.
Schedule 1 is now ready for use by any device that supports a schedule.
NOTE: To use it in an EC-gfxProgram code, simply drag and drop a Schedule
block into a project and assign it block number 1.
1312 EC-gfxProgram
Scheduler Configuration Tool (ECP Series)
Calendar
This is the first screen that appears after launching the Scheduler configura-
tion tool. The user may also access this screen by clicking Calendar from the
Menu window on the left hand side of the configuration tool.
Figure 770: Calendar window
Parameter Description
Calendar Mode Determines the functionality of the Calendar. There are
two options here:
• View Schedule
• Assign Schedule
View Schedule By selecting this option in Calendar Mode, the user will
be able to view the daily schedules configured for this
schedule. By clicking on any day in the calendar, the
user will be able to see all the events configured for
that particular day of the week. The time and status of
the schedule will be displayed on the right hand side of
the schedule.
The Next and Previous buttons are used to browse
the months of the year. Clicking the Today button
automatically brings the calendar to the current day,
month, and year.
EC-gfxProgram 1313
Parameter Description
Assign Schedule This option in Calendar Mode allows the user to assign
a Special Day Schedule to a day on the calendar. This
is done by first selecting the Special Day from the
Special Day Schedules drop-down menu that appears
to the right of the calendar as soon as the
Assign Schedule mode is selected. There are four
special days available for configuration. Their default
names are Holiday 1 through Holiday 4. They are also
numbered 1 through 4 (the numbers appear in brackets
next to the special day). If the special day schedules
have not yet been configured, clicking on the > button
to the right of the menu will open the Special day
schedules. After the special day schedule has been
configured and selected, click on the day in the
calendar on which the special day is to be scheduled.
The number of the special day (the one in between
brackets) will appear in grey.
The Next and Previous buttons are used to browse
the months of the year. Clicking the Today button
automatically brings the calendar to the current day,
month, and year.
NOTE: If a special day is being configured that is a day
of the week and also a date then it will have to
be re-configured every year. This is because
the controller will only process dates.
Example: If the first Monday in September is to be a
special day in 2008, then the schedule will have to be
changed in 2009 because in 2008 the first Monday in
September is the 1st and in 2009 the first Monday in
September is the 7th. Therefore if in 2009 the schedule
is not changed to mark the special day on the 7th, then
the controller will assume that the special day is still the
1st of September regardless of which day of the week it
is.
1314 EC-gfxProgram
Scheduler Configuration Tool (ECP Series)
Week schedules
This module is used to configure the schedule for every day of the week. It is
accessible through the Menu window on the left-hand side of the configuration
tool.
Figure 771: Week Schedules window
To configure a particular day, select that day from the Select Day drop-down
menu. The days can also be browsed through by using the Next and Previ-
ous buttons. Clicking the Apply button will confirm the changes made to the
schedule. Clicking OK will confirm the changes to the schedule and close the
Scheduler configuration tool.
If the same events are to be used for different days of the week, simply click
the Copy button on one configured day, go to the new day to be configured
and click Paste. This will copy all the parameters from one day to another.
Once the day to be configured has been selected, the events for that day may
be defined. This is done by entering a Time and Enumeration (state) for
each event. For advanced users the Value field is also available. There are six
events available for each day.
EC-gfxProgram 1315
Parameter Description
Time This is the time at which the event will start and the
event preceding it will end. All times should be entered
in military time (00:00 to 23:59).
For example, Event 1 can be the morning shift, which
starts at 08:00. Event 2 can be the lunch break, which
starts at 12:00. This way Event 1 lasts from 08:00 till
11:59.
NOTE: To do overnight schedules (useful for outdoor
lighting applications) simply enter the start
event and the finish event.
Example: An event is to start at 6PM Monday and end
at 6AM Tuesday. Enter an event that starts at 18:00 on
Monday, go to the Tuesday schedule and enter another
event to start at 6:01. The controller works on an event
by event basis, so an event will not stop until another
one is scheduled to start.
1316 EC-gfxProgram
Scheduler Configuration Tool (ECP Series)
Parameter Description
Value Advanced users can use this field to determine the
Enumeration of the event or to send data across the
(Advanced
network. The field accepts any value from 0 to 255.
Users)
Refer below for the exact values of states for
SNVT_tod_event and SNVT_occupancy.
Enumeration:Value:
OC_OCCUPIED0
OC_UNOCCUPIED1
OC_BYPASS2
OC_STANDBY3
NO_EVENT255
Entering the values displayed above is the equivalent
of selecting the enumeration for the event. So if Event 1
is given a value of 0 then it is also given an
enumeration of OC_OCCUPIED.
To send data over the network, users must be careful
as to what type of data they are sending and in what
format they are sending it.
The scheduler configuration tool can send data over
the network in SNVT types of 1 or 4 bytes. Two byte
SNVT types are not supported by the Scheduler
configuration tool at the moment. This is why the
recommended SNVT types should be used.
If the SNVT type is changed, the enumerations may
change. Therefore, users should verify the value of the
enumerations whenever the SNVT type is changed.
Refer to Options to learn more about SNVT types and
how they apply to the Scheduler configuration tool and
to sending data over the network.
Enumeration This drop-down menu corresponds to the SNVT type to
which the configuration tool is configured. The default
type is SNVT_tod_event. All the enumerations
available for this type are listed above. The
enumeration is essentially the state the controller will
enter upon receiving the update from the schedule to
do so.
So if Event 1 is configured to have an enumeration of
OC_OCCUPIED at 12:00, then at 12:00 the controller
receiving the schedule will go into occupied mode. The
user can then customize what happens during the
occupied mode using a device’s configuration or
programming tool.
EC-gfxProgram 1317
Special day schedules
This module is similar to the Week schedules module except that it is used to
configure Special Days as the name suggests.
Figure 772: Special Day Schedules window
The configuration process is the same as in the Week Schedules screen.
Simply select the special day to be configured from the Special Day Sched-
ules drop-down menu. The days can also be browsed through by using the
Next and Previous buttons. The special days are named Holiday 1 through
Holiday 4 by default. To change the name of a special day, click the […] but-
ton directly to the right of it. This will display a window prompting the new
name for the special day to be entered.
Figure 773: Special day name change window
Click OK to confirm the change and close this window. Click Cancel to close
the window without confirming the change.
1318 EC-gfxProgram
Scheduler Configuration Tool (ECP Series)
After selecting the Special Day to be configured, simply enter a Time and
Value or Enumeration for each event in the special day schedule.
The Copy button may also be used to copy all configured parameters of the
configured special day and the Paste button can then be used to apply those
copied parameters to another special day.
Clicking on the Apply button will confirm the changes made to the schedule.
Clicking OK will confirm the changes to the schedule and close the Scheduler
configuration tool.
EC-gfxProgram 1319
Options
The Options module contains the configuration parameters for the Scheduler
object’s NVO and NVI. You can access this window by clicking on Options
from the Menu window on the left hand side of the configuration tool.
Figure 774: Options window
Figure 775: Options window (EC-gfxProgram)
1320 EC-gfxProgram
Scheduler Configuration Tool (ECP Series)
Each schedule object has a dedicated NVO for it to transmit its contents over
the network. The number of schedule objects available is dependent on the
device being used. In addition to this, programmable controllers using EC-gfx-
Program have a dedicated NVI for it to receive a schedule over the network.
In order for the information to be propagated over the network using these
NVOs or NVIs, the NVOs must be bound to the proper NVIs on the receiving
controllers and the NVIs must be bound to the proper NVOs on the transmit-
ting controllers. The binding of variables is done using a network manage-
ment tool. Refer to their respective user guides for more details on how to
bind network variables.
Scheduler
Parameter Description
Name Enter the name of the Scheduler object (maximum 85
characters).
Scheduler
output options
Parameter Description
Update Period This is a user defined interval which is the rate at which
the schedule object will send out the value of the
schedule to the network. The value must be entered in
seconds. It is not advised to put a very low update
period so as not to flood the network with data.
Default Value This is the value that the schedule will take when an
override is activated. The user may select from a drop-
down menu of enumerations. The enumerations
change according to the selected SNVT type. Refer to
Object Manage for more details on override.
EC-gfxProgram 1321
Parameter Description
NV Type All network variables (input and output) have a
Standard Network Variable Type (SNVT) type. This
type determines the format and enumeration and/or
resolution of the network variable. In effect the SNVT
types determine what the network variable can or
cannot do.
The default SNVT type used for nvoSchedulex (for
example, nvoSchedule1) is SNVT_tod_event. This is a
4-byte SNVT type and it will display the current state,
next state and the time remaining till the next state
goes into effect. So if nvoSchedule1 is viewed using a
network browser or management tool, it would display
something like this:
OC_OCCUPIED, OC_UNOCCUPIED, 60
This means that the current state of Schedule 1 is
OC_OCCUPIED, the next state of Schedule 1 is
OC_UNOCCUPIED and that there are 60 minutes
remaining till the next state takes effect.
It is possible for the user to change the SNVT type; this
is done by clicking on the Change Type button.
Change Type This button is used to launch the Scheduler Input
Configuration (EC-gfxProgram only) window.
NOTE: This button is only available in LNS. To use this
option in EC-Net, refer to Change Network
Variable Type (EC-Net).
NV Value The current value of the NVO (read only).
Read Value This button only works if the device is configured,
online and attached. This button can be used to
retrieve the current value from the network.
1322 EC-gfxProgram
Scheduler Configuration Tool (ECP Series)
Scheduler input
configuration
(EC-gfxProgram) Parameter Description
Max Receive The maximum time period between received updates
Time of the network variable on the network (whether or not
the variable's value has changed). The maximum
receive time is also known as the “heartbeat”.
Setting this to zero disables this feature. When
enabled, we recommend setting for this value is twice
the max send time configured for the corresponding
network variable output.
A max receive time failure occurs if a network variable
update is not received on the network within the time
period set in the textbox. On a max receive time failure,
the device will go into alarm, the device status will be
updated to indicate a failure, and the NVI will return to
its default value.
The appropriate alarm and status bits will be updated
on a max receive time failure.
NOTE: Max receive time only applies to NVIs that are
bound.
NV Type All network variables (input and output) have a
Standard Network Variable Type (SNVT) type. This
type determines the format and enumeration and/or
resolution of the network variable. In effect the SNVT
types determine what the network variable can or
cannot do.
The default SNVT type used for nviSchedulex (for
example, nviSchedule1) is SNVT_tod_event. This is a
4-byte SNVT type and it will display the current state,
next state and the time remaining till the next state
goes into effect. So if nviSchedule1 is viewed using a
network browser or management tool, it would display
something like this:
OC_OCCUPIED, OC_UNOCCUPIED, 60
This means that the current state of Schedule 1 is
OC_OCCUPIED, the next state of Schedule 1 is
OC_UNOCCUPIED and that there are 60 minutes
remaining till the next state takes effect.
It is possible for the user to change the SNVT type; this
is done by clicking on the Change Type button.
EC-gfxProgram 1323
Parameter Description
Change Type This button is used to launch the Change network
variable type (LNS) window.
NOTE: This button is only available in LNS. To use this
option in EC-Net, refer to Change netwrok vari-
able type (EC-Net).
NV Value The current value of the NVI (read only).
Read Value This button only works if the device is configured,
online and attached. This button can be used to
retrieve the current value from the network.
Change network The Change Network Variable type window is typically used when there is a
variable type need to modify the variable type before creating a binding.
(LNS)
NOTE: The NV type should be changed BEFORE configuring the schedule.
Figure 776: Change Network Variable Type window
Parameter Description
Network The name of the network variable.
Variable Name
Actual Type The current network variable type. When the type is
changed and Apply is clicked, this field will be updated.
1324 EC-gfxProgram
Scheduler Configuration Tool (ECP Series)
Parameter Description
Preferred type Checking this box will show the preferred type list for
list the network variable. This option is selected by default.
The preferred type varies based on the type of input
and displays the most appropriate SNVT types that
should be attributed to the network variable. The
preferred SNVT types for nvoSchedule are:
• SNVT_hvac_mode
• SNVT_occupancy
• SNVT_tod_event
Length Select Equal length only to only list network variable
types that have the same length as the Actual Type.
Select All to list all network variable types that do not
exceed the maximum NV length.
Type files A list of all available type files from the device resource
file catalog (standard and manufacturer defined).
Based on the .TYP file you select, the Type List will
change.
Type list A list of types within the selected file that are of the
appropriate length.
Change netwrok The Changeable Nv Manager view is typically used when there is a need to
variable type modify the variable type before creating a binding. Each variable type has a
(EC-Net) preferred number of SNVT types and these preferred SNVT types will work
best with the selected variable type. The supported SNVT types for
nvoSchedule are:
• SNVT_hvac_mode
• SNVT_occupancy
• SNVT_tod_event
NOTE: The NV type should be changed BEFORE configuring the schedule.
To change a network variable type using the Changeable Nv Manager view,
follow these steps:
EC-gfxProgram 1325
1. Enter into the Changeable Nv Manager view by right-clicking the device
name and selecting Views > Changeable Nv Manager.
Figure 777: Changeable Nv Manager view
2. Select the NV whose type is to be changed.
3. Click the Edit button (the Edit Nv Type window will pop up).
4. From the drop-down menu, select the new SNVT type and click OK.
Figure 778: Edit Nv Type window
1326 EC-gfxProgram
Scheduler Configuration Tool (ECP Series)
Data Manage
There are two main sections in the Data Manage module:
Figure 779: Data Manage window (LNS)
Figure 780: Data Manage window (EC-Net)
EC-gfxProgram 1327
Data
management
Parameter Description
Import This command enables the user to import a schedule
from any other controller on the same network that has
(LNS only)
a scheduler object. Simply select the controller that has
the schedule to be imported and click OK. After doing
this, all the settings in the configuration tool will be
changed to that of the imported settings.
Clear By clicking on this button the user returns all
configuration tool parameters to their default values.
Synchronization
Parameter Description
Upload Clicking on this button uploads all schedule settings
stored on the controller and applies them to the
schedule configuration of the configuration tool. Useful
to see what schedule the controller is running on.
Download This button sends all schedule configuration data from
the configuration tool to the controller. Used to make
changes to schedules. It should be noted that clicking
the Apply button will make the same changes, as will
the OK button.
1328 EC-gfxProgram
Scheduler Configuration Tool (ECP Series)
Object Manage
This module of the Scheduler configuration tool is used to perform certain
object requests on the device.
Figure 781: Object Manage window
Parameter Description
Get Status Used to update the device status as opposed to waiting
for the update period to expire.
Clear Status Used to return the entire supported object requests
NVOs to normal status. There is an NVO associated
with all object requests. This command is used to view
changes in the NVOs and nothing more because the
NVOs will return to their real status as soon as the
update period has elapsed.
Override ON Used to put the device into Override mode.
Override OFF Used to return the device from Override mode to its
normal functioning mode.
Enable Not used.
Disable Not used.
Request Not used.
EC-gfxProgram 1329
Parameter Description
Display Active Select this option to only display requests that are
Only “ON”.
1330 EC-gfxProgram
Scheduler Configuration Tool (ECP Series)
Message Logger
This tool displays errors and warnings as soon as they occur. The errors
remain in the log until the user clears the log by clicking the Clear button. The
Close button closes the message logger without erasing the errors. The user
can also save the message log to a file by clicking the Save to File button.
NOTE: The user is notified to the presence of an error in the main window of
the configuration tool by the book icon turning red. This means that
there are logged errors ready for viewing. The book icon will only
return to its default grey color after the errors have been erased.
Selecting the Don’t show information automatically option in the Message
Logger will prevent it from popping up every time there is an error.
Figure 782: Message Logger
The Save to File function can be used to save a message log which can then
be sent to Technical Support for more efficient and accurate responses.
EC-gfxProgram 1331
1332 EC-gfxProgram
Real Time Clock Configuration Tool (ECP Series)
CHAPTER 11
Real Time Clock Configuration Tool
(ECP Series)
For ECP Series controllers, this chapter provides a comprehensive descrip-
tion of this configuration tool and explains how to setup all parameters so that
the controller has proper real time settings.
Topics
Daylight Saving Time
Object Manage
EC-gfxProgram 1333
Daylight Saving Time
This is the first screen that appears after launching the Real Time Clock
(RTC) configuration tool. The user may also access this screen by clicking
Daylight Saving Time from the Menu window on the left hand side of the
configuration tool.
Figure 783: Daylight Saving Time window
Parameter Description
Enable Daylight When selected, the Daylight Saving Time feature is
Saving Time enabled. Daylight Saving Time is the practice of
forwarding clocks in the spring and returning them in
autumn so that there is more daylight during usual
active hours (for example, afternoons), and less during
usual inactive hours (for example, early mornings).
General
Parameter Description
Offset Enter the amount of time that clocks are forwarded and
returned at the end of the Daylight Saving Time period.
Typically 60 minutes.
1334 EC-gfxProgram
Real Time Clock Configuration Tool (ECP Series)
Start time
Parameter Description
Time Enter the time of day when Daylight Saving Time shall
begin. The format should be in military units (6PM =
18:00).
Day Select the day of the week when Daylight Saving Time
shall begin. Use this drop-down menus to select the
day of the week in the month, for example the second
Sunday.
Month Select the month when Daylight Saving Time should
begin.
End time
Parameter Description
Time Enter the time of day when Daylight Saving Time shall
end. The format should be in military units (6PM =
18:00).
Day Select the day of the week when Daylight Saving Time
shall end. Use this drop-down menus to select the day
of the week in the month, for example the first Sunday.
Month Select the month when Daylight Saving Time shall end.
Device date/time
Parameter Description
Date Displays the date running on the system if the Get
System Time button is pressed or the date running on
the device if the Get Device Time button is pressed.
Once displayed, the Set Device Time button can be
pressed to set the date running on the device. The user
can also enter a date and click the Set Device Time
button to set the date running on the device.
Time Displays the time running on the system if the Get
System Time button is pressed or the time running on
the device if the Get Device Time button is pressed.
Once displayed, the Set Device Time button can be
pressed to set the time running on the device. The user
can also enter a time and click the Set Device Time
button to set the time running on the device.
Get System Displays the date and time running on the system in the
Time Date and Time fields respectively.
EC-gfxProgram 1335
Parameter Description
Get Device Time Displays the date and time running on the device in the
Date and Time fields respectively.
Set Device Time Sets the date and time displayed in the Date and Time
fields to the device.
Update period
Parameter Description
Update Period The period of time that the RTC NVO, nvoTimeDate,
will be re-transmitted.
1336 EC-gfxProgram
Real Time Clock Configuration Tool (ECP Series)
Object Manage
This module of the RTC configuration tool is used to perform certain object
requests on the device.
Figure 784: Object Manage window
Parameter Description
Get Status Used to update the device status as opposed to waiting
for the update period to expire.
Clear Status Used to return the entire supported object requests
NVOs to normal status. There is an NVO associated
with all object requests. This command is used to view
changes in the NVOs and nothing more because the
NVOs will return to their real status as soon as the
update period has elapsed.
Override ON Not used.
Override OFF Not used.
Enable Not used.
Disable Not used.
Request Not used.
Display Active Select this option to only display requests that are
Only “ON”.
EC-gfxProgram 1337
1338 EC-gfxProgram
EC-Net Platform Support Pack Features for ECP & ECL Series Controllers
CHAPTER 12
EC-Net Platform Support Pack Features
for ECP & ECL Series Controllers
An EC-gfxProgram compatible controller can be programmed on a EC-Net
platform just like any other device. However, if the EC-Net platform is to man-
age the programmable controller directly, it needs to connect to the device’s
internal points in a certain way. By using special control points that can be
linked to the internal points of the programmable controller, the controller’s
internal points can be used in graphics (Px) pages, logs, or alarms.
Or use LONWORKS component objects to link one controller to another control-
ler.
Topics
Typical controller internal points
Automatic generation of control points from EC-gfxProgram code
Manual creation of internal control points
Internal control points actions
Linking, building, and trimming LONWORKS component objects in EC-Net
Sending weather information to a controller
EC-gfxProgram 1339
Typical controller internal points
EC-gfxProgram controllers have 8 or more types of internal points that are
stored in Network Constant Inputs (NCIs), Network Variable Inputs (NVIs), or
Network Variable Outputs (NVOs). EC-gfxProgram compatible controllers
may have the following NCIs, NVIs, and NVOs. See the controller’s functional
profile in its datasheet for the specific details of the supported NCIs, NVIs, and
NVOs.
Table 37: Typical controller internal points
Controller Type
ECL Series ECP Series
Constant Bool (nciCb01_124). -
Constant Enum (nciCe01_31, nciCe32_62). Constant Enum (ECP Series) (nciCe1_31).
Constant Numeric (nciCn01_07, nciCn08_14, Constant Numeric (ECP Series) (nciCn1_7,
nciCn15_21, nciCn22_28, nciCn29_35, nciCn8_14, nciCn15_21, nciCn22_28,
nciCn36_42, nciCn43_49, nciCn50_56). nciCn29_35).
Variable Enum (nvoVe1_27, nvoVe28_54). Variable Enum (nvoVe1_27).
Variable Numeric (nvoVn1_7, nvoVn8_14, Variable Numeric (ECP Series) (nvoVn1_7,
nvoVn15_21, nvoVn22_28, nvoVn29_35, nvoVn8_14, nvoVn15_21, nvoVn22_28,
nvoVn36_42, nvoVn43_49, nvoVn50_56). nvoVn29_35).
Hardware Input (ECL Series) (changeable Hardware Input = nvoHwI#
type):
# = input number
• Controller NVO name = nvoHwInput_#,
nvoHwIn01_07, nvoHwIn08_14,
nvoHwIn15_16.
• IO Module 1 NVO name = nvoHwIn-
putX1_#, nvoHwInX1_01_07, and
nvoHwInX1_08_12 – when an ECx-400
Series Extension Module is equipped
• IO Module 2 NVO name = nvoHwIn-
putX2_#, nvoHwInX2_01_07, and
nvoHwInX2_08_12 – when a second
ECx-400 Series Extension Module is
equipped
# = Input number
1340 EC-gfxProgram
EC-Net Platform Support Pack Features for ECP & ECL Series Controllers
Table 37: Typical controller internal points
Controller Type
ECL Series ECP Series
Hardware Output (changeable type): Hardware Output = nvoHwO#
• Controller NVI name = nviHwOutput_# # = output number
• IO Module 1 NVI name = nviHwOut-
putX1_# – when an ECx-400 Series
Extension Module is equipped
• IO Module 2 NVI name = nviHwOut-
putX2_# – when a second ECx-400
Series Extension Module is equipped
• Controller NVO name = nvoHwOutput_#
and nvoHwOut01_12
• IO Module 1 NVO name = nvoHwOut-
putX1_# and nvoHwOutX1_01_12 – when
an ECx-400 Series Extension Module is
equipped
• IO Module 2 NVO name = nvoHwOut-
putX2_# and nvoHwOutX2_01_12 – when
a second ECx-400 Series Extension Mod-
ule is equipped
# = Output number
- SmartSensor Input (nvoSmI1_5) or for devices
that have 16 inputs, the SmartSensor Input NVO
also contains the NVOs for the last two Hardware
Inputs of the controller, so the NVO appears as
nvoHwI1516_SmI15 instead of nvoSmI1_5.
Wireless Input (nvoWrIn1_14, Wireless Input (nvoWrI1_14).
nvoWrIn15_28).
Wireless Output (nvoWrOut1_14, -
nvoWrOut15_28).
ComSenser (nvoComSensr01_04, -
nvoComSensr05_08, nvoComSensr09_12)
Optional Network Variables Inputs -
(changeable type): nviFP_# (# = 1 to 35)
Optional Network Variables Outputs -
(changeable type): nvoFP_# (# = 1 to 35)
The EC-Net platform can be used to manage these internal points for several
purposes including reading and writing to them in a graphics (Px) page, log-
ging them or linking them to alarms. However, to enable the EC-Net platform
to be able to manage the internal points, they first must be added to the sta-
EC-gfxProgram 1341
tion. See Automatic generation of control points from EC-gfxProgram code
and Manual creation of internal control points.
Internal control points provide an interface between the EC-Net platform and
the internal points of a controller. Through this interface, the EC-Net platform
can have proper control over the internal points to be able to read their modes
and values, set their values, override their modes, etc. There are 3 types of
internal control points: InternalPointNumeric, InternalPointEnum, and Internal-
PointBoolean (see Automatic generation of control points from EC-gfxPro-
gram code).
After an internal control point from the EC-Net platform is linked to an internal
point from the controller, it needs to be updated with the values and modes
from the internal point. The only way to update an internal control point is
through Binding (see below).
Binding Binding is a process of one-way or two-way communication (depending on
the type) between a sender and receiver to send an updated value and/or
mode. The internal point initiates the communication by sending an updated
current value/or mode to the control point. For NVOs, this method can be
used for medium to large scale networks since, generally, updates are sent
only when the value and/or mode of the internal point changes in accordance
to the MaxSendTime and MinSendTime values defined in the controller.
NCIs cannot be bound: When an NCI is “polled”, the internal control point
sends out ONLY one request for an update when it becomes subscribed. This
can either be initiated directly by the user or, if the NCI is in a graphics (Px)
page, it is initiated when the page is first opened. An NCI is generally used as
part of a graphics (Px) page where one value and/or mode update is sufficient
and not when it is part of a control logic sequence, alarm sequence or being
logged where regular automatic updates are often required.
There are 4 types of bindings or Service/Link Types: Standard, Reliable, Criti-
cal, and Authenticated. Link Types can be selected under the Proxy Ext
parameter of each of the respective NVOs that are linked (see Proxy Ext and
Figure 785). If the Service Types of many NVOs are to be selected at the
1342 EC-gfxProgram
EC-Net Platform Support Pack Features for ECP & ECL Series Controllers
same time, use the Lon Link Manager. Right-click BcpLonNetwork in the in
the Nav tree to access the Lon Link Manager.
Figure 785: Defining the service type through the Lon LinkManager
Parameter Description
Standard Is the least reliable, yet often most widely-used (also
known as unacknowledged). This is the default
service type for a EC-Net binding. With this service, the
message is sent one time and no response is
expected. This service is typically used when the
highest level of network performance is needed,
network bandwidth is limited, and the application is not
sensitive to the loss of messages.
Reliable Is recommended for messaging that has been
classified as important— if there is a specific need to
know that a status has changed (also known as
unacknowledged/repeated). Reliable messaging
sends a message three times. The srcDevice sends
each message three times, and if the targetDevice
receives the message, it simply throws subsequent
messages away.
Critical Means that the targetDevice must acknowledge the
fact that it received a message (also known as
acknowledged). The srcDevice continues to send the
message until the targetDevice acknowledges receipt
of that message. You are limited to the number of
bindings that can be defined as critical, because it
taxes the system, and often causes communications
issues (by loading down the network with message
verification traffic).
Authenticated Is a security service reserved for secure messaging.
When using authentication, the srcDevice must identify
itself to the targetDevice, and vice-versa. This service
is rarely used, and only in instances where messaging
must be secure.
EC-gfxProgram 1343
If you set Priority in combination with any of the message service types, upon
a bind, the Priority flag is set in the network variable’s Nv Config Data.
NOTE: It is very important to change the default MaxSendTime and MinSend-
Time of programmable controllers in medium to large scale networks.
For example, they should be changed to MaxSendTime = 300s and
MinSendTime = 15s.
Once the links have been created, remove any unnecessary control points to
reduce the amount of memory resources needed by using the Trim feature.
See Trimming LONWORKS component objects in EC-Net.
Types of point There are two types of controller points that can be created in EC-Net.
Parameter Description
Standard EC-Net network variable.
Controller internal points are special control points that
allow for the control of internal parameters. These
internal points are created through the Create Points
feature. See Automatic generation of control points
from EC-gfxProgram code and Manual creation of
internal control points.
This icon can be identified by the black dot in its center,
whereas the standard EC-Net network variable icon
has no dot in the center.
1344 EC-gfxProgram
EC-Net Platform Support Pack Features for ECP & ECL Series Controllers
Automatic generation of control points from EC-gfx-
Program code
A controller function automatically creates EC-Net control points from any
block that has a LONWORKS Network tab in its Advanced Configuration (see
Network Properties Configuration window (ECL, ECB & ECY Series)) and for
any of the following project code objects:
• Network Variable Input (ECL Series)
• Network Variable Output (ECL Series)
• Hardware Input (ECL Series)
• Hardware Output (ECL Series)
• Constant Enum (ECP Series)
• Constant Numeric (ECP Series)
• Constant Boolean
• Variable Enum (ECP Series)
• Variable Numeric (ECP Series)
• SmartSensor Outputs
• Wireless Inputs
• Wireless Outputs
• Flow Sensor (ECP Series)
• Damper Control (ECP Series)
• ComSensor (ECL Series)
Control points are automatically linked to the internal points of a controller so
that the internal points can be properly controlled by the EC-Net platform.
NOTE: These controller internal points are special control points that allow for
the control of internal parameters and can be identified in EC-Net in
the Points folder by their icon (the icon has a black dot in its cen-
ter).
For the highest level of integration with EC-Net, always use the latest
EC-Net service pack.
EC-gfxProgram 1345
Automatically The following procedure creates the control points on the EC-Net Station from
creating in EC- blocks in EC-gfxProgram code. If you update your code, and want to see the
Net the control change reflected on the Station, use the option Update Points (see Updating a
points used in control point in EC-Net). Add control points that are associated with a device’s
your code internal control points as follows:
1. Right-click the device and select Actions, Create Points.
Figure 786: Automatically adding internal control points of a compatible controller
2. A Create Points popup asks if you want to use a temporary folder. Select
True to put the control points into a temporary subfolder (you then choose
the ones you need to use by moving them as necessary in the Points
folder to then later delete the temporary folder to remove remaining
unused ones). Use the temporary folder when you need to replace only a
few existing proxy points. Select false to put all control points directly in
the Points folder of the device – this is not recommended as this can cre-
ate a large volume of network traffic that can impair normal operation.
NOTE: Pre-existing internal control points are not overwritten when creating
control points with the same name using the above procedure. Control
points are found under their corresponding network variable.
1346 EC-gfxProgram
EC-Net Platform Support Pack Features for ECP & ECL Series Controllers
3. Delete any unused internal control points that were created to reduce the
amount of memory resources needed.
NOTE: When the default value is set for the control point in EC-gfxProgram,
the same default value is automatically set in EC-Net for the control
point.
Updating a If a control point has been automatically created in EC-Net from an EC-gfx-
control point in Program project, and then you make a change of a block (format type, unit,
EC-Net Boolean value, or text for example), the control point in EC-Net will not be
automatically updated. First update the control point in EC-Net by right-click-
ing the device and selecting Actions, Update Points.
NOTE: This does not update points located in the temporary CreatedPoints
folder. If the control point does not update, delete the control points
and repeat the create control points procedure (see above).
Conversion of The Name, Type (Bool, Enum, or Numeric) and Units / Enumeration you con-
EC-gfxProgram figure for a LONWORKS network variable in EC-gfxProgram are reused to cre-
formats to EC- ate the EC-Net control point. For example,if you create a Numeric input that
Net control reads the Outdoor Air Temperature, the name of the block is OAT with the
points LonMark Format set to Fahrenheit, the same name, type, and unit will be
reproduced in EC-Net.
If no format is set for a block’s output port, the control point will be numeric
without a facet applied.
Boolean Output ports that are configured as Boolean format in EC-gfxProgram are
automatically created as Boolean control points with the corresponding name
and facets in EC-Net.
Enumeration Output ports that are configured as enumeration format in EC-gfxProgram are
automatically created as enumeration control points with the corresponding
name and facets in EC-Net for the following objects:
• Hardware Output
• Constant Enum (ECP Series)
• Variable Enum (ECP Series)
• SmartSensor Outputs
• Wireless Inputs
For all other objects, they are automatically created as numeric control points.
The notion of a value range for enumeration does not exist in EC-Net and any
enumeration value range created in EC-gfxProgram is not created in EC-Net.
NOTE: The SNVT_count_32 enumeration is not supported in EC-Net.
Numeric value + Output ports that are configured as Numeric Value + Text format in EC-gfx-
Text Program are automatically created as numeric control points with the corre-
sponding name and with a ptText facet that can be used in px pages.
EC-gfxProgram 1347
LonMark Output ports that are configured as LonMark Enumeration format in EC-gfx-
enumeration Program are automatically created as enumeration control points with the cor-
responding name and facets in EC-Net for the following objects:
• Hardware Output
• Constant Enum (ECP Series)
• Variable Enum (ECP Series)
• SmartSensor Outputs
• Wireless Inputs
For all other objects, they are automatically created as numeric control points.
LonMark format Output ports that are configured as LonMark format in EC-gfxProgram are
automatically created as numeric control points.
For ECL Series controllers only: EC-gfxProgram blocks that use a LonMark
format from any installed manufacturer’s DRF will be automatically converted
into control points with the corresponding name and facets in EC-Net.
For ECP Series controllers only: Only EC-gfxProgram blocks that use a Lon-
Mark format listed below will be automatically converted into control points
with the corresponding name and facets in EC-Net. For formats not listed
below, you will have to set the facet manually in EC-Net (see Internal control
points configuration to do so).
Table 38: Supported LonMerk formats
LonMark Format
SNVT_abs_humid
SNVT_amp SNVT_amp_c SNVT_amp_mil
SNVT_angle SNVT_angle_deg SNVT_angle_vel
SNVT_area
SNVT_btu_kilo SNVT_btu_mega
SNVT_density
SNVT_elec_kwh SNVT_elec_whr
SNVT_enthalpy
SNVT_flow SNVT_flow#US_liq
SNVT_flow_mil SNVT_flow_p
SNVT_freq_hz SNVT_freq_kilohz SNVT_freq_milhz
SNVT_grammage
SNVT_length SNVT_length_kilo SNVT_length_micr SNVT_length_mil
SNVT_lev_cont SNVT_lev_percent
1348 EC-gfxProgram
EC-Net Platform Support Pack Features for ECP & ECL Series Controllers
Table 38: Supported LonMerk formats
LonMark Format
SNVT_lux
SNVT_mass SNVT_mass_kilo SNVT_mass_mega SNVT_mass_mil
SNVT_ph
SNVT_power SNVT_power_kilo
SNVT_ppm
SNVT_press SNVT_press#US_psi SNVT_press_p SNVT_press_p#US_ps
i
SNVT_res SNVT_res_kilo
SNVT_rpm
SNVT_sound_db
SNVT_speed SNVT_speed_mil
SNVT_temp SNVT_temp#US_diff
SNVT_temp_diff_p SNVT_temp_p#US_diff
SNVT_temp_p
SNVT_temp_ror
SNVT_time_hour SNVT_time_min SNVT_time_sec
SNVT_turbidity
SNVT_vol SNVT_vol#US_gal SNVT_vol_kilo SNVT_vol_kilo#US_gal
SNVT_vol_mil
SNVT_volt SNVT_volt_ac SNVT_volt_dbmv SNVT_volt_kilo
SNVT_volt_mil
UNVT_flow#SI_m3h
UNVT_press_p#US_mi
lli
EC-gfxProgram 1349
Manual creation of internal control points
Internal control points are linked to the internal points of a controller so that
the internal points can be properly controlled by the EC-Net platform. There
are 3 types of internal control points: BcpNumericWritable, BcpEnumWritable,
and BcpBooleanWritable. Any type of internal control point can be linked to
any type of internal point in the controller (with the exception that BcpEnum-
Writable cannot be linked to Constant Numeric (ECP Series), Variable
Numeric (ECP Series), and Hardware Input (ECL Series)), but generally
BcpNumericWritable internal control points are linked to internal points with
numeric values and BcpEnumWritable internal control points are linked to
internal points with enumerated values.
NOTE: It is easier to use the Automatic generation of control points from EC-
gfxProgram code feature to automatically create the Internal control
points into a temporary folder. Simply move the needed points from
the temporary folder into the points folder and then delete the tempo-
rary folder.
Linking an To link an Internal control point to an internal point of a controller:
internal control
point to an 1. Open the distechControls palette, and then expand the Drivers, LON-
internal point of WORKS, ProgrammableControllers, Graphical programming control-
an EC- lers, and Utilities folders to locate the Bcp control points.
gfxProgram
controller
1350 EC-gfxProgram
EC-Net Platform Support Pack Features for ECP & ECL Series Controllers
2. Drag and drop an Internal control point from the distechControls palette
onto the Points folder of the EC-gfxProgram compatible controller in the
station. The internal control point will be in fault until it is linked to an inter-
nal point.
Figure 787: Adding an internal control point to an EC-gfxProgram compatible
controller
3. Configure the internal control point through its property sheet (see Inter-
nal control points configuration). Access the property sheet by:
• Double-clicking the point extension. The property sheet will appear in
the View Pane.
• Right-clicking the point extension, selecting Views and then Property
Sheet.
EC-gfxProgram 1351
NOTE: If the Points folder is expanded in the Nav Side Bar, the newly added
internal control point appears underneath and in the controller’s prop-
erty sheet under the Points parameter.
Figure 788: Location of internal control point in the EC-gfxProgram compatible controller
The previous instructions explained a basic setup in order to set read/write
access to an internal point. More internal control points can be added to rep-
resent other internal points from the EC-gfxProgram compatible controller by
repeating steps 2 and 3. Once you are done adding internal control points, a
graphics (Px) page can be created and the points can be dragged and
dropped onto it.
After configuring the internal control points, they can be copied and pasted
into other EC-gfxProgram compatible controllers if the same setup is desired.
This is done by:
1. Right-clicking the internal control point and selecting Copy.
Expanding the desired EC-gfxProgramcompatible controller, right-clicking the
Points folder and selecting Paste.
1352 EC-gfxProgram
EC-Net Platform Support Pack Features for ECP & ECL Series Controllers
Internal control Each internal control point has certain parameters that need to be configured
points in order to properly interface with the internal points of the controller.
configuration
Figure 789: Internal control point property sheet
Parameter Description
Facets This parameter affects how the value of the linked
internal point of the controller is displayed, such as
decimal places, engineering units, enumerations, etc.
Click the button to open the Config Facets window
and define how the data will be displayed. Click the
button to select from amongst the most recently
used facets.
NOTE: The range facet must be defined by the user for
an InternalPointEnum internal control point.
Proxy Ext Proxy Ext parameters are used to further define the link
between the internal control point and the internal point
of the controller. Refer to Proxy Ext for more
information on the Proxy Ext parameters.
Out Displays the current value, status, and priority level of
the linked internal point. This field is read only.
def Shows the default value when an internal control point
is in Fault. Click the button to expand the view and to
set the default value. To set a non-null value, deselect
null and then set a value in the field to the right.
Override Displays the date and time that the override mode will
Expiration expire when the linked internal point is put into override
mode. Null is displayed if the linked internal point is put
into permanent override mode or if it is in automatic
mode. This field is read only.
EC-gfxProgram 1353
Parameter Description
Select Type Select the type of internal point to which the internal
control point is to be linked. There are 8 types of
internal points in the drop-down list: hwInput, wrInput,
smInput, hwOutput, numVariable, enumVariable,
numConstant, and enumConstant.
NOTE: hwInput, numVariable, and numConstant are
not available in an InternalPointEnum internal
control point.
Select Index Select the index of the specific internal point to which
the internal control point is to be linked. The range
varies depending on the type of internal point selected
and the type of controller.
For example, a controller has 10 hardware inputs and
the internal control point is to be linked to hardware
input 2. The user would select hwInput from the Select
Type field and then enter 2 in the Select Index field.
Figure 790: Select type and select index example
Support, Write The last value written to the linked internal point. This
Value field is read only.
Support, Write This is an internal variable that should not be changed.
Scaling
Proxy Ext Proxy Ext parameters are used to further define the link between the internal
control point and the internal point of the controller. These parameters are set
with default values and usually do not require any user configuration.
Figure 791: Proxy ext property sheet
1354 EC-gfxProgram
EC-Net Platform Support Pack Features for ECP & ECL Series Controllers
Parameter Description
Status Status of the proxy extension, which in turn determines
the status of the linked internal point. These status flags
are set and cleared resulting from polled values or status
updates received through the BcpLonNetwork. There
are 9 status flags that are set automatically and are read
only:
• {ok} – The link between the internal control point and
internal point is functioning properly.
• {alarm} – The linked internal point currently has a
value in an alarm range as defined by its alarm
extension.
• {fault} – This indicates an AX configuration error or
license error. If a fault occurs following normal {ok}
status, it could be a “native fault” condition detected
within the controller or perhaps some other fault cri-
teria was met.
• {overridden} – The linked internal point is currently in
override.
• {disabled} – The internal control point has manually
been disabled by setting the Enabled field to false.
• {down} – The internal control point is unable to
receive a response from the linked internal point.
When one internal control point is in {down} status
all the other internal control points linked to the
same controller will be in {down} status.
• {stale} – Since the last poll update, the point’s value
has not been updated within the time specified in the
“Stale Time” of the LONWORKS network’s Tuning Pol-
icy. The {stale} status clears upon the next received
poll value.
• {null} – The linked internal point does not have a
specific value.
• {unackedAlarm} – Occurs after an alarm, if the point
is back to normal, but the alarm event is still not
acknowledged in the Alarm Console.
Fault Cause If the internal control point is in {fault} status, this field
will display a brief description as to the reason for the
fault. This field is read only.
Enabled This field determines whether the Proxy Ext and in turn
the internal control point is enabled or disabled. Set the
Enabled field to True to enable the control point. Set the
Enabled field to false to disable the control point.
Device Facets Native facets used in proxy read and write. Set the
internal control points facets under its Facets field.
EC-gfxProgram 1355
Parameter Description
Conversion Specifies the conversion used between the Device
Facets of the Proxy Extand the Facets of the internal
control point. There are five conversion types to select
from:
• Default – Conversion between units within the same
category (temperature, weight, length, etc.) is auto-
matically performed within the proxy point. For
example, if the Device Facets of the Proxy Ext is set
to °C and the Facets of the internal control point is
set to °F the output value is automatically converted.
However, if the Facets of the internal control point is
set to dissimilar units (say, in this case to kilograms),
a {fault} status occurs.
• Linear – Conversion within the same unit linearly by
specifying the Scale (which determines linear
response slope) and Offset (offset used in output
calculation).
• Reverse Polarity – Useful for InternalPointBoolean
to reverse the logic. Be careful in the use of the
reverse polarity conversion, as it may lead to later
confusion when troubleshooting logic or communi-
cations problems.
• Thermistor Type 3 – Applies to an internal control
point linked to an internal point that is using a type III
thermistor (ex. Hardware Input for temperature
sensing). This selection provides a "built-in" input
resistance-to-temperature value response curve for
Type 3 Thermistor temperature sensors.
• Tabular Thermistor – Applies to an internal control
point linked to an internal point that is using a therm-
istor (ex. Hardware Input for temperature sensing).
This selection provides a control for a popup dialog
for a custom resistance-to-temperature value
response curve, including ability to import and
export response curves.
NOTE: It is strongly recommended that this field not be
edited. Use the Default conversion.
Read Value Last value read from the device, expressed in device
facets. This field is read only.
Write Value Last value written, using device facets. This field is read
only.
1356 EC-gfxProgram
EC-Net Platform Support Pack Features for ECP & ECL Series Controllers
Parameter Description
Target Comp The NVO linked to the internal control point. This is
determined by the Select Type and Select Index fields.
NOTE: It is strongly recommended that this field not be
edited. Use the Select Type and Select Index
fields instead.
Target Name The name of the specific object in the NVO linked to the
internal control point. This is determined by the Select
Type and Select Index fields.
NOTE: It is strongly recommended that this field not be
edited. Use the Select Type and Select Index
fields instead.
Link Type Determines the service type of the internal control point.
There are five available service types:
• Standard – (unacknowledged) is the least reliable,
yet often most widely-used. This is the default ser-
vice type for a EC-Net binding. With this service, the
message is sent one time and no response is
expected. This service is typically used when the
highest level of network performance is needed, net-
work bandwidth is limited, and the application is not
sensitive to the loss of messages.
• Reliable – (unacknowledged/repeated) is recom-
mended for messaging that has been classified as
important--if there is a specific need to know that a
status has changed. Reliable messaging sends a
message three times. The controller sends each
message three times, and if the EC-Net platform
receives the message, it simply throws subsequent
messages away.
• Critical – (acknowledged) means that the EC-Net
platform must acknowledge the fact that it received a
message. The controller continues to send the mes-
sage until the EC-Net platform acknowledges receipt
of that message. You are limited to the number of
bindings that can be defined as critical, because it
often causes communication issues by loading down
the network with message verification traffic.
• Authenticated – a security service reserved for
secure messaging. When using authentication, the
controller must identify itself to the EC-Net platform,
and vice-versa. This service is rarely used, and only
in instances where messaging must be secure.
• Poll Only – This will only poll the internal point.
Priority Enable or disable the priority.
EC-gfxProgram 1357
Internal control points actions
After linking an internal control point to an internal point the control point can
be used to manually set or control the internal point. By right-clicking the inter-
nal control point and selecting Actions, a set of commands become available
to the user to manually affect the internal point. The actions that are displayed
depend on the internal control point being used as well as the type of internal
point.
Figure 792: Internal control points actions
If the internal control point is linked to an NVO internal point.
InternalPointNumeric and InternalPointEnum Actions
Parameter Description
Override Use this action to put the internal point into override
mode. The override duration can be set in the Override
window.
Auto Use this action to put the internal point into Automatic
mode.
Read Point Use this action to read the current actual value of the
internal point.
1358 EC-gfxProgram
EC-Net Platform Support Pack Features for ECP & ECL Series Controllers
If the internal control point is linked to an NCI internal point:
Parameter Description
Set Use this action to manually set the value of an internal
point.
Read Point Use this action to read the current actual value of the
internal point.
NOTE: An internal control point will not read an override mode that is acti-
vated directly in the programming tool of a programmable controller.
InternalPointBoolean Actions
Parameter Description
True (Active) Use this action to put the internal point into override
True (Active) mode. How long the internal point will
remain True is determined by the Min Active Time set
in the InternalPointBoolean property sheet. The
override duration can be set in the Override window.
False (Inactive) Use this action to put the internal point into override
False (Inactive) mode. How long the internal point will
remain False is determined by the Min Inactive Time
set in the InternalPointBoolean property sheet. The
override duration can be set in the Override window.
Auto Use this action to put the internal point into Automatic
mode.
Read Point Use this action to read the current actual value of the
internal point.
Hide/Show point When control points are used on a Px graphics page, you do not always want
actions (ECP & an operator to be able to override the control point. This feature allows you to
ECL Series) control what actions can be done to a control point on a Px graphics page. By
selecting one or more control points, you can control any one of the actions
that are available for the selected control points. This procedure presumes
that the control points have already been created on the station for the con-
troller – see Automatic generation of control points from EC-gfxProgram code.
Proceed as follows.
1. Expand the Points folder tree under the device to show the control points.
EC-gfxProgram 1359
2. Select the control points that you want to disable actions from being done
to them from a Px graphics page. To select two or more control points,
first click a control point, then hold down the Ctrl or Shift key and click
another control point to individually add it to the selection or a to select a
range of control points.
Figure 793: Selecting a range of control points
3. The Hide/Show Points Actions pop-up appears. The action’s options
shown change according to the actions available to each control point
that has been selected. Selecting or deselecting an action will apply to all
selected control points, as applicable to the individual control point. Dese-
lect the control point actions that you do not want an operator to be able
to access on a Px graphics page. Click OK.
Figure 794: Disabling Px graphics page control point actions that an operator will
not be able to override
1360 EC-gfxProgram
EC-Net Platform Support Pack Features for ECP & ECL Series Controllers
Linking, building, and trimming LONWORKS compo-
nent objects in EC-Net
EC-Net is used to create and manage LONMARK component network bindings
to link one controller to another controller thereby forming a direct network
connection between the two controllers.
This is opposed to a proxy binding (through the creation of control points)
which requires EC-Net to be present on the network. Unlike proxy binding, no
control points are created in EC-Net and therefore the data cannot be directly
used in EC-Net graphics (Px) pages, logs, or alarms.
When you add a device, the network variables are automatically created.
Ensure to set the same SNVT type for both matching network variables on
each controller. See Change Type (ECP & ECL Series).
NOTE: This procedure applies only to controllers that use the BcpLonworks-
Device device type.
When finished creating network bindings, use the Trim function to
remove unused objects to reduce the amount of memory resources
needed. Should you need to then create more network bindings, you
can create them by using the Build function to create the underlying
NV components. See below.
Linking the LONWORKS component objects
Once the LONWORKS component objects are used in a project’s code, they
can be bound to other LONWORKS Component Objects that are used by the
project code of another LONWORKS controller.
If you need to create a control point in EC-Net for a network variable that is
going to be bound to another controller, it is best to create it only on the con-
troller with the network variable output (as opposed to the controller with the
network variable input). See also Automatic generation of control points from
EC-gfxProgram codee.
EC-gfxProgram 1361
In EC-Net, Bcp devices have the following two incompatible methods to link
network variables between controllers. When using one Link Mark method in
the menu, you cannot use the other method to complete the Link From or
Link To in the menu.
Figure 795: The two incompatible link mark methods
Parameter Description
1 The Bcp Nv Link Mark actions that are used according
to the procedure below.
2 The standard EC-Net Link Mark actions that are
described in EC-Net’s documentation.
1362 EC-gfxProgram
EC-Net Platform Support Pack Features for ECP & ECL Series Controllers
The following procedure shows how to link a network variable value from the
first controller to make it available on the second controller according to the
figure below.
Figure 796: Linking the LONWORKS component objects overview
1. In the project code for both controllers, add a component object to the
programming sheet and connect it to the appropriate code.
2. In the project code for both controllers, ensure to set the same SNVT type
for both matching variables on each controller. See Change Type (ECP &
ECL Series).
3. In the EC-gfxProgram for both controllers, synchronize the project with
their respective controller. See Project Synchronization.
4. In EC-Net, on Controller A, right-click the controller in the Nav tree and
select Nv Link Mark.
Figure 797: Selecting the Nv Linl Mark on the first controller in EC-Net
EC-gfxProgram 1363
5. In EC-Net, on Controller B, right-click the controller in the Nav tree and
select Nv Link From “Controller A”. The Link window opens.
Figure 798: Selecting Lin Mark
6. In the Link window, select the Source object in the left pane (NVOs) and
then the Target object in the right pane (NVIs). Only objects that have the
same SNVT type can be linked. Click OK.
Figure 799: Linking the source object to the target object
1364 EC-gfxProgram
EC-Net Platform Support Pack Features for ECP & ECL Series Controllers
7. Links have to be bound through the Lon Link Manager view of a
BcpLonNetwork. Right-click BcpLonNetwork in the Nav tree and select
Views > Lon Link Manager.
Figure 800: The Link Manager showing the current links between controllers
8. Select the New Link binding in the list and click Selective Bind.
Figure 801: Binding the new link
9. Wait for the Lon Bind to complete and for the LinkStatus to become
Bound.
Figure 802: The LinkStatus has become bound
EC-gfxProgram 1365
Removing the binding between two controllers
A binding between two controllers is managed by EC-Net, however the bind-
ing is made in the controllers themselves.
NOTE: If a binding is to be removed that has control points that have been
created in EC-Net for either controller, it is recommended to delete
these control points on either controller before carrying out this proce-
dure. Once this procedure is complete, recreate the control points in
EC-Net if necessary. See also Automatic generation of control points
from EC-gfxProgram code.
Remove a binding as follows.
1. Open the Lon Link Manager view of a BcpLonNetwork: Right-click
BcpLonNetwork in the Nav tree and select Views > Lon Link Manager.
2. Find the srcDevice node for the link. In the screen below, this is shown as
VAV Lobby.HwInput1. In the Nav tree, right-click the corresponding node
and select Views > Link Sheet.
Figure 803: Opening the link sheet for the bound node
1366 EC-gfxProgram
EC-Net Platform Support Pack Features for ECP & ECL Series Controllers
3. Right-click the link and select Delete Links.
Figure 804: Deleting the bindings’s link
4. Open the Lon Link Manager view of a BcpLonNetwork: Right-click
BcpLonNetwork in the Nav tree and select Views > Lon Link Manager.
5. Select the binding. Its linkStatus should be Obsolete. Click Selective
Bind.
Figure 805: Removing the binding
EC-gfxProgram 1367
6. The Binding’s linkStatus should be Unbound. Click Refresh to remove
the binding from the Lon Link Manager’s list.
Figure 806: Refreshing the Lon Link manager’s list
Trimming LONWORKS component objects in EC-Net
NOTE: This procedure applies only to controllers that use the BcpLonworks-
Device device type.
Unused proxy LONWORKS component objects should be removed to reduce
the amount of memory resources needed. To remove these objects, right-click
the device and select Actions, Trim.
Building LONWORKS component objects in EC-Net
NOTE: This procedure applies only to controllers that use the BcpLonworks-
Device device type.
Build LONWORKS component objects (network variables and LONMARK
objects) when necessary as follows.
1. Right-click the device and select Actions, Build.
Figure 807: Selectiong Build
1368 EC-gfxProgram
EC-Net Platform Support Pack Features for ECP & ECL Series Controllers
2. Select the Build options as follows.
Figure 808: Selecting the Build options
Setting Description
lmos LONMARK object components
Nvs Network variables components
Ncis Network configurable input components
cps Configuration properties components
EC-gfxProgram 1369
Sending weather information to a controller
Controllers that are equipped with an operator interface or are connected to
an ECx-Display can show the current weather conditions. Weather informa-
tion is also available to EC-gfxProgram code. The weather information
required for this feature is supplied by the EC-Net Weather Service and is
then processed by the BcpWeatherExport component to make it available to
all controllers through the use of network variable bindings.
For weather information to be available in EC-Net, the EC-Net platform must
have Internet connectivity to access the weather service information: There-
fore the Platform’s TCP/IP Configuration must be configured. If this station is
without Internet access, but it is a subordinate of a Supervisor station already
using the WeatherService, then use the EC-Net Fox Weather Provider to
enable WeatherService connectivity (refer to the EC-Net documentation for
more information about how to do so).
Adding the For a EC-Net platform that has Internet connectivity, configure it as follows.
WeatherService
to the station 1. Click the Open Palette button in the Palette side bar to open the Open
(ECL Series) Palette selection window.
Figure 809: Opening the Open Palette window
NOTE: If the Palette side bar is not open in the Side Bar Pane, click Windows
> Side Bars > Palette to add the Palette side bar.
1370 EC-gfxProgram
EC-Net Platform Support Pack Features for ECP & ECL Series Controllers
2. Select weather from the Open Palette selection window and click OK.
This will add the Weather palette to your Palette side bar.
Figure 810: Opening Palette window: select weather
3. Install the WeatherService: Drag and drop the WeatherService from the
weather Palette into the Station’s Services tree.
Figure 811: Installing the WeatherService on the station
NOTE: The Services tree is found within the Config tree of the station.
EC-gfxProgram 1371
4. Click OK to add the WeatherService on the station.
Figure 812: Accepting the installation of the WeatherSerbvice on the station
Configuring the The WeatherService must be configured by adding one or more weather pro-
WeatherService viders. The standard weather provider, EC-Net Nws Weather Provider will
(ECL Series) be used as an example in the procedure below (refer to the EC-Net documen-
tation for the configuration information of other available weather providers).
Weather providers are added to the Weather Manager. The Weather Man-
ager can be accessed from the Nav side bar; double-click WeatherService in
the Services tree of the station.
Figure 813: The Weather Manager
Add a weather provider as follows.
1. Click New.
2. Select Nws Weather Provider in Type to Add. Set the Number to Add
to 1. Click OK.
Figure 814: Accepting the Weather Provider
1372 EC-gfxProgram
EC-Net Platform Support Pack Features for ECP & ECL Series Controllers
3. Give the weather provider a name and select the current building’s loca-
tion in Provider. Click OK.
Figure 815: Naming the Weather Report and setting the location
The Weather Report is available when the fields populate with weather data
as shown below. If weather data is not available, verify that the Platform’s
TCP/IP Configuration is properly configured.
Figure 816: A weather report showing data for a location
Configuring the To make the weather data available to ECL Series controllers, the BcpWeath-
Weather Export erExport component needs to be added to the BcpLonNetwork driver. Pro-
component for a ceed as follows.
LONWORKS
network 1. Click the Open Palette button in the Palette side bar to open the Open
Palette selection window. See Figure 809.
2. Select the distechControls palette from the Open Palette selection win-
dow and click OK. This will add the distechControls palette to your Pal-
ette side bar.
EC-gfxProgram 1373
3. Install the BcpWeatherExport component: Drag and drop the Bcp-
WeatherExport component from the Palette into the Station’s BcpLon-
Network drivers tree.
Figure 817: Installing the BcpWeatherExport on the station
NOTE: The BcpLonNetwork driver is found within the Config > Drivers tree
of the station.
4. Click OK to add the WeatherService on the station.
Figure 818: Accepting the addition of the BcpWeatherExport component
Linking the The BcpWeatherExport component needs to be linked to a Weather Report
Weather Export in order to receive the weather report data. Proceed as follows.
component to
the Weather 1. Double-click the BcpWeatherExport component to open its property
Report (ECL sheet.
Series)
1374 EC-gfxProgram
EC-Net Platform Support Pack Features for ECP & ECL Series Controllers
2. Click the tiny black arrow on the folder icon (located on the right of
the Weather Report Path field) and select Component Chooser.
Figure 819: Selecting the Component Chooser
3. Navigate to the location where the weather provider is found: Services >
WeatherService > [weather report provider] and click OK.
Figure 820: Navigating the Weather Report provider location
EC-gfxProgram 1375
4. Click Save.
Figure 821: Weather Report path - saving selected provider
Configuring the Once the BcpWeatherExport component has been added to the BcpLonNet-
Weather Export work, it must be configured.
component (ECL
Series) Figure 822: Configuring the BcpWeatherExport
Parameter Description
Enabled Enables / disables the operation of the weather export
component. Set to True.
Weather Report This is the ord to the Weather Report. See Linking the
Path Weather Export component to the Weather Report
(ECL Series) to create this ord.
1376 EC-gfxProgram
EC-Net Platform Support Pack Features for ECP & ECL Series Controllers
Parameter Description
Send Heartbeat Shows how often the weather data will be sent to the
controllers.
Trigger Mode Sets the method that triggers a weather data update
being sent to the controllers.
Last Trigger Shows the last time a weather data update was sent to
the controllers.
Next Trigger Shows the next time a weather data update will be sent
to the controllers.
nvoCurrWeath The current weather conditions network variable. This
Cond is bound to a controller’s NVI whose facet type has
been changed to UNVT_current_weather_condition.
nvoWeath The weather forecast network variable for today
Forecast0 to (nvoWeathForecast0) and up to six days from now
nvoWeath (nvoWeathForecast6). This is bound to a controller’s
Forecast6 NVI whose facet type has been changed to
UNVT_weather_forecast.
Binding the Each ECL Series controller that is to receive weather data must be bound to
Weather Export the building controller. The controller must be online: To do this, you must first
component to a use the Change Type (ECP & ECL Series) option on the network variable
controller input that is going to receive the weather data. Launch EC-gfxProgram for the
controller and configure it as follows.
1. Launch the EC-gfxProgram wizard for the controller: Right-click the con-
troller and select Launch Wizard.
Figure 823: Launching the EC-gfxProgram wizard
EC-gfxProgram 1377
2. Add a Network Variable Input block to the programming sheet.
Figure 824: Adding a Network Variable Input block to the programming sheet
3. Right-click the Network Variable Input block and select Change Type.
Figure 825: Changing the Network Variable Input’s facet type
4. In the Type file drop-down list, select StaticProg.typ. In the Types list,
select UNVT_current_weather_condition if you are binding to the
nvoCurrWeathCond (for the current weather conditions) or select
1378 EC-gfxProgram
EC-Net Platform Support Pack Features for ECP & ECL Series Controllers
UNVT_weather_forecast if you are binding to nvoWeathForecast0 to
nvoWeathForecast6 (for the weather forecast) and click OK.
Figure 826: Changing the Network Variable Input’s facet type to
UNVT_current_weather_condition to receive the current weather forecast
NOTE: The Network Variable Input block updates with weather data ports.
In EC-Net, the corresponding network variable’s facet has now
changed to support weather data.
EC-gfxProgram 1379
5. In EC-Net, right-click the BcpWeatherExport component (found under
Station > Config > Drivers > BcpLonNetwork) network variable and
select Nv Link Mark.
Figure 827: Selecting the Nv Link Mark on the BcpWeatherExport component EC-
Net
6. Right-click the controller and select NvLink From “BcpWeatherExport”.
Figure 828: Making the link to the controller’s Network Variable Input
7. In the Link window, select nvoCurrWeathCond or nvoWeathForecast0-
6 as the Source and the Controller’s Network Variable Input as the Tar-
1380 EC-gfxProgram
EC-Net Platform Support Pack Features for ECP & ECL Series Controllers
get. Since in the project code we used Network Variable Input 1, the tar-
get appears here as nviFP01. Click OK.
Figure 829: Linking the Source object to the Target object
8. Links have to be bound through the Lon Link Manager view of a
BcpLonNetwork. Right-click BcpLonNetwork in the Nav tree and select
Views > Lon Link Manager.
Figure 830: The Link Manager showing the current links between controllers
EC-gfxProgram 1381
9. Select the New Link binding in the list and click Selective Bind.
Figure 831: Binding the new link
10. Wait for the Lon Bind to complete and for the LinkStatus to become
Bound.
Figure 832: The LinkStatus has become bound
11. In the controller’s operator interface / ECx-Display (when equipped), you
will have to go into a non-weather menu and then return to the main menu
in order to refresh the main screen. The Weather icon becomes available
and the menu shows the weather data.
Weather data is also available to the project code connected to the output
ports of the Network Variable Input block.
Should you want to remove a binding, see Removing the binding between
two controllers.
1382 EC-gfxProgram
EC-Net Platform Support Pack Features for ECB & ECY Series Controllers
CHAPTER 13
EC-Net Platform Support Pack Features
for ECB & ECY Series Controllers
An EC-gfxProgram compatible controller can be programmed using EC-gfx-
Program on a Distech Controls platform just like any other device. However,
control points must be created in EC-Net to link to the controller’s values such
as inputs, outputs, etc. This chapter explains a method to quickly create con-
troller points in EC-Net. Proxy points are typically used in graphics (Px)
pages, logs or alarms.
Topics
Introduction
Automatic generation of control points from EC-gfxProgram code
Hide/Show point actions (ECB & ECY Series)
Configuring weather information for controllers with an operator interface
EC-gfxProgram 1385
Introduction
EC-gfxProgram compatible controllers share values through BACnet objects.
These objects can be discovered and added to the EC-Net station through the
standard Point Manager. The Point Manager is a standard view in EC-Net that
is available under all devices’ Points folder. When working with ECB & ECY
Series controllers, the controller typically needs to be Online in order to dis-
cover the points contained in the controller. This mechanism has many advan-
tages; however, it also has the disadvantage of not allowing the station to be
pre-engineered in EC-Net. When working with ECB & ECY Series controllers
and with EC-gfxProgram, the points (BACnet objects) can be discovered and
added to the station even if the controller is Offline. This has the benefit of
allowing the station to be pre-engineered in EC-Net.
The EC-Net platform is used to manage these points for several purposes
including reading and writing to them in a graphics (Px) page, logging them, or
linking them to alarms. choose in the Configuration Assistant.
NOTE: For the highest level of integration with EC-Net, always use the latest
EC-Net service pack.
1386 EC-gfxProgram
EC-Net Platform Support Pack Features for ECB & ECY Series Controllers
Automatic generation of control points from EC-gfx-
Program code
An EC-gfxProgram controller function automatically creates EC-Net control
points from the BACnet objects included in project code including:
• Analog Input
• Analog Output
• Analog Value (ECB & ECY Series)
• Binary Input
• Binary Output
• Binary Value (ECB & ECY Series)
• Multi-State Input
• Multi-State Value
• Loop
Automatically The following procedure creates the control points on the EC-Net Station from
creating the blocks in EC-gfxProgram code. If you update your code, and want to see the
control points change reflected on the Station, use the option Update Points (see Updating a
used in EC- control point in EC-Net). Add control points that are associated with device
gfxProgram points as follows:
code
EC-gfxProgram 1387
1. Right-click the device and select Actions, Create Points.
Figure 833: Automatically adding internal control points to an EC-gfxProgram
compatible controller in EC-Net
2. A Create Points popup asks if you want to use a temporary folder. Select
True to put the control points into a temporary subfolder (you then choose
the ones you need to use by moving them as necessary in the Points
folder to then later delete the temporary folder to remove remaining
unused ones). Use the temporary folder when you need to replace only a
few existing proxy points. Select false to put all control points directly in
the Points folder of the device – this is not recommended as this can cre-
ate a large volume of network traffic that can impair normal operation.
Figure 834: Selecting where the internal control points are to be created
1388 EC-gfxProgram
EC-Net Platform Support Pack Features for ECB & ECY Series Controllers
NOTE: Pre-existing internal control points are not overwritten when creating
control points with the same name using the above procedure.
Figure 835: Once the control points are created, a notification is shown
3. Delete any unused internal control points that were created as they
unnecessarily consume resources.
NOTE: When the default value is set for the control point in EC-gfxProgram,
the same default value is automatically set in EC-Net for the control
point.
Updating a If a point has been automatically created in EC-Net from an EC-gfxProgram
control point in project, and then you change the BACnet units of a BACnet object in EC-gfx-
EC-Net Program, the control point in EC-Net will not be automatically updated. To
update the control point, right-click the device and select Actions, Update
Points.
If a point has been automatically created in EC-Net from an EC-gfxProgram-
project, and then you change the BACnet object name or format type in EC-
gfxProgram, the control point in EC-Net will not be automatically updated. To
update the control point in EC-Net, delete the control point and repeat the
Create Control Points procedure (see above).
Verifying control If control points have been automatically created in EC-Net from an EC-gfx-
points in EC-Net Program project, you can confirm that there are no issues with the current
control points such as duplicates, or incorrect facets.
Conversion of The Name, Type (Binary, Multi-State, or Analog) and the BACnet Units / Enu-
EC-gfxProgram meration you configure for a BACnet object in EC-gfxProgram are reused to
formats to EC- create the EC-Net control point. For example, in EC-gfxProgram, if you create
Net control an Analog Input that reads the Outdoor Air Temperature, the name of the
points block is OAT with the BACnet unit set to Fahrenheit, the same name, type,
and unit will be reproduced in EC-Net.
EC-gfxProgram 1389
Hide/Show point actions (ECB & ECY Series)
When control points are used on a Px graphics page, you do not always want
an operator to be able to override the control point. This feature allows you to
control what actions can be done to a control point on a Px graphics page. By
selecting one or more control points, you can control any one of the actions
that are available for the selected control points. This procedure presumes
that the control points have already been created on the station for the con-
troller – see Automatic generation of control points from EC-gfxProgram code.
Proceed as follows.
1. Expand the Points folder tree under the device to show the control points.
2. Select the control points that you want to disable actions from being done
to them from a Px graphics page. To select two or more control points,
first click a control point, then hold down the Ctrl or Shift key and click
another control point to individually add it to the selection or a to select a
range of control points.
Figure 836: Selecting a range of control points
3. The Hide/Show Points Actions pop-up appears. The action’s options
shown change according to the actions available to each control point
that has been selected. Selecting or deselecting an action will apply to all
selected control points, as applicable to the individual control point. Dese-
lect the control point actions that you do not want an operator to be able
to access on a Px graphics page. Click OK.
Figure 837: Disabling Px graphics page control point actions that an operator will
not be able to override
1390 EC-gfxProgram
EC-Net Platform Support Pack Features for ECB & ECY Series Controllers
Configuring weather information for controllers with
an operator interface
Controllers that are equipped with an operator interface or are connected to
an ECx-Display can show the current weather conditions. The weather infor-
mation required for this feature is supplied by the EC-Net Weather Service
and is then processed by the BcpWeatherExport component to make it
available to all controllers on a specific subnet identified by a network number
(local broadcast), or to all controllers on all subnets (global broadcast). In the
case of a global broadcast, the weather information is passed on (repeated)
by Building Controllers according to their routing configuration.
For weather information to be available in EC-Net, the EC-Net platform must
have Internet connectivity to access the weather service information: There-
fore the Platform’s TCP/IP Configuration must be configured. If this station is
without Internet access, but it is a subordinate of a Supervisor station already
using the WeatherService, then use the EC-Net Fox Weather Provider to
enable WeatherService connectivity (refer to the EC-Net documentation for
more information about how to do so).
Adding the For a EC-Net platform that has Internet connectivity, configure it as follows.
WeatherService
to the Station 1. Click the Open Palette button in the Palette side bar to open the Open
(ECB & ECY Palette selection window.
Series) Figure 838: Opening the Open Palette window
NOTE: If the Palette side bar is not open in the Side Bar Pane, click Win-
dows> Side Bars > Palette to add the Palette side bar.
EC-gfxProgram 1391
2. Select weather from the Open Palette selection window and click OK.
This will add the Weather palette to your Palette side bar.
Figure 839: Open Palette window: Select weather
3. Install the WeatherService: Drag and drop the WeatherService from the
weather Palette into the Station’s Services tree.
Figure 840: Installing the WeatherService on the station
NOTE: The Services tree is found within the Config tree of the station.
1392 EC-gfxProgram
EC-Net Platform Support Pack Features for ECB & ECY Series Controllers
4. Click OK to add the WeatherService on the station.
Figure 841: Accepting the installation of the WeatherService on the station
Configuring the The WeatherService must be configured by adding one or more weather pro-
WeatherService viders. The standard weather provider, Nws Weather Provider will be used
(ECB & ECY as an example in the procedure below (refer to the EC-Net documentation for
Series) the configuration information of other available weather providers). Weather
providers are added to the Weather Manager. The Weather Manager can be
accessed from the Nav side bar; double-click WeatherService in the Services
tree of the station.
Figure 842: The Weather Manager
Add a weather provider as follows.
1. Click New.
2. Select Nws Weather Provider in Type to Add. Set the Number to Add
to 1. Click OK.
Figure 843: Accepting the Weather Provider
EC-gfxProgram 1393
3. Give the Weather Report a name and select the current building’s location
in Provider. Click OK.
Figure 844: Naming the Weather Report and setting the location
The Weather Report is available when the fields populate with weather
data as shown below. If weather data is not available, verify that the Plat-
form’s TCP/IP Configuration is properly configured.
Figure 845: A weather report showing weather data for a location
Adding the To broadcast the weather data to ECB & ECY Series controllers, the Bcp-
Weather Export WeatherExport component needs to be added to the BcpBacnetNetwork
component to driver. Proceed as follows.
the BACnet
network 1. Click the Open Palette button in the Palette side bar to open the Open
Palette selection window. See Figure 838.
2. Select distechControls palette from the Open Palette selection window
and click OK. This will add the distechControls palette to your Palette
side bar.
1394 EC-gfxProgram
EC-Net Platform Support Pack Features for ECB & ECY Series Controllers
3. Install the BcpWeatherExport component: Drag and drop the Bcp-
WeatherExport component from the Palette into the Station’s BcpBac-
netNetwork drivers tree.
Figure 846: Installing the BcpWeatherExport on the station
NOTE: The BcpLonNetwork driver is found within the Config > Drivers tree
of the station.
4. Click OK to add the WeatherService on the station.
Figure 847: Accepting the addition of the BcpWeatherExport component
Linking the The BcpWeatherExport component needs to be linked to a Weather Report
Weather Export in order to receive the weather report data. Proceed as follows.
component to
the Weather 1. Double-click the BcpWeatherExport component to open its property
Report (ECB & sheet.
ECY Series)
EC-gfxProgram 1395
2. Click the tiny black arrow on the folder icon (located on the right of
the Weather Report Path field) and select Component Chooser.
Figure 848: Selecting the Component Chooser
3. Navigate to the location where the weather provider is found: Services >
WeatherService > [weather report provider] and click OK.
Figure 849: Navigating the Weather Report Provider location
1396 EC-gfxProgram
EC-Net Platform Support Pack Features for ECB & ECY Series Controllers
4. Click Save.
Figure 850: Weather Report path - saving selected provider
5. In the controller’s operator interface / ECx-Display, you will have to go into
a non-weather menu and then return to the main menu in order to refresh
the main screen. The Weather icon becomes available and the menu
shows the weather data.
Configuring the Once the BcpWeatherExport component has been added to the BcpBacnet-
Weather Export Network, it must be configured.
component (ECB
& ECY Series) Figure 851: Accepting the addition of the BcpWeatherExport component
Parameter Description
Enabled Enables / disables the operation of the weather export
component. Set to True.
Weather Report This is the ord to the Weather Report. See Linking the
Path Weather Export component to the Weather Report
(ECB & ECY Series) to create this ord.
EC-gfxProgram 1397
Parameter Description
Send Heartbeat Shows how often the weather data will be sent to the
controllers.
Trigger Mode Sets the method that triggers a weather data update
being sent to the controllers.
Last Trigger Shows the last time a weather data update was sent to
the controllers.
Next Trigger Shows the next time a weather data update will be sent
to the controllers.
Export Type Sets the weather data update broadcast type:
• Global Broadcast: Broadcast the weather data to
all controllers on all subnets.
• Local Broadcast: Broadcast the weather data to
all controllers on a specific subnet (specified on the
right).
1398 EC-gfxProgram
Configuration Assistant
CHAPTER 14
Configuration Assistant
This chapter explains how to create a configuration user-interface on top of
your EC-gfxProgram code to select software operating modes and options.
This can be used for example, to make a programmable controller behave as
a configurable controller.
Topics
Introduction
Typical configuration assistant window
Creating a configuration variable
Creating a configuration assistant sheet
Configuration assistant ribbon
Creating the configuration assistant sheet layout
Setting a variable’s presentation
Adding a logo to the Configuration Assistant
Setting the Configuration Assistant’s properties
EC-gfxProgram 1399
Introduction
The Configuration Assistant allows you to create a configuration user-inter-
face on top of your EC-gfxProgram code that allows a user to select software
operating modes and options that have been previously created. This can be
used for example, to make a programmable controller behave as a configu-
rable controller, making it readily usable as an application-specific controller.
In this way, the Configuration Assistant standardizes and simplifies system
integration without on site programming.
When you open the code for a controller that has its Configuration Assistant
enabled, the Configuration Assistant is shown as the controller’s interface.
The controller’s EC-gfxProgram code can then be accessed through the Con-
figuration Assistant. However, this code may be password protected to keep
unauthorized users from modifying the controller’s programming.
The Configuration Assistant cannot read or modify values used in EC-gfxPro-
gram code directly. Instead, it reads and modifies Configuration Variables that
have been created for this purpose. There are two types of Configuration Vari-
ables.
Type Description
Configuration Is linked to one or more Configuration Parameters used
Variable by one or more blocks in your EC-gfxProgram code.
See Creating a configuration variable.
Live Is linked to the Configuration Parameters used by a
Configuration block in your EC-gfxProgram code. These values are
Variable updated in real time to reflect the current values being
used by the code. This can be used to view and set the
object’s present value.
For example, as BACnet objects are exposed to the
network, a Live Configuration Variable bound to such
an object will be updated with any value written to the
object through the network.
See Creating live configuration variables.
These Configuration Variables can be put into any order and laid out as you
choose in the Configuration Assistant.
1400 EC-gfxProgram
Configuration Assistant
Typical configuration assistant window
The Configuration Assistant window shown below is the configuration inter-
face for a typical configurable controller that has been previously created.
Figure 852: Typical configuration assistant interface
Item Description
1 The Configuration Assistant toolbar. See Configuration Assistant
toolbar.
2 The Configuration Assistant menus. See Configuration Assistant
menu.
3 The Configuration Assistant configuration parameters and tabs.
See Configuration Assistant configuration parameters and tabs.
EC-gfxProgram 1401
Configuration Assistant toolbar
The toolbar has the following options:
Parameter Description
Save Saves the current parameters into the device’s
database or in the case of an ECY Series controller, it
saves the current parameters into the controller itself.
The current parameters can also be saved by pressing
Ctrl+S on the keyboard.
Measurement Select the measurement system (Metric or US) to be
System displayed within the Configuration Assistant.
Note that this does not change the measurement
system of the project.
Switch to EC- Opens the EC-gfxProgram code for this project. If the
gfxProgram project is password protected, you will need the
project’s password to access the code.
Synchronize The Project Synchronization window is used to
Synchronize the code and configurations between the
device and PC, by either downloading from the PC to
one or more devices, or uploading from a device to the
PC. The information being transferred can include
configurations, modes, and values of blocks. See
Project Synchronization.
Import From File Allows you to import another project file. Once
imported, you must synchronize the project to send it to
the controller.
Firmware Upgrade the firmware of devices that are online on the
Upgrade network. See Upgrade firmware (for ECL Series or
ECB Series controllers only) and Upgrade firmware (for
ECY Series controllers).
Device Opens the Device Information window.
Information
NOTE: This information is only available if the device is
connected and online.
Configuration Assistant menu
The Configuration Assistant menus allows a user to navigate to specific con-
figuration parameters.
1402 EC-gfxProgram
Configuration Assistant
Configuration Assistant configuration parameters
and tabs
The Configuration Assistant configuration variables are shown in any order
you choose. Logical or functional groups of parameters can optionally be
organized into tabs for increased usability and less scrolling when the list of
variables is long.
Steps to Create a Configuration Assistant
Creating a Configuration Assistant is a multistep process. Proceed as follows:
1. Create the code required to control a process. Code in a way that allows
an externally-controlled variable to trigger different operational modes by,
for example, enabling or disabling sections of code, setting the range of
allowable options, and so on.
2. Identify the variables in your code that you want to expose to a user in the
Configuration Assistant.
3. Create the corresponding configuration variables and associate them to
the variables in your code. See Creating a configuration variable and Cre-
ating live configuration variables.
4. Create the Configuration Assistant layout by organizing the configuration
variables into menus and tabs and set the order in which they are to be
shown. See Creating a configuration assistant sheet.
5. Test the Configuration Assistant. Make corrections as necessary. See the
Preview mode in Configuration assistant ribbon.
EC-gfxProgram 1403
Creating a configuration variable
About A Configuration Variable holds a value that when used in the Configuration
configuration Assistant, allows a user to view the variable’s current value and to set the vari-
variables able’s value to be used in the controller’s EC-gfxProgram code. A Configura-
tion Variable is associated to one or more configuration parameters used by
other resource block instances configured for this project in the Resources
Configuration.
For example, in the Resources Configuration, each configuration parameter
can be linked to a Configuration Variable. This is shown by the symbol as
shown below next to a linked configuration parameter Controller specific.
Figure 853: Resources configuration parameters linked to configuration variables
Once a Configuration Variable has been created, it becomes available to be
used on any Configuration Assistant Sheet.
Once one or more configuration parameters have been linked to a Configura-
tion Variable, changing the value at one place in the Resources Configuration
will be propagated to all linked configuration parameters. Once a configuration
parameter has been used on a Configuration Assistant Sheet, its value will
likewise be propagated to all linked configuration parameters in the code.
Creating a The following methods can be used to create a Configuration Variable:
configuration
variable • Create a Configuration Variable directly from a configuration parameter in
the Resources Configuration. The configuration of the Configuration Vari-
able is automatically created with the necessary parameters suited to the
configuration parameter (for example, the data type, units, and so on).
See Creating a configuration variable directly from a configuration param-
eter.
• Create the Configuration Variable and then associate it with one or more
configuration parameters in the Resources Configuration. See Creating a
configuration variable to later associate it with a configuration parameter.
1404 EC-gfxProgram
Configuration Assistant
Creating a configuration variable directly from a
configuration parameter
The easiest way to create a new fully configured Configuration Variable is to
create it directly from a Configuration Parameter. By doing so, the Configura-
tion Variable is automatically configured for the data type and units that the
current Configuration Parameter is using.
Create a Configuration Variable directly from a Configuration Parameter as
follows:
1. Right-click the Configuration Parameter and select Bind to New Config-
uration Variable.
2. Set the Configuration Variable’s name in Name and select the group into
which the Configuration Variable is to be located in Create in. If a new
group is needed to organize variables into logical or structural group, click
Create new folder. Click OK.
Figure 854: Add variable destination
Once the Configuration Variable has been created, it can be bound to other
Configuration Parameters.
1. Right-click a resource’s configuration parameter in the Resource Tree and
select Bind to Existing Configuration Variable.
EC-gfxProgram 1405
2. From the Variable Selector list, select the Configuration Variable you
previously created. Click OK.
Figure 855: Selecting a variable you previously created
NOTE: The variable selector only displays variables of a compatible type.
3. Repeat steps 4 and 5 to bind other resource’s configuration parameters to
this Configuration Variable as necessary.
Creating a configuration variable to later associate
it with a configuration parameter
The following options are available when creating a Configuration Variable in
the Resources Configuration under Configuration Variables in the Resource
Tree.
Figure 856: Resource tree configuration variable options
Parameter Description
Add Adds a Configuration Variable. This is used to set the
configuration value of one or more resource
parameters in the Resources Configuration only.
Add Live Adds a Live Configuration Variable. This is used to set
the live value of an object property in the controller. For
example, BAcnet object properties or Lon object
properties. See Creating a live configuration variable to
later associate it with a resource block.
Add Group It is best to first create and organize variables into
logical or structural groups as appropriate.
Rename This allows you to rename the configuration variable.
1406 EC-gfxProgram
Configuration Assistant
Parameter Description
Delete This deletes the selected configuration variable.
Create the Configuration Variable and then associate it with one or more con-
figuration parameters in the Resources Configuration as follows:
1. In the Resource Tree (see Accessing the Resources Configuration win-
dow) right-click Configuration Variables and select Add Group. Name
the group according to its logical or structural application. Add as many
groups as necessary.
2. In the Resource Tree, right-click Configuration Variables or a group you
have created and select Add.
3. Configure the Configuration Variable. See Configuring a configuration
variable.
4. Bind the Configuration Variable to one or more configuration parameters.
Right-click a resource’s configuration parameter in the Resource Tree and
select Bind to New Configuration Variable.
5. From the Variable Selector list, select the Configuration Variable you
previously created. Click OK.
Figure 857: Selecting a variable you previously created
6. Repeat steps 4 and 5 to bind other resource’s configuration parameters to
this Configuration Variable as necessary.
EC-gfxProgram 1407
Configuring a configuration variable
Configuration A Configuration Variable can use any one of the following data types.
variable data
types Configuration
Description See
Variable type
String Holds a sequence of Configuring a sting variable
characters, text or both.
Boolean Holds one of two values Configuring a boolean
such as True or False, 1 variable
or 0.
Numeric Holds a number. Configuring a numeric
variable
Enum Holds a named value or Configuring an enum
element that is a member variable
of a list of elements.
1408 EC-gfxProgram
Configuration Assistant
Common All variables have the same General configuration parameters.
configuration
variable Figure 858: Common variable configuration parameters
parameters
Parameter Description
Name The variable’s name. There are specific rules in regard
to variable names:
• Must be unique within a given group.
• Can contain letters, digits, underscores, and dollar
signs.
• Must begin with a letter or an underscore.
• Cannot consist of one of the following reserved
words:
do, if, in, for, let, new, try, var, case, else, enum,
eval, false, null, this, true, void, with, break, catch,
class, const, super, throw, while, yield, delete,
export, import, public, return, static, switch, typeof,
default, extends, finally, package, private, continue,
debugger, function, arguments, interface, pro-
tected, implements, instanceof.
Display name The name of the variable displayed in the configuration
Assistant. The display name does not have
restrictionsand can be something more user-friendly for
easy identification.
Description Provide explanatory information about the variable.
The description is displayed as a tool tip on the variable
in the configuration assistant and can be used to
provide relevant information to the end user.
Full name This is how this variable will be identified wherever it is
used within the project.
Type The variable type.
EC-gfxProgram 1409
Configuring a This configuration variable type holds a sequence of characters, text or both.
sting variable
Figure 859: String variable configuration parameters
Parameter Description
Type String variable type.
Use max length Enable string length limiting.
Max length When Use max length is enabled, this sets the
maximum total number of characters the string is able
to accept.
Value The current value assigned to this variable.
The configuration variable type must correspond with the configuration
parameters’ type used by other resource block instances. For example, in the
Resources Configuration, the Object Name configuration parameter is a text
box that must be associated with a String Configuration Variable data type.
Figure 860: Example: text box object name configuration parameter requires a string
configuration variable data type
1410 EC-gfxProgram
Configuration Assistant
Configuring a This configuration variable type holds one of two values, such as True or
boolean variable False, 1 or 0.
Figure 861: Boolean variable configuration parameters
Parameter Description
Type Boolean variable type.
Value The current value assigned to this variable. When
ticked, the value is true or 1. When cleared, the value
is false or 0.
The configuration variable type must correspond to the configuration parame-
ters’ type used by other resource block instances. For example, in the
Resources Configuration, the Persist configuration parameter is a check box
that must be associated with a Boolean Configuration Variable data type.
Figure 862: Example: check box persist configuration parameter requires a boolean
configuration variable data type
EC-gfxProgram 1411
Configuring a This configuration variable type holds a number.
numeric variable
Figure 863: Numeric variable configuration parameters
Parameter Description
Type Numeric variable type.
Use range Used to constrain the usable range of permitted
numeric values. Your EC-gfxProgram code must be
able to make use of any value allowed by this setting.
Minimum When Use range is enable, this sets the lower and
Maximum: upper numeric value range limits that this variable is
able to accept.
Use precision This limits the number of digits to be shown after the
Number of decimal place to better show the available significant
decimals digits.
1412 EC-gfxProgram
Configuration Assistant
Parameter Description
Use units Sets whether this configuration variable is scalar or
US unit dimensionless (has no units). When Use units is
Metric unit enabled, the Configuration Assistant allows the user to
choose the measurement system to be used in the
interface. You must set a value for both unit types to be
able toggle between both measurement systems in the
Configuration Assistant.
In US unit, set the unit to use with this variable when
the Measurement System in the Configuration
Assistant is set to US units.
In Metric unit, set the unit to use with this variable
when the Measurement System in the Configuration
Assistant is set to Metric units.
Value The current value assigned to this variable.
The configuration variable type must correspond to the configuration parame-
ters’ type used by other resource block instances. For example, in the
Resources Configuration, the Integral time configuration parameter is a
numeric value that must be associated with a Numeric Variable data type.
Figure 864: Example: integral time configuration parameter requires a numeric
variable data type
EC-gfxProgram 1413
Configuring an This configuration variable type holds a named value or element that is a
enum variable member of a list of elements.
Figure 865: Enum variable configuration parameters
Parameter Description
Type Enum variable type.
Enumeration Shows the current list of enumeration members and the
Members corresponding numeric value assigned to each
member. According to the controller type,
enumerations have range limitations. See Creating and
using enumerations (8-Bit) or Creating and using
enumerations (ECL Series).
Click to add a new enumeration member.
Click to delete the enumeration member.
Allow custom When checked, this adds the ability to manually specify
values a numeric value for the variable instead of only allowing
selection from drop-down list. When this property is
selected, the variable is no longer restricted to the
numeric values defined as enumeration members but
can be either freely typed by the user or limited to a
specific range (see Use range below).
If you use the Value drop-down list with Allow custom
values being checked, you can quickly select the
desired value instead of perusing the list, by typing the
first characters of the desired enumeration member. As
soon as you unfold the drop-down list, the first element
matching the specified characters will be automatically
selected.
1414 EC-gfxProgram
Configuration Assistant
Parameter Description
Use range Used to constrain the usable range of permitted
numeric values. Your EC-gfxProgram code must be
able to make use of any value allowed by this setting.
This is only relevant when the Allow custom values
parameter is used.
Minimum When Use range is enabled, this sets the lower and
upper numeric value range limits that this variable is
Maximum
able to accept. This is only relevant when the Allow
custom values parameter is used.
Value The current value assigned to this variable.
The configuration variable type must correspond with the configuration
parameters’ type used by other resource block instances. For example, in the
Resources Configuration, the Time base configuration parameter is an enu-
meration that must be associated to an Enum Configuration Variable data
type.
Figure 866: Example: enumeration time base configuration parameter requires a enum
configuration variable data type
Once a binding has been made
Binding status The color of the binding icon shows its status.
Icon Description
The configuration parameters’ binding to the Configuration
Variable is working.
The configuration parameters’ binding to the Configuration
Variable is broken.
EC-gfxProgram 1415
More information about the binding’s status can be seen by hovering your
mouse over the binding icon.
Figure 867: Binding status
Parameter Description
Bound to This shows which Configuration Variable this
configuration parameter is linked to.
Error When the binding to the Configuration Variable is
broken, this message explains the underlying problem.
• Binding source type mismatch: The current Con-
figuration Variable’s data type is not the same as
this configuration parameter’s data type.
• Failed to synchronize bound object values: The
current value of the Configuration Variable is out-
side of this configuration parameter’s permitted
range. Set the range of the Configuration Variable
to be equally restrictive or more restrictive than the
range of the configuration parameter’s range.
Go to variable To view the Configuration Variable’s configuration, right-click a Configuration
Parameter and select Go to Configuration Variable.
Figure 868: Go to configuration variable
Removing a To remove a Configuration Parameter’s binding to a Configuration Variable,
binding right-click the Configuration Parameter and select Remove Binding. Note
that the binding does not delete the bound variable.
Figure 869: Remove a configuration parameter’s binding to a configuration variable
1416 EC-gfxProgram
Configuration Assistant
Creating live configuration variables
Live Configuration Variables link to a resource block’s configuration parame-
ters used by your EC-gfxProgram code. These values are updated in real
time to reflect the current values being used by the code. This can be used to
view and set object values and properties.
For example, as BACnet objects are exposed to the network, a Live Configu-
ration Variable bound to such an object will be updated with any value written
to the object through the network.
Once a Live Configuration Variable has been created, it becomes available to
be used on any Configuration Assistant Sheet.
The following methods can be used to create a Live Configuration Variable:
• Create a Live Configuration Variable directly from a resource block in the
Resources Configuration.
• Create the Live Configuration Variable in the Resources Configuration
and then associate it to a resource block.
Creating a live configuration variable directly from
a resource block
The easiest way to create a new Live Configuration Variable is to create it
directly from a resource block as follows.
1. Right-click one or more resource blocks and select Create Live Configu-
ration Variable.
2. For each selected block, set the Live Configuration Variable’s name in
Name and select the group into which the Live Configuration Variable is
EC-gfxProgram 1417
to be located in Create in. If a new group is needed to organize variables
into logical or structural group, click Create new folder. Click OK.
Figure 870: Add variable destination
Creating a live configuration variable to later asso-
ciate it with a resource block
The following options are available when creating a Live Configuration Vari-
able in the Resources Configuration under Configuration Variables in the
Resource Tree.
Figure 871: Resource tree configuration variables option
Parameter Description
Add Adds a Configuration Variable. This is used to set the
configuration value of one or more resource
parameters in the Resources Configuration only. For
example, to set the signal interpretation type for a
hardware input. See Creating a configuration variable
to later associate it with a configuration parameter.
Add Live Adds a Live Configuration Variable. This is used to set
the live value of an object property in the controller.
Add Group It is best to first create and organize variables into
logical or structural groups as appropriate.
Rename This renames the selected configuration variable.
1418 EC-gfxProgram
Configuration Assistant
Parameter Description
Delete This deletes the selected configuration variable.
Create the Live Configuration Variable and then associate it with a block
instance in the Resources Configuration as follows.
1. In the Resource Tree (see Accessing the Resources Configuration win-
dow) right-click Configuration Variables and select Add Group. Name
the group according to its logical or structural application. Add as many
groups as necessary.
2. In the Resource Tree (see Accessing the Resources Configuration Win-
dow) right-click Configuration Variables or a group you have created
and select Add Live.
3. Select the object’s type from the Object type drop down.
4. Select the object’s instance from the Object instance drop down.
5. Select the property identifier from the Property identifier drop down.
Type updates with the current object’s variable type and the configuration
parameter adjust accordingly.
6. Configure the Live Configuration Variable. See Configuring a live configu-
ration variable.
Configuring a live configuration variable
Live A Live Configuration Variable can use any one of the following data types that
configuration is automatically selected according to match the data type used by the linked
variable data block instance.
types
Live
Configuration Description See
Variable type
String Holds a sequence of Configuring a live string
characters, text or both. variable
Boolean Holds one of two values such Configuring a live
as True or False, 1 or 0. boolean variable
Numeric Holds a number. Configuring a live
numeric variable
Enum Holds a named value or Configuring a live enum
element that is a member of a variable
list of elements.
EC-gfxProgram 1419
Common live All live variables have the same General configuration parameters.
configuration
variable Figure 872: Live common variable configuration parameters
parameters
Parameter Description
Name The variable’s name.
Display Name The name for this variable to use in the configuration
Assistant.
Description Provide explanatory information about the variable.
Full Name This is how this variable will be identified wherever it is
used within the Resources Configuration.
Type The currently selected resource’s variable type.
1420 EC-gfxProgram
Configuration Assistant
Configuring a This Live Configuration Variable type holds a sequence of characters, text or
live string both.
variable
Figure 873: Live string variable configuration parameters
Parameter Description
Type String variable type.
Object type Select the object’s type.
Object instance Select the object’s instance. The block resource must
have previously been configured.
Property Select the property identifier.
identifier
Read only This live variable can only be read (cannot be modified
through the Configuration Assistant).
Use max length Enable string length limiting.
Max length When Use max length is enabled, this sets the
maximum total number of characters the string is able
to accept.
Value The current value assigned to this variable.
EC-gfxProgram 1421
Configuring a This Live Configuration Variable type holds one of two values such as True or
live boolean False, 1 or 0.
variable
Figure 874: Live boolean variable configuration parameter
Parameter Description
Type Boolean variable type.
Object type Select the object’s type.
Object instance Select the object’s instance. The block resource must
have previously been configured.
Property Select the property identifier.
identifier
Read only This live variable can only be read (cannot be modified
through the Configuration Assistant).
Write priority Set the BACnet priority to use to write to the BACnet
object. This parameter is only applicable to the
“Present value” property identifier. See Commandable
object priority array levels.
Value The current value assigned to this variable. When
ticked, the value is true or 1. When cleared, the value
is false or 0.
1422 EC-gfxProgram
Configuration Assistant
Configuring a This Live Configuration Variable type holds a number.
live numeric
variable Figure 875: Live numeric variable configuration parameters
Parameter Description
Type Numeric variable type.
Object type Select the object’s type.
Object instance Select the object’s instance. The block resource must
have previously been configured.
Property Select the property identifier.
identifier
Read only This live variable can only be read (cannot be modified
through the Configuration Assistant).
Write priority Set the BACnet priority to use to write to the BACnet
object. This parameter is only applicable to the
“Present value” property identifier. See Commandable
Object Priority Array Levels.
Use range Used to constrain the usable range of permitted
numeric values. Your EC-gfxProgram code must be
able to make use of any value allowed by this setting.
EC-gfxProgram 1423
Parameter Description
Minimum When Use range is enable, this sets the lower and
upper numeric value range limits that this variable is
Maximum
able to accept.
Use precision This limits the number of digits to be shown after the
decimal place to better show the available significant
Number of
digits.
decimals
Use units Sets whether this Live Configuration Variable is scalar
or dimensionless (has no units). When Use units is
US unit
enabled, the Configuration Assistant allows the user to
Metric unit choose the measurement system to be used in the
interface.
Figure 876: Selecting the Units in the Configuration Assistant
In US unit, set the unit to use with this variable when
the user has set the Measurement System in the
Configuration Assistant to US units.
In Metric unit, set the unit to use with this variable
when the user has set the Measurement System in
the Configuration Assistant to Metric units.
Value The current value assigned to this variable.
1424 EC-gfxProgram
Configuration Assistant
Configuring a This Live Configuration Variable type holds a named value or element that is a
live enum member of a list of elements.
variable
Figure 877: Live enum variable configuration parameters
Parameter Description
Type Enum variable type.
Object type Select the object’s type.
Object instance Select the object’s instance. The block resource must
have previously been configured.
Property Select the property identifier.
identifier
Read only This live variable can only be read (cannot be modified
through the Configuration Assistant).
EC-gfxProgram 1425
Parameter Description
Write priority Set the BACnet priority to use to write to the BACnet
object. This parameter is only applicable to the
"Present value" property identifier. See Commandable
object priority array levels.
Enumeration Shows the current list of enumeration members and the
Members corresponding numeric value assigned to that member.
According to the controller type, enumerations have
range limitations. See Creating and using
enumerations (8-Bit) or Creating and using
enumerations (ECL Series).
Click to add a new enumeration member.
Click to delete the enumeration member.
Allow custom When Allow custom values is checked, it allows you to
values type the value, or the first several letters of a value,
rather than perusing through a long drop-down list.
Once you have typed the first couple of letters, click the
drop-down arrow, and if the value exists, it will appear
completed.
Use range Used to constrain the usable range of permitted
numeric values. Your EC-gfxProgram code must be
able to make use of any value allowed by this setting.
Minimum When Use range is enabled, this sets the lower and
upper numeric value range limits that this variable is
Maximum
able to accept.
Value The current value assigned to this variable.
1426 EC-gfxProgram
Configuration Assistant
Creating a configuration assistant sheet
Overview Create the Configuration Assistant layout by organizing the configuration vari-
ables into menus and tabs and set the order in which they are to be shown.
Proceed as follows:
1. Add a Configuration Assistant Sheet to your Project. See below.
2. Add menus, tabs, and groups to the Configuration Assistant Sheet to cre-
ate a logical structure and Variables to the groups. See Creating the con-
figuration assistant sheet layout.
3. Optional: Set a password to protect the Configuration Assistant Sheet
from unauthorized access. See Setting the Configuration Assistant’s
properties.
4. Open at Startup: a sheet’s properties can be set to open at startup. In the
View menu, select Properties. Set the OpenAtStartup parameter to True.
5. Save the project. In the File menu, select Save. See File menu.
6. Reconnect to the controller to see and test the Configuration Assistant. In
the File menu, select Connect to server. See File menu.
Adding a In the Home ribbon, click Add under Project and select Configuration
configuration Assistant Sheet. See Home ribbon.
assistant sheet
to your project Figure 878: Adding a configuration assistant sheet
EC-gfxProgram 1427
Configuration assistant ribbon
When a Configuration Assistant Sheet is selected, the Configuration Assistant
Ribbon becomes available.
Figure 879: The EC-gfxProgram user interface (UI)
Parameter Description
Export Assistant Saves the current Configuration Assistant Sheet to a
file on your PC, including:
• The layout of the Configuration Assistant Sheet.
• The definition of all configuration schemes of this
sheet.
• The definition of all variables referred by the Con-
figuration Assistant Sheet.
• The bindings related to all variables referred by the
Configuration Assistant Sheet.
Import Assistant Imports a previously saved Configuration Assistant
Sheet from a file on your PC.
Protect Block access to the sheet with a password to prevent
other users from accidentally or deliberately changing
Configuration Assistant content.
Unprotect Remove protection from the current Configuration
Assistant Sheet.
Preview Alternate between the edit mode where you can
change the Configuration Assistant Sheet and the
preview mode where you can see how the sheet will
look like with live data as seen during run time.
Reorder Reorder the Configuration Assistant Sheet content, to
move a tab to another menu for example.
Save Saves the current Configuration Assistant Sheet
parameters into the device’s database or in the case of
an ECY Series controller, it saves the parameters into
the controller itself.
1428 EC-gfxProgram
Configuration Assistant
Parameter Description
Measurement Select the Configuration Assistant Sheet’s default
System measurement system to use for this sheet.
EC-gfxProgram 1429
Creating the configuration assistant sheet layout
Typical Once a Configuration Assistant Sheet has been added to the project, start
configuration adding menus, tabs, and groups to it.
assistant sheet
layout Figure 880: Typical Configuration Assistant Sheet layout
Configuration assistant configuration parameters
and tabs
The Configuration Assistant configuration variables are shown in any order
you choose. Logical or functional groups of parameters can optionally be
organized into tabs for increased usability and less scrolling when the list of
variables is long.
Item Description
1 Menus: Contains one or more Tabs. See Adding a menu to the
Configuration Assistant.
2 Tabs: Contains one or more Groups. See Adding a tab to the
Configuration Assistant.
3 Groups: Contains one or more Variables. See Adding a group to
the Configuration Assistant.
1430 EC-gfxProgram
Configuration Assistant
Item Description
4 Variables: The Configuration Assistant Variables. See Adding a
variable to the Configuration Assistant.
5 Insert your company’s logo. See Adding a logo to the Configuration
Assistant
Adding a menu Add a menu to the Configuration Assistant as follows.
to the
Configuration
Assistant
Parameter Description
Add Menu Item Add a new menu item below the currently selected
menu item.
Insert Menu Item Add a new menu item above the currently selected
menu item.
Rename This allows you to rename the currently selected menu
item.
Remove This deletes the selected menu item. All tabs, groups,
and references to variables contained in the menu will
also be removed. Before the deletion takes place, you
will be prompted for confirmation.
Adding a tab to Add a tab to a menu as follows.
the
Configuration
Assistant
Parameter Description
Add Tab Add a new tab nextto the currently selected tab.
Insert Tab Add a new tab before the currently selected tab.
Rename This allows you to rename the currently selected tab.
EC-gfxProgram 1431
Parameter Description
Remove This deletes the selected tab. All groups and
references to variables contained in the tab will also be
removed. Before the deletion takes place, you will be
prompted for confirmation.
Adding a group Add a group to a tab as follows.
to the
Configuration
Assistant
Parameter Description
Add Group Add a new group below the currently selected group.
Insert Group Add a new group above the currently selected group.
Rename Group This allows you to rename the currently selected group.
Remove Group This deletes the selected group. All references to
variables contained in the group will also be removed.
Before the deletion takes place, you will be prompted
for confirmation.
Adding a Add a variable element to a group as follows.
variable to the
Configuration 1. In a group, click .
Assistant
2. In the Variable Selector, select one or more variables that was previously
created in the Resources Configuration that you want to add to the group.
There are the following ways to add variables to the group.
• Click a variable and click Add.
• Search for a variable by typing its name into the filter (Type filter
here) and click Add.
• To select two or more variable instances, first click a variable
instance, then hold down the Ctrl or Shift key and click another vari-
1432 EC-gfxProgram
Configuration Assistant
able instance to individually add it to the selection or to select a range
of variable instances. Then click Add.
• Repeat any of the above methods to continue adding variables.
3. When you have added all the variables needed for the group, click OK.
Removing a Remove a variable element from a group by clicking to the right of the
variable from the variable.
Configuration
Assistant
EC-gfxProgram 1433
Setting a variable’s presentation
Overview A variable’s presentation attributes can be customized according to your
needs. The attribute can be fixed (never changing) or it can be programmed
with Javascript to react to current variable values to change the variable’s
color, hide the variable, and so on.
Available Variable attributes are set in the Properties pane. The following attributes can
variable be set for each variable shown in the Configuration Assistant.
attributes
Figure 881: Variable attributes
Parameter Description
BackColor Sets the variable’s background color.
EditionBack Sets the background color of the editable portion.
Color
EditionFore Sets the text box’s font color of the editable portion.
Color
ForeColor Sets the variable’s font color.
VariableName The variable’s programmatic name provided for
information purposes only. This is useful when you
need to reference this variable in Javascript code. It
can be copied and pasted in a JavaScript expression.
OnChange When a user enters a new value, this triggers a
Javascript expression that can be used to write a value
to another configuration variable or it can write values
to many other configuration variables. See Editing an
Events Parameter.
Enabled These parameters work together. See Enabled and
ReadOnly Parameter Options.
ReadOnly
1434 EC-gfxProgram
Configuration Assistant
Parameter Description
F(X) Changes to the Javascript editor. See Writing a
Javascript Expression.
Enables and The Enabled and ReadOnly parameter options work together as follows.
ReadOnly
parameter Description
options
When Enabled Regardless of ReadOnly value the edition is not
is False: possible and its not possible to copy the text.
When Enabled the edition is not possible but its possible to copy the
is True and text.
ReadOnly is
True:
Otherwise: the edition is possible and it is possible to copy the text.
Editing an The Appearance parameters control the color presentation of a variable. Set
appearance the color as follows.
parameter
1. Click into the Appearance parameter. A drop-down arrow appears.
Figure 882: Opening the color pallet
EC-gfxProgram 1435
2. Click the drop-down arrow. A color pallet appears.
Figure 883: Select a color swatch from the color pallet
Tab Description
Custom A pallet of commonly-used colors. Right-click a color
swatch in the last two rows of the color pallet to set a
custom color.
Web A pallet of web-safe colors.
System A list of Microsoft Windows® display elements that
base their color value on the current operating system’s
color theme in effect. As a result, the actual colors
shown by the Configuration Assistant may change from
PC to PC where it is installed or even between different
user accounts on the same PC according.
3. Select a color or right-click a color swatch in the last two rows of the color
pallet to set a custom color.
1436 EC-gfxProgram
Configuration Assistant
4. Select a color swatch or, optionally, in the Custom tab, right-click a color
swatch in the last two rows of the color pallet to set a custom color and
click Add Color.
Figure 884: Setting a custom color swatch
Editing a events When the value of the variable changes, the Events parameters are used to
parameter trigger a Javascript expression that can be used to write a value to another
configuration variable or it can write values to many other configuration vari-
ables.
Writing a Javascript expression
Overview The variable’s presentation can be dynamically-controlled by writing a Javas-
cript expression. This can be used to change Configuration Variable’s color
when its value has gone out of limit for example. Javascript can use one or
more Configuration Variable values to change the current variable’s presenta-
tion parameters.
Supported The JavaScript parsing engine is based on ECMA 262 (JavaScript Edition
Javascript 5.1). See the ECMA 262 official language specifications: http://www.ecma-
version international.org/ecma-262/5.1/
EC-gfxProgram 1437
Opening the You create the Javascript expression in the Expressions editor. Open the
expressions Expressions editor as follows.
editor
1. Click F(X).
2. Click =. The Expressions editor opens.
Expression Use the expression editor to create Javascript code that dynamically-controls
editor overview a configuration variable’s presentation. Any one of the Configuration Vari-
able’s Appearance or Layout presentation parameters can be controlled by a
Javascript expression. This Javascript expression can evaluate the value of
one or more Configuration Variables at runtime to change the current vari-
able’s presentation parameter.
Figure 885: Expression editor
1438 EC-gfxProgram
Configuration Assistant
The expression editor has syntax highlighting and variable completion sug-
gestions.
Figure 886: Expression editor variable completion suggestions
To see suggestions to complete a variable, proceed as follows.
1. Type an expression and when you arrive at a valid point to insert a vari-
able, press the down key (↓) to open your project’s current variable tree
structure.
2. Click the tree structure to open branches and select a variable.
Javascript The following commonly-used Javascript expressions are explained below.
expression
examples Javascript
Expression Description
Examples
(Variables.Setpo When the Configuration Variable named Setpoint
int == 0) ? “Blue” (shown in VariableName) is equal to zero, make the
: “Red” presentation parameter display in blue otherwise make
it display in red.
(Variables.Retur When the Configuration Variable named ReturnTemp is
nTemp == -327) equal to -327, make the presentation parameter display
? "ORANGE" : in orange otherwise make it display in white. For this
"WHITE" input, a reading of -327 indicates that the sensor is
disconnected.
EC-gfxProgram 1439
Javascript
Expression Description
Examples
if When the universal hardware input number 2’s
(Variables.Hard configuration value is equal to 2, set the presentation
ware parameter to true, otherwise;
Configuration.In
When the sensor hardware input number 3’s
putsConf.
configuration value is equal to 2, set the presentation
UI2Config == 2)
parameter to true, otherwise;
{ true; } else
if(Variables.Hard Set the presentation parameter to false.
ware
Configuration.In
putsConf.
SI3Config == 2)
{ true; } else {
false; }
NOTE: JavaScript expression are case sensitive. Therefore, true and false
values must be provided in lower case.
1440 EC-gfxProgram
Configuration Assistant
Adding a logo to the Configuration Assistant
Add your company logo to the Configuration Assistant as follows.
1. Right-click the Logo icon and select Add Image.
Parameter Description
Add Image Add a bitmap image to the Configuration Assistant.
Remove Image This removes the logo from the Configuration
Assistant.
2. Select a bitmap image on your PC’s file system. Click Open.
NOTE: Large image files will increase the size of the project, which may com-
promise usability. Therefore, it is recommended to use smaller image
files.
EC-gfxProgram 1441
Setting the Configuration Assistant’s properties
You can set in the Configuration Assistant’s properties the following parame-
ters:
• Enable or Disable the Configuration Assistant when opening EC-gfxPro-
gram. By default, when a Configuration Assistant has been added to the
project, the Configuration Assistant will be first shown when you open the
controller’s code with EC-gfxProgram.
• Password-Protect access to EC-gfxProgram.
These behaviors can be changed by setting the Configuration Assistant prop-
erties as follows.
1. In the Project Explorer, right-click the Configuration Assistant and select
Properties.
2. Set the configuration assistant sheet properties.
Parameter Description
(Name) Sets the name of the Configuration Assistant Sheet.
1442 EC-gfxProgram
Configuration Assistant
Parameter Description
OpenAtStartup True: the Configuration Assistant is eligible to be first
shown when you open the controller’s code with EC-
gfxProgram
Password True: A password is needed to access the current
Protected Configuration Assistant Sheet when it opens at startup.
False: No password is needed to access the current
Configuration Assistant Sheet when it opens at startup.
Validating the Configuration Assistant sheets
The Validate function allows you to validate the Configuration Assistant
Sheets.
The Validate function works with an error list at the bottom of the layer which
appears after clicking Validate.
The Validate function shows:
• Unknown variables
• Script errors
Reorder
The Reorder function allows you to reorder the layout of the Configuration
Assistant.
EC-gfxProgram 1443
Items can be dragged and dropped within the layout tree, including entire sec-
tions.
After reordering items, they will be displayed within the Configuration Assis-
tant Sheet according to the order selected.
Configuration Assistant scheme management
Variables can be bundled into specific schemes using the Manage Configura-
tion Schemes function.
1444 EC-gfxProgram
Configuration Assistant
Schemes make it easier to update a group of variables simultaneously. Check
the boxes of the variables you wish to include in the scheme. Black boxes
indicate that at least one variable has been selected within a lower level of the
tree. Schemes can also be reordered using drag and drop.
From the icon menu above the first column, you can add a new scheme,
delete a current scheme, or rename a current scheme.
EC-gfxProgram 1445
Created schemes appear in the configuration assis-
tant synchronization
Created schemes will appear in the Configuration Assistant Synchronization
window, under Synchronization Options.
• When more than one configuration scheme is selected, only parameters
applicable to those schemes are synchronized.
• When no specific configuration schemes have been created, the Syn-
chronization Options will present an “Entire Configuration” selection.
1446 EC-gfxProgram
Configuration Assistant
Download to multiple devices
Download to multiple devices allows you to synchronize the selected options
to a list of selected devices. This option is only applicable when connecting
through an EC-BOS.
Initiating Configuration Assistant synchronization
After initiating the Configuration Assistant Synchronization by clicking Next,
you can track the progress and view the results using the selections in the left
column of the Configuration Assistant Synchronization window.
EC-gfxProgram 1447
1448 EC-gfxProgram
EC-gfxProgram vs Line-by-Line
CHAPTER 15
EC-gfxProgram vs Line-by-Line
This chapter provides a practical comparison between coding in EC-gfxPro-
gram and coding in traditional line-by-line code. A roof top unit will be used as
an example and will be coded in both methods.
Topics
Example description
Wiring diagram
Line-by-line code
EC-gfxProgram code
EC-gfxProgram 1449
Example description
The example that will be coded concerns a roof top unit. Below is a general
description of all parameters that need to be coded. This includes the equip-
ment involved and the sequence of operation when the system is unoccupied
and occupied.
System • 1 Roof Top Unit.
Equipment • 2 Cooling Stages.
• 2 Heating Stages.
• 1 Fan (on/off).
• 1 Fresh air damper.
• 1 Space temperature sensor with adjustable set point and override button.
• 1 Supply air temperature sensor.
System • The fan is off.
Unoccupied • The 2 heating stages are off.
• The 2 cooling stages are off.
• The fresh air damper is closed.
System • The fan starts according to one of the following conditions:
Occupied • The schedule is occupied.
• The space low limit (16°C - adjustable) is reached.
• The space high limit (28°C - adjustable) is reached.
• The space temperature sensor override button is activated.
• The space temperature set point can be manually adjusted on the sensor.
• The fresh air damper, the cooling stages and the heating stages are con-
trolled in sequence using a P-I loop.
• If the outdoor temperature is lower than the winter set point (5°C - adjust-
able), only the fresh air dampers can be used for cooling.
• If the outdoor temperature is lower than the winter set point (5°C), the
dampers are controlled with a supply low limit set point (8°C - adjustable).
• If the outdoor temperature is higher than the winter set point (5°C - adjust-
able) and lower than the summer set point (13°C - adjustable), the damp-
ers and the first stage of cooling will be controlled in sequence for cooling.
• If the outdoor temperature is higher than the summer set point (13°C), the
2 cooling stages can be activated when needed and the dampers will be
set at their minimum positions (10% - adjustable).
• The first stage of heating can be used only if the outdoor temperature is
lower than a set point (15°C - adjustable).
• The second stage of heating can be used only if the outdoor temperature
is lower than another set point (13°C - adjustable).
1450 EC-gfxProgram
EC-gfxProgram vs Line-by-Line
Wiring diagram
WARNING: Always follow the wiring instructions provided in the installation
guide supplied with the controller.
EC-gfxProgram 1451
Line-by-line code
The following is the line-by-line code for the programming of the roof top unit
sequence of operation as outlined in the Example Description. The constants,
variables, inputs, outputs, and PID settings used are also listed after the code.
Code Defining the Room Final Setpoint
ROOM_FINAL_SP = ROOM_SP + SET
Schedule Status
REM 0 = Occupied
REM 1 = Unoccupied
REM 2 = By-pass
REM 3 = Standby
IF ( SCHEDULE1 = 0 )
SCHEDULE_ST = ON
ELSE
SCHEDULE_ST = OFF
ENDIF
NOTE: SCHEDULE1 is a reserved word.
Defining Room Low Limit and High Limit
• The low limit is activated if the room temperature is less than START_LL.
• The low limit is deactivated if the room temperature is greater than
STOP_LL.
• The high limit is activated if the room temperature is greater than
START_HL.
• The high limit is deactivated if the room temperature is less than
STOP_HL.
STOP_LL = START_LL + LL_DIFF
LL_UNOCC = SWITCH ( ROOM_TP START_LL STOP_LL )
STOP_HL = START_HL - HL_DIFF
HL_UNOCC = SWITCH ( ROOM_TP START_HL STOP_HL )
Start and Stop of the Fan Control
The fan is running if:
1452 EC-gfxProgram
EC-gfxProgram vs Line-by-Line
• The schedule is On,
• The LL_UNOCC is On,
• The HL_UNOCC is On or
• The override button is activated.
FAN = HISEL ( SCHEDULE_ST LL_UNOCC HL_UNOCC OVERRIDE8 )
IF ( FAN = OFF )
CLEAR CO1
ENDIF
NOTE: OVERRIDE8 is a reserved word.
Defining the Heating and Cooling Variables
The variables are calculated with the PI loop No.1. The PI loop is in inverse
mode (for example, 0-50 = cooling; 50-100 = heating).
VAR_HEAT = 2 * CO1 - 100
VAR_HEAT = LIMIT ( VAR_HEAT 0 100 )
VAR_COOL = -2 * CO1 + 100
VAR_COOL = LIMIT ( VAR_COOL 0 100 )
Variable of Cooling Stages and Dampers Variables
Equation
• If the outdoor temperature is less than the constant WINTER, only the
dampers can operate with a low limit setpoint.
• If the outdoor temperature is greater than the constant WINTER and less
than the constant SUMMER, the dampers and the first cooling stage can
operate.
• If the outdoor temperature is greater than the constant SUMMER, the
dampers are in minimum position and the 2 cooling stages can operate.
IF ( OUT_TEMP < WINTER )
VAR_DAMPER = LIMIT ( VAR_COOL MIN_POS CO2 )
VAR_COOL_STG = 0
ELSE
IF ( OUT_TEMP < SUMMER )
VAR_DAMPER = 2 * VAR_COOL
VAR_DAMPER = LIMIT
( VAR_DAMPER MIN_POS 100 )
VAR_COOL_STG = VAR_COOL - 50
VAR_COOL_STG = LIMIT ( VAR_COOL_STG 0 50 )
ELSE
EC-gfxProgram 1453
VAR_DAMPER = MIN_POS
VAR_COOL_STG = VAR_COOL
ENDIF
ENDIF
Heating and Cooling Stages Control
The constants HEAT1_PERM and HEAT2_PERM give the possibility of oper-
ating the heating stages only if the outdoor temperature is less than a speci-
fied setpoint. The cooling stages are controlled with the variable
VAR_COOL_STG.
IF ( FAN = ON )
MOD_DAMPERS = VAR_DAMPER
COOL1 = SWITCH ( VAR_COOL_STG 50 0 )
COOL2 = SWITCH ( VAR_COOL_STG 100 50 )
IF ( OUT_TEMP < HEAT1_PERM )
HEAT1 = SWITCH ( VAR_HEAT 50 0 )
ELSE
HEAT1 = OFF
ENDIF
IF ( OUT_TEMP < HEAT2_PERM )
HEAT2 = SWITCH ( VAR_HEAT 100 50 )
ELSE
HEAT2 = OFF
ENDIF
ELSE
COOL1 = OFF
COOL2 = OFF
HEAT1 = OFF
HEAT2 = OFF
MOD_DAMPERS = 0
ENDIF
END
Variables
# Label Mode Value Units Description
01 SCHEDULE_ST Automatic 0 On/Off Schedule status
02 ROOM_FINAL_SP Automatic 0 °C x 10 Room final setpoint
1454 EC-gfxProgram
EC-gfxProgram vs Line-by-Line
# Label Mode Value Units Description
03 LL_UNOCC Automatic 0 On/Off Evaluated low limit unoccupied
status
04 HL_UNOCC Automatic 0 On/Off Evaluated high limit unoccupied
status
05 STOP_LL Automatic 0 °C x 10 Calculated room low limit
stopping temperature
06 STOP_HL Automatic 0 °C x 10 Calculated room high limit
stopping temperature
07 VAR_HEAT Automatic 0 % Heating demand
08 VAR_COOL Automatic 0 % Cooling demand
09 VAR_DAMPER Automatic 0 % Damper position
10 VAR_COOL_STG Automatic 0 % Cooling stage variable
Constants
# Label Value Units Description (...)
01 ROOM_SP 220 °C x 10 Room setpoint
02 START_LL 130 °C x 10 Adjustable room low limit starting
temperature
03 LL_DIFF 30 °C x 10 Adjustable low limit differential
04 START_HL 310 °C x 10 Adjustable room high limit starting
temperature
05 HL_DIFF 30 °C x 10 Adjustable high limit differential
06 SUMMER 130 °C x 10 Summer starting temperature
07 WINTER 50 °C x 10 Winter starting temperature
08 MIN_POS 10 % Minimum position of damper
09 HEAT1_PERM 150 °C x 10 Temperature permitting heating stage 1
10 HEAT2_PERM 130 °C x 10 Temperature permitting heating stage 2
11 LL_SUPPLY 80 °C x 10 Low limit setpoint for PI2
Inputs
# Label Mode Value Units Description Commissioned
01 SUPPLY_TP Automatic 0 °C x 10 Supply air No
temperature
EC-gfxProgram 1455
# Label Mode Value Units Description Commissioned
07 SET Automatic 0 °C x 10 Setpoint adjustment No
by user
08 ROOM_TP Automatic 0 °C x 10 Room temperature No
Output
# Label Mode Value Units Description Commissioned
01 FAN Automatic 0 On/Off Fan status No
02 COOL1 Automatic 0 On/Off Cooling stage 1 No
status
03 COOL2 Automatic 0 On/Off Cooling stage 2 No
status
04 MOD_DAMPERS Automatic 0 % Damper position No
05 HEAT1 Automatic 0 On/Off Heating stage 1 No
status
06 HEAT2 Automatic 0 On/Off Heating stage 2 No
status
PIs
# Mode Value Input Setpoint PB IG IT DB Bias Action Divider
01 Automatic 0 ROOM_TP ROOM_ 4.0 1.0 15 2.0 50 Reverse 10
FINAL_S
P
02 Automatic 0 SUPPLY_T LL_ 6.0 0.0 0 0.0 50 Direct 10
P SUPPLY
1456 EC-gfxProgram
EC-gfxProgram vs Line-by-Line
EC-gfxProgram code
The following is the EC-gfxProgram code for the programming of the roof top
unit sequence of operation as outlined in the Example description. Certain
EC-gfxProgram 1457
sequences were coded differently than in the line-by-line code due to
advancements in EC-gfxProgram.
Figure 887: Roof top unit
Figure 888: Operation status block
Figure 889: Season status block
1458 EC-gfxProgram
EC-gfxProgram vs Line-by-Line
Figure 890: Damper and cooling control block
Figure 891: Heating stage permission block
Figure 892: Heating control block
EC-gfxProgram 1459
1460 EC-gfxProgram
Air Physics Guide
CHAPTER 16
Air Physics Guide
This appendix provides a brief overview of Air Physics calculations and
explains the relation between air velocity, dynamic pressure, differential pres-
sure, Pitot factors, and various coefficients.
Topics
Air physics
EC-gfxProgram 1461
Air physics
The following is an equation to calculate air velocity:
(1)
Where C is a constant (4005 for US units, 1289.75 for metric units where air-
flow is in L/s and 4363.1 for metric units where airflow is in m3/hr), V is the air
velocity in ft/min (if C=4005) or m/hr (if C=1289.75) or m/s (if C=4363.1) and
pv is the dynamic pressure (or velocity pressure) in “ H2O (if C=4005) or Pa (if
C=1289.75 or C=4363.1).
The following is an equation to calculate airflow:
(2)
Where Q is the airflow in ft3/min (if C=4005) or L/s (if C=1289.75) or m3/hr (if
C=4363.1) and A is the duct area in ft2 (if C=4005) or m2 (if C=1289.75 or
C=4363.1).
The following is a combination of equations (1) and (2):
(3)
Normally, the dynamic pressure is measured with a Pitot tube connected to a
differential pressure sensor (or a manometer). The following is the relation-
ship between the differential and dynamic pressure:
or
(4)
Where pd is the differential pressure and PF is the Pitot factor.
1462 EC-gfxProgram
Air Physics Guide
The following is a combination of equations (3) and (4):
(5)
Some manufacturers give a flow coefficient (or K factor) instead of the Pitot
factor for their VAV boxes (with Pitot tubes included). In this case, the follow-
ing airflow equation can be used:
or
(6)
Where Kflow is the flow coefficient.
The following is a combination of equations (5) and (6):
or
(7)
Equation (7) is useful when an instrument that reads the airflow using equa-
tion (5) is connected to a VAV box whose specifications only provide a flow
coefficient.
Some other manufacturers give a velocity coefficient for their VAV boxes (with
Pitot tubes included). In this case, the following airflow equation can be used:
or
(8)
Where Kvelocity is the velocity coefficient.
EC-gfxProgram 1463
The following is a combination of equations (5) and (8):
or
(9)
Equation (9) is useful when an instrument that reads the airflow using equa-
tion (5) is connected to a VAV box whose specifications only provide a velocity
coefficient.
1464 EC-gfxProgram
Tuning a PID Loop
CHAPTER 17
Tuning a PID Loop
This chapter describes how to tune the PID loop in a systematic manner to
prevent the system from oscillating.
Topics
Tuning a PID loop
EC-gfxProgram 1465
Tuning a PID loop
1. Tune the proportional band
a. Set the integral and derivative times to 0 seconds.
i. If the Input is not oscillating regularly about the setpoint as
observed in Figure 893, divide the proportional band by 2. Repeat
this step if the Input is still not oscillating regularly about the set-
point after having stabilized. Once some oscillations are
observed, continue to step b.
Figure 893: Proportional - input not oscillating about setpoint
ii. If the Input is oscillating regularly about the setpoint as observed
in Figure 894, multiply the proportional band by 2. Repeat this
step if the Input is still oscillating regularly about the setpoint after
having stabilized. Once no oscillations are observed, continue to
step b.
Figure 894: Proportional - input oscillating about setpoint
1466 EC-gfxProgram
Tuning a PID Loop
b. Carefully increase or decrease the proportional band by small incre-
ments until some oscillations just appear about the setpoint as shown
in Figure 895.
Figure 895: Proportional - near perfect tuning
Increase the proportional band by 50%, for example, and multiply the
proportional band by 1.5. Initiate a cold start (stop then restart the
system) and make sure that the system has minimal overshoot, mini-
mal offset, and is not oscillating as shown in Figure 896.
Figure 896: Proportional - near perfect tuning with no oscillations
2. Tune the integral time
a. Set the integral time to a large value which results in a slow system
response.
i. If the Input is not oscillating regularly about the setpoint, as
observed in Figure 897, multiply the integral time by 2. Repeat
this step if the Input is still not oscillating regularly about the set-
point after having stabilized. Once some oscillations are
observed, continue to step b.
Figure 897: Input not oscillating about setpoint
EC-gfxProgram 1467
ii. f the Input is oscillating regularly about the setpoint, as observed
in Figure 898, divide the integral time by 2. Repeat this step if the
Input is still oscillating regularly about the setpoint after having
stabilized. Once no oscillations are observed, continue to step b.
Figure 898: Input oscillating about setpoint
b. Carefully increase or decrease the integral time by small increments
until some oscillations just appear about the setpoint, as shown in
Figure 899.
Figure 899: Integral - near perfect tuning
3. Tune the derivative time
NOTE: Since HVAC systems have a slow response time due to the nature of
the equipment, the derivative time is generally not used. It is thus rec-
ommended to set it to 0.
1468 EC-gfxProgram
Supported EnOcean Wireless Sensor Profiles
CHAPTER 18
Supported EnOcean Wireless Sensor
Profiles
This chapter describes the supported EnOcean Equipment Profiles (EEP).
Topics
Supported Wireless Receivers
Supported Wireless Sensor Profiles
EC-gfxProgram 1469
Supported Wireless Receivers
There are two generations of wireless receiver models that are supported: X1
and X2. Each generation is available in either of two radio frequencies as
shown in the table below.
Wireless Receiver Model 902 MHz 868 MHz
X1 model (phased out)
X2 model (supports RSSI)
1470 EC-gfxProgram
Supported EnOcean Wireless Sensor Profiles
Supported Wireless Sensor Profiles
The supported EnOcean Equipment Profiles (EEP) are shown in the table
below.
Device
Sensor Description EEP Controller Series
Category
ECL, ECB,
ECP
ECY
Series
Series
Temperature Temperature Sensor (-40°C to 0°C) 07-02-01
Temperature Sensor (-30°C to +10°C) 07-02-02
Temperature Sensor (-20°C to +20°C) 07-02-03
Temperature Sensor (-10°C to +30°C) 07-02-04
Temperature Sensor (0°C to +40°C) 07-02-05
Temperature Sensor (+10°C to +50°C) 07-02-06
Temperature Sensor (+20°C to +60°C) 07-02-07
Temperature Sensor (+30°C to +70°C) 07-02-08
Temperature Sensor (+40°C to +80°C) 07-02-09
Temperature Sensor (+50°C to +90°C) 07-02-0A
Temperature Sensor (+60°C to +100°C) 07-02-0B
Temperature Sensor (-60°C to +20°C) 07-02-10
Temperature Sensor (-50°C to +30°C) 07-02-11
Temperature Sensor (-40°C to +40°C) 07-02-12
Temperature Sensor (-30°C to +50°C) 07-02-13
Temperature Sensor (-20°C to +60°C) 07-02-14
Temperature Sensor (-10°C to +70°C) 07-02-15
Temperature Sensor (0°C to +80°C) 07-02-16
Temperature Sensor (+10°C to +90°C) 07-02-17
Temperature Sensor (+20°C to +100°C) 07-02-18
Temperature Sensor (+30°C to +110°C) 07-02-19
EC-gfxProgram 1471
Device
Sensor Description EEP Controller Series
Category
ECL, ECB,
ECP
ECY
Series
Series
Temperature Sensor (+40°C to +120°C) 07-02-1A
Temperature Sensor (+50°C to +130°C) 07-02-1B
Temperature Sensor (-40°C to 0°C) A5-02-01
Temperature Sensor (-30°C to +10°C) A5-02-02
Temperature Sensor (-20°C to +20°C) A5-02-03
Temperature Sensor (-10°C to +30°C) A5-02-04
Temperature Sensor (0°C to +40°C) A5-02-05
Temperature Sensor (+10°C to +50°C) A5-02-06
Temperature Sensor (+20°C to +60°C) A5-02-07
Temperature Sensor (+30°C to +70°C) A5-02-08
Temperature Sensor (+40°C to +80°C) A5-02-09
Temperature Sensor (+50°C to +90°C) A5-02-0A
Temperature Sensor (+60°C to +100°C) A5-02-0B
Temperature Sensor (-60°C to +20°C) A5-02-10
Temperature Sensor (-50°C to +30°C) A5-02-11
Temperature Sensor (-40°C to +40°C) A5-02-12
Temperature Sensor (-30°C to +50°C) A5-02-13
Temperature Sensor (-20°C to +60°C) A5-02-14
Temperature Sensor (-10°C to +70°C) A5-02-15
Temperature Sensor (0°C to +80°C) A5-02-16
Temperature Sensor (+10°C to +90°C) A5-02-17
Temperature Sensor (+20°C to +100°C) A5-02-18
Temperature Sensor (+30°C to +110°C) A5-02-19
Temperature Sensor (+40°C to +120°C) A5-02-1A
Temperature Sensor (+50°C to +130°C) A5-02-1B
1472 EC-gfxProgram
Supported EnOcean Wireless Sensor Profiles
Device
Sensor Description EEP Controller Series
Category
ECL, ECB,
ECP
ECY
Series
Series
Temperature
Temperature & Humidity Sensor (0°C to
& Humidity 07-04-01
+40°C, 0% to 100%)
Sensor
Temperature & Humidity Sensor (0°C to
A5-04-01
+40°C, 0% to 100%)
Rocker Light & Blind Control 2 Rocker Switch
05-02-01
Switch EU Application Style
Light & Blind Control 2 Rocker Switch
05-02-02
US/CAN Application Style
Light & Blind Control 4 Rocker Switch 05-03-01
Light & Blind Control 2 Rocker Switch
F6-02-01
EU Application Style
Light & Blind Control 2 Rocker Switch
F6-02-02
US/CAN Application Style
Light & Blind Control 4 Rocker Switch F6-03-01
Room
Temperature Sensor; SetPoint, Fan-
Operating 07-10-01
Speed & Occupancy Control
Panel
Temperature Sensor; SetPoint, Fan-
07-10-02
Speed & DayNight Control
Temperature Sensor; SetPoint Control 07-10-03
Temperature Sensor; SetPoint & Occu-
07-10-05
pancy Control
Temperature Sensor; SetPoint & Day-
07-10-06
Night Control
Temperature & Humidity Sensor; Set-
07-10-10
Point & Occupancy Control
Temperature & Humidity Sensor; Set-
07-10-11
Point & DayNight Control
Temperature & Humidity Sensor; Set-
07-10-12
Point Control
Temperature & Occupancy Control 07-10-0C
Temperature Sensor; SetPoint, Fan-
A5-10-01
Speed & Occupancy Control
EC-gfxProgram 1473
Device
Sensor Description EEP Controller Series
Category
ECL, ECB,
ECP
ECY
Series
Series
Temperature Sensor; SetPoint, Fan-
A5-10-02
Speed & DayNight Control
Temperature Sensor; SetPoint Control A5-10-03
Temperature Sensor; SetPoint & Occu-
A5-10-05
pancy Control
Temperature Sensor; SetPoint & Day-
A5-10-06
Night Control
Temperature & Humidity Sensor; Set-
A5-10-10
Point & Occupancy Control
Temperature & Humidity Sensor; Set-
A5-10-11
Point & DayNight Control
Temperature & Humidity Sensor; Set-
A5-10-12
Point Control
Temperature & Occupancy Control A5-10-0C
Light Sensor Light Sensor 300 lx to 60.000 lx 07-06-01
Light Sensor 300 lx to 60.000 lx A5-06-01
Light Sensor 0 lx to 1.020 lx A5-06-02
Digital Input Digital Input; Single Input Contact, Bat-
tery Monitor (1: battery OK, 2: battery 07-30-01
low)
Digital Input; Single Input Contact 07-30-02
Digital Input; Single Input Contact, Bat-
tery Monitor (1: battery OK, 2: battery A5-30-01
low)
Digital Input; Single Input Contact A5-30-02
Contact & Contacts & Switches; Single Input Con-
06-00-01
Switch tact
Contacts & Switches; Single Input Con-
D5-00-01
tact
Occupancy
Occupancy Sensor 07-07-01
Sensor
Occupancy Sensor A5-07-01
1474 EC-gfxProgram
Supported EnOcean Wireless Sensor Profiles
Device
Sensor Description EEP Controller Series
Category
ECL, ECB,
ECP
ECY
Series
Series
Light,
Temperature Light, Temperature & Occupancy Sen-
07-08-01
& Occupancy sor 0 to 510 lx, 0 to 51°C
Sensor
Light, Temperature & Occupancy Sen-
A5-08-01
sor 0 to 510 lx, 0 to 51°C
Gas Sensor Humidity; CO2 & Temperature Sensor
(0% to 100%, 0ppm to 2550ppm, 0°C to 07-09-04
+51°C)
Humidity; CO2 & Temperature Sensor
(0% to 100%, 0ppm to 2550ppm, 0°C to A5-09-04
+51°C)
Universal Analog Input Module (3 analog 0...10V
07-3F-7F *
DC inputs)
Analog Input Module (3 analog 0...10V
A5-3F-7F *
DC inputs)
* Supported for ECL and ECB series only
EC-gfxProgram 1475
1476 EC-gfxProgram
Thermistor Resistance Tables
CHAPTER 19
Thermistor Resistance Tables
This chapter has tables of the resistance values for the standard supported
thermistors.
Topics
10kilohm Type II Thermistor
10kilohm Type III Thermistor
Platinum RTD Sensor: Pt1000 (1kilohm)
Nickel RTD Sensor: Ni1000 (1kilohm) @ 0ºC
Nickel RTD Sensor: Ni1000 (1kilohm) @ 21ºC
EC-gfxProgram 1477
10kilohm Type II Thermistor
Values shown in are within the supported range of controller operation for the
Type II sensor input.
°C °F Resistance
-40.0 -40.0 336095
-39.0 -38.2 314553
-38.0 -36.4 294525
-37.0 -34.6 275896
-36.0 -32.8 258562
-35.0 -31.0 242426
-34.0 -29.2 227400
-33.0 -27.4 213391
-32.0 -25.6 200338
-31.0 -23.8 188162
-30.0 -22.0 176801
-29.0 -20.2 166199
-28.0 -18.4 156295
-27.0 -16.6 147041
-26.0 -14.8 138393
-25.0 -13.0 130307
-24.0 -11.2 122742
-23.0 -9.4 115663
-22.0 -7.6 109032
-21.0 -5.8 102824
-20.0 -4.0 97007
-19.0 -2.2 91552
-18.0 -0.4 86438
-17.0 1.4 81640
-16.0 3.2 77138
-15.0 5.0 72910
-14.0 6.8 68940
1478 EC-gfxProgram
Thermistor Resistance Tables
°C °F Resistance
-13.0 8.6 65209
-12.0 10.4 61703
-11.0 12.2 58406
-10.0 14.0 55303
-9.0 15.8 52385
-8.0 17.6 49638
-7.0 19.4 47050
-6.0 21.2 44613
-5.0 23.0 42316
-4.0 24.8 40152
-3.0 26.6 38110
-2.0 28.4 36184
-1.0 30.2 34366
0.0 32.0 32651
1.0 33.8 31031
2.0 35.6 29501
3.0 37.4 28054
4.0 39.2 26688
5.0 41.0 25395
6.0 42.8 24172
7.0 44.6 23016
8.0 46.4 21921
9.0 48.2 20885
10.0 50.0 19903
11.0 51.8 18973
12.0 53.6 18092
13.0 55.4 17257
14.0 57.2 16465
15.0 59.0 15714
16.0 60.8 15001
17.0 62.6 14324
EC-gfxProgram 1479
°C °F Resistance
18.0 64.4 13683
19.0 66.2 13073
20.0 68.0 12493
21.0 69.8 11943
22.0 71.6 11420
23.0 73.4 10923
24.0 75.2 10450
25.0 77.0 10000
26.0 78.8 9572
27.0 80.6 9165
28.0 82.4 8777
29.0 84.2 8408
30.0 86.0 8056
31.0 87.8 7721
32.0 89.6 7402
33.0 91.4 7097
34.0 93.2 6807
35.0 95.0 6530
36.0 96.8 6266
37.0 98.6 6014
38.0 100.4 5774
39.0 102.2 5544
40.0 104.0 5325
41.0 105.8 5116
42.0 107.6 4916
43.0 109.4 4725
44.0 111.2 4542
45.0 113.0 4367
46.0 114.8 4200
47.0 116.6 4040
48.0 118.4 3887
1480 EC-gfxProgram
Thermistor Resistance Tables
°C °F Resistance
49.0 120.2 3741
50.0 122.0 3601
51.0 123.8 3467
52.0 125.6 3339
53.0 127.4 3216
54.0 129.2 3098
55.0 131.0 2985
56.0 132.8 2877
57.0 134.6 2773
58.0 136.4 2674
59.0 138.2 2579
60.0 140.0 2487
61.0 141.8 2399
62.0 143.6 2315
63.0 145.4 2234
64.0 147.2 2157
65.0 149.0 2082
66.0 150.8 2011
67.0 152.6 1942
68.0 154.4 1876
69.0 156.2 1813
70.0 158.0 1752
71.0 159.8 1693
72.0 161.6 1637
73.0 163.4 1582
74.0 165.2 1530
75.0 167.0 1480
76.0 168.8 1432
77.0 170.6 1385
78.0 172.4 1341
79.0 174.2 1298
EC-gfxProgram 1481
°C °F Resistance
80.0 176.0 1256
81.0 177.8 1216
82.0 179.6 1178
83.0 181.4 1141
84.0 183.2 1105
85.0 185.0 1070
86.0 186.8 1037
87.0 188.6 1005
88.0 190.4 974
89.0 192.2 945
90.0 194.0 916
91.0 195.8 888
92.0 197.6 862
93.0 199.4 836
94.0 201.2 811
95.0 203.0 787
96.0 204.8 764
97.0 206.6 741
98.0 208.4 720
99.0 210.2 699
100.0 212.0 678
101.0 213.8 659
102.0 215.6 640
103.0 217.4 622
104.0 219.2 604
105.0 221.0 587
106.0 222.8 571
107.0 224.6 555
108.0 226.4 539
109.0 228.2 524
110.0 230.0 510
1482 EC-gfxProgram
Thermistor Resistance Tables
°C °F Resistance
111.0 231.8 496
112.0 233.6 482
113.0 235.4 469
114.0 237.2 457
115.0 239.0 444
116.0 240.8 432
117.0 242.6 421
118.0 244.4 410
119.0 246.2 399
120.0 248.0 388
121.0 249.8 378
122.0 251.6 368
123.0 253.4 359
124.0 255.2 350
125.0 257.0 341
126.0 258.8 332
127.0 260.6 323
128.0 262.4 315
129.0 264.2 307
130.0 266.0 300
131.0 267.8 292
132.0 269.6 285
133.0 271.4 278
134.0 273.2 271
135.0 275.0 264
136.0 276.8 258
137.0 278.6 252
138.0 280.4 246
139.0 282.2 240
140.0 284.0 234
141.0 285.8 228
EC-gfxProgram 1483
°C °F Resistance
142.0 287.6 223
143.0 289.4 218
144.0 291.2 212
145.0 293.0 207
146.0 294.8 203
147.0 296.6 198
148.0 298.4 193
149.0 300.2 189
150.0 302.0 185
1484 EC-gfxProgram
Thermistor Resistance Tables
10kilohm Type III Thermistor
Values shown in are within the supported range of controller operation for the
Type III sensor input.
°C °F Resistance
-40.0 -40.0 239831
-39.0 -38.2 226105
-38.0 -36.4 213243
-37.0 -34.6 201187
-36.0 -32.8 189885
-35.0 -31.0 179280
-34.0 -29.2 169330
-33.0 -27.4 159990
-32.0 -25.6 151219
-31.0 -23.8 142978
-30.0 -22.0 135233
-29.0 -20.2 127951
-28.0 -18.4 121104
-27.0 -16.6 114662
-26.0 -14.8 108599
-25.0 -13.0 102890
-24.0 -11.2 97513
-23.0 -9.4 92449
-22.0 -7.6 87675
-21.0 -5.8 83174
-20.0 -4.0 78930
-19.0 -2.2 74926
-18.0 -0.4 71148
-17.0 1.4 67581
-16.0 3.2 64212
-15.0 5.0 61030
-14.0 6.8 58024
EC-gfxProgram 1485
°C °F Resistance
-13.0 8.6 55182
-12.0 10.4 52495
-11.0 12.2 49954
-10.0 14.0 47549
-9.0 15.8 45274
-8.0 17.6 43119
-7.0 19.4 41079
-6.0 21.2 39147
-5.0 23.0 37316
-4.0 24.8 35580
-3.0 26.6 33935
-2.0 28.4 32375
-1.0 30.2 30895
0.0 32.0 29490
1.0 33.8 28157
2.0 35.6 26891
3.0 37.4 25689
4.0 39.2 24547
5.0 41.0 23462
6.0 42.8 22431
7.0 44.6 21450
8.0 46.4 20517
9.0 48.2 19631
10.0 50.0 18787
11.0 51.8 17983
12.0 53.6 17219
13.0 55.4 16490
14.0 57.2 15797
15.0 59.0 15136
16.0 60.8 14507
17.0 62.6 13906
1486 EC-gfxProgram
Thermistor Resistance Tables
°C °F Resistance
18.0 64.4 13334
19.0 66.2 12788
20.0 68.0 12268
21.0 69.8 11771
22.0 71.6 11297
23.0 73.4 10845
24.0 75.2 10413
25.0 77.0 10000
26.0 78.8 9606
27.0 80.6 9229
28.0 82.4 8869
29.0 84.2 8525
30.0 86.0 8197
31.0 87.8 7882
32.0 89.6 7581
33.0 91.4 7293
34.0 93.2 7018
35.0 95.0 6754
36.0 96.8 6501
37.0 98.6 6260
38.0 100.4 6028
39.0 102.2 5806
40.0 104.0 5594
41.0 105.8 5390
42.0 107.6 5195
43.0 109.4 5008
44.0 111.2 4828
45.0 113.0 4656
46.0 114.8 4490
47.0 116.6 4332
48.0 118.4 4180
EC-gfxProgram 1487
°C °F Resistance
49.0 120.2 4034
50.0 122.0 3893
51.0 123.8 3759
52.0 125.6 3629
53.0 127.4 3505
54.0 129.2 3386
55.0 131.0 3271
56.0 132.8 3160
57.0 134.6 3054
58.0 136.4 2952
59.0 138.2 2854
60.0 140.0 2760
61.0 141.8 2669
62.0 143.6 2582
63.0 145.4 2498
64.0 147.2 2417
65.0 149.0 2339
66.0 150.8 2264
67.0 152.6 2191
68.0 154.4 2122
69.0 156.2 2055
70.0 158.0 1990
71.0 159.8 1928
72.0 161.6 1868
73.0 163.4 1810
74.0 165.2 1754
75.0 167.0 1700
76.0 168.8 1648
77.0 170.6 1598
78.0 172.4 1550
79.0 174.2 1503
1488 EC-gfxProgram
Thermistor Resistance Tables
°C °F Resistance
80.0 176.0 1458
81.0 177.8 1414
82.0 179.6 1372
83.0 181.4 1332
84.0 183.2 1293
85.0 185.0 1255
86.0 186.8 1218
87.0 188.6 1183
88.0 190.4 1149
89.0 192.2 1116
90.0 194.0 1084
91.0 195.8 1053
92.0 197.6 1023
93.0 199.4 995
94.0 201.2 967
95.0 203.0 940
96.0 204.8 914
97.0 206.6 888
98.0 208.4 864
99.0 210.2 840
100.0 212.0 817
101.0 213.8 795
102.0 215.6 774
103.0 217.4 753
104.0 219.2 733
105.0 221.0 713
106.0 222.8 694
107.0 224.6 676
108.0 226.4 658
109.0 228.2 641
110.0 230.0 624
EC-gfxProgram 1489
°C °F Resistance
111.0 231.8 608
112.0 233.6 592
113.0 235.4 577
114.0 237.2 562
115.0 239.0 548
116.0 240.8 534
117.0 242.6 521
118.0 244.4 508
119.0 246.2 495
120.0 248.0 483
121.0 249.8 471
122.0 251.6 459
123.0 253.4 448
124.0 255.2 437
125.0 257.0 426
126.0 258.8 416
127.0 260.6 406
128.0 262.4 396
129.0 264.2 386
130.0 266.0 377
131.0 267.8 368
132.0 269.6 360
133.0 271.4 351
134.0 273.2 343
135.0 275.0 335
136.0 276.8 327
137.0 278.6 320
138.0 280.4 312
139.0 282.2 305
140.0 284.0 298
141.0 285.8 291
1490 EC-gfxProgram
Thermistor Resistance Tables
°C °F Resistance
142.0 287.6 285
143.0 289.4 278
144.0 291.2 272
145.0 293.0 266
146.0 294.8 260
147.0 296.6 254
148.0 298.4 249
149.0 300.2 243
150.0 302.0 238
EC-gfxProgram 1491
Platinum RTD Sensor: Pt1000 (1kilohm)
The required Pt1000 RTD sensor should have a Temperature Coefficient of
Resistance (TCR) of 0.00385 Ω/Ω/ºC (0.385 %/ºC, 3.85 Ω/K, or 3850 PPM/
ºC). Values shown in are within the supported range of controller operation for
the Pt1000 RTD sensor input.
°C °F Resistance
-40.0 -40.0 842.7
-39.0 -38.2 846.7
-38.0 -36.4 850.7
-37.0 -34.6 854.6
-36.0 -32.8 858.6
-35.0 -31.0 862.5
-34.0 -29.2 866.5
-33.0 -27.4 870.4
-32.0 -25.6 874.3
-31.0 -23.8 878.3
-30.0 -22.0 882.2
-29.0 -20.2 886.2
-28.0 -18.4 890.1
-27.0 -16.6 894.1
-26.0 -14.8 898.0
-25.0 -13.0 901.9
-24.0 -11.2 905.9
-23.0 -9.4 909.8
-22.0 -7.6 913.7
-21.0 -5.8 917.7
-20.0 -4.0 921.6
-19.0 -2.2 925.5
-18.0 -0.4 929.5
-17.0 1.4 933.4
-16.0 3.2 937.3
-15.0 5.0 941.3
1492 EC-gfxProgram
Thermistor Resistance Tables
°C °F Resistance
-14.0 6.8 945.2
-13.0 8.6 949.1
-12.0 10.4 953.0
-11.0 12.2 956.9
-10.0 14.0 960.9
-9.0 15.8 964.8
-8.0 17.6 968.7
-7.0 19.4 972.6
-6.0 21.2 976.5
-5.0 23.0 980.4
-4.0 24.8 984.4
-3.0 26.6 988.3
-2.0 28.4 992.2
-1.0 30.2 996.1
0.0 32.0 1000.0
1.0 33.8 1003.9
2.0 35.6 1007.8
3.0 37.4 1011.7
4.0 39.2 1015.6
5.0 41.0 1019.5
6.0 42.8 1023.4
7.0 44.6 1027.3
8.0 46.4 1031.2
9.0 48.2 1035.1
10.0 50.0 1039.0
11.0 51.8 1042.9
12.0 53.6 1046.8
13.0 55.4 1050.7
14.0 57.2 1054.5
15.0 59.0 1058.5
16.0 60.8 1062.4
EC-gfxProgram 1493
°C °F Resistance
17.0 62.6 1066.3
18.0 64.4 1070.2
19.0 66.2 1074.1
20.0 68.0 1077.9
21.0 69.8 1081.8
22.0 71.6 1085.7
23.0 73.4 1089.6
24.0 75.2 1093.5
25.0 77.0 1097.4
26.0 78.8 1101.2
27.0 80.6 1105.1
28.0 82.4 1109.0
29.0 84.2 1112.9
30.0 86.0 1116.7
31.0 87.8 1120.6
32.0 89.6 1124.5
33.0 91.4 1128.4
34.0 93.2 1132.2
35.0 95.0 1136.1
36.0 96.8 1140.0
37.0 98.6 1143.8
38.0 100.4 1147.7
39.0 102.2 1151.6
40.0 104.0 1155.4
41.0 105.8 1159.3
42.0 107.6 1163.1
43.0 109.4 1167.0
44.0 111.2 1170.9
45.0 113.0 1174.7
46.0 114.8 1178.6
47.0 116.6 1182.4
1494 EC-gfxProgram
Thermistor Resistance Tables
°C °F Resistance
48.0 118.4 1186.3
49.0 120.2 1190.1
50.0 122.0 1194.0
51.0 123.8 1197.8
52.0 125.6 1201.7
53.0 127.4 1205.5
54.0 129.2 1209.4
55.0 131.0 1213.2
56.0 132.8 1217.1
57.0 134.6 1220.9
58.0 136.4 1224.7
59.0 138.2 1128.6
60.0 140.0 1232.4
61.0 141.8 1236.3
62.0 143.6 1240.1
63.0 145.4 1243.9
64.0 147.2 1247.8
65.0 149.0 1251.6
66.0 150.8 1255.4
67.0 152.6 1259.3
68.0 154.4 1263.1
69.0 156.2 1266.9
70.0 158.0 1270.8
71.0 159.8 1274.6
72.0 161.6 1278.4
73.0 163.4 1282.2
74.0 165.2 1286.0
75.0 167.0 1289.9
76.0 168.8 1293.7
77.0 170.6 1297.5
78.0 172.4 1301.3
EC-gfxProgram 1495
°C °F Resistance
79.0 174.2 1305.2
80.0 176.0 1309.0
81.0 177.8 1312.8
82.0 179.6 1316.6
83.0 181.4 1320.4
84.0 183.2 1324.2
85.0 185.0 1328.0
86.0 186.8 1331.8
87.0 188.6 1335.7
88.0 190.4 1339.5
89.0 192.2 1343.3
90.0 194.0 1347.1
91.0 195.8 1350.9
92.0 197.6 1354.7
93.0 199.4 1358.4
94.0 201.2 1362.3
95.0 203.0 1366.1
96.0 204.8 1369.9
97.0 206.6 1373.7
98.0 208.4 1377.5
99.0 210.2 1381.3
100.0 212.0 1385.0
101.0 213.8 1388.9
102.0 215.6 1392.6
103.0 217.4 1396.4
104.0 219.2 1400.2
105.0 221.0 1404.0
106.0 222.8 1407.8
107.0 224.6 1411.6
108.0 226.4 1415.4
109.0 228.2 1419.1
1496 EC-gfxProgram
Thermistor Resistance Tables
°C °F Resistance
110.0 230.0 1422.9
111.0 231.8 1426.7
112.0 233.6 1430.5
113.0 235.4 1434.3
114.0 237.2 1438.0
115.0 239.0 1441.8
116.0 240.8 1445.6
117.0 242.6 1449.4
118.0 244.4 1453.1
119.0 246.2 1456.9
120.0 248.0 1460.6
121.0 249.8 1464.5
122.0 251.6 1468.2
123.0 253.4 1472.0
124.0 255.2 1475.8
125.0 257.0 1479.5
126.0 258.8 1483.3
127.0 260.6 1487.0
128.0 262.4 1490.8
129.0 264.2 1494.6
130.0 266.0 1498.3
131.0 267.8 1502.1
132.0 269.6 1505.6
133.0 271.4 1509.6
134.0 273.2 1513.3
135.0 275.0 1517.1
136.0 276.8 1520.9
137.0 278.6 1524.6
138.0 280.4 1528.4
139.0 282.2 1532.1
140.0 284.0 1535.8
EC-gfxProgram 1497
°C °F Resistance
141.0 285.8 1539.6
142.0 287.6 1543.3
143.0 289.4 1547.1
144.0 291.2 1550.8
145.0 293.0 1554.6
146.0 294.8 1558.3
147.0 296.6 1562.0
148.0 298.4 1565.8
149.0 300.2 1569.5
150.0 302.0 1573.1
1498 EC-gfxProgram
Thermistor Resistance Tables
Nickel RTD Sensor: Ni1000 (1kilohm) @ 0ºC
Values shown in are within the supported range of controller operation for the
Ni1000 RTD sensor input.
°C °F Resistance
-40.0 -40.0 791.31
-39.0 -38.2 796.26
-38.0 -36.4 801.23
-37.0 -34.6 806.21
-36.0 -32.8 811.21
-35.0 -31.0 816.21
-34.0 -29.2 821.23
-33.0 -27.4 826.27
-32.0 -25.6 831.32
-31.0 -23.8 836.38
-30.0 -22.0 841.46
-29.0 -20.2 846.55
-28.0 -18.4 851.65
-27.0 -16.6 856.77
-26.0 -14.8 861.90
-25.0 -13.0 867.04
-24.0 -11.2 872.20
-23.0 -9.4 877.37
-22.0 -7.6 882.56
-21.0 -5.8 887.75
-20.0 -4.0 892.96
-19.0 -2.2 898.19
-18.0 -0.4 903.43
-17.0 1.4 908.68
-16.0 3.2 913.94
-15.0 5.0 919.22
-14.0 6.8 924.51
EC-gfxProgram 1499
°C °F Resistance
-13.0 8.6 929.82
-12.0 10.4 935.14
-11.0 12.2 940.47
-10.0 14.0 945.82
-9.0 15.8 951.17
-8.0 17.6 956.55
-7.0 19.4 961.93
-6.0 21.2 967.33
-5.0 23.0 972.74
-4.0 24.8 978.17
-3.0 26.6 983.60
-2.0 28.4 989.06
-1.0 30.2 994.52
0.0 32.0 1000.00
1.0 33.8 1005.49
2.0 35.6 1011.00
3.0 37.4 1016.51
4.0 39.2 1022.05
5.0 41.0 1027.59
6.0 42.8 1033.15
7.0 44.6 1038.72
8.0 46.4 1044.31
9.0 48.2 1049.90
10.0 50.0 1055.52
11.0 51.8 1061.14
12.0 53.6 1066.78
13.0 55.4 1072.43
14.0 57.2 1078.09
15.0 59.0 1083.77
16.0 60.8 1089.46
17.0 62.6 1095.17
1500 EC-gfxProgram
Thermistor Resistance Tables
°C °F Resistance
18.0 64.4 1100.89
19.0 66.2 1106.62
20.0 68.0 1112.36
21.0 69.8 1118.12
22.0 71.6 1123.90
23.0 73.4 1129.68
24.0 75.2 1135.48
25.0 77.0 1141.29
26.0 78.8 1147.12
27.0 80.6 1152.96
28.0 82.4 1158.81
29.0 84.2 1164.68
30.0 86.0 1170.56
31.0 87.8 1176.45
32.0 89.6 1182.36
33.0 91.4 1188.28
34.0 93.2 1194.21
35.0 95.0 1200.16
36.0 96.8 1206.13
37.0 98.6 1212.10
38.0 100.4 1218.09
39.0 102.2 1224.09
40.0 104.0 1230.11
41.0 105.8 1236.14
42.0 107.6 1242.19
43.0 109.4 1248.25
44.0 111.2 1254.32
45.0 113.0 1260.41
46.0 114.8 1266.51
47.0 116.6 1272.62
48.0 118.4 1278.75
EC-gfxProgram 1501
°C °F Resistance
49.0 120.2 1284.89
50.0 122.0 1291.05
51.0 123.8 1297.22
52.0 125.6 1303.41
53.0 127.4 1309.61
54.0 129.2 1315.82
55.0 131.0 1322.05
56.0 132.8 1328.29
57.0 134.6 1334.55
58.0 136.4 1340.82
59.0 138.2 1347.10
60.0 140.0 1353.40
61.0 141.8 1359.72
62.0 143.6 1366.05
63.0 145.4 1372.39
64.0 147.2 1378.75
65.0 149.0 1385.12
66.0 150.8 1391.51
67.0 152.6 1397.91
68.0 154.4 1404.33
69.0 156.2 1410.76
70.0 158.0 1417.21
71.0 159.8 1423.67
72.0 161.6 1430.14
73.0 163.4 1436.64
74.0 165.2 1443.14
75.0 167.0 1449.67
76.0 168.8 1456.20
77.0 170.6 1462.75
78.0 172.4 1469.32
79.0 174.2 1475.91
1502 EC-gfxProgram
Thermistor Resistance Tables
°C °F Resistance
80.0 176.0 1482.50
81.0 177.8 1489.12
82.0 179.6 1495.75
83.0 181.4 1502.39
84.0 183.2 1509.05
85.0 185.0 1515.73
86.0 186.8 1522.42
87.0 188.6 1529.13
88.0 190.4 1535.85
89.0 192.2 1542.59
90.0 194.0 1549.34
91.0 195.8 1556.12
92.0 197.6 1562.90
93.0 199.4 1569.71
94.0 201.2 1576.53
95.0 203.0 1583.36
96.0 204.8 1590.21
97.0 206.6 1597.08
98.0 208.4 1603.97
99.0 210.2 1610.87
100.0 212.0 1617.79
101.0 213.8 1624.72
102.0 215.6 1631.67
103.0 217.4 1638.64
104.0 219.2 1645.62
105.0 221.0 1652.62
106.0 222.8 1659.64
107.0 224.6 1666.68
108.0 226.4 1673.73
109.0 228.2 1680.80
110.0 230.0 1687.89
EC-gfxProgram 1503
°C °F Resistance
111.0 231.8 1694.99
112.0 233.6 1702.11
113.0 235.4 1709.25
114.0 237.2 1716.41
115.0 239.0 1723.58
116.0 240.8 1730.77
117.0 242.6 1737.98
118.0 244.4 1745.21
119.0 246.2 1752.45
120.0 248.0 1759.72
121.0 249.8 1767.00
122.0 251.6 1774.30
123.0 253.4 1781.61
124.0 255.2 1788.95
125.0 257.0 1796.30
126.0 258.8 1803.68
127.0 260.6 1811.07
128.0 262.4 1818.48
129.0 264.2 1825.90
130.0 266.0 1833.35
131.0 267.8 1840.82
132.0 269.6 1848.30
133.0 271.4 1855.80
134.0 273.2 1863.33
135.0 275.0 1870.87
136.0 276.8 1878.43
137.0 278.6 1886.01
138.0 280.4 1893.61
139.0 282.2 1901.23
140.0 284.0 1908.87
141.0 285.8 1916.52
1504 EC-gfxProgram
Thermistor Resistance Tables
°C °F Resistance
142.0 287.6 1924.20
143.0 289.4 1931.90
144.0 291.2 1939.62
145.0 293.0 1947.35
146.0 294.8 1955.11
147.0 296.6 1962.89
148.0 298.4 1970.69
149.0 300.2 1978.51
150.0 302.0 1986.35
EC-gfxProgram 1505
Nickel RTD Sensor: Ni1000 (1kilohm) @ 21ºC
Values shown in are within the supported range of controller operation for the
Ni1000 RTD sensor input.
°C °F Resistance
-46 -50 674
-40 -40 699
-34 -30 725
-29 -20 751
-23 -10 777
-18 0 803
-12 10 830
-7 20 858
-1 30 885
4 40 914
10 50 942
16 60 971
21 70 1000
27 80 1030
32 90 1060
38 100 1090
43 110 1121
49 120 1152
54 130 1184
60 140 1216
66 150 1248
71 160 1281
77 170 1314
82 180 1348
88 190 1382
93 200 1417
99 210 1452
1506 EC-gfxProgram
Thermistor Resistance Tables
°C °F Resistance
104 220 1487
110 230 1524
116 240 1560
121 250 1597
EC-gfxProgram 1507
1508 EC-gfxProgram
EC-gfxProgram
EC-gfxProgram_UG_67_EN
You might also like
- WorkPlace Tech Tool 4.0 Engineering Guide (F-27254-4)No ratings yetWorkPlace Tech Tool 4.0 Engineering Guide (F-27254-4)732 pages
- Intelligent Buildings (NT3042) L11 BACnetNo ratings yetIntelligent Buildings (NT3042) L11 BACnet54 pages
- System Description For Use With DESIGO XWORKS 17285 HQ enNo ratings yetSystem Description For Use With DESIGO XWORKS 17285 HQ en48 pages
- 04) CP Training-Understand Customer Pain Point and How STARDOM Can Be The Pain Killer100% (1)04) CP Training-Understand Customer Pain Point and How STARDOM Can Be The Pain Killer51 pages
- Geo SCADA 2022 Update Sep 2023 (85.8650.1) Release NotesNo ratings yetGeo SCADA 2022 Update Sep 2023 (85.8650.1) Release Notes39 pages
- Sparkplug Specification: MQTT Topic Namespace and Payload DefinitionNo ratings yetSparkplug Specification: MQTT Topic Namespace and Payload Definition56 pages
- D1.5 Analysis of Hard and Software RequirementsNo ratings yetD1.5 Analysis of Hard and Software Requirements59 pages
- Assembling The Puzzle Pieces of Digital Tranformation - June2024WebinarNo ratings yetAssembling The Puzzle Pieces of Digital Tranformation - June2024Webinar38 pages
- Safety Considerations Guide For Tricon v9-v10 SystemsNo ratings yetSafety Considerations Guide For Tricon v9-v10 Systems122 pages
- MELSEC IQ-R PID Control Function Block Library ReferenceNo ratings yetMELSEC IQ-R PID Control Function Block Library Reference94 pages
- TAC Vista Product Catalog Building Management System CatalogueNo ratings yetTAC Vista Product Catalog Building Management System Catalogue103 pages
- RS 485 Cabling Requirements Modbus RTU and BACnet MSTP - R20ANo ratings yetRS 485 Cabling Requirements Modbus RTU and BACnet MSTP - R20A5 pages
- AVEVA Customer FIRST Program User Guide v1.3 May 2020No ratings yetAVEVA Customer FIRST Program User Guide v1.3 May 202041 pages
- Gooood Telvent - OASyS SCADA - Specifications Product1No ratings yetGooood Telvent - OASyS SCADA - Specifications Product111 pages
- 02a BACnet IP Fundamentals May2022 v02 HANDOUTNo ratings yet02a BACnet IP Fundamentals May2022 v02 HANDOUT25 pages
- 6.中央監控基本軟體+10.1-AVEVA System Platform 2023, 5K IO1K HistoryNo ratings yet6.中央監控基本軟體+10.1-AVEVA System Platform 2023, 5K IO1K History17 pages
- ControlMaestro 2018 and Titanium Hardware SpecificationsNo ratings yetControlMaestro 2018 and Titanium Hardware Specifications7 pages
- GENESIS64 - Connecting To Remote ICONICS FrameWorX64 ServerNo ratings yetGENESIS64 - Connecting To Remote ICONICS FrameWorX64 Server2 pages
- Ignition HMI To SLC Through ANC-100e or ANC-120eNo ratings yetIgnition HMI To SLC Through ANC-100e or ANC-120e6 pages
- FlexROOM WAGO in Building Automation 60395614No ratings yetFlexROOM WAGO in Building Automation 6039561424 pages
- Healthcare Facilities: Open, Secure and Connected SolutionsNo ratings yetHealthcare Facilities: Open, Secure and Connected Solutions8 pages
- Establishing OPC UA Connectivity With Rockwell Automation® Integrated ArchitectureNo ratings yetEstablishing OPC UA Connectivity With Rockwell Automation® Integrated Architecture3 pages
- How To Serial Shell Into A JACE: Additional InformationNo ratings yetHow To Serial Shell Into A JACE: Additional Information1 page
