s Desigo™ SX Open SX Configurator, V2.
Table of contents 1 About this document ..............................................................................4 1.1 Revision history.........................................................................................5 1.2 1.2.1 1.2.2 1.2.3 1.2.4 Before you start .........................................................................................5 Trademarks ...............................................................................................5 Copyright ......................
5 Worksheets in SX Configurator ...........................................................25 5.1 5.1.1 5.1.2 5.1.3 Cover sheet.............................................................................................27 Administrative section .............................................................................27 OPTIONS section....................................................................................29 Default mapping .................................................................
1 About this document SX Configurator is supplied as an integral component of the SX Open software package, and is a necessary tool for the configuration of this software (refer also to section 2). This manual describes the use of SX Configurator. It describes the step-by-step process for configuring SX Open (section 3) and contains detailed background information on importing and compiling OPC data, and on creating the various worksheets in the SX Configurator file (sections 4 to 5.14).
1.1 Version 2.1 Revision history Date Changes Section 20 Mar 2012 New product name SX Open Correcting Typos, added clarifications Change default notification class to 31 New sections schedule object Deleted figure 3.1 Clarification of alarm-values 3.7.6 3.7.8, 5.2, 5.2.8 3.10 5.2.6 Hint for more than one SX Trend Server 5.2.7 No alarm suppression for “trended” objects 5.2.9 Removed restriction to read-only mapping for VT_BSTR items Detailed description of BACnet client sheet 5.2.
1.2.3 Quality assurance These documents were prepared with great care. • The contents of all documents are checked at regular intervals. • Any corrections necessary are included in subsequent versions. • Documents are automatically amended as a consequence of modifications and corrections to the products described. Please make sure that you are aware of the latest document revision date.
BACnet objects 1.3 Printing conventions 1.3.1 Printing conventions for the BACnet terms BACnet objects (standard and proprietary) are not written or marked out in any special way in the manual. Example: Notification class BACnet properties The first time it occurs in a section of this manual, a BACnet property is written in full, followed by the abbreviated form in square brackets. After this, the property is referred to only by its abbreviated name or "identifier". Example: 1.
2 SX Open – Integration into BACnet Figure 2-1 SX Open is a software package in the Desigo Open family, and is used to integrate third-party subsystems or devices with an OPC interface into a BACnet system. Integration into Desigo SX Open enables devices or complete systems from third-party manufacturers to be integrated into the Desigo system via the OPC data access interface.
This file is part of the SX Open package, and is copied into the subfolder ...\Config of SX Open datapath when SX Open is set up. As a rule, SX Configurator also runs from this subfolder. However, the configuration process can also be carried out without the SX Open setup. It is sufficient simply to copy the file SX-Configurator.xls. Note Note that in this case, after you have configured SX Open, the resulting *.
3 SX configuration workflow The workflow consists of the following main activities: • • • • • • Opening SX Configurator (Section 3.1) Checking global Excel settings (Section 3.2) Cover sheet (Section 3.3) Importing data (Section 3.4 to 3.6) Editing the main configuration sheet (Section 3.7) Editing other worksheets (refer to sections 3.8 and 3.11) 3.1 Opening SX Configurator To create a new SX configuration, open the file SX-Configurator.xls. This file serves a template, and must not be overwritten.
3.2 Preparation - Checking global Excel settings To avoid problems when using SX Configurator with different language settings always use a dot as decimal separator and a comma as thousand separator. 3.3 Cover sheet – Entering the project data Here, you enter specific information about the project to describe it in full. The worksheet is described in detail in section 5.1.
3.4 Importing data Section 4 contains all the background information associated with the import of OPC data. Action Select the relevant options Select the type of data import Select import location, online/offline Step Sheet OPC server Sheet BACnet device Procedure Opens the dialog box for importing OPC data. Select the type and source of the OPC import, as described in section 4. 1 Get OPC data 2 Full/Based on device/Number of fields Enable the required type of import.
3.7 Editing the main configuration sheet The worksheet and individual values are described in detail in section 5.2. Following the import of the OPC data, the OPC section is already completed. To complete the SX configuration, the remaining data must now be added. All the imported OPC items must now be assigned to the appropriate BACnet objects and properties in the BACnet section of the sheet.
3.7.2 Column Step Completing the BACnet section Procedure BACnet Device Ref (required) 1 In the BACnet Device sheet, enter the reference to the BACnet device to which the BACnet object is be assigned BACnet Object Type (required) 2 Select the object type for mapping values on the BACnet side (Objects sheet ) Object Instance (required) 3 Select an object instance. Key name (required) 4 (= User Designation).
3.7.4 Column Step Completing BACnet information for binary objects Procedure Polarity (optional) 1 Enter 0 for normal polarity and 1 for inverse polarity, binary-input and binary-output only. Active Text (optional) 2 Enter the state text for present-value 1. Inactive Text (optional) 3 Enter the state text for present-value 0. Min Off Time (optional) 4 Enter the minimum off time. Min On Time (optional) 5 Enter the minimum on time. 3.7.
Column Step Notify Type (optional) 7 Event Enable (optional) 8 Time Delay (optional) 9 Important Procedure Enter as applicable: 0 = Alarm 1 = Event Enter as applicable (addition of 3 event enable bits): 1 = to-offnormal enabled 2 = to-fault enabled 4 = to-normal enabled Enter delay time For binary objects there may be one number only in column Alarm Value(s) There is no check in SX Configurator for the same value used in Alarm Value(s) and Fault Value(s) of a multistate object. 3.7.
3.7.10 Column Step Completing the function info section Procedure Avoid Default Mapping (optional) 1 Disable default mapping of alarms Uses OPC Quality (optional) 2 Blank or <>1 = Use item value 1 = Use item status Function Name (optional) 3 Enter function name from Functions sheet Parameters (1…40) (optional) 4 Define other input parameters (according to function) 3.
3.10 Compiling the SX configuration The SX configuration is completed after creation of the downloadable SX Open configuration files (CSV files) and the BACnet object descriptions by compiling the data. Create SX-OPEN files The SX configuration process is started by use of the illustrated button. The process is not complete until the compilation runs without errors. Any errors must be eliminated before repeating the compilation. The process is recorded in a log file.
4 Importing OPC data The data objects available on the OPC server (primarily the server object and the various OPC items with name, data type, type of access etc.) are defined by importing the relevant object description list, or if there a connection to the server is established, by interrogating the OPC server. Note In normal circumstances, SX Open and the OPC server are installed on the same hardware platform.
4.2 OPC data import types (Import Type) Figure 4-1 Note The Full import type must always be used at least once if no data has yet been imported. After this, an OPC server reference is generated, and the item sets or device sets can be created: • Analyze the data and decide whether Number of fields or Based on device are applicable. • If so, copy the relevant OPC item data from the Configuration sheet to the Item Set sheet, modify the data and add the necessary information including BACnet data.
4.2.1 Full All OPC items are displayed in full in the Configuration sheet, and the data can be edited as required. With a Full import, the default BACnet property is [PrVal] for all defined points. [PrVal] Note It is advisable to set Warning Level 2, as otherwise, all the data will be checked. Examples for a log report: SX-OPEN Configurator V2.00.025 - 10.11.09 SX-OPEN Configurator V2.00.025 - 10.11.
4.2.2 Based on device This import type can be used when there are several devices of the same type to import, e.g. room controller devices in a 400-room hotel. Assuming that 400 rooms generate the same type of information, a device template, the "Device Set", can be created. In this case, only the OPC item fields to the left (normally the Device ID) are displayed in the Configuration sheet. All other fields are in the Device Set sheet. 4.2.
The Item Set sheet has a special use in cases where BACnet properties other than [PrVal] are to be mapped to or from an OPC item. The idea underlying these import types is to offer a certain degree of automation for repetitive tasks, and to reduce the information in the Configuration sheet. The only type of import that is mandatory is Full. For an online import, the OPC server can be located on a different computer. In this case, the name of the remote computer should be entered. 4.
Example Figure 4-3 Note When Create SX-OPEN files is clicked, the colors green and blue revert to black. The red items always generate the following warning: **Warning** Row XX: Item does not exist anymore; object not exported... until the rows concerned have been checked and removed. New or modified items contain a "1" in the ForceUpdate column, to force SX Open to reset to the changed/new value. 4.
5 Worksheets in SX Configurator SX Configurator is based on worksheets that contain data for the OPC/BACnet conversion. The data is arranged in separate sheets to provide maximum support when configuring mass data. The basic principle is that specific items should be defined in detail once only in a sheet, with only a reference required in the main Configuration worksheet.
Worksheet overview Contents Section NofificationClass Definition of notification classes used in all configured BACnet devices. 5.2.6 Hash-Values Definition of hash-values for items of VT_BSTR type 5.13 Trend Definition of used trendlog objects 5.2.7 Schedule Definition of used schedule objects 5.2.8 Color code Figure 5-2 The column names show the type of information required in each field.
5.1 Cover sheet Figure 5-4 The Cover sheet contains basic project information, such as name, description and person(s) responsible, plus a section for general and optional settings and file storage information.. 5.1.1 Administrative section Figure 5-5 Fill in the administrative details (the light turquoise cells) to suit your requirements. Note Apart from the PROJECT NAME and AUTHOR, all entries are optional.
When the file is saved for the first time, the project name is automatically appended to the file name, making the file name unique. Example 1. 2. Complete the PROJECT NAME field, e.g. by entering the name "My Project". When the file is saved, its name is automatically extended to: SX Configurator- My Project.xls From now on, only the project-specific file is used. The original file remains unchanged. If you try to save the file with an empty PROJECT NAME field, a warning is displayed.
5.1.2 OPTIONS section Figure 5-8 This section (light yellow fields) allows you to modify the general behavior of SX Configurator and define the paths to any additionally required files, or to the file location of the SX configuration. The default is the path via which SX Configurator.xls was opened. Important Once the file is saved by its project-specific name, the OPC Import Folder, SX-OPEN Folder and EDE Folder paths are no longer updated automatically.
Row Function Create INSIGHT File INSIGHT Site Name 1) Create INSIGHT File Default 1) For further information refer to Blank = BACnet object description will not be created automatically as an XML file Not blank, e.g. 1 = XML object description created and saved in the location specified in the EDE Folder. For further information refer to 2) If the Create INSIGHT File field is enabled, the Desigo Insight site name must be entered here; the SX Open objects are arranged under this name.
5.1.3 Default mapping An OPC item consists of: • • • • Name Value Status Time stamp Activating Default Mapping means that not only is the item value mapped to [PrVal] of the BACnet object, but also that the OPC status is mapped, more or less invisibly, to the relevant alarm properties of the same object. Depending on the OPC status, the alarm state on the BACnet side is then NORMAL or an OFFNORMAL or FAULT alarm.
default mapping not generated default mapping generated Figure 5-9 This default mapping generates error events based on the sheet above, using the configured notification class. 32 / 72 Siemens Building Technologies Desigo SX Open - SX Configurator, V2.
5.2 Main Configuration sheet Figure 5-10 The Configuration sheet contains the actual SX Open configuration with the rules for mapping OPC data to BACnet objects and properties and the use of optional system functions such as alarm and trend. This is also where the use of specific function blocks for mapping signals and functions should be configured (for further information on this subject, refer to the Engineering Guideline.
Structure The sheet is divided into the following sections: • OPC • BACnet • general settings • analog objects settings • binary objects settings • multistate objects settings • alarm information • trend information • schedule information • Alarm suppression • Function information 5.2.1 OPC area Figure 5-12 Column Description Item Name Name of the OPC item. The item contains a value, a status and a time stamp for the last change of value.
Column Description Item Set Ref Reference to an Item Set from the sheet of the same name. Can be used for this type of import. Device Set Ref Reference to a Device Set from the sheet of the same name. Not used for this type of import.
5.2.2 BACnet section Figure 5-14 The BACnet information has to be entered manually to define each mapped OPC item. In the simplest case, some (or all) OPC items are mapped to [PrVal] of the BACnet objects.
Column Description BACnet Object Name Name of the BACnet object. Governed by the Desigo Insight naming conventions. A suggested name based on the OPC item can be generated automatically during the import process. The object name is interpreted on the Desigo-side as the Technical Designation. Description (Optional) Description of the object. BACnet Property (Optional) Reference to the BACnet Property to which the OPC value is to be mapped.
Figure 5-15 2) Force Update On start-up SX Open reads the current configuration and compares it with the configuration held in its internal data storage system. Property values of objects for which the Force Update column in the Configuration sheet is set to 1 are overwritten with values from csv file. Properties of all other objects are read from internal data storage system. For a new configuration, the ForceUpdate column is set to 1 for all objects.
5.2.3 BACnet information for analog objects Column Description BACnet Units For analog objects only: unit for the analog object. This can be the BACnet unit number (e.g. 62), the BACnet unit name (DEGREES_C) or the OPC-server unit string ("°C"). Reference to engineering unit in the Unit sheet: Alternatively, the OPC unit can be used, if shown in the Unit sheet.
5.2.4 BACnet information for binary objects Column Description Polarity (optional) Polarity can be used to change an OPC item to positive logic, i.e. 0 as passive state and 1 as active state. Active Text (optional) Active text assigns a value for present-value 1. Inactive Text (optional) Passive text assigns a value for present-value 0. Min Off Time (optional) Min Off Time describes how long present-value stays at 0 before a change back to 1 is allowed again.
5.2.6 BACnet alarm info section Figure 5-16 SX Open supports the alarm system function in a way similar to that used in Desigo. The alarm function in each alarm-generating BACnet object can be configured accordingly. Notification classes SX Open uses a sheet NC to define a set of notification classes. Figure 5-17 SX Configurator is delivered with a set of predefined notification classes which are used in Desigo, too. 41 / 72 Siemens Building Technologies Desigo SX Open - SX Configurator, V2.
Column Description NC-Id NC-Id is the instance-number of the corresponding notification-class BACnet object. The predefined notification-classes are assigned instance numbers according to Desigo. Keyname In this column the keyname is entered NC-Name In this column the object-name is entered Description Description of the notification-class object. Priority TO_OFFNORMAL Priority of a TO_OFFNORMAL alarm or event. Priority TO_FAULT Priority of a TO_FAULT alarm or event.
Column Description High limit For analog objects only: If an analog object is required to generate a BACnet alarm, a value must be entered in either the High Limit or the Low Limit column (or both). SX generates an OFFNORMAL alarm if [PrVal] violates the limit. For further information refer to 1) Blank Value x Low limit For analog objects only: SX generates an OFFNORMAL alarm if [PrVal] drops below the limit.
1) High/Low Limit For analog objects, the alarm function is activated via these columns. If the columns are left blank, no alarm is initiated. Alarm limits can be defined in the following two ways: • Directly, by specifying a physical value in the same format as the [PrVal] of the object. • Indirectly, via the value from another OPC item. In this case, an "x" must be entered instead of the value.
Figure 5-21 Figure 5-22 Column Description Trend-Log ObjectInstance The instance number is referenced from Configuration sheet and may not be changed. Recommendation When modifying the configuration at a later date, take care not to change any instance numbers already allocated to trend log objects. The instance number allocated to the "trended" BACnet object must also be retained. Important Failure to observe these rules can result in the loss of trend data.
Column Description Log interval Describes how to get the monitored value: Buffer size 0 = use confirmed COV notification -1 = use unconfirmed COV notification >0 = poll monitored object and use supplied value as poll interval Size of the temporary trend buffer for each object. The amount of space required for the trend log objects in the working memory of the SX PC depends on their number and on the buffer size, and is in direct competition with other applications, e.g. other SX components.
5.2.8 BACnet schedule object section As an option, SX can change a BACnet object value based on a schedule. For this purpose, a schedule object must be assigned to the BACnet object at the configuration stage. Figure 5-23 Column Description Schedule Object Instance Enter the instance number of the scheduleg BACnet object. The instance number must be unique and must occur only once in the file.
Column Description Schedule Object Device ID The instance number of the device where the BACnet object to schedule is located. This entry may not be changed, too. Schedule Keyname Keyname of schedule object. Schedule Object Name The name of the schedule object. The name is generated to the rule "SCHED" + instance number, in the form XXXX, e.g. SCHED0023”, but can be changed afterwards.
5.2.9 Section alarm suppression Figure 5-26 Column Description Propagation Delay A delay time before a BAD OPC quality will be delivered as a BACnet fault state. Default value is 30 seconds. Subsystem Status An OPC item which describes the communication state to a subsystem. Subsystem status is only useful if an OPC server can distinguish different devices and every device is modeled as a BACnet device of its own.
5.2.10 Function info section Figure 5-27 Column Description Avoid Default Mapping Disables the default mapping for alarms individually. (Refer also to the information on Default Mapping in section 5.1.3.) Uses OPC Quality For default mapping of an OPC item to a BACnet property, the OPC item value is used. It may on occasion be necessary to map the OPC Item Quality, instead of its value, as the input variable for a function block. In this case, enter a "Y" (or other letter) in this column.
2) To support VT_BSTR items e.g. for signaling a state, these strings must be translated in a unique number which can be handled by SX Open. These strings have to be mapped to hash values in SX Configurator (see Hash VT_BSTR sheet). The same hashing function will be used in SX Open as soon as string is received from OPC Client. By defining a mapping function which knows about the different hash values a mapping of strings to a discrete set of numbers is possible.
5.3 Item Set sheet Figure 5-29 • At least one entry must have [PrVal] as a property and must also define the BACnet object type. • Each entry is mapped with a BACnet property, which means that if not [PrVal], then the Output Destination must be defined. . Defining Item Sets This sheet allows the separate definition of recurring substructures when mapping OPC items to BACnet properties.
Column Description Ref Unique set number used as a reference in the Configuration sheet. The Reference is a sequence number in two parts: main-item.sub-item; all definitions related to the same object must have the same main-item reference; The reference number is divided into two parts, x.y: x represents the set number to which reference is made in the Configuration sheet. y is the numbering within the item set. OPC Server Ref The OPC Server Ref must be known.
To simplify the configuration process, it also possible to define just one Item Set with: Ref = 1 1.1 OPC valid = RSUA0 RSUA0 OPC fields = .Value .Status The basic links in the Configuration sheet are created automatically after the item set definition process, when an OPC data import is next started. This time, however, the import type is Number of Fields.
5.5 OPC Server sheet Figure 5-32 This sheet is used to store OPC server data, such as name, location and update rate. Normally, if the OPC item data is imported directly from a specific OPC server, the sheet is filled in automatically. However, you can also add to or correct the sheet manually. Column Description Ref Unique number of the OPC server, used as a reference in the Configuration sheet. OPC Server Name Name of the OPC server, e.g. "Matrikon.OPC.Simulation.
5.6 BACnet Device sheet Figure 5-33 All the information about the "virtual" BACnet devices is saved here. It is best to assign the BACnet objects according to the subsystem or device to be integrated, to achieve a clear, hierarchical object structure on the BACnet side. Column Description Instance Instance of the BACnet device object. The instance must be unique. It is also used as a reference in the Configuration sheet. Keyname This is normally identical to the BACnet object name.
5.7 Units sheet Figure 5-34 This sheet lists all the units defined in the BACnet standard, together with their respective reference numbers. For each OPC server, you can use the Unit sheet to define your own unit designations or the existing ones, for use in the Configuration sheet. This can make it easier to enter Configuration sheet data in cases where the data needs to be copied and pasted from OPC into Excel. Column Description Ref BACnet reference number for the unit.
5.8 State sheet Figure 5-35 This sheet can be used to associate text with the numerical states of multistate objects. Column Description Ref BACnet reference number for the state State Nbr/Text State number and associated text. SX Open supports up to 127 state texts. Note that in contrast to OPC on the BACnet side, the state 0 is not supported. In such cases, the BACnet state must be made compatible by use of an "SxAdd 1" function block.
5.10 Properties sheet Figure 5-37 This sheet lists the BACnet properties supported by SX Open for mapping the OPC data. To avoid having to enter the object type in full in the Configuration sheet, socalled "Nicknames" (abbreviations) can be defined. For example the property "HighLimit" can be abbreviated to "HiLm" and this can be used as a reference. Each parameter is defined as a tuple (Property, Value and Default).
5.11 Functions sheet Figure 5-38 The Function sheet is for entry of the predefined functions available via the function block library, PRJLib.dll. Only the functions that are actually needed in the main Configuration sheet should be described. Column Description Function Name Function name Number of extra Parameters Description Number of optional extra parameters Inverse Function Inverse function, for use in cases where the function is used for signal mapping.
Figure 5-40 The client connections, too, can be configured in SX Configurator. Configuring a BACnet client The sheet has two sections, for Source and Destination. The Source section contains the address of the object which is the source of the value (e.g. a DMAP object from PX), and the Destination section contains the address of the object to which the value is to be transmitted (e.g. an SX-BACnet object).
Important Supported source object types • Analog Input • Analog Value • Binary Input • Binary Value • Multistate Input • Multistate Value Supported destination object types • Analog Output • Analog Value • Binary Output • Binary Value • Multistate Output • Multistate Value SX BACnet Client supports Device Object as source object, too.
5.13 BSTR Hash sheet Figure 5-41 SX Open can deal with VT_BSTR items and map a finite set of different texts to [PrVal] of e.g. a multistate input object. This mapping is done by assigning every string of interest a hash value and using these hashes in a mapping function. Calculating of hash values is performed by SX Configurator during compilation and the resulting value is stored in BSTR Hash sheet. Column Description of the Source and Destination sections BSTR Value A string to map to a hash value.
5.14 Upload of properties from a running system SX Configurator V2.1 supports the upload of properties from a running system, e.g. if a configuration shall be extended and changes of properties done by a customer must be preserved. An upload must be accomplished in following order: Column Step Procedure Get current values 1 Start SX Upload tool on target system. Copy upload file to SX OPEN folder 2 This step is only needed if runtime system does not runt on the same PC as SX Configurator.
6 Messages A number of messages appear in the OPC import and SX export process. Some of these are self-explanatory, and others are described below. In the data export process, unused information is deleted automatically, to reduce the quantity of information on the screen. Message Description Action BACnet object definition is incomplete and will be ignored: clear all occurrences like this? This information will be restored with the next OPC import.
7 Examples 7.1 Mapping Limits from OPC The following example shows how to map limits from OPC to an analog input object.
Figure 7-1 The Hash-Value itself will be calculated by SX Configurator when compiling configuration and must not be calculated and entered manually. 2. Define for every text an associated BACnet state text, e.g. just use the same text. Figure 7-2 3. Map VT_BSTR to BACnet Present_Value using defined strings and mapping function BstrHash2MultiState • H indicates to use the Hash-Value of provided string 67 / 72 Siemens Building Technologies Desigo SX Open - SX Configurator, V2.
7.3 Defining a Calendar Object Calendar objects are created as container only. There will be no calendar entries inserted by SX-Configurator. Do add a calendar object to SX-Configurator a new line must be inserted in Configuration Sheet. Figure 7-3 Calendar objects are SX Open internal objects, there is no OPC item associated with a calendar object. Nevertheless SX-Configurator needs an OPC item for every BACnet object defined in Configuration Sheet.
As a last step entries in SXmapping.csv must be suppressed. This is done by using the special mapping function SXVirtual which is a trigger not to emit mapping entries for this row in Configuration sheet. Parameter number 1 to 9 are reserved for Supervisor objects, every othere parameter value is feasible. After compiling this configuration and starting SX_Open a calendar object will be available and can be filled with value from Desigo Insight. 7.
8 What is the meaning of SX object member eventEnable? FAQ SX object member eventEnable is the counterpart of BACnet property eventenable and is entered as a number that will be decoded as follows: • • • Bit 0: TO_OFFNORMAL Bit 1: TO_FAULT Bit 2: TO_NORMAL The coding is hidden in SX Configurator VBA code. EventEnable must be inserted in the Configuration sheet.
Index B BACnet client sheet .............................................. 60 BACnet printing conventions .................................. 7 BSTR Hash sheet ................................................. 63 C Cancel current operation ...................................... 10 Checking the OPC server..................................... 12 Color code ............................................................ 26 Compiling the SX configuration ............................
U Units sheet ............................................................ 57 Upload of properties from a running system......... 64 Upload properties ................................................. 10 W Warning Level 2 .................................................... 21 Workflow, SX-configuration................................... 10 Worksheet BACnet client..................................................... 60 BACnet Device .................................................. 56 BSTR Hash ...........
