BACnet/IP systems Desigo Control Point Engineering A6V11604297_en--_g 2021-04-05 Smart Infrastructure
Edition notice Edition notice Technical specifications and availability subject to change without notice. This document may not be reproduced, disseminated to third parties or processed and its contents may not be used or disclosed without express permission. Non-compliance shall result in compensation for damages. All rights, including those resulting from a successful patent application and registration of a utility model or design patent, are reserved.
Copyright Copyright This document may be duplicated and distributed only with the express permission of Siemens, and may be passed only to authorized persons or companies with the required technical knowledge.
Trademarks Trademarks The trademarks used in this document are listed together with their legal owners in this section. The use of these trademarks is subject to international and national statutory provisions. Desigo® and Desigo® CC™ are registered trademarks of Siemens Schweiz AG. BACnet is a trademark of American National Standard (ANSI/ASHRAE 135-1995). Chrome and the Chrome logo are trademarks of Google LLC. Firefox is a registered trademark of Mozilla Foundation.
Table of Contents 1 About this document ............................................................................................................................. 10 1.1 Scope .......................................................................................................................................................... 10 1.2 Target reader ............................................................................................................................................... 10 1.
4.2.4 Editing an interactive graphic ..........................................................................................................48 4.2.5 Editing a slideshow kiosk ................................................................................................................49 4.2.6 Removing a kiosk ............................................................................................................................52 4.2.7 Logging out of a kiosk .................................
8.9 Cancelling a kiosk log out sequence ......................................................................................................... 192 8.10 Special characters do not display in graphic file names ........................................................................... 192 8.11 The color of a graphical component may display incorrectly if the component was copied ..................... 192 Index ...............................................................................................
| 195 A6V11604297_en--_g
Cybersecurity disclaimer Cybersecurity disclaimer Siemens provides a portfolio of products, solutions, systems and services that includes security functions that support the secure operation of plants, systems, machines and networks. In the field of Building Technologies, this includes building automation and control, fire safety, security management as well as physical security systems.
1 About this document Scope 1 About this document 1.1 Scope This manual provides advanced procedures for using Desigo Control Point. It contains the following sections: Commissioning This section outlines topics that are not included in the Desigo Control Point Operation Manual (A6V11211557).
About this document Terms 1 1.3 Terms Term Definition ABT-SSA Setup & Service Application included in Desigo Control Point. Mainly intended for commissioning, service and other more advanced tasks. Also provides a generic data point list to operate all supported BACnet objects and properties of the assigned devices. automation station Primarily controls equipment and plants.
Commissioning 2 Default connection 2 Commissioning NOTICE Changes to the Desigo Control Point device configuration are saved in nonvolatile memory every 30 minutes and whenever you log out of the device. ● ● Save and log out to immediately save changes to the device configuration. Changes to the device configuration are lost if a power cycle occurs within 30 minutes of the change and before you have logged out. 2.
Commissioning 2 Setup wizard 2.3 Setup wizard The Setup wizard displays when you log in to any Desigo Control Point device with the status Unconfigured or Download Required. The Setup wizard is only available if the tool-free workflow has always been used with the device. If ABT Site has been used at any time, the tool free commissioning wizard is not available. The Desigo Control Point device restarts at the end of this procedure to save your configuration settings in non-volatile memory.
2 Commissioning Setup wizard Setting Description Firmware revision (Information only) Current firmware revision loaded in the device. Serial number (Information only) Serial number of the Desigo Control Point device. Local date (Information only) Current date. Local time (Information only) Current time. Table 1: Device fields. Network settings fields Fig. 2: Commissioning wizard, Network settings. Setting Description DHCP check box Select to use dynamic IP addressing.
Commissioning 2 Discover and assign devices Application fields Fig. 3: Commissioning wizard, Application fields. Setting Description Application template description If the device contains multiple applications, select the Application type from the drop-down list. Active system language User interface language for the application. Default: The language selected on the login page. Object naming convention Only Hierarchical, standard names (default) applies for Desigo Control Point.
2 Commissioning Subscribing to the time master 2.5 Subscribing to the time master The Desigo Control Point device time can be set or obtained from a time master. Complete this procedure to identify a time master for the Desigo Control Point device. If a time master is not being used, see the Settings section of the Desigo Touch Panel Clients Commissioning Manual (A6V11604303) to set the device time. Note The Desigo Control Point device cannot be a time master. 1. Select 2.
Commissioning 2 Registering as a foreign device 2.7 Registering as a foreign device This procedure configures a Desigo Control Point device as a foreign device to monitor BACnet devices outside of the IP segment. 1. Do the following in ABT Site to configure the device as a foreign object for Desigo Control Point: – – Update the device firmware and assign the device type. In the Engineered devices pane, right-click on the device and select Load > Fully load (device may restart).
Commissioning 2 Operating and monitoring features 2.9 Operating and monitoring features Use the workflow in this section to set up user accounts, add email recipients, and configure network and alarm settings in the application.
Commissioning 2 Operating and monitoring features NOTICE Corporate network restrictions may prevent you from using the configuration settings outlined in this section. Please clarify the network security policies at each site. 1. Select > > SMTP settings to display the SMTP settings from the project database. 2. Use the information in the following table to update the settings and then click Apply. The Test connection dialog box displays. 3.
2 Commissioning Operating and monitoring features Setting Description FTP server The IP address or DNS name of the FTP server that stores off-loaded data. For example, ftps://Host. User name The user name of an account that is allowed to access the FTP server. For example, Administrator. Password and Confirm password Type and confirm a password that complies with the password policy for your site. For security, the actual characters do not display in these fields. Table 6: FTP settings dialog box.
Commissioning 2 Operating and monitoring features 2.9.6 Configuring Alarms settings This section configures the following settings for Alarms: Setting Description Alarm polling How often the database is checked for any objects with an active alarm state, an acknowledgerequired state, or a reset-required state. Alarm history ● By default, the database is polled every two seconds.
Commissioning 2 Operating and monitoring features Setting Description Weekly Monday Tuesday Wednesday Thursday Friday Saturday Sunday – Monthly Week 1 (Days 1-7) Monday Tuesday Wednesday Thursday Friday Saturday Sunday Week 2 (Days 8-14) Week 3 (Days 15-21) Week 4 (Days 22-28) Week 5 (Days 29-31) Time Displayed in the format selected by the currently logged in user. The default setting is 22:00 or 10:00 PM. ● Field 1: Hours ● Field 2: Minutes Table 7: Configure alarm history dialog box.
Commissioning 2 Operating and monitoring features 4. Use the Table Alarm filter dialog box to make selections in the second dialog box. 5. Click Apply to save your selections. Setting Description Name Name of the alarm routing configuration. Default: Alarm routing If a configuration is saved with the default name, subsequent default names are Alarm routing n. Email subject The email subject line for the routed alarm.
Commissioning 2 Operating and monitoring features Table 10: Alarm filter dialog box. Editing an alarm routing This procedure modifies an existing alarm routing. Alarms is selected in the core function pane. 1. Select > > Configure alarm routing > . The Edit alarm routings dialog box displays the settings for each schedule. 2. Select an alarm routing from the drop-down list and select Edit. 3. Make the necessary changes in the Configure alarm routing dialog box and select Next. 4.
Commissioning 2 Operating and monitoring features Purging an alarm routing This procedure removes an alarm routing from the database. Alarms is selected in the core function pane. 1. Select > > Configure alarm routing > . The Purge alarm routings dialog box displays all alarm routings. 2. Select the alarm routing(s) to be removed and select Remove. 3. Select Apply to complete the removal. 2.9.
2 Commissioning Operating and monitoring features Setting Description Automatically integrate newly assigned devices ● If selected, data points are automatically integrated as soon as the automation station is assigned to the Desigo Control Point device. ● If cleared, you must manually integrate data points for newly-assigned devices. ● If selected, data points from an assigned device are automatically integrated if there is a change in the device type or the BACnet database revision number.
Commissioning 2 Operating and monitoring features 5. (Optional) Edit the ContentOn filter. This field defaults to a relative binding filter that applies to the current level of the building hierarchy. 6. Click Add and then OK to clear the message. Note The upload process stops if the maximum file size or the maximum memory is exceeded. The document is now available at the selected location in the building hierarchy. 2.9.9.
Data point integration 3 Data point integration user interface 3 Data point integration The Data point integration function displays under > Tools for all core functions that a user role is allowed to access. Data points from the devices being monitored must be integrated to the Desigo Control Point device. The Desigo Control Point device determines the total number of data points that can be integrated. For BACnet devices and systems all data points are integrated by default. 3.
Data point integration Data point integration user interface 3 ⑨ Status Indicates whether the objects from the device have been integrated to the Desigo Control Point device for monitoring. See the following Table Status indications for more information. ⑩ Filled Percent of the Desigo Control Point device capacity used by this device. ⑪ Template Does not apply for BACnet devices and systems. ⑫ Cache / Advanced ● Select Cache to load data points into the Desigo Control Point device memory.
Data point integration 3 Advanced integration functions 3.2 Advanced integration functions Use the Advanced integration functions to manually add or remove BACnet objects from the Desigo Control Point device. (See ④ and ⑤ in the following figure.) 1 2 3 4 5a 5b 6 ① Device name ② Applied template Does not apply for BACnet devices and systems. ③ Reset change button 5c 7 Apply button Applies your changes and closes the Advanced integration function.
Data point integration 3 Advanced integration functions ⓑ Clear the check box to manually remove a data point from integration. ⓒ The Source column indicates if a data point was added by the template, manually added or manually removed for integration. ⑥ Provided filter text Does not apply for BACnet devices and systems. ⑦ Tags column Displays semantic tags that are applied during data point integration. Does not apply for BACnet devices and systems.
3 Data point integration Advanced integration functions Example The filter coil and netObjectAccess >= 5 has been applied in the following figure. In this case, objects are only included if they have both the tag coil and netObjectAccess >= 5.
Data point integration 3 Advanced integration functions The filter equipRef->navName == “Cooling coil” has been applied in the following figure.
Data point integration 3 Resolving errors related to data point integration 3.3 Resolving errors related to data point integration Complete this procedure if a cache or integration error occurs. 1. Manually remove the device in ABT-SSA: – Select > Setup & Service > Assigned devices. – Select Assigned devices in the work area and click – – Click for the device with the error. Click Delete to confirm the action. to open Edit mode. 2.
Graphic features 4 Plant view Tools 4 Graphic features 4.1 Plant view Tools The Plant view core function provides custom graphical views of the current control within your facility. Graphics available for viewing in the Plant view are based on the type of binding applied to the graphic the context of where the user is in the navigation. For example, a room segment graphic with relative binding will be available for all room segments at the same relative position in the building hierarchy.
4 Graphic features Plant view Tools User interface ① Root icon and breadcrumb navigation Click to navigate to the top of the hierarchy for all devices being monitored. Graphics at this level are designed to encompass an entire project and display data from multiple sites. For example, a dashboard graphic that displays data for all fire sensors in a project.
Graphic features 4 Plant view Tools Enabled graphics and kiosks Graphics and kiosks with an active thumbnail image or an active generic logo can be viewed by room users. A generic logo displays if a graphic does not have a thumbnail image. ④ Click the thumbnail image, the graphic name or to display a graphic or kiosk.
Graphic features 4 Plant view Tools (Optional) Adding graphic components 1. Drag-and-drop graphic components from the COMPONENTS pane. 2. Drag-and-drop the appropriate data point from the EQUIPMENTS pane onto the component. 3. (Optional) Right-click the component and select TOOLS > RELATIVIZE. Select the binding options to create a relative reference and click APPLY. (Optional) Adding smart labels 1. Drag-and-drop a numeric point from the EQUIPMENTS pane. 2.
Graphic features 4 Plant view Tools Removing a graphic ◈ Do one of the following: – Select > > Configure graphics > in the Plant view to display a list of graphics. Select the graphic(s) to remove, click Remove and then click Apply. – Display the graphic you want to remove and then select > > Configure graphics > . The selected graphic(s) are removed. 4.1.
4 Graphic features Plant view Tools 4.1.6 Importing graphics 1. Select > > Import files. The Import files dialog box displays. 2. Click Choose files and select the desired *.fst file(s) from your computer. 3. Click Import files to complete the process and click OK to close the message. 4.1.7 Enable / disable graphics and kiosks Room users can only view graphics and kiosks that have been enabled in the Desigo Control Point device.
Graphic features 4 Plant view Tools 4.1.8 Defining graphics as a startup page Graphics that are defined as a startup page are the default view for a particular level of the building hierarchy. This feature helps to maintain relative references if you are using hyperlinks to navigate between graphics. 1. Select > > Define startup page. The Define startup page dialog box displays all graphics in the application. 2. Select the graphic(s) to define as a startup page in the Not startup pages section. 3.
4 Graphic features Kiosk graphics 4.2 Kiosk graphics A PXM... touch panel may be used to display kiosk graphics. A kiosk displays graphics in a controlled manner that prevents users from accessing information and system features outside the scope of the controlled display. ● An activated kiosk displays graphics in full-screen mode. ● Exiting full-screen mode requires a special touch sequence and user authentication. ● Thumbnail images are currently not supported for kiosk graphics.
Graphic features Kiosk graphics 4 Configuring the touch panel for kiosk operation 1. Log in to the touch panel through a computer. 2. Select Plant view 3. Select > and display the kiosk graphic that should display after a power cycle. > Configure graphics > URL. 4. Copy the URL in the dialog box and click Close. 5. Select 6. Click > Setup & Service > > Favorite commissioning > Touch panel settings. to display all properties. 7.
Graphic features 4 Kiosk graphics 4.2.2 Designing interactive graphics This section outlines the recommended layout to optimize user experience during room operation. As a security measure to prevent malware attacks, Web browsers do not allow the display to change to full-screen mode without user interaction. Using a different layout may cause the icon to display, which indicates that a tap or click is required to authorize full-screen mode.
Graphic features 4 Kiosk graphics 1 2 3 4 5 6 ① Interactive kiosk Only one graphic can be assigned to an interactive kiosk. This graphic displays when a user navigates to the kiosk. Navigating to the kiosk and navigating to the graphic assigned to the kiosk appear the same to the user; however It is only possible to enter or exit full-screen mode from the kiosk.
Graphic features 4 Kiosk graphics 4.2.3 Workflow for configuring a kiosk presentation Workflow step 1 Configuring a user account for the kiosk operator [➙ 46] 2 Configuring interactive graphics [➙ 46] or Configuring a slideshow of graphics [➙ 47] 3 Activating a kiosk presentation [➙ 48] Configuring a user account for the kiosk operator This procedure configures a user account for the kiosk operator that does not automatically log out and is limited to running the kiosk. 1.
Graphic features 4 Kiosk graphics 4. Select > > Enable/disable graphics & kiosks. 5. Select the new kiosk in the Disabled graphics & kiosks section, click Apply to enable it and then click Close. The interactive graphic kiosk is enabled for viewing. Configuring a slideshow of graphics A slideshow of graphics can be assigned one graphic or multiple graphics to be displayed in sequence.
4 Graphic features Kiosk graphics Activating a kiosk presentation CAUTION Always activate the kiosk while logged in with the kiosk user account. Activating the kiosk while logged in with an advanced user account, such as an administrator or engineer, allows the kiosk operator to access non-kiosk system functions. NOTICE User accounts with limited access cannot log in if the previous user logged out from the ABT Setup & Service Assistant (SSA).
Graphic features Kiosk graphics ① Name Type a new name to rename the kiosk graphic. ② KIOSK ON filter Modify the KIOSK ON filter to change the equip or site where the components bind to display values and states. ③ Select graphic Select the interactive graphic to display for this kiosk. ④ Select target Select the equip or site where the components bind to display values and states. 4 4.2.
4 Graphic features Kiosk graphics Editing kiosk properties ① Name Type a new name to rename the kiosk graphic. ② KIOSK ON filter Modify the KIOSK ON filter to change the equip or site where the components bind to display values and states. Adding slides ① Select the graphic to display in the slideshow. ② The equip or site where the components bind to display values and states. ③ The number of seconds each slide displays. ④ The position of the current graphic in the slideshow sequence.
Graphic features Kiosk graphics 4 Editing slides ① The graphic name. ② The equip or site where the components bind to display values and states. ③ The number of seconds each slide displays. ④ The position of the current graphic in the slideshow sequence. ⑤ Fields for editing the next slide in the slideshow.
4 Graphic features Kiosk graphics 1. Select the slide(s) to remove from the slideshow. 2. Click Remove and OK to confirm the removal. 4.2.6 Removing a kiosk 1. Select > > Configure kiosks > Remove . The Remove kiosks dialog box displays all kiosks in the application. 2. Select the kiosk(s) to remove and click Remove. 3. Click Remove to confirm the removal. 4.2.7 Logging out of a kiosk The touch sequence in the log out procedure only displays the Log out screen—it does not end the kiosk session.
Graphic features 4 Engineering notations NOTICE Do the following if you do not know which user account activated the kiosk session: ● Tap Cancel on the Log out screen. An error may display. ● ● Swipe down to display the URL bar and tap to display ABT-SSA. Select Log out from the User management menu. ABT-SSA may display the next time the user account that originally activated the kiosk session logs in.
4 Graphic features Engineering notations 4. In the middle section of the dialog box, select the data point(s) to which an engineering notation is being added. 5. Type the engineering notation in the engNotation key value field and click Apply. 6. Display the magic bubbles to verify the engineering notations. The notation format is: engNotation: “[tag name]” Editing an engineering notation 1.
Graphic features Engineering notations 4 Removing an engineering notation 1. Open the List view and navigate to the level of the building hierarchy where the equipment and/or data points with an engineering notation reside. 2. Select > > Edit engineering notation > . All engineering notation tags at the selected location in the building hierarchy are displayed. 3. Select the engineering notation(s) to remove. Press CTRL and click to select multiple items. 4.
Graphics Builder 5 Overview 5 Graphics Builder Graphics Builder is the graphic design tool for Desigo Control Point. 5.1 Overview This section provides an overview of the Graphics Builder user interface and terms and concepts that are important for understanding how to use the program. User interface 1 2 3 6 ① Builder pane Provides tools for building graphics or displays information about the current graphic.
Graphics Builder 5 Overview ③ Command bar and MENU flyout Contain basic tools, such as copy, paste, save, open and drawing shapes. The MENU flyout also provides SAVE AS GRAPHIC . Command bar and MENU icons [➙ 58] ④ Currently not used. ⑤ PREVIEW button Click to preview the current graphic. Animated components are active and objects that depend on the context display.
5 Graphics Builder Overview Command bar and MENU icons The command bar and MENU flyout contain basic tools, such as copy, paste, save, open, and drawing shapes. Indicator Name Key combination Description NEW GRAPHIC – Opens an empty graphic page. OPEN GRAPHIC – Opens graphics from the current project. SAVE GRAPHIC CTRL+S Saves and publishes the current graphic. SAVE AS GRAPHIC Only available in the MENU flyout. Saves a copy of the current graphic with a different name.
Graphics Builder Overview 5 Data point binding Data point binding refers to the type of connection between a graphic component and an integrated data point. Graphics Builder uses the following types of data point binding: ● Absolute binding is a fixed connection to a point ID or equip ID that is unique to a specific database. – An absolute binding always fetches data from a specific instance of a point in this database.
Graphics Builder 5 Overview Relative by navName binding Relative by navName binding has a query that contains an equipRef and a navName. For example: equipRef==$id and (point or shadowPoint) and navName=="Outside air temperature" Fig. 6: Example of navName in a binding query. ● ● ● The binding query works on any equipment where the structure of the building hierarchy and the navName naming convention are a match.
Graphics Builder Overview 5 How semantic tags create structure in the system Desigo Control Point uses a semantic tagging model, which is based on the open source Project Haystack model. Rather than object instance numbers or proprietary data point names, a semantic tagging model uses standardized, descriptive metadata to categorize and interpret data point information. The Haystack tags site, equip and point create a basic hierarchy in Desigo Control Point.
5 Graphics Builder Overview How a point or equip is identified in the system Relative bindings create a structure that is used to dynamically identify a point or equip. References in relative bindings always start at lower levels of the building hierarchy and link to higher levels. That is, “parents” do not reference their “children”. Rather, data points reference their “parent” in the building hierarchy, the “parent” references the “grandparent”, and so forth.
Graphics Builder 5 Overview ① Describing the relative position of a point or equip in the hierarchy References in relative bindings always start at lower levels of the building hierarchy and link to higher levels. For example, references link from a point (or shadowPoint) to an equip to a site to the Desigo Control Point device at the Root . ② Dynamic structure Relative bindings create a structure that is used to dynamically identify a point or equip.
Graphics Builder 5 Overview Binding query Type of binding Description baUniqueId Fixed for a specific application on a specific system device. ● Query stays constant within a device unless the application structure is changed. ● Useful for one-time solutions. semantic tags Can be reused with similar applications and other system devices. Query can be used across systems and is extensible by individual libraries. shortName Can be reused with similar applications and other system devices.
Graphics Builder 5 Overview – Select the item, right-click and select TOOLS > RELATIVIZE. The Component binding options dialog box displays. – In the Top Equip section, select a location in the building hierarchy where the graphic will be used. By default, the object on which you opened this graphic for editing is selected. Another object can be manually selected, if necessary. The Top Equip is used as the root when describing the relative location of the point within the hierarchy.
Graphics Builder 5 Overview This procedure creates a graphic that displays data for an entire facility. 1. Create or open a graphic at an equip level that is located immediately below the desired site. How semantic tags create structure in the system [➙ 60] 2. Do the following for each component and smart label in the graphic: – Select the item, right-click and select TOOLS > RELATIVIZE. The Component binding options dialog box displays.
Graphics Builder 5 Overview Fig. 7: Modifying the GRAPHIC ON. Creating Root level graphics This topic outlines tips for creating a graphic that displays data from multiple sites or data for an entire project. ● When using TOOLS > RELATIVIZE to generate bindings, the root of the search pattern is always the $id variable. ● The binding query is always relative to the structured object in the Plant view where the graphic is opened for viewing or editing.
5 Graphics Builder Overview Binding query Result equipRef->siteRef==$id and When this graphic is opened for viewing on a site, the $id variable assumes the value of that specific site, and the binding searches for an equip or point below that site. … equipRef->siteRef->navName=="your site 01" and Regardless of where this graphic is opened for viewing, this binding always connects to the described equip or point instance below the site with navName "your site 01".
Graphics Builder Overview 5 Reusing graphics on other devices Reusing graphics on other Desigo Control Point devices Graphics with relative binding can be reused on other Desigo Control Point devices that have the same or similar applications. ● Relative by Tags binding is recommended for all supported standard applications because semantic tags are automatically applied during data point integration. ● Always use semantic tags that follow the Haystack conventions when creating relativized graphics.
Graphics Builder 5 – Overview Select a component or smart label, right-click and select TOOLS > RELATIVIZE. The Component binding options dialog box displays. – In the Top Equip section, select the building hierarchy location where the graphic will be used. By default, the object on which you opened this graphic is selected. Another object can be manually selected, if necessary. The tool uses the Top Equip as the root when describing the relative position of the point in the building hierarchy.
Graphics Builder 5 Pane tools 5.2 Pane tools The Builder pane displays on the left side of the Graphics Builder and contains the following tools for building robust graphics: ● PROPERTIES [➙ 71] Used to view, edit, add or remove any object, or modify the properties of a graphic component. ● COMPONENTS [➙ 75] Provides components for dashboard graphics and HTML elements and images for physical components. ● LAYERS [➙ 132] Displays a hierarchical structure for all the components in a graphic.
5 Graphics Builder Pane tools BASIC PROPERTIES Use the BASIC PROPERTIES to modify the graphic name or change the appearance of the selected component. This section outlines the properties that are common to all components. See the COMPONENTS tools [➙ 75] and HTML COMPONENTS [➙ 102] sections for information on specific components. General properties ● Component icon and Name field (not labeled) The name of the currently-selected graphic component.
Graphics Builder 5 Pane tools BORDER Adds a border to the selected component. ● Enter a point value in the WIDTH field and select a line TYPE from the drop-down list. ● Select ● Select ● Click the COLOR field to open the palette. Select a color and click the COLOR field again to save your selection. ● Use the RADIUS field to change the appearance of the corners of the selected component. to change all borders at once. , or to change individual sections of the border.
5 Graphics Builder Pane tools ADVANCED PROPERTIES Use the ADVANCED PROPERTIES section to add, edit and remove tags for the selected component. ① binding property A string tag that displays binding information for the selected component. Data point binding [➙ 59] ② 1 ● For components with absolute binding, the ID for a specific data point in the database is displayed. For example, id == @20a3572b-28b7e002. ● For components with relative binding, a query string is displayed.
Graphics Builder 5 Pane tools 5.2.2 COMPONENTS The ● ● ● ● ● ● COMPONENTS pane provides the following tools for creating graphics: Components that are mainly used for dashboard graphics. For example, tools to create charts and gauges, embed graphics, display a motion jpeg and create custom interfaces with the RactiveJS library. COMPONENTS tools [➙ 75] Components to add HTML elements. HTML COMPONENTS [➙ 102] Components that simplify the configuration of bar, circle, half-circle, and icon gauges.
5 Indicator Graphics Builder Pane tools Name Description ITEM RENDERER Renders a list of models based on a query from a virtual point. Example Used in the Sample Room Segment graphic. (Lights and blinds are rendered with an Item renderer.) KIOSK This is a basic component for custom programming only. See the Desigo Control Point kiosk tools, which provide the standard workflow for creating kiosks with robust functionality.
Graphics Builder 5 Pane tools Workflow step More information 1 Create trend(s) for Historical (his) charts. See Trends tools in the Desigo Control Point Operation Manual (A6V11211557). 2 Create the dashboard component. See TIMER [➙ 100] to set a refresh interval. ● Drag-and-drop a chart from COMPONENTS > AM CHARTS onto the work area. ● (Optional) Drag-and-drop from the COMPONENTS > COMPONENTS pane onto the work area to set a refresh interval for the chart data.
5 Graphics Builder Pane tools Area chart Displays historical data (his) for up to ten points. 1 2 3 4 5 Fig. 8: Area chart example. ① Main Title ② Chart Scrollbar ③ Side Title ④ Chart Cursor ⑤ Legend Setting Description Chart type Historical is the only option. Number of points Number of points to display in the chart. Maximum is 10. Timer (Optional) Select a timer to set a refresh interval for the chart data. Legend Select to display a legend below the chart.
Graphics Builder Pane tools 5 Column chart Displays historical data (his) or current values (curVal) for up to ten points. Values can be displayed in either vertical or horizontal bars. 1 2 3 4 5 Fig. 9: Column chart example. ① Main Title ② Y Axis Max ③ Side Title ④ Show Background ⑤ Y Axis Min Field Description Chart type Select Current Val or Historical. Number of points Number of points to display in the chart. Maximum is 10.
5 Graphics Builder Pane tools Column layered chart Displays historical data (his) for exactly two points. Values can be displayed in either vertical or horizontal bars. 1 2 Fig. 10: Column layered example. ① Main Title ② Side Title Setting Description Chart type Historical is the only option. Number of points Number of points to display in the chart. Must be exactly 2. Timer (Optional) Select a timer to set a refresh interval for the chart data.
Graphics Builder 5 Pane tools Column line chart Displays historical data (his) for exactly two points. One value is displayed in vertical bars, and one value is displayed as a line graph. 1 2 3 4 5 6 Fig. 11: Column line example. ① Main Title ② Chart Scrollbar ③ Side Title ④ Show Background ⑤ Chart Cursor ⑥ Legend Setting Description Chart type Historical is the only option. Number of points Number of points to display in the chart. Maximum is 10.
5 Graphics Builder Pane tools Column stacked chart Displays historical data (his) for up to ten points. Values are displayed in vertical bars. 1 2 3 4 Fig. 12: Column stacked example. ① Main Title ② Chart Scrollbar ③ Side Title ④ Legend Setting Description Chart type Historical is the only option. Number of points Number of points to display in the chart. Maximum is 10. Timer (Optional) Select a timer to set a refresh interval for the chart data.
Graphics Builder Pane tools 5 Line chart Displays historical data (his) for up to ten points. 1 2 3 4 5 6 Fig. 13: Line chart example. ① Main Title ② Chart Scrollbar ③ Side Title ④ Show Background ⑤ Chart Cursor ⑥ Legend Setting Description Chart type Historical is the only option. Number of points Number of points to display in the chart. Maximum is 10. Timer (Optional) Select a timer to set a refresh interval for the chart data. Legend Select to display a legend below the chart.
5 Graphics Builder Pane tools Pie chart Displays current values (curVal) for up to ten points. 1 2 3 4 5 Fig. 14: Pie and Donut chart examples. ① Main Title ② Chart Cursor ③ Legend ④ Animate Slice ⑤ Show Background Field Description Chart type Current Val is the only option. Number of points Number of points to display in the chart. Maximum is 10. Timer (Optional) Select a timer to set a refresh interval for the chart data. Legend Select to display a legend below the chart.
Graphics Builder 5 Pane tools Field Description Chart Cursor Select to display the data point value when scrolling over the chart. Animate Slice Select to pull out an individual slice of the pie chart when it is clicked. Main Title Show Background Title shown at top of chart, if left blank it does not display a title. Select to make the background opaque and display a frame around the chart.
Graphics Builder 5 Pane tools Configure Dashboard Component Points Prerequisites ● ● Data points for the chart are available in the VIRTUAL POINTS pane. The Num Points field in the Configure Dashboard Comp dialog box reflects the number of data points to display in the chart. Data points for curVal charts are selected from a drop-down list of VIRTUAL POINTS that are associated with the graphic. If the desired data point is not in the list, drag-and-drop numeric points from the chart.
Graphics Builder 5 Pane tools 5. Click at the bottom of the VIRTUAL POINTS pane to add a new virtual point. 6. Name the virtual point (if desired) and click 7. Click A . for the new virtual point and select ADD PROPERTY. string tag is added. 8. Name the property query and click . 9. Select the value for the query property (initially named NULL), change it to readAll(site) and click A6V11604297_en--_g .
5 Graphics Builder Pane tools 10. Drag-and-drop the new virtual point onto the DATA GRID to bind it to the component. 11. Click PREVIEW in the upper right corner to display the data.
Graphics Builder 5 Pane tools GAUGE A GAUGE displays the current value of a virtual point in a gauge format. Configuring a GAUGE This procedure uses the PROPERTIES, COMPONENTS, VIRTUAL POINTS and EQUIPMENTS panes. 1. From the COMPONENTS > COMPONENTS pane, drag-and-drop 2. (Optional) Select the new GAUGE and use the BASIC GAUGE onto the work area. PROPERTIES to modify the appearance of the gauge. Working with gauges [➙ 167] 3.
Graphics Builder 5 Pane tools AM|GAUGE An AM|GAUGE displays the current value (curVal) of a virtual point in a gauge format. This component is typically used in combination with a PROGRAM and a GROUP. Configuring an AM|GAUGE 1. Drag-and-drop 2. Drag-and-drop a from COMPONENTS > COMPONENTS onto the work area. numeric point from EQUIPMENTS onto the work area to create a smart label for the gauge. 3.
Graphics Builder 5 Pane tools 5. (Optional) Select the gauge and use the BASIC PROPERTIES to modify the End value, Start value or Title . BASIC PROPERTIES [➙ 72] 6. Click PREVIEW in the upper right corner to display the gauge updating with the current value. GRAPHIC INCLUDE GRAPHIC INCLUDE creates a frame that embeds a graphic into another graphic. For an example, see the FIN Include Program in the PROGRAMS pane of the Sample room segment graphic.
5 Graphics Builder Pane tools displays, or to OFF to only load the graphic after a trigger event. 3. Click PREVIEW in the upper right corner to display the 92 | 195 GRAPHIC INCLUDE.
Graphics Builder 5 Pane tools GROUP Groups are typically used to hold components together for making models. Graphics Builder provides two options for holding components together: ● Using GROUP in the COMPONENTS > COMPONENTS pane. ● Selecting CREATE GROUP from the right-click menu. Creating a group with the GROUP component This procedure uses the COMPONENTS and LAYERS panes. 1. Drag the desired components onto the work area. 2.
5 Graphics Builder Pane tools The components are grouped together and move as a single unit. Creating a group through the right-click menu This procedure uses the COMPONENTS pane. 1. Drag-and-drop the desired components onto the work area. 2. Use the mouse to select the components, right click and select CREATE GROUP. The components are grouped together and move as a single unit. BASIC IMAGE BASIC IMAGE adds an image to a graphic. Configuring a BASIC IMAGE This procedure uses the 1.
Graphics Builder 5 Pane tools topic. 4. Click PREVIEW in the upper right corner to display the BASIC IMAGE. ITEM RENDERER ITEM RENDERER uses a program to query for points or equipment in the currently selected location of the building structure. For each point or equipment found, the ITEM RENDERER renders and binds a graphic component, such as a fan or light, and displays the correct number of components.
Graphics Builder 5 Pane tools Configuring an MJPEG image stream This procedure uses the 1. From the PROPERTIES and COMPONENTS panes. COMPONENTS > COMPONENTS pane, drag-and-drop onto the work area. 2. To get the URL for the MJPEG image stream you want to use, right-click on the image and copy the address. – The image at http://www.opentopia.com/webcam/16391 is shown as an example. 3. Select the new MJPEG component. 4. Do the following in the BASIC PROPERTIES pane: a.
Graphics Builder Pane tools 5 MODEL LOADER The MODEL LOADER creates a custom model that can be reused. Configuring a MODEL LOADER This procedure uses the PROPERTIES and COMPONENTS panes. 1. Do the following to create a group of components: a. Drag the desired components onto the work area. b. Use the mouse to select the components, right-click and select CREATE GROUP. 2. In the BASIC PROPERTIES pane, enter a name in the field and click SAVE. 3.
5 Graphics Builder Pane tools Editing a model Note Editing a model creates a new copy of it. You cannot update and save an existing model, and you are not prevented from assigning the same name to multiple models. 1. Select VIEW ASSETS in the command bar. The IMPORT dialog box displays all models and images stored in the device. 2. Select the model you want to edit and click IMPORT. The model is added to the work area. 3. Right-click on the model, select UNGROUP and make the desired edits. 4.
Graphics Builder Pane tools 5 Adding the RACTIVE component This procedure uses the 1. From the 2. In the BASIC PROPERTIES, COMPONENTS and PROGRAMS panes. COMPONENTS > COMPONENTS pane, drag-and-drop onto the work area. PROPERTIES pane, expand RACTIVE EDITOR and click OPEN EDITOR. The RACTIVE EDITOR dialog box displays. 3. Go to the FIN Stack online documentation Web site (https://finproducts.atlassian.net/wiki/spaces/FINStack/pages/91603570/GB+Ractive) and select a custom interface. 4.
5 Graphics Builder Pane tools TIMER The TIMER generates an event at specified intervals. This component is generally used for timing programs. For example, it sets a delay for a program to start or an interval for a program to refresh and continue running. Configuring a TIMER This procedure uses the 1. From the PROPERTIES, COMPONENTS and COMPONENTS > COMPONENTS pane, drag-and-drop PROGRAMS panes. onto the work area and then select it. 2.
Graphics Builder Pane tools 5 7. Click SAVE to save the program and close the PROGRAM EDITOR. The program runs or refreshes at the specified interval. To use a Timer on a Program 1. Click in the PROGRAMS 2. Click in the upper right corner of the PROGRAM EDITOR dialog box. 3. Click at the top of the PROGRAMS VARS pane. 4. Click Settings pane to edit the program. for the new variable and then do the following. a. Type timer in the filter field. b.
5 Graphics Builder Pane tools HTML COMPONENTS CAUTION Minimize links to external URLs. Linking to external URLs, such as Favorites, Web cams and external Web services poses a security risk. ● ● Indicator URLs shall only direct to secure services, such as Web servers hosted by devices in the building automation control network.
Graphics Builder Pane tools 5 ANCHOR The ANCHOR component creates a link to a URL. This is the HTML hyperlink element (). The following table outlines attributes of the ANCHOR component that can be modified in the BASIC PROPERTIES pane. The minimum requirement is an href value. For more information on this element or its attributes, visit https://www.w3schools.com/tags/tag_a.asp.
5 Graphics Builder Pane tools Shape Target Shape of the link Used with the Coords attribute to specify the shape of a link. Not supported in HTML5. Options are: ● default (Default) ● rect ● circle ● poly Where to open the linked document Options are: ● _blank (Default) ● _parent ● _self ● _top ● Framename Note: Select _top for PXM… devices.
Graphics Builder Pane tools 5 BUTTON The BUTTON component is typically used to start an action within a graphic. This is the HTML button element (
5 Graphics Builder Pane tools Formmethod Formnovalidate HTTP method for sending form data Only valid when the Type attribute is set to submit. Specifies how to send the form-data. Options are: ● get (Default) ● post Validate form data on submission Only valid when the Type attribute is set to submit. Switch OFF if the form data should not be validated. Switch ON if form data should be validated. Default: OFF Formtarget Name Form target Only valid when the Type attribute is set to submit.
Graphics Builder Pane tools 5 4. Paste the following code into the SCRIPT EDITOR and click SAVE. var buttonText = this.textContent; if(buttonText == 'On') { this.textContent = 'Off'; } else{ this.textContent = 'On'; } alert('Toggling button to "' + this.textContent + '".'); 5. Click PREVIEW in the upper right corner and click the BUTTON component to test it. H-RULE The H-RULE component is a separating line used to define a thematic break in a graphic. This is the HTML horizontal-rule element (
).Graphics Builder 5 Pane tools The following table outlines attributes of the IMAGE component that can be modified in the BASIC PROPERTIES pane. For more information on this element or its attributes, visit https://www.w3schools.com/tags/tag_img.asp. Attribute Description alt Alternate text Alternate text that will display if the image cannot be displayed. Default: Field is blank. Image border Width of the border (in pixels) around an image. Not supported in HTML5.
Graphics Builder Pane tools 5 INCLUDE The INCLUDE component embeds a Web page into a graphic by setting the src attribute to the Web site’s address. This is the HTML iframe element (
5 Graphics Builder Pane tools Attribute Description frameborder Frame border Displays a border around an
Graphics Builder Pane tools 5 INPUT The INPUT component gathers input from the user, typically in the form of a text-box. This component can also take the form of a text-area, checkbox, file upload, radio buttons, etc. This is the HTML input element (). The following table outlines attributes of the INPUT component that can be modified in the BASIC PROPERTIES pane. For more information on this element or its attributes, visit https://www.w3schools.com/tags/tag_input.asp.
5 Graphics Builder Pane tools Attribute Description autocomplete Enable autocomplete Enables autocomplete for the element. Options are: ● On ● Off autofocus Autofocus switch On = Autofocus is enabled for the element when the page loads. disabled Disabledswitch On = the element is disabled. form Form field Specifies one or more forms the element belongs to. Enter the form_id for each form.
Graphics Builder Pane tools 5 LABEL The LABEL component displays simple text in the graphic. The text attributes, such as size, color and font can be modified in the BASIC PROPERTIES pane for the LABEL component. This is the HTML label element (
5 Graphics Builder Pane tools METER The METER component is rendered as a simple bar. This is the HTML meter element (). The following table outlines attributes of the METER component that can be modified in the BASIC PROPERTIES pane. You can also drag and drop a virtual point onto the METER to display a specific point’s curVal as the value property. For more information on this element or its attributes, visit https://www.w3schools.com/tags/tag_meter.asp.
Graphics Builder Pane tools Attribute Description Disabled Specifies that a drop-down list should be disabled.
Graphics Builder 5 Pane tools 4. Type world in the PROGRAM TARGET FILTER field. 5. Click in the upper right corner of the PROGRAM EDITOR dialog box and select VARIABLES The PROGRAM VARS pane opens. 6. Move your cursor over the row for the this variable and then click . . 7. Set the Invokes the Function? toggle switch to ON. 8. From the SELECT EVENT drop-down list, select CUSTOM EVENT. 9. Type start in the Custom Event Name field and click SAVE. 10.
Graphics Builder Pane tools 5 TEXT AREA The TEXT AREA component displays a text input that is larger than a single line. Typically used to get input from a user for programs within the graphic. This is the HTML text-area element (
5 Graphics Builder Pane tools VIDEO The VIDEO component supports h.264 video. To show a video, the video’s link must be set as the src attribute in the BASIC PROPERTIES pane. This is the HTML video element (
Graphics Builder Pane tools 1 5 4 2 3 4 Fig. 15: SVG GAUGES category. ① Bar Gauges [➙ 120] ② Circle Gauges [➙ 123] ③ Half-circle Gauges [➙ 124] ④ Icon Gauges [➙ 130] Basic workflow 1. Drag-and-drop a gauge from 2. Drag-and-drop a COMPONENTS > SVG GAUGES onto the work area. VIRTUAL POINT onto the gauge. 3. Right click on the chart and select TOOLS > CONFIGURE GAUGE. Use the appropriate table in the following topics. The examples in the following topics show the default colors.
5 Graphics Builder Pane tools Bar Gauges Bar Gauge 1 Fig. 16: Bar gauge 1 example in default configuration. Property Value Rotate Horizontal or vertical bar. ① Border Color Color of the border around the gauge. Default: #000000. ② Text Color Color of the value. Default: #000. ③ Number Color Color of Min Value and Max Value.Default: #000. ④ Gradient Color 1 Gradient color on the left (top for vertical). Default: #8B90C7 ⑤ Gradient Color 2 Gradient color in the middle.
Graphics Builder Pane tools ① Property Value Rotate Horizontal or vertical bar. Min Value Lowest value displayed on the gauge. 5 Default: minVal of the virtual point if one exists. Otherwise, the default is 0. ② Max Value Highest value displayed on the gauge. Default: maxVal of the virtual point if one exists. Otherwise, the default is 100. ③ Number Color Color of Min Value and Max Value. ④ Low Range Color Color of the bar when the value is less than the specified Mid Range.
Graphics Builder 5 Pane tools Bar Gauge 4 Fig. 19: Bar Gauge 4 example in default colors. ① Property Value Rotate Horizontal or vertical bar. Color Color of the bar. Default #29ABE2. Min Value Lowest value displayed on the gauge. Default: minVal of the virtual point if one exists. Otherwise, the default is 0. Max Value Highest value displayed on the gauge. Default: maxVal of the virtual point if one exists. Otherwise, the default is 100.
Graphics Builder Pane tools 5 Circle Gauges Circle Gauge 1 Fig. 21: Circle Gauge 1 example in default colors. Property Value ① Short Name Name displayed with the gauge. If shortName is if blank, navName of the virtual point is displayed. ② Needle Color Color of the needle. ③ Dot Color Color of the dot behind the needle. ④ Min Value Lowest value displayed on the gauge. Default: minVal of the virtual point if one exists. Otherwise, the default is 0.
5 Graphics Builder Pane tools Property Value ① Short Name Name displayed with the gauge. If shortName is if blank, navName of the virtual point is displayed. ② Needle Color Color of the needle (behind the gradient). ③ Min Value Lowest value displayed on the gauge. Default: minVal of the virtual point if one exists. Otherwise, the default is 0. ④ Max Value Highest value displayed on the gauge. Default: maxVal of the virtual point if one exists. Otherwise, the default is 100.
Graphics Builder Pane tools 5 Half-circle Gauge 2 Fig. 24: Half-circle Gauge 2 example in default colors. Property Value ① Short Name Name displayed with the gauge. If shortName is if blank, navName of the virtual point is displayed. ② Text Color Color of the main value. ③ Number Color Color of the numbers. ④ Needle Color Color of the needle. ⑤ Min Value Lowest value displayed on the gauge. Default: minVal of the virtual point if one exists. Otherwise, the default is 0.
5 Graphics Builder Pane tools Property Value ① Short Name Name displayed with the gauge. If shortName is if blank, navName of the virtual point is displayed. ② Text Color Color of the text displaying the value. ③ Needle Color Color of the needle. ④ Min Value Lowest value displayed on the gauge. Default: minVal of the virtual point if one exists. Otherwise, the default is 0. ⑤ Max Value Highest value displayed on the gauge. Default: maxVal of the virtual point if one exists.
Graphics Builder Pane tools 5 Half-circle Gauge 5 Fig. 27: Half-circle Gauge 5 example in default colors. Property Value ① Short Name Name displayed with the gauge. If shortName is if blank, navName of the virtual point is displayed. ② Accent Color Color of the horizontal line, semi-circle, and needle. ③ Text Color Color of the text inside the semi-circle. ④ Min Value Lowest value displayed on the gauge. Default: minVal of the virtual point if one exists. Otherwise, the default is 0.
Graphics Builder 5 Pane tools Property Value ① Short Name Name displayed with the gauge. If shortName is if blank, navName of the virtual point is displayed. ② Background Color Color of the gauge. ③ Number Color Color of Min Value and Max Value. ④ Needle Color Color of the needle. ⑤ Accent Color Color of the tic marks inside the gauge. ⑥ Text Color Color of the navName/Short Name and curVal. ⑦ Min Value Lowest value displayed on the gauge.
Graphics Builder Pane tools Property Value ⑦ Text Color Color of the curVal inside the needle. ⑧ Min Value Lowest value displayed on the gauge. 5 Default: minVal of the virtual point if one exists. Otherwise, the default is 0. ⑨ Max Value Highest value displayed on the gauge. Default: maxVal of the virtual point if one exists. Otherwise, the default is 100. Show Background Select to make the background opaque and display a frame around the gauge. Table 57: Half-circle Gauge 7 dialog box.
Graphics Builder 5 Pane tools Property Value ⑦ Needle Color Color for the needle. Default #1b75bc ⑧ Min Value Lowest value displayed on the gauge. Default: minVal of the virtual point if one exists. Otherwise, the default is 0. ⑨ Max Value Highest value displayed on the gauge. Default: maxVal of the virtual point if one exists. Otherwise, the default is 100. Select to make the background opaque and display a frame around the gauge. Show Background Table 58: Half-circle Gauge 8 dialog box.
Graphics Builder Pane tools 5 Other Icon Gauges Fig. 32: Other Icon Gauge examples. Property Value Text Color Color of text. (Only displays when Show Label is selected.) Color Color of the icon fill. Short Name Name displayed with the gauge. If shortName is if blank, navName of the virtual point is displayed. Min Value Lowest value displayed on the gauge. Default: minVal of the virtual point if one exists. Otherwise, the default is 0. Max Value Highest value displayed on the gauge.
Graphics Builder 5 Pane tools 5.2.3 LAYERS The LAYERS pane displays a hierarchical structure for all the components in a graphic. Components at the top of the list are in the top layer of the graphic. Components lower in the list are in lower layers of the graphic. Components can be added to a layer or moved to a different layer by dragging-and-dropping. Indicator Name Description Show/Hide Shows or hides components on the graphic.
Graphics Builder Pane tools 5 Adding a component to a layer 1. In the LAYERS pane, select the layer to which the component is being added. 2. Drag-and-drop an element from the COMPONENTS pane onto the selected layer. For example, select the Energy layer in the Sample dashboard public graphic and drag-and-drop an HTML COMPONENT onto it. Moving a component to a different layer 1. In the LAYERS pane, select the component to move. 2. Drag-and-drop the component onto the desired layer.
5 Graphics Builder Pane tools Creating a smart label A smart label displays information about a data point and allows users with the appropriate access to command objects. If desired, command access for a smart label can be changed to read-only. Creating a smart label and modifying the command status This procedure creates a smart label and changes the command status to read-only. 1. Drag-and-drop data points onto the work area. Press CTRL and click to select multiple data points.
Graphics Builder Pane tools 5 3. Click and then to display the updated smart label. The smart label now has command access. Binding data points to a graphic component To bind data points to a graphic component, drag-and-drop the data point from the VIRTUAL POINTS pane onto the graphic component. Fig. 35: Binding a data point to a graphic component.
5 Graphics Builder Pane tools Renaming a virtual point To rename the virtual point within the graphic, modify the text in the Name field. This only changes the virtual point name in the current graphic. Working with data points that have the same name NOTICE Adding multiple data points with an indistinct name, such as valve, without using REFORMAT NAME creates a nested structure in the VIRTUAL POINTS pane.
Graphics Builder Pane tools 5 Deleting a nested structure If you accidentally create a nested structure in the VIRTUAL POINTS 1. Collapse all levels of the tree in the VIRTUAL POINTS pane, do the following to delete it: pane. 2. Select the virtual point at the main level in the VIRTUAL POINTS pane and click Minus to delete it. The nested virtual point is now at the main level in the pane. 3. Select the remaining virtual point and click Minus to delete it. The nested structure is deleted. 4.
5 Graphics Builder Pane tools Adding a new tag or property tag 1. Click for the data point and select ADD PROPERTY. 2. If necessary, change the property type. ADVANCED PROPERTIES 3. Name the tag. 5.2.5 EQUIPMENTS The EQUIPMENTS pane allows you to select objects from your building hierarchy that represent a value, setpoint or status. To automatically create a smart label with an absolute binding, drag-and-drop an object onto the graphic. Data point binding [➙ 59] Fig. 37: EQUIPMENTS pane.
Graphics Builder Graphics libraries 5 5.3 Graphics libraries The Graphics Builder program on your Desigo Control Point device contains the following graphics libraries: ● Supersample graphics [➙ 139] ● Graphics models ● Graphics components [➙ 141] Note Graphics models cannot be used with BACnet/IP systems. The pre-built components in this library rely on tags that are applied to data points in Siemens applications. Therefore, detailed information for graphics models is not provided in this manual.
5 Graphics Builder Graphics libraries 5.3.1.1 Pre-loaded supersample graphics library This section outlines the graphics that are pre-loaded in Desigo Control Point devices. Graphic type Characteristics Primary supersample ● ● Application example Dashboard template ● ● Use with PXC4/5 controllers: – Datapoint binding must be redone. – Relativization to be done by shortName. Use with BACnet standard devices: – Datapoint binding must be redone. – Relativization to be done by navName.
Graphics Builder Graphics libraries 5 Example graphic name Application program example Style Description Sample NG AHU_ERC_HC_TP Ahu21 2D+ / 2D AHU; ERC (rotary); speed-controlled fans; chilled water cooling coil; hot water heating coil; shutoff dampers. Sample NG DHW_DhwHyd Dhw21 2D+ / 2D Domestic hot water: with demand-controlled heating and controller storage tank charging. Sample NG HGEN_2Bo HGen21 2D+ / 2D Heat generation: two boilers; modulating burner; single-stage burner.
5 Graphics Builder Graphics libraries Category Description Siemens 2D air Cooling and heating coils, dampers, detectors, duct components, energy recovery exchangers, humidifiers and sensors. 2D cooling Condenser, evaporators, chiller element exchanger, compressor and cooling tower. 2D electrical Lights. 2D heating Boiler and burners. 2D HVAC Detectors, sensors, pumps and valves. 2D room Presence and window detectors and room sensors. 2D services Fire, heat and smoke detectors and meter.
Graphics engineering Using supersample graphics 6 6 Graphics engineering Plant view graphics are created using the Graphics Builder application, which is accessed through Desigo Control Point when working online, and through ABT Site when working offline. Graphics Builder contains sample graphics and additional tools to help you easily create graphics to meet the needs of your facility.
Graphics engineering 6 Using supersample graphics Customizing the graphic 1. Delete the components and smart labels that do not apply to your system. 2. (Optional) Do the following to add graphic components: – Drag-and-drop graphic components from the COMPONENTS pane onto the work area. Graphics components [➙ 141] – Drag-and-drop the appropriate data point from the EQUIPMENTS pane onto each new graphic component. 3.
Graphics engineering Using supersample graphics 6 Modifying the data point binding This procedure creates a Relative by navName binding for the graphic components. 1. Individually select each component and smart label in the graphic, right-click, and select TOOLS > RELATIVIZE. The Component binding options dialog box displays. 2. In the Top Equip section, select a location in the building hierarchy where the graphic will be used.
6 Graphics engineering Optimizing graphics for PXM touch panels and standard devices 6.2 Optimizing graphics for PXM touch panels and standard devices This topic provides tips for creating graphics that are displayed on a touch panel. The Scale to fit setting in the BASIC PROPERTIES defines how the graphic is rendered on the operating client.
Graphics engineering Dashboards 6 3. Do one of the following: – To upload a new image, click Choose File and select the screen capture that was saved to your computer. – To select an image already on the device, click the Existing Image field to select a file and select the Use existing image check box. 4. Click Apply. 5. Click SAVE and close the graphic. 6.
6 ① Graphics engineering Dashboards Energy and maximum power demand (bar and line chart) Created with the AM chart component. ⓐ Electrical energy generation and consumption. ⓑ 15-minute average maximum power demand for the selected reporting interval ⓓ. ⓒ Reporting period selection (Year, Month, Week, Day). ⓓ Reporting interval. When the reporting period is changed, the corresponding interval is automatically displayed (Month, Day, Day, Hour).
Graphics engineering Dashboards 6 1. Saving a copy of the sample graphic Plant view is selected and you are working at the Root level of the building hierarchy. 1. Open the Sample dashboard facility manager graphic. 2. Select > > Configure graphics > . Graphics Builder opens the Facility manager dashboard graphic in a new tab. 3. In Graphics Builder, select MENU > SAVE AS GRAPHIC, enter a unique file name and click SAVE. When using SAVE AS GRAPHIC, always choose a unique graphic name.
6 Graphics engineering Dashboards 1. In the VIRTUAL POINTS pane, click for the energy consumption data point and select ADD PROPERTY. A string tag is added. 2. Scroll down to find the new property, change its name to forMaxPower and click 3. Click and select BOOLEAN to change the property type. 4. Set the toggle switch to true (ON) and click 5. Click . . and SAVE to save the graphic. 3.
Graphics engineering Dashboards 6 2. Drag-and-drop the group of data points onto the chart. A new virtual point is created for each Present value point . The following message displays: Retrieve History From Point(s)? 3. Click No. 4. For each Present value point a. In the VIRTUAL POINTS string tag in the chart, do the following to change its label: pane, click to expand the point and scroll down to the displayName . b.
6 Graphics engineering Dashboards 6.4.2 Public dashboard The Sample dashboard public graphic is designed for use in public spaces to share information about a building. This graphic contains three dashboard layers—Weather, Energy and Water—and a navigation bar at the top to navigate between the layers. The Weather layer is the default view. ① Navigation bar (MainLayer) Contains the date and time display, the tabbed buttons and the company logo. This layer is always visible.
Graphics engineering Dashboards 6 Displaying the Energy and Water layers for editing The Sample dashboard public graphic contains three dashboard layers and a navigation bar at the top to navigate between the layers. When editing this graphic, you may need to click Show/hide in the LAYERS pane to display the layer to edit. The Weather layer is the default view. 1. Click to hide the Weather layer and display a different layer for editing. 2.
6 Graphics engineering Dashboards 6. In the BASIC PROPERTIES, expand RACTIVE EDITOR and click OPEN EDITOR. The RACTIVE EDITOR dialog box opens with the TEMPLATE tab displayed. 7. Paste the new HTML code in the TEMPLATE tab. 8. To scale the widget to fit the dashboard frame, change the width and height to 100% instead of px. 3.
Graphics engineering Dashboards 6 For more information on adding a trend definition, see the Trends tools section of the Desigo Control Point Operation Manual (A6V11211557). BT Download Center b. Adding a trended data point to the Energy and Water layers 1. In the LAYERS pane, click to display the layer to edit. For example, hide the Weather layer and display the Energy layer. Displaying the Energy and Water layers for editing [➙ 153] 2.
6 Graphics engineering Dashboards Fig. 39: Elements of the Ractive components that display resource consumption. ① The Ractive component ② fillColor The color of the icon. You can use any of the 140 valid CSS color strings supported by modern browsers. In this case, it’s red. numIcons The number of icons displayed. In this case, it’s 10. The number of icons displayed in color represents the average daily consumption as a percentage of the maximum daily consumption over the last four weeks.
Graphics engineering Dashboards 6 Modifying the Energy and Water resource consumption graphics This procedure modifies the Ractive component that compares the building’s resource consumption to common household devices. This procedure uses the PROPERTIES and LAYERS panes 1. Open the Sample dashboard public graphic for editing. 2. Click to hide the Weather layer and to display the Energy or Water layer. 3. Select the 4. In the BASIC Ractive component.
6 Graphics engineering Dashboards 1. Open the Sample dashboard public graphic for editing. 2. Click at the bottom of the LAYERS pane to add a new layer to the pane. 3. Select the new layer and modify the Name field in the BASIC 4. Select ADVANCED PROPERTIES and click 5. Name the new tag mode and click PROPERTIES pane. at the bottom of the pane to add a new tag. . 6. Select the value for the mode tag (initially named NewValue), change it to the name of the tab and click .
Graphics engineering Dashboards 6 Adding a button to the navigation bar 1. Drag-and-drop a Button from COMPONENTS > HTML COMPONENTS onto the MainLayer in the LAYERS pane. 2. Drag the Button to the desired position in the MainLayer hierarchy. For example, between the Energy and Weather buttons. 3. Do the following in the BASIC PROPERTIES pane to make the new button match the existing dashboard design: a. Select an existing button and copy the Classes value.
6 Graphics engineering Dashboards b. Paste the value into the Classes field of the new button. For more information on using Classes to change the button style, see the J2 Graphics Builder documentation (https://finproducts.atlassian.net/wiki). c. Change the POSITION & SIZE values to match the existing dashboard design. BASIC PROPERTIES [➙ 72] d. If desired, use the other BASIC PROPERTIES to modify the appearance of the button. 4.
Graphics engineering Dashboards 3. Drag-and-drop a Label from 6 COMPONENTS > HTML COMPONENTS onto the work area. 4. Select the Label and do the following in BASIC PROPERTIES: – Scroll to the Text field at the bottom of the pane to edit the label text. – Expand FONT to modify the text appearance. – If desired, use the other BASIC PROPERTIES to modify the appearance of the label. PROPERTIES [➙ 71] 5. Click to return the Weather layer to the default view. 6. Click and SAVE to save the graphic.
Graphics engineering 6 Dashboards 3. Expand the layer you are editing. 4. If you are replacing an existing background image, right-click on the image in the LAYERS pane and select DELETE. 5. Make sure the layer you are editing is still selected. 6. Do one of the following: – – If the image is already in the database, click VIEW ASSETS, select the image, and click Import.
Graphics engineering Dashboards 6 6.4.5 Adding information from a trended data point Information from a trended data point can be displayed in a summary graphic, such as a pie chart, or in a comparison chart, such as those displayed in the Energy and Water tabs of the Public dashboard. NOTICE For optimum system performance, do the following when defining trends for data points that are used in dashboards: ● ● ● Select the longest possible interval for saving data that is suitable for the application.
Graphics engineering 6 Dashboards 6.4.5.1 Changing the refresh interval for a trended data point By default, data linked to the Energy and Water layers of the Public dashboard is refreshed every three hours. To use a different refresh interval, edit the Delay property of the Timer control for the layer. Changing the refresh interval This procedure uses the PROPERTIES and LAYERS panes. 1. Open the Sample dashboard public graphic for editing. 2.
Graphics engineering Dashboards 6 6.4.6 Adding external media to a dashboard External media, such as a YouTube video, can be embedded in a dashboard by using an HTML inline frame (
6 Graphics engineering Dashboards 6. In the BASIC PROPERTIES, expand RACTIVE EDITOR and click OPEN EDITOR. The RACTIVE EDITOR dialog box opens with the TEMPLATE tab displayed. 7. Paste the HTML code in the TEMPLATE tab. 8. To scale the widget to fit the dashboard frame, change the width and height to 100% instead of px.
Graphics engineering Dashboards 6 6.4.7 Working with gauges A gauge displays the present value of a data point. The following figure outlines the BASIC PROPERTIES that control the appearance of a gauge. Fig. 40: Gauge BASIC PROPERTIES. Property Description Property can be modified ① Gauge color Background color for the gauge. Yes ② Label color Color of the Label text. Yes Label text Subtitle for the gauge. This is a free text field. Yes ③ Maximum Maximum value for the gauge.
Graphics engineering 6 Dashboards Property Description Property can be modified ⑦ Unit Unit of measure for the Value. The Value color also applies to this field. No When a BACnet object is dropped onto the gauge, the unit of measure for the object is automatically entered in the Unit field. ⑧ Gauge fill The color displayed indicates if the present No value is in the minimum range (green), moderate range (yellow-to-orange) or maximum range (red). Table 72: Gauge BASIC PROPERTIES. 6.4.7.
Graphics engineering Dashboards 6.4.7.2 6 Adding a gauge 1. Open the graphic for editing and display the COMPONENTS and EQUIPMENTS 2. From the COMPONENTS onto the work area. 3. In the EQUIPMENTS pane, drag-and-drop a Gauge pane, navigate to the Present value data point panes. that is the source for the gauge. 4. Drag-and-drop the Present value point 5. Click onto the gauge. and SAVE to save the graphic. The gauge has been added to the graphic.
6 Graphics engineering Dashboards 6.4.7.3 Changing the data source This procedure modifies the data source for a gauge. This procedure uses the EQUIPMENTS and 1. Open the graphic for editing and click 2. In the LAYERS panes. in the EQUIPMENTS pane, navigate to the LAYERS pane to display the layer with the gauge. Present value data point that is the source for the gauge. 3. Drag-and-drop the Present value point onto the gauge. Note: Do not select the name of the 4. Click Equipment.
Graphics engineering Dashboards 6 6.4.8 Editing charts Charts display historic values from various data points and may contain complex calculations. 6.4.8.1 Working with pie charts Complete the following steps to add a pie chart. Workflow step ① Adding an AM chart ② Adding data points to the chart ③ Copying the program ④ (Optional) Modifying the chart labels This workflow uses the COMPONENTS, VIRTUAL POINTS and EQUIPMENTS panes. ① Adding an AM chart 1.
6 Graphics engineering Dashboards ② Adding data points to the chart 1. In the EQUIPMENTS pane, press CTRL and click to select all the Present value data points that are the source for the chart. Note: All the data points must be assigned together. They cannot be added one-by-one. A star displays to indicate that a data point is selected. 2. Drag-and-drop the group of data points onto the chart. A new virtual point is created for each Present value point .
Graphics engineering 6 Dashboards 4. Click in the upper right corner of the PROGRAM EDITOR dialog box and select VARIABLES The PROGRAM VARS pane opens. 5. Move your cursor over the row for the this variable and then click . . 6. Set the Invokes the Function? toggle switch to ON. 7. From the SELECT EVENT drop-down list, select CUSTOM EVENT. 8. Type start in the Custom Event Name field and click SAVE. 9. Do the following to copy the program from the Sample dashboard facility manager graphic: a.
6 Graphics engineering Dashboards ④ (Optional) Modifying the chart labels By default, the displayName string tag for each data point is displayed as the label in the chart. Complete this procedure for each label to be modified. 1. In the VIRTUAL POINTS pane, find the data point for the label to be modified and click to display all of its tags. 2. Scroll down to the displayName string tag and select its value. (In the figure, the value is initially named Present value.) 3.
Graphics engineering 6 Dashboards 6.4.8.2 Adding a bar or line chart Use the workflow in this section to add a bar chart. Workflow step ① Adding an AM chart ② Adding data points to the chart ③ Copying the program ④ Displaying the Daily Max Power line This workflow uses the COMPONENTS, VIRTUAL POINTS and EQUIPMENTS panes. ① Adding an AM chart 1. From COMPONENTS > COMPONENTS, drag-and-drop 2. Click to add a new string tag 3. Name the string tag onto the graphic. . barChart and click .
6 Graphics engineering Dashboards 8. Type start in the Custom Event Name field and click SAVE. 9. Do the following to copy the program from the Sample dashboard facility manager graphic: a. Go to Desigo Control Point and display the Sample dashboard facility manager graphic. b. Select > > Configure graphics > . The Sample dashboard facility manager graphic opens in Graphics Builder. c. In the PROGRAMS pane, select for the program you are copying. For example, Pie Chart Program. d.
Graphics engineering Dashboards 1. In the VIRTUAL POINTS pane, click 6 for the energy consumption data point and select ADD PROPERTY. A string tag is added. 2. Scroll down to find the new property, change its name to forMaxPower and click 3. Click and select BOOLEAN to change the property type. 4. Set the toggle switch to true (ON) and click 5. Click . . and SAVE to save the graphic.
7 Advanced functionality Modifying the binding option for multiple points 7 Advanced functionality The procedures in this section assume you have the following knowledge: ● Programming ● Javascript ● BACnet 7.1 Modifying the binding option for multiple points Use this procedure to modify the binding option for multiple points. For example, when you’re using a supersample graphic to create a graphic that uses Relative by navName binding.
Advanced functionality 7 Show/Hide a graphic component based on data point status 7.2 Show/Hide a graphic component based on data point status 1. Add a graphic component to the graphic. 2. Drag-and-drop the data point to bind it to the graphic component. 3. Select the graphic component and click . 4. In the ADD TAGS dialog box, enter a name for the program that will run, for example, alarmIcon. 5. Click . 6. Open the PROGRAMS pane and click to add a new program. 7.
7 Advanced functionality Integrating Web cams The following screen capture is an example of the finished program. 7.3 Integrating Web cams This section provides tips for adding a video component to a graphic. CAUTION Minimize links to external URLs. Linking to external URLs, such as Favorites, Web cams and external Web services poses a security risk.
Advanced functionality Creating custom components 3. In BASIC 7 PROPERTIES, enter your IP/URL video link in the Source field. For example, http://pr_nh_webcam.axiscam.net:8000/mjpg/video.mjpg?resolution=704x480 4. (Optional) Adjust the Delay (Ms) value to change the refresh rate. 5. When you are finished editing, click . 7.4 Creating custom components The Animation editor allows you to create your own components using your own images.
7 Advanced functionality Creating custom components Guidelines for adding images to the database ● Before adding any images to the database, select VIEW ASSETS in the command bar and verify the following: ● – The image is not already in the database. – Imported images are clearly labeled and the file name makes sense. To add images to the database, drag the files from your local computer and drop them on any graphic in Graphics Builder.
Advanced functionality Creating a button to command multiple data points 7 6. From the Animation Type drop-down list, select the type of animated image to create and click APPLY. 7. Select VIEW ASSETS and choose an image for each state of the animated sequence. 8. Click APPLY when an image has been selected for each state. 7.5 Creating a button to command multiple data points ● ● ● ● This program is invoked when a button with the property writeVal is clicked. At runtime, the program variable this.
7 Advanced functionality Creating a button to command multiple data points 3. Name the new tag writeVal and click . 4. Scroll down to locate the writeVal tag in the list. 5. Select the value for the writeVal tag (initially named NewValue), change it to the value to which the data points will be commanded and click .
Advanced functionality Creating a button to command multiple data points This procedure uses the PROGRAMS 1. Click 7 pane. at the bottom of the PROGRAMS pane to add a new program. 2. In the PROGRAM TARGET FILTER field, enter the name of the string tag . (In this case, writeVal.) 3. Copy the desired sample lines of program code from the following table and paste them into the first line of the PROGRAM EDITOR. 4.
7 Advanced functionality Creating a button to command multiple data points Program code for different point commands Command Description Command multiple data points ● readALL() searches the entire database and returns all records that match the query parameter. This example queries for any numeric writable data points. Replace this query as desired to find the points to be commanded. Refer to the section on binding for additional information on using tag queries (for example.
Advanced functionality Creating a button to command multiple data points Command Description Release ALL dampers ● readAll() searches the entire database and returns multiple records. ● The parameter to readAll is a tag query that functionally describes some point or set of points. ● readAll() is using a semantic tag query to find any points matching some description (possibly more than one point). ● The parameter to readAll is a tag query that functionally describes some point or set of points.
7 Advanced functionality Creating a button to command multiple data points Additional hints Graphics in the Supersample graphics library may contain functionality that you want to use in your own program. In particular, the program statusIndicatorProg may be helpful. Do the following to display the code for any program in a graphic: 1. Select > > Configure graphics > Edit. 2. Select a Supersample graphic and click Edit. 3. In the PROGRAMS pane, move your cursor over the program name and click .
Tips and tricks Updates required after a time zone change 8 8 Tips and tricks 8.1 Updates required after a time zone change The following updates must be made if the time zone of the Desigo Control Point device is changed: ● You must reboot the device. Otherwise, the calendar in the Scheduler does not display correctly. ● Any online trends must be redefined. Otherwise, an error similar to the following displays. – If desired, click Details to display the error message in a text file.
8 Tips and tricks Graphic components within models cannot be modified 8.3 Graphic components within models cannot be modified When you use a model from the COMPONENTS view, it displays in the LAYERS view as one object. The graphic components in the model cannot be selected and modified. For example, if a model with a fan is selected, you cannot select the states in which the fan should display with animation. 8.
Tips and tricks Relative hyperlinks cannot be added to a graphic at the Root level 8 8.5 Relative hyperlinks cannot be added to a graphic at the Root level When adding a Relative hyperlink to a graphic at the Root level of the hierarchy, the Add hyperlinks dialog box closes when you click OK in the first step of the process. Specific hyperlinks can be added to a graphic at the Root level of the hierarchy. To reuse the graphic at a different site, the binding must be manually updated. 8.
8 Tips and tricks Detection of network interruptions CAUTION When creating user accounts that do not automatically log off, restrict system access to specific functions. To prevent unauthorized access to other system functions, create separate user accounts for engineering graphics and operating a kiosk. 8.8 Detection of network interruptions Only network interruptions longer than 30 seconds are detected and indicated in the user interface. 8.
Index Index editing file properties ........................................ 27 removing files.................................................... 27 uploading files ................................................... 26 Symbols $id variable .............................................. 63, 67, 70 A add email recipients ................................................. 18 tags after data point integration ........................ 53 user profile ........................................................
Index S SAVE AS GRAPHIC ............................................ 72 scale to fit .......................................................... 146 settings alarm history ..................................................... 21 alarm poll rate ................................................... 21 alarm routing ..................................................... 22 slideshow of graphics .......................................... 42 U uploading documents ...........................................
Issued by Siemens Industry, Inc. Smart Infrastructure 1000 Deerfield Pkwy Buffalo Grove IL 60089 +1 847-215-1000 © Siemens Industry, Inc., 2020 Technical specifications and availability subject to change without notice.