Building Operator Engineering Guide A6V11881627_en_i 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. Noncompliance 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.
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.
Table of Contents Table of Contents ..................................................................................................4 1 Building Operator Engineering Guide ...........................................................5 1.1 Overview..........................................................................................................5 1.2 Setting Up Connect Device and Building Operator .........................................7 1.1.1 1.3 1.4 1.5 4 | 66 Before You Start .........
Building Operator Engineering Guide Overview 1 1 Building Operator Engineering Guide 1.1 Overview This document is intended for Administrators and Engineers in the Building Operator application. The instructions in this document will cover how to connect building automation controls, that reside within a corporate IT network on site, to Building Operator application, using the Connect device gateway. 1.1.
1 Building Operator Engineering Guide Overview In the Network tab, you can configure IP settings, firewall, route and proxy settings. There are four sub-tabs to individually complete these tasks: – IP Settings: You can configure local area network (LAN) settings here or add new IP setting in the fields provided. – Firewall: Here you can add or remove different inbound and outbound rules for Connect devices. – Route: Don’t change anything in the Route tab. If you do, you risk losing cloud connectivity.
Building Operator Engineering Guide Setting Up Connect Device and Building Operator 1 CAUTION If you reset the Connect device to the factory settings, the network settings and the configured project data will be lost. The device must be commissioned again. 1.2 Setting Up Connect Device and Building Operator The instructions in this document will cover how to properly commission the Connect device, as well as establish remote web access.
1 Building Operator Engineering Guide Setting Up Connect Device and Building Operator Account Manager ☐ Signing Up Before using Building Operator, you need to ☐ Activating Subscription create a Siemens ID account, activate your ☐ Creating a Company subscription, create a ☐ Choosing a Product company, and choose your feature packages using Account Manager. See Building Operator User Guide (A6V11881696) on how to get started.
Building Operator Engineering Guide 1 Setting Up Connect Device and Building Operator ☐ Adding Tags to Data Points device to add equipment, data points, and alarms. ☐ Determining BACnet Write Priority for Points ☐ Restarting Connect Device to Update Data Point Information ☐ Configuring Alarms in Building Operator Discovery ☐ Backing Up and Restoring a Building Operator Discovery Database 1.2.
1 Building Operator Engineering Guide Setting Up Connect Device and Building Operator ➅ Display Port Interface (unused) ➆ Serial interface, 9-pin for RS 232, EIA-422, EIA-485 (unused) ➇ X1P1 = LAN (customer network) Ethernet 10/100/1000 Mbps (with 2 LEDs per port for indicators) ➈ X2P1 = LAN (internet access) Ethernet 10/100/1000 Mbps (with 2 LEDs per port for indicators) There are multiple LED lights on the Connect device. The table below outlines each light’s function: 1.
Building Operator Engineering Guide Setting Up Connect Device and Building Operator 1 5. Sign in again with the newly created password. 1.2.3 Choosing network and activating Connect Device After you sign in to the Connect device, complete the following instructions: ◈ Select a network connection mode. The two options are as follows: – Separate network mode: Select this option if your building automation network and Internet use two different physical network connections.
1 Building Operator Engineering Guide Setting Up Connect Device and Building Operator CAUTION This selection is not reversible. A factory reset is required to change this selection, which will result in loss of existing network configuration and project data. 1. The following warning message will display if you select Single network mode. See the Cybersecurity Guidelines (A6V11852371) document for further details. 2.
Building Operator Engineering Guide Setting Up Connect Device and Building Operator 1 Device cloud connection may appear as offline. Troubleshooting If your Connect device does not properly register or the Cloud Connectivity state shows disconnected, follow these steps: 1. Power off the gateway device. 2. Check if your WAN port Internet connectivity is ON. 3. Power on the gateway device. 4. Directly connect your PC to the LAN port via 169.254.169.254 5.
1 Building Operator Engineering Guide Setting Up Connect Device and Building Operator – To add a site through the Sites tab, click Add. 2. Fill in the fields on the ensuing form appropriately. Click Add. 3. A message will appear when the site is successfully added.
Building Operator Engineering Guide Setting Up Connect Device and Building Operator 1 The Address field will automatically suggest addresses. Selecting a suggested address will automatically populate the Time Zone field. If Google API is unavailable, you will need to enter in an address and time zone manually. Adding and activating device After adding a site, in Asset Manager: 1. In the Sites tab, select the site where you want to add your device. 2. Select Add. 3.
1 Building Operator Engineering Guide Setting Up Connect Device and Building Operator When defining or changing the custom name of the device, it will only affect the display name in the cloud. 5. A message will appear that the device was successfully added. When defining or changing the custom name of the device, it will only affect the display name in the cloud.
Building Operator Engineering Guide Setting Up Connect Device and Building Operator 1 1. In the sites tab, select the site with the Connect device you want to assign a distribution to. 2. In the list of devices, select the device. 3. Navigate to the Applications tab. A pop up will appear. 4. In the pop-up, select the distribution set and distribution version. Click Save. 5. After saving, a message will indicate if the distribution was successfully assigned.
1 Building Operator Engineering Guide Setting Up Connect Device and Building Operator 5. Verify the applications and distribution set you want to update. Click Update to confirm. 6. To verify the update, navigate to the services tab, and find the status of your application. Update Operating System To update the operating system of the Connect device, follow the steps below. In Asset Manager: 1. In the sites tab, select the site with the Connect device you want to update. 2.
Building Operator Engineering Guide 1 Setting Up Connect Device and Building Operator 4. Click Update to confirm. 5. After the update is downloaded and installed, a message will appear on the screen when the device is successfully updated. The operating system update could take approximately 20 minutes depending on your network bandwidth. Ensure that the download rate of your network bandwidth is at least 8Mbit/second, or else the update will likely time out. Wait before proceeding to the next step.
1 Building Operator Engineering Guide Setting Up Connect Device and Building Operator 1.2.5 Verifying the Registration State and Software Updates (Optional) In Connect device: 1. To check the status of all applications on the Connect device, select the Operation tab in the top navigation bar. 2. Select the caret icon to expand the Applications menu. Ensure all applications have green dots next to their names.
Building Operator Engineering Guide 1 Setting Up Connect Device and Building Operator Separate Network Mode Description Protocol Source Port Modbus devices tcp BACnet IP devices Destination Interface Target 502 lan0 accept udp 47808 lan0 accept Building Operator Discovery Web-client tcp 8085 lan0 accept Default all RETURN Single Network Mode Description Protocol Source Port Modbus devices tcp BACnet IP devices Destination Interface Target 502 wan0 accept udp 47808 wa
1 Building Operator Engineering Guide Setting Up Connect Device and Building Operator 1. Under Network, in the Tunnel tab click Edit. 2. Click Add. 3. Enter the Name, Description, and URL. See the table below for possible configurations. 4. Click Save. 22 | 66 Name Description URL Building Operator Discovery FIN http://127.0.0.1:8085 TechOp & Daily Op S1 http http://192.168.251.206:80 TechOp S2 https https://192.168.251.207:4 43 Niagara N4 JACE https://192.168.251.
Building Operator Engineering Guide 1 Setting Up Connect Device and Building Operator 1.2.8 Migrating Legacy to new remote web access We are about to discontinue the legacy remote access solution by 2021, March 31. Please move the endpoint configuration from edit site page to Connect UI network settings latest by that date. For more information, see Enabling Remote Web Access in Connect Device UI [➙ 21]. Remote web access to the Connect device web interface will automatically be added to your device.
1 Building Operator Engineering Guide Setting Up Connect Device and Building Operator The Building Operator Discovery Tool and Connect device are pre-configured to work. You do not need to edit these fields. Gateway software must be version 4.0.5 or higher to use the Remote Access Web Feature for Building Operator Discovery. 1.2.
Building Operator Engineering Guide 1 Adding Data Points Using Building Operator Discovery 1.3 Adding Data Points Using Building Operator Discovery Building Operator Discovery is an engineering tool embedded on Connect device to configure and provision data points for Building Operator. 1.3.1 Logging in to Building Operator Discovery Remotely You can log in to Building Operator Discovery remotely, or locally. The instructions below outline how to log in remotely.
1 Building Operator Engineering Guide Adding Data Points Using Building Operator Discovery 4. A new tab will open in the browser. Log in using the following credentials (casesensitive): – – Username: admin Password: admin 5. (Recommended) After you first log in to Building Operator Discovery, you may want to create a more secure password. Find and select the username dropdown in the top-right corner, then select Change Password. Complete the fields from the pop-up and select Apply.
Building Operator Engineering Guide Adding Data Points Using Building Operator Discovery 1 6. Once you’ve created a more secure password, find and select Open Project. 7. A new tab will appear. Select the menu icon in the top left of the screen. 8. Select DB Builder. If your remote connection is interrupted during this session, select Disconnect in Building Operator. Re-start the Remote Web Access process again. 1.3.
1 Building Operator Engineering Guide Adding Data Points Using Building Operator Discovery Before you organize the device view, first change the time zone in My Site to the time zone your device resides in. To do so: 1. IMPORTANT! Add or change the country and time zone. This is the time zone you set for points – and their associated historical data – in Building Operator. The field is called “tz.” Once you’ve set the site to the right time zone, you can create a new floor object.
Building Operator Engineering Guide Adding Data Points Using Building Operator Discovery 1 2. Select the Site name. 3. Find and select the (+) icon at the bottom of the navigation tree. Select Add Floor. 4. In the pop-up, type to in the Floor Name field and give your site a unique name. 5. Select Create when finished. 6. Close the property editor to proceed. The floor structure will not appear in Building Operator.
1 Building Operator Engineering Guide Adding Data Points Using Building Operator Discovery 1.3.3 Discovering a BACnet Device After you've added a floor object, you can now discover a device. In doing so, you can add that device to the Building Operator Discovery project and sync it with Building Operator. Complete the instructions below to discover a BACnet device. Discover a BACnet Device 1. Find and expand Connectors in the Navigation tree.
Building Operator Engineering Guide 1 Adding Data Points Using Building Operator Discovery 5. (Optional) Select Add. 6. Select Discover beneath the device type. At the bottom of Added Devices (there will be no list results if you haven’t added anything yet), select Discover. 7. Find and select the appropriate device(s) in the list results. 8. Select + Add, and then OK in the confirmation pop-up. 9. (Optional) Before you add a device, select Discovery Settings.
1 Building Operator Engineering Guide Adding Data Points Using Building Operator Discovery 10. If you can’t discover all BACnet devices, increase the timeout setting using the up and down arrows in the field provided. We recommend a 30-second timeout value. 11. (Optional) Select Apply to save changes. 12. Locate the appropriate device, select its name to highlight and select Add. You can also add multiple devices at once.
Building Operator Engineering Guide Adding Data Points Using Building Operator Discovery ● ● ● 1 Begin column "A' data with lowercase letters. Add a ping register so that Building Operator Discovery can monitor the controller to make sure it’s active. Manually upload this file to Building Operator Discovery. Configuration Information The following information is required to help configure your .CSV file. ● name (required): Name of the register.
1 Building Operator Engineering Guide Adding Data Points Using Building Operator Discovery Uploading a .CSV File to Building Operator Discovery Once you’ve configured the file, it’s time to upload it to Building Operator Discovery. 1. Select and expand the Modbus drop-down in the Navigation tree. 2. Select Register Maps. 3. Select Upload, below the Modbus Register Maps list. You won’t see any results if you haven’t uploaded a Modbus file yet. 4. Select Choose File.
Building Operator Engineering Guide 1 Adding Data Points Using Building Operator Discovery ● Existing Register Map: If you've already configured a modbus connector, this property will let you choose from a list of available registers or to create a new one with ModbusRegMapUri. ● ModbusRegMapUri: Specify the name of the register map to link with this connector. Replace "xxx" with whatever the name of the register map is. ● Uri: To specify the Uri, enter the host, protocol, and port (default 502).
1 Building Operator Engineering Guide Adding Data Points Using Building Operator Discovery 3. Select the plus icon (+) below the available objects pane, then select Add Equip. 4. In the pop-up, type to enter the equipment name. This name will appear in Building Operator as the Device Name. We strongly recommend you label the equipment as the same name as it is on the BACnet network. 5. Select Create.
Building Operator Engineering Guide Adding Data Points Using Building Operator Discovery 1 Adding Data Points Similar to discovering equipment, you can discover points to add to the equipment you just discovered. To discover points for specific equipment in Building Operator Discovery, complete the following instructions: 1. In the floor object, find and select the right device. Three icons appear once you hover over the device name.
1 Building Operator Engineering Guide Adding Data Points Using Building Operator Discovery 5. Once loaded, find and select (or multiselect) points you want to add to the device. Drag and drop the point(s) on the equipment name in the Equip Tree on your site to add the points or select + Add. 6. Select Apply in the confirmation dialog to add the point. 7. Select Cancel in the Batch Record editor: [Your Panel Name]. This functionality is not fully supported yet. 8.
Building Operator Engineering Guide Adding Data Points Using Building Operator Discovery 1 3. Select Delete [Point or Equipment Name]. 4. Select Delete in the ensuing pop-up to confirm. 5. Navigate to Building Operator and see that the point was successfully deleted from that device. 6. If you’re deleting equipment, navigate to the device in Building Operator. Find and select the delete icon (see below). This is not applicable for data points. 1.3.
1 Building Operator Engineering Guide Adding Data Points Using Building Operator Discovery Marker Tags Marker tags are used to indicate a type. They are a one-word string value that describes the point. To add marker tags: 1. In the Marker Tags section, select the plus icon (+) to expand the tags menu. 2. Enter or scroll to search for the tag(s) you want to attach to this point. 3. Select the check mark icon to save these changes. Select Save to confirm the changes.
Building Operator Engineering Guide 1 Adding Data Points Using Building Operator Discovery 3. Select the appropriate property type to execute the type change. 4. Once you’ve selected the right property tag type, type to enter the tag-name or manually select the tag-name field to find the right tag name. 5. Then, set the appropriate value for the tag using the field provided. 6. Select the check mark to confirm the change, then select Save to save the changes.
1 Building Operator Engineering Guide Adding Data Points Using Building Operator Discovery 3. To clone this value across all points in a device, select the settings icon, below the Available Equip Tree. 4. Select Batch Edit and Clone, then Clone Tags in the ensuing pop-up. 5. (Required) Select to select the appropriate tag in the list results. This populated list based on the object you selected in the Available Equip Tree. 6. (Required) Type to enter a filter query in the space provided.
Building Operator Engineering Guide Adding Data Points Using Building Operator Discovery 1 8. (Optional) To create a custom tag, select Custom in the Filter Editor pop-up. 9. (Optional) Navigate to the appropriate device in the filter editor by expanding the drop-down fields. Find and select the right point and select OK. 10. (Optional) Edit the filter conditions, including Boolean search criteria (and vs. or), conditions, and tags. Select OK to proceed, and then Confirm in the ensuing window.
1 Building Operator Engineering Guide Adding Data Points Using Building Operator Discovery 11. When the two required fields have been filled out, select Apply. Meter Tags Meter tags will allow you to view energy consumption values as bar charts in Building Operator. The meter tag should be applied to points that are connected to accumulator style points.
Building Operator Engineering Guide Adding Data Points Using Building Operator Discovery 1 3. Select Save to confirm the changes. See the Appendix for a list of applicable Haystack tags. Using the Bar Chart Option To view energy consumption values in the bar chart option: 1. In Building Operator, select the site you want to view from the site list. 2. Select the View Data Points icon. 3. Select a data point with a meter tag.
1 Building Operator Engineering Guide Adding Data Points Using Building Operator Discovery 4. After the selecting the data point, use the icons at the top of the chart to toggle between the line and bar chart options. When selecting the Year view, you can switch between monthly and hourly aggregation levels. 1.3.8 Determining BACnet Write Priority for Points BACnet priorities are vary for different vendors.
Building Operator Engineering Guide Adding Data Points Using Building Operator Discovery 1 1. Find and select the appropriate value or output point beneath the device, in the Available Equip tree. 2. In the point editor, find the Write Level field. 3. Use the up or down arrows, or type to enter 8 for the field value. Any command you send to the Building Operator Discovery priority array will be sent out to the end BACnet device at slot 8, or manual override. 4.
1 Building Operator Engineering Guide Adding Data Points Using Building Operator Discovery 5. Select the blue Restart button in the Gateway operation section. 6. Select Restart in the confirmation pop-up. NOTE: You will likely lose and re-gain cloud connectivity during this process. 7. Log back into Building Operator Discovery to confirm the changes reflected after the Connect device restart. 8. Refresh the Site page in Building Operator if the revisions don’t automatically populate. 1.3.
Building Operator Engineering Guide Adding Data Points Using Building Operator Discovery 1 4. Fill in a descriptive name for the record library and click Save. 5. Select an equip in the Equip Tree and then select Gear Icon → Create Batch Records → Download Saved Records. 6. Select your record library from the drop-down box and click OK.
1 Building Operator Engineering Guide Adding Data Points Using Building Operator Discovery 7. Click Download. 8. The file should now be placed in your browser’s download location. 9. After commissioning a new site, you can then upload a record library. Create an empty equip, select it, and then select Gear Icon → Create Batch Records → Upload Saved Records. 10. Click Choose File and browse to your saved record library, then click Upload.
Building Operator Engineering Guide Adding Data Points Using Building Operator Discovery 1 11. Create your equip in the equip tree and make it the current context. Discover the appropriate connector’s points and select the points that were saved in your library. Add them to your new equip record. 12. When the Batch Record Editor window pops up, select your record library from the dropdown box in upper left corner. 13. The points have been matched against your record library.
1 Building Operator Engineering Guide Configuring Alarms in Building Operator Discovery 17. To see the new equip refresh the Floor View. 1.4 Configuring Alarms in Building Operator Discovery CAUTION Only use Alarm Config to add, modify or remove alarms. COVs may be needed to ensure alarms are operating. To configure alarms in Building Operator Discovery, please complete the following instructions: 1. Log in to Building Operator Discovery. 2. Select the menu icon in the top-left corner. 3.
Building Operator Engineering Guide Configuring Alarms in Building Operator Discovery 1 4. In Alarm Config, you can set alarm configurations for the points on your device. To do so, first select the appropriate Point Filter above the list results. Choose from Number, Boolean, Enum or String value. 5. Then, select the box next to the appropriate point name(s). A blue check mark will appear to the left of the point name. You can multi-select points and write different values to them at once.
1 Building Operator Engineering Guide Configuring Alarms in Building Operator Discovery The values you apply in this window will be written to the points selected in the Alarm Config list. 1.4.1 Configuring Number Alarm When configuring a Number alarm with a Delta From Setpoint value, follow the instructions below: 1. Open and launch Alarm Config from the Building Operator Discovery applications menu. 2.
Building Operator Engineering Guide 1 Configuring Alarms in Building Operator Discovery 1.4.2 Configuring Boolean Alarm State Text When configuring alarms in Building Operator Discovery, there are a few nuances you should be aware of. First, if you’re configuring a Boolean alarm that has different values than “True” or “False,” you need to know how to determine which of these binary values are true, and which is false. To determine this, please complete the instructions below: 1.
1 Building Operator Engineering Guide Configuring Alarms in Building Operator Discovery 9. Select OK to proceed. 1.4.3 Configuring Multistate Alarm State Text If you’re configuring a Multistate alarm that has multiple values, you need to know which of these values to manually add to trigger an alarm. To determine this, please complete the instructions below: 1. Open and launch DB Builder from the Building Operator Discovery applications menu. 2.
Building Operator Engineering Guide 1 Configuring Alarms in Building Operator Discovery 5. Enter the multistate value in the Alarm State Text field. Note that spacing is critical in this field. If you enter a multistate field value with incorrect spacing, the alarm will not work. Use a semicolon to separate state text. 6. Select OK. 1.4.4 Verifying Alarms in Building Operator Discovery Once you’ve configured point alarms, you can verify that these changes executed in Building Operator Discovery.
1 Building Operator Engineering Guide Configuring Alarms in Building Operator Discovery 1.4.5 Viewing Alarms in Building Operator Discovery Once you’ve set parameters for your alarm, you can then view the alarm status and associated tags in Building Operator Discovery (pending the alarm has gone off). To do so: 1. Select the menu icon in the top-left corner, and then select Alarms. 2. In the right-hand – Alarms – pane, you’ll see each point that’s listed in an alarm state.
Building Operator Engineering Guide 1 Configuring Alarms in Building Operator Discovery 3. To view the point alarm details, select the (i) information icon directly above the point name. 4. Here you’ll find the point alarm details and associated tags. For example, you can see the timestamp of when that specific point went into alarm (as outlined below). 5. Select Close. 1.4.
1 Building Operator Engineering Guide Backing Up and Restoring a Building Operator Discovery Database 1.5 Backing Up and Restoring a Building Operator Discovery Database In Building Operator Discovery, you can back up or restore a database that you have already created. This is particularly useful if you want to save engineering configurations and data to apply on a replacement Connect device (for example: due to device damage). 1.5.
Building Operator Engineering Guide Backing Up and Restoring a Building Operator Discovery Database 1 3. From the menu, select Make Snapshot.
1 Building Operator Engineering Guide Backing Up and Restoring a Building Operator Discovery Database 4. Once the loading bar reaches 100 percent, your database snapshot will display directly below the menu in the Folio pane.
Building Operator Engineering Guide Backing Up and Restoring a Building Operator Discovery Database 1 5. Select the Folio snapshot name you want to pack up to your computer. Three options will appear: – ◈ 1.5.2 Restore: This will upload the same version of the database you created when you made a snapshot. See below for instructions on how to properly restore. – Backup: This will save the database locally to your device in a Zip file. – Delete: This will remove the folio snapshot of the database.
1 Building Operator Engineering Guide System Limits After you’ve executed this procedure, restart the Connect device. To do so: In Connect device: 1. Select the Maintenance tab. 2. Select Restart and wait approximately ten minutes to execute a proper restore in Building Operator Discovery. 1.
Haystack tags 2 2 Haystack tags Here is a white list of Haystack tags accessible in Building Operator. You can find a complete list of Haystack tags on their website.
Issued by Siemens Switzerland Ltd Smart Infrastructure Global Headquarters Theilerstrasse 1a CH-6300 Zug +41 58 724 2424 www.siemens.com/buildingtechnologies © Siemens Switzerland Ltd, 2020 Technical specifications and availability subject to change without notice.
