GridRouter™ User Guide SmartSynch GridRouter CWZ User Guide Version P01 Deleted: 5 Deleted: Copyright© 2012 SmartSynch™, Inc. All rights reserved.
GridRouter™ User Guide No part of this documentation may be reproduced transmitted, processed, or recorded by any means or form, or be released to any third party without the express written consent of SmartSynch, Inc. Trademarks SmartSynch™, SmartSynch logo, and GridRouter are trademarks or registered trademarks of SmartSynch, Inc. All other companies, brands, and product names listed herein are trademarks or registered trademarks of their respective holders. Document Revisions SmartSynch, Inc.
GridRouter™ User Guide Table of Contents 1 ABOUT THIS GUIDE ........................................................................................................................................5 1.1 CONTACTING SMARTSYNCH...........................................................................................................................5 1.1.1 Technical Support..................................................................................................................................5 1.1.
GridRouter™ User Guide 9 APPENDIX B: SNMP TRAPS .........................................................................................................................58 10 APPENDIX C: REQUIREMENTS AND COMPLIANCE............................................................................59 10.1 10.2 10.3 10.4 10.5 10.6 FCC GRANT STATEMENT .............................................................................................................................59 COMPLIANCE STATEMENT (PART 15.19) .
GridRouter™ User Guide 1 About This Guide This document is a manual designed to help guide you through the testing, installation and activation of your GridRouter. 1.1 Contacting SmartSynch 1.1.1 Technical Support SmartSynch’s technical support staff is ready to answer your technical questions. Contact your technical support representative for information about the latest SmartSynch products, upgrade options, and more.
GridRouter™ User Guide 2 Getting Started Please review the reference documentation before you begin the installation and use of the supporting software. 2.1 Operations The GridRouter is a system that provides flexibility by implementing a card system that uses Field Replaceable Units (FRUs) to implement a variety of network solutions that can be replaced as technology changes. Wide Area Network (WAN) cards allow for a link to the Internet and ultimately to the back office.
GridRouter™ User Guide 3 Product Overview 3.1 Unit Information 3.1.1 Serial Number The unit serial number can be found using several different methods. It can be found on the Web Interface in the top right hand corner as “Host”. The number will be in the form of “1234f56789” with an “sgr” prefix, where the numbers can be any digit. If the Web Interface is not accessible, the serial number can also be obtained from a label on the main system board.
GridRouter™ User Guide 3.1.4 Sales Order Number The sales order number can be found in the ship file included with the unit. The ship file should have been provided either in paper form with the GridRouter package, or as an email attachment. If command line access to the GridRouter is easily obtained, the sales order number can be found by executing “fw_printenv dir”. Refer to the Advanced User Guide for more information on command line access.
FRU4LAN FRU2LAN FRU2PAN FRU1LAN FRU1PAN FRU4PAN FRU3LAN FRU2WAN FRU1WAN FRU3PAN FRU3WAN Eth2 Eth1 UART2 State DDNS UART3 3.2 LED Array FRU4WAN GridRouter™ User Guide Figure 3-1: LED Array 3.2.1 Generic LEDs State (Green/Red/Orange) • Solid orange for low-level bootup (approx. 60 seconds) • Blinking orange for high-level bootup (approx.
GridRouter™ User Guide 3.2.2 Device Specific FRU LEDs Sierra Wireless MC5727 / MC8790 cellular modem • WAN LED will blink green when connected or attempting to connect to a tower. • WAN LED will be solid green when powered on and disconnected from a tower. Lite-On WN6601A Wi-Fi • LAN LED will be solid green when the interface has enabled. SmartSynch 802.15.4 Zigbee Endpoint • LAN LED will blink green when serial communication occurs. • PAN LED will blink green when searching for a network.
GridRouter™ User Guide 3.3 Ports & Switches LED Array Mounting Bracket Reset Button Power Switch Battery LED Power Plug Ethernet Serial Port 0 Serial Port 1 Figure 3-2: Inside the Basic GridRouter NOTE: Actual Configuration may vary Formatted: Font: Bold Formatted: Normal 3.3.1 Power The GridRouter power board is available in either an AC or DC configuration. For the AC configuration the power plug should be connected to a 120VAC supply.
GridRouter™ User Guide 3.3.2 Ethernet This Ethernet port connects the GridRouter to another Ethernet network device on a wired network. The Eth1 and Eth2 LEDs represent Ethernet Link and Activity respectively. 3.3.3 Serial There are two serial interfaces on the GridRouter and they have RJ45 connectors referred to as Port 0 and Port 1. A mezzanine board attached to the power supply board defines whether the ports are RS232 or RS485. The RS232 board makes both Port 0 and Port 1 communicate via RS232.
GridRouter™ User Guide 3.4 Mounting Options The GridRouter has several different mounting options for a variety of environments. Contact your SmartSynch sales representative for information on available mounting hardware. Note: SmartSynch is not responsible for damages incurred by unsecured mounting hardware.
GridRouter™ User Guide 4 Installing 4.1 Preliminary Inspections The GridRouter is calibrated and tested at the factory and is ready for installation. Before installing and applying power to the product, a quick inspection of the GridRouter is recommended to ensure there is no damage to the GridRouter, which could possibly occur during shipping. Physical damage to the GridRouter indicates potential damage to the inside of the GridRouter.
GridRouter™ User Guide 5 Provisioning the GridRouter The provisioning processes must complete to ensure that the GridRouter can receive remote communication. 5.1 Cellular Modem GSM modems have SIM cards and can be activated and provisioned through the cellular carrier without any interaction from the GridRouter. CDMA modems must be activated by the carrier and then provisioned by the GridRouter, done by dialing a phone number.
GridRouter™ User Guide 6 Configuration 6.1 Explanation of the UCI The UCI (Universal Configuration Interface) is a collection of text files that contains the configuration for the processes on the GridRouter. These settings can be altered through the web-based utility (HTTPS), SSH, and the serial console.
GridRouter™ User Guide 6.2 Web Interface ATTENTION – Windows XP and Internet Explorer users The default GridRouter SSL cipher is set to AES with 128-bit encryption. This level of security is not supported by Internet Explorer (IE) when used on Windows XP. It is recommended to use Firefox or Opera when using Windows XP or to use Windows Vista/7. The GridRouter is capable of being configured (pre-deployment or over SSH) to use a lesser form of encryption so that IE can be used on Windows XP.
GridRouter™ User Guide Figure 6-3: Review Changes The following sections detail each page in the web-based utility. 6.2.1 Info 6.2.1.1 System The first screen that appears is the System information screen. The firmware version, Ethernet MAC address, and username are all displayed here. Figure 6-4: Info > System 6.2.1.2 Devices The Info > Devices screen will display information about the devices directly connected to the system.
GridRouter™ User Guide 6.2.1.3 WAN Statistics The Info > WAN Statistics screen will display information queried from the cellular modem. Typical information found here includes received signal strength (dbm and bars), modem temperature, and network status. This page will display slightly different information depending on the type of modem type; whether HSPA or EVDO.
GridRouter™ User Guide 6.2.2 Status 6.2.2.1 System The Status > System screen shows RAM usage, number of tracked connections, and space available on mounted file systems. Figure 6-7: Status > System RAM Usage This is the current RAM usage. The amount free represents how much the applications have available. Tracked Connections This is the number of connections in the GridRouter conntrack table. Mount Usage This is the amount of space total and used on the file systems mounted on the GridRouter.
GridRouter™ User Guide 6.2.2.2 Processes The System > Processes screen displays all programs and processes currently running on the GridRouter. This page also contains the ability to send signals to a running process which can terminate or alter the behavior of the process. Refreshing must be stopped before a signal can be sent to a process. Sending a signal to a running process can result in a loss of communication or system malfunction.
GridRouter™ User Guide 6.2.2.3 Interfaces The Status > Interfaces screen displays all GridRouter interfaces and information about each one; including MAC address, IP address, maximum transmission unit (MTU), amount of data transmitted and received during the current session, and a list of DNS servers. Figure 6-9: Status > Interfaces 6.2.2.4 DHCP Clients The Status > DHCP Clients screen displays information about the DHCP clients and their leases.
GridRouter™ User Guide The Status > Data Usage screen shows data traffic information for each interface configured in Network > vnStat screen. The information here can be viewed over different periods of time with each button. Figure 6-11: Status > Data Usage Query: Shows today’s connection traffic. Hours: Shows data traffic by hour over the last 24 hours. Days: Shows data traffic by day over the last week. Weeks: Shows data traffic by week over the last month.
GridRouter™ User Guide 6.2.2.6 Netstat The Status > Netstat screen shows networking information for the GridRouter including physical connections, the main routing table, listening ports, and active connections.
GridRouter™ User Guide 6.2.2.7 Hardware The Status > Hardware screen shows the current detected temperature at each FRU slot, temperature limit information per device, and the ambient temperature of the power board. The system voltages at various points on the board are also displayed along with all USB devices connected to the system and any mounted memory devices.
GridRouter™ User Guide 6.2.2.8 Diagnostics The Status > Diagnostics screen contains several tools that may be useful when troubleshooting. Figure 6-14: Status > Diagnostics LED Utilities Allows all LEDs on the GridRouter to be enabled/disabled remotely or set for a specific amount of time. Note: A system event such as a door open event will override the settings here. After the timed command completes or a system event occurs the LEDs will return to the default system state.
GridRouter™ User Guide 6.2.3 Log The GridRouter contains a logging application that all processes can direct their messages towards. These messages can be configured to either be temporarily stored in RAM or persist in nonvolatile memory. Along with storing informational messages, the GridRouter has the ability to capture all data across a given interface to help with troubleshooting connectivity issues.
GridRouter™ User Guide 6.2.3.1 System Settings The Log > System Settings screen provides the ability to view/change the system logging configuration values. Figure 6-15: Log > System Settings Remote Syslog The Syslog remote logging functionality can be enabled by entering a server IP address. Server IP Address: Specifies the IP Address for the remote logs to reside. Server Port: Specifies the port on Server IP Address that has the syslog application listening.
GridRouter™ User Guide Message Priority: Logs messages up to the defined priority. Ring Buffer Size: Specifies the size of space the kernel will reserve for messages in memory. Boot Time Log This log file contains messages that occur on boot-up. Backup Boot Time Messages: Specifies whether your boot time messages will be saved to a file for later reference. Backup File: Specifies the path and name of your boot time log file. Compress Backup: Specifies whether the boot time log file will be compressed. 6.
GridRouter™ User Guide 6.2.3.3 Serial PPP Settings The Log > Serial PPP Settings screen allows the data from a serial PPP session to be logged. Enabling logging on an instance of Serial PPP will make a log available for download. Figure 6-47: Log > Serial PPP Settings Deleted: 1 serppp Log: Specifies whether logging is enabled or disabled. serppp Log File: Specifies the path and name of the log file. 6.2.3.
GridRouter™ User Guide 6.2.3.5 Serial Passthrough Settings The Log > Serial Passthrough Settings screen allows debug logging of serial passthrough to be configured on the system. TCP data, serial data, or both can be logged for each instance of serial passthrough. Both types of data will be logged to the same file. Figure 6-196: Log > Serial Passthrough Settings Log Serial Packets: Specifies whether logging serial data is enabled or disabled.
GridRouter™ User Guide 6.2.3.7 Interface Settings The Log > Interface Settings screen allows debug logging of each interface to be configured on the system. Figure 6-21: Log > Interface Settings Logging Status Displays the current status of the logging processes for each interface. Possible values are “Disabled“,“Enabled“, and “Not Running“. “Not Running“ implies that the logging has been enabled but is stopped.
GridRouter™ User Guide 6.2.3.8 Interface Downloads The Log > Interface Downloads screen provides the ability to download log files that captured all data from a specific interface (wan, lan, etc.). Figure 6-22: Log > Interface Downloads Select Log Format Log Download Format: Specifies the format of all downloads on the page. Packet Capture formatting will create a file that can be opened by Wireshark. Text formatting is in a human readable form that can be opened with any standard text editor.
GridRouter™ User Guide 6.2.4 System 6.2.4.1 Settings The System > Settings screen allows for configuration of GridRouter’s time zone and NTP servers. Figure 6-23: System > Settings Time Settings Timezone: Specifies the time zone for the GridRouter which is mainly used for accurate time stamps in the log files. The drop down box includes all time zones. POSIX TZ String: [Read-only] Specifies the POSIX TZ string for reference. Primary NTP Server: Specifies the URL to the primary NTP server.
GridRouter™ User Guide 6.2.4.2 Access Control The System > Access Control screen allows the administrator to create new users on the system and set up which web interface pages that they may view. Figure 6-74: System > Access Control Deleted: 2 Add New User A generic user can be created in this form. Once created the specific settings can be altered on the subsequent forms. Username: Specifies a user’s name. Password: Specifies the user’s password.
GridRouter™ User Guide Expire inactive: Specifies the number of days after a password expires that an account is disabled. Setting this blank causes the account not to expire after the password expires. Account expiration: Specifies the number of days from epoch that the account will be disabled. Setting this blank causes the account not to expire. Web Interface Permissions A list of all users and all web pages and whether or not a user is allowed to access that page.
GridRouter™ User Guide 6.2.4.4 Packages The System > Packages screen provides the means to view, install, and uninstall packages from the GridRouter. A GridRouter package is computer software packaged in an archive format (*.ipk) to be installed by the package management system (opkg). Each package generally contains a specific application or service. Most GridRouter firmware upgrades will be presented in package form.
GridRouter™ User Guide Available Packages This is a list of packages that are not currently installed on the GridRouter. The “install“ link can be used to install an individual package. 6.2.4.5 SNMP The System > SNMP screen allows for configuration of the GridRouter’s SNMP settings. The GridRouter sends in SNMP traps when certain conditions occur and they are sent to the server specified on this page.
GridRouter™ User Guide 6.2.4.6 Backup & Restore The System > Backup & Restore screen provides the ability to download current GridRouter configuration and upload new configuration. Figure 6-118: System > Backup & Restore Deleted: 2 Backup Configuration The GridRouter’s entire configuration is stored in text files. These files can be compressed into a single file and downloaded here. Name this configuration: Specifies the name of the configuration.
GridRouter™ User Guide 6.2.5 Network 6.2.5.1 Networks The Network > Networks screen allows you to configure the GridRouter’s network settings such as IP address, netmask, and gateway. Figure 6-2912: Network > Networks Network Configuration Specific options for each network interface. Connection Type: Specifies the type of connection; “Disabled“,“DHCP“, or “Static IP“. Type: Select whether the network is bridged or not. MAC Address: Specifies the MAC address of the network.
GridRouter™ User Guide 6.2.5.2 Interfaces The Network > Interfaces screen allows interfaces (i.e. eth0, ppp0, wlan0) to be mapped to networks (i.e. lan, wan, wlan) on the system. By default, eth0 is the lan and ppp0 is the wan.
GridRouter™ User Guide 6.2.5.3 Wi-Fi Formatted: Bullets and Numbering 6.3 The Network > Wi-Fi screen allows a supported 802.11 wireless card to be configured.
GridRouter™ User Guide Enable as Wi-Fi Access Point”. Deleted: Enable as Wi-Fi Access Point Figure 6-141: Network > Interfaces Deleted: 3 Wireless Adapter radio Configuration To change the physical aspects of the wireless card, edit these options. Radio: Turns broadcasting on or off for the device. Channel: Specifies the physical channel the radio is broadcasting on. Wireless Distance: Used to set the transmit power of the device.
GridRouter™ User Guide 6.3.1.1 Firewall The Network > Firewall screen allows you to customize port services for common applications. When users send these types of requests to your network via the Internet, the GridRouter will deny or allow those requests and, if enabled, forward them to the appropriate devices. Before using forwarding you should assign static IP address to the designated devices. Refer to the DHCP page, section 6.2.5.6, for more information on assigning static IP addresses.
GridRouter™ User Guide To Port: Specifies the internal port number. This value should normally be blank so that a 1 to 1 port forward can occur. If, however, a value is specified here then any port(s) listed under “Destination Port” will be redirected to this single port. There is currently not a way to forward ports 1-9 to 21-29 in a single rule. MAC Address Filtering Name: Specifies the name of the firewall rule. MAC Address: Specifies the address to explicitly allow.
GridRouter™ User Guide 6.3.1.3 DHCP The Network > DHCP screen allows you to configure the GridRouter’s Dynamic Host Configuration Protocol (DHCP) server function. The GridRouter can be used as a DHCP server which automatically assigns an IP address to each device on your network. Figure 6-174: Network > DHCP Deleted: 3 LAN DHCP The DHCP settings for devices connected to the GridRouter through the Ethernet connector. DHCP: DHCP is enabled by factory default.
GridRouter™ User Guide Echelon DC – Start IP Address: Specifies the beginning of the IP address range to assign to the DC. Echelon DC – End IP Address: Specifies the end of the IP address range to assign to the DC. Echelon DC – Lease Time: Specifies the number of minutes the DC will be allowed to use that local IP address. Active DHCP Leases A list of the currently active DHCP leases. 6.3.1.4 Hosts The Network > Hosts screen is used to configure the hosts file on the GridRouter.
GridRouter™ User Guide 6.3.1.5 Routes The Network > Routes screen allows you to configure the routing tables on the GridRouter. IP Routing is an umbrella term for the set of protocols that determine the path that data follows to travel across multiple networks from its source to its destination. These protocols enable the GridRouter to build up a forwarding table that correlates the final destinations with the next hop addresses.
GridRouter™ User Guide 6.3.1.6 DynDNS The Network > DynDNS screen allows you to configure the Dynamic Domain Name System (DDNS) feature that allows you to assign a fixed host and domain name to a dynamic Internet IP Address. If the onboard modem has a static IP address then this feature can be disabled. Figure 6-207: Network > DynDNS Deleted: 3 DynDNS Dynamic DNS Update: Default value is “Enable“. Host Name: Specifies the DDNS URL assigned by the DDNS service. Default value is “sgr{serial#}.dyndns.org“.
GridRouter™ User Guide 6.3.1.8 IPSEC Configuration of IPSEC is beyond the scope of this document. Please refer to the GridRouter IPSEC Configuration User Guide for information on how to use and configure the IPSEC functionality of the GridRouter.
GridRouter™ User Guide 6.3.1.9 Serial PPP Serial PPP is an application that acts as a modem emulator and provides a PPP connection to a device connected serially to the GridRouter. Any device that would connect directly to a modem and issue AT commands should be able to connect to the GridRouter and access the same network as the GridRouter (whether public to the Internet or a private network).
GridRouter™ User Guide reverting to the alternate local IP address. Port Forwarding To forward a single port, enter the information on each line for the criteria required. It is important to make the serial PPP firewall changes in this form because the rules are auto named and will change the destination IP address based upon which (primary or secondary) local IP address is currently being used for the PPP session. Name: Specifies the name to give the rule. This is auto generated.
GridRouter™ User Guide 6.3.1.10 Serial Passthrough The Network > Serial Passthough screen allows you to change the configuration for the passthrough application that provides a gateway between a conventional RS232/RS485 serial interface and a TCP socket. Figure 6-231: Network > Serial Passthrough Deleted: 4 Enabled: Default value is “Disable“. Physical: Specifies the physical interface as either “RS232“ or “RS485“.
GridRouter™ User Guide 7 Examples 7.1 Serial Passthrough to a Serial Device The GridRouter can provide network connectivity to a device that only talks over serial (RS232/RS485). A single TCP port can be mapped to a serial port such that all traffic sent or received from either one is passed through to the other. For instance, a software application that traditionally connects to a serial port (i.e. COM5), could connect to an IP address and a TCP port and communicate to the end device.
GridRouter™ User Guide 7.2 Serial Data Concentrator to NES When a serial Echelon Data Concentrator (DC) is connected directly to a modem it dials a number with an AT command (i.e. “ATDT10001”). The modem will respond with “CONNECT” and then the Point-to-Point Protocol (PPP) will be used to establish a direct connection between the DC and the Internet service provider (ISP).
GridRouter™ User Guide 7.3 Ethernet Data Concentrator to NES The Ethernet Data Concentrator (EDC) is slightly different than a “normal” Ethernet device. As with the serial Data Concentrator, the EDC alerts the head-end server when its IP address changes. If the GridRouter has a static WAN address then a static local address can be assigned to the EDC and everything will work like a “normal” Ethernet device.
GridRouter™ User Guide 7.4 Enable as Wi-Fi Access Point The Wi-Fi module must be installed before the GridRouter is powered up. The steps required to set up the GridRouter to act as a Wi-Fi access point are as follows: 1. Visit the web-based utility’s Network > Networks screen. 2. At the bottom of the screen, enter "wlan" in the "Add Network" field and click the "Add Network" button. The network name can be anything you want (i.e. “lan2”, “wifi”, etc.). a. Change the wlan "Connection Type" to "Static IP".
GridRouter™ User Guide 8 Appendix A: Specifications Ports LEDs Main Board Enclosure CPU Board (CPU) Flash DRAM Operating System Capacitor Storage Bank External Antennas WAN Antenna LAN Antenna Electrical, Physical, and Environmental Input Voltage Dimensions (approx.) Weight (approx.) Operating Temp.
GridRouter™ User Guide 9 Appendix B: SNMP Traps The Simple Network Management Protocol (SNMP) is used by network management systems to communicate with the GridRouter. An SNMP TRAP is a message that is initiated by the GridRouter and sent to the network management system, generally to indicate some sort of alarm (e.g. power failure). Refer to the “SNMP_MIB_OID_information” document for more information on GridRouter SNMP traps.
GridRouter™ User Guide 10 Appendix C: Requirements and Compliance The Smart GridRouter is compliant with all applicable Federal Communications Commission (FCC) and Industry Canada (IC) requirements. 10.1 FCC Grant Statement The antennas used for this transmitter must be installed to provide a minimum separation distance of 20 cm from all persons, and must not be co-located or operate in conjunction with any other antenna or transmitter. 10.2 Compliance Statement (Part 15.
GridRouter™ User Guide 10.6 Industry Canada Statement The term “IC” before the certification/registration number only signifies that the Industry Canada technical specifications were met.
