ST-EG100-E Ethernet Gateway Installation and User Guide Copyright © 2013 SETECH Security & Automation
ST-EG100-E Installation and User Guide Front Matter 1470 Enterprise Parkway Twinsburg, Ohio 44087 USA Phone: 330.940.1469 www.setechautomation.com email: support@setechautomation.com © Copyright 2013. All rights reserved. SETECH Security & Automation copyrights this document and the associated software. Neither this document nor the associated software may be reproduced without the express written consent of SETECH. This document may contain technical inaccuracies and/or typographical errors.
ST-EG100-E Installation and User Guide Front Matter Table of Contents CHAPTER 1 INTRODUCTION ...........................................................................................................................4 1.1. DESCRIPTION ..................................................................................................................................................4 1.2. ELK™ M1XEP™ COMPATIBILITY ..............................................................................................
ST-EG100-E Installation and User Guide Chapter 1 Introduction Introduction 1.1. Description The SETECH™ ST-EG100-E™ advanced Ethernet Gateway provides an Ethernet network connection to the ELK-M1™ Family of Control Panels using TCP/IP protocol for configuration programming (ElkRP2™), web services, remote access via Virtual Keypad, and Enhanced Email Notification (EEN).
ST-EG100-E Installation and User Guide • Diagnostic Logs available via email • Omnistat2™ Humidity and Outside Temp. support • 256 bit AES Encryption and 1024 bit RSA Key • 30% higher performance processor • NIST AES Compliant Encryption/Decryption Engine Introduction 1.3.2. Specifications • Operating Voltage - 12 Volts D.C. from Security Panel or optional Plug-in Power Supply • Current Draw - Approximately 300 mA • Circuit Board Dimensions - 2.25" x 3.
ST-EG100-E Installation and User Guide Introduction 1.5. Conventions The following conventions are used throughout this document: ! WARNING ! CAUTION Information that must be obeyed in order to avoid injury. Information that must be obeyed in order to avoid damage to product or test equipment. NOTE: Information provided to convey important aspects of the procedure, improve reader understanding, or simplify a task. 1.6.
ST-EG100-E Installation and User Guide Introduction Router- A communications device between networks that determines the best path between them for optimal performance. Routers are used in complex networks such as enterprise-wide networks and the Internet. IP Address (Internet Protocol Address) - The address of a computer attached to a TCP/IP network. Every client and server station must have a unique IP address. (Example: 192.168.0.1).
ST-EG100-E Installation and User Guide Introduction are assigned a unique URL. Also known as an Internet address or web address. (Example: http://www.setechautomation.com) WAN (Wide Area Network) - A computer network covering a wide geographical area, involving vast array of computers. The best example of a WAN is the Internet.
ST-EG100-E Installation and User Guide Chapter 2 Installation Installation 2.1. Installing ST-EG100-E Ethernet Gateway 1. Remove power from the M1 Control board before making any connections. 2. Mount the ST-EG100-E to your existing Structured Wiring Box using the two (2) ELK-SWG Circuit Board Guides, or the ELK-SWP3 Multipurpose Adapter Plate, or four (4) ELK-SWNS1 Nylon Standoffs (see Figure 1). The ST-EG100-E should be mounted within 10 feet of the M1 Control. The supplied cable is 16” long.
ST-EG100-E Installation and User Guide Installation NOTE: The baud rate of the Control's serial port must be set to 115,200, which is the factory default. 4. Plug one end of a user-supplied RJ45 CAT 5 network patch cable into the RJ45 network jack on the ST-EG100-E and the other end to your Ethernet network switch or router. 5. Plug the included SETECH ST-12VPC power cable into the DC power connector on the ST-EG100-E. The center pin of the DC power barrel connector is positive.
ST-EG100-E Installation and User Guide Chapter 3 Configuration Configuration 3.1. Background The ST-EG100-E requires the M1 Family of controls firmware version to be 4.3.0 or later. Configuration of the ST-EG100-E is accomplished using the ElkRP2 software version 1.5.0 or later. Prior to configuration, update to the latest version of the ElkRP2 software, available from the M1 Dealer Website (www.elkproducts.com).
ST-EG100-E Installation and User Guide Configuration If no device is listed, activate the Search button to repeat search process. If a device is still not listed, verify hardware was properly installed and enrolled per Section 2.1. Figure 2 – ElkRP2 Find Results 4. Verify the listed MAC address for the device matches the MAC address printed on the label on top of the RJ45 connector on the ST-EG100-E (see Figure 3). If not, repeat the Find/Search function described in step 3.
ST-EG100-E Installation and User Guide Configuration If successful, the system displays at the lower right corner of the ElkRP2 window. ElkRP2 is now connected to your ELK M1 Control. 9. In the Account Details panel, activate the M1XEP Setup button located at the lower right corner of the panel. The system displays the M1XEP Setup window with the Introduction tab selected. 10. Activate the TCP/IP Settings tab.
ST-EG100-E Installation and User Guide Configuration between 1024 and 49151, with the recommended (default) being 2101. For security reasons, this port should not be mapped outside the local network. If the port is not needed, disable by deselecting Enable Non-Secure Port. 14. ElkRP2 and some third party devices use a SSL or secure port for encrypted communications. Enter the appropriate value for the secure port number in the field immediately below (see Figure 4).
ST-EG100-E Installation and User Guide Configuration Figure 6 - Reboot Required Confirmation Dialog Box 17. Activate OK button and the system displays the Reboot M1XEP dialog box (see Figure 7). Figure 7 - Reboot M1XEP Dialog Box 18. Activate Yes button to reboot the ST-EG100-E to apply the changes. Reboot takes up to 2 minutes to complete, and a connection can not be re-established with the ST-EG100-E until reboot is complete.
ST-EG100-E Installation and User Guide Configuration 3.4. Optional Configuration Using ElkRP2 3.4.1. Setup of User Names & Passwords If you will be remotely connecting to the M1 Control via a web browser (Virtual Keypad), it is REQUIRED that you assign at least one user names with passwords to protect against unauthorized access to the M1 Control from the Web Brower.
ST-EG100-E Installation and User Guide Configuration each email address is 48 characters and each corresponding Message may be up to 255 characters. To enter an email address, left-click in the Email Address cell and enter the email address. 8. Left-click in the adjacent Message cell and enter the message to be sent to the email address. If a specific set of Rules criteria that was defined using the Whenever/And/Then rules programming of the ElkRP2 is met, the message is generated and distributed.
ST-EG100-E Installation and User Guide Keyword {EMAIL_ALSO=recipients} Examples Keyword {EMAIL_SUBJECT=text} Example Keyword {DEVICE_NAME} Example Keyword {EMAIL_ID} Example Keyword {ZONE_STATUS} Keyword {ZONE_ALARM} Keyword {AREA_ARMING_STATUS} Keyword {DIAGNOSTIC_LOG] Configuration Alternate Keyword Description Add comma separated list of email addresses {EA=recipients} as additional recipients for the email message. {EMAIL_ALSO=jdoe@example.com,johnd@abc.com} {EA=jdoe@example.com,johnd@abc.
ST-EG100-E Installation and User Guide Configuration Message Example The following is an example of a complex email message set up in the ElkRP2, M1XEP Setup window for a Device Named “ST-EG100-E” with Email Address for Message 1 of “test@home.com. The “FROM” email address defined in M1XEP Setup is EG100E@home.com. Message Definition {ES=[{DEVICE_NAME}] Custom Subject Test for Email {EI}}A test email for multiple recipients and custom subject, with embedded reports for {DEVICE_NAME}.
ST-EG100-E Installation and User Guide Configuration Resulting Email Email Header: From: EG100E@home.com To: test@home.com; test2@home.com Subject: [ST-EG100-E] Custom Subject Test for Email 1 Message Body: A test email for multiple recipients and custom subject, with embedded reports for STEG100-E Firmware. Zone Status Report Zone State 1. Front House Door Short 2. Utility Room Open Door 4. Garage Rear Door Short Status Normal Violated Normal Zone Alarm Report Zone 2.
ST-EG100-E Installation and User Guide • Configuration ChangeIP www.changeip.com Any DDNS provider that adheres to the standard protocol used by these DDNS servers would work. Select a DDNS provider and visit their website to sign up for a free account. The free accounts they offer are basic, but sufficient for accessing the ST-EG100-E from the Internet. For additional fees, each provider has “extras” such as letting you select a fully custom URL, email services, etc.
ST-EG100-E Installation and User Guide Configuration an abuse of their service to force an update too often, but they will allow forced updates every thirty days. 3.4.4. Time Server The ST-EG100-E can connect daily to a Time Server on the Internet to synchronize the M1’s or EZ8’s clock. This keeps the control’s clock to within a second of universal standard time. To enable this feature, click the Time Server tab on the M1XEP Setup window in ElkRP2.
ST-EG100-E Installation and User Guide Configuration • The filter criteria consists of zone references by zone numbers and/or zone status values by name. • Zone numbers may be specified as comma separated individual numbers or ranges. • Ranges are specified as a starting number and ending number separated by a '-' (dash). • Zones are numbered from 1 to 208. A zone number value or range must be specified. For all zones, use 1-208.
ST-EG100-E Installation and User Guide Configuration The table below lists the ports used by the Elk M1XEP that should be port forwarded through the router. Port 2601 Use Routing Encrypted communications port. Configurable by installer. Route outside to connect with ElkRP2 and web TCP browser through Internet/WAN.
ST-EG100-E Installation and User Guide Chapter 4 Virtual Keypad Virtual Keypad 4.1. Virtual Keypad Access To access the Virtual Keypad Locally (on the same network), simply enter the IP Address for the ST-EG100-E located in the System URL/IP field on the Account Details page of ElkRP2, Example http://192.168.1.15. By default, this entry is routed to port 80, therefore, explicitly specifying port 80 is not required.
ST-EG100-E Installation and User Guide Virtual Keypad Figure 9 - User Code Entry The only valid characters are the number 0 through 9. All other entries are to be ignored. The login process is initiated by the Connect button or pressing Enter. On failure, a message is displayed that indicates a general failure, and the entered user code must be re-entered. 4.4.
ST-EG100-E Installation and User Guide Virtual Keypad Area Menu - Presents a list of defined areas. Displayed status and all security related functions are directed to the currently selected area. Keypad Menu - Presents a list of keypads assigned to the selected area. Virtual Keypad button functionality is configured for the specified keypad. Arming Status LEDs • Armed – Displays solid red when the system is in an armed state. • Ready - Displays solid green when the system is ready to be armed.
ST-EG100-E Installation and User Guide • Virtual Keypad Bypass - Opens a dialog to allow the user to bypass a zone. Zones may only be bypassed when the system is not armed. All Bypassed zones are cleared once the system is disarmed. The Bypass button will be illuminated when any zone is bypassed. Activating the checkbox for each respective zone and clicking on “OK” will toggle its bypass state. o Ignore - Zone is currently being monitored. Activating checkbox will place the zone in “bypass” mode.
ST-EG100-E Installation and User Guide Virtual Keypad • More... - Allows the user to scroll messages displayed on the first line of the alphanumeric display. This button has no effect if the status consists of a single line. • Function Buttons o F1 thru F6 - Executes the pre-configured function associated with the key. o Exit – Illuminates when the system is ARMED in AWAY Mode. If configured to act as a control within ElkRP2, this button will place the system in “Away” mode.
ST-EG100-E Installation and User Guide Virtual Keypad • ON/OFF Status Button - Shows the current state (on = green, off = grey) of the associated lighting component. Clicking on the indicator will toggle the current state of the component. • Dimmer Slider - Adjusts the brightness of the associated lighting component. This functionality is applicable only to dimmer type components, otherwise, setting to zero will turn off the component and any non-zero value will turn the component on.
ST-EG100-E Installation and User Guide Virtual Keypad The valid modes for the thermostat operation are thermostat dependent, however, typically, they are “Off”, “Heat”, “Cool”, “Auto”, and “Emergency Heat”. The valid modes for the fan are “Off”, “On”, and “Auto”. Note: the fan “Off” state is only valid if the thermostat mode is “Off”. 4.4.3.1. Thermostats • Thermostats - Presents a list of available thermostats connected to the system.
ST-EG100-E Installation and User Guide Virtual Keypad ¾ Auto - Maintains the ambient temperature between the heating and cooling setpoints. ¾ Emergency Heat - Forces use of heating coils on heat pump furnaces. This mode has no effect for non-heat pump units. • Fan - Controls the blower operation. ¾ Auto - Fan is cycled on/off based on the operation mode and setpoints. ¾ On - Fan runs continuously.
ST-EG100-E Installation and User Guide Virtual Keypad Shows the reported temperature of available temperature probes. A value of -- indicates the zone is configured as a thermometer but isn’t reporting a valid value. 4.4.3.3. Keypads Shows the ambient temperature of all keypads. As with temperature probes, invalid values (keypads not equipped with temperature probes) will be displayed as double dashes. 4.4.4.
ST-EG100-E Installation and User Guide Virtual Keypad Displays a list of system defined macros. Macros are defined using the ELK configuration tool and can be used to automate operations (e.g. set all lights to a specific level). Clicking on the status LED requests the task be activated and at that time the LED will turn green. Once the request has been acknowledged, the LED will return to its original state. 4.4.5.
ST-EG100-E Installation and User Guide Virtual Keypad • Status Button - Shows the current state (on = green, off = grey) of the selected output. If no output is selected, the label next to the Status Button will be blank. Clicking on the Status Button causes the output state to be toggled. • Turn On - Requests the selected output be turned on for the specified amount of time. • Show Outputs > 64 - Controls whether or not the upper group of un-named outputs are shown.
ST-EG100-E Installation and User Guide Virtual Keypad 4.4.6. Tools Page 4.4.6.1. Email The Email page is used to expand the email recipient list found within ElkRP2. By specifying a “alias” label matching the Group Name, a single Message may be sent to multiple email recipients. • Group Name - An alias used to expand the “Email Address” column in the Elk RP2 - M1EXP Setup dialog.
ST-EG100-E Installation and User Guide Virtual Keypad • Delete - Opens the “Confirm Delete” dialog window for the currently selected entry. • Edit - Opens the “Edit Group” dialog window for the currently selected entry. • Save - Stores the current alias table on the Ethernet module server.
ST-EG100-E Installation and User Guide 4.4.6.2. Virtual Keypad Log Displays the contents of the ELKM1 event log. • ID - Index into the system log table (maximum of 512 log entries). • Date - Date/time the system event was recorded. • Area - Area in which the event occurred. • Event - Brief description of the system event followed by the event and “extended data” codes in brackets (refer to ELK documentation for more detailed information).
ST-EG100-E Installation and User Guide 4.4.6.3. Virtual Keypad License Allows the user to enter a license key. By default, if no license key has been installed on the Ethernet module web server, the server will generate a 15 day temporary license.
ST-EG100-E Installation and User Guide Maintenance & Troubleshooting Chapter 5 Maintenance & Troubleshooting 5.1. Firmware Installation If you are notified of a new firmware release, you can obtain the file and update the SETECH ST-EG100-E Ethernet Gateway. NOTE: To be notified when a firmware update is available, you must have setup a user account on the setechautomation.com website at the time you purchased ST-EG100-E Ethernet Gateway. 1.
ST-EG100-E Installation and User Guide Maintenance & Troubleshooting Figure 11 - SETECH Updater Discovery Window 6. Left-click to highlight the Ethernet board to update, and activate the Select button. NOTE: For most security systems, only a single Ethernet board is listed. 7. Activate the File… button and browse to select the firmware binary file to install. The binary file includes the last 6 characters of the MAC address of the Ethernet hardware.
ST-EG100-E Installation and User Guide Maintenance & Troubleshooting 10. Activate Exit button to close the SETECH Updater window. 5.2. Troubleshooting Symptom ElkRP2 cannot "Find" the ST-EG100-E Cause Resolution Verify the ST-EG100-E is powered up and connected to the M1 Control. Wait 2 minutes after powering up the STEG100-E for the initialization process to complete before ElkRP2 can "Find" the STEG100-E. Network cable disconnected.
ST-EG100-E Installation and User Guide Symptom Maintenance & Troubleshooting Cause Resolution Using ElkRP2, click on M1XEP setup, then click "Find" to verify IP address. Highlight the ST-EG100-E and click "Use Selected" If the ST-EG100-E does not appear on the find screen, refer to the troubleshooting steps above. If there is a router/firewall between the PC and STEG100-E, it must port forward port 2601. Cannot connect with ElkRP2 via Local Network Encrypted communications port 2601 not configured.
ST-EG100-E Installation and User Guide Symptom Maintenance & Troubleshooting Cause Resolution correctly on the TCP/IP tab of the M1XEP setup and that the DHCP configuration is correct for automatically obtaining the DNS information. Verify the Rule to send email is written correctly. Verify that ElkRP2 is disconnected when the triggering event occurs. Ethernet Trouble SETECH Security & Automation 96-300001 Verify the ST-EG100-E is connected to the M1 and enrolled.
