WebRelay-Quad TM Users Manual

Transcription

1 WebRelay-Quad TM Users Manual Revisi: Dec 2015 Covers: X-WR-4R1-5 X-WR-4R1-I X-WR-4R1-E TM a divisi of... Xytrix Research & Design, Inc. Nibley, Utah, USA Xytrix Research & Design, Inc.

2 Revisi 2.6 Ctents Trademark and Copyright Informati Warranty FCC Statement Installati Guidelines (Read Before Installing) Secti 1: Introducti 1.1 Features 1.2 WebRelay-Quad Models Available 1.3 Cnectors & Indicators 1.4 Example Cfiguratis and Applicatis Basic Setup Ctrolling High Power Devices Using WebRelay-Quad Without a Computer Secti 2: Installati and Setup 2.1 Mounting Wall Mounting DIN-Rail Mounting 2.2 Cnecti Power Supply Cnecti Network Cnecti Relay Cnecti 2.3 Establishing Communicatis for Setup Opti 1: Assign a temporary IP address to WebRelay-Quad Opti 2: Assign a temporary IP address to cfigurati computer Open Cfigurati Web Page 2.4 Web-Based Setup Main Setup Page Network Setup Page Password Setup Page Relay Setup Pages Secti 3: Operati 3.1 Browser Operati 3.2 XML Operati state.xml XML Ctrol GET Requests 3.3 Modbus Operati Read Coils (Modbus Functi Code 01 (0x01)) Write Single Coil (Modbus Functi Code 05 (0x05)) Write Multiple Coils (Modbus Functi Code 15 (0x0F)) Write Multiple Registers (Modbus Functi Code 16 (0x10)) Xytrix Research & Design, Inc. page 2

3 Revisi 2.6 Appendix Appendix A: Restoring Factory Default Settings Appendix B: Installing New Firmware Appendix C: Specificatis Appendix D: Mechanical Informati Xytrix Research & Design, Inc. page 3

4 Revisi 2.6 Trademark and Copyright Informati This document is Copyright by Xytrix Research & Design, Inc. All rights reserved. WebRelay-Quad and CtrolByWeb are Trademarks of Xytrix Research & Design, Inc All parts of this product and design including but not limited to firmware, hardware design, schematics, PCB layout, ccept, graphics, users manual, etc., are property of Xytrix Research & Design, Inc WebRelay-Quad may not be opened, disassembled, copied, or reverseengineered. No part of this manual may be reproduced or transmitted in any form or by any means, electric or mechanical, including photocopying or scanning, for any purpose other than the persal use by the purchaser of this product. Xytrix Research & Design, Inc., assumes no respsibility for any errors that may appear in this document. Whereas effort has been made to make the informati in this document as useful and accurate as possible, Xytrix Research & Design, Inc. assumes no respsibility for the applicati, usefulness, or completeness of the informati ctained herein. Under no circumstance will Xytrix Research & Design, Inc. be respsible or liable for any damages or losses including direct, indirect, special, incidental, or csequential damages or losses arising from either the use of any informati ctained within this manual or the use of any products or services referenced in this manual. Xytrix Research & Design, Inc. reserves the right to change any product s features, specificatis, documentati, warranties, fee schedules, and cditis at any time and without notice. Warranty This Xytrix Research & Design, Inc. product has a warranty against defects in material and workmanship for a period of e year from the date of shipment. During the warranty period, Xytrix Research & Design, Inc. will, at its opti, either repair or replace products that prove to be defective. This warranty is extended to the original purchaser of the equipment ly. For warranty service or repair, the product must be properly packaged, and returned to Xytrix Research & Design, Inc. The purchaser shall prepay all charges for shipping to Xytrix Research & Design, Inc., and Xytrix Research & Design, Inc. will pay the shipping charges to return the product to the purchaser as lg as the product is shipped within the United States. If the product is shipped outside of the United States, the purchaser shall pay all shipping charges, duties, and taxes. Limitati The foregoing warranty shall not apply to defects or damage resulting from improper use or misuse, unauthorized repair, tampering, modificati, improper cnecti, or operati outside the electrical/envirmental specificatis for the product. Further, the warranty does not cover Acts of God, such as fire, flood, hurricanes, and tornadoes. This warranty does not cover damage to property, equipment, direct, indirect, csequential, or incidental damage (including damage for loss of business profit, business interrupti, loss of data, and the like) arising out of the use or misuse of this product. UNDER NO CIRCUMSTANCES WILL THE LIABILITY OF XYTRONIX RESEARCH & DESIGN, INC. TO THE PURCHASER OR ANY OTHER PARTY EXCEED THE ORIGINAL PURCHASE PRICE OF THE PRODUCT, REGARDLESS OF THE FORM OF THE CLAIM. No other warranty is expressed or implied. Xytrix Research & Design, Inc. specifically disclaims the implied warranties or merchantability and fitness for a particular purpose. Some jurisdictis may not allow the exclusi of limitati of liability for csequential or incidental damage. Xytrix Research & Design, Inc. page 4

5 Revisi 2.6 FCC Statement This device complies with Part 15 of the FCC Rules. Operati is subject to the following two cditis: This device may not cause harmful interference. This device must accept any interference received, including interference that may cause undesired operati. 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. These limits are designed to provide reasable protecti. This equipment generates, uses and can radiate radio frequency energy and, if not installed and used in accordance with the instructis, may cause interference to radio communicatis. However, there is no guarantee that interference will not occur in a particular installati. If this equipment does cause harmful interference to radio or televisi recepti, which can be determined by turning the equipment and, the user is encouraged to try to correct the interference by e or more of the following measures: Reorient or relocate the receiving antenna. Increase the separati between the equipment and receiver. Cnect the equipment into an outlet a circuit different from that to which the receiver is cnected. Csult the dealer or an experienced radio/tv technician for help. Notice: Changes or modificati not expressly approved by the party respsible for compliance could void the user s authority to operate the equipment. Xytrix Research & Design, Inc. page 5

6 Revisi 2.6 Installati Guidelines (Read Before Installing) Do not open the WebRelay-Quad enclosure. This will void the warranty. This unit must be installed by qualified persnel. 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. It does not support terminal or file transfer programs such as telnet, ftp, ssh, etc. This means that it is not possible for somee to break in to WebRelay-Quad and access other devices your local network. WebRelay-Quad does not support remote firmware updates which means that it is not possible for somee to remotely install malicious software. The simplicity of WebRelay-Quad makes it a very secure device. As with any device to be installed a network, there are some security precautis that should be observed. If WebRelay-Quad is installed the Internet, it is recommended that passwords be enabled for the ctrol page. Make sure secure passwords are used. Passwords should be at least 8 characters in length and should be a combinati of upper case letters, lower case letters, and numbers. D t use passwords that would be easy to guess. For additial security, a firewall may be used to limit access ly to selected IP addresses. Another opti may be to set up a Virtual Private Network (VPN) between the network where WebRelay-Quad resides and the client machine (web browser, secd WebRelay-Quad, etc.). Final installati note. This CtrolByWeb product supports cnecti 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. There are advantages however, to operate this device at 10Mbps. At 10Mbps, less power is required, the unit runs cooler, and the lifetime of the product will be extended. Xytrix Research & Design, Inc. page 6

7 Revisi 2.6 Secti 1: Introducti WebRelay-Quad is a compact, four-relay module with a built in web server. It can be ctrolled and/or mitored over any IP network including private networks, IP-based industrial ctrol networks, and the Internet. Users can operate WebRelay-Quad using a web browser or a custom applicati. Computers, PLCs, or automati ctrollers may ctrol and mitor WebRelay-Quad without user interventi. This works by sending text commands over the network and reading XML status pages from WebRelay-Quad, or by using Modbus/TCP protocol. WebRelay-Quad has many applicatis and is ly limited by imaginati. It works very well as a stand-ale device that can be ctrolled using a web browser or as a cvenient way to add I/O to a computer. It can be used in industrial applicatis to ctrol motors, lights, coils, pumps, valves, etc. 1.1 Features WebRelay-Quad is very simple but has many features. Some features include... No programming required Easy to use as a stand ale device or as part of a large ctrol system Built-in web server provides simple, web based cfigurati and ctrol Ctrol page can be customized with appropriate text and butts 10/100 Ethernet cnectivity Four, 24Volt 1-Amp relays Removable terminal cnectors (included) simplifies wiring and service Custom applicatis can ctrol WebRelay-Quad with simple text commands and read XML formatted status. Modbus/TCP protocol support provides inter-interoperability with devices/software from other manufacturers. Password protecti Selectable TCP ports On/Off or pulse mode DIN-Rail or Wall Mount 1.2 WebRelay-Quad Models Available WebRelay-Quad is currently available in two models. The ly difference between the two models is the power supply requirements. Note: The WebRelay-Quad X-WR-4R1-I and X-WR-4R1-E have been replaced by X-WR-4R3-I and X-WR-4R3-E respectively. These new models use the same firmware and are 100% compatible with the original module. They use slightly larger relays which provide higher switching current capacity. Part Number Power Supply Requirements X-WR-4R3-I 9-28VDC X-WR-4R3-E Power Over Ethernet or 5VDC Xytrix Research & Design, Inc. page 7

8 Revisi Cnectors & Indicators WebRelay-Quad has a removable terminal cnector and an Ethernet cnector. The terminal cnector is used to provide power to the internal web server, and is used to cnect external electrical loads to the relay ctacts. There are seven LED indicators WebRelay-Quad. The Power LED (green) indicates that the unit is powered. Four LEDs (green) labeled Relay 1-4 which indicate that the correspding relay coil is energized. When the relay coils are energized, the NO (Normally Open) ctacts are closed and the NC (Normally Closed) ctacts are open. The load device that is cnected to the relay ctacts may be or when the coil is energized depending how it is wired. The LINK (green) LED indicates that WebRelay-Quad is properly cnected to an Ethernet network. The ACK LED (amber) flashes when there is network activity. Note that the LINK and ACT LEDs are located the Ethernet cnector. R e m o v a b le T e r m in a l S t r ip R e la y S ta tu s In d ic a to r L ig h t s Power I n d ic a t o r L ig h t N e tw o rk A c t iv it y L ig h t N e tw o rk L in k L ig h t Xytrix Research & Design, Inc. E th e rn e t C o n n e c to r page 8

9 Revisi Example Cfiguratis and Applicatis WebRelay-Quad is very versatile and can be used in many applicatis. Several basic installati schemes are illustrated in this secti Basic Setup The illustrati below shows a simple WebRelay-Quad applicati. The example shows how a 3-color industrial light tower can be ctrolled remotely over an Ethernet network. The three lights are cnected to three of the relays so each light can be ctrolled individually. The lights can be cnected directly to the relay ctacts because they are low power lights (LEDs). The ctroller can be a web browser, a custom ctrol applicati running a computer, a PLC, or an embedded industrial ctroller. Commands are sent to WebRelay-Quad over the Ethernet network using standard IP protocols so the ctroller can be placed physically next to the light tower or a distance away. P o w e r S u p p ly fo r W e b R e la y Q uad D e v ic e t o b e C o n t r o lle d ( L ig h t T o w e r ) W e b R e la y - Q u a d Vin+ Vin- 1C 2C 1NO 2NO ht Lig 1 Li gh t2 Light 3 3C 3N O COM C o m p u t e r, P L C, I n d u s tr ia l C o n t r o lle r, e tc. IP N e tw o rk N o t e t h a t a s in g le p o w e r s u p p ly c o u ld b e u s e d to p o w e r b o t h W e b R e la y - Q u a d a n d L ig h t T o w e r. P o w e r S u p p ly fo r L ig h t T o w e r +V COM Xytrix Research & Design, Inc. page 9

10 Revisi Ctrolling High Power Devices WebRelay-Quad can be used to ctrol high power devices by using an external relay. In this cfigurati, WebRelay-Quad does not ctrol the load directly, but ctrols the external relay and the external relay ctrols the load. This is illustrated below. D e v ic e to b e C o n t r o lle d N e u tra l 240V AC Pow er S o u rc e P o w e r S u p p ly ( P o w e r s W e b R e la y ) (5 V D C o r V D C ) L in e 25 Am p S o lid S t a t e R e la y W e b R e la y - Q u a d Vin+ Vin- C o m p u te r, P L C, In d u s tr ia l C o n t r o lle r, e tc. 1C 1NO Input - + IP N e tw o rk Using WebRelay-Quad Without a Computer WebRelay-Quad can be used in cjuncti with other CtrolByWeb products such as WebRelay or the Five- Input Module. This allows users to ctrol devices at a remote locati by using switches or butts instead of using a computer. The illustrati below shows how three switches can remotely ctrol three indicator lights in a light tower at a remote locati. This cfigurati ers many possibilities in security and remote ctrol. The inputs can be driven by switches, sensors, or digital outputs from a PLC or automati ctroller. P o w e r S u p p ly fo r F iv e I n p u t M o d u le P o w e r S u p p ly fo r W e b R e la y Q uad L ig h t T o w e r S w itc h e s F iv e In p u t M o d u le 2N O L ig 3N O 1 IP N e tw o rk 3C 2C, and To 1C, L ig h t 3 ht Li In 3 + CO M In 2 + t2 t 3 L ig h t 2 V in + V in 1NO gh +5 In 1 + W e b R e la y - Q u a d V in + V in G nd In 1 In 2 In 3 - L ig h L ig h t 1 P o w e r S u p p ly fo r L ig h t T o w e r +V CO M Xytrix Research & Design, Inc. page 10

11 Revisi 2.6 Secti 2: Installati and Setup Installati csists of mounting WebRelay-Quad, cnecting to an IP network, providing power, cfiguring via a web browser, and wiring relay ctacts to the device that will be ctrolled. 2.1 Mounting WebRelay-Quad can be be wall mounted or DIN rail mounted. It should be mounted in a clean dry locati where it is protected from the elements. Ventilati is recommended for installatis where ambient air temperature is expected to be high Wall Mounting WebRelay-Quad includes two keyholes in the rear of its enclosure for wall mounting. Mount to a wall by using two #8 screws. Attach the screws to the wall vertically spaced exactly 2.5 inches apart. The head of the screws should be about 1/10 inch away from the wall. See Appendix C for mechanical details DIN-Rail Mounting WebRelay-Quad can be mounted to a standard (35mm by 7.55mm) DIN rail. Attach WebRelayQuad to the DIN rail by hooking the top hook the back of the enclosure to the DIN rail and then snap the bottom hook into place. Remove WebRelay-Quad from DIN rail using a flat-head screwdriver. Insert the screwdriver into the notch in the release tab and pry against the enclosure to release the bottom hook. Xytrix Research & Design, Inc. page 11

12 Revisi Cnecti CAUTION: MAKE SURE POWER IS SHUT OFF BEFORE WIRING! Two removable terminal cnectors are provided for simple wiring to WebRelay-Quad. The correct wiring procedure is as follows; 1. Make sure power is turned. 2. Remove terminal cnectors from WebRelay-Quad and make wiring cnectis to the terminals. 3. Recnect terminal cnectors. 4. Apply power. It is recommended that the load (device to be ctrolled) not be cnected to WebRelay-Quad until after WebRelay-Quad has been cfigured and tested. By doing this, wiring and cfigurati mistakes will not cause the load device to turn unexpectedly. IMPORTANT: MAKE SURE WIRES ARE PROPERLY ATTACHED TO THE TERMINALS! B a d C o n n e c to r E x a m p le. S t r a n d ( s ) o f w ir e a r e lo o s e W ir e s a r e s t r ip p e d t o o f a r b a c k G o o d C o n n e c t o r E x a m p le. W ir e s a r e s t r ip p e d c o r r e c t a m o u n t a n d th e r e a r e n o lo o s e s tra n d s th a t c a n c a u s e s h o rts Xytrix Research & Design, Inc. page 12

13 Revisi pin cnector pinout: Pin VIN+ Descripti Power supply input. Cnect to the positive side of the appropriate power supply. DO NOT EXCEED MAXIMUM POWER SUPPLY VOLTAGE. Model X-WR-4R3-I 9~28VDC Power supply Model X-WR-4R3-E Power Over Ethernet model. These units do not require a power supply to be cnected to this pin when the unit is cnected to an 802.3af compliant network. Alternatively, this model can be powered using a 5VDC power supply. VIN1C Power supply ground (-) cnecti. Relay 1 Comm Ctact 1NC Relay 1 Normally Closed Ctact 1NO Relay 1 Normally Open Ctact 2C Relay 2 Comm Ctact 2NC Relay 2 Normally Closed Ctact 2NO Relay 2 Normally Open Ctact 3C Relay 3 Comm Ctact 3NC Relay 3 Normally Closed Ctact 3NO Relay 3 Normally Open Ctact 4C Relay 4 Comm Ctact 4NC Relay 4 Normally Closed Ctact 4NO Relay 4 Normally Open Ctact Power Supply Cnecti WebRelay-Quad requires power for its internal logic circuits. Cnect appropriate power supply to the Vin+ and Vin- terminals. Alternatively, WebRelay-Quad units with the Power Over Ethernet opti may be powered through the Ethernet cnecti instead of using an external power supply. Multiple WebRelay-Quad units may be cnected to a single power supply by cnecting the power supply input terminals in parallel. The power supply must have a high enough current rating to power all units cnected (see specificatis for current requirements for a specific model number). WebRelay-Quad units with the Power Over Ethernet opti may be cnected to an 802.3af compliant Ethernet port instead of cnecting an external power supply. In this case, WebRelayQuad is powered through the network port. In an 802.3af compliant network, a 48 Volt power source is injected into the Ethernet line. This power source is provided by an 802.3af compliant hub, switch, or power injector which may be located in a utility closet which could be a distance away from WebRelay-Quad. This opti is very useful for installatis where local power is not available. The power injector may inject the 48 Volt power source through the data lines or the spare lines in the Ethernet cable. DO NOT USE A POWER INJECTOR THAT APPLIES A VOLTAGE TO BOTH THE DATA LINES AND THE SPARE LINES. Xytrix Research & Design, Inc. page 13

14 Revisi Network Cnecti Cnect the Ethernet port to a 10 Base T or 10/100 Base T Ethernet cnecti. This typically cnects to an Ethernet hub, switch, or router. For cfigurati, WebRelay-Quad may be cnected directly to the Ethernet port a computer using a crossover cable. Otherwise for cnecti through a hub or router, a standard straight-thru cable should be used Relay Cnecti The relay ctacts internally cnect directly to the 14-pin cnector. No internal fuse is provided. The relay ctacts are rated at 3 Amp max (28V max). For larger loads, an external relay may be used to ctrol the load. 2.3 Establishing Communicatis for Setup WebRelay-Quad is set up using a web browser. The first task is to establish communicatis between a computer and the WebRelay-Quad device so that the browser-based cfigurati can begin. To do this, the computer and WebRelay-Quad must be physically cnected to the same network and both must have IP addresses the same network. There are two ways to set up the computer and WebRelay-Quad so that they are the same network. The first way (Opti 1), is to change the IP address of WebRelay-Quad to an address that is the same network as the computer. The secd way (Opti 2) is to change the IP address of the computer to an address that is the same network that WebRelay-Quad is set to by default Opti 1: Assign a temporary IP address to WebRelay-Quad This opti is used to TEMPORARILY assign an IP address to WebRelay-Quad without the need to change the IP address of the cfigurati computer. Note that WebRelay-Quad will ly use this IP address as lg as power is maintained. Once power is lost and restored, WebRelay-Quad will use the IP address assigned in the setup page and not the temporary address assigned here. This means that ce communicatis are established, the desired IP address should be entered into the network setup page using the browser. To assign the temporary IP address Make sure WebRelay-Quad and the cfigurati computer are cnected to the same physical network. This will not work through routers or gateways. 2. Assign the address as follows... Windows: Open a Command Prompt ( Windows XP, select START, then RUN, then type cmd ). 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-C ) to the following command would be used. arp -s c-c Next, type... ping -l 102 {new IP address} For example, if the new IP address is , the following command would be used. Xytrix Research & Design, Inc. page 14

15 Revisi 2.6 ping -l 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-C ) to the following command would be used. arp -s :0c:c8:01:00:01 Next, type... ping -s 102 {new IP address} For example, if the new IP address is , the following command would be used. ping -s Mac OS X Open a terminal, Note that the terminal is in the Utilities directory which is in Applicatis directory. type sudo arp -s {new IP address} {serial number of WebRelay-Quad } Note: Administrator password is required. 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-C ) to the following command would be used. sudo arp -s :0c:c8:01:00:01 Next, type... ping -s 102 {new IP address} For example, if the new IP address is , the following command would be used. ping -s Xytrix Research & Design, Inc. page 15

16 Revisi Opti 2: Assign a temporary IP address to cfigurati computer If the first opti above is not used, you can use this opti to communicate with WebRelayQuad. By default, WebRelay-Quad comes from the factory with an IP address of Communicatis with WebRelay-Quad may be established by assigning an IP address to the cfigurati computer that is the same network as WebRelay-Quad (for example the cfigurati computer could be assigned to ). Instructis for changing the IP address of the computer that will be used for WebRelay-Quad cfigurati are given here. Note that these instructis 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 ctrol panel by clicking the start menu and then clicking Ctrol Panel. (Note that ctrol panel shown is in Classic View. If ctrol panel is in Category View select the Classic View opti before proceeding.) Xytrix Research & Design, Inc. page 16

17 Revisi 2.6 Step 2: Double click the ic labeled Network Cnectis. The following menu will pop up. Step 3: Right click the ic labeled Local Area Cnecti. Another menu will appear. Select the opti at the bottom of the menu labeled Properties. The Local Area Cnecti Properties window will appear. Step 4: On the Local Area Cnecti Properties page scroll down to Internet Protocol (TCP/IPv4), select it, and then click the butt labeled properties. Xytrix Research & Design, Inc. page 17

18 Revisi 2.6 Step 5: Before making any changes to the network settings, write down the current settings so they can be restored ce WebRelay-Quad is cfigured. Next, select the radio butt labeled Use the following IP address, and type in the IP address Type in a subnet mask of Leave the default gateway field blank. Click OK to apply settings Open Cfigurati Web Page Once the network is set up, open the cfigurati setup page by typing the following URL into the browser: Note: If opti 1 above was used for initial cfigurati, 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). Xytrix Research & Design, Inc. page 18

19 Revisi Web-Based Setup WebRelay-Quad is fully cfigurable 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 cfigured easily. Note that in this chapter, the default IP address of is used in all examples. If the IP address has been changed, substitute the new IP address for the address shown in the examples. Before proceeding, make sure a network cnecti has been established between the computer and WebRelay-Quad. This is de by typing the following URL into the web browser: Another way to check communicatis is to ping WebRelayQuad (from the command prompt (type ping )). Each setup page is described below Main Setup Page This is the initial page that appears when the URL is entered into the web browser. It provides basic informati about the WebRelay-Quad unit. Xytrix Research & Design, Inc. page 19

20 Revisi 2.6 Navigating between setup pages is de by clicking 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 butt and a Reset butt at the bottom of the page. After entering the desired parameters into each page, the Submit butt must be pressed before any parameters will be saved. If a mistake is made in entering the parameters, the Reset butt may be used to restore all parameters the page to their current settings. The Reset butt is ly effective before the Submit butt is pressed. Xytrix Research & Design, Inc. page 20

21 Revisi Network Setup Page The network parameters are changed this page. Note that if multiple WebRelay-Quad units are used the same network, install e unit at a time and set the IP address of each unit before cnecting the next unit to the network. This avoids having multiple WebRelay-Quad units installed 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 the network (this is because each unit has the same default IP address but different mac address). This is de by typing arp -d in the command prompt of a Windows computer (arp -d -a as super user Apple OSX). Also note that the unit must be power-cycled (power discnected, then recnected) before network settings take effect. No other setup page requires power-cycling for the settings take effect. IP Address WebRelay-Quad requires a static IP address. This is a unique address that identifies WebRelay-Quad the network. Dynamic IP address assignment is not supported. The lack of dynamic IP addressing support is intential because a dynamically changing the IP address would make it difficult for a client to access the web server built into WebRelayQuad. The IP address is specific to the network where WebRelay-Quad will be installed, and must be obtained from the network administrator. This guide is not meant to be a tutorial IP addressing, however a few comments about IP addressing are given here. Xytrix Research & Design, Inc. page 21

22 Revisi 2.6 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 ly 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 cnect to the Internet using a single routable IP address. Many small routers from LinkSys, Dlink, and Netgear perform proxy server functis. If a proxy server is used, WebRelay-Quad will not be accessible from the Internet until the proxy server is properly cfigured (forward proper port to WebRelay-Quad ). This informati is mentied for cvenience but details of setting up a cfigurati such as this is beyd the scope of this manual. If WebRelay-Quad is used a private network ly and is NOT used over the Internet, a routable IP address is not necessary. This may be the case when WebRelay-Quad is used to ctrol (or mitor) a device in another room or a nearby building. If WebRelay-Quad will be installed a simple, private network that does not cnect to the Internet, the default IP address may be used as lg as no other device the network uses the same address. If multiple WebRelay-Quad units are installed the same network, each unit must have its own unique IP address. For example, WebRelay-Quad comes from the factory with a default IP address of If multiple units are used, change the IP address for each unit ( , , etc.). Netmask: This specifies the size of the local network. This must be obtained from the network administrator. By default, the netmask is set to Broadcast: This specifies the broadcast address. This must be obtained from the network administrator. By default, this is set to Gateway: This specifies the IP address of the gateway router. This must be obtained from the network administrator. By default, this is set to TCP Port: This specifies the TCP port used for communicatis with WebRelay-Quad. By default, the port is set to 80 which is the standard http port. It is recommended that the port not be changed without an understanding of TCP/IP and ports. Changing the port can be useful for accessing multiple WebRelay-Quad devices which are installed behind a gateway router a private network that uses n-routable IP addresses ( x.x, 10.x.x.x, and x.x through x.x are n-routable or private IP addresses). In this case, each WebRelay-Quad unit would be assigned a different port (for example 8000, 8001, 8002, etc). The gateway router would be set up to forward all traffic for each of the assigned ports to the IP address of the WebRelay-Quad unit which uses that port. The WebRelay-Quad 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-Quad unit. Note that whenever any port is assigned other than port 80, all communicatis with that WebRelay-Quad device must include the port. For example, if WebRelay-Quad is assigned port 8000, access to the setup page would require the following URL to be entered; Xytrix Research & Design, Inc. page 22

23 Revisi 2.6 An example screenshot of a gateway router cfigurati is given below. This setup allows seven CtrolByWeb products to be accessed 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 CtrolByWeb products are assigned IP addresses of to The first device labeled WebRelay-Quad 1 has an IP address of and is assigned port Note that in the WebRelay-Quad setup page (under Network settings tab), TCP Port 8001 must be specified for this device. The secd device, labeled WebRelay-Quad 2 has an IP address of and is assigned port This WebRelay-Quad must have its TCP Port set to 8002 in it's network settings page. This pattern ctinues through which is assigned the port To access the CtrolByWeb units from the Internet, enter the IP address of the gateway plus the port number of the desired device. Modbus Port: This specifies the port used for Modbus/TCP communicatis with WebRelay-Quad. By default this is set to port 502 which is the standard Modbus port. For users not familiar with Modbus, Modbus is a messaging structure protocol used in industrial manufacturing ctrol and automati. It is an open protocol and ers interoperability with software and devices from other manufacturers. If Modbus is not used, this setting can be ignored. Modbus communicatis are disabled whenever the ctrol password is enabled. Speed This opti sets the data rate of the Ethernet port. Both 10Mbps and 100Mbps can be selected. The 100Mbps opti ers faster communicatis but the amount of data to and from WebRelay-Quad is so small that users will not likely notice much of a difference. When WebRelay-Quad is set to 10Mbps, it draws less power and runs a little cooler which translate into a lger product life. IT IS RECOMMENDED THAT THIS SETTING BE LEFT AT 10MBPS UNLESS THE USER HAS A SPECIFIC REASON TO USE 100MBPS. Mode This opti 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. Xytrix Research & Design, Inc. page 23

24 Revisi 2.6 MTU Setting To change the MTU, manually enter the advsetup.html (case sensitive) page into the address bar. ( 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 Transmissi Unit. This defines the max size, in bytes, of the TCP packets sent out from the device. This normally can be left ale, but there are some circumstances where it might be beneficial to change it. One of these circumstances is when the device is to be used over a VPN (virtual private network). VPN's add extra informati to TCP packets, if the new packets are too big to physically travel across the network (greater than about 1500 bytes) then the packets will be split up. This causes problems for some firewalls and those firewalls will just discard the packets. To fix this, the MTU can be adjusted until the TCP packets do not get split up Password Setup Page The password setup page is used to change and enable passwords. A password is required for the setup pages but is optial for the ctrol page. The password is enabled or disabled for the ctrol page by using the Yes or No radio butts. Enabling the ctrol page password also enables the requirement for a password when reading/writing XML pages. Enabling the ctrol page password also disables the ability to communicate with WebRelay-Quad using Modbus. Note that when the password is changed, the password may be displayed in the browser s history in clear text. It is advisable to clear the browsers history after setting the password. Passwords may be up to 10 characters. Xytrix Research & Design, Inc. page 24

25 Revisi Relay Setup Pages These pages are used to set up the functi of each of the four relays, and how each relay is represented the ctrol page. All four pages are identical, with the excepti of the Relay 1 page which also includes a field for the main header text the ctrol page, the opti to automatically refresh the ctrol page, and the time durati for auto refresh. The following settings are ly included the Relay 1 setup page and not Relay 2,3 or 4 setup pages. Main Header Text: This text will be displayed in the main header area of the ctrol page. This field can be up to 25 characters in length. Xytrix Research & Design, Inc. page 25

26 Revisi 2.6 Auto Refresh Page: Web pages traditially display static informati. The WebRelay-Quad ctrol page, however, displays informati that is dynamic. Each time the ctrol 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 informati the ctrol page will be outdated unless the page is re-loaded. Whenever a user changes the state of the relay via the web browser, the web page will automatically reload the ctrol page to display current informati. If, however, the relay state changes due to a change due to a command sent from another machine, the relay state will not be updated and the ctrol page informati will be obsolete. The Auto Refresh Page opti will cause the ctrol page to ctinually update its ctents by setting a timer in the web page that causes it to be reloaded at a specified time interval. Durati: If the Auto Refresh Page opti is set to Yes, this field specifies the time interval in secds that the page will be refreshed. It can be set from 1 to 32 secds. The following settings are included all four relay setup pages. The settings correspd ly to the relay associated with that page. Relay Descripti: This text is used to describe the functi of the relay the ctrol page. This text will not appear if the Display Relay Status is set to No, the On/Off Butts is set to 0, and the Pulse Butt is set to No. This field can be up to 20 characters in length. Display Relay Status: When this opti is set to Yes, the relay status will be displayed the ctrol page. If it is set to No, the relay status will not be displayed. Status ON Color: When the Display Relay Status opti is set to Yes, this field specifies the color that will be displayed when the relay is (coil energized). Status ON Text: When the Display Relay Status opti is set to Yes, this field specifies the text that will be displayed when the relay is (coil energized). Status OFF Color: When the Display Relay Status opti is set to Yes, this field specifies the color that will be displayed when the relay is (coil not energized). Status OFF Text: When the Display Relay Status opti is set to Yes, this field specifies the text that will be displayed when the relay is (coil not energized). ON/OFF Butts: This opti allows the user to specify 0, 1, or 2 butts to turn the relay or. Zero butts disables the users ability to turn the relay and (a pulse butt may still be included... see below). One butt may be used to toggle the relay and. Two butts gives the user e butt to turn the relay and another butt to turn the relay. Butt 1 Label: When 1 or 2 butts is selected in the ON/OFF Butts opti, this field specifies the text that will be displayed in pushbutt number 1. Butt 2 Label: When 2 butts is selected in the ON/OFF Butts opti, this field specifies the text that will be displayed in pushbutt number 2. Xytrix Research & Design, Inc. page 26

27 Revisi 2.6 Pulse Butt: This opti allows the user to include a pulse butt to ctrol the relay. If the pulse butt is included, the relay will pulse for the time specified in the Pulse Durati field in the Relay/Input page each time the butt is pressed. Pulse Butt Label: When the Pulse Butt opti is set to Yes, the text entered here will appear in the pulse butt the ctrol page. Pulse Durati: When WebRelay-Quad receives a command (from over the network or through an input change) to pulse the relay, this is the time in secds that the relay will pulse. This time can be set from 0.1 secds to 86,400 secds (1 day). Note that each time WebRelayQuad receives a pulse command, the relay will be turned (if not already) and the pulse timer will be reset. If WebRelay-Quad receives a pulse command and and a secd pulse command comes in before the pulse timer has expired, the relay will remain and the pulse timer will be reset so the durati of the pulse will be extended. If pulse commands are issued ctinuously so that the pulse timer is not allowed to expire, the relay will remain until after the last pulse command was sent (to be precise, the relay will go at the time of the last command plus the Pulse Durati time). The pulse command can be canceled before the pulse durati time has expired by issuing any other command. The factory default setting for this is 1.5 secds. Xytrix Research & Design, Inc. page 27

28 Revisi 2.6 Secti 3: Operati WebRelay-Quad can be operated by using a web browser, by sending text commands to an XML status/ctrol page, or by sending Modbus/TCP requests. 3.1 Browser Operati Once the unit is set up, the ctrol page may be accessed by typing the following URL into the web browser: (Note that if the IP address was changed, replace the default IP address shown with the new address that was assigned. Note also that if any port is used other than port 80, the port must also be included in the request: ) The new ctrol page will appear. A ctrol page with default settings is shown below. Xytrix Research & Design, Inc. page 28

29 Revisi XML Operati Custom computer applicatis may be created to mitor and ctrol WebRelay-Quad without using a web browser. Mitoring the state of the relays is de by sending a GET request to port 80 (or port specified in setup) for the XML page. Ctrol of the relay is de by sending GET requests to the same page. This can be demstrated by entering commands into the URL line of a web browser state.xml Request the current state: This will return the following XML page.: <?xml versi="1.0" encoding="utf-8"?> <datavalues> <relay1state>0</relay1state> <relay2state>1</relay2state> <relay3state>1</relay3state> <relay4state>1</relay4state> </datavalues> The tags <relay1state>... <relay4state> indicate the current state of each of the four relays. Values for the tags are described below. XML Tags* Values <relayxstate> 0 = Off (coil ) 1 = On (coil energized) * 'X' is replaced by the relay number XML Ctrol Commands can be sent to WebRelay-Quad to ctrol 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. Note: would be included all of the following commands. Command Descripti state.xml?relay1state=0 Turn Relay 1 Off state.xml?relay1state=1 Turn Relay 1 On state.xml?relay1state=1&relay3state=0 Turn Relay 1 ON, Turn Relay 3 OFF Commands can be issued to pulse the relays instead of simply turning them or by setting the relayxstate to 2. Commands can also specify pulse times so that the relay can be pulsed for times other than the times specified in the relay setup pages. This is de by sending an additial variable called pulsetimex (ce again, X represents the appropriate relay). Command Descripti state.xml?relay1state=2 Pulse Relay 1 for the preset time state.xml?relay1state=2&pulsetime1=5 Pulse Relay 1 for 5 secds state.xml?relay3state=2&pulsetime3=10 Pulse Relay 3 for 10 secds Xytrix Research & Design, Inc. page 29

30 Revisi 2.6 The pulsetimex variable does not change the pulse time specified in the setup page and it is not stored or recorded. The pulsetimex variable ly changes the pulse durati 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 secds in the cfigurati pages. To issue e 1.5 secd pulse, three five secd pulses, and a 1.5 secd pulse ce again, you would issue the following commands... state.xml?relay1state=2 state.xml?relay1state=2&pulsetime1=5 state.xml?relay1state=2&pulsetime1=5 state.xml?relay1state=2&pulsetime1=5 state.xml?relay1state=2 This will pulse the relay for the preset time (1.5 secds) This will pulse the relay for 5 secds. This will pulse the relay for 5 secds This will pulse the relay for 5 secds This will pulse the relay for the preset time (1.5 secds) Note: would be included all commands above Multiple relays can be changed with a single command by submitting multiple relayxstate variables separated by an ampersand symbol (&). All four relayxstate variables or a subset of the relayxstate variables can be included. The relayxstate variables can be in any order. Relays that are already in the desired state will not be affected by / commands. Note: Pulse commands will reset the pulse timer each time a command is received. The following line illustrates how to turn ON Relay 1, turn ON Relay 2, and turn OFF Relay 4. When the above commands are sent to WebRelay-Quad, its current state is returned in the form of an XML page. Note: The XML reply does not ctain headers. To generate an XML reply with headers use the following command: Command Descripti statefull.xml Return the XML reply with headers The commands can also be sent without having WebRelay-Quad return the XML page. This is accomplished by adding the noreply field as follows. Command Descripti state.xml?relay1state=1&noreply=1 Turn Relay 1 ON without returning state. state.xml?relay1state=0&noreply=1 Turn Relay 1 OFF without returning state. Xytrix Research & Design, Inc. page 30

31 Revisi GET Requests GET requests can be used by custom applicatis to mitor and ctrol 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.1\r\n\r\n Password Enabled: If the ctrol password is enabled in the WebRelay-Quad 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 applicati and not a browser, the html request will need to ctain the password encoded using the base 64 encoding scheme. The html request header without the password looks like this: GET /state.xml?noreply=1 HTTP/1.1 (Terminated with two \r\n) The html request header with the password looks like this: GET /state.xml?relay2state=1&noreply=1 HTTP/1.1 (Terminated with e \r\n) Authorizati: Basic bm9uztp3zwjyzwxheq== (Terminated with two \r\n\) where bm9uztp3zwjyzwxheq== is the base 64 encoded versi of the username and password ne:webrelay. A utility is provided at 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. Xytrix Research & Design, Inc. page 31

32 Revisi Modbus Operati WebRelay-Quad can be ctrolled (and read) using Modbus/TCP protocol. This provides a standard means of using WebRelay-Quad in cjuncti with devices and software from other manufacturers. This secti ctains the informati necessary to communicate with WebRelayQuad using Modbus/TCP. This is not a tutorial Modbus and it is assumed that reader is already familiar with Modbus. Detailed Modbus informati can be found at It is important to note that when the ctrol password in WebRelay-Quad is enabled, Modbus/TCP communicatis are disabled. This is because Modbus/TCP does not provide a mechanism for password protecti. Make sure the ctrol password is disabled (default) before using Modbus with WebRelay-Quad. WebRelay-Quad functis as a Modbus server. Client devices open a cnecti with WebRelay-Quad port 502 (unless another modbus port is selected) and sends commands or requests to to read the state of a relay, or change a relay. When WebRelay-Quad receives a command, it will perform the desired functi and return a respse. The following commands are available: Read Coils (Modbus functi 01) - read the status of the relay (and/or the input). Write Single Coil (Modbus functi 05) - change the relay state Write Multiple Coils (Modbus Functi Code 15) change multiple relays at the same time Write Multiple Registers (Modbus functi 16) - pulse the relay or multiple relays. Multiple commands may be sent without closing and re-opening the cnecti but if no data is transferred for about 50 secds the cnecti will time out. To keep the cnecti open, a read request can be sent periodically Read Coils (Modbus Functi Code 01 (0x01)) This functi returns the state of the relay coil(s). Relay 1 is at address 0x0000, relay 2 is at address 0x0001, relay 3 is at address 0x0002, and relay 4 is at address 0x0003. Multiple relays may be read at the same time by specifying the correct starting address and quantity of coils. When address 0x0000 is used, the quantities of coils can be 0x0001, 0x0002, x0003 or 0x0004. When address 0x0003 is used, the ly valid quantity of coils is 0x0001. This means that relays 1 and 4 cannot be read without reading relays 2 & 3. Request Modbus/TCP: Transacti identifier (2 Bytes): 0x0001 Protocol identifier (2 Bytes): 0x0000 Length (2 Bytes): 0x0006 Unit identifier (1 Byte): 0xff Modbus: Functi 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 }; Respse Modbus/TCP: Transacti identifier (2 Bytes): 0x0001 Xytrix Research & Design, Inc. page 32