ControlByWeb WebRelay-Quad X-WR-4R1-5 User Manual

ControlByWeb WebRelay-Quad X-WR-4R1-5 User Manual

Hide thumbs Also See for WebRelay-Quad X-WR-4R1-5:

Advertisement

Quick Links

WebRelay-Quad
TM
Users Manual
Revision: 2.2 - June 8, 2007
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
(c) 2006-2007 Xytronix Research & Design, Inc.

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the WebRelay-Quad X-WR-4R1-5 and is the answer not in the manual?

Questions and answers

Summary of Contents for ControlByWeb WebRelay-Quad X-WR-4R1-5

  • Page 1 WebRelay-Quad Users Manual Revision: 2.2 - June 8, 2007 Covers: X-WR-4R1-5 X-WR-4R1-I X-WR-4R1-E a division of... Xytronix Research & Design, Inc. North Logan, Utah, USA (c) 2006-2007 Xytronix Research & Design, Inc.
  • Page 2: Table Of Contents

    Revision 2.2b 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...
  • Page 3: Trademark And Copyright Information

    Trademark and Copyright Information This document is Copyright ©2005-2007 by Xytronix Research & Design, Inc. All rights reserved. WebRelay-Quad and ControlByWeb are Trademarks of Xytronix Research & Design, Inc. 2005-2007. Portions of the software used in WebRelay-Quad are open source and appropriate copyright and legal notices are listed at the end of this manual.
  • Page 4: Fcc Statement

    (web browser, second WebRelay-Quad , etc.). Final installation note. This ControlByWeb product supports connection to 10Mbps and 100Mbps networks. Although 100Mbps networks are faster, the amount of data transferred to and from this device is very minimal and little if any performance increase will be gained by setting it to 100Mbps.
  • Page 5: Section 1: Introduction

    Revision 2.2b 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.
  • Page 6: Example Configurations And Applications

    Revision 2.2b WebRelay-Quad Users Manual Removable Terminal Strip Relay Status Indicator Lights Power Indicator Light Network Activity Light Network Link Ethernet Light Connector 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.
  • Page 7: Basic Setup

    Revision 2.2b WebRelay-Quad Users Manual 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. The three lights are connected to three of the relays so each light can be controlled individually. The lights can be connected directly to the relay contacts because they are low power lights (LEDs).
  • Page 8: Controlling High Power Devices

    Revision 2.2b 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.
  • Page 9: Using Webrelay-Quad

    Without a Computer WebRelay-Quad can be used in conjunction with other ControlByWeb products such as WebRelay the Five- Input Module. This allows users to control devices at a remote location by using switches or buttons instead of using a computer. The illustration below shows how three switches can remotely control three indicator lights in a light tower at a remote location.
  • Page 10: Section 2: Installation And Setup

    Revision 2.2b 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.
  • Page 11: Connection

    Revision 2.2b 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.
  • Page 12: Power Supply Connection

    Revision 2.2b WebRelay-Quad Users Manual 14-pin connector pinout: Description VIN+ 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.
  • Page 13: Network Connection

    Revision 2.2b 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”...
  • Page 14: Option 2: Assign A Temporary Ip Address To Configuration Computer

    Revision 2.2b WebRelay-Quad Users Manual 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-C8-01-00-01 ) to 10.10.10.40 the following command would be used.
  • Page 15 Revision 2.2b WebRelay-Quad Users Manual Instructions for changing the IP address of the computer that will be used for WebRelay-Quad configuration are given here. Note that these instructions are specifically for computers with the Windows XP operating system. For setup using other operating systems, refer to the appropriate users manual. Step 1: Open the control panel by clicking on the start menu and then clicking on Control Panel.
  • Page 16 Revision 2.2b 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/IP), select it, and then click the button labeled properties.
  • Page 17: Open Configuration Web Page

    Revision 2.2b 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.
  • Page 18: Main Setup Page

    Revision 2.2b WebRelay-Quad Users Manual 2.4.1 Main Setup Page This is the initial page that appears when the URL http://192.168.1.2/setup.html is entered into the web browser. It provides basic information about the WebRelay-Quad unit. Navigating between setup pages is done by clicking on the tabs at the top of the page. All setup pages require a password.
  • Page 19 Revision 2.2b WebRelay-Quad Users Manual 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. It may be necessary to clear the arp cache each time you swap WebRelay-Quad units on the network (this is because each unit has the same default IP address but different mac address).
  • Page 20 Revision 2.2b WebRelay-Quad Users Manual 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. Many small routers from LinkSys, Dlink, and Netgear perform proxy server functions. If a proxy server is used, WebRelay-Quad will not be accessible from the Internet until the proxy server is properly configured (forward proper port to WebRelay-Quad...
  • Page 21 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.41 and is assigned port 8001.
  • Page 22: Password Setup Page

    Revision 2.2b WebRelay-Quad Users Manual 8. Mode: This option allows the Ethernet port to be set to Half Duplex or Full Duplex. Legacy Ethernet operates in Half Duplex mode which means that devices can either send data or receive data, but not both at the same time. Full duplex means that devices can send and receive data at the same time.
  • Page 23 Revision 2.2b WebRelay-Quad Users Manual 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.
  • Page 24 Revision 2.2b WebRelay-Quad Users Manual 4. Relay Description: This text is used to describe the function of the relay on the control page. This text will not appear if the ‘Display Relay Status’ is set to No, the ‘On/Off Buttons’ is set to 0, and the ‘Pulse Button’ is set to No. This field can be up to 20 characters in length.
  • Page 25 Revision 2.2b WebRelay-Quad Users Manual remain on and the pulse timer will be reset so the duration of the pulse will be extended. If pulse commands are issued continuously so that the pulse timer is not allowed to expire, the relay will remain on until after the last pulse command was sent (to be precise, the relay will go off at the time of the last command plus the Pulse Duration time).
  • Page 26: Section 3: Operation

    Revision 2.2b 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.
  • Page 27 Revision 2.2b WebRelay-Quad Users Manual <relayXstate> 0=off(coil off) 1=on (coil energized) Commands can be sent to WebRelay-Quad to control the relays. Commands are sent using variables called relay1State, relay2State, relay3State and relay4State. Examples of using relayXState (X represents the appropriate relay) are given here.
  • Page 28: Modbus Operation

    64 encoded version of the username and password none:webrelay A utility is provided at http://www.ControlByWeb.com/encoder that can be used to encode the password. The utility is used by simply typing the string username:password into the website and pressing encode.
  • Page 29 Revision 2.2b WebRelay-Quad Users Manual Protocol identifier (2 Bytes): 0x0000 Length (2 Bytes): 0x0006 Unit identifier (1 Byte): 0xff Modbus: Function code (1 Byte): 0x01 (read coils) Starting address (2 Bytes): 0x0000 (0x0000 ~ 0x0003) Quantity of coils (2 Bytes): 0x0002 (0x0001 ~ 0x0004) Character String Example: char read_coils_mb_request[] ={0x00, 0x01, 0x00, 0x00, 0x00, 0x06, 0xff, 0x01, 0x00, 0x00, 0x00, 0x02 };...
  • Page 30: Write Single Coil (Modbus Function Code 05 (0X05))

    Revision 2.2b WebRelay-Quad Users Manual 0x02 - Incorrect starting address / quantity of outputs combination Character String Example: char read_coils_mb_response[] = {0x00, 0x01, 0x00, 0x00, 0x00, 0x04, 0xff, 0x01, 0x01, 0x01}; 3.3.2 Write Single Coil (Modbus Function Code 05 (0x05)) Request Modbus/TCP: Transaction identifier (2 Bytes): 0x0001...
  • Page 31: Write Multiple Coils (Modbus Function Code 15 (0X0F))

    Revision 2.2b 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. Data Byte (hex) LS Data Bits (binary) Relay 4 State...
  • Page 32: Write Multiple Registers (Modbus Function Code 16 (0X10))

    Revision 2.2b WebRelay-Quad Users Manual Modbus: Function code (1 Byte): 0x05 (write coil) Starting address (2 Bytes): 0x0000 Quantity of outputs (1 Byte): 0xff - relay on, 0x00 - relay off Modbus Error: Function code (1 Byte): 0x8f Exception code (1 Byte): 0x01 or 0x02 Exception codes: 0x01 - Function code not supported 0x02 - Incorrect starting address / quantity of outputs combination...
  • Page 33 Revision 2.2b WebRelay-Quad Users Manual Length (2 Bytes): 0x0006 Unit identifier: 0xff Modbus: Function (1 Byte): 0x10 (Write Multiple Registers) Reference number (2 Bytes): 0x0010 Word count (2 Bytes): 0x0002 Modbus Error: Function code (1 Byte): 0x90 Exception code (1 Byte): 0x01, 0x02, 0x03, or 0x04 Exception codes: 0x01 - Function code not supported 0x02 - Incorrect starting address / quantity of outputs combination...
  • Page 34: Appendix A: Restoring Factory Default Settings

    Revision 2.2b 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.
  • Page 35: Appendix B: Specifications

    Revision 2.2b WebRelay-Quad Users Manual Appendix B: Specifications Power Requirements: Model X-WR-4R1-5 Voltage: 5VDC ± 5% Current: See table below for typical values 10Mbps Network 100Mbps Network No Relays On 130mA 255mA All 4 Relays On 335mA 477mA Model X-WR-4R1-I Voltage: 9~28VDC Current: See table below for typical values 10Mbps Network...
  • Page 36 Revision 2.2b WebRelay-Quad Users Manual LED Indicators: 7 -Power on -Relay coils (1-4) engaged -Network linked -Network activity 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.5oz (128 grams) Enclosure Material: Lexan 940 (UL94 V0 flame rated) Password Settings: Password protection on setup page: Yes...
  • Page 37: Appendix C: Mechanical Information

    Revision 2.2b WebRelay-Quad Users Manual Appendix C: Mechanical Information Xytronix Research & Design, Inc. page 36...
  • Page 38: Appendix D: Open Tcp Legal Notice

    Revision 2.2b WebRelay-Quad Users Manual Appendix D: Open TCP Legal Notice Portions of the software used in WebRelay-Quad are open source. The appropriate notices are listed below. All other parts of the software are property of Xytronix Research & Design, Inc. ©2005-2006. Copyright (c) 2000-2002 Viola Systems Ltd.

This manual is also suitable for:

Webrelay-quad x-wr-4r1-iWebrelay-quad x-wr-4r1-e

Table of Contents