Web Xpander Installation and Operation Manual 12200 Thatcher Court, Poway, CA 92064 TEL 858-486-8787 FAX 858-486-8789 ONLINEJDS@AOL.COM www.jdstechnologies.com Document Rev 1.
Web Xpander Programming Connector Reset Button 12VDC Power Input RS-232 Output to Controller (Stargate) RS-232 Input from PC Ethernet port to Network Router Stand-offs
Welcome to Web Xpander Web Xpander is a serial (RS-232) to ethernet module with embedded web pages that allow monitoring and control of STARGATE via the internet and/or local area network (for downloading schedules see Appendix E). Web Xpander can also be used with STARGATE-Lite, TimeCommander-Plus, TimeCommander, CommStar and HomeBase controllers.
Mounting to STARGATE-Lite (no Telephone/Voice Board) 3b. Using the supplied two standoffs that have screw holes on both sides, and two of the supplied screws, attach the standoffs to the STARGATE main circuit board in the two holes just behind the row of serial ports as shown in the photo. 4. Place the Web Xpander on top of the standoffs with the network and serial jacks facing the same direction as the STARGATE jacks and attach with two screws as shown in the photo. 5.
3. Connection to a Cable/DSL Router This is the most ideal situation in that it allows you to access your STARGATE via the Web Xpander from your home network as well as anywhere on the internet once you’ve configured both the Web Xpander and your router. In most cases, the router will also act as a DHCP server and provide the initial network settings for the Web Xpander. Network Configuration Every device on a TCP/IP network must have a unique IP address.
Viewing Current Network Settings You can use the “:netinfo=” command to view the current network settings of the Web Xpander using WinEVM. From the MegaController screen, click ASCII and send the command “:netinfo=” (no quotes) out of the controller to COM1. The network settings should appear in the MegaController log window.
If your Web Xpander is connected using network configurations 1 or 2 (above) you may need to manually set the IP address of the PC or the Web Xpander. Manually Configuring Web Xpander Network Settings You can send commands to the Web Xpander via the STARGATE by using the “ASCII” button on the MegaController in WinEVM. 1. 2. 3. 4. 5.
:telnet= :reset= :factory= :netinfo= Sets the port (default = 23) for telnet (Ethernet to Serial) Resets the Web Xpander Sets network values to factory presets (must be followed by :reset=) Displays network settings :telnet=23 :reset= :factory= :netinfo= The Web Xpander must be reset (either with the :reset= command or by pressing the reset button on the Web Xpander circuit board) for these changes to take effect. Web Pages When you access the Web Xpander with a web browser (Internet Explorer 5.
A/V Select Output then single click on the Name to send IR command. SECURITY Select security Command and Partition or Zone then click “Send Command.” HVAC Type in or click Inc/Dec to adjust Set Temperature then click “Set” to apply.
DIGITAL ANALOG RELAY Single click “On” or “Off” to change the status of a relay. FLAG Single click “Set”, “Clear” or “Idle” to change status of a flag. VARIABLE Type in or click Inc/Dec to adjust variable value then click “Load” to apply. Green “Clear” button indicates a value of zero. Red “Load” button indicates a value greater than zero.
TIMER ASCII Click “Send” to issue ASCII data.
MSG LOG TEL LOG
SETTINGS Auto Page Refresh The Lighting, HVAC, X10, Digital, Analog, Relay, Flag, Variable, Timer, History, Msg Log and Tel Log menus each have a drop-down box at the bottom. Selecting a refresh interval from this box will cause the selected page to automatically reload its contents from the Web Xpander. To disable auto-refresh for a given page, select “Manual Refresh” from the list. Each page can have its own refresh interval.
Web Xpander Labeler The Web Xpander Labeler is a Windows utility that reads your device names from WinEVM and imports them into the Web Xpander. To install, run WebXlabel.exe located on the CD-ROM (the latest version is always available on the JDS Technologies web site). After you’ve used this tool to import your custom labels, your defined device names will appear on the web pages.
Appendix A – Web Xpander Commands Command :reset= :factory= :ipaddr= :ipmask= :ipgate= :dns= :dhcp= :smtp= :user= :pass= :webport= :telnet= :time= :daily= :netinfo= :mailto= :mailfrom= :mailsubject= :mailbody= :mailsend= Description Resets the Web Xpander Load factory default values (follow with :reset= to restart with these values) Sets the IP Address Sets the Netmask Sets the Gateway Addr.
:debug= :disable= :status= Enables or disables debug information to be sent back through COM1 to WinEVM Used to disable the Web Xpander during schedule downloads or firmware updates. See Appendix J Enables or disables the Web Xpander maintaining its own internal status of all STARGATE devices. Used for Pocket WebX.
Appendix B – Sending Email with the Web Xpander Sending email with the Web Xpander is accomplished by sending ASCII commands from the controller (i.e. STARGATE) to the Web Xpander’s serial port. The example below demonstrates sending an email when the alarm is disarmed. EVENT: Send Email When Alarm Disarmed If Partition Not ARMED [Partition 1] TRANSITION Then ASCII-Out: ':mailto=mycellphone@yahoo.com' [COM1] ASCII-Out: ':mailfrom=myhouse@home.
Appendix C – Managing a Dynamic Home Internet Address Accessing the Web Xpander from the internet (i.e. outside your home network) requires router specific settings and configuration. Once you’ve properly routed incoming connections on port 80, for example, to the Web Xpander you need to know the IP address of your cable modem or DSL modem to connect to your location from the internet.
Appendix D – Ethernet to Serial Bridge Functionality The Web Xpander provides a method of sending/receiving serial data to/from the STARGATE via the Ethernet port using Telnet. Telnet is a terminal emulation program for TCP/IP networks. A telnet application comes with Microsoft Windows but you can also download other versions from the internet such as MochaSoft Telnet (http://www.mochasoft.dk). The Web Xpander listens for incoming connections on a configurable port.
Appendix E – Downloading WinEVM Schedules over a Network Connection WinEVM has been successfully run over a network connection to the STARGATE using a product called COM/IP, distributed by PC Micro Systems. http://www.pcmicro.com/comip/. This allows downloading of schedules via the internet and/or local area network. COM/IP creates a virtual serial port / modem on your PC that when “dialed” is actually making a connection over the network.
8. ** You must temporarily disable the username/password checking for remote access before connecting. Open the Settings page in your web browser and click the “Start” button next to “5 min Direct Access”. This will disable the username/password prompt for 5 minutes so you can connect with COM/IP and WinEVM. 9. Return to WinEVM and click “Start” in the Dial PC Modem window to connect to the STARGATE via the Web Xpander. 10.
Appendix F – Performing a Firmware Update on the Web Xpander ** Note: This applies only to firmware versions prior to v1.6 July 16, 2003 (See Appendix G for updating firmware versions 1.6 and later) The firmware is the software that runs embedded within the Web Xpander. Periodically, a new version of the firmware may be made available either to address issues found in a prior version or to provide new features and functionality.
10-pin programming connector Properly attached Rabbit Programming Cable Using the Rabbit Field Utility 1. Start the Rabbit Field Utility located on the Start menu in the Web Xpander folder (labeled WebX Firmware Utility) 2. Select Setup, Communications from the main menu 3. Select “Use Serial Connection”, Baud Rate: 115200, and the COM port you have attached the programming cable to. 4. Uncheck both check boxes labeled “Enable Processor Detection” and “Use USB to Serial Converter” 5.
Firmware Utility Communications Options 6. From the main menu, select File, Load Flash Image button next to File Location and locate the firmware you 7. Click the downloaded from the JDS Technologies web site. 8. Click the “OK” button to begin the transfer. Do not do anything else with your computer or switch to another window until the transfer is complete. 9. When the transfer is complete, carefully remove the programming cable from the Web Xpander and press the Reset button located above the battery.
5. Select File, Transfer Web Page(s) from the main menu to transfer the web page(s) into the Web Xpander’s battery backed memory. This step is only necessary one time after a new firmware is loaded. 6. Proceed with transferring your device labels to the Web Xpander as described in the Web Xpander Labeler section of this document.
Appendix G – Firmware Upgrades with the Network Download Utility The Web Xpander Network Download Utility is used to transfer firmware updates to the Web Xpander via the network (i.e. LAN) and is only available on firmware v1.6 July 16, 2003 and later. Firmware updates are provided on the JDS Technologies web site (http://www.jdstechnologies.com) to introduce new features or to fix problems in earlier firmware releases.
Appendix H – Internet Time Synchronization The Web Xpander can be configured to automatically synchronize your STARGATE's internal clock daily via the internet to maintain an accurate time setting. There are several different protocols commonly used for internet time syncing including DAYTIME, TIME, and NTP. See http://www.boulder.nist.gov/timefreq/service/its.htm for a more detailed description of the different protocols. The Web Xpander uses the "DAYTIME" Protocol (RFC-867) over TCP port 13.
Appendix I – Advanced WebXpander URL Commands One method of sending commands via the WebX web server interface is by simulating the functionality of the existing web pages. For example, you can simulate the clicking of "Light A-1 ON" from the lighting page by opening: http://192.168.0.5/mega_x10.cgi?var1=lighting&var2=A&var3=1&var4=On&var5=0 Almost all commands issued through the web pages are visible in the "webxdebug" mode accessible via telnet.
Appendix J – Disabling the Web Xpander for Schedule Downloads and STARGATE Firmware Updates To disable the Web Xpander (prior to downloading), send the ASCII string :disable=on "out of controller COM1." For convenience, add an event to send the ASCII string in response to an X-10 ON command. The MegaController log will display ":disable=on" followed by "Web Xpander Disabled." To re-enable the Web Xpander (after downloading), send the ASCII string :disable=off "out of controller COM1.
Appendix K – Web Xpander Firmware Release History v1.0 26-Nov-2002 - Initial Release v1.1 1-Mar-2003 • • • • • • • • • • • • • • • • • • • • • • Reduced the size of HTML pages by removing spaces and tabs to conserve memory Changed SetDirect.
Example 1: sendcommand.cgi?var1=%23%23%2507&var2=str&var3=%23%230 %23 is the URL-encoded character ‘#’ and %25 is the URL-encoded character ‘%’. Most characters other than numbers and letters must be URL-encoded for transmission via HTTP. Example 1 (above) sends the command ##%07 and waits for the string ##0 Example 2: sendcommand.cgi?var1=%23%23%2520&var2=time&var3=1500 Example 2 sends the command ##%20 (x10 status) and waits 1.5 seconds (1500 ms) for the command to complete.
v1.3c 11-Jun-2003 • Removed sending CR to clear buffer before each command. Fixed problem reading time from TimeCommander+. v1.3d 17-Jun-2003 • Corrected a condition where some X-10 commands were not being shown in the history window v1.4 • 30-Jun-2003 Updated to support new HVAC command format (STARGATE firmware 3.05d) v1.5 • • • • 7-Jul-2003 Switched to new compiler Compressed web pages for storage in internal memory Modified sendcommand.cgi and sendcommand2.
v1.6d 3-Aug-2003 • Modified DHCP routines. WebX was correctly reading IP address but incorrectly reading and storing Gateway and DNS info. • Also read SMTP Mail server via DHCP if provided v1.6e 8-Aug-2003 • Modified DHCP routines to try to solve remaining issues. v1.6f 21-Aug-2003 • Adjusted TCP socket handling to prevent "hung" sockets v1.6g 3-Sep-2003 • Corrected DHCP issue where Gateway was being misread v1.7 • 9-Sep-2003 Added support for Pocket WebX Access and Registration v1.
v1.9b 24-Nov-2003 • Added serial command :debug=on and :debug=off to toggle sending debug information to MegaController of WinEVM (defaults to debug=off) v1.9c • • • 4-Dec-2003 Reduced timeout for Pocket WebX Commands Updated Pocket WebX Registration process Added additional option "num" (used in place of either 'str' or 'time') to sendcommand2.cgi to wait for lines of response ( Used in cases where the Stargate doesn't respond with ##0 ) v1.
