eikon 3.02 microblock reference

372
Eikon Microblock Reference

Upload: smithan68

Post on 23-Aug-2014

181 views

Category:

Documents


2 download

TRANSCRIPT

Page 1: Eikon 3.02 Microblock Reference

EikonMicroblock Reference

Page 2: Eikon 3.02 Microblock Reference

Revised on 28-March-00.Version 3.02Copyright 2000 Automated Logic Corporation. All rights reserved.1150 Roberts Boulevard, Kennesaw, GA 30144Phone (770) 429-3000 FAX (770) 429-3001Visit us at http://www.automatedlogic.comPrinted in the United States of America.

Automated Logic is a registered trademark of Automated Logic Corporation.All other brand and product names are trademarked by their respective owners.

This manual was produced using FrameMaker.

Page 3: Eikon 3.02 Microblock Reference

Contents

Chapter 1 Introduction 15

Chapter 2 BACnet Client Microblocks 19

BACnet Client Read Analog 21

BACnet Client Read Binary 24

BACnet Client Write Analog 27

BACnet Client Write Binary 30

BACnet Client Synchronize Analog 33

BACnet Client Synchronize Binary 37

Chapter 3 BACnet Microblocks 41

BACnet Analog Input 42

BACnet Binary Input 45

BACnet Analog Output 48

BACnet Binary Output 51

BACnet Binary Parameter 54

BACnet Analog Parameter 56

BACnet Binary Status 58

BACnet Analog Status 60

Chapter 4 I/O Microblocks 67

Analog Input 69

Digital Input 71

Contents • 3

Page 4: Eikon 3.02 Microblock Reference

Timed Local Override 73

Pulse to Analog 75

LAN Analog Input 78

LAN Digital Input 81

Analog Output 83

Digital Output 85

Floating Motor Output 87

Pulse-Width Output 90

LAN Analog Output 93

LAN Digital Output 96

Airflow Control 99

LogiStat Zone Control 107

Chapter 5 SysIn Microblocks 111

Receive Run Request 113

Receive Heat Request 115

Receive Cool Request 117

Receive Heat and Cool Requests 119

4 • Contents

Page 5: Eikon 3.02 Microblock Reference

Get System Variable 121

Get System Status 123

Receive Electrical Demand Level 125

Binary Parameter 126

Analog Parameter 127

Time Parameter 129

Binary Constant 130

Analog Constant 131

Time Constant 132

Chapter 6 SysOut Microblocks 133

Transmit Run Request 135

Transmit Heat Request 137

Transmit Cool Request 139

Transmit Multiple Heat Requests 141

Transmit Multiple Cool Requests 143

Prime Variable 145

Demand Broadcast 146

Binary Status 147

Analog Status 148

Time Status 149

Outside Air Broadcast 150

Contents • 5

Page 6: Eikon 3.02 Microblock Reference

OA2 - Primary/Secondary Outside Air Broadcast 151

OA3 - Primary/Secondary Outside Air Broadcast 154

Chapter 7 Log Microblocks 157

Digital Trend 158

Analog Trend 160

Set Alarm Number 162

Set Message Number 164

Set Runtime Exceeded Flag 166

Runtime Monitor 168

Alert Event 170

History Recorder 175

High Peak Recorder 176

Low Peak Recorder 178

Runtime Accumulation 180

6 • Contents

Page 7: Eikon 3.02 Microblock Reference

Chapter 8 Control Microblocks 183

Zone Setpoint 190

Zone Setpoint with Demand 194

Zone Setpoint - Plus 198

Zone Setpoint with Learning Adaptive Optimal Start 204

Zone Setpoint with Demand and Learning Adaptive Op-timal Start 208

Zone Setpoint - Plus with Learning Adaptive Optimal Start 213

Setpoint Optimization 220

Set Color 222

Set Color If True 223

Contents • 7

Page 8: Eikon 3.02 Microblock Reference

True If Color = 224

Scheduler 226

Scheduler with Override 227

Chapter 9 Convert Microblocks 229

Zone Controller 231

PID - Direct Acting 234

PID - Reverse Acting 238

Linear Converter 242

Linear Converter for Variable Inputs 243

Enthalpy Calculator 244

Dewpoint Temperature Calculator 246

Wet Bulb Temperature Calculator 247

True If = Constant 248

True If > Constant 249

True If < Constant 250

True If = Variable 251

True If > Variable Input 252

8 • Contents

Page 9: Eikon 3.02 Microblock Reference

True If Input < Variable Input 253

Analog to Digital Converter 254

Digital to Analog Converter 255

Chapter 10 Limit Microblocks 257

Constant High Signal Selector 258

Constant Low Signal Selector 259

Variable High Signal Selector 260

Variable Low Signal Selector 261

Constant Low Limit 262

Constant High Limit 263

Variable Low Limit 264

Variable High Limit 265

Ramp Up/Down Control 266

Chapter 11 Relay Microblocks 269

Constant Duty Cycle 271

Variable Duty Cycle 273

Delay on Make 274

Delay on Break 275

Maximum On Timer 276

Minimum On/Off Timer 277

Contents • 9

Page 10: Eikon 3.02 Microblock Reference

Latch 278

Toggle 279

Lead/Standby 280

Switch (Normally Closed to Variable) 283

Switch (Normally Closed to Constant) 284

Two Variables Switch 285

Digital Wire Lock 286

Analog Wire Lock 287

Chapter 12 Logic Microblocks 289

And - 2 Input 290

And - 3 Input 290

And - 4 Input 290

And - 5 Input 291

Or - 2 Input 291

Or - 3 Input 291

Or - 4 Input 291

Or - 5 Input 292

10 • Contents

Page 11: Eikon 3.02 Microblock Reference

Exclusive Or (XOR) 292

Not 292

Chapter 13 Math1 Microblocks 293

Add Constant to Variable 295

Subtract Constant from Variable 296

Multiply Variable by Constant 297

Divide Variable by Constant 298

Modulo Divide by Constant 299

Add Two Variables 300

Add Three Variables 300

Add Four Variables 300

Subtract Two Variables 300

Multiply Two Variables 301

Divide Two Variables 301

Modulo 301

Average 301

Change Sign 302

Absolute Value 302

Chapter 14 Math2 Microblocks 303

Sine 304

Cosine 304

Contents • 11

Page 12: Eikon 3.02 Microblock Reference

Tangent 304

Natural Log 304

Log 305

Exponent 305

Square Root 305

Integrator 306

Round Up/Down 307

Truncate 307

Chapter 15 Misc Microblocks 309

DO/DI Proof 310

Up/Down Counter 312

Sunrise/Sunset 313

Text 315

Multi-Text 316

Version 318

Operators' Control Language 327

Chapter 16 Figure 319

Drawing figures 319

Editing figures 322

Editing a figure’s attributes 323Editing a figure’s shape 323Scaling and rotating 324

Chapter 17 Operators' Control Language 327

Sample OCL program 329

Variable declaration section 329

Predefined Symbols 333

12 • Contents

Page 13: Eikon 3.02 Microblock Reference

System Variables 334

Special Characters 335

Mathematical Functions 335

Programming Structures 342

Error Messages 347

Chapter 18 Appendix A 351

Non-Graphic FB Commands 351

Chapter 19 Glossary 359

Chapter 20 Index 365

Contents • 13

Page 14: Eikon 3.02 Microblock Reference

14 • Contents

Page 15: Eikon 3.02 Microblock Reference

1 Introduction

This manual is intended to serve as a reference for each of the microblocks included with Eikon. This manual provides details about the individual microblocks and their associated parameters. For information about creating and editing Graphic Function Blocks (GFBs) or other functions of Eikon, refer to the Eikon User’s Guide.

The Parameter and Status page text that is shown in this manual assumes the microblock is unconfigured. Underscores (_) represent configurable information on the Parameter page, while tildes (~) represent current status values on the Status page.

The following table lists the microblocks that are not supported by each Exec version.

Table 1-1. Unsupported microblocks by Exec Version

Exec 3.x Exec 4.x Exec 6.x

Alert Alarm OCL Set Alarm Number

OA3/Primary-Secondary Outside Air Broadcast

BACnet Client Read Analog Set Message Number

Digital Trend BACnet Client Read Binary Set Runtime Exceeded Flag

Analog Trend BACnet Client Write Analog OA2/Primary-Secondary Outside Air Broadcast

Runtime Monitor BACnet Client Write Binary

Zone Setpoint with Learning Adaptive Optimal Start

BACnet Client Synchronize Analog

Chapter 1: Introduction • 15

Page 16: Eikon 3.02 Microblock Reference

Zone Setpoint with Demand and Learning Adaptive Optimal Start

BACnet Client Synchronize Binary

Zone Setpoint - Plus with Learning Adaptive Optimal Start

BACnet Analog Input

Set Color If True BACnet Analog Output

Digital Wire Lock BACnet Binary Input

Analog Wire Lock BACnet Binary Output

Sunrise/Sunset BACnet Analog Parameter

Multi-Text BACnet Analog Status

BACnet Client Read Analog BACnet Binary Parameter

BACnet Client Read Binary BACnet Binary Status

BACnet Client Write Analog Linear Converter for Variable Inputs

BACnet Client Write Binary Airflow control

BACnet Client Synchronize Analog

Zone Controller

BACnet Client Synchronize Binary

LogiStat Zone Sensor

BACnet Analog Input

BACnet Analog Output

BACnet Binary Input

BACnet Binary Output

BACnet Analog Parameter

BACnet Analog Status

BACnet Binary Parameter

Table 1-1. Unsupported microblocks by Exec Version

Exec 3.x Exec 4.x Exec 6.x

16 • Chapter 1: Introduction

Page 17: Eikon 3.02 Microblock Reference

♦ ♦ ♦

BACnet Binary Status

OCL

Linear Converter for Variable Inputs

Airflow control

Zone Controller

LogiStat Zone Sensor

Table 1-1. Unsupported microblocks by Exec Version

Exec 3.x Exec 4.x Exec 6.x

Chapter 1: Introduction • 17

Page 18: Eikon 3.02 Microblock Reference

18 • Chapter 1: Introduction

Page 19: Eikon 3.02 Microblock Reference

2 BACnet Client Microblocks

The BACnet2 menu contains microblocks that are used to initiate read and write requests from within a GFB to any BACnet device on the BACnet internetwork. The BACnet Client microblocks must be bound to either a BACnet microblock or to a point or property in a BACnet device. By binding the BACnet microblock to a BACnet object, the values in the object are available to the GFB containing the BACnet Client microblock. A BACnet Client microblock can be bound to another BACnet object using either static or dynamic binding. BACnet Class 1 and 2 devices only support static binding.

BACnet Client microblocks are used for communication only - they do not create BACnet objects in a module.

All the microblocks on the BACnet2 menu require Exec version 6.02 or greater.

Static binding

Static binding requires the following information about the object you want to bind to:

• object type

• object instance number

• device instance number

• Network address

• MAC address

Chapter 2: BACnet Client Microblocks • 19

Page 20: Eikon 3.02 Microblock Reference

Dynamic binding

Dynamic binding is not supported by all BACnet devices; BACnet Class 1 and 2 devices, such as U-cards, do not support this type of binding. Special BACnet services (Who Is and Who Has) are used to locate the BACnet device and object that you want to bind to.

Dynamic binding requires either the Object Name or Instance number of the object you want to bind to, along with any of the following:

• Device Instance

• Device Name

• Network # and MAC address

For example, by creating a VAV Zone GFB with a BACnet Client microblock that binds to the object named “Supply Air Temp” in the device named “VAV AHU,” the GFB can be used in any sites using “VAV AHU” as the name for the module controlling the VAV air handling unit.

The following BACnet Client microblocks are available:

BACnet Client Read Analog 21

BACnet Client Read Binary 24

BACnet Client Write Analog 27

BACnet Client Write Binary 30

BACnet Client Synchronize Analog 33

BACnet Client Synchronize Binary 37

20 • Chapter 2: BACnet Client Microblocks

Page 21: Eikon 3.02 Microblock Reference

BACnet Client Read Analog

BACnet Client Read Analog

The BACnet Client Read Analog microblock reads the following types of data from BACnet devices and converts the raw data to an analog value:

• Unsigned Integer

• Signed Integer

• Real

• Double

• Enumerated

• Binary

The BACnet Communications section on the microblock dialog allows you to enable BACnet communications on this point. Disable this parameter for troubleshooting.

The Simulation section on the microblock dialog allows you to define a value for this microblock that will be used during Eikon’s simulation. For details about using simulation to test the operation of a GFB, refer to the section “Testing the GFB” of the Eikon User’s Guide.

Assign settings for the remote BACnet objects that you want to communicate with in the Bind Settings section of the microblock dialog. The Object Instance or Name parameter allows you to set the instance number (read as the instance number if all the characters are numbers) or the name (read as the name if any of the characters are not numbers). When this parameter is used as an object name, it uses the Who-Has BACnet service to find the object. See the ANSI/ASHRAE standard, SPC 135 for more information on the Who-Has service. The Object Type can be set to AI, AO, AV, or Custom for this microblock. If set to Custom, you must provide information in the Custom Settings section.

The Refresh Time allows you to set a time interval in minutes and seconds before the module reads a point.

Microblock

Microblock Library icon

Chapter 2: BACnet Client Microblocks • 21

Page 22: Eikon 3.02 Microblock Reference

BACnet Client Read Analog

The Default Value determines the value that the microblock uses on the GFB output wire when communication with the remote BACnet object is lost.

The Custom Settings section allows you to specify the Object Type, Property, and Data Type of the bound object. See the ANSI/ASHRAE standard, SPC 135 for more information. The Data Type field values are Boolean (1), Unsigned (2), Integer (3), Real (4), Double (5), or Enumerated (9).

The Device Instance or Name parameter allows you to set the BACnet device instance (read as the device instance if all the characters are numbers) or the name (read as the name if any of the characters are not numbers). When this parameter is used as a name, it uses the Who-Has BACnet service to find the object. A value of “this-device” indicates that the BACnet property is in this device; this allows for communication with the device without generating traffic on the network. A value of “default” allows you to enter the remote device information on the module driver page. This information is used to insert multiple BACnet Client microblocks that are referencing the same remote device into a GFB. To disable this parameter, enter “no-value.”

The Network # parameter allows you to enter the BACnet network number of the segment but if the module is on the same network, enter “local”. The MAC Address parameter allows you to enter the MAC address. The letter ‘h’ at the end of either of these strings indicates that the string is hexadecimal. To disable either of these parameters, enter “no-value.”

NOTE If the Network # and MAC Address are entered, they will be used for dynamic binding instead of the Device Name. But for static binding to occur, the Object Instance, Network #, MAC Address, and Device Instance are required.

If a field is not used, enter “no-value.” When “no-value” is entered, the BACnet Client microblock uses the Who-Is or Who-Has BACnet services to locate and dynamically bind to the BACnet object for communication. Only remote devices that are BACnet Class 3 or higher can support dynamic binding.

22 • Chapter 2: BACnet Client Microblocks

Page 23: Eikon 3.02 Microblock Reference

BACnet Client Read Analog

Figure 2-1: BACnet Client Read Analog Property dialog

Chapter 2: BACnet Client Microblocks • 23

Page 24: Eikon 3.02 Microblock Reference

BACnet Client Read Binary

BACnet Client Read Binary

The BACnet Client Read Binary microblock reads only Boolean data.

The BACnet Communications section on the microblock dialog allows you to enable BACnet communications on this point. Disable this parameter for troubleshooting.

The Simulation section on the microblock dialog allows you to define a value for this microblock that will be used during Eikon’s simulation. For details about using simulation to test the operation of a GFB, refer to the section “Testing the GFB” of the Eikon User’s Guide.

Assign settings for the remote BACnet objects that you want to communicate with in the Bind Settings section of the microblock dialog. The Object Instance or Name parameter allows you to set the instance number (read as the instance number if all the characters are numbers) or the name (read as the name if any of the characters are not numbers). When this parameter is used as an object name, it uses the Who-Has BACnet service to find the object. See the ANSI/ASHRAE standard, SPC 135 for more information on the Who-Has service. The Object Type can be set to BI, BO, BV or Custom for this microblock. If set to Custom, you must provide information in the Custom Settings section.

The Refresh Time allows you to set a time interval in minutes and seconds before the module reads a point.

The Default Value determines the value that the microblock uses on the wire when communication with the remote BACnet object is lost.

The Custom Settings section allows you to specify the Object Type, Property, and Data Type of the bound object. See the ANSI/ASHRAE standard, SPC 135 for more information. The Data Type field values are Boolean (1), Unsigned (2), Integer (3), Real (4), Double (5), or Enumerated (9).

The Device Instance or Name parameter allows you to set the BACnet device instance (read as the device instance if all the characters are numbers) or the name (read as the name if any of the characters are not numbers). When this parameter is used as a name, it uses the Who-Has BACnet service to find the object. A value of “this-device”

Microblock

Microblock Library icon

24 • Chapter 2: BACnet Client Microblocks

Page 25: Eikon 3.02 Microblock Reference

BACnet Client Read Binary

indicates that the BACnet property is in this device; this allows for communication with the device without generating traffic on the network. A value of “default” allows you to enter the remote device information on the module driver page. This information is used to insert multiple BACnet Client microblocks that are referencing the same remote device into a GFB. To disable this parameter, enter “no-value.”

The Network # parameter allows you to enter the BACnet network number of the segment but if the module is on the same network, enter “local”. The MAC Address parameter allows you to enter the MAC Address. The letter ‘h’ at the end of either of these strings indicates that the string is hexadecimal. To disable either of these parameters, enter “no-value.”

NOTE If the Network # and MAC Address are entered, they will be used for dynamic binding instead of the Device Name. But for static binding to occur, the Object Instance, Network #, MAC Address, and Device Instance are required.

If a field is not used, enter “no-value.” When “no-value” is entered, the BACnet Client microblock uses the Who-Is or Who-Has BACnet services to locate and dynamically bind to the BACnet object for communication. Only remote devices that are BACnet Class 3 or higher can support dynamic binding.

Chapter 2: BACnet Client Microblocks • 25

Page 26: Eikon 3.02 Microblock Reference

BACnet Client Read Binary

Figure 2-2: BACnet Client Read Binary Property dialog

26 • Chapter 2: BACnet Client Microblocks

Page 27: Eikon 3.02 Microblock Reference

BACnet Client Write Analog

BACnet Client Write Analog

The BACnet Client Read Analog microblock writes the following types of data:

• Unsigned Integer

• Signed Integer

• Real

• Double

• Enumerated

• Boolean

The BACnet Communications section on the microblock dialog allows you to enable BACnet communications on this point. Disable this parameter for troubleshooting.

The Simulation section on the microblock dialog allows you to define a value for this microblock that will be used during Eikon’s simulation. For details about using simulation to test the operation of a GFB, refer to the section “Testing the GFB” of the Eikon User’s Guide.

Assign settings for the remote BACnet objects that you want to communicate with in the Bind Settings section of the microblock dialog. The Object Instance or Name parameter allows you to set the instance number (read as the instance number if all the characters are numbers) or the name (read as the name if any of the characters are not numbers). When this parameter is used as an object name, it uses the Who-Has BACnet service to find the object. See the ANSI/ASHRAE standard, SPC 135 for more information on the Who-Has service. The Object Type can be set to AI, AO, AV, BI, BO, BV or Custom for this microblock. If set to Custom, you must provide information in the Custom Settings section.

The Refresh Time allows you to set a time interval in minutes and seconds before the module writes a point. When this value is set to 0:00, write operations only occur at start-up or when the input value changes.

Microblock Library icon

Microblock

Chapter 2: BACnet Client Microblocks • 27

Page 28: Eikon 3.02 Microblock Reference

BACnet Client Write Analog

The Custom Settings section allows you to specify the Object Type, Property, and Data Type of the bound object. See the ANSI/ASHRAE standard, SPC 135 for more information. The Data Type field values are Boolean (1), Unsigned (2), Integer (3), Real (4), Double (5), or Enumerated (9).

The Device Instance or Name parameter allows you to set the BACnet device instance (read as the device instance if all the characters are numbers) or the name (read as the name if any of the characters are not numbers). When this parameter is used as a name, it uses the Who-Has BACnet service to find the object. A value of “this-device” indicates that the BACnet property is in this device; this allows for communication with the device without generating traffic on the network. A value of “default” allows you to enter the remote device information on the module driver page. This information is used to insert multiple BACnet Client microblocks that are referencing the same remote device into a GFB. To disable this parameter, enter “no-value.”

The Network # parameter allows you to enter the BACnet network number of the segment but if the module is on the same network, enter “local”. The MAC Address parameter allows you to enter the MAC Address. The letter ‘h’ at the end of either of these strings indicates that the string is hexadecimal. To disable either of these parameters, enter “no-value.”

NOTE If the Network # and MAC Address are entered, they will be used for dynamic binding instead of the Device Name. But for static binding to occur, the Object Instance, Network #, MAC Address, and Device Instance are required.

If a field is not used, enter “no-value.” When “no-value” is entered, the BACnet Client microblock uses the Who-Is or Who-Has BACnet services to locate and dynamically bind to the BACnet object for communication. Only remote devices that are BACnet Class 3 or higher can support dynamic binding.

28 • Chapter 2: BACnet Client Microblocks

Page 29: Eikon 3.02 Microblock Reference

BACnet Client Write Analog

Figure 2-3: BACnet Client Write Analog Property dialog

Chapter 2: BACnet Client Microblocks • 29

Page 30: Eikon 3.02 Microblock Reference

BACnet Client Write Binary

BACnet Client Write Binary

The BACnet Client Write Binary microblock writes only Boolean data.

The BACnet Communications section on the microblock dialog allows you to enable BACnet communications on this point. Disable this parameter for troubleshooting.

The Simulation section on the microblock dialog allows you to define a value for this microblock that will be used during Eikon’s simulation. For details about using simulation to test the operation of a GFB, refer to the section “Testing the GFB” of the Eikon User’s Guide.

Assign settings for the remote BACnet objects that you want to communicate with in the Bind Settings section of the microblock dialog. The Object Instance or Name parameter allows you to set the instance number (read as the instance number if all the characters are numbers) or the name (read as the name if any of the characters are not numbers). When this parameter is used as an object name, it uses the Who-Has BACnet service to find the object. See the ANSI/ASHRAE standard, SPC 135 for more information on the Who-Has service. The Object Type can be set to AI, AO, AV, BI, BO, BV or Custom for this microblock. If set to Custom, you must provide information in the Custom Settings section.

The Refresh Time allows you to set a time interval in minutes and seconds before the module writes a point. When this value is set to 0:00, write operations only occur at start-up or when the input value changes.

The Custom Settings section allows you to specify the Object Type, Property, and Data Type of the bound object. See the ANSI/ASHRAE standard, SPC 135 for more information. The Data Type field values are Boolean (1), Unsigned (2), Integer (3), Real (4), Double (5), or Enumerated (9).

The Device Instance or Name parameter allows you to set the BACnet device instance (read as the device instance if all the characters are numbers) or the name (read as the name if any of the characters are not numbers). When this parameter is used as a name, it uses the Who-Has BACnet service to find the object. A value of “this-device”

Microblock

Microblock Library icon

30 • Chapter 2: BACnet Client Microblocks

Page 31: Eikon 3.02 Microblock Reference

BACnet Client Write Binary

indicates that the BACnet property is in this device; this allows for communication with the device without generating traffic on the network. A value of “default” allows you to enter the remote device information on the module driver page. This information is used to insert multiple BACnet Client microblocks that are referencing the same remote device into a GFB. To disable this parameter, enter “no-value.”

The Network # parameter allows you to enter the BACnet network number of the segment but if the module is on the same network, enter “local”. The MAC Address parameter allows you to enter the MAC Address. The letter ‘h’ at the end of either of these strings indicates that the string is hexadecimal. To disable either of these parameters, enter “no-value.”

NOTE If the Network # and MAC Address are entered, they will be used for dynamic binding instead of the Device Name. But for static binding to occur, the Object Instance, Network #, MAC Address, and Device Instance are required.

If a field is not used, enter “no-value.” When “no-value” is entered, the BACnet Client microblock uses the Who-Is or Who-Has BACnet services to locate and dynamically bind to the BACnet object for communication. Only remote devices that are BACnet Class 3 or higher can support dynamic binding.

Chapter 2: BACnet Client Microblocks • 31

Page 32: Eikon 3.02 Microblock Reference

BACnet Client Write Binary

Figure 2-4: BACnet Client Write Binary Property dialog

32 • Chapter 2: BACnet Client Microblocks

Page 33: Eikon 3.02 Microblock Reference

BACnet Client Synchronize Analog

BACnet Client Synchronize Analog

The BACnet Client Synchronize Analog microblock synchronizes the following types of data:

• Unsigned Integer

• Signed Integer

• Real

• Double

• Enumerated

• Boolean

The BACnet Communications section on the microblock dialog allows you to enable BACnet communications on this point. Disable this parameter for troubleshooting.

The Simulation section on the microblock dialog allows you to define a value for this microblock that will be used during Eikon’s simulation. For details about using simulation to test the operation of a GFB, refer to the section “Testing the GFB” of the Eikon User’s Guide.

The Enable Two-way synchronization parameter allows the Value parameter in the SuperVision database to be synchronized with the remote BACnet Object that the microblock is bound to. If the parameter is set to yes, the microblock sends periodic read services and changes the Value parameter if the remote BACnet property changes. It sends a write service if the SuperVision Value is changed. If the Enable Two-way synchronization is set to no, the microblock periodically writes the Value parameter to the remote BACnet property.

NOTE If Enable Two-way synchronization is set to yes, any change of the remote BACnet Object’s value updates the Value parameter. This causes a parameter mis-match of the GFB. The module parameters need to be transferred to the SuperVision database to complete the update.

Microblock

Microblock Library icon

Chapter 2: BACnet Client Microblocks • 33

Page 34: Eikon 3.02 Microblock Reference

BACnet Client Synchronize Analog

The Read on first execution parameter is only applicable if Enable Two-way synchronization is set to yes. If set to no, the Value parameter is initially written to the remote BACnet Object. If Read on first execution is yes, the remote BACnet property’s state is read and updates the Value parameter.

Assign settings for the remote BACnet objects that you want to communicate with in the Bind Settings section of the microblock dialog. The Object Instance or Name parameter allows you to set the instance number (read as the instance number if all the characters are numbers) or the name (read as the name if any of the characters are not numbers). When this parameter is used as an object name, it uses the Who-Has BACnet service to find the object. See the ANSI/ASHRAE standard, SPC 135 for more information on the Who-Has service. The Object Type can be set to AI, AO, AV, BI, BO, BV or Custom for this microblock. If set to Custom, you must provide information in the Custom Settings section.

The Refresh Time allows you to set a time interval in minutes and seconds before the module synchronizes the points. If Enable Two-way synchronization is set to no, the Refresh Time indicates how frequently it writes. If set to yes, the refresh timer indicates how frequently it reads.

The Value parameter is the SuperVision value that the microblock synchronizes with in the remote BACnet Object’s property value. This represents the state of the remote BACnet Object’s property that the microblock is bound to. When two-way synchronization is enabled, the Value can be changed in SuperVision or in the remote BACnet device. Synchronization microblocks are most useful for interfacing with BACnet devices that are not directly accessible to SuperVision.

The Custom Settings section allows you to specify the Object Type, Property, and Data Type of the bound object. See the ANSI/ASHRAE standard, SPC 135 for more information. The Data Type field values are Boolean (1), Unsigned (2), Integer (3), Real (4), Double (5), or Enumerated (9).

The Device Instance or Name parameter allows you to set the BACnet device instance (read as the device instance if all the characters are numbers) or the name (read as the name if any of the characters are not numbers). When this parameter is used as a name, it uses the Who-Has BACnet service to find the object. A value of “this-device”

34 • Chapter 2: BACnet Client Microblocks

Page 35: Eikon 3.02 Microblock Reference

BACnet Client Synchronize Analog

indicates that the BACnet property is in this device; this allows for communication with the device without generating traffic on the network. A value of “default” allows you to enter the remote device information on the module driver page. This information is used to insert multiple BACnet Client microblocks that are referencing the same remote device into a GFB. To disable this parameter, enter “no-value.”

The Network # parameter allows you to enter the BACnet network number of the segment but if the module is on the same network, enter “local”. The MAC Address parameter allows you to enter the MAC Address. The letter ‘h’ at the end of either of these strings indicates that the string is hexadecimal. To disable either of these parameters, enter “no-value.”

NOTE If the Network # and MAC Address are entered, they will be used for dynamic binding instead of the Device Name. But for static binding to occur, the Object Instance, Network #, MAC Address, and Device Instance are required.

If a field is not used, enter “no-value.” When “no-value” is entered, the BACnet Client microblock uses the Who-Is or Who-Has BACnet services to locate and dynamically bind to the BACnet object for communication. Only remote devices that are BACnet Class 3 or higher can support dynamic binding.

Chapter 2: BACnet Client Microblocks • 35

Page 36: Eikon 3.02 Microblock Reference

BACnet Client Synchronize Analog

Figure 2-5: BACnet Client Synchronize Analog Property dialog

36 • Chapter 2: BACnet Client Microblocks

Page 37: Eikon 3.02 Microblock Reference

BACnet Client Synchronize Binary

BACnet Client Synchronize Binary

The BACnet Client Write Binary microblock synchronizes only binary data.

The BACnet Communications section on the microblock dialog allows you to enable BACnet communications on this point. Disable this parameter for troubleshooting.

The Simulation section on the microblock dialog allows you to define a value for this microblock that will be used during Eikon’s simulation. For details about using simulation to test the operation of a GFB, refer to the section “Testing the GFB” of the Eikon User’s Guide.

The Enable Two-way synchronization parameter allows the Value parameter in the SuperVision database to be synchronized with the remote BACnet Object that the microblock is bound to. If the parameter is set to yes, the microblock sends periodic read services and changes the Value parameter if the remote BACnet property changes. It sends a write service if the SuperVision Value is changed. If the Enable Two-way synchronization is set to no, the microblock periodically writes the Value parameter to the remote BACnet property.

NOTE If Enable Two-way synchronization is set to yes, any change of the remote BACnet Object’s value updates the Value parameter. This causes a parameter mis-match of the GFB. The module parameters need to be transferred to the SuperVision database to complete the update.

The Read on first execution parameter is only applicable if Enable Two-way synchronization is set to yes. If set to no, the Value parameter is initially written to the remote BACnet Object. If Read on first execution is yes, the remote BACnet property’s state is read and updates the Value parameter.

Assign settings for the remote BACnet objects that you want to communicate with in the Bind Settings section of the microblock dialog. The Object Instance or Name parameter allows you to set the instance number (read as the instance number if all the characters are numbers) or the name (read as the name if any of the characters are not numbers). When this parameter is used as an object name, it uses the

Microblock

Microblock Library icon

Chapter 2: BACnet Client Microblocks • 37

Page 38: Eikon 3.02 Microblock Reference

BACnet Client Synchronize Binary

Who-Has BACnet service to find the object. See the ANSI/ASHRAE standard, SPC 135 for more information on the Who-Has service. The Object Type can be set to BI, BO, BV or Custom for this microblock. If set to Custom, you must provide information in the Custom Settings section.

The Refresh Time allows you to set a time interval in minutes and seconds before the module synchronizes the points. If Enable Two-way synchronization is set to no, the Refresh Time indicates how frequently it writes. If set to yes, the refresh timer indicates how frequently it reads.

The Value parameter is the SuperVision value that the microblock synchronizes with in the remote BACnet Object’s property value. This represents the state of the remote BACnet Object’s property that the microblock is bound to. When two-way synchronization is enabled, the Value can be changed in SuperVision or in the remote BACnet device. Synchronization microblocks are most useful for interfacing with BACnet devices that are not directly accessible to SuperVision.

The Custom Settings section allows you to specify the Object Type, Property, and Data Type of the bound object. See the ANSI/ASHRAE standard, SPC 135 for more information. The Data Type field values are Boolean (1), Unsigned (2), Integer (3), Real (4), Double (5), or Enumerated (9).

The Device Instance or Name parameter allows you to set the BACnet device instance (read as the device instance if all the characters are numbers) or the name (read as the name if any of the characters are not numbers). When this parameter is used as a name, it uses the Who-Has BACnet service to find the object. A value of “this-device” indicates that the BACnet property is in this device; this allows for communication with the device without generating traffic on the network. A value of “default” allows you to enter the remote device information on the module driver page. This information is used to insert multiple BACnet Client microblocks that are referencing the same remote device into a GFB. To disable this parameter, enter “no-value.”

38 • Chapter 2: BACnet Client Microblocks

Page 39: Eikon 3.02 Microblock Reference

BACnet Client Synchronize Binary

The Network # parameter allows you to enter the BACnet network number of the segment but if the module is on the same network, enter “local”. The MAC Address parameter allows you to enter the MAC Address. The letter ‘h’ at the end of either of these strings indicates that the string is hexadecimal. To disable either of these parameters, enter “no-value.”

NOTE If the Network # and MAC Address are entered, they will be used for dynamic binding instead of the Device Name. But for static binding to occur, the Object Instance, Network #, MAC Address, and Device Instance are required.

If a field is not used, enter “no-value.” When “no-value” is entered, the BACnet Client microblock uses the Who-Is or Who-Has BACnet services to locate and dynamically bind to the BACnet object for communication. Only remote devices that are BACnet Class 3 or higher can support dynamic binding.

Chapter 2: BACnet Client Microblocks • 39

Page 40: Eikon 3.02 Microblock Reference

BACnet Client Synchronize Binary

Figure 2-6: BACnet Client Synchronize Binary Property dialog

♦ ♦ ♦

40 • Chapter 2: BACnet Client Microblocks

Page 41: Eikon 3.02 Microblock Reference

3 BACnet Microblocks

The BACnet menu contains microblocks that are used to communicate values with devices that use the BACnet communications protocol. Use these microblocks instead of the corresponding microblocks on the I/O, SysIn, and SysOut menus when you want to make this information available to BACnet devices.

NOTE All the microblocks on the BACnet menu require Exec version 6.0 or greater. Up to 1,000 BACnet microblocks can be used in each control module.

The following BACnet microblocks are available:

BACnet Analog Input 42

BACnet Binary Input 45

BACnet Analog Output 48

BACnet Binary Output 51

BACnet Binary Parameter 54

BACnet Analog Parameter 56

BACnet Binary Status 58

BACnet Analog Status 60

Chapter 3: BACnet Microblocks • 41

Page 42: Eikon 3.02 Microblock Reference

BACnet Analog Input

BACnet Analog Input

The BACnet Analog Input microblock reads the value of a physical input and makes this value available to be read by other BACnet devices on the CMnet. The value appears to other BACnet devices as the Present Value Property of a BACnet Analog Input Object. The raw data from the device is converted to the appropriate units (like mA, degrees Fahrenheit, or psi) using the Offset, Gain, and Units parameters. You can assign a name to each input which appears on the face of the microblock and is used as the name of the BACnet object. Each BACnet point in a control module should have a unique name, even when the points are located in different Graphic Function Blocks (GFBs).

The Object ID is a unique ID that identifies this point to other BACnet devices on the CMnet. The ID consists of the object type and an instance number. The object type is fixed at Analog Input, while the instance number can be determined by the Instance setting on the microblock dialog or the Parameter page. Each BACnet Analog Input in a control module must have a unique instance number, even if the microblocks are in different GFBs. If two BACnet Analog Inputs in the same module have the same instance number, other BACnet devices may communicate with the wrong microblock. The instance number can be any positive whole number up to 4,194,303. An instance number of 0 prevents the microblock from being able to communicate with other BACnet devices but does not affect the microblock’s operation within the GFB.

The Expander setting indicates the number of the expander module (normally 0-5 or 0-6). The Channel setting indicates which input on the hardware module this microblock represents. The Offset and Gain values are used to convert the raw data to a meaningful value used by the Graphic Function Block (GFB). The Technical Instructions document for your hardware module or the Technical Handbook can provide you with guidelines for determining the Expander, Channel, Offset, and Gain settings. These settings can be adjusted on the Parameter page using the chan, exp, offs, and gain parameters, respectively; however, these settings should not need to be adjusted after the initial installation unless the input point on the module is changed.

Microblock

Microblock Library icon

42 • Chapter 3: BACnet Microblocks

Page 43: Eikon 3.02 Microblock Reference

BACnet Analog Input

The Units setting indicates what unit the value is measured in. You can scroll through the most common unit types by clicking and holding the left mouse button on the unit name setting. If the unit you need is not listed, enter the unit’s number in the unit number field. A list of available engineering units and their corresponding unit numbers is available in the section “Units” on page 62.

The Trend section on the microblock dialog allows you to enable trending on this point and set the trend interval. The interval can be measured in seconds or minutes. For more information about trending and setting the trend parameters, refer to the SuperVision User’s Guide.

The Simulation section on the microblock dialog allows you to define a value for this microblock that will be used during Eikon’s simulation. For details about using simulation to test the operation of a GFB, refer to the section “Testing the FB” of the Eikon User’s Guide.

On the Parameter page, the lock setting allows you to define a value for the microblock which will be used instead of the actual value read by the module. Set the lock parameter to N to use the actual value read by the module.

Chapter 3: BACnet Microblocks • 43

Page 44: Eikon 3.02 Microblock Reference

BACnet Analog Input

Figure 3-1: BACnet Analog Input microblock dialog

Parameter page text

________________(BAI) exp ___ chan __ lock _ _____________ offs _____ gain ______ units (_____) trend: _ secs _ interval ___ sec report _ display range: ______ ______ BACnet Object ID: (Analog Input, Instance _____________)

Status page text

~~~~~~~~~~~~~~~~(BAI) lock ~ ~~~~~~~~~~~~~ (~~~~~) BACnet Object ID: (Analog Input, Instance ~~~~~~~~~~~~~)

44 • Chapter 3: BACnet Microblocks

Page 45: Eikon 3.02 Microblock Reference

BACnet Binary Input

BACnet Binary Input

The BACnet Binary Input microblock reads the on or off value of a physical input on the module and makes this value available to be read by other BACnet devices on the CMnet. The value appears to other BACnet devices as the Present Value Property of a BACnet Binary Input Object. You can assign a name to each input which appears on the face of the microblock and is used as the name of the BACnet object. Each BACnet point in a control module should have a unique name, even when the points are located in different Graphic Function Blocks (GFBs).

The Object ID is a unique ID that identifies this point to other BACnet devices on the CMnet. The ID consists of the object type and an instance number. The object type is fixed at Binary Input, while the instance number can be determined by the Instance setting on the microblock dialog or the Parameter page. Each BACnet Binary Input in a control module must have a unique instance number, even if the microblocks are in different GFBs. If two BACnet Binary Inputs in the same module have the same instance number, other BACnet devices may communicate with the wrong microblock. The instance number can be any positive whole number up to 4,194,303. An instance number of 0 prevents the microblock from being able to communicate with other BACnet devices but does not affect the microblock’s operation within the GFB.

The Expander setting indicates the number of the expander module (normally 0-5 or 0-6). The Channel setting indicates which input on the hardware module this microblock represents. The Technical Instructions document for your hardware module or the Technical Handbook can provide you with guidelines for determining the Expander and Channel settings. These settings can be adjusted on the Parameter page using the chan and exp parameters, respectively; however, these settings should not need to be adjusted after the initial installation unless the input point on the module is changed.

The Trend section on the microblock dialog allows you to enable trending on this point and set the trend interval. The interval can be measured in seconds or minutes. For more information about trending and setting the trend parameters, refer to the SuperVision User’s Guide.

Microblock

Microblock Library icon

Chapter 3: BACnet Microblocks • 45

Page 46: Eikon 3.02 Microblock Reference

BACnet Binary Input

The Simulation section on the microblock dialog allows you to define a value for this microblock that will be used during Eikon’s simulation. For details about using simulation to test the operation of a GFB, refer to the section “Testing the FB” of the Eikon User’s Guide.

On the Parameter page, the lock setting allows you to define a value for the microblock which will be used instead of the actual value read by the module. Set the lock parameter to N to use the actual value read by the module. The fail setting indicates what the value of the microblock should default to when the equipment is turned off. The fail setting also corresponds to the Polarity property of the BACnet Binary Input Object. When fail is set to no, the Polarity property is Normal. When fail is set to yes, the Polarity property is Reverse.

Figure 3-2: BACnet Binary Input microblock dialog

46 • Chapter 3: BACnet Microblocks

Page 47: Eikon 3.02 Microblock Reference

BACnet Binary Input

Parameter page text

________________(BBI) exp ___ chan __ lock _ ___ fail ___ trend: _ secs _ interval ___ sec report _ BACnet Object ID: (Binary Input, Instance _____________)

Status page text

~~~~~~~~~~~~~~~~(BBI) lock ~ ~~~ BACnet Object ID: (Binary Input, Instance ~~~~~~~~~~~~~)

Chapter 3: BACnet Microblocks • 47

Page 48: Eikon 3.02 Microblock Reference

BACnet Analog Output

BACnet Analog Output

The BACnet Analog Output microblock sends a value from the GFB to a physical output on the module and makes this value available to other BACnet devices on the CMnet. Any BACnet device on the CMnet can read or change the value of this output as long as the device uses a priority higher than 16 (or, if the lock parameter is set to Y, a priority higher than 8). The value appears to other BACnet devices as the Present Value Property of a BACnet Analog Output Object. You can assign a name to each output which appears on the face of the microblock and is used as the name of the BACnet object. Each BACnet point in a control module should have a unique name, even when the points are located in different Graphic Function Blocks (GFBs).

The Object ID is a unique ID that identifies this point to other BACnet devices on the CMnet. The ID consists of the object type and an instance number. The object type is fixed at Analog Output, while the instance number can be determined by the Instance setting on the microblock dialog or the Parameter page. Each BACnet Analog Output in a control module must have a unique instance number, even if the microblocks are in different GFBs. If two BACnet Analog Outputs in the same module have the same instance number, other BACnet devices may communicate with the wrong microblock. The instance number can be any positive whole number up to 4,194,303. An instance number of 0 prevents the microblock from being able to communicate with other BACnet devices but does not affect the microblock’s operation within the GFB.

The Expander setting indicates the number of the expander module (normally 0-5 or 0-6). The Channel setting indicates which output on the hardware module this microblock represents. The Offset and Gain values are used to convert the microblock’s value to a form that is used by the module. The Technical Instructions document for your hardware module or the Technical Handbook can provide you with guidelines for determining the Expander, Channel, Offset, and Gain settings. These settings can be adjusted on the Parameter page using the chan, exp, offs, and gain parameters, respectively; however, these settings should not need to be adjusted after the initial installation unless the output point on the module is changed.

Microblock

Microblock Library icon

48 • Chapter 3: BACnet Microblocks

Page 49: Eikon 3.02 Microblock Reference

BACnet Analog Output

The Units setting indicates what unit the value is measured in. You can scroll through the most common unit types by clicking and holding the left mouse button on the unit name setting. If the unit you need is not listed, enter the unit’s number in the unit number field. A list of available engineering units and their corresponding unit numbers is available in the section “Units” on page 62.

The Trend section on the microblock dialog allows you to enable trending on this point and set the trend interval. The interval can be measured in seconds or minutes. For more information about trending and setting the trend parameters, refer to the SuperVision User’s Guide.

On the Parameter page, the lock setting allows you to override the microblock’s actual value. When the lock parameter is set to Y, the value of the microblock is written using BACnet priority 8. When the lock parameter is set to N, the value of the microblock is written using BACnet priority 16. Set the lock parameter to N to use the actual value of the microblock. The Status page shows the BACnet priority level currently being used by this microblock. The priority ranges from 1 to 16, with 1 being the highest priority.

Chapter 3: BACnet Microblocks • 49

Page 50: Eikon 3.02 Microblock Reference

BACnet Analog Output

Figure 3-3: BACnet Analog Output microblock dialog

Parameter page text

________________(BAO) exp ___ chan __ lock _ _____________ offs _____ gain ______ units (_____) trend: _ secs _ interval ___ sec report _ display range: ______ ______ BACnet Object ID: (Analog Output, Instance _____________)

Status page text

~~~~~~~~~~~~~~~~(BAO) lock ~ ~~~~~~~~~~~~~ (~~~~~) priority ~~ BACnet Object ID: (Analog Output, Instance ~~~~~~~~~~~~~)

50 • Chapter 3: BACnet Microblocks

Page 51: Eikon 3.02 Microblock Reference

BACnet Binary Output

BACnet Binary Output

The BACnet Binary Output microblock transmits the on or off value from the GFB to a physical output on the module and makes this value available to other BACnet devices on the CMnet. Any BACnet device on the CMnet can read or change the value of this output as long as the device uses a priority higher than 16 (or, if the lock parameter is set to Y, a priority higher than 8). The value appears to other BACnet devices as the Present Value Property of a BACnet Binary Output Object. You can assign a name to each output which appears on the face of the microblock and is used as the name of the BACnet object. Each BACnet point in a control module should have a unique name, even when the points are located in different Graphic Function Blocks (GFBs).

The Object ID is a unique ID that identifies this point to other BACnet devices on the CMnet. The ID consists of the object type and an instance number. The object type is fixed at Binary Output, while the instance number can be determined by the Instance setting on the microblock dialog or the Parameter page. Each BACnet Binary Output in a control module must have a unique instance number, even if the microblocks are in different GFBs. If two BACnet Binary Outputs in the same module have the same instance number, other BACnet devices may communicate with the wrong microblock. The instance number can be any positive whole number up to 4,194,303. An instance number of 0 prevents the microblock from being able to communicate with other BACnet devices but does not affect the microblock’s operation within the GFB.

The Expander setting indicates the number of the expander module (normally 0-5 or 0-6). The Channel setting indicates which output on the hardware module this microblock represents. The Technical Instructions document for your hardware module or the Technical Handbook can provide you with guidelines for determining the Expander and Channel settings. These settings can be adjusted on the Parameter page using the chan and exp parameters, respectively; however, these settings should not need to be adjusted after the initial installation unless the output point on the module is changed.

The Trend section on the microblock dialog allows you to enable trending on this point and set the trend interval. The interval can be measured in seconds or minutes. For more information about

Microblock

Microblock Library icon

Chapter 3: BACnet Microblocks • 51

Page 52: Eikon 3.02 Microblock Reference

BACnet Binary Output

trending and setting the trend parameters, refer to the SuperVision User’s Guide.

On the Parameter page, the lock setting allows you to override the microblock’s actual value. When the lock parameter is set to Y, the value of the microblock is written using BACnet priority 8. When the lock parameter is set to N, the value of the microblock is written using BACnet priority 16. Set the lock parameter to N to use the actual value of the microblock. The Status page shows the BACnet priority level currently being used by this microblock. The priority ranges from 1 to 16, with 1 being the highest priority.

The fail setting indicates what the value of the microblock should default to in the event the module is unable to communicate with the equipment (such as a power failure in the module). The fail setting also corresponds to the Polarity property of the BACnet Binary Output Object. When fail is set to no, the Polarity property is Normal. When fail is set to yes, the Polarity property is Reverse.

Figure 3-4: BACnet Binary Output microblock dialog

52 • Chapter 3: BACnet Microblocks

Page 53: Eikon 3.02 Microblock Reference

BACnet Binary Output

Parameter page text

________________(BBO) exp ___ chan __ lock _ ___ fail ___ trend: _ secs _ interval ___ sec report _ BACnet Object ID: (Binary Output, Instance _____________)

Status page text

~~~~~~~~~~~~~~~~(BBO) lock ~ ~~~ priority ~~ BACnet Object ID: (Binary Output, Instance ~~~~~~~~~~~~~)

Chapter 3: BACnet Microblocks • 53

Page 54: Eikon 3.02 Microblock Reference

BACnet Binary Parameter

BACnet Binary Parameter

BACnet Binary Parameter microblocks are used to create a yes or no, on or off signal to be sent to another microblock in the GFB. Any BACnet device on the CMnet can read or change the value of this parameter. If no BACnet device changes the value of this parameter, the default value is used. The value appears to other BACnet devices as the Present Value Property of a BACnet Binary Value Object. You can assign a name to each parameter which appears on the face of the microblock and is used as the name of the BACnet object. Each BACnet microblock in a control module should have a unique name, even when the microblocks are located in different Graphic Function Blocks (GFBs).

The Object ID is a unique ID that identifies this point to other BACnet devices on the CMnet. The ID consists of the object type and an instance number. The object type is fixed at Binary Value, while the instance number can be determined by the Instance setting on the microblock dialog or the Parameter page. Each BACnet Binary Parameter and Binary Status microblock in a control module must have a unique instance number, even if the microblocks are in different GFBs. If two BACnet Binary Value microblocks in the same module have the same instance number, other BACnet devices may communicate with the wrong microblock. The instance number can be any positive whole number up to 4,194,303. An instance number of 0 prevents the microblock from being able to communicate with other BACnet devices but does not affect the microblock’s operation within the GFB.

The microblock can be assigned a default value on the microblock dialog. You can edit the Parameter screen prompt text and Status screen descriptive text on the microblock dialog to provide a meaningful description of the microblock’s use on the Parameter page and Status pages.

Microblock

Microblock Library icon

54 • Chapter 3: BACnet Microblocks

Page 55: Eikon 3.02 Microblock Reference

BACnet Binary Parameter

Figure 3-5: BACnet Binary Value Parameter microblock dialog

Parameter page text

________________(BBV) ___ BACnet Object ID: (Binary Value, Instance _____________)

Status page text

~~~~~~~~~~~~~~~~(BBV) ~~~ priority ~~ BACnet Object ID: (Binary Value, Instance ~~~~~~~~~~~~~)

Chapter 3: BACnet Microblocks • 55

Page 56: Eikon 3.02 Microblock Reference

BACnet Analog Parameter

BACnet Analog Parameter

BACnet Analog Parameter microblocks are used to specify a numeric value to be sent to another microblock in the GFB. Any BACnet device on the CMnet can read or change the value of this parameter. If no BACnet device changes the value of this parameter, the default value is used. The value appears to other BACnet devices as the Present Value Property of a BACnet Analog Value Object. You can assign a name to each parameter which appears on the face of the microblock and is used as the name of the BACnet object. Each BACnet microblock in a control module should have a unique name, even when the microblocks are located in different Graphic Function Blocks (GFBs).

The Object ID is a unique ID that identifies this point to other BACnet devices on the CMnet. The ID consists of the object type and an instance number. The object type is fixed at Analog Value, while the instance number can be determined by the Instance setting on the microblock dialog or the Parameter page. Each BACnet Analog Parameter and Analog Status microblock in a control module must have a unique instance number, even if the microblocks are in different GFBs. If two BACnet Analog Value microblocks in the same module have the same instance number, other BACnet devices may communicate with the wrong microblock. The instance number can be any positive whole number up to 4,194,303. An instance number of 0 prevents the microblock from being able to communicate with other BACnet devices but does not affect the microblock’s operation within the GFB.

The Units setting indicates what unit the value is measured in. You can scroll through the most common unit types by clicking and holding the left mouse button on the unit name setting. If the unit you need is not listed, enter the unit’s number in the unit number field. A list of available engineering units and their corresponding unit numbers is available in the section “Units” on page 62.

The microblock can be assigned a default value on the microblock dialog. You can edit the Parameter screen prompt text and Status screen descriptive text on the microblock dialog to provide a meaningful description of the microblock’s use on the Parameter page and Status pages.

Microblock

Microblock Library icon

56 • Chapter 3: BACnet Microblocks

Page 57: Eikon 3.02 Microblock Reference

BACnet Analog Parameter

Figure 3-6: BACnet Analog Value Parameter microblock dialog

Parameter page text

________________(BAV) _____________ units (_____) BACnet Object ID: (Analog Value, Instance _____________)

Status page text

~~~~~~~~~~~~~~~~(BAV) ~~~~~~~~~~~~~ (~~~~~) priority ~~ BACnet Object ID: (Analog Value, Instance ~~~~~~~~~~~~~)

Chapter 3: BACnet Microblocks • 57

Page 58: Eikon 3.02 Microblock Reference

BACnet Binary Status

BACnet Binary Status

BACnet Binary Status microblocks display a yes/no or on/off value from the GFB. Any BACnet device on the CMnet can read the value of this microblock. The value appears to other BACnet devices as the Present Value Property of a BACnet Binary Value Object. You can assign a name to the microblock which appears on the face of the microblock and is used as the name of the BACnet object. Each BACnet microblock in a control module should have a unique name, even when the microblocks are located in different Graphic Function Blocks (GFBs).

The Object ID is a unique ID that identifies this point to other BACnet devices on the CMnet. The ID consists of the object type and an instance number. The object type is fixed at Binary Value, while the instance number can be determined by the Instance setting on the microblock dialog or the Parameter page. Each BACnet Binary Parameter and Binary Status microblock in a control module must have a unique instance number, even if the microblocks are in different GFBs. If two BACnet Binary Value microblocks in the same module have the same instance number, other BACnet devices may communicate with the wrong microblock. The instance number can be any positive whole number up to 4,194,303. An instance number of 0 prevents the microblock from being able to communicate with other BACnet devices but does not affect the microblock’s operation within the GFB.

You can edit the Parameter screen prompt text and Status screen descriptive text on the microblock dialog to provide a meaningful description of the microblock’s use on the Parameter and Status pages.

Microblock

Microblock Library icon

58 • Chapter 3: BACnet Microblocks

Page 59: Eikon 3.02 Microblock Reference

BACnet Binary Status

Figure 3-7: BACnet Binary Value Status microblock dialog

Parameter page text

________________(BBV) BACnet Object ID: (Binary Value, Instance _____________)

Status page text

~~~~~~~~~~~~~~~~(BBV) ~~~ BACnet Object ID: (Binary Value, Instance ~~~~~~~~~~~~~)

Chapter 3: BACnet Microblocks • 59

Page 60: Eikon 3.02 Microblock Reference

BACnet Analog Status

BACnet Analog Status

BACnet Analog Status microblocks display the numeric value from the GFB. Any BACnet device on the CMnet can read the value of this microblock. The value appears to other BACnet devices as the Present Value Property of a BACnet Analog Value Object. You can assign a name to the microblock which appears on the face of the microblock and is used as the name of the BACnet object. Each BACnet microblock in a control module should have a unique name, even when the microblocks are located in different Graphic Function Blocks (GFBs).

The Object ID is a unique ID that identifies this point to other BACnet devices on the CMnet. The ID consists of the object type and an instance number. The object type is fixed at Analog Value, while the instance number can be determined by the Instance setting on the microblock dialog or the Parameter page. Each BACnet Analog Parameter and Analog Status microblock in a control module must have a unique instance number, even if the microblocks are in different GFBs. If two BACnet Analog Value microblocks in the same module have the same instance number, other BACnet devices may communicate with the wrong microblock. The instance number can be any positive whole number up to 4,194,303. An instance number of 0 prevents the microblock from being able to communicate with other BACnet devices but does not affect the microblock’s operation within the GFB.

The Units setting indicates what unit the value is measured in. You can scroll through the most common unit types by clicking and holding the left mouse button on the unit name setting. If the unit you need is not listed, enter the unit’s number in the unit number field. A list of available engineering units and their corresponding unit numbers is available in the section “Units” on page 62.

Microblock

Microblock Library icon

60 • Chapter 3: BACnet Microblocks

Page 61: Eikon 3.02 Microblock Reference

BACnet Analog Status

Figure 3-8: BACnet Analog Value Status microblock dialog

Parameter page text

________________(BAV) units (_____) BACnet Object ID: (Analog Value, Instance _____________)

Status page text

~~~~~~~~~~~~~~~~(BAV) ~~~~~~~~~~~~~ (~~~~~) BACnet Object ID: (Analog Value, Instance ~~~~~~~~~~~~~)

Chapter 3: BACnet Microblocks • 61

Page 62: Eikon 3.02 Microblock Reference

Units

Units

Area square-meters (0)square-feet (1)

Currency currency1 (105)currency2 (106)currency3 (107)currency4 (108)currency5 (109)currency6 (110)currency7 (111)currency8 (112)currency9 (113)currency10 (114)

Electrical milliamperes (2)amperes (3)ohms (4)kilohms (122)megohms (123)volts (5)millivolts (124)kilovolts (6)megavolts (7)volt-amperes (8)kilovolt-amperes (9)megavolt-amperes (10)volt-amperes-reactive (11)kilovolt-amperes-reactive (12)megavolt-amperes-reactive (13)degrees-phase (14)power-factor (15)

Energy joules (16)kilojoules (17)kilojoules-per-kilogram (125)megajoules (126)watt-hours (18)kilowatt-hours (19)btus (20)therms (21)ton-hours (22)

62 • Chapter 3: BACnet Microblocks

Page 63: Eikon 3.02 Microblock Reference

Units

Enthalpy joules-per-kilogram-dry-air (23)btus-per-pound-dry-air (24)

Entropy joules-per-degree-Kelvin (127)joules-per-kilogram-degree-Kelvin (128)

Frequency cycles-per-hour (25)cycles-per-minute (26)hertz (27)kilohertz (129)megahertz (130)per-hour (131)

Humidity grams-of-water-per-kilogram-dry-air (28)percent-relative-humidity (29)

Length millimeters (30)meters (31)inches (32)feet (33)

Light watts-per-square-foot (34)watts-per-square-meter (35)lumens (36)luxes (37)foot-candles (38)

Mass kilograms (39)pounds-mass (40)tons (41)

Mass Flow kilograms-per-second (42)kilograms-per-minute (43)kilograms-per-hour (44)pounds-mass-per-minute (45)pounds-mass-per-hour (46)

Power milliwatts (132)watts (47)kilowatts (48)megawatts (49)btus-per-hour (50)horsepower (51)tons-refrigeration (52)

Chapter 3: BACnet Microblocks • 63

Page 64: Eikon 3.02 Microblock Reference

Units

Pressure pascals (53)hectopascals (133)kilopascals (54)millibars (134)bars (55)pounds-force-per-square-inch (56)centimeters-of-water (57)inches-of-water (58)millimeters-of-mercury (59)centimeters-of-mercury (60)inches-of-mercury (61)

Temperature degrees-Celsius (62)degrees-Kelvin (63)degrees-Fahrenheit (64)degree-days-Celsius (65)degree-days-Fahrenheit (66)

Time years (67)months (68)weeks (69)days (70)hours (71)minutes (72)seconds (73)

Velocity meters-per-second (74)kilometers-per-hour (75)feet-per-second (76)feet-per-minute (77)miles-per-hour (78)

Volume cubic-feet (79)cubic-meters (80)imperial-gallons (81)liters (82)us-gallons (83)

64 • Chapter 3: BACnet Microblocks

Page 65: Eikon 3.02 Microblock Reference

Units

♦ ♦ ♦

Volumetric Flow cubic-feet-per-minute (84)cubic-meters-per-second (85)cubic-meters-per-hour (135)imperial-gallons-per-minute (86)liters-per-second (87)liters-per-minute (88)liters-per-hour (136)us-gallons-per-minute (89)

Other degrees-angular (90)degrees-Celsius-per-hour (91)degrees-Celsius-per-minute (92)degrees-Fahrenheit-per-hour (93)degrees-Fahrenheit-per-minute (94)kilowatt-hours-per-square-meter (137)kilowatt-hours-per-square-foot (138)megajoules-per-square-meter (139)megajoules-per-square-foot (140)no-units (95)parts-per-million (96)parts-per-billion (97)percent (98)percent-per-second (99)per-minute (100)per-second (101)psi-per-degree-Fahrenheit (102)radians (103)revolutions-per-minute (104)watts-per-square-meter-degree-kelvin (141)

Chapter 3: BACnet Microblocks • 65

Page 66: Eikon 3.02 Microblock Reference

Units

66 • Chapter 3: BACnet Microblocks

Page 67: Eikon 3.02 Microblock Reference

4 I/O Microblocks

The I/O menu contains input and output microblocks that are used to communicate values between the modules and the HVAC equipment, or between modules on the CMnet.

The following Input/Output Point microblocks are available:

Analog Input 69

Digital Input 71

Timed Local Override 73

Pulse to Analog 75

LAN Analog Input 78

LAN Digital Input 81

Analog Output 83

Digital Output 85

Floating Motor Output 87

Pulse-Width Output 90

LAN Analog Output 93

LAN Digital Output 96

Airflow Control 99

Chapter 4: I/O Microblocks • 67

Page 68: Eikon 3.02 Microblock Reference

LogiStat Zone Control 107

68 • Chapter 4: I/O Microblocks

Page 69: Eikon 3.02 Microblock Reference

Analog Input

Analog Input

The Analog Input microblock reads the value of a physical input on the module. The raw data from the sensor is converted to the appropriate range for its unit (like mA, degrees Fahrenheit, or psi) using the Offset and Gain settings. You can assign a name to each input which appears on the face of the microblock.

The Expander setting (Exec 4.x and 5.x only) indicates the number of the expander module (normally 0-5 or 0-6). The Channel setting indicates which input on the hardware module this microblock represents. The Offset and Gain values are used to convert the raw data to a meaningful value used by the Graphic Function Block (GFB). The Technical Instructions document for your hardware module or the Technical Handbook can provide you with guidelines for determining the Expander, Channel, Offset, and Gain settings. These settings can be adjusted on the Parameter page using the chan, exp, offs, and gain parameters, respectively; however, these settings should not need to be adjusted after the initial installation unless the input point on the module is changed.

The Trend section on the microblock dialog allows you to enable trending on this point and set the trend interval. The interval can be measured in seconds or minutes. When using this microblock in Exec 3.x modules, trends are enabled in the header of the Parameter page, not on the microblock dialog. For more information about trending and setting the trend parameters, refer to the SuperVision User’s Guide.

The Simulation section on the microblock dialog allows you to define a value for this microblock that will be used during Eikon’s simulation. For details about using simulation to test the operation of a GFB, refer to the section “Testing the FB” of the Eikon User’s Guide.

On the Parameter page, the lock setting allows you to define a value for the microblock which will be used instead of the actual value read by the module. Set the lock parameter to N to use the actual value read by the module.

Microblock

Microblock Library icon

Chapter 4: I/O Microblocks • 69

Page 70: Eikon 3.02 Microblock Reference

Analog Input

Figure 4-1: Analog Input microblock dialog (Exec 4.x)

Parameter page text (Exec 4.x)

________________(AI) exp ___ chan __ lock _ _____ offs _____ gain _____trend: _ secs _ interval ___ sec report _ display range: ______ ______

Status page text (Exec 4.x)

~~~~~~~~~~~~~~~~(AI) lock ~ ~~~~~

70 • Chapter 4: I/O Microblocks

Page 71: Eikon 3.02 Microblock Reference

Digital Input

Digital Input

The Digital Input microblock reads the on or off value of a physical input on the module. You can assign a name to each input which appears on the face of the microblock.

The Expander setting (Exec 4.x and 5.x only) indicates the number of the expander module (normally 0-5 or 0-6). The Channel setting indicates which input on the hardware module this microblock represents. The Technical Instructions document for your hardware module or the Technical Handbook can provide you with guidelines for determining the Expander and Channel settings. These settings can be adjusted on the Parameter page using the chan and exp parameters, respectively; however, these settings should not need to be adjusted after the initial installation unless the input point on the module is changed.

The Trend section on the microblock dialog allows you to enable trending on this point and set the trend interval. The interval can be measured in seconds or minutes. When using this microblock in Exec 3.x modules, trends are enabled in the header of the Parameter page, not on the microblock dialog. For more information about trending and setting the trend parameters, refer to the SuperVision User’s Guide.

The Simulation section on the microblock dialog allows you to define a value for this microblock that will be used during Eikon’s simulation. For details about using simulation to test the operation of a GFB, refer to the section “Testing the FB” of the Eikon User’s Guide.

On the Parameter page, the lock setting allows you to define a value for the microblock which will be used instead of the actual value read by the module. Set the lock parameter to N to use the actual value read by the module. The fail setting indicates what the value of the microblock should default to when the equipment is turned off.

When used with Exec 3.x modules, the Digital Input microblock can be configured to track the accumulated runtime of the equipment by setting the Acc runtime setting to yes. This causes the microblock to measure the amount of time in hours that the input has been on. A Runtime limit can also be configured; when this limit is reached, the input will automatically turn off. On the Parameter page, these settings can be adjusted using the runtime: clr and lim

Microblock

Microblock Library icon

Chapter 4: I/O Microblocks • 71

Page 72: Eikon 3.02 Microblock Reference

Digital Input

parameters. In Exec 4.x modules, use the Runtime Monitor microblock in the GFB to serve this function.

Figure 4-2: Digital Input microblock dialog (Exec 4.x)

Parameter page text (Exec 4.x )

________________(DI) exp ___ chan __ lock _ ___ fail ___ trend: _ secs _ interval ___ sec report _

Exec 4.x Status page text (Exec 4.x )

~~~~~~~~~~~~~~~~(DI) lock ~ ~~~

72 • Chapter 4: I/O Microblocks

Page 73: Eikon 3.02 Microblock Reference

Timed Local Override

Timed Local Override

The Timed Local Override (TLO) reads a time value from a local override device (like the Enhanced Room Sensor). This value can be used by a Time Clock with Override microblock to indicate a change in occupancy status. You can assign a name to the TLO which appears on the face of the microblock.

The Expander setting (Exec 4.x and 5.x only) indicates the number of the expander module (normally 0-5 or 0-6). The Channel setting indicates which input on the hardware module this microblock represents. The Technical Instructions document for your hardware module or the Technical Handbook can provide you with guidelines for determining the Expander and Channel settings. These settings can be adjusted on the Parameter page using the chan and exp parameters, respectively; however, these settings should not need to be adjusted after the initial installation unless the input point on the module is changed.

The TLO can operate in one of three ways: as a Pulse Input, a Fixed Width Input, or a Mechanical Input. When operating as a Pulse Input, the microblock reads the signal from a toggle switch or button. Each time the switch or button is pressed, the override is activated for a preset amount of time, defined by the Each pulse setting, up to a specified maximum which is defined by the Max accum setting. On the Parameter page, these settings can be adjusted using the For each pulse, add ____ (mm:ss), up to a maximum of _____ (mm:ss) parameters. Using the Pulse Input setting, you can also define a reset signal using the option Cancel override if input closed for > __ sec; this is the amount of time you must hold the override switch to cancel the override. On the Parameter page, this setting can be adjusted using the Hold Input for ___ (sec) to reset parameter.

Fixed Width operation is used in the same way as Pulse Input, except that the preset time cannot be extended and you cannot define a reset signal. Use the Each pulse setting to define the override time. On the Parameter page, you can define the override time using the Broadcast Request time parameter.

In Mechanical Timer mode, the override is enabled by a device that produces a constant signal such as a wind-up timer. Use the Input

Microblock

Microblock Library icon

Chapter 4: I/O Microblocks • 73

Page 74: Eikon 3.02 Microblock Reference

Timed Local Override

closed setting to define the amount of time the override will be in effect. On the Parameter page, you can change this setting using the Broadcast Request Time parameter.

NOTE The Time Local Override microblock has a maximum accumulated time of 546 minutes.

Figure 4-3: Timed Local Override microblock dialog (Exec 4.x)

Parameter text for Pulse Input (Exec 4.x)

________________(TLO) exp ___ chan __ lock _ ___ Mode=_ (1=Pulse;2=Timr;3=Fixed) Hold input for __ (sec) to reset For each pulse, add _____ (mm:ss), up to a maximum of _____ (mm:ss)

Parameter text for Fixed Width and Mechanical Input (Exec 4.x)

________________(TLO) exp ___ chan __ lock _ ___ Mode=_ (1=Pulse;2=Timr;3=Fixed)Broadcast Request time _____ (mm:ss)

Status page text (Exec 4.x)

~~~~~~~~~~~~~~~~(TLO) lock ~ ~~~ Override timer: ~~~~~ (mm:ss)

74 • Chapter 4: I/O Microblocks

Page 75: Eikon 3.02 Microblock Reference

Pulse to Analog

Pulse to Analog

The Pulse to Analog microblock counts pulses from a digital input over a specified period of time. The value of the microblock is determined by calculating the average number of pulses received over the specified time. You can assign a name to the input which appears on the face of the microblock.

The Expander setting (Exec 4.x and 5.x only) indicates the number of the expander module (normally 0-5 or 0-6). The Channel setting indicates which input on the hardware module this microblock represents. The Technical Instructions document for your hardware module or the Technical Handbook can provide you with guidelines for determining the Expander and Channel settings. These settings can be adjusted on the Parameter page using the chan and exp parameters, respectively; however, these settings should not need to be adjusted after the initial installation unless the input point on the module is changed.

The Gain setting determines the quantity that each pulse represents. The Pulse window setting determines the time period over which the rate is averaged. The average is calculated every minute using the following formula (where P is the number of pulses received over the duration of the pulse window, M is Pulse window setting, and G is the Gain setting):

The example below shows how this microblock can be used to calculate instantaneous demand.

Microblock

Microblock Library icon

PM----- G× microblock value=

Chapter 4: I/O Microblocks • 75

Page 76: Eikon 3.02 Microblock Reference

Pulse to Analog

Instantaneous Demand

Figure 4-4: Example of instantaneous demand using Pulse-to-Analog microblock

The Pulse-to-Analog microblock (labeled "KWH PULSE" in the diagram above) uses the following values: The Gain is the value of kilowatt-hours per pulse, which is provided by the electric company (in this case, 1 KWH/Pulse). The Pulse Window is the time period used to calculate the instantaneous demand (in this case, 30 minutes). The microblock’s value is multiplied by 60 to convert the result from kilowatt-hours per minute to kilowatt-hours. If 50 pulses are counted during the pulse window, the following result is calculated for instantaneous demand:

NOTE The Pulse to Analog microblock cannot count more than 4 pulses per second. Because of the delay associated with the T-Line sub-net, the use of this microblock in T-Line modules is not recommended or supported.

5030------ 1× 5

3--- 60× 100 KW= =

76 • Chapter 4: I/O Microblocks

Page 77: Eikon 3.02 Microblock Reference

Pulse to Analog

Figure 4-5: Pulse to Analog Input microblock dialog (Exec 4.x)

Parameter page text (Exec 4.x)

________________(DI) exp ___ chan __ Gain _____________ (units/pulse) Sample pulses over an interval of ~~~ (min)

Status page text (Exec 4.x)

~~~~~~~~~~~~~~~~(DI) lock ~ ~~~ Current rate = ~~~~~~~~~~~~~Current pulses this minute = ~~~~~

Chapter 4: I/O Microblocks • 77

Page 78: Eikon 3.02 Microblock Reference

LAN Analog Input

LAN Analog Input

The LAN Analog Input (LAN AI) microblock reads a value that is broadcast on the network by a LAN Analog Output (LAN AO) microblock. This broadcast value may be an actual physical value read in another module or a calculated value which is generated and broadcast by another GFB. You can assign a name to the input which appears on the face of the microblock.

LAN input and output microblocks are used to pass information between modules on the same CMnet. These microblocks are also used to pass broadcasted variables (heat or cool requests, demand, and outside air temperature, etc.) between modules on different CMnets which share the same LGnet. Variables that are used by many GFBs like outside air temperature and electrical demand are called global variables. To transmit these kinds of variables between different CMnets on the same LGnet, you can use one of the following GFBs (which are available at ALC’s web site, http:\\www.automatedlogic.com). Using one of these pre-designed GFBs will reduce the level of network traffic on the LGnet.

NOTE When receiving a Timed Local Override broadcast from a non-graphic function block, the input must be multiplied by 16. This is because the old-style broadcast is not 100% compatible with the new microblock.

Table 4-1. Recommended GFBs for Global Variables

GFB name Function

YOT Transmit Outside Air temperature

YOR Receive Outside Air temperature

YDT Transmit Electrical Demand

YDR Receive Electrical Demand

YRT Transmit accumulated Heat and Cool Requests

YRR Receive accumulated Heat and Cool Requests

Microblock

Microblock Library icon

78 • Chapter 4: I/O Microblocks

Page 79: Eikon 3.02 Microblock Reference

LAN Analog Input

The Inact value setting on the microblock’s dialog determines the value that the microblock uses when information from a LAN Analog Output is unavailable. The Simulation section of the dialog allows you to determine a cell number to read or a value for the microblock to use during Eikon simulation. For more information about using cells and Eikon simulation, refer to the section “Testing the FB” of the Eikon User’s Guide.

On the Parameter page, the lock setting allows you to define a value for the microblock which will be used instead of the microblock’s actual value. Set the lock parameter to N to use the actual value of the microblock.

Once a GFB using the LAN Analog Input microblock is complete, you must indicate which LAN Analog Output the LAN Analog Input receives information from. This is done by assigning special two-number addresses to the microblocks on each GFB’s Parameter page in SuperVision. The Listen to parameter for LAN Analog Input contains the address of the LAN Analog Output that the input gets its information from. For example, if a LAN Analog Input is used to receive information from a LAN Analog Output whose address is 101, 2, then the LAN Analog Input would have 101, 2 entered as its Listen to parameter. For information about assigning addresses to LAN Analog Outputs, refer to the section “LAN Analog Output” on page 93.

Figure 4-6: LAN Analog Input microblock dialog

Chapter 4: I/O Microblocks • 79

Page 80: Eikon 3.02 Microblock Reference

LAN Analog Input

Parameter page text

________________(GAI) lock _ _____ Listen to ___,__ Fail value _____

Status page text

~~~~~~~~~~~~~~~~(GAI) lock ~ Receiving Command ~~~ with Value ~~~~~

80 • Chapter 4: I/O Microblocks

Page 81: Eikon 3.02 Microblock Reference

LAN Digital Input

LAN Digital Input

The LAN Digital Input (LAN DI) microblock reads a value that is broadcast on the network by a LAN Digital Output (LAN DO) microblock. This broadcast value may be an actual physical value read in another module or a calculated value which is generated and broadcast by another GFB. You can assign a name to the input which appears on the face of the microblock.

LAN input and output microblocks are used to pass information between modules on the same CMnet. These microblocks are also used to pass broadcasted variables (heat or cool requests, demand, and outside air temperature, etc.) between modules on different CMnets which share the same LGnet. Variables that are used by many GFBs like outside air temperature and electrical demand are called global variables. To transmit these kinds of variables between different CMnets on the same LGnet, you can use one of the following GFBs (which are available at ALC’s web site, http:\\www.automatedlogic.com). Using one of these pre-designed GFBs will reduce the level of network traffic on the LGnet.

On the Parameter page, the lock setting allows you to define a value for the microblock which will be used instead of the microblock’s actual value. Set the lock parameter to N to use the actual value of the microblock.

Table 4-2. Recommended GFBs for Global Variables

GFB name Function

YOT Transmit Outside Air temperature

YOR Receive Outside Air temperature

YDT Transmit Electrical Demand

YDR Receive Electrical Demand

YRT Transmit accumulated Heat and Cool Requests

YRR Receive accumulated Heat and Cool Requests

Microblock

Microblock Library icon

Chapter 4: I/O Microblocks • 81

Page 82: Eikon 3.02 Microblock Reference

LAN Digital Input

Once a GFB using the LAN Digital Input microblock is complete, you must indicate which LAN Digital Output the LAN Digital Input receives information from. This is done by assigning special two-number addresses to the microblocks on each GFB’s Parameter page in SuperVision. The Listen to parameter for LAN Digital Input contains the address of the LAN Digital Output that the input gets its information from. For example, if a LAN Digital Input is used to receive information from a LAN Digital Output whose address is 101, 2, then the LAN Digital Input would have 101, 2 entered as its Listen to parameter. For information about assigning addresses to LAN Digital Outputs, refer to the section “LAN Digital Output” on page 96.

Figure 4-7: LAN Digital Input microblock dialog

Parameter page text

________________(GDI) lock _ ___ Listen to ___,__ Fail value ___

Status page text

~~~~~~~~~~~~~~~~(GDI) lock ~ Receiving ~~~ (not receiving)

82 • Chapter 4: I/O Microblocks

Page 83: Eikon 3.02 Microblock Reference

Analog Output

Analog Output

The Analog Output microblock sends a value from the GFB to a physical output on the module. The value received by this microblock from the GFB is converted to a signal which is read by the hardware module. You can assign a name to each input which appears on the face of the microblock.

The Expander setting (Exec 4.x and 5.x only) indicates the number of the expander module (normally 0-5 or 0-6). The Channel setting indicates which output on the hardware module this microblock represents. The Offset and Gain values are used to convert the microblock’s value to a form that is used by the module. The Technical Instructions document for your hardware module or the Technical Handbook can provide you with guidelines for determining the Expander, Channel, Offset, and Gain settings. These settings can be adjusted on the Parameter page using the chan, exp, offs, and gain parameters, respectively; however, these settings should not need to be adjusted after the initial installation unless the output point on the module is changed.

The Trend section on the microblock dialog allows you to enable trending on this point and set the trend interval. The interval can be measured in seconds or minutes. When using this microblock in Exec 3.x modules, trends are enabled in the header of the Parameter page, not on the microblock dialog. For more information about trending and setting the trend parameters, refer to the SuperVision User’s Guide.

On the Parameter page, the lock setting allows you to define a value for the microblock which will be used instead of the microblock’s actual value. Set the lock parameter to N to use the actual value of the microblock.

Microblock

Microblock Library icon

Chapter 4: I/O Microblocks • 83

Page 84: Eikon 3.02 Microblock Reference

Analog Output

Figure 4-8: Analog Output microblock dialog (Exec 4.x)

Parameter page text (Exec 4.x)

________________(AO) exp ___ chan __ lock _ _____ offs _____ gain ______ trend: _ secs _ interval ___ sec report _ display range: ______ ______

Status page text (Exec 4.x)

~~~~~~~~~~~~~~~~(AO) lock ~ ~~~~~

84 • Chapter 4: I/O Microblocks

Page 85: Eikon 3.02 Microblock Reference

Digital Output

Digital Output

The Digital Output microblock transmits the on or off value from the GFB to a physical output on the module. You can assign a name to each input which appears on the face of the microblock.

The Expander setting (Exec 4.x and 5.x only) indicates the number of the expander module (normally 0-5 or 0-6). The Channel setting indicates which output on the hardware module this microblock represents. The Technical Instructions document for your hardware module or the Technical Handbook can provide you with guidelines for determining the Expander and Channel settings. These settings can be adjusted on the Parameter page using the chan and exp parameters, respectively; however, these settings should not need to be adjusted after the initial installation unless the output point on the module is changed.

The Trend section on the microblock dialog allows you to enable trending on this point and set the trend interval. The interval can be measured in seconds or minutes. When using this microblock in Exec 3.x modules, trends are enabled in the header of the Parameter page, not on the microblock dialog. For more information about trending and setting the trend parameters, refer to the SuperVision User’s Guide.

On the Parameter page, the lock setting allows you to define a value for the microblock which will be used instead of the microblock’s actual value. Set the lock parameter to N to use the actual value of the microblock. The fail setting indicates what the value of the microblock should default to in the event the module is unable to communicate with the equipment (such as a power failure in the module).

When used with Exec 3.x modules, the Digital Output microblock can be configured to track the accumulated runtime of the equipment and define a minimum amount of time for the equipment to be on or off. The Minimum ON time setting (mon on the Parameter page) determines how long the output should stay on when the microblock sends an "on" signal to the module. The Minimum OFF time setting (moff on the Parameter page) determines how long the output should stay off when the microblock sends an "off" signal to the module. In Exec 4.x modules, use the Minimum On/Off Timer microblock to serve this function.

Microblock

Microblock Library icon

Chapter 4: I/O Microblocks • 85

Page 86: Eikon 3.02 Microblock Reference

Digital Output

Runtime can be tracked in Exec 3.x modules by setting the Acc runtime setting to yes. This causes the microblock to measure the amount of time in hours that the output has been on. A Runtime limit can also be configured; when this limit is reached, the input will automatically turn off. On the Parameter page, these settings can be adjusted using the runtime: clr and lim parameters. In Exec 4.x modules, use the Runtime Monitor microblock in the GFB to serve this function.

Figure 4-9: Digital Output microblock dialog (Exec 4.x)

Parameter page text (Exec 4.x)

________________(DO) exp ___ chan __ lock _ ___ fail ___ trend: _ secs _ interval ___ sec report _

Status page text (Exec 4.x)

~~~~~~~~~~~~~~~~(DO) lock ~ ~~~

86 • Chapter 4: I/O Microblocks

Page 87: Eikon 3.02 Microblock Reference

Floating Motor Output

Floating Motor Output

The Floating Motor Output is designed to work with an actuator that has a bidirectional motor triggered by two digital signals; for example, "clockwise" and "counterclockwise" or "damper open" and "damper closed." The microblock converts a "percent open" value from the GFB to "on" and "off" signals to two physical digital outputs on the module. The duration of the digital signal controls how long the motor is activated. When correctly calibrated, the duration of the signal is accurately determined by the percentage received by the microblock. You can assign a name which appears on the face of the Floating Motor Output microblock; additionally, you can assign names to the two digital points the microblock actually controls.

The Floating Motor microblock tracks the current position of the actuator based on the history of its movement since its last calibration. For example, if the actuator is at 60% open, and the microblock’s value is changed to 80%, the motor will be activated for the length of time required to open 20% (80% - 60%). In order for this method of control to be accurate, the Full travel time setting on the microblock’s dialog must be as accurate as possible. The Full travel time is the time it takes for the actuator to travel from fully open to fully closed. This setting can be adjusted on the Parameter page using the Full Span parameter. The example below shows how the Full travel time affects the microblock’s operation.

Example

The Full travel time of an actuator is 100 seconds, and the value of the Floating Motor Output is 10%. The motor is activated for 10 seconds to achieve a 10% open status. The value of the Floating Motor Output is later increased to 30% as the zone temperature increases. The motor is then activated for an additional 20 seconds to achieve a 30% open status (30% - 10% = 20% = 20 seconds).

NOTE The Floating Motor Output microblock will not send a signal shorter than one second. If you need to control the accuracy of the actuator’s position to within 1%, you must use an actuator with a travel time of at least 100 seconds. For example, if your actuator has a 20 second travel time, it can only be adjusted in increments of 5% (1 second/20 seconds = 5 seconds/100 seconds or 5%).

Microblock

Microblock Library icon

Chapter 4: I/O Microblocks • 87

Page 88: Eikon 3.02 Microblock Reference

Floating Motor Output

If the Full travel time is inaccurate, the calculated position of the actuator will also be inaccurate. Over time, multiple adjustments can cause the error to be quite large and affect the ability of the equipment to efficiently achieve the desired setpoint. For this reason it is recommended that you program the GFB to allow the Floating Motor Output microblock to recalibrate itself by using a value of 0% or 100%. When the microblock’s value is either 0% or 100%, the microblock recalibrates by sending an additional signal for the full duration of the travel time to ensure that a fully open or fully closed position is obtained.

On the microblock’s dialog, the Expander setting (Exec 4.x and 5.x only) indicates the number of the expander module (normally 0-5 or 0-6). The Channel setting indicates which output on the hardware module this output represents. Because the Floating Motor Output microblock actually controls two digital points, two different channel numbers are required for each point. The Technical Instructions document for your hardware module or the Technical Handbook can provide you with guidelines for determining the Expander and Channel settings. These settings can be adjusted on the Parameter page using the chan and exp parameters, respectively; however, these settings should not need to be adjusted after the initial installation unless the output point on the module is changed.

The Min pulse width setting (Min Pulse on the Parameter page) indicates the minimum amount of time the motor should be activated anytime it moves. When the Floating Motor microblock receives a new position, if the time required to move that amount is less than the Min pulse width, the microblock will not activate the motor.

The Maintain contact closure setting allows you to determine whether the motor should remain activated after it has recalibrated itself at 0% or 100%. This setting can be adjusted using the Maintain OPEN at 100% and CLOSE at 0% parameter on the Parameter page. If this is set to YES, the motor remains activated after it has reached its limit of 0% or 100%. If this is set to NO, the motor will stop after recalibrating to its fully open or closed position. If this is set to NO when the module is restarted or when the Floating Motor Output microblock has a value of 0% or 100%, then the Parameter page text Proceeding with power up initialization appears.

88 • Chapter 4: I/O Microblocks

Page 89: Eikon 3.02 Microblock Reference

Floating Motor Output

The fail setting indicates what the status the equipment should default to in the event the module is unable to communicate with the equipment (such as a power failure in the module). The lock setting cannot be changed.

Figure 4-10: Floating Motor Output microblock dialog (Exec 4.x)

Parameter page text (Exec 4.x)

________________(DO) exp ___ chan __ lock ~ ~~~ fail ___________________(DO) exp ___ chan __ lock ~ ~~~ fail ___ Full Span _____ (mm:ss) Min Pulse _____ (mm:ss) Maintain OPEN at 100% and CLOSE at 0% ? ___

Status page text (Exec 4.x)

~~~~~~~~~~~~~~~~(DO) lock ~ ~~~~~~~~~~~~~~~~~~~(DO) lock ~ ~~~Current Position = ~~~~~% Proceeding with power up initialization

Chapter 4: I/O Microblocks • 89

Page 90: Eikon 3.02 Microblock Reference

Pulse-Width Output

Pulse-Width Output

The Pulse-Width Output microblock converts a percent value from the GFB to a digital on or off signal. The duration of the signal is calculated according to the percent value of the microblock and is based on minimum and maximum values you define. The Pulse-Width Modulation Output microblock can be used for hot wax valve modulation or for interfacing with a pulse width transducer. You can assign a name for the Pulse-Width Output which appears on the face of the microblock.

The Expander setting (Exec 4.x and 5.x only) indicates the number of the expander module (normally 0-5 or 0-6). The Channel setting indicates which output on the hardware module this microblock represents. The Technical Instructions document for your hardware module or the Technical Handbook can provide you with guidelines for determining the Expander and Channel settings. These settings can be adjusted on the Parameter page using the chan and exp parameters, respectively; however, these settings should not need to be adjusted after the initial installation unless the output point on the module is changed.

On the microblock dialog, the 100% setting defines the maximum duration the signal should be when the value of the microblock is 100%. On the Parameter page, this setting is represented as Full Scale. The 0% setting defines the minimum duration the signal should be when the value of the microblock is 0%. On the Parameter page, this setting is represented as Min Pulse.

The total duration of the signal is a combination of the minimum (0%) and maximum (100%) times. The signal duration is calculated as follows, where m is the 0% setting (minimum pulse width), M is the 100% setting (maximum pulse width), and P is the percent value of the microblock:

Microblock

Microblock Library icon

signal duration m M P×( )+=

90 • Chapter 4: I/O Microblocks

Page 91: Eikon 3.02 Microblock Reference

Pulse-Width Output

Example

0% = 5 sec., 100% = 40 sec., input = 25%

In this example, the signal duration equals (5 sec.) + (40 sec. x .25), or 15 seconds.

In the Pulse refresh time section, the Minimum setting defines how long to wait before sending a new signal. If the microblock’s value changes before this time, the GFB will ignore it until the minimum time expires. This value can be adjusted on the Parameter page using the Min Refresh parameter.

TIP The minimum refresh time must be at least as long as the total of the 0% and 100% pulse width times, otherwise the minimum time may expire before the complete pulse has been sent.

The Maximum setting defines how long to wait before sending a new signal if the percent value has not changed since the last pulse. If the value has not changed by the time the maximum time expires, the GFB will send the same pulse again. This setting can be adjusted on the Parameter page using the Max Refresh parameter. The maximum time must be longer than the minimum time. The maximum is usually obtained from the end-device manufacturer's specifications.

If the percent value changes after the minimum refresh time but before the maximum refresh time, the FB will immediately send a new pulse and reset minimum refresh time and maximum refresh time.

On the Parameter page, the lock setting allows you to define a value for the microblock which will be used instead of the microblock’s actual value. Set the lock parameter to N to use the actual value of the microblock.

Chapter 4: I/O Microblocks • 91

Page 92: Eikon 3.02 Microblock Reference

Pulse-Width Output

Figure 4-11: Pulse-Width Output microblock dialog (Exec 4.x)

Parameter page text (Exec 4.x)

________________(DO) exp ___ chan __ lock _ ___ fail ~~~ Full Scale _____ (sec) Min Pulse _____ (sec) Min Refresh _____ (sec) Max Refresh _____ (sec)

Status page text (Exec 4.x)

~~~~~~~~~~~~~~~~(DO) lock ~ ~~~

92 • Chapter 4: I/O Microblocks

Page 93: Eikon 3.02 Microblock Reference

LAN Analog Output

LAN Analog Output

The LAN Analog Output (LAN AO) microblock broadcasts a value on the network that is read by one or more LAN Analog Input (LAN AI) microblocks. This broadcast value may be an actual physical value read from the module or a value calculated in the GFB. You can assign a name to the output which appears on the face of the microblock.

LAN input and output microblocks are used to pass information between modules on the same CMnet. These microblocks are also used to pass broadcasted variables (heat or cool requests, demand, and outside air temperature, etc.) between modules on different CMnets which share the same LGnet. Variables that are used by many GFBs like outside air temperature and electrical demand are called global variables. To transmit these kinds of variables between different CMnets on the same LGnet, you can use one of the following GFBs (which are available ALC’s web site, http:\\www.automatedlogic.com). Using one of these pre-designed GFBs will reduce the level of network traffic on the LGnet.

If the microblock’s value is being used only by other graphic FBs, enter 129 as the command number on the microblock’s dialog (the Send command setting on the Parameter page). If the value is being used by non-graphic FBs, click the button representing the global command the microblock broadcasts: an occupancy override (command 3), or a LAN variable (command 11-global variables). You can also broadcast other analog global commands by entering the appropriate command

Table 4-3. Recommended GFBs for Global Variables

GFB name Function

YOT Transmit Outside Air temperature

YOR Receive Outside Air temperature

YDT Transmit Electrical Demand

YDR Receive Electrical Demand

YRT Transmit accumulated Heat and Cool Requests

YRR Receive accumulated Heat and Cool Requests

Microblock

Microblock Library icon

Chapter 4: I/O Microblocks • 93

Page 94: Eikon 3.02 Microblock Reference

LAN Analog Output

number in the Send command setting. The section “Non-Graphic FB Commands” on page 351 provides a description of global commands and command numbers that can be used with non-graphic FBs.

The Simulation section of the dialog allows you to determine what cell number, if any, to write to during Eikon simulation. For more information about using cells and Eikon simulation, refer to the section “Testing the FB” of the Eikon User’s Guide. On the Parameter page, the lock setting allows you to define a value for the microblock which will be used instead of the microblock’s actual value. Set the lock parameter to N to use the actual value of the microblock.

Once a GFB using the LAN Analog Output microblock is complete, you must indicate an address for the microblock that LAN Analog Input microblocks can use to receive information. This is done by assigning a special two-number address to the microblock on the GFB’s Parameter page in SuperVision. The Using Address parameter for the LAN Analog Output should be assigned as described below:

• When transferring information between modules on the same CMnet, use numbers 101-199 for the first number of the address.

• When transferring information between modules on the same LGnet but different CMnets, use the numbers 201-254 for the first number of the address.

• The second number of the address should be 1-60, and should be sequentially increased by one for each LAN output on the CMnet.

For example, control module number 5 is using a LAN AO to broadcast information to module number 16 on the same CMnet. The LAN AO has 105, 1 entered as its Using Address parameter, and the LAN AI receiving the information in control module number 16 has 105, 1 entered as its Listen to parameter. Every LAN AO in a system must have a unique address; however, more than one LAN AI can receive information from a single LAN AO.

94 • Chapter 4: I/O Microblocks

Page 95: Eikon 3.02 Microblock Reference

LAN Analog Output

Figure 4-12: LAN-Analog Output microblock dialog

Parameter page text

_______________(GAO) lock _ _____ Send Command ___ Using Address ___,__

Status page text

~~~~~~~~~~~~~~~~(GAO) lock ~ Sending Command ~~~ with Value ~~~~~

Chapter 4: I/O Microblocks • 95

Page 96: Eikon 3.02 Microblock Reference

LAN Digital Output

LAN Digital Output

The LAN Digital Output (LAN DO) microblock broadcasts a value on the network that is read by one or more LAN Digital Input (LAN DI) microblocks. This broadcast value may be an actual physical value read from the module or a value calculated in the GFB. You can assign a name to the input which appears on the face of the microblock.

LAN input and output microblocks are used to pass information between modules on the same CMnet. These microblocks are also used to pass broadcasted variables (heat or cool requests, demand, and outside air temperature, etc.) between modules on different CMnets which share the same LGnet. Variables that are used by many GFBs like outside air temperature and electrical demand are called global variables. To transmit these kinds of variables between different CMnets on the same LGnet, you can use one of the following GFBs (which are available ALC’s web site, http:\\www.automatedlogic.com). Using one of these pre-designed GFBs will reduce the level of network traffic on the LGnet.

If the microblock’s value is being used only by other graphic FBs, enter 129 as the command number on the microblock’s dialog (the Send command setting on the Parameter page). If the value is being used by non-graphic FBs, click the button representing the global command the microblock broadcasts: shutdown (command 1), norm/rev (command 2-changeover), compressor shutdown (command 4), soft shutdown (command 6), or LAN on/off (command 11-global

Table 4-4. Recommended GFBs for Global Variables

GFB name Function

YOT Transmit Outside Air temperature

YOR Receive Outside Air temperature

YDT Transmit Electrical Demand

YDR Receive Electrical Demand

YRT Transmit accumulated Heat and Cool Requests

YRR Receive accumulated Heat and Cool Requests

Microblock

Microblock Library icon

96 • Chapter 4: I/O Microblocks

Page 97: Eikon 3.02 Microblock Reference

LAN Digital Output

variables). You can also broadcast other digital global commands by entering the appropriate command number in the Send command setting. The section “Non-Graphic FB Commands” on page 351 provides a description of global commands and command numbers that can be used with non-graphic FBs.

The Simulation section of the dialog allows you to determine what cell number, if any, to write to during Eikon simulation. For more information about using cells and Eikon simulation, refer to the section “Testing the FB” of the Eikon User’s Guide. On the Parameter page, the lock setting allows you to define a value for the microblock which will be used instead of the microblock’s actual value. Set the lock parameter to N to use the actual value of the microblock.

Once a GFB using the LAN Digital Output microblock is complete, you must indicate an address for the microblock that LAN Digital Input microblocks can use to receive information. This is done by assigning a special two-number addresses to the microblock on the GFB’s Parameter page in SuperVision. The Using Address parameter for the LAN Digital Output should be assigned as described below:

• When transferring information between modules on the same CMnet, use numbers 101-199 for the first number of the address.

• When transferring information between modules on the same LGnet but different CMnets, use the numbers 201-254 for the first number of the address.

• The second number of the address should be 1-60, and should be sequentially increased by one for each LAN output on the CMnet.

For example, control module number 3 is using a LAN DO to broadcast information to module number 8 on the same CMnet. The LAN DO has 101, 1 entered as its Using Address parameter, and the LAN DI receiving the information in control module number 8 has 101, 1 entered as its Listen to parameter. Every LAN DO in a system must have a unique address; however, more than one LAN DI can receive information from a single LAN DO.

Chapter 4: I/O Microblocks • 97

Page 98: Eikon 3.02 Microblock Reference

LAN Digital Output

Figure 4-13: LAN-Digital Output microblock dialog

Parameter page text

________________(GDO) lock _ ___ Send Command ___ Using Address ___,__

Status page text

~~~~~~~~~~~~~~~~(GDO) lock ~ Sending ~~~

98 • Chapter 4: I/O Microblocks

Page 99: Eikon 3.02 Microblock Reference

Airflow Control

Airflow Control

The Airflow Control microblock accesses the airflow control algorithm available in U-Line control modules using Exec 6.02 (or later) module drivers. This microblock provides inputs and outputs that communicate parameter and status values to and from the flow control algorithm using predefined channel numbers. This microblock is also used to access the built-in testing and balancing procedure that allows a VAV box to be commissioned through a LogiStat Pro zone sensor. To use this microblock, be sure to select Exec 6.x and Zone GFB from the Option menu on the menu bar. To select GFBs created in previous versions of this microblock, select GFB-Insert MB on the menu bar.

Inputs and outputs

The inputs in this microblock are used to determine the flow setpoint and minimum flow parameters; these are sent to the flow control algorithm. The algorithm opens or closes the dampers to maintain the actual measured flow at the desired setpoint. To avoid damaging the damper actuator, the flow algorithm will not move the dampers for less than one second. If the required correction to the damper position requires less than a one-second movement of the dampers, no movement will be attempted. However, if the measured flow falls below the minimum flow parameter, the algorithm sends a one-second open signal to the dampers to ensure that the airflow into the zone does not fall below the required minimum. (This minimum flow provision is disabled if the minimum flow parameter is set to zero or if the flow setpoint is manually locked.) The number of damper movements (open or closed) per day is displayed on the module driver status page. If this number becomes excessive, an alarm is generated.

The Status page displays the current values of the Airflow Control's parameters. The Flow Control Range shows the curent minimum and maximum flow settings depending on such things as occupancy and heat mode. The number of damper movements (open or closed) per day is displayed on the module driver status page. If this number becomes excessive, an alarm is generated. The % of Max Flow represents the actual flow value divided by the current maximum flow.

Microblock

Microblock Library icon

Chapter 4: I/O Microblocks • 99

Page 100: Eikon 3.02 Microblock Reference

Airflow Control

The OCC input lets the microblock know if the zone is occupied or unoccupied. This determines whether the Occupied Min Airflow or the Unoccupied Min Airflow parameter will be used as the low limit for the flow setpoint. The HEAT MODE input lets the microblock know if the Air Handling Unit is supplying warm air to the VAV box. Many VAV systems are cooling only, in which case this input would never be active, but some VAV systems have heating coils in the Air Handling Unit and can supply warm air to the VAV boxes when heating is required. In these systems, a LAN point or other external logic must be used to tell the VAV zones if the Air Handling Unit is supplying warm air or cool air to the VAV boxes.

The FAN input should be used if the VAV box includes a circulation fan, either series or parallel. If the VAV box contains such a fan, parameters in this microblock are used to assign an output channel number to this fan, and this output will turn on whenever the FAN input is on. By routing the fan signal through this microblock, the technician can switch the fan on or off from a LogiStat Pro while testing and balancing.

The clg% and htg% inputs are normally connected to the corresponding outputs on a Zone microblock. Under normal circumstances, The clg % input will control the airflow setpoint from 0 to the Cooling Max Airflow setting as the clg % input ranges from 0 to 100%. (Various minimum airflow parameters can set a lower limit on this setpoint, as determined by operating conditions.) If the HEAT MODE input is on and the Use Supply Air for Heating parameter is set to yes, the htg % input will take control of the damper and modulate the airflow setpoint from 0 to the Heating Max Airflow setting in a similar manner. The htg % input is also passed through the microblock to the AUX HEAT output, allowing this microblock to control an auxiliary heating coil if one is present in the VAV box. This passthrough occurs regardless of the the state of the HEAT MODE input or the Use Supply Air for Heating parameter. As with the fan control, the advantage of controlling the heating coil through this microblock is that it allows the technician to open and close the heating valve from a LogiStat Pro while testing and balancing.

The other outputs from this microblock are the actual flow reading (FLOW), the flow setpoint (FLOW SP), and outputs indicating that the damper has reached a fully open or fully closed position (FULL OPN, FULL CLS). The damper full open or closed signals are only active

100 • Chapter 4: I/O Microblocks

Page 101: Eikon 3.02 Microblock Reference

Airflow Control

when a control module with built-in actuator, such as a U341v+, is used. If any other module is being used, these outputs will always be off. For more information on the built-in testing and balancing procedures, refer to the appropriate control module documentation.

Parameters on the Airflow Control microblock dialog box

The units used during airflow calibration determine the units used for the setpoint, minimum flow, and flow reading. This microblock can accept parameters in cubic feet per minute (CFM), liters per second (L/sec), or any other flow units as long as the same units were used for the flow measurements entered into the calibration table.

The Cooling Max Airflow field is the design maximum airflow that will be provided to the zone when the VAV box is in a cooling mode. If the VAV air handling unit provides warm air when the system is in a warm-up mode, the Heating Max Airflow field is used as the design maximum flow under these conditions. The Occupied Min Airflow and Unoccupied Min Airflow set the minimum flows as required for ventilation purposes. These minimums apply to either heating or cooling airflow. (Typically, the unoccupied minimum airflow is set to zero, but special circumstances may require airflow even when the zone is unoccupied.)

The Aux Heat Min Airflow parameter allows a separate minimum flow setting to be entered to assure adequate airflow if an auxiliary heating coil is used. This parameter only takes effect when the htg % input is greater than zero which is when an auxiliary heating coil would be on. Under these conditions, the airflow from the AHU is not allowed to drop below the Aux Heat Min Airflow setting or the Occupied Min Airflow setting, whichever is larger. (If the zone is unoccupied, the Aux Heat Min Airflow is compared to the Unoccupied Min Airflow and the larger of the two is used as the minimum.) This minimum flow setting takes effect regardless of whether or not the HEAT MODE is active or the Use Supply Air for Heating parameter is set to yes. If the VAV box does not have an auxiliary heating coil, or if the box contains a fan which insures sufficient flow across the coil regardless of the airflow from the Air Handling Unit, this parameter should be set to zero.

Chapter 4: I/O Microblocks • 101

Page 102: Eikon 3.02 Microblock Reference

Airflow Control

The Flow Measurement Units field is for display and documentation purposes only. The sensor reading will be given in the same units used during the system calibration. If the flow calibration readings are entered in CFM, for example, the flow sensor will read in CFM. This field allows you to record what units were used and to display them on the Status and Parameter pages.

The Damper Travel Time field should be set to the total time required for the damper motor to travel from its full-closed to full-open position. The Direction field tells the flow control algorithm whether the motor turns clockwise or counter-clockwise to open the dampers.

If the Use Supply Air for Heating when Heat Mode is ON field is set to yes, the flow control algorithm uses the htg % input to control the VAV dampers when the Air Handling unit is supplying warm air to the VAV boxes. If this field is set to no, the dampers will be controlled to provide the appropriate minimum occupied or unoccupied airflow to the zone during the warm-up period.

The Flow Loop # allows multiple instances of this microblock to be used in the same GFB. If this is a typical single-duct VAV system, this number should be set to 1. Dual-duct systems require two Airflow Control microblocks (one for each duct). The microblock which is controlling the primary cooling duct should have this field set to 1. The microblock which is controlling the second duct, typically a heating or ventilating duct, should have this field set to 2.

NOTE This microblock requires the hardware configuration and airflow source of these loops be set on the module driver's Parameter page.

The Name field can be used to give this microblock a unique 24-character name, such as VAV 1-2 Cooling Flow or Dual-Duct Heating Flow, for display on the Status and Parameter pages. This parameter is for documentation and display purposes only and does not affect the operation of the microblock.

The Simulation section on the dialog controls the outputs of this microblock in Eikon's simulation mode. The values entered do not affect the outputs during actual operation.

102 • Chapter 4: I/O Microblocks

Page 103: Eikon 3.02 Microblock Reference

Airflow Control

Verifying, adjusting, and trending parameters

Two parameters can be viewed, adjusted, and trended from the Parameter and Status pages. The Damper Position parameter can be used to lock the dampers to an approximate position (0 to 100%) based on the specified damper motor stroke time. This parameter is only displayed on the Status page if it is locked on the Parameter page. The Flow Control Slope status value displays the sensitivity of the VAV control (change in flow per one second damper movement) based on the most recent damper movement. Both of these parameters are primarily used during commissioning and troubleshooting.

NOTE The trend display for the Flow SP and Actual Flow points is limited to values within a range of ± 2047. If the Max Design Flow parameter is greater than this, the trended values will automatically be scaled by 10% to keep them within this range.

Airflow Calibration

The Parameter page provides access to the calibration data needed to convert the flow sensor reading into an air flow measurement for the particular VAV box being controlled. For accuracy, follow a four-point calibration procedure. Instructions for performing this calibration manually (from SuperVision) are included on the Parameter page. You can view these instructions, along with the calibration table, can be viewed by setting the Use Calibration Table parameter to yes. If you are using a LogiStat Pro zone sensor, you can calibrate each individual zone by using a preprogrammed calibration procedure. This procedure allows testing and balancing personnel to fill in the calibration table directly, as they balance the system, without requiring them to relay information to a SuperVision operator.

If the calibration has not yet been performed, the default values in the calibration table provide enough control over the VAV box to allow initial mechanical system testing and verification to be done. If the flow characteristics of the VAV box are known (either from a K-factor or a factory supplied flow graph) better control is achieved by entering the flow reading that corresponds to a 1” water gauge velocity pressure on the flow sensor. To enter this value, set the Use Calibration Table parameter to no. The Parameter page then displays the line Air flow at 1" water column_________.

Chapter 4: I/O Microblocks • 103

Page 104: Eikon 3.02 Microblock Reference

Airflow Control

Enter the appropriate airflow reading in this parameter, and the flow sensor will use this as a calibration point. This does not prevent you from doing a more accurate four-point calibration procedure at a later date. The pre-programmed LogiStat Pro calibration procedure automatically resets the Use Calibration Table parameter to yes and uses the measured calibration data in place of the estimated value entered for 1" water column.

NOTE If you are not using water column units, enter the flow reading in whatever units you prefer for the equivalent of 1” water column. For example, if you have flow data in cubic meters/hr vs mm of HG, enter the flow reading for 1.8665 mm HG (the equivalent of a 1-inch water column).

104 • Chapter 4: I/O Microblocks

Page 105: Eikon 3.02 Microblock Reference

Airflow Control

Figure 4-14: Airflow Control microblock

Chapter 4: I/O Microblocks • 105

Page 106: Eikon 3.02 Microblock Reference

Airflow Control

Parameter page text

Name: VAV Flow ControlFlow Loop # 1Flow Measurement Units: CFMOccupied Min Airflow: 200 Heating Max Airflow: 800Unoccupied Min Airflow: 0 Cooling Max Airflow: 800Aux Heat Min Airflow: 0Damper Travel Time: 90 seconds Direction: CW = 0 (0=Open, 1=Close)Use supply air for heating when HEAT MODE is ON? YESActual Flow lock N 0.00 trend: Y secs Y intervl 5 min report Y display range: 0 900Flow Setpoint lock Y 1000. trend: Y secs N intervl 5 min report Y display range: 0 900Damper Position lock N 0Aux Heat (AO) lock N 0.00 trend: Y secs N intervl 5 min report N display range: 0 120Fan (DO) exp 0 chan 00 lock N OFF fail OFF trend: Y secs N intervl 5 min report N Damper Full Open (DI) lock N OFF trend: Y secs N intervl 5 min report N Damper Full Close(DI) lock N OFF trend: Y secs N intervl 5 min report N Flow Control Slope trend: Y secs N intervl 5 min report N display range: 0 120

Status page text

Name: VAV Flow controlFlow Measurement Units: CFMFlow Control Range 200 to 800Flow Setpoint lock N 510Actual Flow lock N 503.346Flow Control Range 200 to 800% of Max Flow 62.88Flow Control Slope 10.4446Damper Position lock NAux Heat lock N OFan lock N OFFDamper Full Open lock N OFFDamper Full Close lock N OFFCooling Percent 62.1071Heating Percent 0Zone is OCCUPIEDHeat Mode OFF

106 • Chapter 4: I/O Microblocks

Page 107: Eikon 3.02 Microblock Reference

LogiStat Zone Control

LogiStat Zone Control

The LogiStat Zone Sensor microblock accesses the inputs and outputs from a LogiStat room sensor. With the LogiStat Plus and Pro, you can also set the programming parameters for the setpoint adjust and timed local overrides. Since these features are not available on the base model of the LogiStat, the setpoint adjust and timed local override outputs are set to zero. For more information about setting the parameters for the setpoint adjust values and the timed local overrides for the LogiStat Plus and LogiStat Pros refer to the section “Output Parameters for the LogiStat Plus and Pro”. To use this microblock, be sure to select Exec 6.x from the Option menu on the menu bar.

Since the LogiStat Zone Sensor microblock automatically detects the type of LogiStat being used when the control module is started, it can be used for all LogiStats. Also, the type of LogiStat being used in the field can be changed without changing the Function Block. Point addresses and channel numbers are automatically set by the microblock. The LogiStat Zone Sensor microblock is supported by Exec 6.01 S6104 modules and U-Line modules with a UxM module driver.

Occupancy state (occupied/unoccupied) is the only input wire required for this microblock.

The LogiStat Pro can display the outside air temperature from the system broadcast; refer to the Outside Air Broadcast, OA2, or OA3 microblocks in the section “SysOut Microblocks”. The microblock receives readings directly from the Outside Air broadcast.

The Zone Temp output shows the LogiStat's temperature reading in Fahrenheit or Celsius. The temperature units are determined by the Metric setting in Eikon at design time (refer to "Making the FB" in the "Creating a GFB" chapter of the Eikon User's Guide). This setting is stored in the Setpoint microblock.

The Simulation sections determines what value will be used during an Eikon simulation.

Microblock

Microblock Library icon

Chapter 4: I/O Microblocks • 107

Page 108: Eikon 3.02 Microblock Reference

LogiStat Zone Control

Output Parameters for the LogiStat Plus and Pro

The setpoint adjust output shows the value from the slidepot adjustment on the LogiStat Plus or the numeric setting on the LogiStat Pro. The LogiStat provides a base adjustment range of +/- 1 degree. The Max Adjustment shrinks or expands this reading as required to give the desired range of setpoints. The units for this adjustment are the same as for the Zone Temp.

The output shows the time remaining on the timed local override (TLO) in minutes and seconds (mm:ss). The parameter for Each pulse adjusts the length of time the zone will be occupied after each press of the Timed Local Override button. The parameter for Max Accum sets the maximum time the zone will be occupied regardless of the number of times the button is pressed. The Cancel Override field sets the number of seconds the TLO button must be held in order to clear all previous TLO requests.

These settings can also be adjusted on the Parameter page.

108 • Chapter 4: I/O Microblocks

Page 109: Eikon 3.02 Microblock Reference

LogiStat Zone Control

Figure 4-15: LogiStat Zone Sensor microblock

Chapter 4: I/O Microblocks • 109

Page 110: Eikon 3.02 Microblock Reference

LogiStat Zone Control

Parameter page text for the LogiStat Basic

Zone Temp lock N 0Final offset to be applied to zone temp input 0

Parameter page text for the LogiStat Plus and Pro

Timed Local Override (TLO) lock N 0:00 (min:ss)Hold input for 1 (sec) to resetFor each pulse, add 30:00 (min:ss),up to a maximum of 90:0 (min:ss)Set point Adjust lock N 0Max Sepoint Adjust

Status Page Text for the LogiStat Zone Sensor

Type of LogiStat: PlusSub-type of LogiStat Pro 0Rigidware version of LogiStat Pro 0Zone Temp Lock N 75.06 Deg FCurrent Setpoint AdjustLock N -2 Deg FOverride timer: Lock N 0:00 (min:ss)LogiStat zone is currently OCCUPIEDLogiStat port is currently INACTIVE

♦ ♦ ♦

110 • Chapter 4: I/O Microblocks

Page 111: Eikon 3.02 Microblock Reference

5 SysIn Microblocks

The SysIn menu contains microblocks that receive heat and cool requests, as well as other system information. Requests are the method by which GFBs communicate their heating and cooling needs to each other.

By using requests you can construct a software "chain" mimicking the mechanical chain of equipment in the building. When properly constructed, requests allow you to schedule terminal or zone equipment only, and allow other equipment to respond to the zone requests. The equipment serving the zones can use requests along with the setpoint optimization microblock to constantly adjust discharge setpoints in order to minimize energy consumption.

The following microblocks are available in the SysIn menu:

Receive Run Request 113

Receive Heat Request 115

Receive Cool Request 117

Receive Heat and Cool Requests 119

Get System Variable 121

Get System Status 123

Receive Electrical Demand Level 125

Binary Parameter 126

Analog Parameter 127

Time Parameter 129

Chapter 5: SysIn Microblocks • 111

Page 112: Eikon 3.02 Microblock Reference

Binary Constant 130

Analog Constant 131

Time Constant 132

112 • Chapter 5: SysIn Microblocks

Page 113: Eikon 3.02 Microblock Reference

Receive Run Request

Receive Run Request

The Receive Run Request microblock receives requests from Transmit Run Request microblocks on the same CMnet. The Receive Run Request microblock should be used on equipment that does not need to pass along heating or cooling requests to other HVAC equipment. An example of a piece of equipment which would use a Receive Run Request microblock is a condensation pump which runs any time a steam boiler is energized.

The Receive Run Request microblock receives requests in the form of a number of minutes which the equipment should run. Each time a new request is received, the value of the microblock is reset to the new request time. If the GFB’s update time has expired twice and no new requests are received during that time, the current request time is set to zero. (The update time is shown in the GFB’s header on the Parameter page.) You can add logic to the GFB to disable this feature. The example below shows a way to prevent requests from being cancelled.

Figure 5-1: Preventing run requests from being cancelled

In the example above, the parameter text for the binary parameter microblock reads Allowed to cancel run requests? You can then change this parameter to Yes or No on the Parameter page depending on whether or not you want the GFB to cancel requests.

The Transmit Run Request microblock that is sending the request should contain the address of the GFB containing the Receive Run Request microblock. Therefore, on the Parameter page of the Receive Run Request microblock, the listen to requests sent to parameter should be set to 0,0 (yourself). If you need to receive requests from a GFB located on a different CMnet that shares the same LGnet, use the LAN Input and Output microblocks instead of the Transmit and Receive Request microblocks. Refer to the section “I/O Microblocks” on page 67 for more information about the LAN Input and Output microblocks.

Microblock

Microblock Library icon

Chapter 5: SysIn Microblocks • 113

Page 114: Eikon 3.02 Microblock Reference

Receive Run Request

On the microblock dialog, the Simulation section allows you to determine a cell number to read or a value for the microblock to use during Eikon simulation. For more information about using cells and Eikon simulation, refer to the section “Testing the FB” of the Eikon User’s Guide.

Figure 5-2: Receive Run Request microblock dialog

Parameter page text

Incoming: listen to requests sent to ___,__ (0,0 = yourself)

Status page text

Incoming: requested to run for ~~~ minutes

114 • Chapter 5: SysIn Microblocks

Page 115: Eikon 3.02 Microblock Reference

Receive Heat Request

Receive Heat Request

The Receive Heat Request microblock receives requests for heating from Transmit "I need heat" Request or Transmit Multiple Heat Request microblocks on the same CMnet. The Receive Heat Request microblock should be used on equipment which has the ability to increase its heating output. An example of a piece of equipment which would use a Receive Heat Request microblock is a steam heat exchanger which could raise its leaving water temperature setpoint based on the number of requests for additional heat being received.

The Receive Heat Request microblock contains two values: the number of requests received (heating requested by on the Status page) and the number of minutes the equipment should run (requested to run for on the Status page). These two values allow you to add logic based on either the requested run times, or the number of requests, or both.

Each time a new request is received, the requested to run for value of the microblock is reset to the new request time. If the GFB’s update time has expired twice and no new requests are received during that time, the current request time is set to zero. (The update time is shown in the GFB’s header on the Parameter page). You can add logic to the GFB to disable this feature. The example below shows a way to prevent requests from being cancelled.

Figure 5-3: Preventing heat requests from being cancelled

In the example above, the parameter text for the binary parameter microblock reads Allowed to cancel run requests? You can then change this parameter to Yes or No on the Parameter page depending on whether or not you want the GFB to cancel requests.

The microblock that is sending the request (Transmit "I need heat" Request or Transmit Multiple Heat Request) should contain the address of the GFB containing the Receive Heat Request microblock. Therefore, on the Parameter page of the Receive Heat Request microblock, the listen to requests sent to parameter should

Microblock

Microblock Library icon

Chapter 5: SysIn Microblocks • 115

Page 116: Eikon 3.02 Microblock Reference

Receive Heat Request

be set to 0,0 (yourself). If you need to receive requests from a GFB located on a different CMnet that shares the same LGnet, use the LAN Input and Output microblocks instead of the Transmit and Receive Request microblocks. Refer to the section “I/O Microblocks” on page 67 for more information about the LAN Input and Output microblocks.

On the microblock dialog, the Simulation section allows you to determine a cell number to read or values for the microblock to use during Eikon simulation. For more information about using cells and Eikon simulation, refer to the section “Testing the FB” of the Eikon User’s Guide.

Figure 5-4: Receive Heat Request microblock dialog

Parameter page text

Incoming: listen to requests sent to ___,__ (0,0 = yourself)

Status page text

Incoming: requested to run for ~~~ minutes heating requested by ~~~ unit(s)

116 • Chapter 5: SysIn Microblocks

Page 117: Eikon 3.02 Microblock Reference

Receive Cool Request

Receive Cool Request

The Receive Cool Request microblock receives requests for cooling from Transmit "I need cool" Request or Transmit Multiple Cool Request microblocks on the same CMnet. The Receive Cool Request microblock should be used on equipment which has the ability to increase its cooling output. An example of a piece of equipment which would use a Receive Cool Request microblock is a centrifugal chiller which could lower its leaving water temperature setpoint based on the number of requests for additional cooling.

The Receive Cool Request microblock contains two values: the number of requests received (cooling requested by on the Status page) and the number of minutes the equipment should run (requested to run for on the Status page). These two values allow you to add logic based on either the requested run times, or the number of requests, or both.

Each time a new request is received, the requested to run for value of the microblock is reset to the new request time. If the GFB’s update time has expired twice and no new requests are received during that time, the current request time is set to zero. (The update time is shown in the GFB’s header on the Parameter page). You can add logic to the GFB to disable this feature. The example below shows a way to prevent requests from being cancelled.

Figure 5-5: Preventing cool requests from being cancelled

In the example above, the parameter text for the binary parameter microblock reads Allowed to cancel run requests? You can then change this parameter to Yes or No on the Parameter page depending on whether or not you want the GFB to cancel requests.

The microblock that is sending the request (Transmit "I need cool" Request or Transmit Multiple Cool Request) should contain the address of the GFB containing the Receive Cool Request microblock. Therefore, on the Parameter page of the Receive Cool Request microblock, the listen to requests sent to parameter should

Microblock

Microblock Library icon

Chapter 5: SysIn Microblocks • 117

Page 118: Eikon 3.02 Microblock Reference

Receive Cool Request

be set to 0,0 (yourself). If you need to receive requests from a GFB located on a different CMnet that shares the same LGnet, use the LAN Input and Output microblocks instead of the Transmit and Receive Request microblocks. Refer to the section “I/O Microblocks” on page 67 for more information about the LAN Input and Output microblocks.

On the microblock dialog, the Simulation section allows you to determine a cell number to read or values for the microblock to use during Eikon simulation. For more information about using cells and Eikon simulation, refer to the section “Testing the FB” of the Eikon User’s Guide.

Figure 5-6: Receive Cool Request microblock dialog

Parameter page text

Incoming: listen to requests sent to ___,__ (0,0 = yourself)

Status page text

Incoming: requested to run for ~~~ minutes cooling requested by ~~~ unit(s)

118 • Chapter 5: SysIn Microblocks

Page 119: Eikon 3.02 Microblock Reference

Receive Heat and Cool Requests

Receive Heat and Cool Requests

The Receive Heat and Cool Request microblock receives requests for heating and/or cooling from the Transmit Heat or Cool Request microblocks on the same CMnet. The Receive Heating and Cooling Requests microblock should be used on equipment which has the ability to increase its heating and/or cooling output. An example of a piece of equipment which would use a Receive Heating and Cooling Requests microblock is a multi-zone air handling unit containing a hot deck and a cold deck with the ability to adjust the output of either.

The Receive Heat and Cool Request microblock contains three values: the number of heat requests received (heating requested by on the Status page), the number of cool requests received (cooling requested by on the Status page), and the number of minutes the equipment should run (requested to run for on the Status page). These three values allow you to add logic based on either the requested run times, or the number of requests, or both.

Each time a new request is received, the requested to run for value of the microblock is reset to the new request time. If the GFB’s update time has expired twice and no new requests are received during that time, the current request time is set to zero. (The update time is shown in the GFB’s header on the Parameter page). You can add logic to the GFB to disable this feature. The example below shows a way to prevent requests from being cancelled.

Figure 5-7: Preventing requests from being cancelled

In the example above, the parameter text for the binary parameter microblock reads Allowed to cancel run requests? You can then change this parameter to Yes or No on the Parameter page depending on whether or not you want the GFB to cancel requests.

The microblock that is sending the request should contain the address of the GFB containing the Receive Heat and Cool Request microblock. Therefore, on the Parameter page of the Receive Heat and Cool

Microblock

Microblock Library icon

Chapter 5: SysIn Microblocks • 119

Page 120: Eikon 3.02 Microblock Reference

Receive Heat and Cool Requests

Request microblock, the listen to requests sent to parameter should be set to 0,0 (yourself). If you need to receive requests from a GFB located on a different CMnet that shares the same LGnet, use the LAN Input and Output microblocks instead of the Transmit and Receive Request microblocks. Refer to the section “I/O Microblocks” on page 67 for more information about the LAN Input and Output microblocks.

On the microblock dialog, the Simulation section allows you to determine a cell number to read or values for the microblock to use during Eikon simulation. For more information about using cells and Eikon simulation, refer to the section “Testing the FB” of the Eikon User’s Guide.

Figure 5-8: Receive Heat and Cool Request microblock dialog

Parameter page text

Incoming: listen to requests sent to ___,__ (0,0 = yourself)

Status page text

Incoming: requested to run for ~~~ minutes cooling requested by ~~~ unit(s) heating requested by ~~~ unit(s)

120 • Chapter 5: SysIn Microblocks

Page 121: Eikon 3.02 Microblock Reference

Get System Variable

Get System Variable

The Get System Variable microblock provides information to the Graphic Function Block that is stored in each module in the CMnet. This information, while available in each module, must be provided to the GFB using this microblock.

This microblock can use one of the following values, depending on the option chosen on the microblock’s dialog:

• Outside air temperature

• Outside air humidity

• Outside air enthalpy

• Current time (0-1439; in minutes since midnight)

• Current day of the week (Monday=1, Sunday=7)

• Current day of the month (1-31)

• Minute (0-59)

• Hour (0-23)

• Month (1-12)

• Year (1981-2040)

The Outside Air temperature, humidity and enthalpy are only available to this microblock if an Outside Air Broadcast microblock is used in a GFB in the same CMnet. If an Outside Air Broadcast microblock is not used on the CMnet, the Get System Variable microblock will have an invalid value. An invalid value may also be the result of a communication, power, or other failure in the CMnet.

The Status page text for this microblock varies depending on the type of information received. If you need to receive information that is only available on a different CMnet that uses the same LGnet, use the LAN Input and Output microblocks to transfer this value. Refer to the

Microblock

Microblock Library icon

Chapter 5: SysIn Microblocks • 121

Page 122: Eikon 3.02 Microblock Reference

Get System Variable

section “I/O Microblocks” on page 67 for more information about the LAN Input and Output microblocks.

Figure 5-9: Get System Variable microblock dialog

Status page text

Outside Air Temp = ~~~~~

122 • Chapter 5: SysIn Microblocks

Page 123: Eikon 3.02 Microblock Reference

Get System Status

Get System Status

The Get System Status microblock indicates whether the outside air temperature broadcast is valid or whether the module is currently communicating with other modules. The microblock has a value of yes or no. The Get System Status function may be used to disable certain processes in the event the outside air temperature is invalid or the module is not communicating with the rest of the network.

On the microblock dialog, if oa valid is chosen, then the microblock has a value of yes as long as an Outside Air Broadcast microblock on the CMnet has broadcast an outside air temperature within the past hour. If more than an hour passes without an outside air broadcast, the microblock’s value changes to no. If no outside air broadcast has been made since the module containing the Get System Status microblock has been reset, the value of the microblock may be yes or no until a broadcast is received or until an hour passes. This microblock does not receive an actual outside air temperature.

If comm lost is chosen, the microblock has a value of no unless the module is unable to communicate with any other module on the CMnet. If no other module on the CMnet communicates with the module containing the Get System Status microblock, the value of the microblock changes to yes.

If BACnet Client microblocks are used within a function block and BACnet Comm is chosen, the microblock has a value of no unless the function block is unable to communicate with the bound BACnet device’s network. The value of the microblock changes to yes under either of the following conditions:

• if the bound device is not communicating

• if communication for any BACnet Client microblock within a function block is disabled

This microblock can only be used to determine the status of outside air temperature or communication on the same CMnet. The Status page text changes depending on which option is chosen on the microblock dialog.

Microblock

Microblock Library icon

Chapter 5: SysIn Microblocks • 123

Page 124: Eikon 3.02 Microblock Reference

Get System Status

Figure 5-10: Get System Status microblock dialog

Status page text

Outside Air Valid? ~~~

124 • Chapter 5: SysIn Microblocks

Page 125: Eikon 3.02 Microblock Reference

Receive Electrical Demand Level

Receive Electrical Demand Level

The Receive Electrical Demand Level microblock receives the current demand level from a Demand Broadcast microblock or an electric meter Function Block on the same CMnet. The value of the microblock is either 0, 1, 2, or 3, corresponding to the current electrical demand level. The demand level may be used to offset setpoints, change the duty cycle rate on outputs, or shut certain equipment completely off.

This microblock receives information from the Demand Controller Address setting in the Parameter page header. This setting should contain either the address of the Demand Broadcast microblock sending the demand information or the address of the electric meter Function Block. If no address is entered for this setting, the demand level will not be received. If the Demand Broadcast microblock or electric meter Function Block is located on a different CMnet using the same LGnet, use the LAN Input and Output microblocks instead of the Demand microblocks. Refer to the section “I/O Microblocks” on page 67 for more information about the LAN Input and Output microblocks.

Parameter page text (Header section)

Demand Controller Address ___,___

Status page text (Header section)

Current Demand Level ~~

Microblock

Microblock Library icon

Chapter 5: SysIn Microblocks • 125

Page 126: Eikon 3.02 Microblock Reference

Binary Parameter

Binary Parameter

Binary Parameter microblocks are used to create a yes or no, on or off signal to be sent to another microblock in the GFB. You determine the description of the microblock using the Parameter screen prompt text setting on the microblock’s dialog. You set the value of this microblock on the microblock dialog or on the Parameter page. The descriptive parameter text is displayed on the Parameter page in gray, and the value is displayed in blue.

The microblock can be assigned a yes/no or on/off value on the microblock dialog.

The Value setting on the dialog defines the default value of the microblock, where 0 represents no or off, and 1 represents yes or on.

Figure 5-11: Binary Parameter microblock dialog

Parameter page text

This parameter is _____________

Status page text

This value is ~~~~~~~~~~~~~

Microblock

Microblock Library icon

126 • Chapter 5: SysIn Microblocks

Page 127: Eikon 3.02 Microblock Reference

Analog Parameter

Analog Parameter

Analog Parameter microblocks are used to specify a numeric value to be sent to another microblock in the GFB. This value can be changed on the GFB’s Parameter page or on the microblock’s dialog. You determine the description of the microblock using the Parameter screen prompt text setting on the microblock’s dialog. The descriptive parameter text is displayed on the Parameter page in gray, and the value is displayed in blue.

The microblock’s value can be assigned one of four ranges or values: -100 to +100, -30,000 to +30,000, floating point, or enumerated value. The range that you choose affects the amount of memory used by the GFB, so choose the smallest range that suits your application. The floating point option uses the most memory, while the -100 to +100 range uses the least.

Figure 5-12: Analog Parameter microblock dialog

An enumerated value can represent a word or phrase corresponding to the microblock’s value. To include an enumerated value in an Analog Parameter microblock, select the GFB-Insert MBs option on the menu bar instead of selecting it from the palette. Then, select M$PARA2.sym from the drop-down list and press the ##,ABC enum button to display the Value-String Pairs edit window. Enter the input value and the phrase that you would like it to represent in the Value-String Pairs edit window.

Microblock

Microblock Library icon

Chapter 5: SysIn Microblocks • 127

Page 128: Eikon 3.02 Microblock Reference

Analog Parameter

Parameter page text

This parameter is _____________

Status page text

This value is ~~~~~~~~~~~~~

128 • Chapter 5: SysIn Microblocks

Page 129: Eikon 3.02 Microblock Reference

Time Parameter

Time Parameter

Time Parameter microblocks are used to specify a time value to be sent to another microblock in the GFB. This value can be changed on the GFB’s Parameter page or on the microblock’s dialog. You determine the description of the microblock using the Parameter screen prompt text setting on the microblock’s dialog. The descriptive parameter text is displayed on the Parameter page in gray, and the value is displayed in blue.

Figure 5-13: Time Parameter microblock dialog

Parameter page text

This parameter is _____________

Status page text

This value is ~~~~~~~~~~~~~

Microblock

Microblock Library icon

Chapter 5: SysIn Microblocks • 129

Page 130: Eikon 3.02 Microblock Reference

Binary Constant

Binary Constant

Binary Constant microblocks are used to specify a yes/no or on/off value to be sent to another microblock in the GFB. Binary Constants do not appear on the Parameter or Status pages and should be used instead of Binary Parameter microblocks when the value of the microblock will not change.

The microblock can be assigned a yes/no or on/off value, depending on your application. The Value setting indicates the default value of the microblock, where 0 represents no or off and 1 represents yes or on. This value can only be changed on the microblock dialog.

Figure 5-14: Binary Constant microblock dialog

Microblock

Microblock Library icon

130 • Chapter 5: SysIn Microblocks

Page 131: Eikon 3.02 Microblock Reference

Analog Constant

Analog Constant

Analog Constant microblocks are used to specify a numeric value to be sent to another microblock in the GFB. Analog Constants do not appear on the Parameter or Status pages and should be used instead of Analog Parameter microblocks when the value of the microblock will not change (such as a flow coefficient or pi).

The microblock’s value can be assigned one of three ranges: -100 to +100, -30,000 to +30,000, or floating point. The range that you choose will affect the amount of memory used by the GFB, so you can choose the smallest range that suits your application. The floating point option uses the most memory, while the -100 to +100 range uses the least.

Figure 5-15: Analog Constant microblock dialog

Microblock

Microblock Library icon

Chapter 5: SysIn Microblocks • 131

Page 132: Eikon 3.02 Microblock Reference

Time Constant

Time Constant

Time Constant microblocks are used to specify a time value to be sent to another microblock in the GFB. Time Constants do not appear on the Parameter or Status pages and should be used instead of Time Parameter microblocks when the value of the microblock will not change. The microblock’s value must be defined in hours and minutes.

Figure 5-16: Time Constant microblock dialog

♦ ♦ ♦

Microblock

Microblock Library icon

132 • Chapter 5: SysIn Microblocks

Page 133: Eikon 3.02 Microblock Reference

6 SysOut Microblocks

The SysOut menu contains microblocks that send heat and cool requests, as well as other system information. Requests are the method by which GFBs communicate their heating and cooling needs to each other.

Using requests you can construct a software "chain" mimicking the mechanical chain of equipment in the building. When properly constructed, requests allow you to schedule terminal or zone equipment only and allow other equipment to respond to the zone requests. The equipment serving the zones can use requests along with the setpoint optimization microblock to constantly adjust discharge setpoints in order to minimize energy consumption.

The following microblocks are available in the SysOut menu:

Transmit Run Request 135

Transmit Heat Request 137

Transmit Cool Request 139

Transmit Multiple Heat Requests 141

Transmit Multiple Cool Requests 143

Prime Variable 145

Demand Broadcast 146

Binary Status 147

Analog Status 148

Time Status 149

Chapter 6: SysOut Microblocks • 133

Page 134: Eikon 3.02 Microblock Reference

Outside Air Broadcast 150

OA2 - Primary/Secondary Outside Air Broadcast 151

OA3 - Primary/Secondary Outside Air Broadcast 154

134 • Chapter 6: SysOut Microblocks

Page 135: Eikon 3.02 Microblock Reference

Transmit Run Request

Transmit Run Request

The Transmit Run Request microblock sends requests to a Receive Run Request microblock on the same CMnet. The Transmit Run Request microblock should be used for equipment that has no heating or cooling ability. An example of a piece of equipment that could take requests from this microblock would be a condensation pump which runs any time a steam boiler is energized.

The value of the Transmit Run Request microblock should be the number of minutes that the equipment should run. The send requests to parameter on the Parameter page is used to enter the address of the Receive Run Request microblock that will receive this information. If you need to send a request to a microblock on a different CMnet that shares the same LGnet, use the LAN Input and Output microblocks instead of the Transmit and Receive Request microblocks. Refer to the section “I/O Microblocks” on page 67 for more information about the LAN Input and Output microblocks.

In the Name field on the microblock dialog, you can assign a name to indicate which equipment is requested to run. This name appears on the face of the microblock. The Simulation section allows you to determine what cell number, if any, to write information to during Eikon simulation. For more information about using cells and Eikon simulation, refer to the section “Testing the FB” of the Eikon User’s Guide.

Microblock

Microblock Library icon

Chapter 6: SysOut Microblocks • 135

Page 136: Eikon 3.02 Microblock Reference

Transmit Run Request

Figure 6-1: Transmit Run Request microblock dialog

Parameter page text

Outgoing: for Run Source, send requests to ___,__ (0,0 = no one)

Status page text

Outgoing: Run Source requested to run for ~~~ minutes

136 • Chapter 6: SysOut Microblocks

Page 137: Eikon 3.02 Microblock Reference

Transmit Heat Request

Transmit Heat Request

The Transmit Heat Request microblock sends a request for heating to a Receive Heat Request or Receive Heating and Cooling Request microblock on the same CMnet. The Transmit Heat Request microblock should send requests to the equipment that is the immediate source of heat for the current piece of equipment; this may or may not be the primary heat source for the system. This microblock should only be used on equipment which needs to send a single request. If you need to send more than one request, use the Transmit Multiple Heat Request microblock (refer to the section “Transmit Multiple Heat Requests” on page 141).

The Transmit Heat Request microblock sends two values: the actual request for heat (the "I need heat" portion of the microblock), which is activated by a yes or on signal, and the number of minutes the equipment is requested to run (Heat Source requested to run for on the Status page). The send requests to parameter on the Parameter page is used to enter the address of the Receive Request microblock that will receive this information. If you need to send a request to a microblock on a different CMnet that shares the same LGnet, use the LAN Input and Output microblocks instead of the Transmit and Receive Request microblocks. Refer to the section “I/O Microblocks” on page 67 for more information about the LAN Input and Output microblocks.

In the Name field on the microblock dialog, you can assign a name to indicate which equipment is requested to run. This name appears on the face of the microblock. The Simulation section allows you to determine what cell number, if any, to write information to during Eikon simulation. For more information about using cells and Eikon simulation, refer to the section “Testing the FB” of the Eikon User’s Guide.

Microblock

Microblock Library icon

Chapter 6: SysOut Microblocks • 137

Page 138: Eikon 3.02 Microblock Reference

Transmit Heat Request

Figure 6-2: Transmit Heat Request microblock dialog

Parameter page text

Outgoing: for Heat Source, send requests to ___,__ (0,0 = no one)

Status page text

Outgoing: Heat Source requested to run for ~~~ minutes I need heat requested by ~~ unit(s)

138 • Chapter 6: SysOut Microblocks

Page 139: Eikon 3.02 Microblock Reference

Transmit Cool Request

Transmit Cool Request

The Transmit Cool Request microblock sends a request for heating to a Receive Cool Request or Receive Heating and Cooling Request microblock on the same CMnet. The Transmit Cool Request microblock should send requests to the equipment that is the immediate source of cooling for the current piece of equipment; this may or may not be the primary cool source for the system. This microblock should only be used on equipment which needs to send a single request. If you need to send more than one request, use the Transmit Multiple Cool Request microblock (refer to the section “Transmit Multiple Cool Requests” on page 143).

The Transmit Cool Request microblock sends two values: the actual request for cooling (the "I need cool" portion of the microblock), which is activated by a yes or on signal, and the number of minutes the equipment is requested to run (Cool Source requested to run for on the Status page). The send requests to parameter on the Parameter page is used to enter the address of the Receive Request microblock that will receive this information. If you need to send a request to a microblock on a different CMnet that shares the same LGnet, use the LAN Input and Output microblocks instead of the Transmit and Receive Request microblocks. Refer to the section “I/O Microblocks” on page 67 for more information about the LAN Input and Output microblocks.

In the Name field on the microblock dialog, you can assign a name to indicate which equipment is requested to run. This name appears on the face of the microblock. The Simulation section allows you to determine what cell number, if any, to write information to during Eikon simulation. For more information about using cells and Eikon simulation, refer to the section “Testing the FB” of the Eikon User’s Guide.

Microblock

Microblock Library icon

Chapter 6: SysOut Microblocks • 139

Page 140: Eikon 3.02 Microblock Reference

Transmit Cool Request

Figure 6-3: Transmit Cool Request microblock dialog

Parameter page text

Outgoing: for Cool Source, send requests to ___,__ (0,0 = no one)

Status page text

Outgoing: Cool Source requested to run for ~~~ minutes I need cool requested by ~~ unit(s)

140 • Chapter 6: SysOut Microblocks

Page 141: Eikon 3.02 Microblock Reference

Transmit Multiple Heat Requests

Transmit Multiple Heat Requests

The Transmit Multiple Heat Requests microblock sends a request for heating to a Receive Heat Request or Receive Heat and Cool Request microblock on the same CMnet. The Transmit Multiple Heat Requests microblock should send requests to the equipment that is the immediate source of heat for the current piece of equipment; this may or may not be the primary heat source for the system.

The Transmit Multiple Heat Requests microblock sends two values: the number of actual requests for heat (I need heat requested by on the Status page), and the number of minutes the equipment is requested to run (Heat Source requested to run for on the Status page). The send requests to parameter on the Parameter page is used to enter the address of the Receive Request microblock that will receive this information. If you need to send a request to a microblock on a different CMnet that shares the same LGnet, use the LAN Input and Output microblocks instead of the Transmit and Receive Request microblocks. Refer to the section “I/O Microblocks” on page 67 for more information about the LAN Input and Output microblocks.

In the Name field on the microblock dialog, you can assign a name to indicate which equipment is requested to run. This name appears on the face of the microblock. The Simulation section allows you to determine what cell number, if any, to write information to during Eikon simulation. For more information about using cells and Eikon simulation, refer to the section “Testing the FB” of the Eikon User’s Guide.

Microblock

Microblock Library icon

Chapter 6: SysOut Microblocks • 141

Page 142: Eikon 3.02 Microblock Reference

Transmit Multiple Heat Requests

Figure 6-4: Transmit Multiple Heat Requests microblock dialog

Parameter page text

Outgoing: for Heat Source, send requests to ___,__ (0,0 = no one)

Status page text

Outgoing: Heat Source requested to run for ~~~ minutes I need heat requested by ~~ unit(s)

142 • Chapter 6: SysOut Microblocks

Page 143: Eikon 3.02 Microblock Reference

Transmit Multiple Cool Requests

Transmit Multiple Cool Requests

The Transmit Multiple Cool Requests microblock sends a request for cooling to a Receive Cool Request or Receive Heat and Cool Request microblock on the same CMnet. The Transmit Multiple Cool Requests microblock should send requests to the equipment that is the immediate source of cooling for the current piece of equipment; this may or may not be the primary cool source for the system.

The Transmit Multiple Cool Requests microblock sends two values: the number of actual requests for cooling (I need cool requested by on the Status page), and the number of minutes the equipment is requested to run (Cool Source requested to run for on the Status page). The send requests to parameter on the Parameter page is used to enter the address of the Receive Request microblock that will receive this information. If you need to send a request to a microblock on a different CMnet that shares the same LGnet, use the LAN Input and Output microblocks instead of the Transmit and Receive Request microblocks. Refer to the section “I/O Microblocks” on page 67 for more information about the LAN Input and Output microblocks.

In the Name field on the microblock dialog, you can assign a name to indicate which equipment is requested to run. This name appears on the face of the microblock. The Simulation section allows you to determine what cell number, if any, to write information to during Eikon simulation. For more information about using cells and Eikon simulation, refer to the section “Testing the FB” of the Eikon User’s Guide.

Microblock

Microblock Library icon

Chapter 6: SysOut Microblocks • 143

Page 144: Eikon 3.02 Microblock Reference

Transmit Multiple Cool Requests

Figure 6-5: Transmit Multiple Cool Requests microblock dialog

Parameter page text

Outgoing: for Cool Source, send requests to ___,__ (0,0 = no one)

Status page text

Outgoing: Cool Source requested to run for ~~~ minutes I need cool requested by ~~ unit(s)

144 • Chapter 6: SysOut Microblocks

Page 145: Eikon 3.02 Microblock Reference

Prime Variable

Prime Variable

The Prime Variable microblock identifies a single specific value from the GFB that the workstation needs quick access to, such as the current zone temperature. The value of the Prime Variable microblock, like the FB’s color, is stored in the gateway module where the workstation can retrieve it quickly and without having to access the individual GFB. The prime variable is sent after the GFB’s update time has expired. The update time is visible in the header of the GFB’s Parameter page.

Because the prime variable can be retrieved by the workstation as quickly as the colors can, you can add a prime variable to a SuperVision graphic without significantly increasing the redraw time of the graphic. To include the prime variable in a GFB’s graphic drawing, use ALC Draw’s Variable Text feature and the following text expression: FBID$T, where FBID is the ID of the GFB (located in the header of the GFB’s Parameter page).

Microblock

Microblock Library icon

Chapter 6: SysOut Microblocks • 145

Page 146: Eikon 3.02 Microblock Reference

Demand Broadcast

Demand Broadcast

The Demand Broadcast microblock sends the current demand level to the Receive Electrical Demand Level microblock in another GFB on the same CMnet. The value of this microblock is either 0, 1, 2, or 3, corresponding to the current electrical demand level. The demand level can be calculated using the Pulse to Analog microblock and information obtained from your electric company. For an example of how to calculate demand in a GFB, refer to the section “Pulse to Analog” on page 75.

If the Receive Electrical Demand Level microblock is located on a different CMnet using the same LGnet, use the LAN Input and Output microblocks instead of the Demand microblocks. Refer to the section “I/O Microblocks” on page 67 for more information about the LAN Input and Output microblocks.

Figure 6-6: Demand Broadcast microblock dialog

Status page text

Currently broadcasting demand level ~~

Microblock

Microblock Library icon

146 • Chapter 6: SysOut Microblocks

Page 147: Eikon 3.02 Microblock Reference

Binary Status

Binary Status

The Binary Status microblock displays a yes/no or on/off value from the GFB on the Status page. You can use this microblock to display the value of another microblock that would not normally appear on the Status page. You determine the description of the microblock using the Status screen prompt text setting on the microblock’s dialog.

The microblock can be assigned a yes/no or on/off value on the microblock dialog, according to the type of information received.

Figure 6-7: Binary Status microblock dialog

Status page text

This value is ~~~~~~~~~~~~~

Microblock

Microblock Library icon

Chapter 6: SysOut Microblocks • 147

Page 148: Eikon 3.02 Microblock Reference

Analog Status

Analog Status

The Analog Status microblock displays the numeric value from the GFB on the Status page. You can use this microblock to display the value of another microblock that would not normally appear on the Status page. You determine the description of the microblock using the Status screen prompt text setting on the microblock’s dialog.

The microblock’s value can be assigned one of four ranges or values: -100 to +100, -30,000 to +30,000, floating point, or enumerated value. The range that you choose affects the amount of memory used by the GFB, so choose the smallest range that suits your application. The floating point option uses the most memory, while the -100 to +100 range uses the least.

Figure 6-8: Analog Status microblock dialog

An enumerated value can represent a word or phrase corresponding to the microblock’s value. To include an enumerated value in an Analog Status microblock, select the GFB-Insert MBs option on the menu bar instead of selecting it from the palette. Then, select M$STATA2.sym from the drop-down list and press the ##,ABC enum button to display the Value-String Pairs edit window. Enter the input value and the phrase that you would like it to represent in the Value-String Pairs edit window.

Status page text

This value is ~~~~~~~~~~~~~

Microblock

Microblock Library icon

148 • Chapter 6: SysOut Microblocks

Page 149: Eikon 3.02 Microblock Reference

Time Status

Time Status

The Time Status microblock displays a time value from the GFB on the Status page. You can use this microblock to display the value of another microblock that would not normally appear on the Status page. You determine the description of the microblock using the Status screen prompt text setting on the microblock’s dialog.

The microblock’s value must be defined in hours and minutes. If the microblock receives a numeric value, minutes and seconds value, or other value, it will not be converted to an hours and minutes value.

Figure 6-9: Time Status microblock dialog

Status page text

This value is ~~~~~~~~~~~~~

Microblock

Microblock Library icon

Chapter 6: SysOut Microblocks • 149

Page 150: Eikon 3.02 Microblock Reference

Outside Air Broadcast

Outside Air Broadcast

The Outside Air Broadcast microblock broadcasts the outside air temperature, humidity, and enthalpy to the module’s firmware (the Exec). These values, which are typically used to control equipment such as outside air dampers and hot/cold water coils, are available to all GFBs on the CMnet, and can be retrieved using the Get System Variable microblock. Because these values are stored in the firmware, no broadcast or receiving addresses need to be defined. Each input on this microblock must be wired to a value, even if that value is not used.

If you need to broadcast these values to GFBs on a different CMnet that shares the same LGnet, use the LAN Input and Output microblocks instead of the Outside Air Broadcast and Get System Variable microblocks. Refer to the section “I/O Microblocks” on page 67 for more information about the LAN Input and Output microblocks.

Figure 6-10: Outside Air Broadcast microblock dialog

Status page text

Outside Air Temp = ~~~~~ degOutside Air Humidity = ~~~~~ %Outside Air Enthalpy = ~~~~~ BTU/lb.

Microblock

Microblock Library icon

150 • Chapter 6: SysOut Microblocks

Page 151: Eikon 3.02 Microblock Reference

OA2 - Primary/Secondary Outside Air Broadcast

OA2 - Primary/Secondary Outside Air Broadcast

The Outside Air Broadcast microblock broadcasts the outside air temperature, humidity, and enthalpy to the module’s firmware (the Exec). These values, which are typically used to control equipment such as outside air dampers and hot/cold water coils, are available to all GFBs on the CMnet, and can be retrieved using the Get System Variable microblock. Because these values are stored in the firmware, no broadcast or receiving addresses need to be defined. Each input on this microblock must be wired to a value, even if that value is not used.

The OA2 - Primary/Secondary Outside Air Broadcast microblock can be used as the primary or the secondary outside air broadcast by setting the Primary OA Broadcast parameter on the Parameter page or the microblock dialog. The Units section of the microblock dialog allows you to determine what units the microblock uses to send its values. The Status page shows both the numeric values and the units you have defined for them. The outside air value is an average value which does not change unless the average varies by a user-defined amount. This amount can be entered either on the microblock dialog or the Parameter page.

If used as the secondary OA broadcast, this microblock checks the firmware to make sure the primary OA broadcast is being received. If the broadcast is absent for a defined number of token passes, this microblock begins to broadcast its own temperature, humidity, and enthalpy values and generates an alarm and a message. This number of token passes can be defined either on the microblock dialog or the Parameter page. Because of the old style of alarm and message this microblock generates, you should use the OA3 microblock (described on page 154) if Alert is being used for alarm management.

The corresponding alarm and message flags must be enabled on the GFB’s Parameter page before they can be reported. You can set the flags on the microblock’s dialog, or on the Parameter page (the Alarms enabled setting in the header). If you enable the alarm and

Microblock

Microblock Library icon

Chapter 6: SysOut Microblocks • 151

Page 152: Eikon 3.02 Microblock Reference

OA2 - Primary/Secondary Outside Air Broadcast

message on the Parameter page, note that the following alarm and message flags are reserved:

The Text setting in the Parameter page header indicates the number that corresponds to the text of the alarm or message. The alarm and message text can be located in the xxxalarm.txt or sysalarm.txt files.

If you need to broadcast this microblock’s values to GFBs on a different CMnet that shares the same LGnet, use the LAN Input and Output microblocks instead of the Outside Air Broadcast and Get System Variable microblocks. Refer to the section “I/O Microblocks” on page 67 for more information about the LAN Input and Output microblocks.

NOTE This microblock is not compatible with Exec 6.x firmware. If Exec 6.x modules are installed, use the OA3 microblock (described on page 154).

Table 6-1. Reserved alarm and message flags

Type of flag Flag number Reserved for

alarm 1 Point under manual lock

message 1 Runtime Expired

message 6 FB error

message 7 Daily Trend Report

message 8 Daily Status Report

152 • Chapter 6: SysOut Microblocks

Page 153: Eikon 3.02 Microblock Reference

OA2 - Primary/Secondary Outside Air Broadcast

Figure 6-11: OA2 - Primary/Secondary OA Broadcast microblock dialog

Parameter page text

Primary OA Broadcast? ___ (NO = Secondary)If primary Outside Air broadcast is absent more than ___ passes,begin secondary broadcast.The Outside Air broadcast value will not change unless the averageOutside Air temperature varies by more than _____ degrees.Units: OA Temp ________; OA Humidity ________; OA Enthalpy ________;

Status page text

Primary OA broadcast is active. Average: Outside Air Temp = ~~~~~ ~~~~~~~~ Broadcasting: Outside Air Temp = ~~~~~ ~~~~~~~~ Broadcasting: Outside Air Humidity = ~~~~~ ~~~~~~~~ Broadcasting: Outside Air Enthalpy = ~~~~~ ~~~~~~~~

Chapter 6: SysOut Microblocks • 153

Page 154: Eikon 3.02 Microblock Reference

OA3 - Primary/Secondary Outside Air Broadcast

OA3 - Primary/Secondary Outside Air Broadcast

The Outside Air Broadcast microblock broadcasts the outside air temperature, humidity, and enthalpy to the module’s firmware (the Exec). These values, which are typically used to control equipment such as outside air dampers and hot/cold water coils, are available to all GFBs on the CMnet, and can be retrieved using the Get System Variable microblock. Because these values are stored in the firmware, no broadcast or receiving addresses need to be defined. Each input on this microblock must be wired to a value, even if that value is not used. This microblock is identical in function to the OA2 - Primary/Secondary Outside Air Broadcast, except that instead of generating an old-style alarm and message, it provides an alarm output that can be used to trigger the Alert Alarm microblock.

The OA3 - Primary/Secondary Outside Air Broadcast microblock can be used as the primary or the secondary outside air broadcast by setting the Primary OA Broadcast parameter on the Parameter page or the microblock dialog. The Units section of the microblock dialog allows you to determine what units the microblock uses to send its values. The Status page shows both the numeric values and the units you have defined for them. The outside air value is an average value which does not change unless the average varies by a user-defined amount. This amount can be entered either on the microblock dialog or the Parameter page.

If used as the secondary OA broadcast, this microblock checks the firmware to make sure the primary OA broadcast is being received. If the broadcast is absent for a defined number of token passes, this microblock begins to broadcast its own temperature, humidity, and enthalpy values and activates its alarm output. This number of token passes can be defined either on the microblock dialog or the Parameter page. The alarm output must be wired to an Alert microblock to generate an Alert event. Refer to the section “Alert Event” on page 170 for details.

If you need to broadcast this microblock’s values to GFBs on a different CMnet that shares the same LGnet, use the LAN Input and Output microblocks instead of the Outside Air Broadcast and Get System Variable microblocks. Refer to the section “I/O Microblocks” on page 67 for more information about the LAN Input and Output microblocks.

Microblock

Microblock Library icon

154 • Chapter 6: SysOut Microblocks

Page 155: Eikon 3.02 Microblock Reference

OA3 - Primary/Secondary Outside Air Broadcast

The following table describes the microblock’s inputs and outputs

Figure 6-12: OA3 - Primary/Secondary Outside Air Broadcast microblock dialog

Parameter page text

Primary OA Broadcast? ___ (NO = Secondary)If primary Outside Air broadcast is absent more than ___ passes,begin secondary broadcast.The Outside Air broadcast value will not change unless the averageOutside Air temperature varies by more than _____ degrees.

Table 6-2. OA3 microblock inputs and output

Name Description Type of value

temp temperature input numeric (analog)

humidity humidity input numeric (analog)

enthalpy enthalpy input numeric (analog)

alarm Alert event trigger output on or off (digital)

Chapter 6: SysOut Microblocks • 155

Page 156: Eikon 3.02 Microblock Reference

OA3 - Primary/Secondary Outside Air Broadcast

Units: OA Temp ________; OA Humidity ________; OA Enthalpy ________;

Status page text

Primary OA broadcast is active. Average: Outside Air Temp = ~~~~~ ~~~~~~~~ Broadcasting: Outside Air Temp = ~~~~~ ~~~~~~~~ Broadcasting: Outside Air Humidity = ~~~~~ ~~~~~~~~ Broadcasting: Outside Air Enthalpy = ~~~~~ ~~~~~~~~

♦ ♦ ♦

156 • Chapter 6: SysOut Microblocks

Page 157: Eikon 3.02 Microblock Reference

7 Log Microblocks

The Log menu contains microblocks that log system information such as trends and alarms.

The following microblocks are available in the Log menu:

Digital Trend 158

Analog Trend 160

Set Alarm Number 162

Set Message Number 164

Set Runtime Exceeded Flag 166

Runtime Monitor 168

Alert Event 170

History Recorder 175

High Peak Recorder 176

Low Peak Recorder 178

Runtime Accumulation 180

Chapter 7: Log Microblocks • 157

Page 158: Eikon 3.02 Microblock Reference

Digital Trend

Digital Trend

The Digital Trend microblock records data for trend purposes from a digital microblock output. If you want to trend information from a Digital Input microblock, this can be accomplished using the Digital Input alone, without the Digital Trend microblock. Refer to the section “Digital Input” on page 71 for details.

When enabled, this microblock records its value in the module’s memory at the interval you define. The interval can be measured in minutes or seconds. Each trend holds the most recent 288 samples in memory (288 = 24 hours at 5 minute intervals). You can use up to 254 Digital or Analog Trend microblocks in a single GFB; however, because each active trend consumes a portion of the module's memory, the maximum number of trends you can use at any one time will be less than this. Each trend may be individually enabled and disabled, and when disabled, consumes no memory. (To enable the trend from the Parameter page, make sure the trend parameter is set to Y.)

Trend reports are no longer generated or viewed as in previous versions of Alert EL. Refer to the SuperVision and Gopher User’s Guides for details about viewing trend information.

The trend from this microblock assumes the same address of the FB in which it resides, except the expander number is 94 and the channel number is the trend's wire number (as reported in the wire parameter on the Parameter or Status page).

Figure 7-1: Digital Trend microblock dialog

Microblock

Microblock Library icon

158 • Chapter 7: Log Microblocks

Page 159: Eikon 3.02 Microblock Reference

Digital Trend

Parameter page text

________________(DT) wire ~~ trend: _ secs _ interval ___ sec report _

Status page text

~~~~~~~~~~~~~~~~(DT) wire ~~ ~~~

Chapter 7: Log Microblocks • 159

Page 160: Eikon 3.02 Microblock Reference

Analog Trend

Analog Trend

The Analog Trend microblock records data for trend purposes from an analog microblock output. If you want to trend information from an Analog Input microblock, this can be accomplished using the Analog Input alone, without the Analog Trend microblock.

When enabled, this microblock records its value in the module’s memory at the interval you define. The interval can be measured in minutes or seconds. Each trend holds the most recent 288 samples in memory (288 = 24 hours at 5 minute intervals). You can use up to 254 Digital or Analog Trend microblocks in a single GFB; however, because each active trend consumes a portion of the module's memory, the maximum number of trends you can use at any one time will be less than this. Each trend may be individually enabled and disabled, and when disabled, consumes no memory. (To enable the trend from the Parameter page, make sure the trend parameter is set to Y.)

Trend reports are no longer generated or viewed as in previous versions of Alert EL. Refer to the SuperVision and Gopher User’s Guides for details about viewing trend information.

The trend from this microblock assumes the same address of the FB in which it resides, except the expander number is 94 and the channel number is the trend's wire number (as reported on the Parameter or Status page).

Figure 7-2: Analog Trend microblock dialog

Microblock

Microblock Library icon

160 • Chapter 7: Log Microblocks

Page 161: Eikon 3.02 Microblock Reference

Analog Trend

Parameter page text

________________(AT) wire ~~ trend: _ secs _ interval ___ sec report _ display range: ______ ______

Status page text

~~~~~~~~~~~~~~~~(AT) wire ~~ ~~~~~

Chapter 7: Log Microblocks • 161

Page 162: Eikon 3.02 Microblock Reference

Set Alarm Number

Set Alarm Number

The Set Alarm Number microblock activates one of seven available alarm flags when the microblock’s value is set to on. If you have Alert, you should use the Alert alarm microblock if possible to send the alarm. This microblock does not function with Exec 6.x firmware. An alarm generated by this microblock records the time and date the alarm is received by the workstation. For details about alarms and alarm management, refer to the Alert User’s Guide.

The microblock dialog allows you to determine which alarm flag is activated by this microblock. You can also determine this in the Alarms enabled section of the Parameter page. The eight dashes in this field represent the eight alarm flags; to enable an alarm, click the appropriate dash to change it to an X. The Text setting next to Alarms enabled identifies the actual report text of each of the alarms. This field contains eight numbers that correspond to the eight alarm flags. Each number represents a text entry in the xxxalarm.txt or sysalarm.txt files, which appears in the alarm report when the alarm is generated.

Example

Alarms Enabled _X____X_ Text ___ 72 ___ ___ ___ ___ 115 ___

In this example, alarm flags 2 and 7 have been enabled. When alarm flag 2 is activated in the GFB, the alarm report displays the text represented by the number 72 in the xxxalarm.txt or sysalarm.txt files. When alarm flag 7 is activated, the alarm report shows the text for number 115 in the xxxalarm.txt or sysalarm.txt files. If both the xxxalarm.txt or sysalarm.txt files contain the same number (for example, they each contained different text for number 72), the information in the xxxalarm.txt file is displayed.

Alarm flag 1 is reserved for indicating that points are under manual lock. If this flag is enabled on the Parameter page, an alarm will be reported whenever a microblock’s lock parameter is set to Y on the Parameter page.

Microblock

Microblock Library icon

162 • Chapter 7: Log Microblocks

Page 163: Eikon 3.02 Microblock Reference

Set Alarm Number

Figure 7-3: Set Alarm Number microblock dialog

Parameter page text

Alarms Enabled ________ Text ___ ___ ___ ___ ___ ___ ___ ___

Status page text

Active Alarms ~~~~~~~~

Chapter 7: Log Microblocks • 163

Page 164: Eikon 3.02 Microblock Reference

Set Message Number

Set Message Number

The Set Message Number microblock activates one of six available message flags when the microblock’s value is set to on. If you have Alert, you should use the Alert Alarm microblock if possible to send the message. This microblock does not function with Exec 6.x firmware. A message generated by this microblock records the time and date the message is received by the workstation. For details about messages and alarm management, refer to the Alert User’s Guide.

The microblock dialog allows you to determine which message flag is activated by this microblock. You can also determine this in the Messages enabled section of the Parameter page. The eight dashes in this field represent the eight message flags; to enable a message, click the appropriate dash to change it to an X. The Text setting next to Messages enabled identifies the actual report text of each of the messages. This field contains eight numbers that correspond to the eight message flags. Each number represents a text entry in the xxxalarm.txt or sysalarm.txt files, which appears in the message report when the message is generated.

Example

Messages Enabled _X______ Text ___ 15 ___ ___ ___ ___ ___ ___

In this example, message flag 2 has been enabled. When message flag 2 is activated in the GFB, the message report displays the text represented by the number 15 in the xxxalarm.txt or sysalarm.txt files. If both the xxxalarm.txt or sysalarm.txt files contain the same number (for example, they each contained different text for number 15), the information in the xxxalarm.txt file is displayed.

Table 7-1 shows which message flags are reserved. Message flags 1 and 6 cannot be set on the microblock dialog. Message flags 7 and 8 are

Microblock

Microblock Library icon

164 • Chapter 7: Log Microblocks

Page 165: Eikon 3.02 Microblock Reference

Set Message Number

not supported in SuperVision v3.0 or Alert v3.0 but, in previous versions, should be used to send a trend report or status report.

Figure 7-4: Set Message Number microblock dialog

Parameter page text

Messages Enabled ________ Text ___ ___ ___ ___ ___ ___ ___ ___

Status page text

Active Messages ~~~~~~~~

Table 7-1. Reserved message flags

Flag number Reserved for

1 Runtime Expired

6 FB error

7 Daily Trend Report

8 Daily Status Report

Chapter 7: Log Microblocks • 165

Page 166: Eikon 3.02 Microblock Reference

Set Runtime Exceeded Flag

Set Runtime Exceeded Flag

The Set Runtime Exceeded Flag microblock monitors the amount of time that a piece of equipment has been running and activates one of five available message flags when the specified runtime limit is exceeded. If you have Alert, you should use the Runtime Monitor microblock if possible to generate a message. This microblock does not function with Exec 6.x firmware. A message generated by this microblock records the time and date the message is received by the workstation. For details about messages and alarm management, refer to the Alert User’s Guide.

The microblock tracks the amount of time that its input remains on. When the limit (set either on the microblock dialog or using the limit parameter on the Parameter page) is reached, a message is generated and sent to the workstation. The Status page shows the number of hours of runtime accumulated since the time the microblock’s input was turned on and also shows the time at which the microblock began counting. If the clear parameter on the Parameter page is set to yes, or the microblock’s input changes to off, the number of hours of accumulated runtime is reset to zero.

The microblock dialog allows you to determine which message flag is activated by this microblock. You can also determine this in the Messages enabled section of the Parameter page. The eight dashes in this field represent the eight message flags; to enable a message, click the appropriate dash to change it to an X. The Text setting next to Messages enabled identifies the actual report text of each of the messages. This field contains eight numbers that correspond to the eight message flags. Each number represents a text entry in the xxxalarm.txt or sysalarm.txt files, which appears in the message report when the message is generated.

Example

Messages Enabled _X______ Text ___ 15 ___ ___ ___ ___ ___ ___

In this example, message flag 2 has been enabled. When message flag 2 is activated in the GFB, the message report displays the text represented by the number 15 in the xxxalarm.txt or sysalarm.txt files. If both the xxxalarm.txt or sysalarm.txt files contain the same

Microblock

Microblock Library icon

166 • Chapter 7: Log Microblocks

Page 167: Eikon 3.02 Microblock Reference

Set Runtime Exceeded Flag

number (for example, they each contained different text for number 15), the information in the xxxalarm.txt file is displayed.

Table 7-1 on page 165 shows which message flags are reserved. Message flag 1 is reserved for an expired runtime message; use this flag with this microblock if possible. Message flags 6, 7, and 8 cannot be set on the microblock dialog.

Figure 7-5: Set Runtime Exceeded Flag microblock dialog

Parameter page text

runtime: clear ___ limit _____ hours

Status page text

runtime: expired ~ ~~~~~ hours since ~~~~~~~~~

Chapter 7: Log Microblocks • 167

Page 168: Eikon 3.02 Microblock Reference

Runtime Monitor

Runtime Monitor

The Runtime Monitor microblock monitors the amount of time that a piece of equipment has been running and provides an alarm output that can be used to trigger the Alert Alarm microblock when the specified runtime limit is exceeded. The microblock tracks the amount of time that its input remains on. When the limit (set either on the microblock dialog or using the limit parameter on the Parameter page) is reached, the microblock’s output is turned on. This output may be wired to an Alert microblock to generate a runtime exceeded alarm. Refer to the section “Alert Event” on page 170 for more information about the Alert microblock.

The Status page shows the number of hours of runtime accumulated since the time the microblock’s input was turned on and also shows the time at which the microblock began counting. If the clear parameter on the Parameter page is set to yes or if the microblock’s input changes to off, the number of hours of accumulated runtime is reset to zero. The accumulated runtime value monitored by the this microblock is stored in the module’s non-volatile memory, so that if power is lost this value is retained. In modules containing Exec 3.x or Exec 4.x, the runtime value is stored once every hour.

NOTE This microblock can only be displayed in SuperVision for Windows version 2.5b or later.

Figure 7-6: Runtime Monitor microblock dialog

Parameter page text

runtime: clear ___ limit _____ hours

Microblock

Microblock Library icon

168 • Chapter 7: Log Microblocks

Page 169: Eikon 3.02 Microblock Reference

Runtime Monitor

Status page text

runtime: expired ~ ~~~~~ hours since ~~~~~~~~~

Chapter 7: Log Microblocks • 169

Page 170: Eikon 3.02 Microblock Reference

Alert Event

Alert Event

The Alert Event microblock is used to transmit alarms and supplemental data from the GFB to the Alert event management system. An event generated by this microblock is time-stamped with the time the event was generated.

Alert microblocks tell Alert:

• what event has occurred (according to the event ID)

• whether the event requires a return to normal conditions before it can be closed

• whether the event is critical

• what additional information from the GFB is available to Alert

This information can be specified on the microblock dialog or on the Parameter page. In order for Alert to receive an event, the Enable event setting (Enable on the Parameter page) must be set to yes.

Event IDs

The event ID is an eight-character name that identifies the event for Alert. Alert knows what information to display and what actions are applicable to an event based on its ID. Event IDs can be made up of uppercase letters, numbers, and any symbol on the keyboard. Certain default event IDs are reserved for special uses; Table 7-2 on page 171 lists these special IDs and their uses.

NOTE Events with an ID of STATUS are not supported by Alert version 3.0 or later. Events with this ID are supported by Alert versions 1.2a and

Microblock

Microblock Library icon

170 • Chapter 7: Log Microblocks

Page 171: Eikon 3.02 Microblock Reference

Alert Event

below, but these events record the date and time the event was received, instead of the date and time the event occurred.

Return to normal

If you want to require that an event return to normal before it can be closed, set Return to normal required to yes (on the Parameter page, the RTN reqd parameter). If an event does not require a return to normal

Table 7-2. Reserved event IDs

Event ID Used for

A Unconfigured events generated by Set Alarm Number microblocks. Alert uses this ID combined with the alarm number (for example, A7) to display events that are generated from these microblocks and are not already configured in Alert.

A1 Lock alarm. This event occurs when a parameter is locked from SuperVision’s parameter page.

ALERTERR Bad alarms. This event occurs when Alert receives an event it cannot display or handle properly. If this type of event occurs, check the error log for more information. Refer to the Alert User’s Guide for details.

DEFAULT Unconfigured Alert microblock events. This is a template that Alert uses when an event occurs that has not been configured in Alert. The unconfigured event will appear in the view using the information provided in this Default template.

M Unconfigured events generated by Set Message Number microblocks. Alert uses this ID combined with the message number (for example, M15) to display events that are generated from these microblocks and are not already configured in Alert.

GATEWAY Gateway not responding. Alert generates this event when it is unable to establish contact with the gateway module.

Chapter 7: Log Microblocks • 171

Page 172: Eikon 3.02 Microblock Reference

Alert Event

before closing, then the event is closed as soon as it has been acknowledged and its reporting actions are complete.

Critical events

The difference between a critical and a non-critical event is the amount of time that might pass before Alert is notified of an event’s occurrence. Critical events are sent to Alert as soon as they occur in the module. To identify an event as a critical event, set Is this a critical event to yes on the microblock dialog (the Critical parameter on the Parameter page).

If you are monitoring your system through a modem connection, non-critical events are stored in the gateway until a critical event occurs, the gateway is contacted by SuperVision, or the gateway buffer is full, at which time all the events are sent to Alert. If you monitor the system through a direct or network connection, Alert collects non-critical events from the gateway at predetermined intervals. These intervals are determined when the connection is configured in SuperVision; refer to the SuperVision Configuration Guide for details.

Time inputs

You have the option of overriding an event’s time and date of generation with other time and date inputs from the GFB. Normally the Alert microblock records the time and date the event occurred. This is the time and date that is shown in the event report in Alert. By enabling the microblock’s time inputs, you can specify a different time and date you want recorded for the event.

NOTE Since these inputs will override the time and date the event actually occurred, the enable TIME inputs setting should normally be set to no.

Simulation

The Simulation section of the microblock dialog is used to test the event during Eikon simulation. When using simulation to test the event, make sure Enable event is also set to yes. The Test event setting (Test on the Parameter page) must be set to no during normal operation for Alert to receive and handle events properly.

172 • Chapter 7: Log Microblocks

Page 173: Eikon 3.02 Microblock Reference

Alert Event

Optional inputs

In addition to the specific event information, the Alert microblock can record up to five other values from the GFB at the time the event is generated. These values are recorded using the Alert microblock’s optional inputs. To use these inputs, first you must define a name for the input and the input’s type (analog or digital) on the Alert microblock’s dialog. The microblock will then show the additional inputs which can then be wired to receive the appropriate information from other parts of the GFB.

In order for information from these inputs to be displayed in Alert’s event report, you must configure the event in Alert so that the information will appear. Refer to the Alert Configuration Guide for details.

Figure 7-7 shows an example of how you could use an Alert microblock to generate an event in a GFB.

Figure 7-7: Using the Alert microblock in a GFB

Chapter 7: Log Microblocks • 173

Page 174: Eikon 3.02 Microblock Reference

Alert Event

Figure 7-8: Alert event microblock dialog

Parameter page text

Event ID: ________ Enable: ___ Critical: ___ RTN reqd: ___ Test: ___

Status page text

Event ID: ~~~~~~~~ Active: ~~~ Enabled: ~~~ Test: ~~~

174 • Chapter 7: Log Microblocks

Page 175: Eikon 3.02 Microblock Reference

History Recorder

History Recorder

The History Recorder microblock records a current and previous value from a microblock in a GFB. You determine when the value is recorded. The Status page shows the current and previous values (Current cycle and Previous cycle), and the time of day and the date when the recordings were made.

The microblock’s analog input receives the value that is to be recorded. When the rec input is on, the microblock transfers the current value of its input to its primary output, and the prior output value is transferred to the prev output. The value is recorded only once while the rec input is on. For example, if the microblock is used to record the zone temperature, and the rec input remains on while the temperature changes, only the temperature that was current at the time the rec input turned on will be recorded.

Figure 7-9: History Recorder microblock dialog

Status page text

Current cycle = ~~~~~~~~~~~~~ on ~~~~~~~~~~~ ~~~~~~~~~~~~~ since ~~~~~~~~~~~ ~~~~~~~~~~~~~Previous cycle = ~~~~~~~~~~~~~ on ~~~~~~~~~~~ ~~~~~~~~~~~~~ since ~~~~~~~~~~~ ~~~~~~~~~~~~~

Microblock

Microblock Library icon

Chapter 7: Log Microblocks • 175

Page 176: Eikon 3.02 Microblock Reference

High Peak Recorder

High Peak Recorder

The High Peak Recorder microblock records the highest and previous highest value of a microblock in a GFB. You determine when the values are recorded and when the previous highest value should be replaced by the current highest value. For example, if you want to record the highest outside air temperature for each day, this microblock can record today’s highest temperature and yesterday’s highest temperature. The Status page shows the current and previous values (Current cycle and Previous cycle) and the time of day and the date when the recordings were made.

The microblock’s analog input receives the value that is to be recorded. When the rec input is on, the microblock monitors the input value. The highest value received while the rec input is on is transferred to the microblock’s primary output. This output value is transferred to the prev output when the rset input is turned on. Following is an example of how you could use this microblock to record outside air temperatures.

Figure 7-10: Using the High Peak Recorder microblock

Figure 7-11: High Peak Recorder microblock dialog

Microblock

Microblock Library icon

176 • Chapter 7: Log Microblocks

Page 177: Eikon 3.02 Microblock Reference

High Peak Recorder

Status page text

Current cycle = ~~~~~~~~~~~~~ on ~~~~~~~~~~~ ~~~~~~~~~~~~~ since ~~~~~~~~~~~ ~~~~~~~~~~~~~Previous cycle = ~~~~~~~~~~~~~ on ~~~~~~~~~~~ ~~~~~~~~~~~~~ since ~~~~~~~~~~~ ~~~~~~~~~~~~~

Chapter 7: Log Microblocks • 177

Page 178: Eikon 3.02 Microblock Reference

Low Peak Recorder

Low Peak Recorder

The Low Peak Recorder microblock records the lowest and previous lowest value of a microblock in a GFB. You determine when the values are recorded and when the previous lowest value should be replaced by the current lowest value. For example, if you want to record the lowest outside air temperature for each day, this microblock can record today’s lowest temperature and yesterday’s lowest temperature. The Status page shows the current and previous values (Current cycle and Previous cycle) and the time of day and the date when the recordings were made.

The microblock’s analog input receives the value that is to be recorded. When the rec input is on, the microblock monitors the input value. The lowest value received while the rec input is on is transferred to the microblock’s primary output. This output value is transferred to the prev output when the rset input is turned on. Following is an example of how you could use this microblock to record outside air temperatures:

Figure 7-12: Using the Low Peak Recorder microblock

Figure 7-13: Low Peak Recorder microblock dialog

Microblock

Microblock Library icon

178 • Chapter 7: Log Microblocks

Page 179: Eikon 3.02 Microblock Reference

Low Peak Recorder

Status page text

Current cycle = ~~~~~~~~~~~~~ on ~~~~~~~~~~~ ~~~~~~~~~~~~~ since ~~~~~~~~~~~ ~~~~~~~~~~~~~Previous cycle = ~~~~~~~~~~~~~ on ~~~~~~~~~~~ ~~~~~~~~~~~~~ since ~~~~~~~~~~~ ~~~~~~~~~~~~~

Chapter 7: Log Microblocks • 179

Page 180: Eikon 3.02 Microblock Reference

Runtime Accumulation

Runtime Accumulation

The Runtime Accumulation microblock calculates the amount of time in hours that a piece of equipment has been running. This microblock records the amount of time its primary digital input is on. You can reset the microblock’s value when you choose by using the microblock’s clr input.

The Preset runtime value parameter on the Parameter page allows you to define the number of hours which the microblock begins to count from. For example, if Preset runtime value is set to 5, the Runtime Accumulation microblock begins counting runtime hours at 5. The Latch in preset value now parameter resets the microblock’s value to the value indicated by the Preset runtime value setting.

The Simulation section of the microblock’s dialog allows you to determine whether a preset runtime value will be used in simulation, and what that value should be. For more information about using Eikon simulation, refer to the section “Testing the FB” of the Eikon User’s Guide.

Figure 7-14: Runtime Accumulation microblock dialog

Microblock

Microblock Library icon

180 • Chapter 7: Log Microblocks

Page 181: Eikon 3.02 Microblock Reference

Runtime Accumulation

Parameter page text

Preset runtime value _____ Latch in preset value now? _

Status page text

Total accumulated runtime = ~~~~~~ hours

♦ ♦ ♦

Chapter 7: Log Microblocks • 181

Page 182: Eikon 3.02 Microblock Reference

Runtime Accumulation

182 • Chapter 7: Log Microblocks

Page 183: Eikon 3.02 Microblock Reference

8 Control Microblocks

The Control microblocks output signals that are used mainly for control and scheduling purposes. Many of these microblocks generate colors, which are used by SuperVision to communicate the status of the Graphic Function Block (GFB). You should use a Zone Setpoint, Set Color, or Set Color If True microblock (but not a combination of these) in every GFB. Since each GFB can broadcast only one color, there cannot be more than one Zone Setpoint or Set Color microblock in a GFB. You can use more than one Set Color If True microblock; however, only one Set Color If True microblock can display its color at any given time.

The Zone Setpoint microblocks use an optimal start routine to control equipment. If you plan to use a Zone Setpoint microblock, be sure to read the section “Optimal Start” on page 185.

NOTE Zone Setpoint microblocks can only be used with Exec 6.00g and newer modules.

The following microblocks are available in the Control menu:

Zone Setpoint 190

Zone Setpoint with Demand 194

Zone Setpoint - Plus 198

Chapter 8: Control Microblocks • 183

Page 184: Eikon 3.02 Microblock Reference

Zone Setpoint with Learning Adaptive Optimal Start 204

Zone Setpoint with Demand and Learning Adaptive Op-timal Start 208

Zone Setpoint - Plus with Learning Adaptive Optimal Start 213

Setpoint Optimization 220

Set Color 222

Set Color If True 223

True If Color = 224

Scheduler 226

Scheduler with Override 227

184 • Chapter 8: Control Microblocks

Page 185: Eikon 3.02 Microblock Reference

Optimal Start

Optimal Start

All Zone Setpoint microblocks provide an optimal start routine that allows equipment to begin heating or cooling a zone before occupancy begins. This way, zone temperatures can reach the ideal comfort range at the time occupancy begins. Optimal start works by calculating setpoints during the unoccupied period that are gradually adjusted toward the occupied setpoints. The adjusted setpoints and their rate of change are calculated using the following information:

• Occupancy mode (occupied/unoccupied) - received from the occ input

• Time remaining in current mode - received from the for input

• Current zone temperature - received from the zone input

• Current electrical demand level - received from the dem input (not available on all Zone Setpoint microblocks)

• Current outside air temperature - received from the module’s firmware

• Heating/cooling capacity of the zone in question - entered on the microblock’s dialog or the Parameter page

Once optimal start begins, the GFB’s color changes from gray (unoccupied) to the appropriate color according to the occupied color band on the setpoint graph. As the optimal start routine continues to adjust the unoccupied setpoints toward the occupied setpoints, the zone temperature changes with it, ideally reaching the desired range by the time occupancy begins.

Depending on which Zone Setpoint microblock you are using, it may be possible to prevent heating and cooling setpoints from being adjusted due to optimal start. Refer to the individual microblock descriptions for details.

The rate at which the setpoints are adjusted relates directly to the heating and cooling capacities of the equipment. The optimal start routine calculates the actual heating or cooling capacity of the

Chapter 8: Control Microblocks • 185

Page 186: Eikon 3.02 Microblock Reference

Optimal Start

equipment at the current outside air temperature using the following formulas.

Formulas for heating setpoint during optimal start period

Use the following formulas for Exec 6.00g and later modules.

t = time remaining until the transition to the occupied state (hours)OAT =outside air temperature (°F)HDESIGN =heating design tempHCAP =heating capacityHUNOCC =heating setpoint when unoccupiedHOCC =heating setpoint when occupied

H1 = (HDESIGN - OAT) / (HDESIGN - 65F) * HCAP

H2 = HUNOCC + ((12 - MIN(t,12)) / 12) * (HOCC - HUNOCC)

H3 = MAX(MIN (H2, HOCC - (t * H1)), HUNOCC)

HSP = H3 + (H3 - HUNOCC) * (1 - (H3 - HUNOCC) / (HOCC - HUNOCC))

Cooling setpoint during optimal start period:

t = time remaining until the transition to the occupied state (hours)OAT =outside air temperature (°F)CDESIGN =cooling design tempCCAP =cooling capacityCUNOCC =cooling setpoint when unoccupiedCOCC =cooling setpoint when occupied

C1 = (CDESIGN - OAT) / (CDESIGN - 65F) * CCAP

C2 = CUNOCC + ((12 - MIN(t,12)) / 12) * (COCC - CUNOCC)

C3 = MIN(MAX (C2, COCC + (t * C1)), CUNOCC)

CSP = C3 + (C3 - CUNOCC) * (1 - (C3 - CUNOCC) / (COCC - CUNOCC))

Use the following formulas for Exec 6.00g and later modules.

186 • Chapter 8: Control Microblocks

Page 187: Eikon 3.02 Microblock Reference

Optimal Start

Use the following formula for versions earlier than Exec 6.00g.

Learning adaptive optimal start

Using learning adaptive optimal start, if the zone’s ideal temperature range is not reached by the time occupancy begins, or if it is reached too soon, the heating or cooling capacities of the equipment are adjusted up or down for the next unoccupied period. You determine the amount of the adjustment, depending on the color actually achieved at the beginning of occupancy, on the microblock’s dialog or on the Parameter page. The following formulas use the adjusted heating and cooling capacities to calculate the current setpoints for Exec 6.00g and later modules.

Heating setpoint during optimal start period:

t = time remaining until the transition to the occupied state(hours)

OAT =outside air temperature (°F)HDESIGN =heating design tempLearned HCAP =learned heating capacityHUNOCC =heating setpoint when unoccupiedHOCC =heating setpoint when occupied

H1 = (HDESIGN - OAT) / (HDESIGN - 65F) * Learned HCAP

H2 = HUNOCC + ((12 - MIN(t,12)) / 12) * (HOCC - HUNOCC)

H3 = MAX(MIN (H2, HOCC - (t * H1)), HUNOCC)

HSP = H3 + (H3 - HUNOCC) * (1 - (H3 - HUNOCC) / (HOCC - HUNOCC))

Actual Capacity = Design Temp - OATDesign Temp - 65°F

X Capacity at 65°F

Chapter 8: Control Microblocks • 187

Page 188: Eikon 3.02 Microblock Reference

Optimal Start

Cooling setpoint during optimal start period:

t = time remaining until the transition to the occupied state(hours)

OAT =outside air temperature (°F)CDESIGN =cooling design tempLearned CCAP =learned cooling capacityCUNOCC =cooling setpoint when unoccupiedCOCC =cooling setpoint when occupied

C1 = (CDESIGN - OAT) / (CDESIGN - 65F) * Learned CCAP

C2 = CUNOCC + ((12 - MIN(t,12)) / 12) * (COCC - CUNOCC)

C3 = MIN(MAX (C2, COCC + (t * C1)), CUNOCC)

CSP = C3 + (C3 - CUNOCC) * (1 - (C3 - CUNOCC) / (COCC - CUNOCC))

Use the following formula for modules earlier than Exec 6.00g.

Because learning adaptive optimal start uses learned capacities, the optimal start calculations are more accurate and equipment is controlled more efficiently. The current learned capacities are displayed on the Status page and are available to other parts of the GFB from the microblock’s HCAP and CCAP outputs. Following is an example of how learning adaptive optimal start works:

Example

The heating capacity for the zone is 5 degrees per hour. When the zone becomes occupied, the zone temperature is 1 degree below the occupied setpoint, indicating a need for additional heat. Since the zone temperature was low by 1 degree, the heating capacity will be decreased by the light blue Learning Adaptive Optimal Start value (1 degree below setpoint is in the light blue region). If the light blue Learning Adaptive Optimal Start value is 0.06, the heating capacity will be adjusted to 4.94 for the next optimal start

Actual Capacity = Design Temp - OATDesign Temp - 65°F

X Learned Capacity

188 • Chapter 8: Control Microblocks

Page 189: Eikon 3.02 Microblock Reference

Optimal Start

period. This causes the setpoint adjustment to begin sooner in the next unoccupied period.

Enter the Learning Adaptive Optimal Start values on the microblock’s dialog or on the Parameter page. In heating mode, the microblock subtracts the adjustment value from the heating capacity. In cooling mode, the microblock adds the adjustment value to the cooling capacity. The learning adaptive optimal start routine will not adjust the learned heating or cooling capacities lower than .0625 or higher than 15.938 degrees per hour.

If you are using learning adaptive optimal start, be aware that learned capacities can be distorted during override periods. For this reason, you should prevent learned capacities from being adjusted during override periods by using the microblock’s LRNI input. When this input is turned on, learning adaptive optimal start will still occur, but the learned heating and cooling capacities will not be changed from the previous unoccupied period’s values.

Also, make sure that all other control sequences in the GFB, including PID loops, are tuned and functioning properly before using the learning adaptive optimal start microblocks. Otherwise, setpoints could be improperly adjusted.

Chapter 8: Control Microblocks • 189

Page 190: Eikon 3.02 Microblock Reference

Zone Setpoint

Zone Setpoint

The Zone Setpoint microblock is used to calculate effective setpoints and zone colors for GFBs controlling single zone equipment. You can determine a zone’s setpoints for both occupied and unoccupied periods; however, because of factors such as local overrides or optimal start routines, the zone’s effective setpoints may be calculated differently by the microblock. The color generated by the microblock represents the status of the GFB to SuperVision and can be used by other microblocks in the GFB (such as the True if Color = microblock) to perform additional control.

NOTE Do not use the Zone Setpoint microblock in combination with the Set Color or Set Color If True microblocks in the same GFB. There cannot be more than one Zone Setpoint microblock in a GFB.

The microblock’s occ and for inputs provide information used during adaptive optimal start (see the section “Optimal Start” on page 185). The occ input indicates whether or not the zone is currently occupied, and the for input indicates the amount of time remaining until the occupancy status changes. Occupancy is normally determined by a Scheduler or Scheduler with Override microblock. If some other method is used to determine occupancy, attach a Binary Status microblock to the wire that leads into the Zone Setpoint’s occ input. This status microblock should be given an MbCode of MOCC. This will enable SuperVision to display the correct occupancy on the setpoint graph.

The zone input receives the current zone temperature. The color broadcast by the microblock is based on the zone temperature in relation to the effective setpoints. The ht and cl outputs on the microblock contain the effective heating and cooling setpoints, respectively. If the zone is occupied, the effective setpoints are the same as those defined on the microblock dialog, the Parameter page, or the setpoint graph. If the zone is currently unoccupied, the microblock calculates effective setpoints for an adaptive optimal start routine (see the section “Optimal Start” on page 185).

Microblock

Microblock Library icon

190 • Chapter 8: Control Microblocks

Page 191: Eikon 3.02 Microblock Reference

Zone Setpoint

Figure 8-1: Using the Zone Setpoint microblock

Figure 8-2: Zone Setpoint microblock dialog

Zone Setpoint parameters

The Design Temp section of the microblock dialog indicates the extreme outside temperatures at which equipment must run constantly in order to maintain comfort. Design temperatures are based on the geographic area of the building and are available from ASHRAE publications and most design references. On the Parameter page, use the Heating Design Temp and Cooling Design Temp settings to change these values.

The Capacity section of the microblock dialog indicates the maximum rate (in degrees F per hour) at which the heating and cooling equipment can change the temperature if the outside air temperature

Chapter 8: Control Microblocks • 191

Page 192: Eikon 3.02 Microblock Reference

Zone Setpoint

is 65°F. The accuracy of these values affects the ability of the equipment to bring the zone temperature to the occupied setpoint exactly at occupancy time, rather than too early or too late. On the Parameter page, use the Heating Capacity and Cooling Capacity settings to change these values.

On the microblock dialog, the settings on the colored bands determine the width (in degrees) of the colored bands on the setpoint graph in SuperVision. Actual occupied and unoccupied setpoint values can be entered in the heating setpt and cooling setpt fields beneath the graph on the microblock dialog, or using the Heating and Cooling settings on the Parameter page.

On the Parameter page, the Bands settings determine the width of the color bands on the setpoint graph. The Free setting determines the width of the speckled green band (which allows free cooling from the outside air dampers when appropriate). If free cooling is not available, this parameter should be set to 0.00. The Stage 1 setting determines the width of the yellow band for cooling and the light blue band for heating, and the Stage 2 setting determines the width of the orange band for cooling and the dark blue band for heating.

The Color Change Hysteresis is represented by the Hyst setting on the Parameter page. When returning to normal, it is the number of degrees required to exceed the setpoint before the microblock’s color changes. An appropriate hysteresis prevents equipment from "chattering" when the temperature is very close to and oscillating around the setpoint.

Parameter page text

Set Points Occ Unocc Free Stg1 Stg2 Hyst Heating _____ _____ Bands ____ ____ ____ Cooling _____ _____ Bands ____ ____ ____ Heating Capacity ____ (deg/hr) Heating Design Temp _____Cooling Capacity ____ (deg/hr) Cooling Design Temp _____

192 • Chapter 8: Control Microblocks

Page 193: Eikon 3.02 Microblock Reference

Zone Setpoint

Status page text

Effective Set Points: Red | DkBlue | LtBlue | Green | Yellow | Orange | Red ~~~~~ ~~~~~ ~~~~~ ~~~~~ ~~~~~ ~~~~~

Chapter 8: Control Microblocks • 193

Page 194: Eikon 3.02 Microblock Reference

Zone Setpoint with Demand

Zone Setpoint with Demand

The Zone Setpoint with Demand microblock is used to calculate effective setpoints and zone colors for single zone equipment. You can determine a zone’s setpoints for both occupied and unoccupied periods; however, because of factors such as local overrides, demand level, or optimal start routines, the zone’s effective setpoints may be calculated differently by the microblock. The color generated by the microblock represents the status of the GFB to SuperVision and can be used by other microblocks in the GFB (such as the True if Color = microblock) to perform additional control.

NOTE Do not use the Zone Setpoint with Demand microblock in combination with the Set Color or Set Color If True microblocks in the same GFB. There cannot be more than one Zone Setpoint microblock in a GFB.

The microblock’s occ, for, and dem inputs provide information used during adaptive optimal start (see the section “Optimal Start” on page 185). The dem input indicates the current electrical demand level (obtained from a Get Electrical Demand Level or LAN Input microblock). The occ input indicates whether or not the zone is currently occupied, and the for input indicates the amount of time remaining until the occupancy status changes.

Occupancy is normally determined by a Scheduler or Scheduler with Override microblock. If some other method is used to determine occupancy, attach a Binary Status microblock to the wire that leads into the Zone Setpoint’s occ input. This status microblock should be given an MbCode of MOCC. This enables SuperVision to display the correct occupancy on the setpoint graph.

The zone input receives the current zone temperature. The color broadcast by the microblock is based on the zone temperature in relation to the effective setpoints. The ht and cl outputs on the microblock contain the effective heating and cooling setpoints, respectively.

Microblock

Microblock Library icon

194 • Chapter 8: Control Microblocks

Page 195: Eikon 3.02 Microblock Reference

Zone Setpoint with Demand

Figure 8-3: Using the Zone Setpoint with Demand microblock

Figure 8-4: Zone Setpoint with Demand microblock dialog

Zone Setpoint with Demand parameters

The Design Temp section of the microblock dialog indicates the extreme outside temperatures at which equipment must run constantly in order to maintain comfort. Design temperatures are based on the geographic area of the building and are available from ASHRAE publications and most design references. On the Parameter

Chapter 8: Control Microblocks • 195

Page 196: Eikon 3.02 Microblock Reference

Zone Setpoint with Demand

page, use the Heating Design Temp and Cooling Design Temp settings to change these values.

The Capacity section of the microblock dialog indicates the maximum rate (in degrees F per hour) at which the heating and cooling equipment can change the temperature if the outside air temperature is 65°F. The accuracy of these values affects the ability of the equipment to bring the zone temperature to the occupied setpoint exactly at occupancy time, rather than too early or too late. On the Parameter page, use the Heating Capacity and Cooling Capacity settings to change these values.

On the microblock dialog, the settings on the colored bands determine the width (in degrees) of the colored bands on the setpoint graph in SuperVision for each level of electrical demand (0, 1, 2, or 3). The occupied band represents demand level zero. For each increase in the level of demand, you can offset the width of the color bands on the setpoint graph by the number of degrees indicated on the appropriate band.

Actual occupied and unoccupied setpoint values can be entered in the heating setpt and cooling setpt fields beneath the graph (the Heating and Cooling settings on the Parameter page). When the zone is occupied, these values, adjusted for demand level, are the effective setpoints. When the zone is unoccupied, the microblock calculates effective setpoints using the adaptive optimal start routine (see the section “Optimal Start” on page 185).

For example, Figure 8-6 shows the dem1 band’s cooling offset is 1.00, and the occupied cooling setpoint is 76.00. When the building is occupied and operating under demand level 1, the effective cooling setpoint is then 77.00. This effective setpoint is further adjusted by the value of the microblock’s cadj input. This strategy allows the total building demand to be lowered, often without shutting off any equipment.

On the Parameter page, the Bands settings determine the width of the color bands on the setpoint graph. The Free setting determines the width of the speckled green band (which allows free cooling from the outside air dampers when appropriate). If free cooling is not available, this parameter should be set to 0.00. The Stg1 setting determines the width of the yellow band for cooling and the light blue

196 • Chapter 8: Control Microblocks

Page 197: Eikon 3.02 Microblock Reference

Zone Setpoint with Demand

band for heating, and the Stg2 setting determines the width of the orange band for cooling and the dark blue band for heating. These settings for Free, Stg1 and Stg2 are used when the demand level is zero. The Offset settings allow you to enter an amount (in degrees) by which the Free, Stg1, and Stg2 settings will be adjusted for each level of demand.

The Color Change Hysteresis is represented by the Hyst setting on the Parameter page. When returning to normal, it is the number of degrees required to exceed the setpoint before the microblock’s color changes. An appropriate hysteresis prevents equipment from "chattering" when the temperature is very close to and oscillating around the setpoint.

Parameter page text

Set Points Occ Unocc Free Stg1 Stg2 Dem1 Dem2 Dem3 Hyst Heating _____ _____ Bands ____ ____ Offset ____ ____ ____ ____ Cooling _____ _____ Bands ____ ____ ____ Offset ____ ____ ____Heating Capacity ____ (deg/hr) Heating Design Temp _____Cooling Capacity ____ (deg/hr) Cooling Design Temp _____

Status page text

Effective Set Points: Red | DkBlue | LtBlue | Green | Yellow | Orange | Red ~~~~~ ~~~~~ ~~~~~ ~~~~~ ~~~~~ ~~~~~

Chapter 8: Control Microblocks • 197

Page 198: Eikon 3.02 Microblock Reference

Zone Setpoint - Plus

Zone Setpoint - Plus

The Zone Setpoint - Plus microblock is used to calculate effective setpoints and zone colors for single zone equipment. This microblock offers the same features as the Zone Setpoint and Zone Setpoint with Demand microblocks and includes the following additional features:

• Remote setpoint adjustment (the hadj and cadj inputs on the microblock)

• Optimal start inhibit (the hosi and cosi inputs on the microblock)

• Night setback mode notification (the ns output on the microblock). This output turns on when the zone is unoccupied, optimal start is not in progress, and the unoccupied heating or cooling setpoint has been exceeded

You can determine a zone’s setpoints for both occupied and unoccupied periods; however, because of factors such as local overrides, demand level, setpoint adjustments, or optimal start routines, the zone’s effective setpoints may be calculated differently by the microblock. The color generated by the microblock represents the status of the GFB to SuperVision and can be used by other microblocks in the GFB (such as the True if Color = microblock) to perform additional control.

NOTE Do not use the Zone Setpoint with Demand microblock in combination with the Set Color or Set Color If True microblocks in the same GFB. There cannot be more than one Zone Setpoint microblock in a GFB.

Microblock

Microblock Library icon

198 • Chapter 8: Control Microblocks

Page 199: Eikon 3.02 Microblock Reference

Zone Setpoint - Plus

The following table describes the microblock’s inputs and outputs.

Occupancy is normally determined by a Scheduler or Scheduler with Override microblock. If some other method is used to determine occupancy, attach a Binary Status microblock to the wire that leads into the Zone Setpoint’s occ input. This status microblock should be

Table 8-1. Zone Setpoint - Plus microblock inputs and outputs

Input or Output Description

occ Digital input - indicates whether or not the zone is currently occupied

for Analog input - indicates how long the zone will remain in its current state of occupancy

zone Analog input - current zone temperature

dem Analog input - current electrical demand level. This is normally received from a Get Electrical Demand Level or LAN Input microblock and should be a value of 0, 1, 2, or 3

hadj Analog input - the amount (in degrees) by which the heating setpoint should be adjusted

cadj Analog input - the amount (in degrees) by which the cooling setpoint should be adjusted

hosi Digital input - indicates whether or not the heating setpoint will be affected by adaptive optimal start

cosi Digital input - indicates whether or not the cooling setpoint will be affected by adaptive optimal start

color Analog output - the color representing the zone’s temperature in relation to the zone’s effective setpoints

ht Analog output - the zone’s effective heating setpoint

cl Analog output - the zone’s effective cooling setpoint

ns Digital output - indicates whether or not the zone is in night setback mode

Chapter 8: Control Microblocks • 199

Page 200: Eikon 3.02 Microblock Reference

Zone Setpoint - Plus

given an MbCode of MOCC. This will enable SuperVision to display the correct occupancy on the setpoint graph.

Figure 8-5: Using the Zone Setpoint - Plus microblock

Zone Setpoint - Plus parameters

The Design Temp section of the microblock dialog indicates the extreme outside temperatures at which equipment must run constantly in order to maintain comfort. Design temperatures are based on the geographic area of the building and are available from ASHRAE publications and most design references. On the Parameter page, use the Heating Design Temp and Cooling Design Temp settings to change these values.

The Capacity section of the microblock dialog indicates the maximum rate (in degrees F per hour) at which the heating and cooling equipment can change the temperature if the outside air temperature is 65°F. The accuracy of these values affects the ability of the equipment to bring the zone temperature to the occupied setpoint exactly at occupancy time, rather than too early or too late. On the Parameter page, use the Heating Capacity and Cooling Capacity settings to change these values.

200 • Chapter 8: Control Microblocks

Page 201: Eikon 3.02 Microblock Reference

Zone Setpoint - Plus

Figure 8-6: Zone Setpoint - Plus microblock dialog

On the microblock dialog, the settings on the colored bands determine the width (in degrees) of the colored bands on the setpoint graph in SuperVision for each level of electrical demand (0, 1, 2, or 3). The occupied band represents demand level zero. For each increase in the level of demand, you can offset the width of the color bands on the setpoint graph by the number of degrees indicated on the appropriate band.

Actual occupied and unoccupied setpoint values can be entered in the heating setpt and cooling setpt fields beneath the graph (the Heating and Cooling settings on the Parameter page). When the zone is occupied, these values, adjusted for demand level and additional inputs (the hadj and cadj inputs on the microblock), are the effective setpoints. When the zone is unoccupied, the microblock calculates effective setpoints using the adaptive optimal start routine (see the section “Optimal Start” on page 185).

Chapter 8: Control Microblocks • 201

Page 202: Eikon 3.02 Microblock Reference

Zone Setpoint - Plus

For example, Figure 8-6 shows the dem1 band’s cooling offset is 1.00, and the occupied cooling setpoint is 76.00. When the building is occupied and operating under demand level 1, the effective cooling setpoint is then 77.00. This effective setpoint is further adjusted by the value of the microblock’s cadj input. This strategy allows the total building demand to be lowered, often without shutting off any equipment.

On the Parameter page, the Bands settings determine the width of the color bands on the setpoint graph. The Free setting determines the width of the speckled green band (which allows free cooling from the outside air dampers when appropriate). If free cooling is not available, this parameter should be set to 0.00. The Stg1 setting determines the width of the yellow band for cooling and the light blue band for heating, and the Stg2 setting determines the width of the orange band for cooling and the dark blue band for heating. These settings for Free, Stg1 and Stg2 are used when the demand level is zero. The Offset settings allow you to enter an amount (in degrees) by which the Free, Stg1, and Stg2 settings will be adjusted for each level of demand.

The Color Change Hysteresis is represented by the Hyst setting on the Parameter page. When returning to normal, it is the number of degrees required to exceed the setpoint before the microblock’s color changes. The hysteresis prevents equipment from "chattering" when the temperature is oscillating around the setpoint.

Preventing adaptive optimal start adjustments

The Zone Setpoint - Plus microblock allows you to prevent heating or cooling effective setpoints from being calculated using the adaptive optimal start routine described above. When the microblock’s hosi input receives an on signal, heating setpoints are not adjusted using the adaptive optimal start routine. When the microblock’s cosi input receives an on signal, cooling setpoints are not adjusted using the adaptive optimal start routine. Even if these inputs are on, however, effective setpoints may be adjusted based on other inputs or demand limiting.

202 • Chapter 8: Control Microblocks

Page 203: Eikon 3.02 Microblock Reference

Zone Setpoint - Plus

Parameter page text

Set Points Occ Unocc Free Stg1 Stg2 Dem1 Dem2 Dem3 Hyst Heating _____ _____ Bands ____ ____ Offset ____ ____ ____ ____ Cooling _____ _____ Bands ____ ____ ____ Offset ____ ____ ____Heating Capacity ____ (deg/hr) Heating Design Temp _____Cooling Capacity ____ (deg/hr) Cooling Design Temp _____

Status page text

Effective Set Points: Red | DkBlue | LtBlue | Green | Yellow | Orange | Red ~~~~~ ~~~~~ ~~~~~ ~~~~~ ~~~~~ ~~~~~

Chapter 8: Control Microblocks • 203

Page 204: Eikon 3.02 Microblock Reference

Zone Setpoint with Learning Adaptive Optimal Start

Zone Setpoint with Learning Adaptive Optimal Start

The Zone Setpoint with Learning Adaptive Optimal Start microblock is used to calculate effective setpoints and zone colors for single zone equipment. You can determine a zone’s setpoints for both occupied and unoccupied periods; however, because of factors such as local overrides or optimal start routines, the zone’s effective setpoints may be calculated differently by the microblock. The color generated by the microblock represents the status of the GFB to SuperVision and can be used by other microblocks in the GFB (such as the True if Color = microblock) to perform additional control.

The microblock’s OCC and FOR inputs provide information used during learning adaptive optimal start (see the section “Optimal Start” on page 185). The OCC input indicates whether or not the zone is currently occupied, and the FOR input indicates the amount of time remaining until the occupancy status changes. Occupancy is normally determined by a Scheduler or Scheduler with Override microblock. If some other method is used to determine occupancy, attach a Binary Status microblock to the wire that leads into the Zone Setpoint’s occ input. This status microblock should be given an MbCode of MOCC. This enables SuperVision to display the correct occupancy on the setpoint graph.

The ZONE input receives the current zone temperature. The color broadcast by the microblock is based on the zone temperature in relation to the effective setpoints. The HT and CL outputs on the microblock contain the effective heating and cooling setpoints, respectively. If the zone is occupied, the effective setpoints are the same as those defined on microblock dialog, the Parameter page, or the setpoint graph. If the zone is currently unoccupied, the microblock calculates effective setpoints using the learning adaptive optimal start routine (see the section “Optimal Start” on page 185).

The HCAP and CCAP outputs contain the learned heating and cooling capacities calculated by the learning adaptive optimal start routine. Refer to the section “Learning adaptive optimal start” on page 187 for details.

Microblock

Microblock Library icon

204 • Chapter 8: Control Microblocks

Page 205: Eikon 3.02 Microblock Reference

Zone Setpoint with Learning Adaptive Optimal Start

NOTE Do not use the Zone Setpoint with Learning Adaptive Optimal Start microblock in combination with the Set Color or Set Color If True microblocks in the same GFB. There cannot be more than one Zone Setpoint microblock in a GFB.

Figure 8-7: Using the Zone Setpoint with Learning Adaptive Optimal Start microblock

Zone Setpoint with Learning Adaptive Optimal Start parameters

The Design Temp section of the microblock dialog indicates the extreme outside temperatures at which equipment must run constantly in order to maintain comfort. Design temperatures are based on the geographic area of the building and are available from ASHRAE publications and most design references. On the Parameter page, use the Heating Design Temp and Cooling Design Temp settings to change these values.

The Capacity section of the microblock dialog indicates the maximum rate (in degrees F per hour) at which the heating and cooling equipment can change the temperature if the outside air temperature is 65°F. On the Parameter page, use the Heating Capacity and Cooling Capacity settings to change these values. The actual heating and cooling capacities used to calculate optimal start may vary because of the way learning adaptive optimal start is performed. Refer to the section “Learning adaptive optimal start” on page 187.

If the heating and cooling capacity parameters are changed and transferred to the module, the learned heating and cooling capacities will change to the new values. If the capacities are not changed but other parameters from the GFB are transferred to the module, the learned capacities will not be affected.

Chapter 8: Control Microblocks • 205

Page 206: Eikon 3.02 Microblock Reference

Zone Setpoint with Learning Adaptive Optimal Start

The Learning Adaptive Optimal Start settings determine the amount by which the heating or cooling capacities are adjusted, depending on the zone’s color when occupancy begins. A different value may be entered for each color. Note that two values may be entered for the color green: one for heating mode (the left-hand value) and one for cooling mode (the right-hand value).

Figure 8-8: Zone Setpoint with Learning Adaptive Optimal Start microblock dialog

On the microblock dialog, the settings on the colored bands determine the width (in degrees) of the colored bands on the setpoint graph in SuperVision. Actual occupied and unoccupied setpoint values can be entered in the heating setpt and cooling setpt fields beneath the graph on the microblock dialog, or using the Heating and Cooling settings on the Parameter page.

On the Parameter page, the Bands settings determine the width of the color bands on the setpoint graph. The Free setting determines the width of the speckled green band (which allows free cooling from the outside air dampers when appropriate). If free cooling is not available, this parameter should be set to 0.00. The Stage 1 setting determines the width of the yellow band for cooling and the light blue

206 • Chapter 8: Control Microblocks

Page 207: Eikon 3.02 Microblock Reference

Zone Setpoint with Learning Adaptive Optimal Start

band for heating, and the Stage 2 setting determines the width of the orange band for cooling and the dark blue band for heating.

The Color Change Hysteresis is represented by the Hyst setting on the Parameter page. When returning to normal, it is the number of degrees required to exceed the setpoint before the microblock’s color changes. An appropriate hysteresis prevents equipment from "chattering" when the temperature is very close to and oscillating around the setpoint.

Parameter page text

Set Points Occ Unocc Free Stg1 Stg2 Hyst Heating _____ _____ Bands ____ ____ ____ Cooling _____ _____ Bands ____ ____ ____ Heating Capacity ____ (deg/hr) Heating Design Temp _____Cooling Capacity ____ (deg/hr) Cooling Design Temp _____Learning Adaptive Optimal Start: Upon transitioning from Unoccupied to Occupied, apply these values: Red | DkBlue | LtBlue | Green or SpGrn | Yellow | Orange | Red _____ _____ _____ _____ _____ _____ _____ _____

Status page text

Effective Set Points: Red | DkBlue | LtBlue | Green | Yellow | Orange | Red ~~~~~ ~~~~~ ~~~~~ ~~~~~ ~~~~~ ~~~~~The learned cooling capacity is ~~~~~; Adjusted cooling capacity is ~~~~~.The learned heating capatity is ~~~~~; Adjusted heating capacity is ~~~~~.

Chapter 8: Control Microblocks • 207

Page 208: Eikon 3.02 Microblock Reference

Zone Setpoint with Demand and Learning Adaptive Optimal Start

Zone Setpoint with Demand and Learning Adaptive Optimal Start

The Zone Setpoint with Demand and Learning Adaptive Optimal Start microblock is used to calculate effective setpoints and zone colors for single zone equipment. You can determine a zone’s setpoints for both occupied and unoccupied periods; however, because of factors such as local overrides, demand level, or optimal start routines, the zone’s effective setpoints may be calculated differently by the microblock. The color generated by the microblock represents the status of the GFB to SuperVision and can be used by other microblocks in the GFB (such as the True if Color = microblock) to perform additional control.

The microblock’s OCC and FOR inputs provide information used during learning adaptive optimal start (see the section “Optimal Start” on page 185). The OCC input indicates whether or not the zone is currently occupied, and the FOR input indicates the amount of time remaining until the occupancy status changes.

Occupancy is normally determined by a Scheduler or Scheduler with Override microblock. If some other method is used to determine occupancy, attach a Binary Status microblock to the wire that leads into the Zone Setpoint’s occ input. This status microblock should be given an MbCode of MOCC. This enables SuperVision to display the correct occupancy on the setpoint graph.

The ZONE input receives the current zone temperature. The color broadcast by the microblock is based on the zone temperature in relation to the effective setpoints. The DEM input indicates the current electrical demand level (obtained from a Get Electrical Demand Level or LAN Input microblock). The HT and CL outputs on the microblock contain the effective heating and cooling setpoints, respectively.

The HCAP and CCAP outputs contain the learned heating and cooling capacities calculated by the learning adaptive optimal start routine. Refer to the section “Learning adaptive optimal start” on page 187 for details.

Microblock

Microblock Library icon

208 • Chapter 8: Control Microblocks

Page 209: Eikon 3.02 Microblock Reference

Zone Setpoint with Demand and Learning Adaptive Optimal Start

NOTE Do not use the Zone Setpoint with Learning Adaptive Optimal Start microblock in combination with the Set Color or Set Color If True microblocks in the same GFB. There cannot be more than one Zone Setpoint microblock in a GFB.

Figure 8-9: Using the Zone Setpoint with Demand and Learning Adaptive Optimal Start microblock

Zone Setpoint with Demand and Learning Adaptive Optimal Start parameters

The Design Temp section of the microblock dialog indicates the extreme outside temperatures at which equipment must run constantly in order to maintain comfort. Design temperatures are based on the geographic area of the building and are available from ASHRAE publications and most design references. On the Parameter page, use the Heating Design Temp and Cooling Design Temp settings to change these values.

The Capacity section of the microblock dialog indicates the maximum rate (in degrees F per hour) at which the heating and cooling equipment can change the temperature if the outside air temperature is 65°F. On the Parameter page, use the Heating Capacity and Cooling Capacity settings to change these values. The actual heating and cooling capacities used to calculate optimal start may vary because of the way learning adaptive optimal start is performed. Refer to the section “Learning adaptive optimal start” on page 187.

If the heating and cooling capacity parameters are changed and transferred to the module, the learned heating and cooling capacities will change to the new values. If the capacities are not changed but other parameters from the GFB are transferred to the module, the learned capacities will not be affected.

Chapter 8: Control Microblocks • 209

Page 210: Eikon 3.02 Microblock Reference

Zone Setpoint with Demand and Learning Adaptive Optimal Start

The Learning Adaptive Optimal Start settings determine the amount by which the heating or cooling capacities are adjusted, depending on the zone’s color when occupancy begins. A different value may be entered for each color. Note that two values may be entered for the color green: one for heating mode (the left-hand value) and one for cooling mode (the right-hand value).

.Figure 8-10: Zone Setpoint with Demand and Learning Adaptive Optimal Start microblock

dialog

On the microblock dialog, the settings on the colored bands determine the width (in degrees) of the colored bands on the setpoint graph in SuperVision for each level of electrical demand (0, 1, 2, or 3). The occupied band represents demand level zero. For each increase in the level of demand, you can offset the width of the color bands on the setpoint graph by the number of degrees indicated on the appropriate band.

210 • Chapter 8: Control Microblocks

Page 211: Eikon 3.02 Microblock Reference

Zone Setpoint with Demand and Learning Adaptive Optimal Start

Actual occupied and unoccupied setpoint values can be entered in the heating setpt and cooling setpt fields beneath the graph (the Heating and Cooling settings on the Parameter page). When the zone is occupied, these values, adjusted for demand level, are the effective setpoints. When the zone is unoccupied, the microblock calculates effective setpoints using the learning adaptive optimal start routine (see the section “Optimal Start” on page 185).

For example, Figure 8-10 shows the dem1 band’s cooling offset is 1.00, and the occupied cooling setpoint is 76.00. When the building is occupied and operating under demand level 1, the effective cooling setpoint is then 77.00. This effective setpoint is further adjusted by the value of the microblock’s cadj input. This strategy allows the total building demand to be lowered, often without shutting off any equipment.

On the Parameter page, the Bands settings determine the width of the color bands on the setpoint graph. The Free setting determines the width of the speckled green band (which allows free cooling from the outside air dampers when appropriate). If free cooling is not available, this parameter should be set to 0.00. The Stg1 setting determines the width of the yellow band for cooling and the light blue band for heating, and the Stg2 setting determines the width of the orange band for cooling and the dark blue band for heating. These settings for Free, Stg1 and Stg2 are used when the demand level is zero. The Offset settings allow you to enter an amount (in degrees) by which the Free, Stg1, and Stg2 settings will be adjusted for each level of demand.

The Color Change Hysteresis is represented by the Hyst setting on the Parameter page. When returning to normal, it is the number of degrees required to exceed the setpoint before the microblock’s color changes. An appropriate hysteresis prevents equipment from "chattering" when the temperature is very close to and oscillating around the setpoint.

Parameter page text

Set Points Occ Unocc Free Stg1 Stg2 Dem1 Dem2 Dem3 Hyst Heating _____ _____ Bands ____ ____ Offset ____ ____ ____ ____ Cooling _____ _____ Bands ____ ____ ____ Offset ____ ____ ____Heating Capacity ____ (deg/hr) Heating Design Temp _____

Chapter 8: Control Microblocks • 211

Page 212: Eikon 3.02 Microblock Reference

Zone Setpoint with Demand and Learning Adaptive Optimal Start

Cooling Capacity ____ (deg/hr) Cooling Design Temp _____Learning Adaptive Optimal Start: Upon transitioning from Unoccupied to Occupied, apply these values: Red | DkBlue | LtBlue | Green or SpGrn | Yellow | Orange | Red _____ _____ _____ _____ _____ _____ _____ _____

Status page text

Effective Set Points: Red | DkBlue | LtBlue | Green | Yellow | Orange | Red ~~~~~ ~~~~~ ~~~~~ ~~~~~ ~~~~~ ~~~~~The learned cooling capacity is ~~~~~; Adjusted cooling capacity is ~~~~~.The learned heating capatity is ~~~~~; Adjusted heating capacity is ~~~~~.

212 • Chapter 8: Control Microblocks

Page 213: Eikon 3.02 Microblock Reference

Zone Setpoint - Plus with Learning Adaptive Optimal Start

Zone Setpoint - Plus with Learning Adaptive Optimal Start

The Zone Setpoint - Plus with Learning Adaptive Optimal Start microblock is used to calculate effective setpoints and zone colors for single zone equipment. You can determine a zone’s setpoints for both occupied and unoccupied periods; however, because of factors such as local overrides, demand level, or optimal start routines, the zone’s effective setpoints may be calculated differently by the microblock. The color generated by the microblock represents the status of the GFB to SuperVision and can be used by other microblocks in the GFB (such as the True if Color = microblock) to perform additional control. This microblock also offers the following additional features:

• Remote setpoint adjustment (the HADJ and CADJ inputs on the microblock)

• Optimal start inhibit (the HOSI and COSI inputs on the microblock)

• Night setback mode notification (the NS output on the microblock). This output turns on when the zone is unoccupied, optimal start is not in progress, and the unoccupied heating or cooling setpoint has been exceeded

NOTE Do not use the Zone Setpoint with Learning Adaptive Optimal Start microblock in combination with the Set Color or Set Color If True microblocks in the same GFB. There cannot be more than one Zone Setpoint microblock in a GFB.

The following table describes the microblock’s inputs and outputs.

Table 8-2. Zone Setpoint - Plus with Learning Adaptive Optimal Start microblock inputs and outputs

Input or Output Description

OCC Digital input - indicates whether or not the zone is currently occupied

FOR Analog input - indicates how long the zone will remain in its current state of occupancy

Microblock

Microblock Library icon

Chapter 8: Control Microblocks • 213

Page 214: Eikon 3.02 Microblock Reference

Zone Setpoint - Plus with Learning Adaptive Optimal Start

ZONE Analog input - current zone temperature

DEM Analog input - current electrical demand level. This is normally received from a Get Electrical Demand Level or LAN Input microblock and should be a value of 0, 1, 2, or 3

HADJ Analog input - the amount (in degrees) by which the heating setpoint should be adjusted.

CADJ Analog input - the amount (in degrees) by which the cooling setpoint should be adjusted

HOSI Digital input - indicates whether or not the heating setpoint will be affected by adaptive optimal start

COSI Digital input - indicates whether or not the cooling setpoint will be affected by adaptive optimal start

HCAP% Analog input - the percentage by which the learned heating capacity should be adjusted

CCAP% Analog input - the percentage by which the learned cooling capacity should be adjusted

LRNI Digital input - indicates whether or not learned heating and cooling capacities will be calculated for optimal start

COLOR Analog output - the color representing the zone’s temperature in relation to the zone’s effective setpoints

HT Analog output - the zone’s effective heating setpoint

CL Analog output - the zone’s effective cooling setpoint

NS Digital output - indicates whether or not the zone is in night setback mode

HCAP Analog output - the learned heating capacity

CCAP Analog output - the learned cooling capacity

Table 8-2. Zone Setpoint - Plus with Learning Adaptive Optimal Start microblock inputs and outputs (Continued)

Input or Output Description

214 • Chapter 8: Control Microblocks

Page 215: Eikon 3.02 Microblock Reference

Zone Setpoint - Plus with Learning Adaptive Optimal Start

Figure 8-11: Using the Zone Setpoint - Plus with Learning Adaptive Optimal Start microblock

Figure 8-12: Zone Setpoint - Plus with Learning Adaptive Optimal Start microblock dialog

Chapter 8: Control Microblocks • 215

Page 216: Eikon 3.02 Microblock Reference

Zone Setpoint - Plus with Learning Adaptive Optimal Start

Zone Setpoint - Plus with Learning Adaptive Optimal Start parameters

The Design Temp section of the microblock dialog indicates the extreme outside temperatures at which equipment must run constantly in order to maintain comfort. Design temperatures are based on the geographic area of the building and are available from ASHRAE publications and most design references. On the Parameter page, use the Heating Design Temp and Cooling Design Temp settings to change these values.

The Capacity section of the microblock dialog indicates the maximum rate (in degrees F per hour) at which the heating and cooling equipment can change the temperature if the outside air temperature is 65°F. On the Parameter page, use the Heating Capacity and Cooling Capacity settings to change these values. The actual heating and cooling capacities used to calculate optimal start may vary because of the way learning adaptive optimal start is performed. Refer to the section “Learning adaptive optimal start” on page 187.

If the heating and cooling capacity parameters are changed and transferred to the module, the learned heating and cooling capacities will change to the new values. If the capacities are not changed but other parameters from the GFB are transferred to the module, the learned capacities will not be affected.

The Learning Adaptive Optimal Start settings determine the amount by which the heating or cooling capacities are adjusted, depending on the zone’s color when occupancy begins. A different value may be entered for each color. Note that two values may be entered for the color green: one for heating mode (the left-hand value) and one for cooling mode (the right-hand value).

On the microblock dialog, the settings on the colored bands determine the width (in degrees) of the colored bands on the setpoint graph in SuperVision. Actual occupied and unoccupied setpoint values can be entered in the heating setpt and cooling setpt fields beneath the graph (the Heating and Cooling settings on the Parameter page). When the demand level is zero, the settings in the occupied band are used. For each increase in the level of demand, you can offset the width of the color bands by the number of degrees indicated on each band. For example, Figure 8-10 shows the dem1 band’s cooling offset is 1.00, and

216 • Chapter 8: Control Microblocks

Page 217: Eikon 3.02 Microblock Reference

Zone Setpoint - Plus with Learning Adaptive Optimal Start

the cooling setpoint is 76.00. When the building is operating under demand level 1, the effective cooling setpoint will then be 77.00. This strategy allows the total building demand to be lowered often without shutting off any equipment.

On the Parameter page, the Bands settings determine the width of the color bands on the setpoint graph. The Free setting determines the width of the speckled green band (which allows free cooling from the outside air dampers when appropriate). If free cooling is not available, this parameter should be set to 0.00. The Stg1 setting determines the width of the yellow band for cooling and the light blue band for heating, and the Stg2 setting determines the width of the orange band for cooling and the dark blue band for heating. These settings for Free, Stg1 and Stg2 are used when the demand level is zero. The Offset settings allow you to enter an amount (in degrees) by which the Free, Stg1, and Stg2 settings will be adjusted for each level of demand.

The Color Change Hysteresis is represented by the Hyst setting on the Parameter page. When returning to normal, it is the number of degrees required to exceed the setpoint before the microblock’s color changes. An appropriate hysteresis prevents equipment from "chattering" when the temperature is very close to and oscillating around the setpoint.

Preventing adaptive optimal start adjustments

The Zone Setpoint - Plus with Learning Adaptive Optimal Start microblock allows you to prevent heating or cooling effective setpoints from being calculated using the adaptive optimal start routine. When the microblock’s hosi input receives an on signal, heating setpoints are not adjusted using the adaptive optimal start routine. When the microblock’s cosi input receives an on signal, cooling setpoints are not adjusted using the adaptive optimal start routine. Even if these inputs are on, however, effective setpoints may be adjusted based on other inputs or demand limiting. Note that these inputs only affect heating and cooling setpoints, not heating and cooling capacities. If you want to prevent heating and cooling capacities from being adjusted, use the LRNI input (refer to the section “Learning adaptive optimal start” on page 187).

Chapter 8: Control Microblocks • 217

Page 218: Eikon 3.02 Microblock Reference

Zone Setpoint - Plus with Learning Adaptive Optimal Start

Adjusting learned heating and cooling capacities

You can adjust learned heating and cooling capacities using the HCAP% and CCAP% inputs on the microblock. These inputs accept a percent value which is used to adjust the learned heating capacities used during learning adaptive optimal start. These adjustments will affect the learned heating and cooling capacities even when the LRNI input is turned on.

Example

The heating capacity for the zone is set at 5 degrees per hour. When the zone becomes occupied, the zone’s color is light blue, indicating a need for additional heat. Additionally, the microblock’s HCAP% input has a value of 80%, and the Learning Adaptive Optimal Start value for the color light blue is 1. The next time the zone is unoccupied, the microblock adjusts setpoints assuming a learned heating capacity of 3.2 degrees (5 degrees heating capacity - 1 degree learned adjustment x 80% capacity adjustment). This causes the setpoint adjustment to begin sooner.

The adjusted heating and cooling capacities appear only on the Status page.

Parameter page text

Set Points Occ Unocc Free Stg1 Stg2 Dem1 Dem2 Dem3 Hyst Heating _____ _____ Bands ____ ____ Offset ____ ____ ____ ____ Cooling _____ _____ Bands ____ ____ ____ Offset ____ ____ ____Heating Capacity ____ (deg/hr) Heating Design Temp _____Cooling Capacity ____ (deg/hr) Cooling Design Temp _____Learning Adaptive Optimal Start: Upon transitioning from Unoccupied to Occupied, apply these values: Red | DkBlue | LtBlue | Green or SpGrn | Yellow | Orange | Red _____ _____ _____ _____ _____ _____ _____ _____

218 • Chapter 8: Control Microblocks

Page 219: Eikon 3.02 Microblock Reference

Zone Setpoint - Plus with Learning Adaptive Optimal Start

Status page text

Effective Set Points: Red | DkBlue | LtBlue | Green | Yellow | Orange | Red ~~~~~ ~~~~~ ~~~~~ ~~~~~ ~~~~~ ~~~~~The learned cooling capacity is ~~~~~; Adjusted cooling capacity is ~~~~~.The learned heating capatity is ~~~~~; Adjusted heating capacity is ~~~~~.

Chapter 8: Control Microblocks • 219

Page 220: Eikon 3.02 Microblock Reference

Setpoint Optimization

Setpoint Optimization

The Setpoint Optimization microblock calculates a setpoint for the equipment controlled by the GFB based on the number of heating or cooling requests received by the equipment. You can determine a maximum and minimum temperature that the setpoint will not exceed, and you can determine when and how often the setpoint is calculated. This type of control allows you to efficiently meet the building’s requirements by calculating the setpoint according to the amount of heating or cooling that is needed.

The microblock’s req input accepts the number of requests received by the GFB (usually from a Receive Requests microblock). Setpoint calculations are only performed when the microblock’s go input receives an on signal. If this input’s value is off, then the setpoint will remain at the initial value and will not be adjusted.

The Initial Setpoints section of the microblock dialog determines the starting setpoint for the equipment and the minimum and maximum allowable setpoints. The microblock determines the setpoint with a "trim and respond" calculation using the settings in the following statement: Every _____ mins, Trim by ____ and Respond by ____ but no more than ____. For cooling, you should use a positive Trim by value and a negative value for the Respond by and but no more than parameters. For heating, you should use a negative value for Trim by and a positive value for the Respond by and but no more than parameters. Setpoints are calculated using the following formula:

Example 1

The initial setpoint for a VAV air handler (which is the source of cold air for a number of VAV boxes) is 60 degrees, with a minimum of 55 degrees and a maximum of 65 degrees. The trim and respond parameters are set as follows: Every 2.0 mins, Trim by 0.25 and Respond by -0.50 but no more than -3.0. If the current setpoint is 57 degrees, and 4 requests are received, the new setpoint would be 55.25 degrees (57 degrees + .25 trim + (-.50 x 4) respond).

Microblock

Microblock Library icon

New Setpoint Previous Setpoint trim by respond by number of requests×( )+ +=

220 • Chapter 8: Control Microblocks

Page 221: Eikon 3.02 Microblock Reference

Setpoint Optimization

Example 2

The same VAV air handler later receives seven cooling requests. The trim and respond parameters are set as follows: Every 2.0 mins, Trim by 0.25 and Respond by -0.50 but no more than -3.0. If the current setpoint is 55.25 degrees, the new setpoint would be 52.5 degrees (57 degrees +.25 trim + (-3.0) respond). Because the number of requests (7) multiplied by the Respond by value (-.50) is greater than the no more than value, the no more than value is used in the calculation instead.

Figure 8-13: Setpoint Optimization microblock dialog

Parameter page text

Optimized setpoint description...Initial setpt _____ Max Setpt _____ Min Setpt _____ Every __ mins, Trim by _____ and Respond by _____ but no more than _____

Chapter 8: Control Microblocks • 221

Page 222: Eikon 3.02 Microblock Reference

Set Color

Set Color

The Set Color microblock defines a color (white, gray, or red) for a GFB that does not use a Zone Setpoint or Set Color If True microblock. This microblock is used so the GFB displays a color in SuperVision indicating its status. For example, this microblock can be used to generate a color for a piece of equipment depending on its status: white if the equipment is running, gray if the equipment is not running and red if an alarm condition exists for the equipment.

NOTE Do not use the Set Color microblock in combination with any Zone Setpoint or Set Color If True microblocks in the same GFB. There cannot be more than one Set Color microblock in a GFB.

When the microblock’s alrm input receives an on signal, the GFB’s broadcast color is red, regardless of the value of the run input. When the alrm input is off and the run input is on, the GFB’s broadcast color is white. If both inputs are off, the GFB’s broadcast color is gray.

Figure 8-14: Using the Set Color microblock

Microblock

Microblock Library icon

222 • Chapter 8: Control Microblocks

Page 223: Eikon 3.02 Microblock Reference

Set Color If True

Set Color If True

The Set Color If True microblock broadcasts the selected color for the GFB when it is activated. The microblock’s input accepts an on or off signal; when the input is on, the color (chosen on the microblock dialog) is broadcast. When the input is off, the GFB’s color is gray.

It is possible to use more than one Set Color If True microblock in a GFB, as long as only one of these microblocks is activated at a time.

NOTE Do not use the Set Color If True microblock in combination with any Zone Setpoint or Set Color microblocks in the same GFB.

Figure 8-15: Set Color If True microblock dialog

Microblock

Microblock Library icon

Chapter 8: Control Microblocks • 223

Page 224: Eikon 3.02 Microblock Reference

True If Color =

True If Color =

The True If Color = microblock allows you to define control sequences based on the GFB’s current color. This microblock accepts a color value from a Zone Setpoint or Set Color microblock. If the color matches one of the colors selected for the microblock (from the microblock dialog), the microblock’s output is turned on. For example, this microblock can be used to create a signal that turns an Alert microblock on when the GFB’s color is either red or orange.

Figure 8-16: Using the True If Color = microblock

On the microblock dialog, click the button or buttons representing the color or colors that will turn the microblock’s output on. On the Parameter page, indicate the desired color or colors by changing the appropriate dash to an X. The dashes represent the colors in the order indicated by the letters (rdlggyor): red (heat alarm), dark blue, light blue, green, speckled green, yellow, orange, and red (cooling alarm). The dashes represented by the letters (gw) stand for the colors gray and white.

Figure 8-17: True If Color = microblock dialog

Microblock

Microblock Library icon

224 • Chapter 8: Control Microblocks

Page 225: Eikon 3.02 Microblock Reference

True If Color =

Parameter page text

Test color par descriptionRun if color = ________ (rdlggyor) __ (gw)

Chapter 8: Control Microblocks • 225

Page 226: Eikon 3.02 Microblock Reference

Scheduler

Scheduler

The Scheduler microblock reads schedules from SuperVision and generates signals to tell the GFB whether or not the zone is occupied, and how long the zone will remain in its current state of occupancy.

The microblock has two outputs: the occ output, which indicates whether the zone is currently occupied (on) or unoccupied (off); and the timer output, which indicates the number of minutes remaining until the occupancy changes. The value of these outputs depends on the schedule entered for the GFB in SuperVision. To enter or view schedules, use SuperVision’s Schedule feature. Refer to the SuperVision User’s Guide for details.

The microblock dialog allows you to set values that the microblock can use during simulation. You cannot set schedules using the microblock’s dialog. For more information about simulating a GFB, refer to the Eikon User’s Guide. The Status page shows the current occupancy status of the zone and the time when the occupancy is scheduled to change.

NOTE Only one Scheduler or Scheduler with Override microblock can be used per GFB. Otherwise, Eikon will not complete the Make FB process successfully.

Figure 8-18: Scheduler microblock dialog

Status page text

Scheduler Status: ~~~~~~~~~~ until ~~~~~~~~~~~ ~~~~~

Microblock

Microblock Library icon

226 • Chapter 8: Control Microblocks

Page 227: Eikon 3.02 Microblock Reference

Scheduler with Override

Scheduler with Override

The Scheduler with Override microblock reads schedules from SuperVision and generates signals to tell the GFB whether or not the zone is occupied and how long the zone will remain in its current state. This microblock can also accept an override signal (using the ovr input) from another microblock that indicates the number of minutes to override occupancy.

The microblock has two outputs: the occ output, which indicates whether the zone is currently occupied (on) or unoccupied (off); and the timer output, which indicates the number of minutes remaining until the occupancy changes. The value of these outputs depends on the schedule entered for the GFB in SuperVision. To enter or view schedules, use the SuperVision’s Schedule feature. Refer to the SuperVision User’s Guide for details.

The microblock dialog allows you to set values that the microblock can use during simulation. You cannot set schedules using the microblock’s dialog. For more information about simulating a GFB, refer to the Eikon User’s Guide. The Status page shows the current occupancy status of the zone, and the time when the occupancy is scheduled to change.

NOTE Only one Scheduler or Scheduler with Override microblock can be used per GFB. Otherwise, Eikon will not complete the Make FB process successfully.

Figure 8-19: Scheduler with Override microblock dialog

Microblock

Microblock Library icon

Chapter 8: Control Microblocks • 227

Page 228: Eikon 3.02 Microblock Reference

Scheduler with Override

Status page text

Scheduler Status: ~~~~~~~~~~ until ~~~~~~~~~~~ ~~~~~~~~~~~~~

♦ ♦ ♦

228 • Chapter 8: Control Microblocks

Page 229: Eikon 3.02 Microblock Reference

9 Convert Microblocks

The Convert menu microblocks take information from other microblocks, change it in some way, and then output the modified data. These microblocks should be placed in the middle of the GFB between the Inputs and Outputs.

The following microblocks are available in the Convert menu:

Zone Controller 231

PID - Direct Acting 234

PID - Reverse Acting 238

Linear Converter 242

Linear Converter for Variable Inputs 243

Enthalpy Calculator 244

Dewpoint Temperature Calculator 246

Wet Bulb Temperature Calculator 247

True If = Constant 248

True If > Constant 249

Chapter 9: Convert Microblocks • 229

Page 230: Eikon 3.02 Microblock Reference

True If < Constant 250

True If = Variable 251

True If > Variable Input 252

True If Input < Variable Input 253

Analog to Digital Converter 254

Digital to Analog Converter 255

230 • Chapter 9: Convert Microblocks

Page 231: Eikon 3.02 Microblock Reference

Zone Controller

Zone Controller

The Zone Controller microblock is designed to provide stable temperature control of a single-zone heating and cooling system using two modified PID control loops. The two PID loops (a direct acting loop for the cooling output and a reverse acting loop for the heating output) are non-linear. This allows for fine-tuning corrections when the system is near setpoint and larger corrections when the setpoint or the load changes and the system needs to adjust quickly. To use this microblock, be sure to select Exec 6.x from the Option menu on the menu bar. For more information about PID loops, see the Technical Handbook.

The Zone Controller microblock is supported by Exec 6.01 (or later) and is well-suited for controlling a VAV box when used with an Airflow microblock; refer to the section “Airflow Control” on page 99.

The OCC input on the Zone Controller microblock is the occupied or unoccupied status (on means occupied). This information comes from a Scheduler microblock and any additional logic, such as a timed local override switch, used to determine occupancy status.

The FOR input is the amount of time, in minutes, remaining in the current OCC status. This information comes from a Scheduler microblock and any additional logic which affects this value. The ZONE input is the zone temperature in degrees. The CLSP input is the cooling setpoint in degrees. The HTSP is the heating setpoint in degrees.

NOTE The units for ZONE, CLSP, and HTSP are dependent on the Metric setting on the Options-Edit Options dialog box. If the Metric option is set to yes, all temperatures are expressed in Celsius. Otherwise, Fahrenheit is used.

The outputs on the Zone Controller are used to control the cooling and heating systems through an output microblock, such as the Airflow microblock. The output can also be used to trigger “I need cool/heat” requests back to the air handler unit.

Microblock

Microblock Library icon

Chapter 9: Convert Microblocks • 231

Page 232: Eikon 3.02 Microblock Reference

Zone Controller

Zone Controller Parameters

The Cooling Loop Gain is a parameter used to adjust the speed of the integral action relative to the proportional action when the system is in cooling mode. If the system begins cycling, decrease this setting. The range of this parameter is 1 through 5 and the default value is 5.

The Heating Loop Gain is a parameter used to adjust the speed of the integral action relative to the proportional action when the system is in heating mode. If the system begins cycling, decrease this setting. The range of this parameter is 1 through 5 and the default value is 5.

The Maintain Setpoint +/- ___Deg parameter controls how far from the heating or cooling setpoint the system can vary before the controller calls for full heating or cooling. The controller calls for full heating or cooling when the temperature comes within 75% of this limit; this ensures the limit is not exceeded. If a zone has a cooling setpoint of 74 Deg F, for example, and cannot be allowed to rise above 75 Deg F under any circumstances, a setting of Maintain Setpoint +/-1 Deg F calls for full cooling if the temperature rises to 74.75 Deg F. Similarly, if the heating setpoint is set at 70 Deg F, the controller calls for full heat if the temperature drops below 69.25 Deg F. The default setting maintains control in most situations, but can be increased if the system begins to cycle.

Figure 9-1: Zone Controller microblock

232 • Chapter 9: Convert Microblocks

Page 233: Eikon 3.02 Microblock Reference

Zone Controller

Parameter page text

Cooling Loop Gain: 5 (range = 1 to 5)Heating Loop Gain: 5 (range = 1 to 5)Maintain Setpoint +/-1deg F (range = 1 to 5)

Status page text

Cooling %: 100Heating %: 0

Chapter 9: Convert Microblocks • 233

Page 234: Eikon 3.02 Microblock Reference

PID - Direct Acting

PID - Direct Acting

PID (Proportional, Integral, Derivative) loops use industry standard algorithms to calculate an appropriate response for controlling a physical output, based on the equipment’s setpoint and the actual temperature. The microblock calculates three values: a proportional value, integral value, and derivative value. These three values are added together with the bias to create an output percentage that increases as the temperature rises above the setpoint.

Figure 9-2: Using the PID-Direct Acting microblock

The Gain section of the microblock dialog indicates the values used by the PID microblock to calculate each portion of the PID routine. Proper adjustment of these values results in the most efficient use of the equipment. Automated Logic Corporation provides tools to assist you in tuning PID loops. These tools are available in the ALC File Library, which can be accessed at http://www.automatedlogic.com/techsupport.

The Proportional gain (P-gain) value is used to calculate the proportional component of the routine. This component increases in direct proportion to the difference between the setpoint and the current temperature. If you define only the P-gain portion of the PID microblock, the microblock’s output value could cause the temperature to oscillate around the setpoint or possibly to never reach the setpoint (if the P-gain is too low). The proportional value is calculated using the following formula:

For example, if the P-gain is 20, the setpoint is 65, and the current temperature is 67, the proportional value is 40. The value of the proportional component (p) appears on the Status page.

Microblock

Microblock Library icon

P Input Setpoint–( ) P-gain×=

234 • Chapter 9: Convert Microblocks

Page 235: Eikon 3.02 Microblock Reference

PID - Direct Acting

The Integral gain (I-gain) value is used to calculate the integral component of the PID routine. The integral value accounts for the amount of time that the temperature and the setpoint have been different. The longer that the temperature and setpoint are different, the larger the integral value becomes. The integral value is calculated as follows:

For example, if the I-gain is 2, the setpoint is 65, and the current temperature is 67, the integral value for the first interval will be 4. If at the end of the second interval the temperature is still 67, the integral value will increase to 8.

The Derivative gain (D-gain) value attempts to control the rate at which the temperature is brought to setpoint in order to prevent the setpoint from being exceeded. This value uses information from the current and previous intervals and is calculated using the following formula:

For example, if the D-gain is 3, the setpoint is 65, and the current temperature is 67, the derivative value for the first interval is 6 ([2 - 0] x 3 = 6). If at the end of the second interval the temperature is still 67, the derivative value will decrease to 0 ([2 - 2] x 3 = 0).

The microblock’s output percentage uses all three components as follows:

The Bias is set on the microblock dialog or the Parameter page. Using the examples listed for each component above, and assuming a bias value of 0, the output value of the PID microblock for the first interval would be 50; for the second interval the value would be 48.

The Loop section of the microblock dialog contains settings that affect the overall operation of the microblock. The Bias value is added to the proportional, integral, and derivative values calculated by the microblock to create the final output value. The bias can be viewed as a starting point for the calculation or as an offset to the final value.

I Previous I value Input( Setpoint ) I-gain×–[ ]+=

D Input Setpoint–( )current Input Setpoint–( )previous–[ ] D-gain×=

Output (%) Bias P I D+ + +=

Chapter 9: Convert Microblocks • 235

Page 236: Eikon 3.02 Microblock Reference

PID - Direct Acting

When the go input is off, the microblock’s output defaults to the Bias value. The Interval setting indicates how often the microblock calculates its output value. When the microblock’s go input is on, the output value is calculated only once each interval. The Hold I error setting, when enabled, retains the last calculated integral value when the microblock’s go input is off.

You can edit the Parameter screen prompt text on the microblock dialog to provide a meaningful description of the microblock’s use on the Parameter page.

NOTE Because this microblock has been updated to avoid integral error problems, PID microblocks which were inserted into GFBs prior to Eikon 2.0 should be deleted and reinserted using Eikon 2.0 or later.

Figure 9-3: PID-Direct Acting microblock dialog

Parameter page text

Loop par description...PID Loop P-gain ____ I-gain ____ D-gain ____ Bias ____ Interval ___sec Hold I-error while inactive? ___

236 • Chapter 9: Convert Microblocks

Page 237: Eikon 3.02 Microblock Reference

PID - Direct Acting

Status page text

Loop stat description...PID loop: setpoint ~~~~~ current ~~~~~ bias ~~~~~ +(p) * ~~~~ ~~~~~ interval ~~~ +(i) * ~~~~ ~~~~~ +(d) * ~~~~ ~~~~~ output ~~~~~

Chapter 9: Convert Microblocks • 237

Page 238: Eikon 3.02 Microblock Reference

PID - Reverse Acting

PID - Reverse Acting

PID (Proportional, Integral, Derivative) loops use industry standard algorithms to calculate an appropriate response for controlling a physical output, based on the equipment’s setpoint and the actual temperature. The microblock calculates three values: a proportional value, integral value, and derivative value. These three values, together with the bias, create an output percentage that increases as the temperature falls below the setpoint.

Figure 9-4: Using the PID - Reverse Acting microblock

The Gain section of the microblock dialog indicates the values used by the PID microblock to calculate each portion of the PID routine. Proper adjustment of these values results in the most efficient use of the equipment. Automated Logic Corporation provides tools to assist you in tuning PID loops. These tools are available in the ALC File Library, which can be accessed at http://www.automatedlogic.com/techsupport.

The Proportional gain (P-gain) value is used to calculate the proportional component of the routine. This component increases in direct proportion to the difference between the setpoint and the current temperature. If you define only the P-gain portion of the PID microblock, the microblock’s output value could cause the temperature to oscillate around the setpoint or possibly to never reach the setpoint (if the P-gain is too low). The proportional value is calculated using the following formula:

For example, if the P-gain is 20, the setpoint is 65, and the current temperature is 63, the proportional value is -40. The value of the proportional component (p) appears on the Status page.

Microblock

Microblock Library icon

P Input Setpoint–( ) P-gain×=

238 • Chapter 9: Convert Microblocks

Page 239: Eikon 3.02 Microblock Reference

PID - Reverse Acting

The I-gain value is used to calculate the integral component of the PID routine. The integral value accounts for the amount of time that the temperature and the setpoint have been different. The longer that the temperature and setpoint are different, the larger the integral value becomes. The integral value is calculated as follows:

For example, if the I-gain is 2, the setpoint is 65, and the current temperature is 63, the integral value for the first interval will be -4. If at the end of the second interval the temperature is still 63, the integral value will increase to -8.

The derivative value attempts to control the rate at which the temperature is brought to setpoint in order to prevent the setpoint from being exceeded. This value uses information from the current and previous intervals, and is calculated using the following formula:

For example, if the D-gain is 3, the setpoint is 65, and the current temperature is 63, the derivative value for the first interval is -6 ([-2 - 0] x 3 = -6). If at the end of the second interval the temperature is still 63, the derivative value will increase to 0 ([-2 - (- 2)] x 3 = 0).

The microblock’s output percentage uses all three components as follows:

The bias is set on the microblock dialog or the Parameter page. Using the examples listed for each component above, and assuming a bias value of 0, the output value of the PID microblock for the first interval would be 50; for the second interval the value would be 48.

The Loop section of the microblock dialog contains settings that affect the overall operation of the microblock. The Bias value is added to the proportional, integral, and derivative values calculated by the microblock to create the final output value. The bias can be viewed as a starting point for the calculation, or as an offset to the final value. When the go input is off, the microblock’s output defaults to the Bias

I Previous I value Input( Setpoint ) I-gain×–[ ]+=

D Input Setpoint–( )current Input Setpoint–( )previous–[ ] D-gain×=

Output (%) Bias P– I– D–=

Chapter 9: Convert Microblocks • 239

Page 240: Eikon 3.02 Microblock Reference

PID - Reverse Acting

value. The Interval setting indicates how often the microblock calculates its output value. When the microblock’s go input is on, the output value is calculated only once each interval. The Hold I error setting, when enabled, retains the last calculated integral value when the microblock’s go input is off.

You can edit the Parameter and Status screen prompt text on the microblock dialog to provide a meaningful description of the microblock’s use on the Parameter and Status pages.

NOTE Because this microblock has been updated to avoid integral error problems, PID microblocks which were inserted into GFBs prior to Eikon 2.0 should be deleted and reinserted using Eikon 2.0 or later.

Figure 9-5: PID - Reverse Acting microblock dialog

Parameter page text

Loop par description...PID Loop P-gain ____ I-gain ____ D-gain ____ Bias ____ Interval ___sec Hold I-error while inactive? ___

240 • Chapter 9: Convert Microblocks

Page 241: Eikon 3.02 Microblock Reference

PID - Reverse Acting

Status page text

Loop stat description...PID loop: setpoint ~~~~~ current ~~~~~ bias ~~~~~ +(p) * ~~~~ ~~~~~ interval ~~~ +(i) * ~~~~ ~~~~~ +(d) * ~~~~ ~~~~~ output ~~~~~

Chapter 9: Convert Microblocks • 241

Page 242: Eikon 3.02 Microblock Reference

Linear Converter

Linear Converter

The Linear Converter microblock converts a value in a range to a proportionate value in a different range. You define both the starting (Input) and ending (Output) ranges on the microblock dialog. For example, you can use this microblock to convert a PID output percent value to a 3-13 psi value to operate a hot water valve. You could also use this microblock to establish a setpoint range for equipment based on the outside air temperature range. See Figure 9-6 below for an example of this application.

You can edit the Parameter screen prompt text on the microblock dialog to provide a meaningful description of the microblock’s use on the Parameter page.

Figure 9-6: Using the Linear Converter microblock

Figure 9-7: Linear Converter microblock dialog

Parameter page text

For description ...Convert value in the range [_____,_____] to [_____,_____]

Microblock

Microblock Library icon

242 • Chapter 9: Convert Microblocks

Page 243: Eikon 3.02 Microblock Reference

Linear Converter for Variable Inputs

Linear Converter for Variable Inputs

The Linear Converter for Variable Inputs microblock converts a value in a range to a proportionate value in a different range. The starting (Input) and ending (Output) ranges are defined by four values established by inputs to the microblock.

A and B define the input range.

X and Y define the output range.

For example, you can use this microblock to allow a BACview keypad to adjust the range of an output point such as a damper. See Figure 9-8 below for an example of this application.

Figure 9-8: Using the Variable Converter microblock

The Linear Converter for Variable Inputs microblock is supported by Exec 6.01 (or later) modules.

Microblockck

Microblock Library icon

Chapter 9: Convert Microblocks • 243

Page 244: Eikon 3.02 Microblock Reference

Enthalpy Calculator

Enthalpy Calculator

The Enthalpy Calculator microblock accepts a dry bulb temperature and a relative humidity input and calculates a corresponding value for enthalpy. Enthalpy is a measure of energy inherent in the air. A high enthalpy value indicates a higher air temperature.

Figure 9-9 shows how you can use the Enthalpy calculator microblock to modulate an economizer and take advantage of free cooling.

Figure 9-9: Using the Enthalpy Calculator microblock

In cases where the temperature and humidity input values are very high or very low, the enthalpy calculation can become distorted. In these cases it may be necessary to substitute additional logic in place of the Enthalpy Calculator microblock. Figure 9-10 illustrates this substitute programming.

Microblock

Microblock Library icon

244 • Chapter 9: Convert Microblocks

Page 245: Eikon 3.02 Microblock Reference

Enthalpy Calculator

Figure 9-10: Calculating enthalpy

Chapter 9: Convert Microblocks • 245

Page 246: Eikon 3.02 Microblock Reference

Dewpoint Temperature Calculator

Dewpoint Temperature Calculator

The Dewpoint Temperature Calculator microblock accepts a dry bulb temperature and a relative humidity value and uses this information to calculate the dewpoint temperature. The dewpoint is the temperature at which water vapor begins condensing.

Figure 9-11 shows how you can use the dewpoint temperature to trigger a routine that enables dehumidification.

Figure 9-11: Using the Dewpoint Temperature Calculator microblock

In cases where the temperature and humidity input values are very high or very low, the dewpoint temperature can become distorted. To prevent this, use Constant High Limit and Constant Low Limit microblocks to limit the temperature and humidity input values. See Figure 9-12 below:

Figure 9-12: Limiting input values for the Dewpoint Temperature Calculator microblock

Microblock

Microblock Library icon

246 • Chapter 9: Convert Microblocks

Page 247: Eikon 3.02 Microblock Reference

Wet Bulb Temperature Calculator

Wet Bulb Temperature Calculator

The Wet Bulb Temperature Calculator microblock accepts a dry bulb temperature and a relative humidity value and uses this information to calculate the wet bulb temperature. The wet bulb temperature lowers when the humidity is low, indicating that more water can be absorbed by the air through evaporation.

Figure 9-13 shows how you can use the wet bulb temperature to use an evaporative cooling device.

Figure 9-13: Using the Wet Bulb Temperature Calculator microblock

Microblock

Microblock Library icon

Chapter 9: Convert Microblocks • 247

Page 248: Eikon 3.02 Microblock Reference

True If = Constant

True If = Constant

The True If = Constant microblock creates an on (or true) signal when the value of the microblock’s input is equal to the trip point. You define the trip point on the microblock’s dialog or the Parameter page.

You can edit the Parameter screen prompt text on the microblock dialog to provide a meaningful description of the microblock’s use on the Parameter page.

Figure 9-14: True If = Constant microblock dialog

Parameter page text

Trip point is _____

Microblock

Microblock Library icon

248 • Chapter 9: Convert Microblocks

Page 249: Eikon 3.02 Microblock Reference

True If > Constant

True If > Constant

The True If > Constant microblock creates an on (or true) signal when the value of the microblock’s input is greater than the microblock’s trip point. You define the trip point on the microblock’s dialog or the Parameter page.

The Hysteresis setting indicates the amount by which the input value must fall below the trip point before the microblock’s output is turned off. The hysteresis can prevent the microblock from changing its value too frequently when the input oscillates around the trip point. For example, if the trip point is 35 and the hysteresis is 2, the microblock’s input must fall to 33 before the output turns off.

You can edit the Parameter screen prompt text on the microblock dialog to provide a meaningful description of the microblock’s use on the Parameter page.

Figure 9-15: True If > Constant microblock dialog

Parameter page text

Trip point is _____, with hysteresis of _____

Microblock

Microblock Library icon

Chapter 9: Convert Microblocks • 249

Page 250: Eikon 3.02 Microblock Reference

True If < Constant

True If < Constant

The True If < Constant microblock creates an on (or true) signal when the value of the microblock’s input is less than the microblock’s trip point. You define this number on the microblock’s dialog or the Parameter page.

The Hysteresis setting indicates the amount by which the input value must rise above the trip point before the microblock’s output is turned off. The hysteresis can prevent the microblock from changing its value too frequently when the input oscillates around the trip point. For example, if the trip point is 35 and the hysteresis is 2, the microblock’s input must rise to 37 before the output turns off.

You can edit the Parameter screen prompt text on the microblock dialog to provide a meaningful description of the microblock’s use on the Parameter page.

Figure 9-16: True If < Constant microblock dialog

Parameter page text

Trip point is _____, with hysteresis of _____

Microblock

Microblock Library icon

250 • Chapter 9: Convert Microblocks

Page 251: Eikon 3.02 Microblock Reference

True If = Variable

True If = Variable

The True If = Variable microblock creates an on (or true) signal when the value of the microblock’s if = input equals the microblock’s other input. The microblock accepts two analog values wired from other parts of the GFB.Microblock

Microblock Library icon

Chapter 9: Convert Microblocks • 251

Page 252: Eikon 3.02 Microblock Reference

True If > Variable Input

True If > Variable Input

The True If > Variable Input microblock creates an on (or true) signal when the value of the microblock’s if > input is greater than the microblock’s other input. The microblock accepts two analog values wired from other parts of the GFB.

The Hysteresis setting indicates the amount by which the if > input value must fall below the variable input before the microblock’s output is turned off. The hysteresis can prevent the microblock from changing its value too frequently when the input oscillates around the trip point. For example, if the if > input is 35 and the hysteresis is 2, the microblock’s input must fall to 33 before the output turns off. The hysteresis can be set on the microblock’s dialog or the Parameter page.

You can edit the Parameter screen prompt text on the microblock dialog to provide a meaningful description of the microblock’s use on the Parameter page.

Figure 9-17: True if > Variable Input microblock dialog

Parameter page text

Trip point hysteresis is _____

Microblock

Microblock Library icon

252 • Chapter 9: Convert Microblocks

Page 253: Eikon 3.02 Microblock Reference

True If Input < Variable Input

True If Input < Variable Input

The True If < Variable Input microblock creates an on (or true) signal when the value of the microblock’s if < input is less than the microblock’s other input. The microblock accepts two analog values wired from other parts of the GFB.

The Hysteresis setting indicates the amount by which the if < input value must rise above the variable input before the microblock’s output is turned off. The hysteresis can prevent the microblock from changing its value too frequently when the input oscillates around the trip point. For example, if the if < input is 35 and the hysteresis is 2, the microblock’s input must rise to 37 before the output turns off. The hysteresis can be set on the microblock dialog or the Parameter page.

You can edit the Parameter screen prompt text on the microblock dialog to provide a meaningful description of the microblock’s use on the Parameter page.

Figure 9-18: True If < Variable Input microblock dialog

Parameter page text

Trip point hysteresis is _____

Microblock

Microblock Library icon

Chapter 9: Convert Microblocks • 253

Page 254: Eikon 3.02 Microblock Reference

Analog to Digital Converter

Analog to Digital Converter

The Analog to Digital Converter microblock converts a numeric input to an on/off digital signal. If the input value is zero, the microblock creates an off signal. If the input value is any number other than zero, the microblock creates an on signal.Microblock

Microblock Library icon

254 • Chapter 9: Convert Microblocks

Page 255: Eikon 3.02 Microblock Reference

Digital to Analog Converter

Digital to Analog Converter

The Digital to Analog Converter microblock accepts a digital on or off signal and converts it to a numeric value. If the microblock’s input is on, the output value is 1.0. If the microblock’s input is off, the output value is 0.0.

♦ ♦ ♦

Microblock

Microblock Library icon

Chapter 9: Convert Microblocks • 255

Page 256: Eikon 3.02 Microblock Reference

Digital to Analog Converter

256 • Chapter 9: Convert Microblocks

Page 257: Eikon 3.02 Microblock Reference

10 Limit Microblocks

The Limit menu contains microblocks which accept signals from other microblocks, limit the value in some way, and then output the modified signal. These microblocks should be placed in the middle of the Graphic Function Block (GFB) between the Inputs and Outputs.

The following microblocks are available in the Limit menu:

Constant High Signal Selector 258

Constant Low Signal Selector 259

Variable High Signal Selector 260

Variable Low Signal Selector 261

Constant Low Limit 262

Constant High Limit 263

Variable Low Limit 264

Variable High Limit 265

Ramp Up/Down Control 266

Chapter 10: Limit Microblocks • 257

Page 258: Eikon 3.02 Microblock Reference

Constant High Signal Selector

Constant High Signal Selector

The Constant High Signal Selector microblock accepts a numeric value from another microblock and compares it to a constant value you define. The higher of the two values becomes the microblock’s output value. The Constant value can be set on the microblock dialog or the Parameter page.

You can edit the Parameter screen prompt text on the microblock dialog to provide a meaningful description of the microblock’s use on the Parameter page.

Figure 10-1: Constant High Signal Selector microblock dialog

Parameter page text

This parameter is _____

Microblock

Microblock Library icon

258 • Chapter 10: Limit Microblocks

Page 259: Eikon 3.02 Microblock Reference

Constant Low Signal Selector

Constant Low Signal Selector

The Constant Low Signal Selector microblock accepts a numeric value from another microblock and compares it to a constant value you define. The lower of the two values becomes the microblock’s output value. The Constant value can be set on the microblock dialog or the Parameter page.

You can edit the Parameter screen prompt text on the microblock dialog to provide a meaningful description of the microblock’s use on the Parameter page.

Figure 10-2: Constant Low Signal Selector microblock dialog

Parameter page text

This parameter is _____

Microblock

Microblock Library icon

Chapter 10: Limit Microblocks • 259

Page 260: Eikon 3.02 Microblock Reference

Variable High Signal Selector

Variable High Signal Selector

The Variable High Signal Selector microblock accepts two numeric values from other microblocks in the GFB and compares them to each other. The higher of the two values becomes the microblock’s output value.

Figure 10-3: Using the Variable High Signal Selector microblock

Microblock

Microblock Library icon

260 • Chapter 10: Limit Microblocks

Page 261: Eikon 3.02 Microblock Reference

Variable Low Signal Selector

Variable Low Signal Selector

The Variable Low Signal Selector microblock accepts two numeric values from other microblocks in the GFB and compares them to each other. The lower of the two values becomes the microblock’s output value. Microblock

Microblock Library icon

Chapter 10: Limit Microblocks • 261

Page 262: Eikon 3.02 Microblock Reference

Constant Low Limit

Constant Low Limit

The Constant Low Limit microblock sets a limit that the microblock’s value cannot go below. As long as the microblock’s input is higher than the constant value you define, the microblock’s output value will equal the input value. If the input value is less than the constant you define, the constant value becomes the output value. You can set the constant value on the microblock’s dialog or the Parameter page.

You can edit the Parameter screen prompt text on the microblock dialog to provide a meaningful description of the microblock’s use on the Parameter page.

Figure 10-4: Constant Low Limit microblock dialog

Parameter page text

This parameter is _____

Microblock

Microblock Library icon

262 • Chapter 10: Limit Microblocks

Page 263: Eikon 3.02 Microblock Reference

Constant High Limit

Constant High Limit

The Constant High Limit microblock sets a limit that the microblock’s value cannot go above. As long as the microblock’s input is less than the constant value you define, the microblock’s output will equal the input. If the input value is higher than the constant you define, the constant becomes the output value. You can set the constant value on the microblock’s dialog or the Parameter page.

You can edit the Parameter screen prompt text on the microblock dialog to provide a meaningful description of the microblock’s use on the Parameter page.

Figure 10-5: Constant High Limit microblock dialog

Parameter page text

This parameter is _____

Microblock

Microblock Library icon

Chapter 10: Limit Microblocks • 263

Page 264: Eikon 3.02 Microblock Reference

Variable Low Limit

Variable Low Limit

The Variable Low Limit microblock limits a value based on another value in the microblock. The value of microblock’s second input is the low limit of the first input. If the first input’s value is greater than the second input, the output value is the same as the first input. If the first input is lower than the second, the output value is the same as the second input.

Figure 10-6: Using the Variable Low Limit microblock

Microblock

Microblock Library icon

264 • Chapter 10: Limit Microblocks

Page 265: Eikon 3.02 Microblock Reference

Variable High Limit

Variable High Limit

The Variable High Limit microblock limits a value based on another value in the microblock. The value of microblock’s first input is the high limit of the second input. If the second input’s value is less than the first input, the output value is the same as the second input. If the second input is higher than the first, the output value is the same as the first input.

Figure 10-7: Using the Variable High Limit microblock

Microblock

Microblock Library icon

Chapter 10: Limit Microblocks • 265

Page 266: Eikon 3.02 Microblock Reference

Ramp Up/Down Control

Ramp Up/Down Control

The Ramp Up/Down Control microblock limits the rate at which an analog signal may increase or decrease. When the microblock’s go input is on, the microblock's ramp control is enabled. When the go input is off, the output value is equal to the input value.

The Ramp microblock is often used as an additional safety measure to slow the reaction of a piece of equipment. This microblock can also be used in a sequence to prevent incoming requests from being cancelled. For more information, refer to the appropriate request microblock description in the section “SysIn Microblocks” on page 111.

Figure 10-8: Using the Ramp Up/Down Control microblock

The Initial Values section of the microblock dialog sets the rate at which the input value can be increased or decreased. These settings correspond to the text on the Parameter page. The description on the Status page changes according to the actual state of the microblock.

Figure 10-9: Ramp Up/Down Control microblock dialog

Microblock

Microblock Library icon

266 • Chapter 10: Limit Microblocks

Page 267: Eikon 3.02 Microblock Reference

Ramp Up/Down Control

Parameter page text

Ramp parameter description... Limit rise to ____ per _____(mm:ss) and fall to ____ per _____ (mm:ss)

Status page text

Ramp status description... rate of change is being restricted. is passing unrestricted. Currently ~~~~~~~~~~~~~

♦ ♦ ♦

Chapter 10: Limit Microblocks • 267

Page 268: Eikon 3.02 Microblock Reference

Ramp Up/Down Control

268 • Chapter 10: Limit Microblocks

Page 269: Eikon 3.02 Microblock Reference

11 Relay Microblocks

The Relay menu contains microblocks which accept signals from other microblocks, change or limit them in some way, and then output the modified signal. These microblocks should be placed in the middle of the Graphic Function Block between the Inputs and Outputs.

The following microblocks are available in the Relay menu:

Constant Duty Cycle 271

Variable Duty Cycle 273

Delay on Make 274

Delay on Break 275

Maximum On Timer 276

Minimum On/Off Timer 277

Latch 278

Toggle 279

Lead/Standby 280

Switch (Normally Closed to Variable) 283

Switch (Normally Closed to Constant) 284

Two Variables Switch 285

Chapter 11: Relay Microblocks • 269

Page 270: Eikon 3.02 Microblock Reference

Digital Wire Lock 286

Analog Wire Lock 287

270 • Chapter 11: Relay Microblocks

Page 271: Eikon 3.02 Microblock Reference

Constant Duty Cycle

Constant Duty Cycle

The Constant Duty Cycle microblock produces an output that cycles on and off according to the length of time you define for the cycle, and the percentage of that time you specify the output should be on. The microblock only cycles the output when the go input is on; if the go input is off, the output remains on.

On the microblock dialog you can define the length of the complete cycle using the Full cycle setting (period setting on the Parameter page). As shown below, the duty cycle determines the percentage of the cycle that the output is on. For example, using the values shown in Figure 11-2, the microblock’s output would turn on for 7.5 minutes, then turn off for 7.5 minutes, then begin the cycle again as long as the microblock’s go input stays on. The on time occurs at the beginning of the cycle, so that if the Duty cycle setting in Figure 11-2 were 20%, the output would turn on for three minutes, then off for 12 minutes.

Figure 11-1: Duty cycling

NOTE If the cycle time is changed, the change will not take effect until the current cycle is completed or the module is powered down and restarted.

Microblock

Microblock Library icon

Full cycle = 15 minutes

On

Off

Duty cycle on time = 50% (7.5 minutes)

Chapter 11: Relay Microblocks • 271

Page 272: Eikon 3.02 Microblock Reference

Constant Duty Cycle

Figure 11-2: Constant Duty Cycle microblock dialog

Parameter page text

Duty cycle ON for ___%, with period of _____ (mm:ss)

272 • Chapter 11: Relay Microblocks

Page 273: Eikon 3.02 Microblock Reference

Variable Duty Cycle

Variable Duty Cycle

The Variable Duty Cycle microblock produces an output that cycles on and off according to the length of time you define for the cycle and the value of the microblock’s input, which indicates the percentage of the cycle time the output should be on. The microblock only cycles the output when the input is on; if the input is off, the output remains on.

On the microblock dialog you can define the length of the complete cycle using the Period setting. For example, using the period shown in Figure 11-3, if the microblock’s input value is 50%, the microblock’s output would remain on for 7.5 minutes, then turn off for 7.5 minutes. The on time occurs at the beginning of the cycle, so that if the microblock’s input is 40%, the output would turn on for 6 minutes, then off for 9 minutes. Refer to Figure 11-1 on page 271 for an illustration of duty cycling.

NOTE If the duty cycle period is changed, the change will not take effect until the current cycle is completed or the module is powered down and restarted.

Figure 11-3: Variable Duty Cycle microblock dialog

Parameter page text

Duty cycle period is _____ (mm:ss)

Microblock

Microblock Library icon

Chapter 11: Relay Microblocks • 273

Page 274: Eikon 3.02 Microblock Reference

Delay on Make

Delay on Make

The Delay on Make microblock provides a delay before passing an on signal to the next microblock. You can set the length of the delay on the microblock dialog or the Parameter page.

When the microblock receives an on signal, its output remains off until the delay time has passed. The delay time applies only to an on signal. Once the input turns off, the output turns off immediately. If the input turns off before the delay period passes, the output does not turn on.

NOTE If you change the delay time after the input is turned on, the change will not take effect until the original delay time expires or the module is restarted.

Figure 11-4: Delay on Make microblock dialog

Parameter page text

Delay time is _____ (mm:ss)

Status page text

Delayed output is ~~~ for ~~~~~ (mm:ss).

Microblock

Microblock Library icon

274 • Chapter 11: Relay Microblocks

Page 275: Eikon 3.02 Microblock Reference

Delay on Break

Delay on Break

The Delay on Break microblock provides a delay before passing an off signal to the next microblock. You can set the length of the delay on the microblock dialog or the Parameter page.

When the microblock receives an off signal, its output remains on until the delay time has passed. The delay time applies only to an off signal. Once the input turns on, the output turns on immediately. If the input turns on before the delay period passes, the output does not turn off.

NOTE If you change the delay time after the input is turned off, the change will not take effect until the original delay time expires or the module is restarted.

Figure 11-5: Delay on Break microblock dialog

Parameter page text

Delay time is _____ (mm:ss)

Status page text

Delayed output is ~~~ for ~~~~~ (mm:ss).

Microblock

Microblock Library icon

Chapter 11: Relay Microblocks • 275

Page 276: Eikon 3.02 Microblock Reference

Maximum On Timer

Maximum On Timer

The Maximum On Timer microblock is used to limit the amount of time a signal remains on. When the microblock’s input turns on, the microblock turns its output on and begins to track the amount of time that passes. When the specified amount of time passes, the microblock turns its output off. If the input turns off before this time is reached, the microblock’s output turns off immediately.

You can set the maximum amount of time the microblock’s output stays on using the Maximum "on" duration setting on the microblock dialog or the Delay time is setting on the Parameter page. You can edit the Parameter and Status screen prompt text on the microblock dialog to provide a meaningful description of the microblock’s use on the Parameter and Status pages.

NOTE If you change the delay time after the input is turned on, the change will not take effect until the original delay time expires or the module is restarted.

Figure 11-6: Maximum On Timer microblock dialog

Parameter page text

Delay time is _____ (mm:ss)

Status page text

Delayed output is ~~~ for ~~~~~ (mm:ss).

Microblock

Microblock Library icon

276 • Chapter 11: Relay Microblocks

Page 277: Eikon 3.02 Microblock Reference

Minimum On/Off Timer

Minimum On/Off Timer

The Minimum On/Off Timer microblock defines the minimum amount of time that a signal should remain on or off. This microblock can be used to prevent an on/off signal from rapid fluctuations that could affect equipment performance.

When the microblock receives an on signal, the output turns on and remains on for the amount of time defined in the Minimum ON time setting (Min On on the Parameter page). Once the Minimum ON time expires, the microblock’s output either remains on if the input is on, or turns off if the input is off. Likewise, when the microblock receives an off signal, the output turns off and remains off for the amount of time defined in the Minimum OFF time (Min Off on the Parameter page). Once the Minimum OFF time expires, the microblock’s output either remains off if the input is off or turns on if the input is on.

NOTE If you change the minimum on or off time, the change will not take effect until the original minimum time expires or the module is restarted.

Figure 11-7: Minimum On/Off Timer microblock dialog

Parameter page text

Min On _____ (mm:ss) Min Off _____ (mm:ss)

Status page text

Current State = ~~~ Waiting to change? ~~~

Microblock

Microblock Library icon

Chapter 11: Relay Microblocks • 277

Page 278: Eikon 3.02 Microblock Reference

Latch

Latch

The Latch microblock maintains an on signal until some other condition occurs to turn the signal off. Once the latch input receives an on signal, the output turns on and remains on until the clr input turns on, even if the latch input turns off. When the clr input turns on, the microblock’s output turns off as long as the latch input is off. If both the latch input and clr input receive an on signal at the same time, the clr input takes precedence, and the microblock’s output turns off.

Figure 11-8: Using the Latch microblock

You can edit the Status screen prompt text on the microblock dialog to provide a meaningful description of the microblock’s use on the Status page.

Figure 11-9: Latch microblock dialog

Status page text

Latch output is ~~~

Microblock

Microblock Library icon

278 • Chapter 11: Relay Microblocks

Page 279: Eikon 3.02 Microblock Reference

Toggle

Toggle

The Toggle microblock toggles its output value whenever its input turns on. For example, when the toggle input turns on, the output turns on and remains on when the input turns off again. When the input turns back on, the output toggles off. When the clr input turns on, the output turns off or remains off if it is off already.

You can edit the Status screen prompt text on the microblock dialog to provide a meaningful description of the microblock’s use on the Status page.

Figure 11-10: Toggle microblock dialog

Status page text

Toggle output is ~~~

Microblock

Microblock Library icon

Chapter 11: Relay Microblocks • 279

Page 280: Eikon 3.02 Microblock Reference

Lead/Standby

Lead/Standby

The Lead/Standby microblock controls two outputs to maintain an on or off signal. If one of the output signals is interrupted by an alarm condition or an expired runtime, the other output is activated to continue the signal. The output that produces the same signal received by the go input is called the lead output. The other output is the standby output, which becomes the lead output when the lead output is inactivated. This occurs when one of the following happens:

• The lead output’s corresponding alarm input (a1 or a2) turns on. The a1 input corresponds to the o1 output, and the a2 input corresponds to the o2 output. Note that one of the outputs will be on even when both alarm inputs are on. For example, if a1 is on, then o2 turns on. If a2 then turns on, then o1 turns on even though a1 is still on.

• The lead output’s runtime expires. The maximum runtime for the lead output can be defined on the microblock’s dialog or on the Parameter page.

• The swap input turns on. When the swap input turns off, the outputs are not affected. Note that as long as the swap input is on, the alarm inputs do not affect the outputs. For example, if o1 is on and swap turns on, then o1 turns off and o2 turns on. If a2 then turns on while swap is still on, o2 will remain on. To avoid this situation, you can send a pulse signal to the swap input that turns swap on only long enough for the outputs to change.

The lstat output turns on when the lead and standby outputs are changed as a result of the swap input turning on. When the go input is off, both outputs are turned off.

If you want the standby output to become the lead based on runtime, set the Swap based on runtime option on the microblock dialog to yes. Use the Swap lead output after ____ hrs setting to determine when the lead output’s runtime expires. You can determine the starting runtime value using the Preset runtime value setting on the Parameter page.

Microblock

Microblock Library icon

280 • Chapter 11: Relay Microblocks

Page 281: Eikon 3.02 Microblock Reference

Lead/Standby

For example, if the Preset runtime value is 100, and the Swap lead output after __ hrs setting is 150, the lead output becomes the standby output after 50 hours have passed (150 hours - 100 hours preset = 50 hours). Once the Preset runtime value is used, the Latch in preset value now parameter automatically changes to N. You must change this parameter back to Y to use the Preset runtime value again.

TIP If you need to have at least one of the outputs on at all times, you may want to use Delay on Break microblocks on the outputs to account for the possibility of lag time when the outputs are swapped. See Figure 11-11 for an example.

Figure 11-11: Using the Lead/Standby microblock

Figure 11-12: Lead/Standby microblock dialog

Parameter page text

Enable lead swap based on runtime? ___Swap lead output after _____ hours of runtime.Preset runtime value _____ Latch in preset value now? _

Chapter 11: Relay Microblocks • 281

Page 282: Eikon 3.02 Microblock Reference

Lead/Standby

Status page text

Lead/Standby is ~~~~~~~~ Lead output is ~~~.Swap based on runtime? ~ Total accumulated runtime = ~~~~~~~~ hours.

282 • Chapter 11: Relay Microblocks

Page 283: Eikon 3.02 Microblock Reference

Switch (Normally Closed to Variable)

Switch (Normally Closed to Variable)

The Switch (Normally Closed to Variable) microblock is used to switch the microblock’s output between a numeric input and a constant value. The Constant value is defined on the microblock’s dialog box or the Parameter page.

The microblock’s output will normally equal the numeric input, unless the sw input is on. When the sw input is on, the microblock’s output equals the constant value.

You can edit the Parameter screen prompt text on the microblock dialog to provide a meaningful description of the microblock’s use on the Parameter page.

Figure 11-13: Switch (Normally Closed to Variable) microblock dialog

Parameter page text

This parameter is _____

Microblock

Microblock Library icon

Chapter 11: Relay Microblocks • 283

Page 284: Eikon 3.02 Microblock Reference

Switch (Normally Closed to Constant)

Switch (Normally Closed to Constant)

The Switch (Normally Closed to Constant) microblock is used to switch the microblock’s output between a numeric input and a constant value. The Constant value is defined on the microblock’s dialog box or the Parameter page.

The microblock’s output will normally equal the constant value, unless the sw input is on. When the sw input is on, the microblock’s output equals the numeric input’s value.

You can edit the Parameter screen prompt text on the microblock dialog to provide a meaningful description of the microblock’s use on the Parameter page.

Figure 11-14: Switch (Normally Closed to Constant) microblock dialog

Parameter page text

This parameter is _____

Microblock

Microblock Library icon

284 • Chapter 11: Relay Microblocks

Page 285: Eikon 3.02 Microblock Reference

Two Variables Switch

Two Variables Switch

The Two Variables Switch microblock is used to switch the microblock’s output value between two numeric inputs.

The microblock’s output will normally equal the first numeric input, unless the sw input is on. When the sw input is on, the microblock’s output equals the second numeric input.

Figure 11-15: Using the Two Variables Switch microblock

Microblock

Microblock Library icon

Chapter 11: Relay Microblocks • 285

Page 286: Eikon 3.02 Microblock Reference

Digital Wire Lock

Digital Wire Lock

The Digital Wire Lock microblock can lock a signal so that it remains on or off regardless of the input signal. You can assign a name to the lock that appears on the Parameter page.

On the microblock dialog, you can enable the lock and set the value of the microblock’s output. The Lock Type section of the microblock indicates whether the lock is continuous or dated. A continuous lock remains in effect until the lock is disabled. A dated lock is effective only for the time indicated in the Dated lock section of the dialog (the Begin and End settings on the Parameter page).

Figure 11-16: Digital Wire Lock microblock dialog

Parameter page text

________________ lock _ ___ Dated? _ (N = Continuous) Begin _________ _____ End _________ _____

Status page text

~~~~~~~~~~~~~~~~ lock ~ ~~~

Microblock

Microblock Library icon

286 • Chapter 11: Relay Microblocks

Page 287: Eikon 3.02 Microblock Reference

Analog Wire Lock

Analog Wire Lock

The Analog Wire Lock microblock can lock a specified value so that it remains the same regardless of the input signal. You can assign a name to the lock that appears on the Parameter page.

On the microblock dialog, you can enable the lock and set the value of the microblock’s output. The Lock Type section of the microblock indicates whether the lock is continuous or dated. A continuous lock remains in effect until the lock is disabled. A dated lock is effective only for the time indicated in the Dated lock section of the dialog (the Begin and End settings on the Parameter page).

Figure 11-17: Analog Wire Lock microblock dialog

Parameter page text

_______________ lock _ ________ Dated? _ (N = Continuous) Begin _________ _____ End _________ _____

Status page text

~~~~~~~~~~~~~~~~ lock ~ ~~~~~~~~~~~~~

♦ ♦ ♦

Microblock

Microblock Library icon

Chapter 11: Relay Microblocks • 287

Page 288: Eikon 3.02 Microblock Reference

Analog Wire Lock

288 • Chapter 11: Relay Microblocks

Page 289: Eikon 3.02 Microblock Reference

12 Logic Microblocks

The Logic menu contains microblocks which perform logical operations on signals received from other microblocks. Often these microblocks are used to determine conditions that trigger equipment starts, stops, or alarms. These microblocks accept only digital inputs and produce on or off (digital) signals.

The following microblocks are available in the Logic menu:

And - 2 Input 290

And - 3 Input 290

And - 4 Input 290

And - 5 Input 291

Or - 2 Input 291

Or - 3 Input 291

Or - 4 Input 291

Or - 5 Input 292

Exclusive Or (XOR) 292

Not 292

Chapter 12: Logic Microblocks • 289

Page 290: Eikon 3.02 Microblock Reference

And - 2 Input

And - 2 Input

The And - 2 Input microblock accepts two on or off (digital) signals. If both inputs are on, the microblock’s output turns on. If either of the two inputs is off, the microblock’s output is off.

And - 3 Input

The And - 3 Input microblock accepts three on or off (digital) signals. If all the inputs are on, the microblock’s output turns on. If any of the three inputs is off, the microblock’s output is off.

And - 4 Input

The And - 4 Input microblock accepts four on or off (digital) signals. If all the inputs are on, the microblock’s output turns on. If any of the four inputs is off, the microblock’s output is off.

Microblock

Microblock Library icon

Microblock

Microblock Library icon

Microblock

Microblock Library icon

290 • Chapter 12: Logic Microblocks

Page 291: Eikon 3.02 Microblock Reference

And - 5 Input

And - 5 Input

The And - 5 Input microblock accepts five on or off (digital) signals. If all the inputs are on, the microblock’s output turns on. If any of the five inputs is off, the microblock’s output is off.

Or - 2 Input

The Or - 2 Input microblock accepts two on or off (digital) signals. If either of the two inputs are on, the microblock’s output turns on. If neither of the two inputs are on, the microblock’s output turns off.

Or - 3 Input

The Or - 3 Input microblock accepts three on or off (digital) signals. If any of the three inputs are on, the microblock’s output turns on. If none of the inputs are on, the microblock’s output turns off.

Or - 4 Input

The Or - 4 Input microblock accepts four on or off (digital) signals. If any of the four inputs are on, the microblock’s output turns on. If none of the inputs are on, the microblock’s output turns off.

Microblock

Microblock Library icon

Microblock

Microblock Library icon

Microblock

Microblock Library icon

Microblock

Microblock Library icon

Chapter 12: Logic Microblocks • 291

Page 292: Eikon 3.02 Microblock Reference

Or - 5 Input

Or - 5 Input

The Or - 5 Input microblock accepts five on or off (digital) signals. If any of the five inputs are on, the microblock’s output turns on. If none of the inputs are on, the microblock’s output turns off.

Exclusive Or (XOR)

The Exclusive Or (XOR) microblock accepts two on or off (digital) signals. If either of the two inputs are on (but not both), the microblock’s output turns on. If none of the inputs are on, or if both of the inputs are on, the microblock’s output turns off.

Not

The Not microblock produces an output opposite of its input. For example, when the microblock’s input is on, the output is off. When the input is off, the output is on.

♦ ♦ ♦

Microblock

Microblock Library icon

Microblock

Microblock Library icon

Microblock

Microblock Library icon

292 • Chapter 12: Logic Microblocks

Page 293: Eikon 3.02 Microblock Reference

13 Math1 Microblocks

The Math1 menu contains microblocks which perform mathematical operations on value(s) from other microblocks. These microblocks should be placed in the middle of the Graphic Function Block between the Inputs and Outputs.

The following microblocks are available in the Math1 menu:

Add Constant to Variable 295

Subtract Constant from Variable 296

Multiply Variable by Constant 297

Divide Variable by Constant 298

Modulo Divide by Constant 299

Add Two Variables 300

Add Three Variables 300

Add Four Variables 300

Subtract Two Variables 300

Multiply Two Variables 301

Divide Two Variables 301

Modulo 301

Chapter 13: Math1 Microblocks • 293

Page 294: Eikon 3.02 Microblock Reference

Average 301

Change Sign 302

Absolute Value 302

294 • Chapter 13: Math1 Microblocks

Page 295: Eikon 3.02 Microblock Reference

Add Constant to Variable

Add Constant to Variable

The Add Constant to Variable microblock adds its input value to a Constant value you can define on the microblock’s dialog or the Parameter page. The microblock’s output is the result of this calculation.

You can edit the Parameter screen prompt text on the microblock dialog to provide a meaningful description of the microblock’s use on the Parameter page.

Figure 13-1: Add Constant to Variable microblock dialog

Parameter page text

This parameter is _____

Microblock

Microblock Library icon

Chapter 13: Math1 Microblocks • 295

Page 296: Eikon 3.02 Microblock Reference

Subtract Constant from Variable

Subtract Constant from Variable

The Subtract Constant from Variable microblock subtracts the Constant value you define on the microblock’s dialog or the Parameter page from its input value. The microblock’s output is the result of this calculation.

You can edit the Parameter screen prompt text on the microblock dialog to provide a meaningful description of the microblock’s use on the Parameter page.

Figure 13-2: Subtract Constant from Variable microblock dialog

Parameter page text

This parameter is _____

Microblock

Microblock Library icon

296 • Chapter 13: Math1 Microblocks

Page 297: Eikon 3.02 Microblock Reference

Multiply Variable by Constant

Multiply Variable by Constant

The Multiply Variable by Constant microblock multiplies its input value by the Constant value you define on the microblock’s dialog or the Parameter page. The microblock’s output is the result of this calculation.

You can edit the Parameter screen prompt text on the microblock dialog to provide a meaningful description of the microblock’s use on the Parameter page.

Figure 13-3: Multiply Variable by Constant microblock dialog

Parameter page text

This parameter is _____

Microblock

Microblock Library icon

Chapter 13: Math1 Microblocks • 297

Page 298: Eikon 3.02 Microblock Reference

Divide Variable by Constant

Divide Variable by Constant

The Divide Variable by Constant microblock divides its input value by the Constant value you define on the microblock’s dialog or the Parameter page. The microblock’s output is the result of this calculation.

You can edit the Parameter screen prompt text on the microblock dialog to provide a meaningful description of the microblock’s use on the Parameter page.

Figure 13-4: Divide Variable by Constant microblock dialog

Parameter page text

This parameter is _____

Microblock

Microblock Library icon

298 • Chapter 13: Math1 Microblocks

Page 299: Eikon 3.02 Microblock Reference

Modulo Divide by Constant

Modulo Divide by Constant

The Modulo Divide by Constant microblock divides its input value by the Constant value you define on the microblock’s dialog or the Parameter page. The microblock’s output is equal to the remainder of this calculation. For example, if the microblock’s input is ten and the Divisor (defined on the microblock’s dialog) is three, the microblock’s output is one.

You can edit the Parameter screen prompt text on the microblock dialog to provide a meaningful description of the microblock’s use on the Parameter page.

Figure 13-5: Modulo Divide by Constant microblock dialog

Parameter page text

This parameter is _____

Microblock

Microblock Library icon

Chapter 13: Math1 Microblocks • 299

Page 300: Eikon 3.02 Microblock Reference

Add Two Variables

Add Two Variables

The Add Two Variables microblock adds the values of its inputs. The microblock’s output is the result of this calculation.

Add Three Variables

The Add Three Variables microblock adds the values of its inputs. The microblock’s output is the result of this calculation.

Add Four Variables

The Add Four Variables microblock adds the values of its inputs. The microblock’s output is the result of this calculation.

Subtract Two Variables

The Subtract Two Variables microblock subtracts the value of its second input from the value of its first input. The microblock’s output is the result of this calculation.

Microblock

Microblock Library icon

Microblock

Microblock Library icon

Microblock

Microblock Library icon

Microblock

Microblock Library icon

300 • Chapter 13: Math1 Microblocks

Page 301: Eikon 3.02 Microblock Reference

Multiply Two Variables

Multiply Two Variables

The Multiply Two Variables microblock multiplies the values of its two inputs together. The microblock’s output is the result of this calculation.

Divide Two Variables

The Divide Two Variables microblock divides the value of its first input by the value of its second input. The microblock’s output is the result of this calculation.

Modulo

The Modulo microblock divides the value of its first input by the value of its second input. The microblock’s output equals the remainder of this calculation. For example, if the microblock’s first input is ten, and the second input is three, the microblock’s output is one.

Average

The Average microblock calculates the average of its two input values. The microblock’s output is the result of this calculation.

Microblock

Microblock Library icon

Microblock

Microblock Library icon

Microblock

Microblock Library icon

Microblock

Microblock Library icon

Chapter 13: Math1 Microblocks • 301

Page 302: Eikon 3.02 Microblock Reference

Change Sign

Change Sign

The Change Sign microblock changes the sign of its input value by multiplying the value by -1. For example, if the microblock’s input value is -32, the output value is 32.

Absolute Value

The Absolute Value microblock determines the absolute value of its input by removing its sign. For example, if the microblock’s input is -10, the output is 10. If the microblock’s input is 8, the output is 8.

♦ ♦ ♦

Microblock

Microblock Library icon

Microblock

Microblock Library icon

302 • Chapter 13: Math1 Microblocks

Page 303: Eikon 3.02 Microblock Reference

14 Math2 Microblocks

The Math2 menu contains microblocks which perform mathematical operations on value(s) received from other microblocks. These microblocks should be placed in the middle of the Graphic Function Block between the Inputs and Outputs.

The following microblocks are available in the Math2 menu:

Sine 304

Cosine 304

Tangent 304

Natural Log 304

Log 305

Exponent 305

Square Root 305

Integrator 306

Round Up/Down 307

Truncate 307

Chapter 14: Math2 Microblocks • 303

Page 304: Eikon 3.02 Microblock Reference

Sine

304 • Chapter 14: Math2 Microblocks

Sine

The Sine microblock accepts a value in degrees and calculates the sine of this value. The microblock’s output is the result of this calculation.

Cosine

The Cosine microblock accepts a value in degrees and calculates the cosine of this value. The microblock’s output is the result of this calculation.

Tangent

The Tangent microblock accepts a value in degrees and calculates the tangent of this value. The microblock’s output is the result of this calculation.

Natural Log

The Natural Log microblock calculates the natural logarithm of its input. The microblock’s output is the result of this calculation.

Microblock

Microblock Library icon

Microblock

Microblock Library icon

Microblock

Microblock Library icon

Microblock

Microblock Library icon

Page 305: Eikon 3.02 Microblock Reference

Log

Log

The Log microblock calculates the base 10 logarithm of its input. The microblock’s output is the result of this calculation.

Exponent

The Exponent microblock raises the value of its second input to the power of its first input. The microblock’s output is the result of this calculation.

Square Root

The Square Root microblock calculates the square root of its input value. The microblock’s output is the result of this calculation.

Microblock

Microblock Library icon

Microblock

Microblock Library icon

Microblock

Microblock Library icon

Chapter 14: Math2 Microblocks • 305

Page 306: Eikon 3.02 Microblock Reference

Integrator

Integrator

The Integrator microblock calculates a value over time (minutes or hours) at a rate defined by the value of the input. The microblock’s output is based on the value of the input and the rate chosen on the microblock dialog.

On the microblock dialog you define whether the microblock’s value is calculated over minutes (units/min) or hours (units/hr). For example, if the microblock’s input value is 10, and the rate is measured in units per hour, the microblock’s output increases at a rate of 10 per hour. At the end of the first hour, the output value is 10; at the end of the second hour, the output is 20, and so on. When the clr input turns on, the microblock’s output value is reset to zero.

Figure 14-1: Using the Integrator microblock

You can edit the Status screen prompt text on the microblock dialog to provide a meaningful description of the microblock’s use on the Status page.

Figure 14-2: Integrator microblock dialog

Microblock

Microblock Library icon

306 • Chapter 14: Math2 Microblocks

Page 307: Eikon 3.02 Microblock Reference

Round Up/Down

Status page text

Current use = ~~~~~~~~~~~~

Round Up/Down

The Round Up/Down microblock rounds the input value up or down and produces a whole number. If the fraction of the input value is less than 0.5, the microblock rounds the number down to the next whole number. If the fraction of the input is 0.5 or greater, the microblock rounds the number up to the next whole number.

Truncate

The Truncate microblock discards the fractional portion of its input and provides a whole number output.

♦ ♦ ♦

Microblock

Microblock Library icon

Microblock

Microblock Library icon

Chapter 14: Math2 Microblocks • 307

Page 308: Eikon 3.02 Microblock Reference

Truncate

308 • Chapter 14: Math2 Microblocks

Page 309: Eikon 3.02 Microblock Reference

15 Misc Microblocks

The Misc menu contains miscellaneous microblocks. Although the OCL microblock appears in the Misc menu, it is discussed in the section “Operators' Control Language” on page 327 because of its complexity.

The following microblocks are available in the Misc menu:

DO/DI Proof 310

Up/Down Counter 312

Sunrise/Sunset 313

Text 315

Multi-Text 316

Version 318

Operators' Control Language 327

Chapter 15: Misc Microblocks • 309

Page 310: Eikon 3.02 Microblock Reference

DO/DI Proof

DO/DI Proof

The DO/DI Proof microblock verifies proper equipment operation by comparing the status of a Digital Input with the status of a corresponding Digital Output. For example, the microblock can compare an input indicating the fan’s on or off status with the output that turns the fan on or off. If the two inputs do not receive the same signal, the DO/DI Proof microblock provides two outputs that can be used to trigger alarms.

Figure 15-1: Using the DO/DI Proof microblock

On the microblock dialog, the Feedback delay setting allows you to specify an allowable delay between the time a Digital Output turns on and the time the Digital Input registers the new status. When the microblock’s do input turns on, if the di input does not turn on by the time the feedback delay time expires, the alrm output turns on. The Debounce time setting is the amount of time that the di input must remain on or off before it is considered valid. The debounce time should not be longer than the feedback delay; otherwise, an alarm will be generated each time the equipment starts.

The alrm output turns on when the do input is on but the di input is off, indicating that the equipment is not running when it should have been turned on. The hand output turns on when the do input is off but the di input is on, indicating that the equipment is still running when it should have been turned off.

You can edit the Parameter screen prompt text on the microblock dialog to provide a meaningful description of the microblock’s use on the Parameter page.

Microblock

Microblock Library icon

310 • Chapter 15: Misc Microblocks

Page 311: Eikon 3.02 Microblock Reference

DO/DI Proof

Figure 15-2: DO/DI Proof microblock dialog

Parameter page text

Proof par description: Feedback Delay _____ Debounce Time _____ (mm:ss)

Chapter 15: Misc Microblocks • 311

Page 312: Eikon 3.02 Microblock Reference

Up/Down Counter

Up/Down Counter

The Up/Down Counter microblock counts the number of on signals it receives and produces a number that increases or decreases according to the input receiving the signal. Each time the inc input turns on, the output value is increased by one. Each time the dec input turns on, the output value is decreased by one (but does not fall below zero). When the clr input turns on, the output value resets to zero.

You can edit the Status screen prompt text on the microblock dialog to provide a meaningful description of the microblock’s use on the Status page.

Figure 15-3: Up/Down Counter microblock dialog

Status page text

Current count = ~~~~~~~~~~~~

Microblock

Microblock Library icon

312 • Chapter 15: Misc Microblocks

Page 313: Eikon 3.02 Microblock Reference

Sunrise/Sunset

Sunrise/Sunset

The Sunrise/Sunset microblock calculates the time the sun will rise and set based on location and time zone information entered on the microblock’s dialog or the Parameter page. The sunrise and sunset outputs produce today’s sunrise and sunset times. The daylight output turns on when the current time falls between sunrise and sunset and turns off when the current time is before sunrise or after sunset.

The Latitude, Longitude, and Offset from Greenwich Mean Time settings must be entered accurately in order to ensure that the correct sunrise and sunset times are calculated. Consult an atlas or your local weather station to determine this information for your area. When entering the longitude for a location in the Western Hemisphere (North or South America), enter the longitude as a negative number. Choose the appropriate negative number for the timezone:

EST = -5 CST = -6MST = -7 PST = -8

The Daylight Saving Time section of the microblock dialog allows you to enter the dates that Daylight Saving Time is in effect for up to seven years.

Parameter page text

Latitude: ____ degrees, __ minutes; Longitude: ____ degrees, __ minutesOffset from Greenwich Mean Time (EST=-5, CST=-6, MST=-7, PST=-8) _____----------- Daylight Saving Time Changeover Dates (Sundays) -----------

Offset local time by ____ hour(s) between the following dates:

Range 1: _________ to _________Range 2: _________ to _________Range 3: _________ to _________Range 4: _________ to _________Range 5: _________ to _________Range 6: _________ to _________Range 7: _________ to _________

Microblock

Microblock Library icon

Chapter 15: Misc Microblocks • 313

Page 314: Eikon 3.02 Microblock Reference

Sunrise/Sunset

Status page text

Sunrise today occurs at ~~~~~~; Sunset today occurs at ~~~~~~.It is currently ~~~~~~~~.

314 • Chapter 15: Misc Microblocks

Page 315: Eikon 3.02 Microblock Reference

Text

Text

Text microblocks do not interact with other microblocks in the GFB and are used only to place descriptive text on the Parameter page. The position of the text on the Parameter page can be controlled by clicking Reorder-Edit Order. The text is entered and edited on the microblock dialog but cannot be edited on the Parameter page.

Figure 15-4: Text microblock dialog

Microblock

Microblock Library icon

Chapter 15: Misc Microblocks • 315

Page 316: Eikon 3.02 Microblock Reference

Multi-Text

Multi-Text

The Multi-Text microblock can be used to place descriptive text on the Function Block's Parameter and Status pages. The microblock accepts a numeric input of 1 to 15, which corresponds to one of 15 lines of descriptive text you can define. When an input from 1 to 15 is received, the corresponding text appears on the Status page. If an input higher than 15 or lower than 1 is received, no text for this microblock appears on the Status page. Each line of text may contain up to 48 characters, but quotation marks cannot be used.

The position of the text on the Parameter page can be controlled by clicking Reorder-Edit Order. The text is entered and edited on the microblock dialog. The text cannot be edited on the Parameter page.

Figure 15-5: Multi-Text microblock dialog

Microblock

Microblock Library icon

316 • Chapter 15: Misc Microblocks

Page 317: Eikon 3.02 Microblock Reference

Multi-Text

Parameter page text

String 1: ________________________________________________String 2: ________________________________________________String 3: ________________________________________________String 4: ________________________________________________String 5: ________________________________________________String 6: ________________________________________________String 7: ________________________________________________String 8: ________________________________________________String 9: ________________________________________________String 10: ________________________________________________String 11: ________________________________________________String 12: ________________________________________________String 13: ________________________________________________String 14: ________________________________________________String 15: ________________________________________________

Chapter 15: Misc Microblocks • 317

Page 318: Eikon 3.02 Microblock Reference

Version

Version

The Version microblock allows you to attach a fixed version number to a Graphic Function Block. This number appears only on the face of the microblock and on the Modstat page of the module where the GFB resides. The version number can only be changed on the microblock dialog. The Version microblock does not interact with any other microblock in the GFB and does not have any corresponding Parameter or Status page text.

Figure 15-6: Version microblock dialog

♦ ♦ ♦

Microblock

Microblock Library icon

318 • Chapter 15: Misc Microblocks

Page 319: Eikon 3.02 Microblock Reference

16 Figure

Unlike the other Microblock menus, the Figure menu contains figures that allow the operator to draw on the Eikon screen. This feature is helpful for organizing areas of a GFB. For example, an unfilled rectangle could be drawn around a certain area of logic with descriptive text.

The Figure menu can be used along with the editing commands available in Eikon (Move, Delete, etc.) and the Palette (which can be shown by clicking Options-Palette). The Palette allows you to choose the colors, pattern, and line style for the figure you are drawing.

Drawing figures

Figures are drawn using the same basic steps. From the Figure menu, click the figure you want to draw. Click the color and pattern or line style you want from the palette. You can then begin drawing a figure following the specific instructions for the shape (instructions begin on page 320).

Figure 16-1: Eikon’s palette

If you choose to use one of the available patterns for your figure, you can click a foreground color for your figure and right-click a

Patterns

Palette

StylesLine

Chapter 16: Figure • 319

Page 320: Eikon 3.02 Microblock Reference

Drawing figures

background color. A choice of line style is only necessary when you are drawing a line or an unfilled object.

Following are specific instructions for drawing each type of shape on the Figure menu. Some of the shapes are available as both filled and unfilled objects, but the technique for drawing a filled or unfilled object is the same.

To draw a line

1. Start the line by holding down the left mouse button where you want to begin the line.

2. Drag the mouse to draw the line the length you want.

3. To create additional segments, right-click while holding down the left mouse button and moving the cursor to the desired location.

Up to 15 segments can be made in a line.

4. To finish the line, release the left mouse button.

The backspace key can cancel line segments starting with the last one as long as you have not completed the figure and released the left mouse button.

To draw a square or rectangle

1. Start the rectangle by holding down the left mouse button where you want to begin the object.

2. Drag the mouse to an opposite corner to create the shape you want.

3. To finish the rectangle, release the left mouse button.

320 • Chapter 16: Figure

Page 321: Eikon 3.02 Microblock Reference

Drawing figures

To draw a circle

1. Start the circle by holding down the left mouse button where the center of the completed circle should be.

2. Drag the mouse away from the center until the circle is the desired size.

3. To finish the circle, release the left mouse button.

To draw an ellipse

Use the circle figure to draw an ellipse.

1. Start the ellipse by holding down the left mouse button where the center of the completed ellipse should be.

2. Drag the mouse away from the center until the ellipse has the horizontal width you desire.

3. While still holding the left mouse button down, click and release the right mouse button and move the mouse up/down or left/right until the desired ellipse has been formed.

TIP It may take some practice to form an ellipse of the proper size and shape.

To draw an arc

1. Start the arc by holding down the left mouse button where the center of the completed circle should be.

2. Drag the mouse away from the center until the circle is the desired size.

3. While still holding the left mouse button down, right-click the mouse button and move the cursor clockwise or counter-

Chapter 16: Figure • 321

Page 322: Eikon 3.02 Microblock Reference

Editing figures

clockwise until the desired arc has been formed. To finish the shape, release the left button.

To draw a polygon

1. Start the polygon by holding down the left mouse button where you want to begin the object.

2. Drag the mouse to another corner to form the first side of the polygon.

3. While still holding the left mouse button, right-click the mouse to draw the next side of the figure.

4. Continue in this manner until the figure is complete.

Up to 15 directional changes can be made.

5. To finish the figure, release the left mouse button.

To draw dots

1. Click and release the left mouse button where you want to draw a dot.

Each dot is a separate figure with its own origin. Background color and line style do not apply when drawing dots.

Editing figures

The figures you draw using the Figure menu can be moved, deleted, and copied using the Edit menu commands, just as you would move, delete or copy microblocks or wires. It is also possible to change the shape, color, pattern, or line style of a figure and to rotate and scale the figure to a different size.

322 • Chapter 16: Figure

Page 323: Eikon 3.02 Microblock Reference

Editing figures

Editing a figure’s attributes

You can change a figure’s color, pattern, or line style by clicking Edit-Edit-Others-Attributes. You can edit the attributes for multiple figures at one time by first selecting each figure, then by clicking Edit-Edit-Others-Selected.

To edit the attributes of a figure

1. Click Edit-Edit-Attributes.

2. Click the figure to be edited.

3. Click the desired color, pattern, or line style.

TIP You can also click Edit-Edit-Others-Attributes to change the font, direction, or alignment of text. Enter text using the Abc option on one of the microblock libraries.

Editing a figure’s shape

You can change the shape of a figure using the Edit-Edit-Shape menu command. When editing a polygon or line, you can add or remove portions of the line or figure.

To edit the shape of an arc, circle, ellipse, or rectangle

1. Click Edit-Edit-Shape.

2. Click and hold the left mouse button inside the figure to be edited.

3. Drag the outline of the figure to the desired shape.

4. Release the left mouse button to complete the shape.

Chapter 16: Figure • 323

Page 324: Eikon 3.02 Microblock Reference

Editing figures

To edit the shape of a line or polygon

1. Click Edit-Edit-Shape.

2. Click and hold the left mouse button inside the figure to be edited.

The last segment of the figure as it was originally drawn becomes active.

3. Drag the segment to the desired position.

To add additional segments, click the right mouse button and continue as you would to draw the line or segment. Refer to the procedure “To draw a line” on page 320 or the procedure “To draw a polygon” on page 322 for details.

To remove segments, press Backspace while continuing to hold the left mouse button.

4. When the figure is complete, release the left mouse button.

Scaling and rotating

You can scale a figure up or down to a desired percentage, and you can rotate a figure around its origin. The width (X-axis) and height (Y-axis) of most figures can be adjusted independently of each other. However, text cannot be scaled at all.

NOTE Do not scale or rotate microblocks.

The minimum and maximum range of scaling is from zero percent to approximately 32,000 percent. If a figure is scaled up or down over 90 percent of its original size, it may not be possible to scale the figure back.

324 • Chapter 16: Figure

Page 325: Eikon 3.02 Microblock Reference

Editing figures

To scale or rotate objects

1. Press F8 to display the scaling dialog.

Figure 16-2: Scale and rotate dialog

2. Type the amount in percent that you want to scale the figure horizontally (on the X-axis) and vertically (on the Y-axis).

A negative percentage shrinks the figure, and a positive percentage enlarges it. If you do not want to change the figure’s size, leave these values at 100.

3. Type the amount in degrees that you want to rotate the figure.

A negative number rotates the figure counter-clockwise around its origin (or starting point). A positive number rotates the figure clockwise around its origin. If you do not want to rotate the figure, leave this value at 0.

4. Click OK to continue.

5. Click the object you want to scale or rotate.

TIP You can scale or rotate multiple objects by using the right mouse button to drag an outline around a group of objects. Release the mouse button to complete the scale or rotation.

♦ ♦ ♦

Chapter 16: Figure • 325

Page 326: Eikon 3.02 Microblock Reference

Editing figures

326 • Chapter 16: Figure

Page 327: Eikon 3.02 Microblock Reference

17 Operators' Control Language

The OCL microblock allows you to create your own microblock when the existing Eikon microblocks are not suitable for your application. You define the microblock’s inputs, outputs, and internal calculations. This entire chapter is devoted to the programming necessary to use the OCL microblock.

NOTE This microblock can only be used with modules containing Exec version 5.1 or higher. It is highly recommended that you consult Technical Support before proceeding with the engineering of this microblock.

An OCL program is made up of two parts: the variable declaration section and the body of the program itself. The variable declaration section allows you to define features that are unique to the microblock and variables that are used in the body of the program. OCL also provides a number of terms, variables, mathematical functions, and programming commands you can use to complete your program.

Note that although OCL has a great deal of flexibility, you should not try to program an entire FB into a single microblock. The program will function more efficiently if you break it up into smaller sections, using wires and other microblocks whenever possible. This way, you will also be able to easily see the components of the GFB, which will make the program easier to troubleshoot if necessary.

The OCL program is not case-sensitive, but there are certain characters that have a special meaning, and there are cases in which a certain syntax must be used for the command to be understood. This information is noted in the applicable sections in this chapter.

When you click OK on the OCL microblock dialog, the program is saved and checked for errors. A list of possible error messages and their explanations is located in the section “Error Messages” on page 347.

Chapter 17: Operators' Control Language • 327

Page 328: Eikon 3.02 Microblock Reference

To create a custom microblock using OCL

1. Click the OCL microblock icon from the Misc microblock menu.

2. Click where you want to place the microblock.

The OCL microblock appears as a blank gray microblock when it is first placed. When you define the microblock’s title, inputs, and outputs, the microblock will expand to accommodate the necessary text on the microblock’s face.

3. To enter the programming for the microblock, press F5 and then click the OCL microblock.

4. Type the program into the editing window.

5. Click OK to save the program and close the editing window.

If errors are found in the program, a message appears. The message indicates which line of the program the error was found in, so you can correct the error more easily. Error messages and their explanations are listed in the section “Error Messages” on page 347.

If no errors are found, the program is saved and the microblock changes appearance to reflect the title and any inputs or outputs defined.

TIP If you want to use this microblock in more than one GFB, select the microblock by pressing F9 and clicking the microblock. Then save the microblock as a symbol by clicking Edit-Copy To. Refer to the Eikon User’s Guide for more information about symbols.

328 • Chapter 17: Operators' Control Language

Page 329: Eikon 3.02 Microblock Reference

Sample OCL program

Sample OCL program

Following is a sample OCL program, which will give you an idea of how the different lines of code interact with each other.

Figure 17-1: Sample OCL program

Variable declaration section

The first part of an OCL program is the variable declaration section. In this section you define values that are specific to the microblock you want to create, such as the microblock’s title, the microblock’s inputs and outputs, and the settings that appear on the Parameter and Status pages.

The values you define in the variable declaration section are used in the body of the OCL program along with the predefined symbols, system variables, functions, and structures. The following list explains the terms you can define in the variable declaration section of the

This is the variabledeclaration section. This

section contains informationabout the microblock’s

inputs and outputs, and anyvariables used in the body of

the program.

Comment

Programming structure

Mathematical function

Special character

This is the microblockthat results from the

program shown above.

This is the programmingsequence followed when

the OCL program executes.Each line is indented by

typing a number of spacesprior to the actual code. This

spacing, while notnecessary, makes the

program easier to read andunderstand.

Chapter 17: Operators' Control Language • 329

Page 330: Eikon 3.02 Microblock Reference

Variable declaration section

program. You cannot create a variable using the same name as any of the predefined symbols, functions, or commands.

When entering the variable declaration section, you only need to include those items that are used by the microblock. Each term can be typed either in upper or lower case letters and should be followed by at least one space.

AINPUT This term is used to define the microblock’s analog inputs. Each input’s name must begin with a letter. While each name can be up to 32 characters long, only the first four characters appear on the face of the microblock. If you need to define more than one analog input, separate each input’s name with a comma.

Example

AINPUT TMP1,CUR5,ENT3

This line creates three analog inputs for the microblock named TMP1, CUR5, and ENT3.

AOUTPUT This term is used to define the microblock’s analog outputs. Each output’s name must begin with a letter. While each name can be up to 32 characters long, only the first four characters appear on the face of the microblock. If you need to define more than one analog output, separate each output’s name with a comma.

Example

AOUTPUT COIL,POWR,HEAT

This line creates three analog outputs for the microblock named COIL, POWR, and HEAT.

DINPUT This term is used to define the microblock’s digital inputs. Each input’s name must begin with a letter. While each name can be up to 32 characters long, only the first four characters appear on the face of the microblock. If you need to define more than one digital input, separate each input’s name with a comma.

330 • Chapter 17: Operators' Control Language

Page 331: Eikon 3.02 Microblock Reference

Variable declaration section

Example

DINPUT STA1,PMP2

This line creates two digital inputs for the microblock named STA1 and PMP2.

DOUTPUT This term is used to define the microblock’s digital outputs. Each output’s name must begin with a letter. While each name can be up to 32 characters long, only the first four characters appear on the face of the microblock. If you need to define more than one digital output, separate each output’s name with a comma.

Example

DOUTPUT SEC7,LIG2

This line creates two digital outputs for the microblock named SEC7 and LIG2.

PAR This term is used to define variables that are used in the body of the OCL program, and if necessary, to define the text for these variables that appears on the Parameter page. Each variable can be any letter or letter combination you choose, as long as it is not already used by OCL. If the variable appears on the Parameter page, the Parameter page text should be entered within quotation marks following the variable. To display the value of the parameter, you must use the underscore character (_). You must enter enough underscores to account for all the digits required to display the value; otherwise, the value will be truncated.

TIP If you want to display the variable’s value on the Parameter page but do not want the value to be changed, you can use a tilde (~) in place of the underscore. Refer to the example below.

Example

PAR E = 2.71 "E equals ____", X = 5.0 "X equals ~~~"

In this example, OCL assigns the variable E to 2.71 and X to 5.0. On the parameter page, the text "E equals 2.71" will be displayed, with the "2.71" in blue text, indicating that this value can be

Chapter 17: Operators' Control Language • 331

Page 332: Eikon 3.02 Microblock Reference

Variable declaration section

changed. The text "X equals 5.0" also appears on the Parameter page, but the value "5.0" appears in yellow text, indicating that it cannot be changed.

TIMER The TIMER declaration is used to define timing variables. These are defined similar to the VAR declaration, with a variable name, text within quotes, and a string of tildes to display the present value of the variable.

Example

TIMER T2 "Time remaining for Timer2 = ~~~~ (mm:ss)"

In this example, OCL displays the given text on the Status page along with the present value of T2 instead of the string of tildes.

TITLE This term defines the title of the microblock that appears on the microblock’s face. The title will not appear if no inputs or outputs are defined. The title may be up to eight characters long.

Example

TITLE ICEPLANT

In this example, OCL assigns the name "ICEPLANT" to the microblock.

VAR This term is used to define variables that are used in the body of the OCL program, and if necessary, to define the text for these variables that appears on the Status page. Each variable can be any letter or letter combination you choose, as long as it is not already used in the variable declaration section or by OCL. If the variable appears on the Status page, the Status page text should be entered within quotation marks following the variable. To display the value of the variable, you must use the tilde character (~). You must enter enough tildes to account for all the digits required to display the value; otherwise, the value will be truncated.

332 • Chapter 17: Operators' Control Language

Page 333: Eikon 3.02 Microblock Reference

Predefined Symbols

Example

VAR Z "Z equals ~~~~"

In this example, OCL displays the text "Z equals" along with the present value of Z.

Predefined Symbols

OCL provides a number of predefined symbols, which are terms that already have an assigned value. These terms can be used in the body of your OCL program. You cannot change the value of any of these terms, and you should not list these terms in the variable declaration section.

Table 17-1. Predefined OCL symbols

Symbol Value Symbol Value

GRAY 1 JAN 1

HRED 2 FEB 2

KBLUE 3 MAR 3

LTBLUE 4 APR 4

GREEN 5 MAY 5

SPECKLE 6 JUN 6

YELLOW 7 JUL 7

ORANGE 8 AUG 8

CRED 9 SEP 9

WHITE 10 OCT 10

NOV 11

TRUE 1 DEC 12

FALSE 0

ON 1 MON 1

Chapter 17: Operators' Control Language • 333

Page 334: Eikon 3.02 Microblock Reference

System Variables

System Variables

OCL provides several system variables, which read information from the GFB. You can use these variables in your program whenever one of these values is required. Each system variable produces a number corresponding to the variable’s current value in the GFB.

COLOR TRepresents the GFB’s current color (1-10).

MDAY Represents the current day of the month (1-31).

MONTH Represents the current month (1-12).

TIME Represents the current time (0-1439; in minutes since midnight).

WDAY Represents the current day of the week (Monday=1, Sunday=7).

YDAY Represents the current day of the year (1-366).

YEAR Represents the current year (1981-2040).

OFF 0 TUE 2

OCC 1 WED 3

UNOCC 0 THU 4

OCCUPIED 1 FRI 5

UNOCCUPIED 0 SAT 6

YES 1 SUN 7

NO 0

Table 17-1. Predefined OCL symbols

Symbol Value Symbol Value

334 • Chapter 17: Operators' Control Language

Page 335: Eikon 3.02 Microblock Reference

Special Characters

Special Characters

When typing your OCL program, there are certain characters that represent specific functions or values in OCL. The characters that have a special significance in OCL are described below:

Mathematical Functions

OCL provides a number of mathematical and logical functions you can use in your program. Each of these functions acts on a value or set of values in parenthesis following the name of the function. These functions can act on numbers, variables, or expressions to calculate the results.

ABS

This function returns the absolute value of the number, variable, or expression in parenthesis.

Table 17-2. Special Characters

Character Description

( ) Used to override order of evaluation in an expression, delineate arguments in function calls, and to specify a conditional expression.

, (comma) Used to separate arguments in function calls.

: (colon) Used to identify labels referenced by GOSUB and GOTO keywords.

// Used to place comments in the program. Any text following two front slashes is ignored by the OCL complier.

H Used to represent one hour, or 3600 seconds.

M Used to represent one minute, or 60 seconds.

S Reserved but has no effect. The default time unit is seconds.

Chapter 17: Operators' Control Language • 335

Page 336: Eikon 3.02 Microblock Reference

Mathematical Functions

Example

X = -10Y = ABS(X)Z = ABS(5+3)

In this example, OCL assigns Y to 10, because the absolute value of X equals 10. OCL assigns Z to 8, because the absolute value of 5+3 equals 8.

AVG

The AVG function returns the average of a set of values.

Example

XAN = 5BETA = AVG(1,4,XAN,9)

In this example, OCL assigns BETA to:

BETWEEN

This function evaluates the three values in parentheses and determines whether the first value falls between the second and third values. If the first value does fall between the second and third values, the function returns a value of 1.0. If not, the between function returns a value of 0.0.

Example

STAT1 = BETWEEN(17,15,20)BETA = 2STAT2 = BETWEEN(BETA,3,5)

In this example, OCL assigns the value of STAT1 to 1.0, since 17 falls between 15 and 20. OCL assigns the value of STAT2 to 0.0, since BETA (which has a value of 2) is not between 3 and 5.

1 4 XAN 9+ + +( )4

----------------------------------------------1 4 5 9+ + +( )

4------------------------------------ 19

4------ 4.75= = =

336 • Chapter 17: Operators' Control Language

Page 337: Eikon 3.02 Microblock Reference

Mathematical Functions

COS

This function computes the cosine of the value (in degrees) in parentheses.

Example

VAL = COS(45)

In this example, OCL assigns the value of VAL to 0.707.

DELON

This function calculates whether a variable or expression has been on or true for the amount of time specified. The time must be specified as a number, variable, or expression.

Example

STAGE1 = DELON(GAS, 1:00)

This example turns on the variable STAGE1 after the variable GAS has been on for 1 minute.

Example

STAGE2 = DELON(FLOW1 > 125, 5 H)

This example turns on the variable STAGE2 after the value of the variable FLOW1 has been greater than 125 for 5 hours.

LMT

This function limits a value based on the high and low limits specified. This function requires three values: the first value is the value to be limited, the second value is the low limit, and the third value is the high limit. Each of the values can be a number, a variable, or an expression. If the first value falls between the low and high limits, the value is unchanged. If the first value is lower than the low limit, the low limit becomes the function’s value. If the first value is higher than the high limit, the high limit becomes the function’s value.

Chapter 17: Operators' Control Language • 337

Page 338: Eikon 3.02 Microblock Reference

Mathematical Functions

Example

ZETA1 = 3

ZETA2 = LMT(ZETA1, 5, 10)

In this example, ZETA2 = 5, since the value of ZETA1 (which is 3) is less than the low limit of 5.

LN

The LN function calculates the natural logarithm of the indicated value.

Example

Y = LN(134)

In this example, OCL sets Y equal to 4.8978.

LOG

The LOG function calculates the base 10 logarithm of the indicated value.

Example

X = LOG(134)

In this example, OCL sets X equal to 2.1271

MAX

This function determines the larger number from a set of two numbers, variables, constants, or expressions.

338 • Chapter 17: Operators' Control Language

Page 339: Eikon 3.02 Microblock Reference

Mathematical Functions

Example

SIGMA = 7

GAMMA = MAX(SIGMA,10)

In this example, OCL sets GAMMA equal to 10, since 10 is larger than SIGMA (which is set to 7).

MIN

This function determines the smaller number from a set of two numbers, variables, constants, or expressions.

Example

X = 2

RHO = MIN(1+X,4)

In this example, OCL sets RHO equal to 3, since 1+X (when X = 2) is less than 4.

POW

This function calculates the first value raised to the power of the second value.

Example

CHI = POW(TAU,3)

In this example, OCL sets CHI equal to TAU raised to the power of 3 (TAU cubed).

RATIO

This function converts converts a value in a range to a proportionate value in a different range. The first value in parenthesis is the value to be converted. The next two values indicate the current range that the first value belongs in, and the last two numbers indicate the range the value should be converted to.

Chapter 17: Operators' Control Language • 339

Page 340: Eikon 3.02 Microblock Reference

Mathematical Functions

Example

N=40

DELTA = RATIO(N, 0, 100, 3, 13)

In this example, OCL sets DELTA to 7.

RND

The RND function rounds the specified number to the nearest whole number.

Example

KAPPA = RND(3.442)LAMBDA = RND(10.59)

In this example, OCL sets KAPPA equal to 3.0 and LAMBDA equal to 11.0.

SIN

This function calculates the sine of the value (in degrees) in parenthesis.

Example

X = SIN(90)

In this example, OCL sets X equal to 1.0

SQRT

This function calculates the square root of the indicated value.

Example

Y = SQRT(81)

In this example, OCL sets Y equal to 9.

340 • Chapter 17: Operators' Control Language

Page 341: Eikon 3.02 Microblock Reference

Mathematical Functions

START

The START function turns on the variable or variables in parenthesis. You can use as many variables as necessary, separating each variable with a comma.

Example

START(FAN1, PUMP4, STAGE2)

In this example, OCL turns on the variables FAN1, PUMP4, and STAGE2.

STOP

This function turns off all of the variables listed in parenthesis. You can use as many variables as necessary, separating each variable with a comma.

Example

STOP (ALARM, LIGHT2, COMP4)

This example turns off the variables ALARM, LIGHT2, and COMP4.

TAN

This function calculates the tangent of the value (in degrees) indicated in parenthesis.

Example

XI = TAN(71)

In this example, OCL sets the variable XI equal to 2.904.

TOF

This function returns the amount of time in seconds that the variable or expression in parenthesis has been off or false.

Chapter 17: Operators' Control Language • 341

Page 342: Eikon 3.02 Microblock Reference

Programming Structures

Example

X = TOF(CHILLER1)

In this example, OCL sets X equal to the amount of time in seconds that CHILLER1 has been off.

TON

This function returns the amount of time in seconds that the variable or expression in parenthesis has been on or true.

Example

Y = TON(BOILER2)

In this example, OCL sets Y equal to the amount of time in seconds that BOILER2 has been running.

TRN

This function discards the fractional portion of the value in parenthesis.

Example

WEIGHT= TRN((CREQ1 + CREQ2 + CREQ3)/3)

In this example, OCL evaluates the equation in parenthesis and truncates the value. If CREQ1 equals 2, CREQ2 equals 5, and CREQ3 equals 0, the value of WEIGHT is 2.

Programming Structures

OCL supports several programming structures, which are common to many other programming languages.

BEGIN...END

The BEGIN...END structure is used to group together a number of program statements. This structure is often used to group together a

342 • Chapter 17: Operators' Control Language

Page 343: Eikon 3.02 Microblock Reference

Programming Structures

sequence of statement that should be executed when a given condition is met.

Example

IF (OCC) THENBEGIN

START PUMP1START BOILER1RATE = 4 * LMT(FLOW,5,10)

END

In this example, OCL starts PUMP1, starts BOILER1, and calculates RATE whenever OCC is TRUE.

DELAY

This structure halts execution for the amount of time specified. The time may be defined in hours (H), minutes (M), or seconds (the default unit).

Example

DELAY 10H

This example stops the execution of OCL for 10 hours.

EVERY...DO

This structure tells OCL to execute a program statement once every time the specified interval of time passes. The time may be defined in hours (H), minutes (M), or seconds (the default unit). The actual amount of time can be a number or a variable.

Example

EVERY 10 M DO A = B + AVG(C, D + E)

This example calculates the value of the variable A every 10 minutes.

Chapter 17: Operators' Control Language • 343

Page 344: Eikon 3.02 Microblock Reference

Programming Structures

EXITLOOP

The EXITLOOP structure is used to skip the remaining portion of a WHILE...DO loop if the specified condition is met.

Example

WHILE (CONTENT < 90.1) DOBEGIN

IF (TLO = ON) THEN EXITLOOPD = D + 2

END

In this example, OCL continues to calculate the value of the variable D until either the value of CONTENT becomes greater than 90.1 or the variable TLO turns on.

EXITPROG

EXITPROG is used to end the OCL program. You should place all subroutines after the EXITPROG statement to prevent them from being executed inadvertently.

Syntax

EXITPROG

GOSUB...RETURN

The GOSUB structure is used to call a subroutine which is referenced by a label or name. You should place all subroutines after the EXITPROG statement to ensure that they are not executed inadvertently. Once the subroutine is finished, the RETURN statement resumes execution of the OCL program at the point where the subroutine was invoked.

344 • Chapter 17: Operators' Control Language

Page 345: Eikon 3.02 Microblock Reference

Programming Structures

Example

IF X < 23.0 THEN GOSUB TURNONELSE GOSUB TURNOFF

EXITPROG

TURNON:START (LOCK1)START (LOCK2)

RETURN

TURNOFFSTOP (LOCK1)STOP (LOCK2)

RETURN

In this example, OCL begins the TURNON subroutine, which turns LOCK1 and LOCK2 on, if X is less than 23. If X is greater than 23, OCL begins the TURNOFF subroutine, which turns LOCK1 and LOCK2 OFF.

GOTO

The GOTO structure transfers execution of OCL to the designated label. Use of the GOTO structure is not recommended because it creates difficulties in debugging the OCL sequence.

Example

IF (PH >= 6) THEN GOTO ACIDY = GB - X

GOTO LASTACID:

Y = GB + XLAST:

In this example, OCL jumps to the line labeled ACID if PH is greater than or equal to 6. After it reaches line ACID, it sets Y equal to GB + X and proceeds to the line LAST. If PH is less than 6, OCL sets Y equal to GB - X and jumps to the line LAST.

Chapter 17: Operators' Control Language • 345

Page 346: Eikon 3.02 Microblock Reference

Programming Structures

IF...THEN

The IF...THEN structure tells OCL to execute the given program statement if the value of the variable or expression in parenthesis is TRUE.

Example

IF (BOILER9) THEN X = 45

In this example, OCL sets X equal to 45 if BOILER9 is on.

IF...THEN...ELSE

The IF...THEN...ELSE structure works similarly to IF...THEN but adds an alternative statement to be executed if the value of the variable or expression in parenthesis is FALSE.

Example

IF (HUMIDITY > 88) THENDEMAND = 4

ELSEDEMAND = 2

In this example, OCL sets DEMAND equal to 4 if HUMIDITY is greater than 88; otherwise OCL sets DEMAND equal to 2.

IFONCE...THEN

This structure works similarly to the IF...THEN structure but executes the program statement only once after the value of the variable or expression in parenthesis has been determined to be true.

Example

IFONCE(PRESSURE > 178)THEN START (ALARM6)

In this example, OCL starts ALARM6 if PRESSURE becomes greater than 178.

346 • Chapter 17: Operators' Control Language

Page 347: Eikon 3.02 Microblock Reference

Error Messages

Operators

The following operators can be used with If statements:

WHILE...DO

This structure tells OCL to execute a program statement provided that the value of the variable or expression in parenthesis is TRUE.

Example

WHILE (POSITION>150) DOPOSITION = POSITION - 1

Error MessagesASSERT ERROR Did not expect the item encountered.

ASSERT ERROR: EXPECTED 'THEN' THEN required with IF or IFONCE statements.

ASSERT ERROR: EXPECTED ',' Function arguments must be comma delimited.

ASSERT ERROR: EXPECTED 'DO' DO required with WHILE or EVERY statements.

ASSERT ERROR: EXPECTED '=' Expected assignment operator.

ASSERT ERROR: EXPECTED '(' Function arguments are surrounded by parentheses.

ASSERT ERROR: EXPECTED ')' Missing matching parentheses.

CAN'T FIND LABEL Encountered GOSUB or GOTO label statement but was unable to find the label.

CANNOT CHANGE READ-ONLY ITEM Attempting to change a Read-Only variable.

DOUBLY-DEFINED ITEM Attempting to declare the same item twice.

Chapter 17: Operators' Control Language • 347

Page 348: Eikon 3.02 Microblock Reference

Error Messages

ELSE WITHOUT IF Encountered ELSE without a preceding IF.

END WITHOUT BEGIN Encountered END without a preceding BEGIN.

EXITLOOP WITHOUT WHILE Encountered EXITLOOP without a preceding WHILE.

FUNCTION CALL ARGUMENT MISMATCH A call to a function was made with an incorrect number of arguments.

GOSUB WITHOUT RETURN Encountered a GOSUB without a subsequent RETURN.

INVALID CHARACTER ENCOUNTERED IN ITEM NAME The only valid characters are 'A'- 'Z', 'a'-'z', and '_'. Item names must begin with alpha characters.

INVALID CONSTANT The number of digits in a constant exceeded 32 characters.

ITEM RESERVED AS AN OCL KEYWORD Attempting to use an OCL keyword in variable declaration section.

ITEMS MUST BE DEFINED BEFORE USE IN OCL A variable was used before being declared in the variable declaration section.

PROGRAM STACK OVERFLOW Attempting to nest statements too deeply.

RETURN WITHOUT GOSUB Encountered RETURN without a preceding GOSUB.

INVALID PARAMETER DECLARATION A number must follow '=' of the PAR statement in the variable declaration section.

TOO MANY INPUTS DEFINED The combined number of analog/digital inputs exceeded 16.

TOO MANY ITEMS DEFINED The number of items declared in the variable declaration section must not exceed 1000.

TOO MANY OUTPUTS DEFINED The combined number of analog/digital outputs exceeded 16.

348 • Chapter 17: Operators' Control Language

Page 349: Eikon 3.02 Microblock Reference

Error Messages

UNEXPECTED COMMA ENCOUNTERED IN DECLARATIONS Error in declaration syntax.

UNKNOWN OPERATOR An operator was expected, but some other character was encountered instead.

UNKNOWN STATEMENT OCL was unable to understand the statement.

UNKNOWN VARIABLE A variable was referenced in the body of the OCL program which was not first declared in the header portion.

♦ ♦ ♦

Chapter 17: Operators' Control Language • 349

Page 350: Eikon 3.02 Microblock Reference

Error Messages

350 • Chapter 17: Operators' Control Language

Page 351: Eikon 3.02 Microblock Reference

18 Appendix A

Non-Graphic FB Commands

The commands listed in this appendix section were originally used to pass information between non-graphic FBs. While these commands may still be used for this purpose, they may also be used to send global commands from GFBs to non-graphic FBs using LAN Output microblocks (discussed in the I/O Microblocks chapter).

A non-graphic FB can receive commands from up to four different LAN Outputs. In order to receive these commands, the non-graphic FB must have the correct address of the transmitting LAN Output in the Command From parameter on the parameter page. Four entries are available in the Command From parameter for this purpose.

The global commands are presented in the following format:

Command # - Command Name (Command Type)

Broadcast By:

Received By:

Explanation:

Additional commands are available that do not require a command number or Command From address. These commands are listed at the end of this appendix.

0 - Normal (Digital)

Broadcast By: Any FB listed in "Broadcast By" of this appendix.

Received By: Any FB listed in "Received By" of this appendix.

Chapter 18: Appendix A • 351

Page 352: Eikon 3.02 Microblock Reference

Non-Graphic FB Commands

Explanation: Returns a receiving FB to normal operation.

1 - Shutdown (Digital)

Broadcast By: AI1, ALB, DI2, DLB, PTR, SL2, SL4, SLB, TC1, ULB, WSP

Received By: AH1-AH8, AHB, AHC, AHF, AHM, AHN, AHT, AHU, ALB, AM1, AMB, AMB, AMR, ASI, AVG, AW1, AW2, AZ1, BC1, BM2, CH1-CH5, CL2, CL3, CLH, CM1-CM6, CMB, CMF, CMN, CMT, CO1-CO3, COV, CPG, CPL, CPM, CPP, CSM, CT1, CT2, DI3, DLB, DO2-DO4, DOA, DOL, DOS, EC1, EC2, ECO, ET2, ET3, ETI, ETR, FCT, FM1, FM2, FTC, FTR, GIR, HL2, HLR, HP1, HP2, LC2, LM1, MCM, MTS, MV1, ORC, OSI, PC1, PM1, PM2, PMN, PT2-PT5, PTR, SC1, SC2, SC4, SLB, SS1-SS5, TC1, TC2, TCR, TOI, TPC, TPF, TS1, ULB, VV1, VVR, WBC, WH1, WSPZC1, ZC2, ZF1-ZF3, ZH1, ZP1, ZS1, ZV1

Explanation: Forces FB to an unoccupied or inactive state and forces all outputs off or to an inactive state.

2 - Changeover (Digital)

Broadcast By: ALB, DLB, MC1, MCM, SLZ, SL4, SLB, TPC, ULB, WSM

Received By: AH7, AHM, AHN, AHU, BM2, CL1-CL3, CM2, CM5, CO1-CO3, COV, SL2, SL4, SLB, SS1,TC1, TCR, TPF, VVR, ZP1, ZS1

Explanation: Sends a digital command to switch to Changeover mode. This mode is opposite of the "Normal" mode parameter defined in each receiving FB's parameter page (heating or cooling).

3 - TLO (Analog)

Broadcast By: SL2, SL4, SLB, TL8, TLC, TLO

Received By: AHB, AHC, AI1-AI4, ALB, ASI, BTU, CMB, CMF, CPP, DI1, DI4, DLB, DOA, DOS, EM6-EM8, ET2, ET3, ETI, ETR, FTR, GIR, HP1, HP2, LC1, LC2, LM1, MCM, NP1, OSI, PA1, PSV, PT2-PT5, PTR,

352 • Chapter 18: Appendix A

Page 353: Eikon 3.02 Microblock Reference

Non-Graphic FB Commands

SL2, SL4, SLB, SM1, TC1, TC2, TCR, TL8, TLC, TLO, TOI, TPF, TS1, ULB, VV1, VVR, WH1, WSP, ZC1, ZC2, ZF1-ZF3, ZH1, ZP1, ZS1, ZV1

Explanation: Sends an override command. Any FBs capable of listening to this command will go into occupied mode.

4 - Compressor Shutdown (Digital)

Broadcast By: ALB, DI2, DLB, SL2, SL4, SLB, ULB, WSM, WSP

Received By: HP1, HP2, SL2, SL4, SLB, ZC2, ZH1, ZP1, ZS1, ZV1

Explanation: Sends the command to shutdown compressor outputs. All other outputs will function formally, and the FB will remain in its current state of occupancy.

5 - Chilled Water Temp. Setpoint (Analog)

Broadcast By: ALB, BM2, CM2, CM3, CM4, CM5, CM6, CMB, CMT, CPG, CPL, CPM, SL2, SL4, SLB, TS1, ULB

Received By: ALB, CH1-CH5, DLB, HL2, HLL, HLR, SL2, SL4, SLB, SS1, SS5, ULB

Explanation: Sends the command to adjust the chilled water temperature setpoint. Normally used to adjust the chillers' and boilers' FB temperature setpoints to be the same as that at the Chiller Manager or Boiler Manager FB.

6 - Soft Shutdown (Digital)

Broadcast By: ALB, DI2, DLB, SL2, SL4, SLB, ULB, WSM, WSP

Received By: AH3, AHM, AHU, ALB, CH5, CL3, DLB, DO3, DO4, DOA, DOL, DOS, ET3, ETR, HP1, HP2, LC2, SL2, SL4, SLB, TPF, ULB, VVR, ZF1-ZF3, ZH1, ZP1, ZS1, ZV1

Explanation: Sends the command to shut off all digital outputs, but otherwise run as normal.

Chapter 18: Appendix A • 353

Page 354: Eikon 3.02 Microblock Reference

Non-Graphic FB Commands

7 - Modify Setpoint: -Cool (Analog)

Broadcast By: NP1, SL2, SL4, SLB, SM1

Received By: AI1-AI3, ET2, ET3, ETI, ETR, FTR, GIR, HP1, HP2, PT2-PT5, PTR, SL2, SL4, SLB, SM1, TC1, TC2, TCR, TPR, VV1, VVR, WH1, WSP, ZC1, ZC2, ZF1-ZF3, ZH1, ZP1, ZS1, ZV1

Explanation: Sends the command to decrease the cooling setpoint of a zone.

8 - Modify Setpoint: +Heat (Analog)

Broadcast By: NP1, SL2, SL4, SLB, SM1

Received By: AI1-AI3, ET2, ET3, ETI, ETR, FTR, GIR, HP1, HP2, PT2-PT5, PTR, SL2, SL4, SLB, SM1, TC1, TC2, TCR, TPR, VV1, VVR, WH1, WSP, ZC1, ZC2, ZF1-ZF3, ZH1, ZP1, ZS1, ZV1

Explanation: Sends the command to increase the heating setpoint of a zone.

9 - Modify Setpoint: +Heat, -Cool (Analog)

Broadcast By: NP1, SL2, SL4, SLB, SM1

Received By: AI1-AI3, ET2, ET3, ETI, ETR, FTR, GIR, HP1, HP2, PT2-PT5, PTR, SL2, SL4, SLB, SM1, TC1, TC2, TCR, TPR, VV1, VVR, WH1, WSP, ZC1, ZC2, ZF1-ZF3, ZH1, ZP1, ZS1, ZV1

Explanation: Sends the command to decrease the cooling setpoint and increase the heating setpoint of a zone.

10 - Modify Setpoint: -Heat, +Cool (Analog)

Broadcast By: NP1, SL2, SL4, SLB, SM1

354 • Chapter 18: Appendix A

Page 355: Eikon 3.02 Microblock Reference

Non-Graphic FB Commands

Received By: AI1-AI3, ET2, ET3, ETI, ETR, FTR, GIR, HP1, HP2, PT2-PT5, PTR, SL2, SL4, SLB, SM1, TC1, TC2, TCR, TPR, VV1, VVR, WH1, WSP, ZC1, ZC2, ZF1-ZF3, ZH1, ZP1, ZS1, ZV1

Explanation: Sends the command to decrease the heating setpoint and increase the cooling setpoint of a zone.

11 - Global Variables (Analog/Digital)

Broadcast By: GV1, SL2, SL4, SLB

Received By: 88H, AH1-AH8, AHB, AHC, AHF, AHM, AHN, AHT, AHU, AI1-AI4, ALB, AM1, AMB, AMG, AMR, ASI, AVG, AW1, AW2, AZ1, BC1, BM2, BTU, CH1-CH5, CL1-CL3, CLH, CM1-CM6, CMB, CMF, CMN, CMT, CO1-CO3, COV, CP1, CP2, CPG, CPL, CPM, CPP, CSM, CT1, CT2, DI1-DI5, DLB, DO2-DO5, DOA, DOL, DOS, EC1, EC2, ECO, EM1-EM8, CM., ET2, ET3, ETR, TCT, FM1, FM2, FTC, FTR, GIR, GM1, GV1, HL2, HLL, HLR, HP1, HP2, LC1, LC2, LM1, MC1, MCM, MTS, MV1, NP1, OA1, OA2, OA4, OA5, OAN, ORC, OSI, OTO, OT1-OT3, OT5, PA1, PAC, PC1, PCT, PM1, PM2, PMN, PSB, PSC, PSR, PST, PSV, PT2-PT5, PTR, SC1, SL2, SL4, SLB, SM1, SS1-SS5, TC1, TC2, TCR, TL8, TLC, TLO, TOI, TPC, TPF, TS1, ULB, VV1, VVR, WBC, WH1, WM1, WSM, WSP

Explanation: Sends an analog or digital value as a global broadcast to a non-graphic FB.

NOTE Command 11 requires that the input in the non-graphic FB that receives the broadcast must have the correct global channel number listed. The following channel numbers are used for receiving global broadcasts: A1, A2, A3, A4 (for analog broadcasts) and B1, B2, B3, B4 (for digital broadcasts). These channel numbers correspond to the addresses in the Command From parameter. For example, an analog input with a channel number of A3 would listen to broadcasts received from the address listed in the third entry in the Command From parameter. Note that it is not possible to use the same number for digital and analog channels (for example, both A3 and B3) in the same FB.

Chapter 18: Appendix A • 355

Page 356: Eikon 3.02 Microblock Reference

Non-Graphic FB Commands

12 - Economizer Mode (Digital)

Broadcast By: CPL, SL2, SL4, SLB

Received By: CPL, CT1, CT2, SL2, SL4, SLB

Explanation: This allows the above FBs to operate using setpoints appropriate for waterside Economizer operation.

13 - Pressurization Mode (Digital)

Broadcast By: DI2, SL2, SL4, SLB

Received By: ZP1, ZS1

Explanation: Used to force VAV FBs to a predetermined setpoint based on a global building condition.

14 - Telephone Override (Digital)

Broadcast By: SL2, SL4, SLB, TOI

Received By: SL2, SL4, SLB, TLO

Explanation: Used to concentrate more than 1 TLO broadcast going to a single zone into a single TLO broadcast.

15 - Optimal Start Inhibitor (Digital)

Broadcast By: OSI, SL2, SL4, SLB

Received By: AI1-AI3, ASI, ET2, ET3, ETI, ETR, FTR, GIR, HP1, HP2, PT2-PT5, HPR, SL2, SL4, SLB, SM1, TC1, TC2, TCR, TPF, VV1, VVR, WH1, WSPZC1, ZC2, ZF1-ZF3, ZH1, ZP1, ZS1, ZV1

Explanation: Used to inhibit optimal start role on the above FBs.

356 • Chapter 18: Appendix A

Page 357: Eikon 3.02 Microblock Reference

Non-Graphic FB Commands

16 - Relative Schedule Time Remaining (Analog)

Broadcast By: RTS

Received By: All Exec. 3.x FBs.

Explanation: Used to broadcast the number of minutes until the next scheduled transition time (occupied or unoccupied).

99 - Momentary Pulse 'heartbeat' (Digital)

Broadcast By: RTS (or any graphic FB with a LAN DO)

Received By: All Exec. 3.x FBs (or any graphic FB with a LAN DI).

Explanation: Used to revalidate a broadcast (or LAN DO) in the receiving FB. When an on broadcast is sent, the receiving FB sees a momentary on then off signal. This can be used to trigger FB logic to indicate a failed or separated module. It can also be used to revalidate a relative schedule time broadcast in receiving FBs. If the receiving FB does not receive this broadcast, the relative schedule will default to the downloaded schedule.

Additional Commands

The following broadcasts can be received by any Exec 3.x FB as long as the appropriate channel number is entered for the receiving input. No address is required in the Command From parameter.

♦ ♦ ♦

Table 18-1. Exec 3.x Broadcasts

Broadcast Channel Number

Outside Air Humidity FD

Outside Air Enthalpy FE

Dry Bulb Temperature FF

Chapter 18: Appendix A • 357

Page 358: Eikon 3.02 Microblock Reference

Non-Graphic FB Commands

358 • Chapter 18: Appendix A

Page 359: Eikon 3.02 Microblock Reference

19 Glossary

ADAPTIVE OPTIMAL START A method used by certain Zone Setpoint microblocks to regulate setpoints so that the ideal temperature range can be achieved when building occupancy begins. The Adaptive Optimal Start routine adjusts setpoints at a constant rate based on the heating or cooling capacity of the equipment and the amount of time remaining prior to occupancy. See also Learning Adaptive Optimal Start.

ADDRESS A series of four numbers that indicate the location of a Function Block in a system. The address is composed of the site number, gateway number, module number, and Function Block number. For example, a Function Block with an address of 1,2,7,3 is the third Function Block in module number seven, which is connected to the second gateway in site number one.

ALERT A comprehensive event management software package. Alert is designed for maximum event handling flexibility, including several event notification options and reporting actions.

CELL A temporary storage location used to simulate the transmission of data between Function Blocks in Eikon’s simulation mode.

CHANNEL NUMBER A two-digit number that tells a Function Block where to locate an input or output point on a control module. The channel number represents the physical input or output channel on a module and can be configured on the Parameter page or on the microblock dialog.

CMNET A peer-to-peer local area network which allows up to 99 control modules to communicate with one another with equal authority.

Chapter 19: Glossary • 359

Page 360: Eikon 3.02 Microblock Reference

CONTROL MODULE A microprocessor-based hardware product designed for stand-alone direct digital control of HVAC equipment. Many types are available in a variety of input/output configurations. Control modules are wired together to form a local area network called a CMnet.

DUTY CYCLE A period of time during which equipment is alternately on and off.

EIKON A Windows-based application which provides the ability to graphically program, display, and interact with any HVAC sequence of operation. It features microblocks (representing common control devices and complex energy management functions) interconnected on the screen by graphical wires to form logical connections.

EXEC See Firmware.

EXPANDER MODULE A module which is added to an existing module in order to expand the number of I/O points. One or more expander modules connected to a base module is called a “stack”. Each expander has a unique address in the stack which is called the expander number.

EXPANDER NUMBER A number that tells a Function Block which expander module contains an input or output point. Expander numbers are assigned to points using either the point microblock’s dialog or the Parameter page.

FIRMWARE The software program that resides in a control module’s Programmable Read-Only Memory (PROM). The firmware, or Exec, controls the processing of the Function Blocks in the module.

FUNCTION BLOCK (FB) A software program designed specifically for controlling HVAC equipment. A Function Block (FB) consists of small program blocks (called microblocks) that can be linked together to create logical control sequences. Operating parameters for the Function Block can be assigned by the operator or by the Function Block’s designer and can be changed in SuperVision on the Parameter page. The current status of these parameters can be

360 • Chapter 19: Glossary

Page 361: Eikon 3.02 Microblock Reference

viewed on SuperVision’s Status page. See also Graphic Function Block.

GAIN A parameter which a Function Block multiplies with an analog I/O value in order to convert the signal into desired units (for example, converting mA to degrees Fahrenheit). Gain is used with the Offset parameter to calibrate a point.

GLOBAL COMMAND A number that describes the type of LAN broadcast sent between Function Blocks which may or may not be located on the same CMnet.

GLOBAL POINT LAN Input and Output microblocks are sometimes referred to as global points, since they can transmit and receive information between CMnets residing on the same LGnet.

GLOBAL VARIABLE A value (such as outside air temperature or electrical demand level) that is broadcast by a LAN Output microblock. Global variables are available to Function Blocks on different CMnets that share the same LGnet.

GRAPHIC FUNCTION BLOCK (GFB) A Graphic Function Block (GFB) is a term used to describe the graphic representation of a Function Block program. This representation is created in Eikon and can be viewed in SuperVision using the Live GFB feature.

LABEL A method of connecting microblocks to each other in a Graphic Function Block. Labels are used to carry analog or digital values between microblocks when a wire cannot be drawn or is not appropriate. See also Wire.

LEARNING ADAPTIVE OPTIMAL START A method used by certain Zone Setpoint microblocks to regulate setpoints so that the ideal temperature range can be achieved when building occupancy begins. The Learning Adaptive Optimal Start routine adjusts setpoints based on the heating or cooling capacity of the equipment, which is adjusted (or learned) over time as the equipment meets or fails to meet the ideal temperature range. See also Adaptive Optimal Start.

Chapter 19: Glossary • 361

Page 362: Eikon 3.02 Microblock Reference

LGNET A peer-to-peer global network that allows Function Blocks on different CMnets to communicate with equal authority. Each CMnet communicates with the LGnet through a gateway (like a LANgate or LGRM-E). LAN Input and Output microblocks can be used to broadcast information between Function Blocks residing in different CMnets that share the same LGnet.

MBCODE A code assigned to each microblock in a Function Block. MbCodes can be changed by the Function Block’s designer if the microblock has its own dialog box.

MICROBLOCK An individual block of programming code that has a specific purpose and is represented by a graphic symbol. Microblocks are combined in Eikon with wires and labels to create Function Blocks. Custom microblocks can be created using Operator’s Control Language (OCL).

NIB A small pin on the side of a microblock. Wires and labels must connect with a microblock’s nib in order for the Graphic Function Block to compile.

OFFSET A parameter which a Function Block adds to an analog I/O value in order to shift its range to match a standard range (for example, 4-20mA, 3-15psi, or 0-10V). Offset is used with the Gain parameter to calibrate a point.

PARAMETER PAGE The Parameter page is a display in SuperVision where a Function Block’s operating parameters can be viewed or changed. The Parameter page is composed of the settings for each microblock in the Function Block. The Function Block’s programmer can control the content and appearance of the Parameter page using special editing features in Eikon.

PARAMETER PAGE HEADER The Parameter page header is the topmost portion of the Parameter page. The header includes general information about the function block such as its name, ID, system address, and update time. In Exec 3.x modules, the header is also used to configure and enable trends, alarms, and messages.

362 • Chapter 19: Glossary

Page 363: Eikon 3.02 Microblock Reference

REQUEST Requests are the method by which FBs communicate their heating and cooling needs to each other. By using requests you can construct a software "chain" mimicking the mechanical chain of equipment in the building. When properly constructed, requests allow you to schedule terminal or zone equipment only, and allow other equipment to respond to the zone requests. Requests are communicated using Transmit and Receive microblocks, which are located in the SysIn and SysOut microblock libraries.

RUNTIME The amount of time a piece of equipment has been running.

SETPOINT A temperature value that is maintained by the HVAC equipment. Separate setpoints are determined for heating and cooling.

STATUS PAGE The Status page is a display in SuperVision where the current status of a Function Block’s operating parameters can be viewed. The Function Block’s programmer can control the content and appearance of the Status page using special editing features in Eikon.

SUPERVISION A full-featured software package designed as a graphical HVAC system interface featuring high resolution, dynamic color graphics.

SYMBOL A group of graphic objects (such as microblocks and wires) that are stored together in a separate file. Symbol files use the extension .sym, and can be created using Eikon’s Edit-Copy To menu command. Symbols can be used to store graphic programming sequences that are used in more than one Function Block, like a sequence that controls a fan’s operation.

SYSTEM An entire grouping of control modules that share the same CMnet or LGnet. Systems can be divided into sites. Function Blocks can only communicate with other Function Blocks that are located in the same system.

TOKEN PASS The method used by control modules to communicate with one another on the CMnet. The gateway transmits a signal, or "token" to the first control module on the CMnet, which in turn transmits the token to the next module, and so on back to the

Chapter 19: Glossary • 363

Page 364: Eikon 3.02 Microblock Reference

gateway, which begins the token pass again. When a module receives the token, it transmits data such as colors, prime variables, LAN broadcasts, and requests to other modules on the CMnet.

UPDATE TIME The frequency at which a Function Block transmits important information to the gateway module. When the update time expires and the Function Block’s module has the token, the Function Block transmits the following information to the gateway: color, prime variable, and broadcasts from LAN Input and Output microblocks. In addition, Function Block’s that can receive heating, cooling, or run requests ask for those requests when the update time expires (and the module containing the Function Block has the token).

WIRE A special line drawn in Eikon to transmit values from one microblock to another. Analog data is transferred along solid wires, and digital data is transferred along dashed wires. Wires can be connected to microblocks, labels, or other wires. When a wire cannot be drawn or should not be used, a label serves the same purpose. See also Label.

♦ ♦ ♦

364 • Chapter 19: Glossary

Page 365: Eikon 3.02 Microblock Reference

20 Index

A

absolute value 302actuator 87adaptive optimal start 185, 359

preventing 202, 217add

constant to variable 295four variables 300three variables 300two variables 300

address 94, 113, 359demand controller address 125trend address 158, 160

airflow calibration 103airflow control 99alarm

alarm flag 162ALC Draw 145Alert 359Alert event 170

enabling 170testing 172

analogconstant 131convert from digital 255convert to digital 254input 69output 83parameter 127status 148trend 160wire lock 287

and2 input 2903 input 2904 input 2905 input 291

average 301

B

BACnet 41analog input 42analog output 48analog parameter 56analog status 60binary input 45binary output 51binary parameter 54binary status 58microblock menu 41

BACnet communication lost 123bias 235, 239binary

constant 130parameter 126status 147

C

capacity 191adjusting learned capacities 218cooling capacity 185heating capacity 185learned capacity 188, 204

cell 359

Chapter 20: Index • 365

Page 366: Eikon 3.02 Microblock Reference

centrifugal chiller 117change sign 302channel number 359characters

in OCL 335cmnet 78, 94, 113, 359coil 150cold deck 119color 183

set color 222set color if true 223true if color 224

comm lost 123communication

validity of 123condensation pump 113, 135constant

binary constant 130duty cycle 271greater than 249high limit 263high signal selector 258less than 250low limit 262low signal selector 259time constant 132true if equal to 248

control module 360expander module 360T-Line 76

convert menu 229cooling capacity 185cosine 304counter 312custom microblock 327

D

damper 87, 150day 121daylight savings time 313debounce time 310

dehumidification 246delay

feedback delay 310on break 275on make 274

design temperature 191dewpoint temperature calculator 246d-gain 235, 239digital

convert from analog 254convert to analog 255input 71input proof 310output 85output proof 310trend 158wire lock 286

dividetwo variables 301variable by constant 298

DO/DI proof 310Draw 145dry bulb temperature 244, 246–247duty cycle 125, 360

constant 271variable 273

E

economizer 244electric meter 125electrical demand level 125, 146

adjusting setpoints based on 194, 198, 208

demand broadcast 146demand controller address 125instantaneous demand 76receive demand level 125with adaptive optimal start 185

enthalpy 121, 150enthalpy calculator 244

366 • Chapter 20: Index

Page 367: Eikon 3.02 Microblock Reference

enumerated valueanalog parameter 127analog status 148

error messagein OCL 347

evaporative cooling 247exclusive or 292Exec 360

Exec 3.x 15Exec 4.x 15Exec 5.x 15, 41

expander module 360expander number 360exponent 305

F

feedback delay 310firmware 150, 360floating motor output 87for zone controller 231free cooling 192function block 360

G

gain 361PID gain 234

gateway 145get system status 123get system variable 121global command 93, 96, 351, 361global point 361global variable 78, 361graphic function block 361greater than

constant 249variable 252

H

heating capacity 185high limit

constant 263variable 265

high peak recorder 176high signal

constant 258variable 260

history recorder 175hot deck 119hot wax valve 90hour 121humidity 121, 150, 244, 246–247hysteresis 249–250, 252

setpoint 192

I

I/O menu 67i-gain 235, 239input

analog input 69BACnet analog input 42BACnet binary 45digital input 71LAN analog input 78, 94LAN digital 81LAN digital input 97

instantaneous demand 76integrator 306interval

PID 236, 240

L

label 361LAN analog input 78, 94LAN analog output 79, 93LAN digital input 81, 97LAN digital output 82, 96

Chapter 20: Index • 367

Page 368: Eikon 3.02 Microblock Reference

latch 278learning adaptive optimal start 187, 361less than

constant 250variable 253

lgnet 78, 94, 113, 362limit menu 257linear converter

constant ratio 242variable ratio 243

locked point 162, 171locked value

analog wire lock 287digital wire lock 286

logarithm 305natural log 304

logic menu 289LogiStat zone sensor 107

setpoint adjust 108timed local override 108

low limitconstant 262variable 264

low peak recorder 178low signal

constant 259variable 261

M

math1 menu 293math2 menu 303mathematical function 293, 303

in OCL 335maximum on timer 276mbcode 362menu

I/O 67message

message flag 164runtime expired message 166

microblock 362

minimum on/off timer 277minute 121misc menu 309modulo 301modulo divide by constant 299month 121multiply

two variables 301variable by constant 297

multi-text 316multi-zone air handling unit 119

N

natural log 304nib 362night setback 198, 213non-graphic FB 93, 96

commands 351not 292

O

occupancy 226–227adaptive optimal start 185

offset 362operators’ control language 327optimal start 183, 185or

2 input 2913 input 2914 input 2915 input 292exclusive 292

outputanalog output 83BACnet analog 48BACnet binary 51digital output 85floating motor 87LAN analog output 79, 93LAN digital output 82, 96

368 • Chapter 20: Index

Page 369: Eikon 3.02 Microblock Reference

outside airbroadcast 121broadcast validity 123enthalpy 121, 150humidity 121, 150temperature 121, 150temperature history 176, 178

override. See timed local override

P

parameteranalog 127BACnet analog 56BACnet binary 54binary 126time 129

parameter page 362header 362

p-gain 234, 238PID

direct acting 234reverse acting 238

predefined symbols 333prime variable 145programming structure

in OCL 342proof 310pulse to analog 75pulse width transducer 90pulse-width output 90

R

ramp 266ratio

constant 242variable 243

relay menu 269remainder 299, 301request 111, 363

receive cool 117

receive heat 115receive heat and cool 119receive run 113setpoint based on 220transmit cool 139transmit heat 137transmit multiple cool 143transmit multiple heat 141transmit run 135

round up/down 307runtime 363

accumulated 166, 168lead/standby based on 280on digital output 85runtime accumulation

microblock 180runtime expired message 165–166runtime monitor 168

S

schedulescheduler microblock 226scheduler with override

microblock 227set alarm number 162set color 222set color if true 223set message number 164set runtime exceeded flag 166setpoint 363

adaptive optimal start 185adjusting remotely 198, 213based on requests 220hysteresis 192preventing adjustment 202

setpoint optimization 111, 220sign

changing a number’s sign 302sine 304special characters

in OCL 335

Chapter 20: Index • 369

Page 370: Eikon 3.02 Microblock Reference

square root 305status

analog 148BACnet analog 60BACnet binary 58binary 147report 165system status 123time 149

status page 363steam boiler 113, 135steam heat exchanger 115subtract

constant from variable 296two variables 300

sunrise/sunset 313SuperVision 363

schedules 226–227switch

between two variables 285normally closed to constant 284normally closed to variable 283

symbol 363in OCL 333

sysalarm.txt 162, 164system 363system variable 121

in OCL 334

T

tangent 304text 315

multi-text 316tilde 15time 121

constant 132debounce time 310of alarm generation 172parameter 129status 149

timed local override 73learned capacities and 189scheduler with override

microblock 227timer

maximum on 276minimum on/off 277

title 329T-Line 76toggle 279token 363

token pass 363trend

analog 160digital 158report 165

trim and respond 220true if < constant 250true if < variable 253true if = constant 248true if = variable 251true if > constant 249true if > variable 252true if color 224truncate 307

U

underscore 15up/down counter 312update time 113, 364

V

variableduty cycle 273greater than 252high limit 265high signal 260less than 253low limit 264low signal 261

370 • Chapter 20: Index

Page 371: Eikon 3.02 Microblock Reference

system variable 121true if equal to 251

variable declaration 329version 318

W

wet bulb temperature calculator 247wire 364

X

xor 292xxxalarm.txt 162, 164

Y

year 121

Z

zone controller 231zone setpoint 190zone setpoint - plus 198zone setpoint - plus with learning adaptive

optimal start 213zone setpoint with demand 194zone setpoint with demand and learning

adaptive optimal start 208zone setpoint with learning adaptive

optimal start 204

Chapter 20: Index • 371

Page 372: Eikon 3.02 Microblock Reference

372 • Chapter 20: Index