Xytronix Research & Design CONTROL BY WEB XW-111 User Manual

Xytronix Research & Design CONTROL BY WEB XW-111 User Manual

Wireless digital input monitor

Advertisement

Quick Links

Advertisement

Table of Contents
loading

Summary of Contents for Xytronix Research & Design CONTROL BY WEB XW-111

  • Page 2 XW-111™ Wi-Fi Digital Sensor Users Manual XW-111 User Manual Revisions Revision Description Initial release Added Canadian IC declaration Split the combined XW-110 and XW-111 user manual into two separate manuals. Added support for Remote Services, Modbus and other features available beginning with firmware revision 1.03 Added Modbus documentation.
  • Page 3: Section 1: Introduction

    XW-111™ Wi-Fi Digital Sensor Users Manual Introduction Section 1: Introduction The XW-111 is an easy-to-use wireless Wi-Fi digital input monitoring device. The XW-111 monitors and reports the status of switch-closure sensors and alarms. It is ideal for applications where equipment and events must be monitored and Ethernet wiring is not accessible or practical to install.
  • Page 4 Introduction XW-111™ Wi-Fi Digital Sensor Users Manual 1.1.1 Features ➢ Wireless Wi-Fi 802.11 b/g/n ➢ Two digital inputs ➢ Built-in web server for configuration and remote monitoring ➢ Powered from two “AA” batteries or external DC power adapter ➢ Small data packets provide long battery life ➢...
  • Page 5: Section 2: Installation And Setup

    XW-111™ Wi-Fi Digital Sensor Users Manual Installation and Setup Section 2: Installation and Setup 2.1 XW-111 Digital Input Connections The XW-111 can sense the state of up to two switch-closure sensors. Sensors with switch-closure outputs include push buttons, magnetic door alarm switches, micro-switches, or any device which has a relay, switch closure or open collector output.
  • Page 6 Installation and Setup XW-111™ Wi-Fi Digital Sensor Users Manual 2.3 Provisioning After making the sensor connections and providing power, you must provision the XW-111 for use on your wireless network. The goal is to configure the XW-111 such that it can recognize and attach to your Wi-Fi access point.
  • Page 7 XW-111™ Wi-Fi Digital Sensor Users Manual Installation and Setup 2. WPS (Wi-Fi Protected Setup) The WPS method, provides a simple method for attaching the XW-111 to a wireless network without needing to use any setup pages. Although using this method to connect the XW-111 to the network is simple, you will not be able to access the XW-111 web server unless you know the IP address that was assigned by the DHCP sever (router) or unless mDNS services are available on your device.
  • Page 8: Application Examples

    Installation and Setup XW-111™ Wi-Fi Digital Sensor Users Manual 2.4 Application Examples The XW-111 can be configured for many different applications. Applications which require long battery life require careful planning and setup. Several examples are described below: Storage Shed Door Example You want to receive an email whenever someone opens the door to your storage shed.
  • Page 9 XW-111™ Wi-Fi Digital Sensor Users Manual Installation and Setup Navigate to the Inputs tab. Set the Remote Relay Options to Send pulse command when input on. With this setting the relay will pulse for three seconds when the button is pressed. Note: The “Remote command equals input”...
  • Page 10: Section 3: Web Server

    Web Server XW-111™ Wi-Fi Digital Sensor Users Manual Section 3: Web Server The internal web server presents two classes of web pages; Setup pages and Control pages. Setup pages are used by an installer to provision and configure the XW-111. The Control page displays measurement and status information for the user.
  • Page 11 XW-111™ Wi-Fi Digital Sensor Users Manual Web Server Mode The XW-111 operates in two fundamental modes: “Stand-alone” and “Slave.” Depending on which mode you select, the menu tabs will change to reflect the mode's settings. Select “Stand-Alone” if using the XW-111 to simply monitor the inputs and provide input status information to users through its built-in web pages, send email alerts, or control a remote relay.
  • Page 12 Web Server XW-111™ Wi-Fi Digital Sensor Users Manual Part Number This is the full model number of the XW-111 Firmware Revision This is the current product revision of the internal software Serial Number This is the serial number of the XW-111. The serial number is also the MAC address of the unit. Power Supply This field shows if the XW-111 is currently being powered by batteries or the DC wall transformer.
  • Page 13 XW-111™ Wi-Fi Digital Sensor Users Manual Web Server 3.2 WiFi Networks Tab As a Wi-Fi client device, the XW-111 attempts to automatically connect to configured Wi-Fi access points. The settings on this page tab are used to configure this connection. WiFi SETTINGS SSID The SSID (Service Set Identifier) is the name of your Wi-Fi network.
  • Page 14 Web Server XW-111™ Wi-Fi Digital Sensor Users Manual Security Type of authentication used by the access point for connections. Security Key Enter the security key or password for the Wi-Fi network that the XW-111 should connect to. (Hidden when not applicable) IP SETTINGS Use DHCP This option allows DHCP to be enabled or disabled.
  • Page 15: Modbus Server

    XW-111™ Wi-Fi Digital Sensor Users Manual Web Server HTTP SERVER HTTP Server Enabled This option can turn the internal HTTP web server on or off when in stand-alone mode. In slave mode the HTTP web server is automatically disabled. When the web server is on, the XW-111 can be accessed using a web browser or the CBW Mobile app and you can view the current input status.
  • Page 16: Remote Services

    Web Server XW-111™ Wi-Fi Digital Sensor Users Manual REMOTE SERVICES Remote Services Enabled This option enables or disables remote services. If Yes is selected, remote services will be enabled as soon as the Submit button is pressed and the XW-111 will immediately attempt to make a connection with a custom remote server (power cycle not required).
  • Page 17 XW-111™ Wi-Fi Digital Sensor Users Manual Web Server can be set within the range of 1 to 55 minutes. The default setting for this field is 1 minute. Version This field specifies the version of the remote services' protocol to use. Version 1 of the protocol sends the connection string after successfully connecting to the remote server and then periodically per the connection interval specified.
  • Page 18 Web Server XW-111™ Wi-Fi Digital Sensor Users Manual location. This can be used in an environment where a web server on the Internet provides a custom web page to XW-111 and other ControlByWeb products. Users access the XW-111 through the web server rather than communicating directly with it.
  • Page 19: Status Notification

    XW-111™ Wi-Fi Digital Sensor Users Manual Web Server 3.3 Email Tab (STAND-ALONE MODE ONLY) When configured as a Stand-Alone device this tab is visible. When input status alarms occur and an email option is enabled, an email is sent. This page is used to configure the email settings and send notifications to up to three email addresses.
  • Page 20: Email Settings

    Web Server XW-111™ Wi-Fi Digital Sensor Users Manual Email on AC Power Fail When enabled, the XW-111 will send a status email when it detects loss of the +5V input power source. This feature only works if batteries are installed and power to the access point and internet is still available.
  • Page 21 XW-111™ Wi-Fi Digital Sensor Users Manual Web Server • Error sending DATA command: Error sending or error receiving proper response to the SMTP DATA command. This error generally indicates a problem with the SMTP server. • Error sending message body: Error sending or error receiving proper response to sending the content of the email.
  • Page 22 Web Server XW-111™ Wi-Fi Digital Sensor Users Manual 3.4 Remote Master Tab (SLAVE MODE ONLY) When configured as a Slave device this tab is visible. In this low-power mode the XW-111 periodically awakens, makes simple measurements and transmits (pushes) the data to a remote server (usually another ControlByWeb device).
  • Page 23 XW-111™ Wi-Fi Digital Sensor Users Manual Web Server defines the location of a script or page that can accept the data being sent via POST or GET. For example, if the script is located at www.example.com/xw111/logger.php, the path would be xw111/logger.php With POST or GET requests, the information is sent using key-value pairs.
  • Page 24: Password Tab

    Web Server XW-111™ Wi-Fi Digital Sensor Users Manual 3.5 Password Tab The XW-111 has separate passwords for the Setup and Control pages. The passwords can be changed on this page. The username (admin) is fixed and cannot be changed. Setup Password The Setup Password, which is required to access the setup pages, can be modified by entering a new password.
  • Page 25: Date/Time Tab

    XW-111™ Wi-Fi Digital Sensor Users Manual Web Server 3.6 Date/Time Tab XW-111 uses the time of day for enabling or disabling emails at specific time periods of the day and week. The time is stored and displayed in 24-hour time format. The XW-111 does not have an event scheduler.
  • Page 26: Manual Time Configuration

    Web Server XW-111™ Wi-Fi Digital Sensor Users Manual Time Protocol) server. MANUAL TIME CONFIGURATION Date: The current date is entered by first selecting the correct month and year, using the left and right arrows at the top of the calender. The single arrows(< and >) change the month and the double arrows (<< and >>) change the year.
  • Page 27 XW-111™ Wi-Fi Digital Sensor Users Manual Web Server US Servers (http://www.pool.ntp.org/zone/us): 0.us.pool.ntp.org 1.us.pool.ntp.org 2.us.pool.ntp.org 3.us.pool.ntp.org North America (http://www.pool.ntp.org/zone/north-america): 0.north-america.pool.ntp.org 1.north-america.pool.ntp.org 2.north-america.pool.ntp.org 3.north-america.pool.ntp.org Europe (http://www.pool.ntp.org/zone/europe): 0.europe.pool.ntp.org 1.europe.pool.ntp.org 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...
  • Page 28: Daylight Savings

    Web Server XW-111™ Wi-Fi Digital Sensor Users Manual Pacific Standard Time: -8:00 DAYLIGHT SAVINGS Daylight Savings Enabled: In many parts of the United States and in some other countries, the time is shifted forward by one hour during the summer months. This is an effort to conserve energy by making the daylight last longer into the evening hours.
  • Page 29 XW-111™ Wi-Fi Digital Sensor Users Manual Web Server 3.7 Digital Inputs Tab This page determines which actions are to be taken when a digital input changes state. Xytronix Research & Design, Inc. Page 29...
  • Page 30 Web Server XW-111™ Wi-Fi Digital Sensor Users Manual Module Description This text will appear in email messages when email alerts are enabled as well as on the Control Page. This field may be up to 35 characters long. Control Page Refresh Rate Number of seconds between updating the control page with the current status of the device.
  • Page 31 XW-111™ Wi-Fi Digital Sensor Users Manual Web Server Email Schedule Email alerts can be sent in response to changes in the digital inputs. For example, an email can be sent whenever a door sensor detects that a door has been opened.
  • Page 32 Web Server XW-111™ Wi-Fi Digital Sensor Users Manual The input is considered “On” when the switch connected to the input is closed (connected to the Gnd terminal). • No remote relay control - The input has no effect on the remote relay. •...
  • Page 33: Section 4: Control Page

    XW-111™ Wi-Fi Digital Sensor Users Manual Control Page Section 4: Control Page In Stand-Alone mode, and when the internal HTTP Server is enabled, the digital input status can be monitored by using a web browser, the CBW Mobile app, and/or by sending text commands to an XML status/control page.
  • Page 34: Section 5: Modbus/Tcp

    Modbus/TCP XW-111™ Wi-Fi Digital Sensor Users Manual Section 5: Modbus/TCP XW-111 can be controlled and monitored using Modbus/TCP protocol. This provides a standard means of using the XW-111 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.
  • Page 35: Plc Device Addressing

    XW-111™ Wi-Fi Digital Sensor Users Manual Modbus/TCP 5.2 PLC Device Addressing There are generally two schemes for accessing Modbus devices. The first is by specifying the Modbus function code, memory type, and address. The second, sometimes called PLC addressing, requires only the address.
  • Page 36 Modbus/TCP XW-111™ Wi-Fi Digital Sensor Users Manual 5.3 XW-111 Full Address Table The table below gives commonly used function codes, memory types, data sizes, and equivalent PLC addresses for accessing the XW-111. The data size will be the same regardless of the addressing mode. Function Address Data Size...
  • Page 37 XW-111™ Wi-Fi Digital Sensor Users Manual Modbus/TCP 5.4 Read Holding Registers – Modbus Function Code 03 (0x03) The Read Holding Registers function is used for the voltage status. Request 32-bit sensor values are read from 16-bit register pairs. Consequently, senors addresses and registers must be even numbers.
  • Page 38 Modbus/TCP XW-111™ Wi-Fi Digital Sensor Users Manual 5.5 Read Discrete Inputs – Modbus Function Code 02 (0x02) This function returns the state of the digital inputs. Request 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 39: Section 6: Xytronix Compact Data (Xcd) Format

    XW-111™ Wi-Fi Digital Sensor Users Manual Xytronix Compact Data (XCD) Format Section 6: Xytronix Compact Data (XCD) Format The XW-111 sends data contained in a TCP/IP packet. To keep the packets small, and conserve battery power, they are not XML/HTTP. XW-111 Digital Sensor Packet Function Code MAC Address Salt Interval...
  • Page 40: Section 7: Network Discovery

    Network Discovery XW-111™ Wi-Fi Digital Sensor Users Manual Section 7: Network Discovery XW-111 has implemented a network discovery and provisioning protocol to aid in accessing the device. With this protocol, a user may connect the device to a network without knowing the IP address, search and identify the IP address, query basic information and if not yet configured send the desired network and remote services configurations.
  • Page 41: Setup Information

    XW-111™ Wi-Fi Digital Sensor Users Manual Network Discovery 7.2 Setup Information The Setup Information request allows the device to receive IP network, remote services and WiFi network configuration data that it should use. Once this request is properly received, the device will apply the settings and reboot.
  • Page 42 Network Discovery XW-111™ Wi-Fi Digital Sensor Users Manual Successful Response: Header (12 bytes) ASCII String ControlByWeb Message ID (1 byte) Setup successful response 0x04 MAC Address (6 bytes) Binary version 0x00 0x0c 0xc8 0x00 0x00 0x00 Error Response: Header (12 bytes) ASCII String ControlByWeb Message ID (1 byte)
  • Page 43: Appendix A: Specifications

    XW-111™ Wi-Fi Digital Sensor Users Manual Appendix A: Specifications Appendix A: Specifications Wireless Specifications Network Standards:IEEE 802.11b/g/n Frequency Band 2.412 – 2.462 GHz Wi-Fi Security Standards Open, WEP, WPA, WPA2 Network Settings: DHCP or Static Wireless Range Up to 250ft (typical for Wi-Fi devices) depends on environment Antenna: Integral chip antenna, 1.9 dBi.
  • Page 44 Appendix A: Specifications XW-111™ Wi-Fi Digital Sensor Users Manual Email alerts Email Alerts: Configurable Encrypted Email Alerts: Switch Status Alerts: Input on, input off, or input change Environmental Location: Indoor use or NEMA-4 protected location Using Alkaline Batteries: -18ºC to 55ºC (0ºF to 130ºF) Operating Temperature: -40ºC to 65ºC (-40ºF to 150ºF) Storage Temperature:...
  • Page 45: Appendix B: Trademark And Copyright Information

    XW-111™ Wi-Fi Digital Sensor Users Manual Appendix B: Trademark and Copyright Information Appendix B: Trademark and Copyright Information This document is Copyright ©2015-2017 by Xytronix Research & Design, Inc. All rights reserved. XW-111™, WebRelay™, ControlByWeb™, and Xytronix Research & Design™ are trademarks of Xytronix Research &...
  • Page 46: Appendix C: Warranty

    Appendix C: Warranty XW-111™ Wi-Fi Digital Sensor Users Manual Appendix C: 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. During the warranty period, Xytronix Research & Design, Inc.
  • Page 47: Appendix D: Fcc Statement

    XW-111™ Wi-Fi Digital Sensor Users Manual Appendix D: FCC Statement Appendix D: FCC Statement This device complies with Part 15 of the FCC Rules. Operation is subject to the following two conditions: 1. This device may not cause harmful interference. 2.
  • Page 48: Appendix E: Mechanical Dimensions

    Appendix E: Mechanical Dimensions XW-111™ Wi-Fi Digital Sensor Users Manual Appendix E: Mechanical Dimensions Page 48 Xytronix Research & Design, Inc.

This manual is also suitable for:

Control by web xw-111b

Table of Contents