WebRelay-Quad TM Users Manual Revision: 2.4 - June 2012 Covers: X-WR-4R1-5 X-WR-4R1-I X-WR-4R1-E TM a division of... Xytronix Research & Design, Inc. North Logan, Utah, USA © 2006-2012 Xytronix Research & Design, Inc.
Revision 2.4 WebRelay-Quad™ Users Manual Contents Trademark and Copyright Information Warranty FCC Statement Installation Guidelines (Read Before Installing) Section 1: Introduction 1.1 Features 1.2 WebRelay-Quad™ Models Available 1.3 Connectors & Indicators 1.4 Example Configurations and Applications 1.4.1 Basic Setup 1.4.2 Controlling High Power Devices 1.4.3 Using WebRelay-Quad™ Without a Computer Section 2: Installation and Setup 2.1 Mounting 2.1.1 Wall Mounting 2.1.2 DIN-Rail Mounting 2.
Revision 2.4 WebRelay-Quad™ Users Manual Appendix Appendix A: Restoring Factory Default Settings Appendix B: Installing New Firmware Appendix C: Specifications Appendix D: Mechanical Information Xytronix Research & Design, Inc.
Revision 2.4 WebRelay-Quad™ Users Manual Trademark and Copyright Information This document is Copyright ©2005-2012 by Xytronix Research & Design, Inc. All rights reserved. WebRelay-Quad™ and ControlByWeb™ are Trademarks of Xytronix Research & Design, Inc. 2005-2012. All parts of this product and design including but not limited to firmware, hardware design, schematics, PCB layout, concept, graphics, users manual, etc., are property of Xytronix Research & Design, Inc. ©2012.
Revision 2.4 WebRelay-Quad™ Users Manual FCC Statement This device complies with Part 15 of the FCC Rules. Operation is subject to the following two conditions: ━ This device may not cause harmful interference. ━ This device must accept any interference received, including interference that may cause undesired operation. Warning: This equipment has been tested and found to comply with the limits for a Class B (Class A for POE model) digital device, pursuant to Part 15 of the FCC Rules.
Revision 2.4 WebRelay-Quad™ Users Manual Installation Guidelines (Read Before Installing) Do not open the WebRelay-Quad™ enclosure. This will void the warranty. ━ This unit must be installed by qualified personnel. ━ This unit must not be installed directly outdoors. ━ This unit must not be used for medical, life saving purposes, or for any purpose where its failure could cause serious injury or the loss of life. Notes about security: By design, WebRelay-Quad™ is very secure.
Revision 2.4 WebRelay-Quad™ Users Manual Section 1: Introduction WebRelay-Quad™ is a compact, four-relay module with a built in web server. It can be controlled and/or monitored over any IP network including private networks, IP-based industrial control networks, and the Internet. Users can operate WebRelay-Quad™ using a web browser or a custom application. Computers, PLCs, or automation controllers may control and monitor WebRelay-Quad™ without user intervention.
Revision 2.4 WebRelay-Quad™ Users Manual 1.3 Connectors & Indicators WebRelay-Quad™ has a removable terminal connector and an Ethernet connector. The terminal connector is used to provide power to the internal web server, and is used to connect external electrical loads to the relay contacts. There are seven LED indicators on WebRelay-Quad™. The Power LED (green) indicates that the unit is powered. Four LEDs (green) labeled Relay 1-4 which indicate that the corresponding relay coil is energized.
Revision 2.4 WebRelay-Quad™ Users Manual 1.4 Example Configurations and Applications WebRelay-Quad™ is very versatile and can be used in many applications. Several basic installation schemes are illustrated in this section. 1.4.1 Basic Setup The illustration below shows a simple WebRelay-Quad™ application. The example shows how a 3-color industrial light tower can be controlled remotely over an Ethernet network.
Revision 2.4 WebRelay-Quad™ Users Manual 1.4.2 Controlling High Power Devices WebRelay-Quad™ can be used to control high power devices by using an external relay. In this configuration, WebRelay-Quad™ does not control the load directly, but controls the external relay and the external relay controls the load. This is illustrated below.
Revision 2.4 WebRelay-Quad™ Users Manual Section 2: Installation and Setup Installation consists of mounting WebRelay-Quad™, connecting to an IP network, providing power, configuring via a web browser, and wiring relay contacts to the device that will be controlled. 2.1 Mounting WebRelay-Quad™ can be be wall mounted or DIN rail mounted. It should be mounted in a clean dry location where it is protected from the elements.
Revision 2.4 WebRelay-Quad™ Users Manual 2.2 Connection CAUTION: MAKE SURE POWER IS SHUT OFF BEFORE WIRING! Two removable terminal connectors are provided for simple wiring to WebRelay-Quad™. The correct wiring procedure is as follows; 1. Make sure power is turned off. 2. Remove terminal connectors from WebRelay-Quad™ and make wiring connections to the terminals. 3. Reconnect terminal connectors. 4. Apply power.
Revision 2.4 WebRelay-Quad™ Users Manual 14-pin connector pinout: Pin VIN+ Description Power supply input. Connect to the positive side of the appropriate power supply. DO NOT EXCEED MAXIMUM POWER SUPPLY VOLTAGE. Model X-WR-4R1-5 5VDC Power supply Model X-WR-4R1-I 9~28VDC Power supply Model X-WR-4R1-E Power Over Ethernet model. These units do not require a power supply to be connected to this pin when the unit is connected to an 802.3af compliant network.
Revision 2.4 WebRelay-Quad™ Users Manual 2.2.2 Network Connection Connect the Ethernet port to a 10 Base T or 10/100 Base T Ethernet connection. This typically connects to an Ethernet hub, switch, or router. For configuration, WebRelay-Quad™ may be connected directly to the Ethernet port on a computer using a “crossover” cable. Otherwise for connection through a hub or router, a standard “straight-thru” cable should be used. 2.2.
Revision 2.4 WebRelay-Quad™ Users Manual ping -l 102 10.10.10.40 Linux/Unix: Open a terminal, change to root user (su -, then enter root password). Type... arp -s {new IP address} {serial number of WebRelay-Quad™ } Note: IP address format is: xxx.xxx.xxx.xxx Serial number format is: ss:ss:ss:ss:ss:ss For example, to set a WebRelay-Quad™ device (with serial number 00-0C-C801-00-01 ) to 10.10.10.40 the following command would be used. arp -s 10.10.10.40 00:0c:c8:01:00:01 Next, type...
Revision 2.4 WebRelay-Quad™ Users Manual 2.3.2 Option 2: Assign a temporary IP address to configuration computer If the first option above is not used, you can use this option to communicate with WebRelayQuad™ . By default, WebRelay-Quad™ comes from the factory with an IP address of 192.168.1.2.
Revision 2.4 WebRelay-Quad™ Users Manual Step 2: Double click on the icon labeled Network Connections. The following menu will pop up. Step 3: Right click on the icon labeled Local Area Connection. Another menu will appear. Select the option at the bottom of the menu labeled Properties. The Local Area Connection Properties window will appear. Step 4: On the Local Area Connection Properties page scroll down to Internet Protocol (TCP/IPv4), select it, and then click the button labeled properties.
Revision 2.4 WebRelay-Quad™ Users Manual Step 5: Before making any changes to the network settings, write down the current settings so they can be restored once WebRelay-Quad™ is configured. Next, select the radio button labeled “Use the following IP address,” and type in the IP address 192.168.1.50. Type in a subnet mask of 255.255.255.0. Leave the default gateway field blank. Click OK to apply settings. 2.3.
Revision 2.4 WebRelay-Quad™ Users Manual 2.4 Web-Based Setup WebRelay-Quad™ is fully configurable through HTML 4.0 compliant web browsers such as Internet Explorer and Mozilla Firefox. It’s easy to use tab based menu system has been designed to allow the unit to be configured easily. Note that in this chapter, the default IP address of 192.168.1.2 is used in all examples. If the IP address has been changed, substitute the new IP address for the address shown in the examples.
Revision 2.4 WebRelay-Quad™ Users Manual Navigating between setup pages is done by clicking on the tabs at the top of the page. All setup pages require a password. The default password is ‘webrelay’ (no quotes, all lower case) and no user name is required. Each setup page has a “Submit” button and a “Reset” button at the bottom of the page. After entering the desired parameters into each page, the “Submit” button must be pressed before any parameters will be saved.
Revision 2.4 WebRelay-Quad™ Users Manual 2.4.2 Network Setup Page The network parameters are changed on this page. Note that if multiple WebRelay-Quad™ units are used on the same network, install one unit at a time and set the IP address of each unit before connecting the next unit to the network. This avoids having multiple WebRelay-Quad™ units installed on the network with the same factory default IP address at the same time.
Revision 2.4 WebRelay-Quad™ Users Manual If WebRelay-Quad™ will be used over the Internet, the IP address must be a routable address assigned by the upstream Internet Service Provider (ISP). In cases where the ISP only provides a single routable IP address for the entire network (this is typical with ISPs such as cable providers), a proxy server (or gateway router) may be used. A proxy server allows multiple devices to connect to the Internet using a single routable IP address.
Revision 2.4 WebRelay-Quad™ Users Manual An example screenshot of a gateway router configuration is given below. This setup allows seven ControlByWeb™ products to be accessed on a private network behind a gateway router. Note that this screenshot is simply an example of a typical router setup page. Routers will vary. In the example, the seven ControlByWeb™ products are assigned IP addresses of 10.10.10.41 to 10.10.10.47. The first device labeled WebRelay-Quad 1 has an IP address of 10.10.10.
Revision 2.4 WebRelay-Quad™ Users Manual MTU Setting To change the MTU, manually enter the advSetup.html (case sensitive) page into the address bar. (http://192.168.1.2/advSetup.html). This new setup page will have a text box that will allow the MTU to be changed. The valid range is 256 to 1476 bytes. MTU is a network parameter that stands for Maximum Transmission Unit. This defines the max size, in bytes, of the TCP packets sent out from the device.
Revision 2.4 WebRelay-Quad™ Users Manual 2.4.4 Relay Setup Pages These pages are used to set up the function of each of the four relays, and how each relay is represented on the control page. All four pages are identical, with the exception of the Relay 1 page which also includes a field for the main header text on the control page, the option to automatically refresh the control page, and the time duration for auto refresh.
Revision 2.4 WebRelay-Quad™ Users Manual Auto Refresh Page: Web pages traditionally display static information. The WebRelay-Quad™ control page, however, displays information that is dynamic. Each time the control page is loaded to the browser, it displays a snapshot of the current status of the unit. If the state of the unit changes, the information on the control page will be outdated unless the page is re-loaded.
Revision 2.4 WebRelay-Quad™ Users Manual Pulse Button: This option allows the user to include a pulse button to control the relay. If the pulse button is included, the relay will pulse for the time specified in the ‘Pulse Duration’ field in the ‘Relay/Input’ page each time the button is pressed. Pulse Button Label: When the ‘Pulse Button’ option is set to Yes, the text entered here will appear in the pulse button on the control page.
Revision 2.4 WebRelay-Quad™ Users Manual Section 3: Operation WebRelay-Quad™ can be operated by using a web browser, by sending text commands to an XML status/control page, or by sending Modbus/TCP requests. 3.1 Browser Operation Once the unit is set up, the control page may be accessed by typing the following URL into the web browser: http://192.168.1.2 (Note that if the IP address was changed, replace the default IP address shown with the new address that was assigned.
Revision 2.4 WebRelay-Quad™ Users Manual 3.2 XML Operation Custom computer applications may be created to monitor and control WebRelay-Quad™ without using a web browser. Monitoring the state of the relays is done by sending a GET request to port 80 (or port specified in setup) for the XML page. Control of the relay is done by sending GET requests to the same page. This can be demonstrated by entering commands into the URL line of a web browser. 3.2.1 state.xml Request the current state: http://192.168.1.
Revision 2.4 WebRelay-Quad™ Users Manual The pulseTimeX variable does not change the pulse time specified in the setup page and it is not stored or recorded. The pulseTimeX variable only changes the pulse duration for the single pulse initiated by that command. In other words, you must issue the pulseTimeX for each pulse command that differs from the preset pulse time. For example, suppose the pulse time is set to 1.5 seconds in the configuration pages. To issue one 1.
Revision 2.4 WebRelay-Quad™ Users Manual 3.2.3 GET Requests GET requests can be used by custom applications to monitor and control the relays. A few example GET requests are provided below. No Password Enabled: GET requests to the device for specific files. Example: Request home.html GET /home.html HTTP/1.1\r\n\r\n Example: Turn Relay 1 ON GET /state.xml?relay1State=1 HTTP/1.
Revision 2.4 WebRelay-Quad™ Users Manual 3.3 Modbus Operation WebRelay-Quad™ can be controlled (and read) using Modbus/TCP protocol. This provides a standard means of using WebRelay-Quad™ in conjunction with devices and software from other manufacturers. This section contains the information necessary to communicate with WebRelayQuad™ using Modbus/TCP. This is not a tutorial on Modbus and it is assumed that reader is already familiar with Modbus. Detailed Modbus information can be found at http://www.
Revision 2.
Revision 2.4 WebRelay-Quad™ Users Manual 3.3.
Revision 2.4 WebRelay-Quad™ Users Manual 3.3.3 Write Multiple Coils (Modbus Function Code 15 (0x0F)) A single byte can be written to set the state of all four relays. To do this, set the starting address to 0, set the quantity of outputs to 4, and write a single byte with the appropriate value according to the table below.
Revision 2.
Revision 2.
Revision 2.4 WebRelay-Quad™ Users Manual Appendix A: Restoring Factory Default Settings In the event that the IP address or passwords are forgotten, WebRelay-Quad™ may be restored to its original factory default settings. To do this, first remove the power from the unit. Next, insert a thin object (such as a toothpick) through the small hole in the bottom of the unit to press the small button that is located inside the unit.
Revision 2.4 WebRelay-Quad™ Users Manual Appendix B: Installing New Firmware From time to time, updates are made to WebRelay-Quad™ firmware. The firmware can be updated in the field. The procedure for updating the firmware is outlined below. Please note that it is important that this procedure is followed precisely. Requirements The firmware update software requires Windows XP/Vista/7 with the .Net framework installed. The .Net framework is generally installed automatically through Windows update.
Revision 2.4 WebRelay-Quad™ Users Manual Device Upgrade Procedure Carefully follow the following steps to put WebRelay-Quad™ into bootloader mode and perform the upgrade: 1. Remove DC power from WebRelay-Quad™. 2. Using a small, non-conductive tool, press and hold the reset button. 3. While holding the reset button, apply power to WebRelay-Quad™. The LINK and ACT lights will flash. Continue to hold the reset button for the next step. 4.
Revision 2.
Revision 2.4 WebRelay-Quad™ Users Manual Physical: Operating Temperature: -20° to 70°C ( -4°-158°F) Size: 1.41in (35.7mm) wide X 3.88in (98.5mm) tall X 3.1 in(78.0mm) deep Weight: 4.
Revision 2.4 WebRelay-Quad™ Users Manual Appendix D: Mechanical Information Xytronix Research & Design, Inc.
