1. Manuals
  2. Brands
  3. Xytronix Research & Design Manuals
  4. Control Unit
  5. WebRelay-10 X-WR-10R12-I
  6. User manual

Xytronix Research & Design WebRelay-10 X-WR-10R12-I User Manual

Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
WebRelay-10
Title Page
Goes Here

Advertisement

Table of Contents
loading

Related Manuals for Xytronix Research & Design WebRelay-10 X-WR-10R12-I

Summary of Contents for Xytronix Research & Design WebRelay-10 X-WR-10R12-I

  • Page 1 WebRelay-10 Title Page Goes Here...

  • Page 2: Table Of Contents

    WebRelay-10 Users Manual Table of Contents Section 1: Introduction................................4 1.1 Features..................................5 1.2 Applications................................... 5 1.3 WebRelay-10 Models Available............................. 6 1.4 Connectors & Indicators..............................7 1.5 Accessing WebRelay-10..............................8 Section 2: Installation and Setup ............................9 2.1 Mounting..................................10 2.2 Connections.................................
  • Page 3 WebRelay-10 Users Manual WebRelay-10 User Manual Revisions Revision Description Changed input voltage specification from 10-36VDC to 9-28VDC Updated power requirements for 9-28VDC operation Changed relay contact specification from 30amps to 15amps Moved warranty and trademark information to the appendix Changed warranty to 5-years Clarified relay specifications Xytronix Research &...

  • Page 4: Section 1: Introduction

    Introduction WebRelay-10 Users Manual Section 1: Introduction WebRelay-10™ is a robust, 10-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-10 using a web browser or a custom application. Computers, PLCs, or automation controllers may control and monitor WebRelay-10 without user intervention.

  • Page 5: Features

    WebRelay-10 Users Manual Introduction 1.1 Features WebRelay-10 includes the following features: - Ten independent 15-Amp Relays (Form C, SPDT). - Built-in Web server for browser-based setup and control. - No special software or device drivers required. - Customizable email alerts. - XML status and Control Page make communications with custom computer applications simple.

  • Page 6: Webrelay-10 Models Available

    Introduction WebRelay-10 Users Manual 1.3 WebRelay-10 Models Available WebRelay-10 is currently available in two models. The main differences between each model are listed below. X-WR-10R12-I Standard WebRelay-10 with built-in web server, and ten individually controlled relays. X-WR-10R12-IP WebRelay-10 Plus™ includes all features of standard model plus (WebRelay-10 Plus) temperature/humidity monitoring (humidity monitoring requires optional humidity sensor), discrete inputs, real-time clock, event scheduling, capacitor power...

  • Page 7: Connectors & Indicators

    WebRelay-10 Users Manual Introduction 1.4 Connectors & Indicators Version H (Newest version) – Gnd and Vin+ pin position moved from version 2.3 Figure 1.4a - Connections & Indicators Version G (Older version) Xytronix Research & Design, Inc. page 7...

  • Page 8: Accessing Webrelay-10

    Introduction WebRelay-10 Users Manual Module Power Connectors Two 1/4” tab connectors located on the circuit board are used to apply power to the module. Relay Connectors Each relay has three ¼” tab connectors for common, normally open, and normally closed contacts. Female mating connectors (not included) are required for connecting user circuits.

  • Page 9: Section 2: Installation And Setup

    WebRelay-10 Users Manual Installation and Setup Section 2: Installation and Setup Installation consists of mounting WebRelay-10, connecting it to an Ethernet network, providing power, configuring via a web browser, and wiring relay contacts to the device that will be controlled. For WebRelay-10 Plus™...

  • Page 10: Mounting

    Installation and Setup WebRelay-10 Users Manual 2.1 Mounting WebRelay-10 can be mounted to a standard (35mm by 7.55mm) DIN-Rail. Attach the module to the DIN-Rail by placing the top hooks on the back of WebRelay-10 to the DIN-Rail and then snapping the bottom hooks into place.

  • Page 11: Connections

    WebRelay-10 Users Manual Installation and Setup 2.2 Connections CAUTION: MAKE SURE POWER IS SHUT OFF BEFORE WIRING! CAUTION: THIS UNIT SHOULD BE INSTALLED BY A QUALIFIED TECHNICIAN. MIS-WIRING OR MIS CONFIGURATION COULD CAUSE PERMANENT DAMAGE TO THE WebRelay-10 AND/OR THE EQUIPMENT TO WHICH IT IS CONNECTED. Relay connections are made through the ¼...
  • Page 12 Installation and Setup WebRelay-10 Users Manual Figure 2.2a - Network Connection WebRelay-10 can be used on a wireless network by connecting through an Ethernet bridge or a wireless router. WebRelay-10 is connected directly to the wireless device. Figure 2.2b - Wireless Connection Note: The wireless Ethernet bridge or router must be properly configured for the wireless network.
  • Page 13 WebRelay-10 Users Manual Installation and Setup Figure 2.2c - Connector Pinout Input Connection (WebRelay-10 Plus™ only) Two discrete inputs can be connected to dry contact sensors or switches. Third party sensors can be used for monitoring alarm conditions such as door access switches or transducer thresholds. Inputs can also be used for operator switches and the unit can be configured such that they control the relays.
  • Page 14 Installation and Setup WebRelay-10 Users Manual Figure 2.2e - Input Connector Temperature/Humidity Sensor Connection (WebRelay-10 Plus™ only) Temperature and/or humidity sensors can be used for monitoring environmental conditions. The digital sensors use a one-wire data bus, which allows up to eight sensors to share the same terminals (+5V, Ground, Data).
  • Page 15 WebRelay-10 Users Manual Installation and Setup Figure 2.2g - Direct Connection (Star) and Daisy Chain Connection(Linear) Many factors will determine the maximum length of cable used to connect sensors to WebRelay-10 Plus™. Some of these factors include, but are not limited to, the type of cable used, the number of sensors, ambient electromagnetic noise, and sensor network topology.

  • Page 16: Establishing Communications For Setup

    Installation and Setup WebRelay-10 Users Manual 2.3 Establishing Communications for Setup In order to configure WebRelay-10 with the web browser interface, WebRelay-10 must be connected to an Ethernet computer network. This can be done by one of two methods: Method 1 – Assign a temporary IP address of WebRelay-10 to work on an existing network. -or- Method 2 –...
  • Page 17 WebRelay-10 Users Manual Installation and Setup arp -s {new IP address} {serial number of WebRelay-10 } Note: IP address format is xxx.xxx.xxx.xxx. The serial number can be found on a label on the module board. The format is ss:ss:ss:ss:ss:ss. For example, to set WebRelay-10 (with serial number 00-0C-C8-01-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 3.
  • Page 18 Installation and Setup WebRelay-10 Users Manual 2.3.2 Method 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-10. By default, WebRelay-10 comes from the factory with an IP address of 192.168.1.2. Communications with WebRelay-10 may be established by assigning an IP address to the configuration computer that is on the same network as WebRelay-10 (for example, the configuration computer could be assigned to 192.168.1.50)
  • Page 19 WebRelay-10 Users Manual Installation and Setup 3. Right click on the icon labeled Local Area Connection. In the menu that follows, select the option at the bottom of the menu labeled Properties. The Local Area Connection Properties window will appear (Figure 2.3c). Figure 2.3d- Local Area Connection Xytronix Research &...
  • Page 20 Installation and Setup WebRelay-10 Users Manual 4. In the Local Area Connection Properties window in the Connection Uses box, scroll down and highlight “Internet Protocol (TCP/IP).” Click the button labeled “Properties.” The “Internet Protocol (TCP/IP)” Properties menu appears (Figure 2.3e). 5.

  • Page 21: Webrelay-10 Setup

    WebRelay-10 Users Manual Installation and Setup 2.4 WebRelay-10 Setup Pages WebRelay-10 is configured using a web browser. To access the setup pages, enter the following URL in the address bar of a web browser: http://{ipaddress}/setup.html For example, using the default IP address, enter: http://192.168.1.2/setup.html After the page is requested, a password prompt will appear.
  • Page 22 Installation and Setup WebRelay-10 Users Manual 2.4.2 Network Tab The network parameters are set on this page. Note: WebRelay-10 must be power-cycled (power disconnected, then reconnected) before network settings take effect. Only the settings on the Network tab require power-cycling before taking effect. Figure 2.4b - Network Tab Use DHCP (WebRelay-10 Plus™...
  • Page 23 WebRelay-10 Users Manual Installation and Setup Brief Notes About DHCP All devices on an IP network require an IP address. This is a unique address that identifies each device on the network. DHCP (Dynamic Host Control Protocol) is a mechanism that automatically assigns an IP address to a computer (or other devices) when it is connected to a network.
  • Page 24 Installation and Setup WebRelay-10 Users Manual 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.
  • Page 25 WebRelay-10 Users Manual Installation and Setup 2.4.3 Advanced Network Tab Note: These settings are not used for most installations. Figure 2.4c - Advanced Network Tab Modbus Enabled WebRelay-10 can support Modbus/TCP. Modbus is a messaging structure protocol used in industrial manufacturing control and automation. It is an open protocol and offers interoperability with software and devices from other manufacturers.
  • Page 26 Installation and Setup WebRelay-10 Users Manual Server Name/IP Address Specify the name or IP address of the Remote Services server here. If the IP address is specified, enter it in this format aaa.bbb.ccc.ddd. For numbers that are less than 100, preceding zeros should not be included (for example, enter 80 rather than 080).
  • Page 27 WebRelay-10 Users Manual Installation and Setup IP Filter Range 1: 192.168.1.0 192.168.1.255 IP Filter Range 2: 10.143.100.32 10.143.100.32 Note: The address specified for the Remote Services server (if applicable) is automatically allowed through the firewall no matter how this is set. Remote Services Remote Services initiates an outgoing connection to a server at a remote location.
  • Page 28 Installation and Setup WebRelay-10 Users Manual 2.4.4 Password Tab WebRelay-10 requires a password to log into the setup pages. The password can be changed on this page. Additionally, the installer can enable the requirement for a Control Page password. Figure 2.4d - Password Tab Setup Password The Setup Password, which is required to access the setup pages, can be modified by entering a new password here.
  • Page 29 WebRelay-10 Users Manual Installation and Setup a second time in this field. If the password is not entered identically in both fields, the password will not be changed. Xytronix Research & Design, Inc. page 29...
  • Page 30 Installation and Setup WebRelay-10 Users Manual 2.4.5 Date/Time Tab (WebRelay-10 Plus™ only) WebRelay-10 Plus™ uses the time for scheduled events, such as turning the relays ON or OFF at scheduled times and for logging (a time stamp is included with each logged event). The time is stored and displayed in 24-hour time format.
  • Page 31 WebRelay-10 Users Manual Installation and Setup minutes [00-59], SS represents seconds [00-59].) Figure 2.4f - Date/Time Tab - Sync with NTP Server NTP Time Configuration Server Name/IP Address This field is used to specify the name or IP address of the NTP server. If a name is specified, a working DNS server address must be entered into the Network settings.
  • Page 32 Installation and Setup WebRelay-10 Users Manual 2.europe.pool.ntp.org 3.europe.pool.ntp.org Australia (http://www.pool.ntp.org/zone/au): 0.au.pool.ntp.org 1.au.pool.ntp.org 2.au.pool.ntp.org 3.au.pool.ntp.org South America (http://www.pool.ntp.org/zone/south-america): 0.south-america.pool.ntp.org 1.south-america.pool.ntp.org 2.south-america.pool.ntp.org 3.south-america.pool.ntp.org Africa (http://www.pool.ntp.org/zone/africa): 1.africa.pool.ntp.org 1.pool.ntp.org 3.pool.ntp.org Sync With Server This option allows the user to specify how often WebRelay-10 Plus™ time will be synchronized with the time server.
  • Page 33 WebRelay-10 Users Manual Installation and Setup random time within the previously mentioned, five-hour time frame, in order to prevent several different devices from simultaneously requesting a time and overwhelming the NTP server. The default setting is Yes. Note: Enabling the daylight savings time adjustment, scheduled events will be adjusted for the new time.
  • Page 34 Installation and Setup WebRelay-10 Users Manual 2.4.6 Logging Tab (WebRelay-10 Plus™ only) WebRelay-10 Plus™ can be configured to record data such as changes in relay and input state, sensor data, and events. Both periodic and event-based logging are supported. The logged data is stored in internal nonvolatile memory and can be retrieved by entering the command http://{WebRelay-10 IP address}/log.txt.
  • Page 35 WebRelay-10 Users Manual Installation and Setup The default setting for this field is 01:00. Logging Rate This field is used to specify the time period of logging. A numerical value is entered into the text field, and the unit of time is selected using the adjacent radio buttons. The range of values in this field is 1-20864.
  • Page 36 Installation and Setup WebRelay-10 Users Manual 2.4.7 Inputs Tab (WebRelay-10 Plus™ only) This page provides configuration options for the two control inputs built into WebRelay-10 Plus™. Figure 2.4h - Inputs Tab Note: In this manual, the input is considered to be ON when the input is tied to ground. Input This drop down menu is used to select the control input to which the options below will apply.
  • Page 37 WebRelay-10 Users Manual Installation and Setup Note: The input voltage must remain ON or OFF for the minimum hold time before the counter will be incremented, see Appendix H: Specifications. - counter off: The counter is deactivated and will not be incremented - increment when input on: Each time the input is tied to ground, the counter will increment.
  • Page 38 Installation and Setup WebRelay-10 Users Manual 2.4.8 Relays Tab This page provides configuration options for the ten relays. Figure 2.4i - Relays Tab Relay This drop down menu is used to select the relay for which the options below will apply. - Relay 1 to Relay 10: Selects the relay.
  • Page 39 WebRelay-10 Users Manual Installation and Setup Off Button Label The text entered in this field appears in the OFF button for the corresponding relay on the Control Page. Up to 10 characters may be entered in this field. The default text is OFF. Pulse Button Label The text entered in this field appears in the 'Pulse' button for the corresponding relay on the Control Page.
  • Page 40 Installation and Setup WebRelay-10 Users Manual - latch relay when input 1 changes (reset via web): Each time the input is tied to ground or when the input is open, the relay turns ON. Once the relay is on, it will stay ON (unaffected by input change) until it is turned OFF via the web (or command) by a user or WebRelay-10 Plus™...
  • Page 41 WebRelay-10 Users Manual Installation and Setup Use Email Address If email messages are to be sent out when relays change state, these check boxes specify to which email addresses the message will be sent. Email addresses specified on the Network setup tab will be displayed next to each check box.
  • Page 42 Installation and Setup WebRelay-10 Users Manual 2.4.9 Sensor Tab (WebRelay-10 Plus™ only) This tab is used to configure temperature/humidity sensors and associated alarms. WebRelay-10 Plus™ will automatically detect whether a temperature or humidity sensor is connected. Figure 2.4j - Sensors Tab Sensor Up to eight sensors can be connected to WebRelay-10 Plus™.
  • Page 43 WebRelay-10 Users Manual Installation and Setup The addresses of the sensors that are found on the bus are listed in the drop-down list. For each sensor number (Sensor 1... Sensor 8), select the address of the appropriate sensor from the drop- down list.
  • Page 44 Installation and Setup WebRelay-10 Users Manual - Send Email on Alarm 1, Alarm 2, and Normal: Email notifications will be sent due to Alarm 1, Alarm 2, or when normal conditions are regained. Use Email Address If email messages are to be sent out based on alarm conditions, these check boxes specify to which email addresses the message will be sent.
  • Page 45 WebRelay-10 Users Manual Installation and Setup 2.4.10 Events Scheduler Tab (WebRelay-10 Plus™ only) Events can be programmed to turn the relays ON and OFF at specific times. Up to 100 events can be created. Each event can occur one time or multiple times. Figure 2.4l - Events Tab A list of all scheduled events and information about each event is displayed in a table.
  • Page 46 Installation and Setup WebRelay-10 Users Manual Configuration of events is accomplished by clicking on the appropriate event, which causes the following setup screen to be displayed. Figure 2.4m - Event Setup Current Date/Time This field displays the current date and time as specified in the Date/Time tab. Schedule # WebRelay-10 Plus™...
  • Page 47 WebRelay-10 Users Manual Installation and Setup specified by marking the appropriate check boxes. Count The number of times the event will occur is specified. The default text is 0. Note that entering 0 in this field will cause the event to occur continuously. Action This drop down menu specifies which action will take place when the event occurs.
  • Page 48 Installation and Setup WebRelay-10 Users Manual Field Name Event 1 Event 2 Application Description Schedule # Schedule 0 cannot be disabled by other events. Description Security ON Security OFF User description of event. Start Date Current Day Current Day Set to current or previous day. Start Time 20:00:00 06:00:00...
  • Page 49 WebRelay-10 Users Manual Installation and Setup 2.4.11 Script Tab WebRelay-10 can be used to run simple custom programs written in a language similar to BASIC. This page is used to load and execute these programs. Before it can be loaded to WebRelay-10, a script must first be written as a .txt file.
  • Page 50 Installation and Setup WebRelay-10 Users Manual Run Script This option selects whether or not the selected script will be run after it has been uploaded. The Submit button must be clicked to run the script. External Variables External Variables are variables that can be used in BASIC scripts. They are called External Variables because their values can be changed externally to the BASIC script using xml requests, or through the Control Page.
  • Page 51 WebRelay-10 Users Manual Installation and Setup Button 2 Label This text field is used to describe the function of button 2 of the selected extVar. The text also appears to the right of the corresponding extVar status. Up to 14 characters may be entered here. By default, this text is OFF with a value of 0.
  • Page 52 Installation and Setup WebRelay-10 Users Manual 2.4.12 Control Page Setup Tab The Control Page Setup page is used mainly to set parameters that affect the view of the Control Page, how often it will refresh, etc. Figure 2.4p - Control Page Setup Tab Main Header Text The text entered here appears at the top of the Control Page.
  • Page 53 WebRelay-10 Users Manual Installation and Setup - Display On/Off Buttons: When checked, an ON and OFF button is displayed for direct user control. - Display Pulse Button: When checked, a button allowing a user to manually pulse a specified relay is displayed. Note: Inputs, Counters, and Sensors are available on WebRelay-10 Plus™...

  • Page 54: Section 3: Operation

    Operation WebRelay-10 Users Manual Section 3: Operation WebRelay-10 can be operated using a web browser, by sending text commands to an XML status/control page, and/or by sending Modbus/TCP requests. In addition WebRelay-10 Plus™ model allows you to control the relays using inputs, or events. (Using an input or event to control the relays was described throughout previous sections of the manual, and will not be described here.) 3.1 Browser Operation Once WebRelay-10 is set up, users can access the Control Page using a web browser by typing the IP...
  • Page 55 WebRelay-10 Users Manual Operation Header Displays the text entered in the Main Header Text field on the Control Page Setup tab in the setup pages. Input 1 and 2 (WebRelay-10 Plus™ only) These rows display the current state of the two inputs. These rows can be displayed (as shown) or not displayed by checking or unchecking the appropriate boxes in the Control Page Setup tab in the setup pages.

  • Page 56: Xml Operation

    Operation WebRelay-10 Users Manual 3.2 XML Operation Custom XML computer applications may be created to monitor and control WebRelay-10. This method does not use a web browser. Diagnostics.xml is available for troubleshooting and system monitoring. 3.2.1 state.xml Monitoring The state of the relays, inputs, and sensors can be monitored by sending a request to port 80 (or port specified in setup).
  • Page 57 WebRelay-10 Users Manual Operation XML Tags* Monitor Values Control Values WebRelay-10 Plus™ Only <inputXstate> 0 = Input OFF 1 = Input ON <hightimeX> The amount of time in seconds that the input was last on <countX> Current number of times the input has been counted (counting must be enabled) <relayXstate>...
  • Page 58 Operation WebRelay-10 Users Manual the following commands: Command Description state.xml?relay1State=2 Pulse Relay 1 for the preset time (1.5 seconds). state.xml?relay1State=2&pulseTime1=5 Pulse Relay 1 for 5 seconds. state.xml?relay1State=2&pulseTime1=5 Pulse Relay 1 for 5 seconds. state.xml?relay1State=2&pulseTime1=5 Pulse Relay 1 for 5 seconds. state.xml?relay1State=2 Pulse Relay 1 for the preset time (1.5 seconds).
  • Page 59 WebRelay-10 Users Manual Operation 3.2.2 Monitoring Events Through eventX.xml (WebRelay-10 Plus™ only) The relays can be configured to turn ON, turn OFF, or pulse at specified times. Instructions to change the relay state at a given time (or periodically) are called events. WebRelay-10 Plus™ supports 100 events, which can be monitored through the eventX.xml page (where X is the event number 0-99).
  • Page 60 Operation WebRelay-10 Users Manual 3.2.3 XML Diagnostics There is a special diagnostics.xml can be requested by by entering the following in the web browser address bar: http://192.168.1.2/diagnostics.xml The following diagnostics.xml file is returned. <datavalues> <memoryPowerUpFlag>1</memoryPowerUpFlag> <devicePowerUpFlag>1</devicePowerUpFlag> <powerLossCounter>1</powerLossCounter> </datavalues> Diagnostic tags are given in the table below. Description <memoryPowerUpFlag>...

  • Page 61: Configuring Events Through Get Requests (Webrelay-10 Plus™ Only)

    WebRelay-10 Users Manual Operation 3.3 Configuring Events Through GET Requests (WebRelay-10 Plus™ only) Events can be configured using a GET request. For example, to configure event 5 to start on November 19, 2010 at 12:00:00 and continue every day, turning Relay 1 on, send the following request (using the default IP address): http://192.168.1.2/eventSetup.srv? e5=1290168000;1;3;0;0;1;4;0;Event5Desc;127;1;...
  • Page 62 Operation WebRelay-10 Users Manual 3.3.1 Common Base Ten Values for Event Days Tues Thurs Base 10 Value Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 page 62 Xytronix Research & Design, Inc.

  • Page 63: Modbus Operation

    WebRelay-10 Users Manual Operation 3.4 Modbus Operation WebRelay-10 can be controlled and monitored using Modbus/TCP protocol. This provides a standard means of using WebRelay-10 with devices and software from other manufacturers. This section is not a tutorial on Modbus and it is assumed that the reader is already familiar with Modbus. Detailed Modbus information can be found at http://www.modbus.org.
  • Page 64 Operation WebRelay-10 Users Manual Code Name Modbus Data Type* PLC Address PLC Address Function Mode 485 Mode 584/984 Coils (Read/Write) 01, 05, 15 Discrete 1-1000 1-10000 Discrete Inputs (Read only) Discrete 1001-2000 10001-20000 Registers (Read only) 8-64 bits 3001-4000 30001-40000 Holding Registers 03, 06, 16 8-64 bits...
  • Page 65 WebRelay-10 Users Manual Operation 3.4.3 WebRelay-10 Full Address Table The table below gives commonly used function code, memory types, data sizes, and equivalent PLC addresses for accessing the WebRelay-10. The data size will be the same regardless of the addressing mode.
  • Page 66 Operation WebRelay-10 Users Manual 3.4.4 Read Coils - Modbus Function Code 01 (0x01) This function returns the state of the relay coils. 0 denotes that the coil is not energized, 1 denotes that the coil is energized. Request Valid starting address can fall in the range of 0x0000 and 0x0009. Relay 1 is at address 0x0000, Relay 2 is at address 0x0001, Relay 3 is at address 0x0002, and so forth.
  • Page 67 WebRelay-10 Users Manual Operation WebRelay-10 Response Frame Example – Status of Coils 2 through 10 Field Name Length Function Example Data Transaction Identifier 2 bytes Synchronization number. 0x0001 Protocol Identifier 2 bytes Zero for Modbus/TCP 0x0000 Message Length 2 bytes Number of bytes in frame (below) 0x0004 Unit Identifier...
  • Page 68 Operation WebRelay-10 Users Manual 3.4.5 Read Discrete Inputs – Modbus Function Code 02 (0x02) (WebRelay-10 Plus™ only) This function returns the state of the discrete inputs. Start Address: 0x0000 (input1) to 0x0001 (input 2) Input Quantity: 0x0001 to 0x0002 The sum of the starting address and the quantity of coils must not be greater than 0x0002. For example, if you want to read 0x0002, both inputs, then the start address must be 0x0000.
  • Page 69 WebRelay-10 Users Manual Operation Errors Input Read Error Function Code (1 Byte): 0x82 Exception codes (1 Byte): 0x01 – Function not supported. 0x02 – Incorrect combination of start address and input quantity. Error Response Frame Example Field Name Length Function Example Data Transaction Identifier 2 bytes...
  • Page 70 Operation WebRelay-10 Users Manual 3.4.6 Read Sensors – Modbus Function Code 03 (0x03) (WebRelay-10 Plus™ only) The Read Holding Registers function is used for the temperature or humidity sensors. 32-bit sensor values are read from 16-bit register pairs. Consequently, senors addresses and registers must be even numbers.
  • Page 71 WebRelay-10 Users Manual Operation Exception Codes (1 byte): 0x01 – Function not supported. 0x02 – Incorrect combination of start address and input quantity Error Response Frame Example Field Name Length Function Example Data Transaction Identifier 2 bytes Synchronization between messages of 0x0001 server and client.
  • Page 72 Operation WebRelay-10 Users Manual 3.4.7 Write Single Coil Modbus Function Code 05 (0x05) – This function allows you to control relays one at a time. Relay Address (2 bytes): 0x0000 (Relay 1) – 0x00009 (Relay 10) Relay Value (1 byte): 0x00 (ON)), 0xFF(OFF) Padding (1 byte): 0x00...
  • Page 73 WebRelay-10 Users Manual Operation Error Response Frame Example Field Name Length Function Example Data Transaction Identifier 2 bytes Synchronization between messages of 0x0001 server and client. Protocol Identifier 2 bytes Zero for Modbus/TCP 0x0000 Message Length 2 bytes Number of bytes in frame (below) 0x0003 Unit Identifier 1 byte...
  • Page 74 Operation WebRelay-10 Users Manual 3.4.8 Write Multiple Coils - Modbus Function Code 15 (0x0F) One to two bytes can be written to set the state of all 10 relays, each bit representing one relay. The least significant bit of the lower byte represents Relay 1 and the 2nd bit of upper byte representing Relay Upper Byte Lower Byte Bit 15 14...
  • Page 75 WebRelay-10 Users Manual Operation Response WebRelay-10 Response Frame Example – Write Coils 7-9 ON Field Name Length Function Example Data Transaction Identifier 2 bytes Synchronization number. 0x0001 Protocol Identifier 2 bytes Zero for Modbus/TCP 0x0000 Message Length 2 bytes Number of bytes in frame (below) 0x0004 Unit Identifier 1 byte...
  • Page 76 Operation WebRelay-10 Users Manual 3.4.9 Pulse Coils – Modbus Function Code 16 (0x10) The Modbus Write Multiple Registers function is used to pulse the relay(s) for a specified time. When WebRelay-10 receives this command, it immediately turns the appropriate relay coil(s) ON (if not already on) and starts the pulse timer.
  • Page 77 WebRelay-10 Users Manual Operation Response WebRelay-10 Response Frame Example – Write Coils 7-9 ON Field Name Length Function Example Data Transaction Identifier 2 bytes Synchronization number. 0x0001 Protocol Identifier 2 bytes Zero for Modbus/TCP 0x0000 Message Length 2 bytes Number of bytes in frame (below) 0x0004 Unit Identifier 1 byte...

  • Page 78: Email Notification

    Operation WebRelay-10 Users Manual 3.5 Email Notification 3.5.1 Email Notification Description WebRelay-10 can be configured to send messages to five email addresses when certain events occur. Events that can trigger email messages include input state changes, relay state changes, temperature/humidity changes, and commands sent from a BASIC script. When an email message is sent, it looks similar to this: WebRelay-10 Trigger: Relay 1: ON...
  • Page 79 WebRelay-10 Users Manual Operation 3.5.2 Email Notification Setup Email notification requires that the following fields are properly configured. See Section 2.4.2 for a description of each field. Network Tab IP Address Subnet Mask Gateway Preferred DNS Server (this is required if Mail Server is entered by name and not by IP address) Mail Server (SMTP) User Name (If Required) Password (If Required)

  • Page 80: Appendix A: Restoring Factory Default Settings

    Appendix A: Restoring Factory Default Settings WebRelay-10 Users Manual Appendix A: Restoring Factory Default Settings In the event that the IP address or passwords are forgotten, WebRelay-10 may be restored to its original factory default settings. 1. Remove the DC power from the unit. This will also de-energize any relay coils. 2.

  • Page 81: Appendix B: Installing New Firmware

    WebRelay-10 Users Manual Appendix B: Installing New Firmware Appendix B: Installing New Firmware From time to time, updates are made to WebRelay-10 firmware. WebRelay-10 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.
  • Page 82 Appendix B: Installing New Firmware WebRelay-10 Users Manual downloaded from the ControlByWeb™ web site. Device Upgrade Procedure Carefully follow the following steps to put the WebRelay-10 into bootloader mode and perform the upgrade: 1. Remove DC power to WebRelay-10. 2. Using a small, non-conductive tool, press and hold the reset button.. 3.

  • Page 83: Appendix C: Accessing Webrelay-10Tm Over The Internet

    WebRelay-10 Users Manual Appendix C: Accessing WebRelay-10TM Over the Internet Appendix C: Accessing WebRelay-10 Over the Internet WebRelay-10 can be monitored and/or controlled from a remote location over the Internet. Once WebRelay-10 can be accessed on the local network, almost all of the settings required to provide remote access are in the router and not in WebRelay-10.
  • Page 84 Appendix C: Accessing WebRelay-10TM Over the Internet WebRelay-10 Users Manual Figure Appendix C.1 - Local Area Network A Simple LAN connected to the Internet The LAN in the example above can be connected to the Internet by adding a router and an Internet connection.
  • Page 85 WebRelay-10 Users Manual Appendix C: Accessing WebRelay-10TM Over the Internet way, all devices on the LAN share a single public IP address. This is called Network Address Translation (NAT). Port Forwarding The router can be configured to allow outside access to WebRelay-10 and WebRelay™. All requests from the Internet to any device on the local network must use the public IP address ( 266.70.164.97).
  • Page 86 Appendix C: Accessing WebRelay-10TM Over the Internet WebRelay-10 Users Manual Figure Appendix C.3- Port Range Forwarding Accessing Setup Pages After changing ports, the setup pages are accessed on a local network as described below: http://(Local IP Address):(Port Number)/setup.html For example, to access WebRelay-10 at the setup page above, the following command would be used: http://192.168.1.25:8000/setup.html To access the ControlByWeb™...

  • Page 87: Appendix D: Log Files (Webrelay-10 Plus™ Only)

    WebRelay-10 Users Manual Appendix D: Log Files (WebRelay-10 Plus™ only) Appendix D: Log Files (WebRelay-10 Plus™ only) WebRelay-10 Plus™ logs information to two different log files; log.txt and syslog.txt. Both log files are text files and are stored in nonvolatile memory; this data will not be lost due to power failure and is also not cleared when restoring factory defaults.
  • Page 88 Appendix D: Log Files (WebRelay-10 Plus™ only) WebRelay-10 Users Manual The systole file records various system events, which can be used for diagnostics and troubleshooting purposes. File Format: MM/DD/YYYY HH:MM:SS, (category to which message applies): (message) Sample File: 01/02/2010 04:08:13 DEVICE: Power Up. 01/01/2010 00:41:05 DEVICE: Reset factory defaults.
  • Page 89 WebRelay-10 Users Manual Appendix D: Log Files (WebRelay-10 Plus™ only) This file is read by requesting the syslog.txt file. For example, using the default IP address the following command would be used: http://192.168.1.2/syslog.txt Note: The setup user name and password are required to access this file. If the TCP port has been changed (not port 80), the port will be required to read the file.

  • Page 90: Appendix E: External Server And Remote Services

    Appendix E: External Server and Remote Services WebRelay-10 Users Manual Appendix E: External Server and Remote Services Note: The following methods are supported by WebRelay-10; however, Xytronix Research & Design, Inc. does not provide or support custom third party applications, or external web servers. Accessing WebRelay-10 with Custom Software or Third Party Applications Custom applications can send commands to WebRelay-10 for monitoring and control.
  • Page 91 WebRelay-10 Users Manual Appendix E: External Server and Remote Services network installation of WebRelay-10 very simple, and since no incoming ports need to be opened in the router, security is not compromised. See section 2.4.3 Advanced Network Tab for more information. WebRelay-10 can be configured to establish a connection when triggered by an event, such as a relay state changing.

  • Page 92: Appendix F: Snmp Requests, Objects And Community Strings

    Appendix F: SNMP Requests, Objects and Community Strings WebRelay-10 Users Manual Appendix F: SNMP Requests, Objects and Community Strings Relay states, input states, some simple network parameters, and temperature/humidity measured by WebRelay-10 can be retrieved using Simple Network Management Protocol (SNMP). The states of the relays can be changed through SNMP requests.
  • Page 93 WebRelay-10 Users Manual Appendix F: SNMP Requests, Objects and Community Strings Object Response Set Value web10.webrelay_ten_relayOne.0 Value: 0 or 1 0 – OFF, 1 – ON, 2 – Pulse web10.webrelay_ten_sensorTwo.0 Value: 0 or 1 0 – OFF, 1 – ON, 2 – Pulse web10.webrelay_ten_relayThree.0 Value: 0 or 1 0 –...
  • Page 94 Appendix F: SNMP Requests, Objects and Community Strings WebRelay-10 Users Manual the temperature boundaries are crossed. See 2.3.9 Sensor Tab for more information on configuring the sensor alarms. Object Description Value web10.65 Sensor one alarm. x.x (Decimal temperature or humidity.) web10.66 Sensor two alarm.

  • Page 95: Appendix G: Basic Scripts

    WebRelay-10 Users Manual Appendix G: BASIC Scripts Appendix G: BASIC Scripts BASIC (Beginners All-purpose Symbolic Instruction Code) is a computer programming language that has been in use for many years. The WebRelay-10 has an integrated BASIC interpreter for simple BASIC scripts. This provides a great deal of flexibility by allowing users to customize basic functions of the unit.
  • Page 96 Appendix G: BASIC Scripts WebRelay-10 Users Manual Supported Statements The following are the statements supported by the ControlByWeb™ BASIC interpreter. The LET statement assigns a variable a value. The format is: LET (variable) = (expression) IF THEN, ELSE, END IF The IF THEN statement tests the truth of a condition.
  • Page 97 WebRelay-10 Users Manual Appendix G: BASIC Scripts EMAIL 'Status email sent to addresses listed under Network tab..or... EMAIL relay2 'Sends state change message to emails setup in Relays tab..or... EMAIL input1 'Input state change message to emails setup in Input tab..or...
  • Page 98 Appendix G: BASIC Scripts WebRelay-10 Users Manual Let b = 5 'variable b will be set to 5 Let d = b + 2 'variable d will be set to 7 Predefined Variables The following are useful predefined variables for the ControlByWeb™ BASIC interpreter. These are useful for accessing internal values and features states.
  • Page 99 WebRelay-10 Users Manual Appendix G: BASIC Scripts Date and Time Variables (WebRelay-10 Plus™ only) The variables 'time' and 'date' are predefined, read only variables that store the current date and time. They can be used to schedule events and activities, such as sending emails, reading temperature, or setting relays.
  • Page 100 Appendix G: BASIC Scripts WebRelay-10 Users Manual Example: If extvar1 = 1 Then Let relay1 = 1 Else Let relay1 = 0 End If Loop Extvar1 can be set and cleared by entering the following requests into a web browser or by configuring on and off buttons to appear on the Control Page for extvar0: http://192.168.1.2/state.xml?extvar1=1 http://192.168.1.2/state.xml?extvar1=0...

  • Page 101: Appendix H: Specifications

    WebRelay-10 Users Manual Appendix H: Specifications Appendix H: Specifications Power Requirements Input Voltage: 9-28 VDC Current: See table below for typical values at 25°C. 10 Mbps Network Speed Power Supply No Relays Energized 5 Relays Energized 10 Relays Energized 9 VDC 114 mA 692 mA 1320 mA...
  • Page 102 Appendix H: Specifications WebRelay-10 Users Manual Accessory Connector (WebRelay-10 Plus™ only) 5-position, removable terminal strip, 3.81 mm terminal spacing (Replacement part number, Phoenix Contact 1803604) Inputs (WebRelay-10 Plus™ only) Number of Inputs: 2 Input Type: Discrete Inputs (connect to dry contacts) Maximum Input Voltage: 5 VDC Minimum Hold Time (high or low): 20ms Counters (WebRelay-10 Plus™...
  • Page 103 WebRelay-10 Users Manual Appendix H: Specifications Nonvolatile Memory - Memory Type: Flash - Function: All user settings are stored in nonvolatile memory. Settings will not be lost when power is disconnected. Physical - Operating Temperature: -40ºC to 65.5ºC (-40ºF to 150ºF) - Size: 9.125in (232mm) wide, 2.423in (62mm) tall, 4.25in (126mm) deep - Weight: 22 oz.

  • Page 104: Appendix I: Warranty

    Appendix I: Warranty WebRelay-10 Users Manual Appendix I: Warranty This Xytronix Research & Design, Inc. product is warrantied against defects in material and workmanship for a period of five years from the date of shipment for products purchased on or after May 1, 2016 (one year for products purchased before May 1, 2016).

  • Page 105: Appendix J: Fcc Statement

    WebRelay-10 Users Manual Appendix J: FCC Statement Appendix J: 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.

  • Page 106: Appendix K: Trademark And Copyright Information

    Appendix K: Trademark and Copyright Information WebRelay-10 Users Manual Appendix K: Trademark and Copyright Information - This document is Copyright ©2005-2015 by Xytronix Research & Design, Inc. All rights reserved. - WebRelay-10™, WebRelay™, ControlByWeb™, and Xytronix Research & Design™ are trademarks of Xytronix Research &...

  • Page 107: Appendix L: Mechanical Information

    WebRelay-10 Users Manual Appendix L: Mechanical Information Appendix L: Mechanical Information Xytronix Research & Design, Inc. page 107...

This manual is also suitable for:

Webrelay-10 plus x-wr-10r12-ip

Table of Contents