Pow-R-Command 1000 SOAP/XML Server

Transcription

1 Pow-R-Command 1000 SOAP/XML Server Technical Data TD E Effective October 2007 New Information Contents General Pow-R-Command 1000 System Applications for PRC1000 Systems Network Philosophy PRC1000 Communication Levels Device Level Communication System Level Communication Internet Protocols Web Communication Basics Simple Object Access Protocol (SOAP) and XML Overview Benefits of Using SOAP The Pow-R-Command 1000 System and SOAP/XML Connecting to a SOAP/XML Server SOAP Client Abilities SOAP Server and WSDL Applications for a Pow-R-Command 1000 SOAP Server Start-Up and the SOAP Server Notable Standards Built Around SOAP and XML Pow-R-Command Technical Resource Library

2 General Pow-R-Command 1000 System The Pow-R-Command 1000 (PRC1000) system is a complete network of devices that allows a facility s electrical use to be efficiently managed. With the Pow-R-Command 1000, individual loads can be switched through a network of individual panels which are influenced by building automation systems, wall switches, time schedules, software, or through telephone commands, etc. See Technical Document TD E for more information on the Pow-R-Command 1000 system. Applications for PRC1000 Systems The Pow-R-Command 1000 system is primarily designed for larger facilities where multiple nodes are networked together to allow control through software. However, the Pow-R-Command 1000 can be scaled down to meet the needs of some smaller facilities while offering the same functions as a large networked system. The Pow-R-Command system efficiently controls electrical loads yet maintains a compact design. It may also be integrated seamlessly into building automation systems, security systems, and fire/emergency systems. Network Philosophy The Pow-R-Command 1000 system is designed to interface with a number of devices. In most circumstances, the Pow-R-Command system uses an RS-485 protocol and communication standard to send and receive commands between control devices. This RS-485 network is accessed through either RS-232 or Ethernet TCP/IP protocol. For more information on RS-485 to RS-232 and Ethernet, please see Technical Document TD E. In some circumstances, the Pow-R-Command 1000 network must integrate, through software communication, into large systems. These large systems are commonly titled Building Automation Systems (BAS). Currently the Pow-R-Command 1000 system communicates across the BACnet protocol. HVAC System Fire/Emergency System Security/Access Control System Other Mechanical Control System Building Automation System SOAP/XML Client Pow-R-Command 1000 SOAP/XML Server Lighting Control System RS-485 Pow-R-Command Workstation Ethernet Pow-R-Command Network Access Device Networked Pow-R-Command 1000 Lighting Panelboards FIGURE 1. PRC1000 SOAP/XML SERVER IN POW-R-COMMAND 1000 SYSTEM 2 EATON CORPORATION Cutler-Hammer Pow-R-Command 1000 Technical Data TD E Effective: October 2007

3 PRC1000 Communication Levels Device Level Communication The PRC1000 system may have any number of devices, or nodes, connected to the network. Each node has a specific task. Though the devices perform different functions, they must be able to communicate and transmit data to, or through, each other. Each device, no matter the manufacturer, speaks to the others at the device level using a common protocol and a common transmission method. System users send and receive data to/from the system through a central control point. System Level Communication In some circumstances, it is not possible for all devices to communicate using the same protocol and transmission standards. In instances such as this, the alternative is to communicate at the system level. When two systems are integrated, there is commonly a software bridge that transfers/translates messages across systems. When all components are in place, there can be any number of systems acting and operating independently. At the center of these systems is a common communication platform through which each system passes data. Internet Protocols Over the last decade, nothing has shaped the manner that people interact with data more than the Internet and the World Wide Web (a.k.a the Web). Not only has the Web come to be a place for posting data and ideas, but the technology that drives the Web has begun to make its way into other applications. The influence of the Web technology and the exchange of data extends to facility system control. Web Communication Basics There are several protocols that drive data communication on the Web. Many of these protocols have very familiar names. Ethernet, Transmission Control Protocol/Internet Protocol (TCP/IP), and Hyper Text Transfer Protocol (HTTP) are two of the most popular. Each of these protocols play some part in the transmission of data from one machine to another. HyperText Markup Language (HTML) is the authoring language used to create documents on the World Wide Web. These documents are typically viewed as Web pages through a Web browser, such as Internet Explorer or Mozilla. As HTML is to Web pages, XML is to data. Extensible Markup Language (XML) is a flexible way to create common information formats and share both the format and the data on the World Wide Web, Internets, and elsewhere. Simple Object Access Protocol (SOAP) and XML Overview Simple Object Access Protocol (SOAP) is built on XML. Because SOAP is built on existing Web technology, it can be used with the Web and other applications that understand it. SOAP is not a replacement for XML, but a protocol built on XML standards. Each SOAP message is an envelope. Each envelope contains a destination, a method of travel, and a data payload. Because SOAP is a text-based protocol, it travels across HTTP and its destination is defined by a URL. URL stands for Uniform Resource Locator. It is the HTTP address used by the World Wide Web to specify a certain site. A URL is the unique identifier, or address, of a Web page on the internet. When a user wants to visit a Web page, the address is typed in the address field of the Web browser. Typically, at the head of the address there is a statement such as followed by the URL, such as The HTTP declaration tells the Web browser how to move the data. The gives the address of the data to be received, while HTML coding tells the Web browser how to display the data received. Inside the SOAP envelope are XML declarations (tags) that describe the data being sent. Inside the declarations is the actual data being sent. These declarations must be in a format that is common to all parties involved in the communication. Benefits of Using SOAP The process of integrating systems using SOAP can be somewhat complex. All applications intended for integration must be capable of sending and receiving SOAP formatted data. Additionally, each application must have a common method for describing the actions it can accept. Despite this, there are still a great number of benefits for using SOAP when integrating the system. Loosely-coupled: As mentioned, any application that can understand SOAP messages can process, display, and act on data it receives. Equipping an existing system with this ability is not overly complex. This is in contrast to protocols such as DCOM or CORBA, as these systems are manufactured to work only with like types. Designed for distributed intelligence: A benefit derived from loose coupling is the ability to distribute and add to the processing power of a system. Once the rules for communication are created, any device or system that follows those rules can be added. When a device or system is added, it does not lose any of its abilities; it simply adds more abilities to the entire larger system. Built on existing technologies: As mentioned, SOAP is built on existing protocols such as XML. Because of this, the strengths of other applications can be leveraged and used to better control systems and devices. Such applications include Web browsers, which have become a very familiar way for users to interact with data. Text-based protocol: Text-based protocol affords one great benefit. This is the ability to use HTTP to move the envelopes of data. HTTP is the standard protocol used to move data across the Web. As a result, firewalls commonly allow data sent through HTTP. This yields the ability to send data from systems that are physically scattered throughout the world through one common communication platform. Flexible transmission methods: SOAP envelopes can also be transported through Simple Mail Transfer Protocol (SMTP), which is used for most traffic, and File Transfer Protocol (FTP), which is commonly used to exchange files. EATON CORPORATION Cutler-Hammer Pow-R-Command 1000 Technical Data TD E Copyright

4 The Pow-R-Command 1000 System and SOAP/XML To enable facilities to integrate lighting control with other systems through SOAP, Eaton has developed a SOAP/XML server for use with the Pow-R-Command 1000 system. The SOAP/XML server also provides a connection point for color graphics software, which leaves the main system-access device free for maintenance and programming operations. The SOAP/XML server is an optional hardware component. The purpose of this server is to convert the SOAP messages transmitted across HTTP/Ethernet to an RS-485 protocol. The Pow-R-Command 1000 SOAP server is an addressed hardware device that is connected to the PRC1000 system network. All programming of the Pow-R-Command 1000 control nodes is completed through the Lighting Optimization Software. When using a SOAP/XML device, software connection to the Pow-R-Command 1000 network is still made through a Network Access Device. Typically, the Network Interface Device will have an address of 0. All control nodes on the network will have an address ranging from 1 to 120. The SOAP/XML server address defaults to a reserved address, which is typically 122. The SOAP/XML server is a gateway between SOAP protocol and RS-485. As such, it is equipped with an Ethernet RJ45 Cat 5 connector and a 4-pin connector with termination points for system network RS-485 communication. Network communication is carried out over a shielded twisted-pair wire using the RS-485 standard. Connecting to a SOAP/XML Server The SOAP/XML server is designed to receive and process requests from SOAP clients. Based upon the request, the SOAP server will also return an answer to the SOAP client. In order for the SOAP client to send a request/command, it must first find the correct location of the SOAP server. As with any Web device, a Pow-R-Command SOAP/XML server s location is designated by an IP address. The SOAP server IP address is assigned by the facility IT or MIS group. The IP address must be a static IP address. This means that no other devices can use the IP address assigned to the SOAP/XML server and this address can never be changed by automatic means. SOAP Client Abilities The primary use for the SOAP/XML server is to provide SOAP clients the ability to send/receive simple commands and status to/from the Pow-R-Command network. Generally speaking, a SOAP client can be any number of applications including building automation systems, Web browsers, and office tools such as Microsoft Excel. The only condition that a SOAP client must meet is that it has been programmed to send/receive SOAP messages over HTTP/Ethernet. The Pow-R-Command SOAP/XML server is equipped to handle 1,000 concurrent SOAP requests at one point in time. Each of the requests are held by the SOAP/XML server until the request has been processed and answered, or for 30 seconds, whichever comes first. Once either of these conditions is met, the request is automatically erased from the SOAP/XML server. Currently, a SOAP client can request the following from the SOAP server: Send request for status of switching devices, input levels, output levels, counts and alarms. Change set points of analog inputs. Override switching devices, inputs, schedules, groups and outputs. It must be noted that a SOAP client is not capable of: Assigning or reprogramming groups stored on PRC1000 controllers. Creating time schedules stored on PRC1000 controllers. Creating holidays stored on PRC1000 controllers. The Pow-R-Command SOAP/XML server is not intended to completely program an entire system. In order to program all nodes and associated inputs, outputs, groups, time schedules and holidays, the Lighting Optimization Software is required. For more information on the Pow-R-Command 1000 Lighting Optimization Software, please see Technical Document TD E. SHLD LAN + - Gnd +15 SOAP/XML Server Ethernet CAT5 Ethernet +15 VDC GND - RS Network FIGURE 2. POW-R-COMMAND SOAP/XML NETWORK CONNECTIONS 4 EATON CORPORATION Cutler-Hammer Pow-R-Command 1000 Technical Data TD E Effective: October 2007

5 SOAP Server and WSDL In order for a SOAP client s messages to be understood, there must be a standard for actions and a format for request at the SOAP server. This standard is created in a Web Service Director Language (WSDL) file loaded onto the SOAP/XML server. Eaton has developed a WSDL file for the Pow-R-Command 1000 SOAP server, which provides the ability to carry out and understand commands described in this document. This WSDL file is loaded onto the SOAP/XML server prior to installation. With this WSDL file, integrators can create SOAP clients to communicate with the SOAP server. A copy of the Pow-R-Command 1000 SOAP server WSDL file is available upon request. Applications for a Pow-R-Command 1000 SOAP Server Applications for the Pow-R-Command SOAP/XML server are numerous with the potential for more as the market is educated on the potentials of using SOAP-based communication. However, one application is obvious and already in practice. This application has the ability to remotely monitor and command the Pow-R-Command 1000 system in a rich graphic environment without the need for Pow-R- Command 1000 software on each client machine. See Technical Document TD E Custom Graphic Screens and Data Logging Software and Technical Document TD E Web Server Software for more information. SOAP server allows data to be sent/received through applications such as a Web page or a spreadsheet (from Microsoft Excel) to client machines. Inside the Web page or spreadsheet are a series of elements, which are based on data from the Pow-R-Command system. To update the state of the elements, the client program can be modified to automatically poll the system, or modified to allow the user to enter a command to poll the system. Each time an update occurs, the client sends a request to the SOAP server, which in turn either retrieves the data from, or sends a command to, the network device. Once this action has been carried out, the SOAP server sends a SOAP formatted response back to the client. The response may contain a confirmation that the command has been carried out or it may contain the data the client originally requested. All graphics used to display this data are created by the system/web developer for the facility or a third-party integrator. Resident Pow-R- Command software is not required for the client machine; neither is it necessary for a PC to act as a PRC1000 server. Start-Up and the SOAP Server When a Pow-R-Command 1000 system is purchased and installed in a facility, a factory authorized technician is sent to the job site. The technician programs all nodes and ensures the installation of the network is correct. The technician can also provide the facility s maintenance staff with training on all Pow-R-Command 1000 system components. Note that when a Pow-R-Command SOAP device is purchased for third-party integration, the Eaton technician assumes no responsibility, nor the position of system integrator. If desired, additional support services can be purchased from Eaton to provide support for the systems integrator. Notable Standards Built Around SOAP and XML As mentioned, the use of SOAP and, specifically, XML is widespread. Currently, there are two very notable standards being constructed around SOAP/XML. The first of these standards involves a standard well known in the integration industry. This standard is OLE for Process Control or OPC. Currently, OPC is based on Microsoft s DCOM model, but is progressing toward an XML version of the OPC standard. Currently, the Pow-R-Command 1000 system has an optional OPC server available. For more information on the Pow-R-Command 1000 OPC Server, please see Technical Document TD E. The second is a standard being developed by Microsoft, which is known as a.net architecture. In the most basic terms, the Microsoft.NET standard creates a model, tools and standards for efficient communication. The.NET architecture uses technologies like XML and adds them to other standards and distributed network models to form a very powerful platform for all applications to communicate across. Part of the.net architecture can be seen on many Web sites and is used with security and user identification. For more information on Microsoft s.net architecture, please visit In many situations, integrators will use development tools designed for.net applications to establish communication with the Pow-R- Command 1000 SOAP/XML server. EATON CORPORATION Cutler-Hammer Pow-R-Command 1000 Technical Data TD E Copyright

6 Pow-R-Command Technical Resource Library For additional information on Pow-R-Command 1000 Networks and components, please refer to the appropriate Technical Document. As of the date of this document, Technical Documents for the Pow-R-Command 1000 system are as follows: Title Publication Number PRC1000 Universal System Controller Product Reference TD E PRC1000 System Overview TD E PRC1000 Telephone Override Controller Product Reference TD E PRC1000 Networking TD E PRC1000 Lighting Optimization Software TD E PRC1000 Human Machine Interfaces TD E PRC1000 Protocol Exchanges TD E PRC Vdc Dimming Electronic Ballasts Control TD E PRC1000 OPC Server TD E PRC1000 SOAP/XML Server TD E PRC1000 Custom Graphics and Data Logging..... TD E PRC1000 Web Server Software TD E PRC1000 Universal I/O Module TD E PRC1000 Network Signal Repeaters TD E RS-485 Network For the most current list of documents on the Pow-R-Command 1000 system, and available downloads, please visit BACnet is a registered trademark of American Society of Heating, Refrigerating and Air-Conditioning Engineers (ASHRAE). Microsoft, Explorer and Excel are registered trademarks of Microsoft Corporation. Pow-R-Command is a trademark of Eaton Corporation. FIGURE 3. SOAP/XML CLIENT NETWORKED INTO POW-R-COMMAND SYSTEM 6 EATON CORPORATION Cutler-Hammer Pow-R-Command 1000 Technical Data TD E Effective: October 2007

7 Notes EATON CORPORATION Cutler-Hammer Pow-R-Command 1000 Technical Data TD E Copyright

8 Eaton Corporation Electrical Group 1000 Cherrington Parkway Moon Township, PA United States 877-ETN-CARE ( ) Eaton.com 2007 Eaton Corporation All Rights Reserved Printed in USA Publication No. TD E / Z5828 October 2007