EC-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
print
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