Andover Continuum Security and TAC I/A Series Data Exchange Reference Guide

Transcription

1 Andover Continuum Security and TAC I/A Series Data Exchange Reference Guide

2 2010, Schneider Electric All Rights Reserved No part of this publication may be reproduced, read or stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without prior written permission of Schneider Electric. All brand names, trademarks and registered trademarks are the property of their respective owners. Information contained within this document is subject to change without notice. Distributed, manufactured and sold by Schneider Electric. I/A Series trademarks are owned by Invensys Systems, Inc. and are on this product under license from Invensys. Invensys does not manufacture this product or provide any product warranty or support. For service, support and warranty information, contact Schneider Electric at This document is produced in the United States of America. Title: Andover Continuum Security and TAC I/A Series Data Exchange Reference Guide Revision: B Date: December, 2010 Schneider Electric part number: Software application version number 1.81 or higher The information in this document is furnished for informational purposes only, is subject to change without notice, and should not be construed as a commitment by Schneider Electric. Schneider Electric assumes no liability for any errors or inaccuracies that may appear in this document. Schneider Electric One High Street North Andover, MA (978) Fax: (978)

3 Andover Continuum Security and TAC I/A Series Data Exchange Reference Guide Revision B December, 2010

4

5 Contents Standard Regulatory Notices for Andover Continuum Hardware 5 Federal Communications Commission... 5 Industry Canada... 5 CE - Compliance to European Union (EU)... 5 Australian Communications Authority (ACA)... 6 WEEE - Directive of the European Union (EU)... 6 RoHS - Restriction of Hazardous Materials... 6 UL Listing... 6 About this Manual... 9 What s in this Manual... 9 Symbols Used Chapter 1 Introduction and System Overview TAC I/A Series and Andover Continuum Security Solution Purpose of this Document System Architecture Key Concepts and Nomenclature Access Control System Network Andover Continuum ACX 57xx Series Controller Port CyberStation Database Plain English Programs web.client Points XDriver Andover Continuum CyberStation Access Control Essentials Guide 1

6 XDriver SelfObject XDriver Client Object XDriver Server Object Door Door Attributes Events Alarms Schedules User Programmer Supported Device Configurations Workplace Tech/MNB-1000 Controller/ACX 57xx/CyberStation 20 Enterprise Server/UNC/ENC Controller/ACX 57xx/CyberStation Enterprise Server/web.Client - 2 machine Enterprise Server/web.Client/CyberStation - 3 machine 22 Multiple ACX 57xx Controllers Role of XDriver and Plain English in Integration Role of XDriver Points Role of PE Programs Chapter 2 CyberStation Introduction System Requirements and Pre-Installation Minimum/Recommended Hardware Requirements Software Requirements Overview of Common CyberStation Tools and Tasks ACX 57xx Controller Update/Configuration XDriver Support Creating Points To create a point PE Programs web.client for Web-based Access Chapter 3 Using the BACnet/IP XDriver BACnet/IP XDriver Overview BACnet/IP XDriver Requirements Verifying the Controller Options for Installation Schneider Electric

7 BACnet/IP XDriver Installation Configuration Overview Parameters Point Access Type Instance Property BACnet Network IP Address BACnet XDriver Points Overview Client BACnet XDriver Points Examples of a Client BACnet XDriver Point Server BACnet Points Example 1 Server BACnet Point Example 2 Server BACnet Point with Engineering Units Example 3 Server BACnet Point with Engineering Units, Relinquish Default, and Priority Level DeviceSelf Object Programming Introduction Plain English Programming Language Programming Examples - Single ACX 57xx Controller Program Type 1 Distribute Door Attribute Values to MNB-1000 or UNC/ ENC Controllers When a Persistent Door Attribute Changes...61 Program Type 2 Modify Door Attribute Values from MNB-1000 or UNC/ENC Controllers Program Type 3 Distribute Door Attribute Values to MNB-1000 or UNC/ ENC Controllers When a One-Scan Door Attribute Changes 64 Programming Examples Multiple ACX 57xx Controllers 65 Program Type Distribute Door Attribute Values to MNB-1000 or UNC/ Andover Continuum CyberStation Access Control Essentials Guide 3

8 ENC Controllers when a Persistent Door Attribute Changes in the SecondACX Program Type 2 Modify Door Attribute Values in SecondACX from MNB or UNC/ENC Controllers Program Type 3 Distribute Door Attribute Values to MNB-1000 or UNC/ ENC Controllers When a One-Scan Door Attribute Changes in SecondACX Chapter 4 web.client web.client Overview web.client User Documentation A Typical System before web.client A Typical System Implementing web.client Differences between web.client and CyberStation Hardware and Software Requirements for LAN System Hardware and Software Requirements for a Standalone System 79 Appendix A Supported Access Control Elements Appendix B Best Practices Tips for Successful Implementation Appendix C Related Documents and Resources Schneider Electric

9 Regulatory Notices Standard Regulatory Notices for Andover Continuum Hardware Federal Communications Commission Industry Canada FCC Rules and Regulations CFR 47, Part 15, Class A This device complies with part 15 of the FCC Rules. Operation is subject to the following two conditions: (1) This device may not cause harmful interference, and (2) this device must accept any interference received, including interference that may cause undesired operation. Caution: the user that changes or makes modifications not expressly approved by Schneider Electric for compliance could void the user's authority to operate the equipment. ICES-003 This is a Class A digital device that meets all requirements of the Canadian Interference Causing Equipment Regulations. CE - Compliance to European Union (EU) 2004/108/EEC - EMC Directive This equipment complies with the rules of the Official Journal of the European Communities specified in the EMC directive 2004/108/EEC governing the Self Declaration of the CE Marking for the European Union. Andover Continuum Security and TAC I/A Series Data Exchange Reference Guide 5

10 Regulatory Notices Australian Communications Authority (ACA) AS/NZS 3548 This equipment carries the C-Tick label and complies with EMC and radio communications regulations of the Australian Communications Authority (ACA), governing the Australian and New Zealand communities. WEEE - Directive of the European Union (EU) 2002/96/EC This equipment and its packaging carry the waste electrical and electronic equipment (WEEE) label, in compliance with European Union (EU) Directive 2002/96/EC, governing the disposal and recycling of electrical and electronic equipment in the European community. RoHS - Restriction of Hazardous Materials UL Listing 2002/95/EC UL 916 This product complies with the restriction of the use of certain hazardous substances in the European Union electrical and electronic equipment directive. UL listed product for the United States and Canada: Open Energy Management Equipment 6 Schneider Electric

11 Regulatory Notices CAUTION All pertinent state, regional, and local safety regulations must be observed when installing and using this product. For reasons of safety and to assure compliance with documented system data, repairs to components should be performed only by the manufacturer. Failure to observe this precaution can result in injury or equipment damage. Andover Continuum Security and TAC I/A Series Data Exchange Reference Guide 7

12 Regulatory Notices 8 Schneider Electric

13 About this Manual About this Manual What s in this Manual Chapter One - Introduction and System Overview: This chapter contains a basic look at what the Andover Continuum Security and TAC I/A Series solution is and how it works. It contains information regarding nomenclature, supported devices and the system integration between I/A Series and Andover Continuum products. Chapter Two - CyberStation: This chapter focuses on the Continuum CyberStation software that is used to perform certain functions within the security solution. Chapter Three - Using the BACnet/IP XDriver: This chapter explains the BACnet XDriver data exchange solution for access control. Installation, configuration and programming examples are covered in this section. Chapter Four - web.client: This chapter introduces the web.client internet-based tool for use with the security solution. This is an additional resource for use with the Andover Continuum Security and TAC I/A Series security solution. Appendix A - Supported Access Control Elements: This appendix is a spreadsheet view of the devices and attributes supported by this security solution. Appendix B - Best Practices: This section of the reference guide provides hints and suggestions for successful implementation of the security solution. Common issues and questions relating to this data exchange are covered. Appendix C - Related Documentation/Resources: This section provides readers a list of resources that can be referred to for additional information relating to this system integration. Andover Continuum Security and TAC I/A Series Data Exchange Reference Guide 9

14 About this Manual Symbols Used The Notes, Warnings and Cautions used in this manual are listed below. Note: Contains additional information of interest to the user. CAUTION or WARNING Type of hazard How to avoid hazard. Failure to observe this precaution can result in injury or equipment damage. DANGER ELECTRIC SHOCK HAZARD How to avoid hazard. Failure to observe these instructions will result in death or serious injury. 10 Schneider Electric

15 Chapter 1 Introduction and System Overview This chapter contains the following topics: Description of the Andover Continuum Security and TAC I/A Series security solution Purpose of this document Common terms and nomenclature used with this solution Supported device configurations Roles of XDriver points and PE Programs Andover Continuum Security and TAC I/A Series Data Exchange Reference Guide 11

16 Chapter 1: Introduction and System Overview TAC I/A Series and Andover Continuum Security Solution The TAC I/A Series and Andover Continuum Security solution is intended to provide a comprehensive and fully integrated approach to implementing access control functions with the I/A Series of controllers. Continuum hardware and software components allow security functions to be incorporated into these I/A Series-based systems with minimal extra equipment and software. The I/A Series systems, if used alone, do not normally provide security functionality such as: access control, intrusion detection and digital video management. This combined system utilizes I/A Series controllers, such as MNB or UNC/ENC products, WorkPlace Tech software, Enterprise Servers along with the Schneider Electric Continuum ACX 57xx series controllers enabled with a BACnet/IP XDriver and Continuum CyberStation to build a complete building management solution. Purpose of this Document The main intent of this document is to serve as a reference guide for implementation of an access control system that uses an I/A Seriesbased control system, exchanging data with a Schneider Electric Continuum ACX 57xx controller with an XDriver and Continuum CyberStation. This guide, along with related documentation, should provide users with sufficient resources to do so. The first chapter provides I/A Series users with an overview of the Andover Continuum products and their role in this security solution. The subsequent chapters describe the solution and provide instructions for implementing and configuring this solution. More detailed information is located in referenced documentation. The appendices provide useful reference information that will assist in the implementation of the solution. 12 Schneider Electric

17 Chapter 1: Introduction and System Overview System Architecture The following diagram shows components that can comprise an Andover Continuum Security and TAC I/A Series security system: Andover Continuum Security and TAC I/A Series Data Exchange Reference Guide 13

18 Chapter 1: Introduction and System Overview Key Concepts and Nomenclature The design of the Andover Continuum Security and TAC I/A Series system is based on several key concepts that related to the software and hardware components of an access control system. These key concepts are described below. For more thorough descriptions, see the documents referenced in Appendix C. Access Control System An access control system is comprised of controllers, software objects, programs, and field devices such as: readers, door strikes, glass-break sensors, and digital video cameras. It controls functions such as: access control, intrusion detection and digital video management. Network The network is a medium through which electronic hardware communicates. Andover Continuum products use several types of networks. Network controllers communicate with a user workstation and with each controller via an Ethernet TCP/IP network. Andover Continuum products support physical wire and fiber versions of the Ethernet as well as wide-area wireless Ethernet. Andover Continuum 14 Schneider Electric Andover Continuum is system of hardware and software that has been designed to monitor and control the various functions of a building such as security, access control, lighting, and video control. For this specific application, the security and access control capabilities are used. The hardware consists of equipment controllers, network communication controllers, input and output interfaces. The software is a computer program that allows you to communicate with, monitor and control the operation of the system.

19 Chapter 1: Introduction and System Overview The values of each point in the system, the settings for limits, the configuration of the hardware, the personal data of the personnel granted access to your building and more are contained within this powerful software structure. ACX 57xx Series Controller The ACX 57xx controller is the device that provides direct interface from the I/A Series network to the access control system. The two base models are: 5720 and ACX Series Universal Inputs 6 12 Reader Inputs 4 8 Tamper Input 1 1 Digital Outputs 2 4 Port A comm port on a controller is the physical interface from the ACX 57xx controller to another device. The ACX 57xx controller has one ethernet Comm Port connector (COMM1). CyberStation One of the key components of the Andover Continuum system is a Windows based application program called CyberStation that runs on a PC workstation and interacts with the control system. Andover Continuum s second key software component is the database that stores all the vital information pertaining to the security management system. Andover Continuum Security and TAC I/A Series Data Exchange Reference Guide 15

20 Chapter 1: Introduction and System Overview CyberStation software provides Continuum with a graphic user interface that can display and manipulate data that allows the entire site management of adjusting schedules, managing video recording, acknowledging alarms, controlling doors, and tracking personnel. CyberStation is the workstation software used to create and configure ACX 57xx controllers, access control features, XDriver objects, and Plain English programs. Database The information that describes the structure and operation of your building is stored in a software database. The database engine that Continuum uses is either Microsoft SQL Server or MSDE Plain English Programs Plain English (PE) is Andover Continuum s proprietary BASIC-like programming language. A Plain English or PE program transfers values between the ACX 57xx controller and XDriver objects. These are created in the Plain English editor in CyberStation and are stored in the ACX 57xx controller. web.client web.client software provides access to the Andover Continuum system via a web browser. However, web.client s user interface differs from the Andover Continuum user interface. web.client is an additional tool that you may use in conjunction with the Continuum Security and TAC I/A Series solution. Points The control of equipment requires monitoring individual inputs and actuating individual outputs. These are software objects located in the ACX 57xx controller. In Continuum systems, these discrete entities are 16 Schneider Electric

21 Chapter 1: Introduction and System Overview called points. You ll see references to output point or input point often. A point may be classified as one of the following: InfinityInput, InfinityOutput, or InfinityNumeric. Note: The term points may be used interchangeably with objects in this solution. XDriver XDrivers are gateway software that provides non-native protocol connectivity to third-party devices. In this solution, the XDriver provides communication through BACnet/IP from the I/A Series controllers to the ACX 57xx access controller. XDriver SelfObject An XDriver SelfObject is a user-defined object that makes the XDriver device visible to the BACnet/IP network. XDriver Client Object This is an XDriver object that reads or writes values to or from other devices on the BACnet/IP network. XDriver Client objects are typically used to update BACnet object values in MNB-1000 or UNC/ENC controllers. XDriver Server Object This XDriver object provides read or read/write access from other devices on the BACnet/IP network. XDriver Server objects are typically used to receive BACnet values transmitted from MNB-1000 or UNC/ ENC controllers. Andover Continuum Security and TAC I/A Series Data Exchange Reference Guide 17

22 Chapter 1: Introduction and System Overview Door A door is a software object in the ACX 57xx controller that logically represents the physical characteristics of a Door in a building. This may include access events, alarming and locks. Door Attributes Door attributes refer to the individual characteristics of a Door object. Some examples of Door attributes are: Alarm, DoorSwitch, Duress, EntryLastCard, Override, Value, Invalid Attempt, and Forced Entry. Events During operation, access control functions occur as a result of actions taken by users, by the controllers, or as the result of no action. This might include the triggering of motion detection or the discovery of a forced door entry. In Continuum systems, these are classified as events. There are several types of events. Each type can be monitored and acted upon through automatic and programmed control. All events are stored by the system. Alarms Alarms are a type of event that signal the controller of an unusual occurrence. Typical alarms might include glass break and intrusion attempts. Schedules Schedules allow the operation of the system to be regulated according to a particular time, day, week, month, and year. 18 Schneider Electric

23 Chapter 1: Introduction and System Overview User The user (or operator) is a person who manually acknowledge alarms, monitor system activity, and interact with the system on a regular basis. Programmer The programmer is a person who determines the operational flow of the system. The programmer writes programs in the Plain English programming language. Andover Continuum Security and TAC I/A Series Data Exchange Reference Guide 19

24 Chapter 1: Introduction and System Overview Supported Device Configurations The following configurations of I/A Series and Andover Continuum devices are supported. Note: The solid arrow lines signify the data exchange between components of the system. The dashed arrow lines signify the communication between the ACX 57xx controllers. Workplace Tech/MNB-1000 Controller/ACX 57xx/CyberStation In this example, the BACnet/IP XDriver enables communication between the ACX 57xx controller and a MNB-1000 controller. The WorkPlace Tech tool and Cyberstation workstations are used to configure their respective controllers WorkPlace Tech MNB Controller ACX 57xx Controller CyberStation 20 Schneider Electric

25 Chapter 1: Introduction and System Overview Enterprise Server/UNC/ENC Controller/ACX 57xx/CyberStation In this example, the BACnet/IP XDriver enables communication between the ACX 57xx controller and a UNC/ENC controller. The WorkPlace Pro and Cyberstation workstations are used to configure their respective controllers. Enterprise Server/ WorkPlace Pro UNC Controller ACX 57xx Controller CyberStation Enterprise Server/web.Client - 2 machine In this example, the Enterprise Server views schedules, alarm info, video, etc. via a web browser, while the web.client-enabled machine holds the database. Enterprise Server web.client Andover Continuum Security and TAC I/A Series Data Exchange Reference Guide 21

26 Chapter 1: Introduction and System Overview Enterprise Server/web.Client/CyberStation - 3 machine In this example, the Enterprise server views schedules, alarm info, video, etc. via a web browser, while web.client accesses the CyberStation database remotely via a web browser. Enterprise Server web.client CyberStation Multiple ACX 57xx Controllers This example shows a several ACX 57xx controllers sharing a single XDriver. The controller hosting the XDriver acts as the communications gateway between an I/A Series controller and the access control elements in all ACX 57xx controllers. I/A Series Controller ACX 57xx Controller with BACnet/IP XDriver ACX 57xx Controller ACX 57xx Controller 22 Schneider Electric

27 Chapter 1: Introduction and System Overview Role of XDriver and Plain English in Integration This section describes the roles of the BACnet/IP XDriver and the Plain English programming language in the integration. Role of XDriver Points The BACnet/IP XDriver acts as a gateway between the access control system and MNB-1000 and UNC/ENC controllers. The XDriver and its associated objects are created directly in the ACX 57xx access controller. It can read or write the values of any of the following BACnet objects: Analog Input, Analog Output, Analog Value, Binary Input, Binary Output, or Binary Value. XDriver Client objects are typically used to store a predefined access control system value and then transmit the BACnet equivalent of that value to an MNB-1000 or UNC/ENC controller. XDriver Server objects are typically used to modify an access control system value by receiving the BACnet equivalent of that value from an MNB-1000 or UNC/ENC controller. For more information about access control system values, refer to Appendix A. Role of PE Programs Plain English programs facilitate the transfer of data between XDriver objects and values in the access control system, typically Door attributes. PE programs are created manually in ACX 57xx controllers with CyberStation software using a predefined language syntax. These programs contain the logic that determines what access control values are shared across the combined system and the interval at which those values are shared. You can customize the number and content of the PE programs used in this system. This allows for maximum system flexibility. Andover Continuum Security and TAC I/A Series Data Exchange Reference Guide 23

28 Chapter 1: Introduction and System Overview For more information regarding PE programs, please refer to the Andover Continuum CyberStation Plain English Language Reference, Schneider Electric

29 Chapter 2 CyberStation This chapter contains the following topics: Introduction to CyberStation System requirements and pre-installation Overview of common CyberStation tools and tasks Andover Continuum Security and TAC I/A Series Data Exchange Reference Guide 25

30 Chapter 2: CyberStation Introduction Cyberstation is the application program that allows your workstation PC to configure, monitor and control the Continuum hardware. It is a collection of tools and applications that work together to help you create and interface with all the objects in the system. The figure below illustrates some of them. 26 Schneider Electric

31 Chapter 2: CyberStation System Requirements and Pre-Installation This section outlines the basic hardware and software requirements for CyberStation 1.81 software. Minimum/Recommended Hardware Requirements The following table shows the minimum and recommended Hardware Requirements for CyberStation version Hardware Requirements Minimum Recommended 1.6 GHz Pentium IV processor a 2.4 GHz Pentium IV processor 512 MB RAM 1024 MB RAM 20 GB hard drive 40 GB hard drive CD ROM drive CD ROM drive 10/100 MB Ethernet Network Interface card Parallel or USB port 10/100 MB Ethernet Network Interface card Parallel or USB port a. CyberStation performance is directly related to processor speed and RAM. Faster processor speeds and more RAM available to the program will increase performance. Software Requirements Depending on the configuration of your system (standalone or multiuser), you must meet a set of software requirements for your workstation PC prior to installing CyberStation. See the software requirements table on the next page. Andover Continuum Security and TAC I/A Series Data Exchange Reference Guide 27

32 Chapter 2: CyberStation Software Requirements Standalone Windows XP Professional with Service Pack 2 with Microsoft hotfix OR: Windows Server 2003 with Service Pack 1 Internet Explorer 6.0 with Service Pack 1 or Internet Explorer 7.0 MSDE 2000 (included on the Installation CD and installed automatically) with Service Pack 4.NET Framework 2.0 AND:.NET Framework 3.0 (for VideoLayout editor) Windows Installer 3.1 Full Microsoft Outlook or Microsoft Exchange software package a Multi-User (LAN) Workstation: Windows XP Professional with Service Pack 2 with Microsoft hotfix OR: Windows Server 2003 with Service Pack 1 OR: Windows Server 2003 R2 Internet Explorer 6.0 with Service Pack 1 or Internet Explorer 7.0 NET Framework 2.0 AND:.NET Framework 3.0 (for VideoLayout editor) Windows Installer 3.1 Full Microsoft Outlook or Exchange software package 1 Database Server - OS: Windows Server 2003, Service Pack 1 OR: Windows Pro, Service Pack 4 OR: Windows XP Pro, Service Pack 2.NET Framework 2.0 Database Server - SQL: Microsoft SQL Server 2005 or: Microsoft SQL Server 2000 with Service Pack 4 a. Required only for ing or paging alarms and ing reports. 28 Schneider Electric

33 Chapter 2: CyberStation CAUTION Database clean up of temporary information CyberStation requires the SQL Server Agent to be running on standalone workstations and database servers. The purpose of the agent is to perform database clean up of temporary information. Failure to observe this precaution will result in loss of CyberStation functionality and degraded system performance over a period of time. For more detailed information regarding CyberStation installation and system requirements, see: Andover Continuum Cyberstation Installation Guide, Version 1.81, Andover Continuum Security and TAC I/A Series Data Exchange Reference Guide 29

34 Chapter 2: CyberStation Overview of Common CyberStation Tools and Tasks This section provides an overview of CyberStation software support tools and tasks in the integrated security solution. For more detailed instructions regarding these tasks, see the Andover Continuum CyberStation for TAC I/A Series Access Control Essentials Guide, ACX 57xx Controller Update/Configuration When first implementing the integrated system, CyberStation can be used to update and configure the Comm Port of an ACX 57xx controller when its Comm 1 port has not been enabled for XDriver support. Note: The ACX 57xx controller must have the comm port enabled for XDriver support. If a controller is purchased that does not have the comm port enabled, you must call the Schneider Electric Repair Dept. at to purchase the upgrade option. To update, refer to the instructions regarding enabling the comm port that you receive with the.upd file from the Schneider Electric Repair Department. XDriver Support CyberStation is used to install and configure the BACnet/IP XDriver. For more detailed information regarding installing and configuring an XDriver, see Chapter 3 - Using the BACnet/IP XDriver. Creating Points One of the main uses of CyberStation in the Andover Continuum Security and TAC I/A Series solution is to create points (also called objects) within the ACX 57xx controllers. The types of points that can be created are: InfinityInputs, InfinityOutputs and InfinityNumerics. These points will later be configured as XDriver objects. 30 Schneider Electric

35 Chapter 2: CyberStation To create a point For details about specifying these configurations, see the Parameters section in Chapter 3 - Using the BACnet/IP XDriver. To create a point perform the following steps: Step 1: In the Continuum Explorer, select the Network or All Paths view. Step 2: Select the ACX 57xx controller in which you would like to store the new point. Step 3: Right-click the controller or select New in the Object menu to display a popup list of object classes. Step 4: Select one of the three applicable object classes: InfinityInput, InfinityOutput or InfinityNumeric. Andover Continuum Security and TAC I/A Series Data Exchange Reference Guide 31

36 Chapter 2: CyberStation For example, select InfinityNumeric to create an InfinityNumeric point object. Step 5: The New dialog, shown below, appears with the object type you selected displayed in the Objects of type field. In this case, it shows an InfinityNumeric object. Step 6: In the New dialog, enter a name for the point in the Object name field. CyberStation automatically fills in the Alias field, which you can change. Note: When creating an XDriver object, it is advised to use 16 or fewer characters for an object name. This allows the object name and alias to remain identical. Step 7: Click Create to enter the editor of the point you are creating. For more detailed information about creating points and objects, see Continuum CyberStation Configurator s Guide, or the Continuum online help. PE Programs Plain English is a proprietary programming language developed by Schneider Electric. In the Andover Continuum Security and TAC I/A Series system, Plain English programs are used to facilitate the 32 Schneider Electric

37 Chapter 2: CyberStation transfer of data between the access control system and the XDriver objects. You will use the Plain English IDE in CyberStation to create and edit the programs needed for this task. For detailed information about Plain English programming, refer to the Andover Continuum CyberStation Plain English Language Reference, , or the Continuum online help. web.client for Web-based Access web.client is an extension of CyberStation used in the system to provide web-based access to most system functions. It is an additional tool that can monitor and control your access control system. For more specific information regarding web.client installation and capabilities, see Chapter 4 - web.client. Andover Continuum Security and TAC I/A Series Data Exchange Reference Guide 33

38 Chapter 2: CyberStation 34 Schneider Electric

39 Chapter 3 Using the BACnet/IP XDriver This chapter contains the following topics: Overview of the BACnet/XDriver security solution Installation concepts and guidelines for the XDriver Configuration of the XDriver point parameters Description of XDriver objects used with this solution General programming guidelines for the XDriver solution Andover Continuum Security and TAC I/A Series Data Exchange Reference Guide 35

40 Chapter 3: Using the BACnet/IP XDriver BACnet/IP XDriver Overview The Schneider Electric BACnet/IP XDriver interface acts as a gateway between a ACX 57xx Controller and BACnet/IP-enabled devices. The gateway, in conjunction with Plain English programs, can present access control values as BACnet values, and provide these values acting either as a client device or a server device. The user is instructed on how to create the different kinds of XDriver objects that facilitate this functionality in the sections that follow. BACnet/IP XDriver Requirements One Schneider Electric ACX 57xx controller, with firmware version or higher is required. Although the XDriver does not physically use a comm port it does require one to facilitate loading and installation. The option to enable Comm Port 1 can be specified when ordering the ACX 57xx controller. Note: If a controller is purchased that does not have the comm port enabled, you must call the Schneider Electric Repair Dept. at to purchase the upgrade option. The model number and serial number of the ACX 57xx controller will be required. You will receive a update file which should be installed as directed. Verifying the Controller Options for Installation To verify that the ACX 57xx is ready for XDriver installation: Step 1: From Continuum Explorer, double-click the controller where you will be loading the XDriver OR Highlight the controller and select Open from the File menu. Step 2: When the controller editor window appears, click the Options tab. 36 Schneider Electric

41 Chapter 3: Using the BACnet/IP XDriver Step 3: Verify that the Comm Port 1 is bit value 9 (hex). If the bit value of Xdriver Comm 1 is 9, then the comm port is ready for installation of the BACnet/IP XDriver. Note: The item in parenthesis after the bit value in the Xdriver Comm field is the checksum appropriate to that version of the XDriver. BACnet/IP XDriver Installation Note: Only one BACnet/IP XDriver can be installed per controller. The BACnet/IP XDriver software is loaded via the comm port, as follows: Andover Continuum Security and TAC I/A Series Data Exchange Reference Guide 37

42 Chapter 3: Using the BACnet/IP XDriver Step 1: Click the controller or click on the + sign next to the controller icon to display its contents in the viewing pane. Step 2: Step 3: Double-click on the COMM1 object under the controller. From the General tab, select Xdriver from the Default Mode dropdown menu. Step 4: Click on the Browse button in the XDriver File Name field. Note: XDriver files commonly use the extension.xdr. Step 5: Select the XDriver file on the server or workstation. 38 Schneider Electric

43 Chapter 3: Using the BACnet/IP XDriver Step 6: Step 7: Step 8: Step 9: Step 10: Click the OK button to close the Comm Port editor. Right-click on the controller from step 1 and select Send To Controller to reload the controller. Once the controller is reloaded, open the Comm Port editor for Comm1. Click the XDriver Status button to confirm that it was properly installed on the controller. The XDriver details window should respond with the status indicating Xdrvinstalled, which means the XDriver is loaded and ready for use. See below: Configuration Overview The BACnet I/P Xdriver allows the creation of three types of points: Client XDriver point, Server XDriver point, and a DeviceSelf Object. The Client XDriver point is a point that polls and/or writes new values to an object that resides in another BACnet device. Andover Continuum Security and TAC I/A Series Data Exchange Reference Guide 39

44 Chapter 3: Using the BACnet/IP XDriver Server XDriver points operate in a passive mode. They give other BACnet devices visibility and control over their points. Server XDriver points include a security option that can be set to read-only or read/ write access. The DeviceSelf Object is a required object for the BACnet/I/P XDriver. There must be only one DeviceSelf Object per BACnet XDriver. Its function is to specify operating parameters for the XDriver. A DeviceSelf Object MUST be created to enable communication, and to start the driver. Although the XDriver can contain both Client and Server objects, the XDriver operates most efficiently as a BACnet client, especially when large amounts of data are transferred between the access control system and the BACnet/IP network. As such, the user is advised to utilize Client objects to distribute access control values whenever possible. Server objects are used only when an access control value must be adjusted from outside the access control system. Parameters InfinityInput, InifintyOutput and InfinityNumeric points created in CyberStation must be configured with specific parameter values when used as XDriver objects. After the comm port is enabled and the BACnet/IP XDriver is installed, new points should be configured with the following values. To configure these points: Step 1: Double-click on the point that you would like to configure to open the corresponding object editor. To create an entirely new Infinity point, see the To Create a Point section in Chapter 2 - Cyberstation. 40 Schneider Electric

45 Chapter 3: Using the BACnet/IP XDriver Step 2: Six additional fields appear below the "Port" field. They are "Point Access", "Type", "Instance", "Property", "BACnet Network" and "IP Address". Step 3: See below for the values required for each parameter field. Point Access From the table below: Value Access Type Description 0 Client or Self The point will poll and/or write as a Client XDriver Point 1 Server Read Only BACnet can ONLY read this point. 2 Server Read/Write BACnet can read and write to this point. 1. Select the appropriate Point Access type. 2. Enter the value into the Point Access field. 3. Press TAB. Andover Continuum Security and TAC I/A Series Data Exchange Reference Guide 41

46 Chapter 3: Using the BACnet/IP XDriver Type From the table below: Value Object Type 1. Select the appropriate Object Type. XDriver Client object: the type matches the BACnet object type of the remote object that it is referencing. XDriver Server object: the type determines the BACnet object type of the internal XDriver Server object. 2. Enter the value into the Type field. 3. Press TAB. 0 Analog Input 1 Analog Output 2 Analog Value 3 Binary Input 4 Binary Output 5 Binary Value Instance This field accepts a number from 1 to 65, Schneider Electric

47 Chapter 3: Using the BACnet/IP XDriver If an Instance number > is required, then set the Instance Number to 0 and add the number to the end of the I/P address. The Instance number must be prefixed with a capital I (i.e. xxx:xxx:xxx:xxx Iyyyyyy where xxx is the IP address and yyyyyy is the Instance number). Property For Client or Server points, the value should always be 85 (Present Value). Andover Continuum Security and TAC I/A Series Data Exchange Reference Guide 43

48 Chapter 3: Using the BACnet/IP XDriver BACnet Network 1. Enter the BACnet/IP network number that this XDriver is connected to. 2. Press TAB. IP Address If this point is a Client XDriver point, then this field must contain the TCP/IP address of the other BACnet device, using the format: Optional Parameters XXX.XXX.XXX.XXX The additional optional parameters referenced below are allowed in this IP Address field. These options must be added after the TCP/IP address, if one is used, and require a <space> character between each parameter. Instance Number If an instance number > is required then set the instance number to 0 and add the number to the end of the TCP/IP address. the instance number must be prefixed with a capital I as shown below: XXX.XXX.XXX.XXX IYYYYYY where XXX is the IP address and YYYYYY is the instance number. Engineering Units If the point or object is configured as a BACnet Server point or object, the engineering units for each point may be assigned using this field. The units are defined by entering U followed by the enumerated value from the Engineering Units conversion table. The example below would correspond to Pascal: U53 44 Schneider Electric

49 Chapter 3: Using the BACnet/IP XDriver Priority The present value of Analog Output, Analog Value, Binary Output, and Binary Value points or objects can be read or written with a priority level. Different priority levels may be assigned to individual points by assigning the priority parameter to each XDriver point. For both Client and Server objects, if no Priority is assigned the XDriver uses priority 10 when reading or writing the present value. If a Priority is assigned to the DeviceSelf object then the XDriver uses that priority level as its default priority level. To clear the value from the priority array set the XDriver point to NotSet. This will clear the appropriate value (determined by the priority level of this point) from the priority array. The following sample parameter would assign priority level 6 when the value of the point/object is modified: P6 Relinquish Default For Server objects only: When all 16 entries in the priority array are empty the value of the commandable property shall have the value specified by the relinquish default property. This determines the server object s value when present value has been written at no priority. The example below would set the Relinquish Default value to 100: R100 Destination Address Andover Continuum Security and TAC I/A Series Data Exchange Reference Guide 45

50 Chapter 3: Using the BACnet/IP XDriver For Client XDriver objects only: This optional parameter is used to communicate through BACnet routers, so that messages can be relayed from the BACnet/IP network to another. (i.e. MS/TP or ISO Ethernet ). The destination address is used in conjunction with the BACnet network number (Param5) to address messages to devices on other networks. The Destination address (DADR) must be denoted as follows: DADR=<BACnet MAC Address> Examples for an MS/TP network would be (specified in decimal notation). DADR=1 DADR=19 Examples for an ISO ( Ethernet ) would be: DADR=00:0B:DB:A2:A0:15 DADR=00:40:11:3C:4F:22 Note: The Destination address must be in capital letters with equals = sign and no spaces. BACnet/IP Port By default the XDriver uses UDP port 0xBAC0. This may be changed by adding the following command PORT= to the BACnet DeviceSelf object. PORT=BAC1 Note: The BACnet UDP port address must be in capital letters with equals = sign and no spaces. The address must be represented in hexadecimal format and may only be added to the BACnet DeviceSelf object. 46 Schneider Electric

51 Chapter 3: Using the BACnet/IP XDriver BACnet XDriver Points Overview This section describes and provides many examples of BACnet XDriver points. Note: The term points may be used interchangeably with objects in this solution. Client BACnet XDriver Points Client points poll and/or write new values to points in other BACnet devices. Client points are not visible to other BACnet devices. If a point is created as an Infinity INPUT, then its function is to poll an object for its current value. If a point is created as an Infinity OUTPUT, it writes a new value to the Present Value property of the remote object only if its value has changed. If a point is created as an Infinity NUMERIC, it polls and writes as specified above. When a Client object is created, you must set the Point Access parameter to 0. The Type parameter is set to match the kind of object the Client object is referencing on the other BACnet device. The Instance Number is set to match the instance number of the object that the Client references. The Type and Instance Number must be unique for each Client point. The IP Address is set to the TCP/IP address of the host BACnet device. Andover Continuum Security and TAC I/A Series Data Exchange Reference Guide 47

52 Chapter 3: Using the BACnet/IP XDriver Examples of a Client BACnet XDriver Point Example 1 Client BACnet point Point Access = 0 (Client BACnet XDriver Point) Type = 1 (Analog Output) Instance = 4 ( Instance is 4) Property = 85 (Present Value) BACnet Network = 1 (BACnet network number is 1) IP Address = = (TCP/IP Address of other device) Note: If an Instance number > is required the Instance field should be set to 0 and the Instance number appended to the end of the IP address with a <space> Iyyyyyy separating the 2 parameters. 48 Schneider Electric

53 Chapter 3: Using the BACnet/IP XDriver Example 2 Client BACnet point with Priority Level Point Access = 0 (Client BACnet XDriver Point) Type = 4 (Binary Output) Instance = 1 (Instance is 1) Property = 85 (Present Value) BACnet Network = 1 (BACnet network number is 1) IP Address = = (TCP/IP Address of other device) Priority Level = 8 Andover Continuum Security and TAC I/A Series Data Exchange Reference Guide 49

54 Chapter 3: Using the BACnet/IP XDriver Example 3 Client BACnet XDriver point with network addressing (MS/TP device) Point Access = 0 (Client BACnet XDriver Point) Type = 0 (Analog Input) Instance = 3 (Instance is 3) Property = 85 (Present Value) BACnet Network = 2765 (BACnet network number is remote) IP Address = DADR=1 50 Schneider Electric

55 Chapter 3: Using the BACnet/IP XDriver Server BACnet Points Server BACnet points allow other BACnet devices access to ACX 57xx controller objects. These must be set up with either Read or Read/Write access. Because Server objects are visible to other devices as BACnet objects, any BACnet device can read their properties. When a Server object is created, you must specify the Point Access (1 or 2). The Type field is set to match the kind of object you are creating. The Instance is a number with a unique value in the range of Care should be taken when choosing values for BACnet objects. You should ensure that no two objects have the same type/ instance combination. The IP Address field is left blank unless optional parameters are required: Engineering units have to be prefixed with the letter U followed by their corresponding numeric value. Priority levels are prefixed with the letter P. The Relinquish Default values are prefixed with the letter R. Andover Continuum Security and TAC I/A Series Data Exchange Reference Guide 51

56 Chapter 3: Using the BACnet/IP XDriver Example 1 Server BACnet Point Point Access = 2 (Read/Write BACnet Server Point) Type = 2 (Analog Value) Instance = 8 (Instance is 8) Property = 85 (Present Value) BACnet Network = 1 (BACnet network number is 1) IP Address = <blank> (Not Required) 52 Schneider Electric

57 Chapter 3: Using the BACnet/IP XDriver Example 2 Server BACnet Point with Engineering Units Point Access = 2 (Read/Write BACnet Server Point) Type = 2 (Analog Value) Instance = 32 (Instance is 32) Property = 85 (Present Value) BACnet Network = 1 (BACnet network number is 1) IP Address = Units = 62 = (Deg Celsius) Andover Continuum Security and TAC I/A Series Data Exchange Reference Guide 53

58 Chapter 3: Using the BACnet/IP XDriver Example 3 Server BACnet Point with Engineering Units, Relinquish Default, and Priority Level Point Access = 2 (Read/Write BACnet Point BACnet Server) Type = 2 (Analog Value) Instance = 1 (Device Instance) Property = 85 (value) BACnet Network = 1 (BACnet network number is 1) IP Address = Units = Percent Relinquish Default value = 50 Priority Level = 5 54 Schneider Electric

59 Chapter 3: Using the BACnet/IP XDriver DeviceSelf Object There can be only one DeviceSelf object per BACnet/IP XDriver. The DeviceSelf object is an InfinityNumeric and is required to enable the BACnet XDriver. Its function is to configure the XDriver s run-time parameters. The Point Access must be set to Read/Write (2). The DeviceSelf object must be accessible via BACnet for remote devices to query driver information. The Type must be set to 200 to specify this is the Device Self Object. The Instance should be set to a unique value between This number must be unique among all the BACnet devices participating in the entire BACnet internetwork. For the DeviceSelf object, the Property is used as a tuning variable called Service Limit. The Service Limit parameter specifies the number of BACnet/IP packets to send per second. If it is set to 25 and there are less than 26 packets to be sent then all of the packets will be sent for each second. If there are more than 25 to be sent for each second then the BACnet/IP XDriver will send up to 25, then wait for one second before continuing to send the remainder of the point values. Valid values are BACnet Network is used to specify the BACnet network number that this XDriver is connected to. The range is The default is 0. The IP Address field is only used to change the default priority level and/or the BACnet/IP UDP Port address. Andover Continuum Security and TAC I/A Series Data Exchange Reference Guide 55

60 Chapter 3: Using the BACnet/IP XDriver Example 1 DeviceSelf Object Point Access = 2 (2 is required for DeviceSelf Object) Type = 200 (200 is required for DeviceSelf Object) Instance = 99 (Device SelfObject unique Instance is 99) Property = 25 (Tuning variable: 25 points per second) BACnet Network = 1 (BACnet network number is 1) IP Address = <Blank> (Not Required) 56 Schneider Electric

61 Chapter 3: Using the BACnet/IP XDriver Example 2 DeviceSelf Object with a specific UDP port address Point Access = 2 (2 is required for DeviceSelf Object) Type = 200 (200 is required for DeviceSelf Object) Instance = 62 (DeviceSelf Object unique Instance is 62) Property = 25 (Tuning variable: 25 points per second) BACnet Network = 1 (BACnet network number is 1) IP Address = PORT=BAC1 This would set the BACnet UDP port to 0xBAC1, by default the UDP port is set to 0xBAC0. Andover Continuum Security and TAC I/A Series Data Exchange Reference Guide 57