1. Manuals
  2. Brands
  3. Xytronix Research & Design Manuals
  4. Other
  5. WebRelay
  6. User manual

Xytronix Research & Design WebRelay User Manual

Web-controlled relay
Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
WebRelay
TM
Users Manual
Revision: 3.1 - June 8, 2007
Covers:
X-WR-1R12-1I5-5
X-WR-1R12-1I5-I
X-WR-1R12-1I24-I
X-WR-1R12-1I5-E
TM
a division of...
Xytronix Research & Design, Inc.
North Logan, Utah, USA
(c) 2005-2007 Xytronix Research & Design, Inc.

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the WebRelay and is the answer not in the manual?

Questions and answers

Summary of Contents for Xytronix Research & Design WebRelay

  • Page 1 WebRelay Users Manual Revision: 3.1 - June 8, 2007 Covers: X-WR-1R12-1I5-5 X-WR-1R12-1I5-I X-WR-1R12-1I24-I X-WR-1R12-1I5-E a division of... Xytronix Research & Design, Inc. North Logan, Utah, USA (c) 2005-2007 Xytronix Research & Design, Inc.

  • Page 2: Table Of Contents

    2.2.3 Relay Connection 2.2.4 Optically-Isolated Input Connection 2.3 Establishing Communications for Setup 2.3.1 Option 1: Assign a temporary IP address to WebRelay 2.3.2 Option 2: Assign a temporary IP address to configuration computer 2.3.3 Open Configuration Web Page 2.4 Web-Based Setup 2.4.1 Main Setup Page...
  • Page 3 Revision 3.1 WebRelay Users Manual Appendix A: Restoring Factory Default Settings Appendix B: Specifications Appendix C: Mechanical Information Appendix D: Open TCP Legal Notice Xytronix Research & Design, Inc. page 2...

  • Page 4: Trademark And Copyright Information

    ControlByWeb are Trademarks of Xytronix Research & Design, Inc. 2005-2007. Portions of the software used in WebRelay are open source and appropriate copyright and legal notices are listed at the end of this manual. All other parts of the software are property of Xytronix Research & Design, Inc. ©2005- 2007.

  • Page 5: Fcc Statement

    As with any device to be installed on a network, there are some security precautions that should be observed. If WebRelay installed on the Internet, it is recommended that passwords be enabled for the control page. Make sure secure passwords are used.

  • Page 6: Section 1: Introduction

    It can be used to remotely reboot servers, computers, satellite modems, and other devices over the Internet, or it can be configured to automatically reboot devices when they fail to respond to pings that are sent from WebRelay . There are three ways that WebRelay can be wired to a device for reboot.

  • Page 7: Webrelay Tm Models Available

    Closed) contact is open. The load device that is connected to the relay contacts may be on or off when the coil is energized depending on how its wired. LINK means WebRelay is properly connected to an Ethernet network. It also indicates that the unit is properly powered.

  • Page 8: Single Webrelay Tm Device (Ip Network Control Only)

    1.4.1 Single WebRelay Device (IP Network Control Only) The illustration below shows a simple example of using WebRelay to control a device over an IP network. The device to be controlled is wired in series with the relay contacts. Note that a fuse or circuit breaker is shown to limit current overload.

  • Page 9: Dual Webrelay

    Revision 3.1 WebRelay Users Manual 1.4.3 Dual WebRelay Devices (No Computer Required for Operation) This configuration is used to control devices remotely without a browser, or to extend a digital signal to a remote location on the network. A control voltage applied to one unit controls the relay contacts of another unit at a remote location.

  • Page 10: Multiple Webrelay

    WebRelays at remote locations. There is not a way to configure a single WebRelay to control multiple WebRelays directly, but it is possible to set up multiple WebRelays in a daisy-chain mode so that one WebRelay controls a second WebRelay which, in turn controls a third WebRelay and so on.

  • Page 11: Webrelay

    WebRelay that is configured to control it and not necessarily to the state of the switch. In other words, if the switch is 'ON' but a user changes the state of WebRelay 3 to 'OFF' by changing the relay in the web page, WebRelay 4 will be changed to the 'OFF' state also.

  • Page 12: Webrelay

    In this scenario, the computer is never powered down, only reset when necessary by temporarily closing the relay contacts. This approach is more gentle on the computer that it controls than the approach of switching the power. The Common, and Normally Open contacts of WebRelay are wired to the reset circuit of the computer.

  • Page 13: Section 2: Installation And Setup

    2.1.2 DIN-Rail Mounting WebRelay can be mounted to a standard (35mm by 7.55mm) DIN rail. Attach WebRelay to the DIN rail by hooking the top hook on the back of the enclosure to the DIN rail and then snap the bottom hook into place.

  • Page 14: Connection

    3. Reconnect terminal connectors. 4. Apply power. It is recommended that the load (device to be controlled) not be connected to WebRelay until after WebRelay been configured and tested. By doing this, wiring and configuration mistakes will not cause the load device to turn on unexpectedly.

  • Page 15: Power Supply Connection

    WebRelay units with the Power Over Ethernet option may be connected to an 802.3af compliant Ethernet port instead of connecting to an external power supply. In this case, WebRelay is powered through the network port. In 802.3af compliant networks, a 48 Volt power source is injected into the Ethernet line.

  • Page 16: Network Connection

    For loads greater than the maximum relay contact rating, an external relay may be used. The illustration below shows how a 20-Amp motor can be controlled using an external relay. In the example, WebRelay controls the external relay and the external relay controls the load.

  • Page 17: Optically-Isolated Input Connection

    To connect an AC voltage to the input of WebRelay , a diode (or bridge rectifier) and a capacitor can be used to convert the AC signal to a DC signal. To connect a voltage to the input of WebRelay that is greater than the input is rated, a resistor of the appropriate value and power rating can be used to reduce the voltage.

  • Page 18: Establishing Communications For Setup

    The second way (Option 2) is to change the IP address of the computer to an address that is on the same network that WebRelay set to by default.

  • Page 19: Option 2: Assign A Temporary Ip Address To Configuration Computer

    -s 102 10.10.10.40 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 WebRelay . By default, WebRelay comes from the factory with an IP address of 192.168.1.2. Communications with WebRelay...
  • Page 20 Revision 3.1 WebRelay Users Manual Step 1: Open the control panel by clicking on the start menu and then clicking on Control Panel. (Note that control panel shown is in “Classic View”. If control panel is in “Category View” select the “Classic View”...
  • Page 21 Revision 3.1 WebRelay Users Manual 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 22: Open Configuration Web Page

    (note that if option 1 above was used for initial configuration, replace the IP address given here with the newly assigned IP address). A password is required to change any parameters. The default password is ‘webrelay’ (do not include quotes, password is case sensitive). 2.4 Web-Based Setup WebRelay is fully configurable through HTML 4.0 compliant web browsers such as Internet Explorer and Mozilla...
  • Page 23 WebRelay Users Manual 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”...

  • Page 24: Network Setup Page

    Dynamic IP address assignment is not supported. The lack of dynamic IP addressing support is intentional because dynamically changing the IP address would make it difficult for a client to access the web server built into WebRelay The IP address is specific to the network where WebRelay will be installed, and must be obtained from the network administrator.
  • Page 25 The WebRelay units could then be accessed from outside the private network by entering the IP address of the gateway and the port for the desired WebRelay unit. Note that whenever any port is assigned other than port 80, all communications with that WebRelay device must include the port.
  • Page 26 (under Network settings tab), TCP Port 8001 must be specified for this device. The second device, labeled WebRelay 2 has an IP address of 10.10.10.42 and is assigned port 8002. This WebRelay must have its TCP Port set to 8002 in it's network settings page. This pattern continues through 10.10.10.77 which is assigned the port 8007.

  • Page 27: Password Setup Page

    Yes or No radio buttons. Enabling the control page password also enables the requirement for a password when reading/writing XML pages. Enabling the control page password also disables the ability to communicate with WebRelay using Modbus. Note that when the password is changed, the password may be displayed in the browser’s history in clear text.

  • Page 28: Relay/Input Setup Page

    WebRelay expects a response after each ping. If a preset number of ping requests fail, it is assumed that the device is not functioning properly. WebRelay will attempt to restore the device to normal operation by rebooting the device. In Automatic Reboot mode, users also have the ability to manually reboot the device from a remote location over the network.
  • Page 29 86,400 seconds (1 day). Note that each time WebRelay receives a pulse command, the relay will be turned on (if not on already) and the pulse timer will be reset. If WebRelay receives a pulse command and and a second pulse command comes in before the pulse timer has expired, the relay will remain on and the pulse timer will be reset so the duration of the pulse will be extended.
  • Page 30 (it will re-start each time the voltage changes) and the relay will continue to remain on until the timer expires. The following parameters (4-13) are available only when WebRelay is set to Automatic Reboot relay mode.
  • Page 31 There are several options for connection. Three reboot methods are discussed here which will help in understanding of how reboot options should be set. Reboot Method #1: Connect WebRelay in series with the power source of the device. By doing this, WebRelay can switch the device on and off by switching the power to the device on and off.
  • Page 32 -pulse on T1 secs, off T2 secs, on T3 secs (with pp)- This option is identical to the option above, but with one exception; it pulses at power-up (with pp). If WebRelay loses power, it is assumed that the device which WebRelay controls has also lost power.
  • Page 33 When a voltage is applied to the input, no commands are sent to the remote WebRelay -send off command when input off (no on command)- When a voltage is removed from the input, a command is sent to the remote WebRelay to set the relay state to off.
  • Page 34 16. Remote TCP Port: When any option in the ‘Remote Relay Options’ setting is selected other than no remote relay control, commands are sent over the IP network to this TCP port on the remote WebRelay as the control voltage input changes.
  • Page 35 I. NO: When this option is selected, the TCP connection between the two units will be terminated if there is a time gap (more than about 50 seconds) between commands. Once the connection is closed, the two WebRelay units must re-establish a connection before the next command can be sent.

  • Page 36: Control Page Setup (When Relay Mode Is Set To Standard)

    Titles, colors, and basic contents of the control page can be customized by setting the appropriate options on the ‘Control Page Setup’ page. Note that this setup page only affects the control web page and does not affect the function of WebRelay in any way. This section describes the ‘Control Page Setup’...
  • Page 37 Revision 3.1 WebRelay Users Manual 1. Main Header Text: This text will be displayed in the main header area of the control page. This field can be up to 25 characters in length. 2. 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’...

  • Page 38: Control Page Setup (When Relay Mode Is Set To Automatic Reboot)

    (voltage is not applied to input). 19. Auto Refresh Page: Web pages traditionally display static information. The WebRelay 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.
  • Page 39 WebRelay is used for re-boot purposes, the relay status may or may not be the same as the device status. When WebRelay is used to assert the a reset signal on the motherboard of a server, for example, the relay will be ‘OFF’ most of the time even though the server is ‘ON’ most of the time. The specific re-boot method used should be considered when assigning text and color to the relay status.
  • Page 40 Revision 3.1 WebRelay Users Manual 5. Status ON Text: When the ‘Display Relay Status’ option is set to Yes, this field specifies the text that will be displayed when the relay is on (coil energized). 6. Status OFF Color: When the ‘Display Relay Status’ option is set to Yes, this field specifies the color that will be displayed when the relay is off (coil not energized).
  • Page 41 First, if turning the device off causes communications with WebRelay to be lost (for example, WebRelay controls a router or modem which must be operating properly to remotely communicate with WebRelay In this case the user may press the ‘OFF’ button and lose communications with WebRelay so he/she cannot turn the device back on.

  • Page 42: Section 3: Operation

    Revision 3.1 WebRelay Users Manual Section 3: Operation WebRelay can be operated by applying a voltage to the optically-isolated input, using a web browser, by sending text commands to an XML status/control page, or by sending Modbus/TCP requests. Using a control voltage was described throughout previous sections and will not be described here.
  • Page 43 ON/OFF Buttons - These buttons are available only when single pulse reboot options are selected in the ‘Relay/Input’ setup and the ‘On/Off Buttons’ field in the ‘Control Page Setup’ is set to Yes. When WebRelay is wired to correctly match the reboot logic, these buttons will turn the device on and off.

  • Page 44: Xml Operation

    This allows the user to temporarily disable the automatic reboot feature. When automatic reboot is disabled, WebRelay will stop pinging the device. Automatic reboot will be disabled until a user re-enables it or WebRelay is powered cycled. The user can re-enable this feature by pressing the ‘Auto ON/OFF’ button, or by changing any of the reboot parameters in the setup pages.
  • Page 45 Turn the relay ‘off’ without returning state: http://192.168.1.2/state.xml?relayState=0&noReply=1 Password : If the control password is enabled in the WebRelay unit and the XML page is requested through a browser, the browser will prompt the user for the password. If the XML request is sent from another application and not a browser, the html request will need to contain the password encoded using the base 64 encoding scheme.

  • Page 46: Modbus Operation

    Modbus. WebRelay functions as a Modbus server (slave). Client (master) devices open a connection with WebRelay port 502 (unless another modbus port is selected) and sends commands or requests to to read the state of the relay, read the input, or change the relay.

  • Page 47: Read Discrete Inputs (Modbus Function Code 02 (0X02))

    Revision 3.1 WebRelay Users Manual Length (2 Bytes): 0x0006 Unit identifier (1 Byte): 0xff Modbus: Function code (1 Byte): 0x01 (read coils) Starting address (2 Bytes): 0x0000 (0x0000 or 0x0001) Quantity of coils (2 Bytes): 0x0002 (0x0001 or 0x0002) Character String Example: char read_coils_mb_request[] ={0x00, 0x01, 0x00, 0x00, 0x00, 0x06, 0xff, 0x01, 0x00, 0x00, 0x00, 0x02 };...

  • Page 48: Write Single Coil (Modbus Function Code 05 (0X05))

    Revision 3.1 WebRelay Users Manual Character String: char read_inputs_mb_request[] ={0x00, 0x01, 0x00, 0x00, 0x00, 0x06, 0xff, 0x02, 0x00, 0x00, 0x00, 0x01 }; Response Modbus/TCP: Transaction identifier (2 Bytes): 0x0001 Protocol identifier (2 Bytes): 0x0000 Length (2 Bytes): 0x0004 Unit identifier (1 Byte): 0xff...

  • Page 49: Write Multiple Registers (Modbus Function Code 16 (0X10))

    86400, the pulse timer will be set to 86400. If a pulse time command is sent with a value less than 0.1, the pulse timer will be set to 0.1. If any commands are sent to WebRelay (commands may be modbus, xml, html, or electrical input) before the pulse timer has expired, the pulse timer will be canceled immediately and the new command will be executed.
  • Page 50 Users Manual Appendix A: Restoring Factory Default Settings In the event that the IP address or passwords are forgotten, WebRelay 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 51 Revision 3.1 WebRelay Users Manual Appendix B: Specifications Power Requirements: Model X-WR-1R12-1I5-5 Voltage: 5VDC ± 5% Current (operating at 10Mbps): 318mA max Current (operating at 100Mbps): 460mA max Model X-WR-1R12-1I5-I and X-WR-1R12-1I24-I Voltage: 9~28VDC Current at 9V (operating at 10Mbps): 224mA max...
  • Page 52 Revision 3.1 WebRelay Users Manual -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: 5oz (142 grams) Enclosure Material: Lexan 940 (UL94 V0 flame rated)
  • Page 53 Revision 3.1 WebRelay Users Manual Appendix C: Mechanical Information Xytronix Research & Design, Inc. page 52...
  • Page 54 WebRelay Users Manual Appendix D: Open TCP Legal Notice Portions of the software used in WebRelay are open source. The appropriate notices are listed below. All other parts of the software are property of Xytronix Research & Design, Inc. ©2005-2007.

Table of Contents