EIKON LogicBuilder v5 User Manual

EIKON LogicBuilder v5
User Manual
Rev. 4/12/2011
Verify that you have the most current version of this document. Go to http://accounts.automatedlogic.com, then select Support > Download > Documents > Manuals.
Contents
Chapter 1 What's new in EIKON LogicBuilder v5 .......................................................................... 3 Chapter 2 What is EIKON LogicBuilder?...................................................................................... 5 Chapter 3 Getting to know EIKON LogicBuilder............................................................................ 7 Chapter 4 Determining the control program type ......................................................................... 9 Normal for all controllers except U line or ZN line ........................................................... 9 UNI for U line controllers ............................................................................................. 10 ZN for ZN line controllers ............................................................................................ 11 Chapter 5 Developing the logic ................................................................................................ 13 To begin a control program ......................................................................................... 13 To place microblocks .................................................................................................. 14 To draw wires and labels ............................................................................................. 15 To view errors ............................................................................................................. 16 To add comments ....................................................................................................... 16 To add lines and rectangles ........................................................................................ 17 To add an image ......................................................................................................... 19 To create a custom microblock.................................................................................... 19 To select properties for ViewBuilder graphics............................................................... 20 To omit _# at the end of BACnet object names ............................................................ 20 Chapter 6 Formatting Properties pages .................................................................................... 21 To reorder items on the Properties page ...................................................................... 22 To use the Text microblock to format text ..................................................................... 22 Editing Properties page text using special characters .................................................. 24 Formatting a microblock property ............................................................................... 25 Chapter 7 Simulating a control program ................................................................................... 31 Chapter 8 EIKON LogicBuilder productivity tools ....................................................................... 33 To create and use symbols .......................................................................................... 33 To use EquipmentBuilder ............................................................................................ 34 To view or edit microblock common properties ............................................................ 35 To find a microblock or label ....................................................................................... 36 To find identical labels................................................................................................ 36 To show a logical path ................................................................................................ 36 To show a wire's source microblock ............................................................................ 36 Chapter 9 To use custom alarm and schedule categories ........................................................... 37 Chapter 10 Miscellaneous EIKON LogicBuilder menu commands ............................................... 39 Chapter 11 Working with control programs created in EIKON for WebCTRL ................................... 41 Index ..................................................................................................................................... 43
2011 Automated Logic Corporation. All rights reserved throughout the world. Automated Logic Corporation, the Automated Logic logo, WebCTRL, EIKON, BACview, SuperVision, and InterOp are registered trademarks, and Alert is a trademark of Automated Logic Corporation. BACnet is a registered trademark of ASHRAE. All other brand and product names are trademarked by their respective companies.
EIKON LogicBuilder v5 User Manual
Chapter 1
What's new in EIKON LogicBuilder v5
Feature Microblock Common Properties Editor (see page 35) ZN microblock rules (see page 11)
Improvement You can view or edit common properties for the I/O, Network, Display, and BACnet microblocks in a control program. A ZN control program can now have: A maximum of 350 microblocks (previously 200) Up to 2 PID microblocks in addition to the zone controller microblock (previously 1 PID)
Integrator microblock is non-volatile "Always upload" feature in BACnet Analog Value Parameter microblock
The integrator microblock now retains its output magnitude through a power loss, controller reset, or controller restart. Using a combination of logic that writes critical parameters within a control program to a BACnet Analog Value Parameter microblock and a new property of the BACnet Analog Value Parameter microblock, you can retain critical values through a power loss, through a controller restart, and (if the reference name of the microblock is unchanged) through a memory download. This new microblock provides improved PID algorithm and BACnet accessibility. These 2 new microblocks support up to 20 states.
BACnet PID microblock 20-state BACnet Multi-state Value Parameter and 20-state BACnet Multi-state Value Status microblocks OCL microblock system variable for weekday
To be consistent with the System Variable microblock, the weekday system variable has changed to WKDAY, where Monday = 1 to Sunday = 7. The previous weekday system variable, WDAY, will continue to work in existing control programs using Sunday = 1 to Saturday = 7. Use an * in a Network Input or Total Analog microblock's address to have the microblock automatically locate the nearest device that contains the object specified in the address. This feature eliminates the need for specific device addresses when retrieving values from common objects. For example, control programs on a campus that need oa_temp can automatically retrieve the value from the nearest device that contains that object name.
Wildcard (*) instead of Device ID in BACnet addresses
2011 Automated Logic Corporation
Feature Edit > Third Party BACnet Addresses (see page 39) Device Alias microblock and Device Alias field in Display microblocks Mark certain properties as Read-only Remove all Property Page Text (page 39) Keep historical trends for ___days Use unitary naming (see page 20) Immediate Triggered Write
Improvement You can edit the addresses that you created with the Third-Party BACnet Utility. Or, you can convert a control program into an integration program by changing I/O microblocks to Network or Display microblocks and setting the microblock addresses. These allow the use of Network I/O and Display microblocks in the same program, and efficient re-use of programs for multiple instances of third-party equipment. You can right-click some properties in EIKON LogicBuilder and select Make Editable or Make Read-Only to determine that property's functionality in WebCTRL. You can use this Tools menu add-on to remove property page text for all microblocks in a control program. You can now define this setting in EIKON LogicBuilder for I/O and Log microblocks. Previously, this was only in WebCTRL. You can set your control program to use unitary naming to omit __# at the end of BACnet object names. The Immediate Triggered Write property was removed from ANO2 and BNO2 microblocks. These microblocks automatically write their value as soon as they are enabled.
Chapter 2
What is EIKON LogicBuilder?
EIKON LogicBuilder creates control programs to control equipment, from single pieces of equipment to complex energy management functions. You build control programs using individual blocks of programming code called microblocks. You determine the properties for each microblock and connect the microblocks with graphical wires to create a sequence of operation. A control program is assigned to a piece of equipment in SiteBuilder, then WebCTRL downloads it into the controller that will directly control and monitor the equipment. You can change editable properties and view non-editable properties of control programs through WebCTRL.
The typical procedure for creating a control program includes the following steps: 1 2 3 4 Determine the control program type (see page 9). Develop the logic (see page 13). Format Properties pages (see page 21). Simulate the control program (see page 31).
Or, you can use EquipmentBuilder (see page 34) to generate a control program and, optionally, the corresponding equipment graphic.
Chapter 3
Getting to know EIKON LogicBuilder
TIPS If the Property Editor is not visible, double-click an object in the workspace. You can use the Property Editor as a free-standing window, or you can select Options > Dock Property Editor to dock it in the EIKON LogicBuilder window. Keyboard shortcuts are shown beside their corresponding commands in the menus. Press Ctrl + an arrow key to nudge selected objects. Press Shift+Ctrl while using the arrow keys to increase the size of the nudge. Click to undo 1 action, or click the drop-down arrow next to it to undo multiple actions at one or its drop-down arrow to redo actions. The number of actions you can undo or redo time. Click depends on the size of your computer's memory. The workspace size has no limit. Press Home to position the upper left corner of the workspace in the upper left corner of the window. Press End to jump to the bottom of the control program. Use the arrow keys or your mouse's scroll wheel to scroll through the workspace. From the Options menu you can:

Hide or show the workspace grid Enable Snap Figures and Text to Grid to constrain movement to 8 pixels for quick alignment; disable this feature for 1-pixel movement Select metric units of measurement for setpoint microblocks Zoom the view to 50, 100, or 200%
Chapter 4
Determining the control program type
Before you create a control program, first determine the control program type (Normal, UNI, or ZN), and then follow the appropriate rules below.
Normal for all controllers except U line or ZN line

Make sure a control program broadcasts a single color by using one of the following:

1 Setpoint microblock 1 Set Color microblock 1 or more Set Color If True microblocks
Each Time Clock microblock in a control program must have a unique schedule category. To use an RS sensor, the control program must have an RS Zone Sensor microblock. To use a basic LogiStat or LogiStat Plus sensor with an SE line controller, the control program must have a LogiStat Zone Sensor microblock or an RS Zone Sensor microblock.
UNI for U line controllers

Required microblocks BACnet Time Clock Setpoint with a direct input named ZONE TEMP from one of the following microblocks: BACnet Analog Input LogiStat Zone Sensor (ExecB) Microblocks not supported Pulse to Analog Setpoint Optimization Set Color or Set Color if True Dewpoint Temp Calculator Wet Bulb Temp Calculator Toggle Lead/Standby Integrator RS Zone Sensor RS Zone Sensor with Fan Control
NOTES Each Time Clock microblock in a control program must have a unique schedule category. The setpoint microblock's cooling setpoint must be wired to a PID Direct Acting microblock. The setpoint microblock's heating setpoint must be wired to a PID Reverse Acting microblock. Set time delay functions and trend intervals to at least 1 minute because U line controllers do not support time-critical applications. To use a LogiStat sensor, the control program must have a LogiStat Zone Sensor microblock. NOTE The U220 does not support any LogiStat sensor. For the actuator in a v+ controller to be protected by the controller warranty, the control program must contain the following microblocks: Zone Controller U-line Airflow Control The U220 is designed to handle miscellaneous pieces of equipment such as exhaust fans and room lighting. In many cases, these applications will not meet the unitary control criteria required by EIKON LogicBuilder to enable the UNI option. You may use any of the standard U220 zone control programs in the EquipmentBuilder Library. You can download ZN control programs into a UNI. If your control program does not meet UNI rules, try saving it as a ZN control program. If your control program does not meet UNI or ZN rules but is appropriate for a zone control application, you can get the control program tagged by ALC. Review ALC's tagging policy (http://accounts.automatedlogic.com/sales/policy.nsf/7efc5bb11196e87185256b3c00785ad 2/eaffdfa1ccd769d88525735b004e7864!OpenDocument) on the dealer website, then follow the instructions under "How do I get a control program tagged?".
10
ZN for ZN line controllers

Required microblocks BACnet Time Clock Microblocks not supported Setpoint Optimization Set Color or Set Color if True Toggle Lead/Standby Integrator Total Analog Input Average Analog Input Minimum Analog Input Maximum Analog Input
Setpoint with a direct input named ZONE TEMP from one of the following microblocks: BACnet Analog Input Analog Network Input Analog Network Input 2 LogiStat or RS Zone Sensor NOTE Required microblocks must be located in the opening pane (1024 x 600 pixels) of the control program. NOTES
Each Time Clock microblock in a control program must have a unique schedule category. The Zone Controller microblock provides primary heating and cooling PID control loops. If you need additional control loops, you may use up to 2 additional PID microblocks, but no more than 2. To use an RS sensor, the control program must have an RS Zone Sensor microblock. To use a basic LogiStat or LogiStat Plus sensor, the control program must have a LogiStat Zone Sensor microblock or an RS Zone Sensor microblock. NOTE The ZN220 does not support any LogiStat sensor. Other ZN's do not support the LogiStat Pro.
A ZN control program can have a maximum of 350 microblocks (excluding labels, text, and status microblocks). For the actuator in a v+ controller to be protected by the controller warranty, the control program must contain the following microblocks: Zone Controller Airflow Control The ZN220 is designed to handle miscellaneous pieces of equipment such as exhaust fans and room lighting. In many cases, these applications will not meet the zone criteria required by EIKON LogicBuilder to enable the ZN option. You may use any of the standard ZN220 zone control programs in the EquipmentBuilder Library.
11
Tagging:

A control program that does not meet the above ZN criteria but is appropriate for a zone control application can be tagged by ALC as a ZN control program. Only tagged OCL microblocks can be used in a ZN control program. Get a tagged OCL microblock from the dealer website (http://accounts.automatedlogic.com). Select Engineering > StdAppLibrary > Standard Application Library > WebCTRL > ZN551 & ZN253 Zone Applications & OCL Microblocks. Or, get ALC to tag your own OCL microblock. Each microblock inside an untagged custom microblock counts against the ZN 350microblock limit. However, a tagged custom microblock counts as only 1 microblock. You can use tagged custom microblocks available in some applications in EquipmentBuilder. Or, get ALC to tag your own custom microblock. To get a control program, OCL microblock, or custom microblock tagged, review ALC's tagging policy (http://accounts.automatedlogic.com/sales/policy.nsf/7efc5bb11196e87185256b3c0078 5ad2/eaffdfa1ccd769d88525735b004e7864!OpenDocument) on the dealer website, then follow the instructions under "How do I get a control program tagged?".
You cannot suppress the logic page for a ZN control program.
12
Chapter 5
Developing the logic
Use the following procedures to develop your control program.
To begin a control program

EIKON LogicBuilder creates a .equipment file that is the control program that you download into a controller. 1 2 Start EIKON LogicBuilder. Select 1 of the following in the Control Program menu: Normal for downloading into ME, M, SE, S, and LGR line controllers or an Equipment Portal ZN for downloading into ZN line controllers or a Room Controller UNI for downloading into UNI controllers Select File > Save As. Browse to the WebCTRLx.x\webroot\<system_name>\programs folder. Name the .equipment file. The name must: Begin with a letter. Not contain spaces or periods. Be unique throughout a WebCTRL system. In the Files of type field, select:

3 4 5
Control Program (*.equipment) - v4 or earlier to use the control program in any version of WebCTRL. Control Program (*.equipment) - v5 or later to have an encrypted control program. v5 control programs are not backward compatible.
NOTE Go to Options > Preferences > General > Default File Format to change the default setting for this field. 7 Click Save.
NOTES For a Normal or UNI control program, you can select Control Program > Suppress Logic Page so that it cannot be seen in WebCTRL. Select File > Info to view the file's name, location and dates. You can also select a Custom Icon that the WebCTRL navigation tree will show for the equipment.
13
To use C for setpoint microblocks in a control program, select Control Program > Metric. If you change the Metric option for an existing control program, you must delete and reinsert all setpoint microblocks. To have Metric enabled for all future control programs, select Options > Preferences, then select Create new control programs as metric.
To place microblocks
1 Right-click the Microblock palette.
2 3 4 5
Click the icon of the microblock you want to use. Move the cursor into the workspace. NOTE Press and hold Shift if you want to place 2 or more of the selected microblock. Click to place the microblock. Edit the microblock's properties in the Property Editor. NOTES

If the Property Editor is not open, double-click the microblock. Red text in a field indicates an invalid value. You can right-click some properties in EIKON LogicBuilder and select Make Editable or Make Read-Only to determine that property's functionality in WebCTRL.
TIPS Place all input microblocks on the left side of the workspace and all output microblocks on the right. Arrange microblocks so that logic flows from left to right and the sequence of operation can be easily followed. Hold Ctrl as you move a microblock to detach it from its wire.
14
Use EIKON LogicBuilder's Microblock Common Properties Editor to view, compare, and edit common properties of I/O microblocks (see page 35). The order of items on a WebCTRL Properties page is determined by the order in which microblocks are placed when developing the control program in EIKON LogicBuilder. To change the order, see To reorder items on the Properties page (page 22).
To draw wires and labels

Wires are special lines in a control program that transmit values from one microblock to another. Solid wires transmit analog data; dashed wires transmit binary data. Wires connect microblock inputs and outputs. They can also connect to other wires. Output and input labels connect items just as wires do. Use labels when a value is needed in several places within a control program or when wires would clutter or complicate the control program.
To draw wires
1 Click and drag from a microblock nib in the direction you want the wire to go. NOTE A wire automatically makes a 90 turn if you drag away from a straight line. To create additional 90 turns, right-click while continuing to hold down the left mouse button. 2 Release the left mouse button to end the wire. NOTE When drawing wires between closely placed microblocks, you can temporarily disable the snap-to feature by pressing Ctrl while drawing a wire.
To change an existing wire

NOTE If you move a microblock, connected wires move with it. 1 2 Right-click the wire, then select Edit Shape. Do one of the following:

Click and drag any wire segment in the direction of the move icon. Right-click where you want to add a joint on a wire, then select Add Joint. Right-click a green wire joint, then select Remove Joint. Click a wire, then select a different wire from the Type drop-down list.
15
To add labels
1 Select the Label tool.
Move the cursor to the nib of a microblock or to the end of a wire, then click the workspace. TIP To quickly change the label's direction, press I (for Input label) or O (for Output label) while moving the label.
3 4
Type a name in the Label Text field of the Property Editor. NOTE If the Property Editor is not open, double-click the label. Optional: Change the Direction of the label in the Property Editor.
To change a label's text

1 2 3 Select the label. NOTE To locate the label, see To find a microblock or label (page 36). Edit the Label Text field. NOTE If the Property Editor is not open, double-click the label. Optional: Click Rename all labels named '__' to change all labels that have the same label text.
To view errors
EIKON LogicBuilder checks for errors as you build your control program and indicates errors with red dots, wires, and boxes. 1 2 Click errors. in the lower right corner or select Control Program > Errors on the menu bar to view the
Click an error in the list to highlight its location in the workspace.
To add comments
Use the Text tool to add comments to the control program. 1 Select the Text tool.
16
2 3
Click in the workspace where you want the text to begin. Edit the text and its properties in the Property Editor. See table below. NOTE If the Property Editor is not open, double-click the text.
Field Text Font Size Style Foreground Transparent Background Background
Notes Type the comment you want to add to the control program. Select a font. Be sure that all system computers have the font installed. Choose a point size from the drop-down list. Select the Bold or Italic checkbox or both. Click the color swatch to select the color of the text. Select this checkbox to remove the background color and pattern. Click the color swatch to select the color of the box behind the text.
NOTE To change the default settings for all text that you will add to the control program, select Options > Palette. Change the settings on the Font tab.
To arrange text blocks

1 2 Select 1 or more text blocks. Right-click one of the text blocks, then select 1 of the following: Bring Forward Bring to Front Send Backward Send to Back
To add lines and rectangles

Use lines and figures to organize and clarify the control program.
17
To draw a line or polygon

1 2 3 4 Select the line or polygon tool. NOTE To draw multiple similar figures, press and hold Shift as you draw them. To begin drawing the figure in the workspace, click and hold the left mouse button as you move the mouse. While holding down the left mouse button, right-click to add angles. Release the left mouse button to complete the line or polygon.
NOTE To change the shape of an existing figure, right-click the figure, then select Edit Shape. Click and drag a green point to move it.
To draw a rectangle or ellipse

1 2 3 Select the rectangle or circle tool. NOTE To draw multiple similar figures, press and hold Shift as you draw them. Click and drag in the workspace to begin drawing the figure. Release the mouse to complete the rectangle or ellipse.
NOTE Hold Ctrl while you drag to draw a square or a circle.
To change the color or pattern of figures

To change: The color or pattern of a selected figure, use the fields in the Property Editor. See table below. If the Property Editor is not open, Ctrl-click the figure. The color or pattern of multiple selected figures, select Options > Palette. NOTE Select the red cross-hatch pattern for no fill. The default color or pattern for all figures that you will draw, select Options > Palette. Notes Click the color swatch to select a color. Click the line or fill sample to select a pattern.
Field Foreground Background Line Patterns Fill Patterns
18
To arrange figures
1 2 Select 1 or more figures. Right-click 1 of the figures, then select 1 of the following: Bring Forward Bring to Front Send Backward Send to Back
To add an image
Select Edit > Insert Image to add a .gif, .png, .jpg, or .bmp image to your control program.
To create a custom microblock

If you want simple, easy-to-troubleshoot Logic pages, put complicated calculations in a custom microblock. NOTES You cannot view or change a custom microblock's logic in WebCTRL. You can put custom microblocks inside other custom microblocks.
19
To create a custom microblock

1 2 3 Select Custom Microblocks > Add New Custom Microblock. Right-click the custom microblock, then select Step Inside Custom Microblock. In the custom microblock window, place custom I/O microblocks to create nibs on the custom microblock. NOTE The order of the microblocks in the custom microblock window determines the location of the nibs on the custom microblock. 4 5 Place other microblocks, wires, and labels to create the custom microblock's logic. To return to the EIKON LogicBuilder workspace, click Control Program at the top of the custom microblock window.
To select properties for ViewBuilder graphics

EIKON LogicBuilder lets you select the microblock property values that you want to appear on a WebCTRL graphic. This allows the graphics creator to see the property values and quickly obtain their paths in ViewBuilder. These microblock property selections are saved when you save the control program. 1 2 3 Right-click a microblock in the workspace, then choose Select Properties For Graphics. Select the checkbox for any property whose value you want to display on a graphic. NOTE To see all properties, clear the checkbox Show properties typically shown on graphics. Optional: To add a comment for a property such as "Do not include units", select the property and then click , or you can double-click the property.
NOTE Select Control Program > Properties For Graphics to see all the properties that you selected in the control program. In the Comments box, you can type a comment that is not for a specific property. To delete a property, select it and then click .
To omit _# at the end of BACnet object names

BACnet object names are used in Network microblock addresses or by third-party equipment. To prevent duplicate object names in a controller with multiple control programs, WebCTRL automatically adds an instance number to the end of every object name (Example: lstat_5). The instance number added to every object in a control program is unique to that control program. A controller with only one control program does not have duplicate objects, so it does not need instance numbers. In this case, you can keep WebCTRL from adding instance numbers by selecting Control Program > Use Unitary Naming. NOTE If you select this option for a control program that will be downloaded into a multi-equipment device, all reference names in all of the device's control programs must be unique.
20
Chapter 6
Formatting Properties pages
Making a control program in EIKON LogicBuilder automatically creates a WebCTRL Properties page. The initial properties displayed on a Properties page are defined in EIKON LogicBuilder in the Property Editor. You can preview Properties pages by running the system without connecting to controllers.
In the control program, you can change the way text appears on the Properties page by using a Text microblock or by editing a microblock's Property Page Text field in the Property Editor. NOTE If you change a control program after downloading it to the controller, you must: 1 2 Reload the control program. See "Working with control programs in WebCTRL" in WebCTRL Help. Download the control program. See "Downloading system changes to controllers" in WebCTRL Help.
21
To reorder items on the Properties page

1 2 3 4 Select Reorder > Edit Order. Click the microblock(s) you want to move. Use the buttons at the right to move, cut, or paste microblocks. Click OK.
NOTES To find a single microblock in the Edit Order dialog box, do one of the following: Right-click the microblock in the EIKON LogicBuilder workspace, then select Show in Edit Order. In the Edit Order dialog box, click .
To edit a microblock's Property Page Text from the Edit Order dialog box, do one of the following: Double-click the microblock. Select it and then click .
To use the Text microblock to format text

The Text microblock allows you to format text, add horizontal lines, and arrange items on the Properties page. Text microblocks placed in a control program in EIKON LogicBuilder are not visible on the Logic page in WebCTRL. 1 2 3 Place a Text microblock in the workspace to the right of the microblock logic. In the Property Editor, select a format option from the Type drop-down list. See table below. NOTE If the Property Editor is not open, double-click the microblock. Type text in the Property Page Text field. Notes For creating plain text. To create a horizontal line on the Properties page, often used to offset or group information, choose Separator as the Text Type. If you would like text to appear on the separator line, enter the text in the Property Page Text field. For creating bold text.
Text Type Plain Separator
Bold
22
Text Type Expand Begin Closed Expand Begin Opened Expand End
Notes To format a section using expanded formatting, first insert a Text microblock with the Text Type set as Expand Begin Closed or Expand Begin Opened, depending on how you want the area to display when first viewed. If you would like text to appear on your expandable line, enter the text in the Property Page Text field.
You must also insert a Text microblock with the Text Type set as Expand End at the end of the section you wish to group together. TableBegin TableEnd To align data in a table, insert a Text microblock with the Text Type set as Table Begin. To complete the table, insert a Text microblock with the Text Type set as Table End after the last item you want to include in the table.
NOTE When working with a table within an expanded section, make sure the table begins after the Expand Begin and ends before the Expand End. Conditional Hide Begin Conditional Hide End You can hide part of the Properties page based on a value from a specific microblock. For example, you can specify that the Properties page text from an Analog Input microblock will only appear on the Properties page if the value is above 85. The expression is evaluated relative to the entire control program, not at that particular microblock. Place a Text microblock with the Text Type set as Conditional Hide Begin before the microblock to be evaluated and another set to Conditional Hide End after it. Enter a conditional expression in the Properties Page Text field of the Text microblock. Microblock properties may be referenced between the dollar signs ($), and the expression must be Boolean. For example, to show the microblock Properties page text only when the present value of the point named Zone Temp is greater than 85, the expression would be "$Zone_Temp/present_value$ >85". NOTES When referring to the name of a point, use the RefName rather than the Display Name. Technical Support does not provide assistance with writing and editing Javascript. Please see Javascript textbooks, available in most bookstores, for help with Javascript.
TIP If you are adding the Conditional Hide formatting after the control program has been designed or would prefer to group all of the Text microblocks within the control program, use the Reorder menu to correctly place the Text microblocks.
23
Editing Properties page text using special characters

For many microblocks, you can edit or format Properties page text in the microblock's Property Page Text field using special characters described below. To... Display a microblock property In the Property Page Text field, type... The microblock property between 2 dollar signs See the Microblock reference for property reference names. See Formatting a microblock property (page 25). Make a columnaligned table { to begin a table, then } to end the table [ to begin a row, then ]^$ to end a row. Exception: Type ] to end last row in table. | (a pipe) to align cells {[|History Recorder: |Current cycle = |$Current/Latched_Value$| on |$Current/Latched_Time$|$Current/ Latched_Date$ |since|$Current/Reset_Time$|$Current / Reset_Date$]^$ [||Previous cycle = |$Previous/Latched_Value$| on |$Previous/Latched_Time$|$Previous/ Latched_Date$ |since|$Previous/Reset_Time$| $Previous/Reset_Date$]} Displays: Example The value is $Present_Value$ Displays: The value is 69.
Hide default text
^## if Property Page Text field is empty. If the Property Page Text field shows the default text, delete the text.
Display two microblock properties on the same line
^$ at the end of the text for the first microblock
MB#1: Enable when Supply Temp is more than $Constant$ (F) ^$ MB#2: Disable when $Hyst$ (F) below Zone Temp. Displays:
Begin a new line of text
^\ where you want a new line to begin
Time for daily trend report:^\ ___ hh:mm 24 hr Displays: Time for daily trend report: 02:00 hh:mm 24 hr
24
To... Bold text
In the Property Page Text field, type... !{text!}
Example !{NOTE!} Displays: NOTE Must be enabled for... Must be enabled for...
Make a line of text not wrap in the action pane Display one of the following characters: ^\${}[]|!
^( at the beginning of the text and ^) at the end \x, where x is the character you want to display Do not change \! Displays: Do not change!
Formatting a microblock property

To add a microblock property in a microblock's Properties Page Text field, type the property between 2 dollar signs. For example, $current_Value$. This is called an expression. Each microblock property has default formatting that determines how it looks on the Properties page. You can change the way it looks by adding a control and one or more parameters to the expression. EXAMPLES To display the present value of Duty cycle in a time format that shows minutes and seconds, type $Present_Value:control=minsec$ To display the Period microblock property in a time format that shows minutes and seconds and make it editable, type $Period:control="minsec" editable="true"$.
25
Breakdown of an expression
The entire expression is between 2 dollar signs. A microblock property Example: Period A colon Type a colon after the microblock property to add a control. control= A control determines how a property is displayed on the Properties page. Include a control= statement in the expression only if you want to use a control other than the default. Type control=, followed by the control name .
A control Example: "minsec" Type the control between quotation marks. See table below. A space Type a space after a control statement or a parameter statement. A parameter Example: editable= You can add one or more parameters to the expression. To specify a control, type the name of the parameter (see table below), an equal sign, and then a value A parameter value See table below. Example: "true" .
26
Controls and parameters

A microblock property data type determines the type of control that can be used.
To display a... Checkbox
Data must be.. Boolean Example: A binary parameter's present value
Control button type
Parameter
Parameter value WidgetImageButton. TOGGLE true or false (Default value is true.) true or false (Default value is true.)
editable truewhendown Check mark appears when the value is false instead of true.
Radio button
Boolean Example: A binary parameter's present value or Integer Example: An analog parameter's present value or Enumerated Example: A binary, analog, or multi-state parameter's present value
button
type editable truewhendown Button is selected when the value is false instead of true. index For integer or enumerated values, index is the number of the state the radio button is to represent.
WidgetImageButton. RADIO true or false (Default value is true.) true or false (Default value is true.)
any integer (Default value is null.)
Text
Character string Example: A point's display name
charstring
editable
true or false (Default value is true.)
27
To display a... Date
Data must be.. Date Example: A wire lock's begin date/end date
Control date
Parameter editable hasdayofweek Displays the day of the week with the date.
Parameter value true or false (Default value is true.) true or false (Default value is true.)
Number
Integer (no decimal) Example: An analog parameter's present value or Real (has decimal) Example: An analog parameter's present value or Unsigned Example: Any point's expander number
number
editable digits_right_of_decimal (real number only) digits_left_of_decimal showplussign scalingfactor Multiplies the actual value by the scalingfactor value. Example, to convert watts to kilowatts, use .001 as the scaling factor value.
true or false (Default value is true.) number of digits (Default value is null.) number of digits (Default value is null.) true or false (Default value is false.) any floating point number except 0 (Default value is 1.)
Droplist
Enumerated Example: A binary, analog, or multi-state parameter's present value
droplist
editable
true or false (Default value is true.)
28
To display a... Time
Data must be.. Time Example: A wire lock's begin time/end time
Control time
Parameter editable displaywhat
Parameter value true or false (Default value is true.) One of the following: ControlTimeInput.HMSD ControlTimeInput.HMS ControlTimeInput.MSD ControlTimeInput.HM ControlTimeInput.SD ControlTimeInput.MS ControlTimeInput.H ControlTimeInput.M ControlTimeInput.S ControlTimeInput.D where H=hour, M=minutes, S=seconds, D=milliseconds (Default value is ControlTimeInput. HMSD.) true or false (Default value is true.) any floating point number except 0 (Default value is 1.)
Timer
Unsigned numbers used as a timer Example: A duty cycle's time
minsec
editable scalingfactor Multiplies the actual value by the scalingfactor value. Example: To convert watts to kilowatts, use .001 as the scalingfactor value. showhours showseconds
true or false (Default value is false.) true or false (Default value is true.)
29
30
Chapter 7
Simulating a control program
In simulation mode, you can specify microblock properties and define an operating environment to see how a control program will operate. To simulate a control program: 1 2 3 4 Select Control Program > Simulate. In the Simulator window, select Options > Setup. Define the simulation conditions. See table below. Do one of the following: 5 6 7 Click to run the simulation continuously until you click to stop it. Set the Time Increment fields (see table below) to define how fast the simulation will run. Click to run the simulation one step at a time.
to run the simulation as fast as possible. Click Click a microblock, then select its Simulation tab to enter values that will help you check the programming. See NOTES below. Verify that the logic performs the desired sequence of operation. Close the simulation window to return to the workspace. Notes Enter the starting Time and Date for the simulation. Select the Communications Ok checkbox to simulate normal communication. Clear this checkbox to simulate lost communication. The Step Every value determines how often the simulation recalculates values in real time. The One Step = value determines how much simulation time passes between each step. For example, to see 30 minutes of simulation in 1 second of real time, use the following settings: Step Every 00:01 (mm:ss) One Step = 30:00 (mm:ss) TIP Set your One Step = shorter than the shortest delay in your control program to avoid stepping over the delay in the simulation.
Field Calendar Communications Time Increment
31
NOTES For simulation only, decimal values smaller than hundredths are rounded to the nearest hundredth. For example .025 is rounded to .03. The Simulator has the same options as the main EIKON LogicBuilder window for locating items in the control program. See: To find a microblock or label (page 36) To find identical labels (page 36) To show a logical path (page 36) To show a wire's source microblock (page 36) Hold the cursor over a wire or label to see its value.
32
Chapter 8
EIKON LogicBuilder productivity tools
Use the following features to work efficiently in EIKON LogicBuilder.
To create and use symbols

You can reuse a sequence of programming by exporting it to a .logicsymbol file that you can import into other control programs. You can add frequently-used symbols to your Favorites list and organize them for ease of use.
To export a symbol
1 2 3 4 Select the items in a control program that you want in the symbol. Select Edit > Export Symbol. Type a File Name. EIKON LogicBuilder will attach the .logicsymbol file extension. In the Files of type field, select:

Symbol (*.logicsymbol) - v4 or earlier to use the symbol in any version .equipment file. Symbol (*.logicsymbol) - v5 or later for an encrypted symbol. v5 symbols cannot be used in a v4 or earlier .equipment file.
5 6
Select the Selected Items Only checkbox. Click Ok.
To import a symbol
1 2 3 4 Open the control program you want to paste a symbol into. Select Edit > Import Symbol. Browse to the symbol, then double-click it. Click in the workspace to place the symbol.
NOTE You can drag a symbol from Windows Explorer to EIKON LogicBuilder's workspace. You can select multiple items to drag them simultaneously into EIKON LogicBuilder. Hold down Ctrl as you drag and drop the .logicsymbol into EIKON LogicBuilder to have it open as a separate file.
33
To add symbols to your Favorites list

1 2 3 4 Select the items in a control program that you want in the symbol. Right-click one of the items, then select Add to Favorites. Type a Name and a Description. Click Ok.
To put a Favorites item in a control program

1 2 3 Click Favorites. Select the name of the symbol. Click in the workspace to place the symbol.
To organize favorites
1 2 Select Favorites > Organize. Use the buttons on the right to:

Add new favorite Remove favorite Edit favorite's name or description Move up Move down Open selected favorite in main view for editing
To use EquipmentBuilder
You can use EquipmentBuilder to generate: 1 2 3 4 5 An entire control program that is ready to edit or download The corresponding equipment graphic A BACview file (if applicable to selected equipment) Select File > EquipmentBuilder. Select the Equipment. Use the default Name or change it. Click Next. Define values for the items on the following tabs:

Summary Points Sequence
34
6 7 8
Click Next. Select the types of files you want EquipmentBuilder to generate. Click Finish.
NOTE ViewBuilder will open the files you selected in EIKON LogicBuilder and ViewBuilder.
To view or edit microblock common properties

The Microblock Common Properties Editor lets you view or edit common properties for the I/O, Network, Display, and BACnet microblocks in a control program. 1 To see the common properties of: All I/O, Network, Display, and BACnet microblocks in the control program, click toolbar. , then click Selected. Selected microblocks, shift+click the microblocks, click Select the tab for the properties you want to see. on the
NOTES Select File > Export to write the data to a CSV (Comma Separated Values) text file so that you can edit the file in a spreadsheet program. Click File > Import to import the CSV file back into the Microblock Common Properties Editor. CAUTION Do not change any column header name or microblock reference name in the spreadsheet program. To undo changes made in the Editor, close the Editor, then use LogicBuilder's Undo feature . See Microblock Reference Help for a description of each property.
35
To find a microblock or label

1 2 3 4 5 6 7 Select Edit > Find. Enter the text you are looking for in the Find What field. Select Case Sensitive if you want to find items that exactly match the uppercase or lowercase text you typed in step 2. Select the type of items you want to find in the Search box. Click Find. Select an item in the Found Items list. EIKON LogicBuilder highlights that item. Click Close.
To find identical labels

1 2 3 4 Right-click a label. Select Find Label Usages. Click an item in the list. EIKON LogicBuilder highlights that label in the workspace. Click Close.
To show a logical path

Right-click a wire, then select Highlight Connections. If you leave the Highlight Connection box open while you highlight additional wires, EIKON LogicBuilder highlights each wire with a different color. Click Change Color to select a different color for the highlight. Click Clear Highlight to turn off the highlighting.
To show a wire's source microblock

1 2 Right-click a wire. Select Go To Source.
36
Chapter 9
To use custom alarm and schedule categories
A WebCTRL system has pre-defined alarm and schedule categories. But, you can add custom categories. To do this, you add the custom category in EIKON LogicBuilder, then add the same category in WebCTRL. See "Using schedule categories" and "Customizing alarms" in WebCTRL Help.
To add a custom category in EIKON LogicBuilder

1 2 Select Options > Preferences. On the Alarm/Schedule Categories tab, select the Alarm Category tab or one of the following Sched. Category tabs. To create a schedule category for this type of microblock... BACnet Time Clock BACnet Time Clock with TLO Multi-state BACnet Time Clock BACnet Modeled Schedule Multi-state Time Clock Sched. Category Modeled Schedule Sched. Category
Select this tab Time Clock Sched. Category
3 4
Click
Type the category name. NOTE This name must be identical to the reference name that you give the category when you add it in WebCTRL. The name can contain lowercase letters, numbers, hyphens, and underscores (no spaces); it cannot begin with a number.
Click OK twice.
The new category will now appear in a microblock's Category droplist. NOTES Do not delete the existing categories on the Sched. Category tabs if your system uses any control programs created in EIKON for WebCTRL. See Working with EIKON for WebCTRL control programs (page 41). To copy all custom category information to another computer, click Export below the category tabs, then save the file. On the other computer, click Import, then select the exported file.
37
38
Chapter 10
Miscellaneous EIKON LogicBuilder menu commands
Menu command Edit > Third Party BACnet Addresses
Notes Use to edit control programs generated by the Third-Party BACnet Utility. See the BACnet Integration Guide (http://accounts.automatedlogic.com) for instructions on using this feature. When making a control program for use in a non-English system, use this command to embed the translation files in the control program, omitting the need to maintain separate files. See Setting up your system for non-English languages in WebCTRL Help. These apply to the EIKON LogicBuilder application, not just the current file. On this tab... General You can... Define the file format that will be the default when you select File > Save As. See To begin a control program (page 13) for more information. Set the metric option as the default for all future control programs. See To begin a control program (page 13). Guarantee that all control program file names do not contain spaces. Add custom alarm or schedule categories. See To use custom alarm and schedule categories (page 37). Import custom alarm templates, alarm categories, or schedule categories from the ems.ini file used by control programs created in EIKON for WebCTRL. See Working with control programs created in EIKON for WebCTRL (page 41).
Control Program > Bundled Resources
Options > Preferences
Alarm/Schedule Categories
39
Menu command
Notes Droplist Options Customize the following droplists in certain microblocks: HTML Viewer BACNET Engineering Units (Airflow, AO, AI) Output types (AO) Actuator types (AO) Input types (AI) Sensor types (AI)
Edit the location of your HTML Viewer. To Convert EIKON for WebCTRL .equipment files to EIKON LogicBuilder .equipment files. See Working with control programs created in EIKON for WebCTRL (page 41). Disable the Show Property Page Text field for all microblocks in the current control program. See information about the current control program. For example, the number of microblocks, number of ZN-counted microblocks, etc.
Tools > Configure Tools
Click Add, then select a file(s) to add the following to the Tools menu. Click this option Convert EIKON for WebCTRL Equipment
Remove all Property Page Text Statistics
Window Help > Tip of the Day Help > Apply Update Help > About
Select another currently open file to view or edit. Clear the Show tips on startup checkbox if you don't want to see the tips when you start EIKON LogicBuilder. Use this command to install WebCTRL service packs or patches. Technical support may ask you for this version, license, or Java VM information.
40
Chapter 11
Working with control programs created in EIKON for WebCTRL
Some functionality of WebCTRL's Logic page (for example, jumping to labels) requires that the control program be an EIKON LogicBuilder .equipment file. To quickly upgrade multiple EIKON for WebCTRL .equipment files to EIKON LogicBuilder .equipment files, see "Upgrading EIKON for WebCTRL .equipment files" below. To edit an EIKON for WebCTRL control program in EIKON LogicBuilder, you can import the .eiw file or open the .equipment file. See "Editing EIKON for WebCTRL control programs" below. IMPORTANT If you used custom schedule categories, alarm categories, or alarm templates in EIKON for WebCTRL, you must import them into EIKON LogicBuilder before you upgrade or edit the EIKON for WebCTRL files.
Upgrading EIKON for WebCTRL .equipment files

To quickly upgrade EIKON for WebCTRL .equipment files to EIKON LogicBuilder files: 1 2 In EIKON LogicBuilder, select Tools > Convert EIKON for WebCTRL Equipment. Browse to the folder containing the EIKON for WebCTRL .equipment files, then click Open.
NOTE Before the upgrade takes place, EIKON LogicBuilder copies all the control programs in the selected folder to a new backup folder.
Editing EIKON for WebCTRL control programs

To edit an EIKON for WebCTRL control program, you can open the .equipment file or import the .eiw file. After editing, you will save the control program only as a .equipment file; EIKON LogicBuilder does not use a .eiw file. To import a .eiw file: 1 2 Select File > Import from EIKON for WebCTRL. Select the file you want to import, then click Open.
NOTE After you edit a .eiw file, consider doing one of the following to prevent using it as the starting point for future control program edits. Move the .eiw file to a folder named Obsolete. Add -obsolete to the .eiw file name.
41
To import custom categories and templates from EIKON for WebCTRL

If you used custom schedule categories, alarm categories, or alarm templates in EIKON for WebCTRL, you must import those custom items from the ems.ini file. CAUTION Importing deletes any custom categories or templates that you may have defined in EIKON LogicBuilder. To import from the ems.ini file: 1 2 3 4 Select Options > Preferences. On the Alarm/Schedule Categories tab, click Import from INI. Open the ems.ini file located in your previous system's Eikon folder. Click OK.
NOTE If needed for v2.0 or earlier alarms, you can add templates on the Alarm Template tab. V2.5 or later alarms use the Universal template.
42
Index
A
alarm categories 37, 41 alarm templates 41 apply update 39
L
labels 13, 33 Logic pages 7, 13
B
background color 13 BACnet addressing 3 bundled resources 39
M
metric 7, 13 Microblock Common Properties 3, 35 microblock properties 20 microblocks 5, 7, 9, 13, 21, 33
C
category alarm 37, 39 categories 9, 37, 39 control programs 5, 9, 13 Normal 9, 13 simulating 31 UNI 10, 13 ZN 3, 11, 13 controllers 9
P
properties 5, 14, 20, 21 Properties pages 14, 21 Property Editor 7, 14
S
schedule categories 9, 37, 41 service packs and patches 39 shortcuts, mouse and keyboard 7 simulate a control program 31 symbols 33
D
download 5
E
EIKON for WebCTRL 41 error indicator 16 errors 16 expressions 21
T
third-party BACnet addresses 3, 39 Third-Party BACnet Utility 3 trends historical 3
F
font 13
G
graphics 20
I
images 19
J
joints 13
K
keyboard shortcuts 7
43
44

EIKON LogicBuilder v5 User Manual

Uploaded by

Document Information

Original Description:

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

EIKON LogicBuilder v5 User Manual

Uploaded by

Copyright:

Available Formats

EIKON LogicBuilder v5