Host RJ-11 IP Gateway User Guide 2120028 Rev 3.
Important Notice Due to the nature of wireless communications, transmission and reception of data can never be guaranteed. Data may be delayed, corrupted (i.e., have errors) or be totally lost.
DIRECT, INDIRECT, SPECIAL, GENERAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES INCLUDING, BUT NOT LIMITED TO, LOSS OF PROFITS OR REVENUE OR ANTICIPATED PROFITS OR REVENUE ARISING OUT OF THE USE OR INABILITY TO USE ANY SIERRA WIRELESS PRODUCT, EVEN IF SIERRA WIRELESS AND/OR ITS AFFILIATES HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES OR THEY ARE FORESEEABLE OR FOR CLAIMS BY ANY THIRD PARTY.
Contact Information Support Desk: Phone: 1-877-231-1144 Hours: 5:00 AM to 5:00 PM Pacific Time, Monday to Friday, except US Holidays E-mail: support@sierrawireless.com Sales Desk: Phone: 1-510-781-4200 1-604-232-1488 Hours: 8:00 AM to 5:00 PM Pacific Time E-mail: MobileandM2Msales@sierrawireless.com Post: Sierra Wireless AirLink Solutions 3159 Corporate Place Hayward, CA USA 94545 Sierra Wireless 13811 Wireless Way Richmond, BC Canada V6V 3A4 Fax: 1-510-781-4299 1-604-231-1109 Web: www.sierrawireless.
Contents Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3 Host RJ-11 IP Gateway Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Quick Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5 Before You Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents Web-based Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Welcome . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Serial Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 Port Services . . . . . . . . . . . . . .
1: Introduction • Host RJ-11 IP Gateway Features Many existing meters, data loggers, RTUʹs, PLCʹs, point‐of‐ sale, and other remote devices only have physical interfaces designed to access the telephone network. They do not have serial or Ethernet ports. They currently use analog cellular or standard phone lines to connect in circuit‐switched mode for data transfer. Analog cellular phone service is being discontinued.
Host RJ-11 IP Gateway routing them to an internal modem attached to the phone port, or generating calls from an internal modem to an attached device. Caution: The Host RJ-11 IP Gateway's RJ-11 phone port should never be connected into the Public Switched Telephone Network (PSTN). This device is designed to emulate the PSTN for other devices. The Host RJ-11 IP Gateway may sustain damage not covered by warranty if it is connected to the Public Switched Telephone Network.
2: Quick Start • Before You Start • Configuring your Raven X for the Host RJ-11 IP Gateway • Configuring the Raven X Configuring the Host RJ‐11 IP Gateway to work with your Sierra Wireless Airlink Raven X and vice‐versa is easy. This chapter covers a basic configuration. For more advanced configuration of your Raven X, refer to the modem’s user guide. The complete configuration options for the Host RJ‐11 IP Gateway are in this guide.
Host RJ-11 IP Gateway Hardware Required • Ethernet Cable ‐ The Host RJ‐11 IP Gateway and Raven X have an auto‐sensing Ethernet port, you can use either a cross‐over cable or a straight‐through Ethernet cable. • Power adapters and a power source ‐ You will need a power adapter and power source for both the Host RJ‐11 IP Gateway and the RavenX (as applicable).
Note: While this guide application note covers installing an RJ-11 IP Gateway with a Raven X, the RJ-11 IP Gateway is also designed to work with the Raven-E and any other Airlink modem with an Ethernet connection, using the same configuration outlined here These steps are just a basic configuration to get you started and allow the Raven X to connect with the Host RJ‐11 IP Gateway. Refer to the user guide for more configuration options for specific environments.
Host RJ-11 IP Gateway Figure 2-1: Wireless Ace : Connexion Connect 3. Select Common > PPP/Ethernet from the menu on the left side of Wireless Ace (under “Groups”). Public Mode Configure the Raven X for Public Mode. Set the *HOSTPRIVMODE to 0. In this mode, the modem assigns the Host RJ‐11 IP Gateway the IP address it has received from your cellular provider. This is the default setting for the modem.
1 - Use Private IP 192.168.1.4 192.168.1.3 255.255.255.0 Figure 2-3: Wireless Ace : PPP/Ethernet 5. When you have finished configuring the Ethernet settings, click the Write button on the tool bar of Wireless Ace and wait for the message “Write Successful” to appear in the status bar. Figure 2-4: Wireless Ace : Write 6. Note the IP address given to the modem by your cellular provider. a. Select Status from the menu on the left side of Wireless Ace (under “Groups”).
Host RJ-11 IP Gateway Host RJ-11 IP Gateway Defaults Note: If you are using the defaults for the Host RJ-11 IP Gateway, you can skip this section and connect your Host RJ-11 IP Gateway directly to your Raven X and device and network. • Phone port: 8 data bits, no parity, and 1 stop bit (8N1). • Protocol: American/Bell 212A. • Maximum baud: 2400. • DHCP client: disabled. • IP Address: 192.168.1.3. Configuring the Host RJ-11 IP Gateway 1.
Figure 2-7: Host RJ-11 IP Gateway Interface 3. Select Network Settings from the menu on the left. Figure 2-8: Host RJ-11 IP Gateway:Network Settings DHCP Mode In DHCP Mode, the Host RJ‐11 IP Gateway will receive its IP address from the modem The IPv4 Address and the IPv4 Netmask should be listed as 0.0.0.0. (The current IP address and current netmask listed above the entry boxes is received from the modem in DHCP mode. It is for display only.) Rev 3.
Host RJ-11 IP Gateway Figure 2-9: RJ-11 IP Gateway: Network Interface Settings ) Static IP Mode If the Host RJ‐11 IP Gateway is going to be on a LAN, you many wish to set a static IP address. Use this mode only if you have configured Private Mode for the modem. The default for the Host RJ‐11 IP Gateway is a static IP address of 192.168.1.3. 192.168.1.3 255.255.255.0 Figure 2-10: Host RJ-11 IP Gateway: Network Interface Settings a.
1. Select Serial Settings from the menu on the left. 2. The Serial Settings page allows you to specify the baud rate, protocol, character size, parity, stop bits, and flow control behavior for the RJ‐11 port (Phone). Figure 2-11: Host RJ-11 IP Gateway: Serial Settings For more information on the serial and other settings, refer to page 17. Note: For most configurations, the defaults for the other settings are best.
Host RJ-11 IP Gateway Figure 2-12: Host RJ-11 IP Gateway: Reset/Reboot Click the Reboot button to restart the Host RJ‐11 IP Gateway with the configured settings.
3: Hardware Setup • Connectors and Reset button • Status LEDs Designed for simplicity, the Host RJ‐11 IP Gateway hardware has few complicated parts. Connectors and Reset button The Reset button is recessed. To reset the connection, using an unbent paperclip or other narrow, blunt tip, press and quickly release the reset button. To reset the configuration to the factory default, press and hold the reset button until you see the appropriate alternating light sequence.
Host RJ-11 IP Gateway devices. The Host RJ-11 IP Gateway may sustain damage not covered by warranty if it is connected to the Public Switched Telephone Network. Status LEDs The top panel of the Host RJ‐11 IP Gateway displays the status LEDs. Figure 3-3: Host RJ-11 IP Gateway Top Panel (not to scale) • STATUS ‐ Indicates the overall status of the device Table 3-1: Status - Normal Operation LED Condition 16 Description Blinking Yellow The Host RJ-11 IP Gateway is starting up.
Table 3-2: Status - Resetting the Configuration LED Condition Description Alternating Green/ Red While the Reset button is held in, the status light will begin to blink in this sequence to indicate the Host RJ-11 IP Gateway will shortly restore the factory default condition. If you do not want to restore the factory default, release the button before the sequence changes to Green/Yellow.
Host RJ-11 IP Gateway Table 3-5: Phone LED Condition 18 Description Solid Green The port is open and idle. Blinking Green The port is open, and data is being transmitted or received. When data is being continuously transferred, this LED will blink approximately 2 times per second. Blinking Red Data errors will cause periodic red blinks. Persistent red blinks may imply a configuration problem (incorrect baud rate, parity settings, etc.) Yellow Port is closed. Solid Red Port hardware has failed.
A: Specifications • Physical Dimensions • Connections • Phone and Modem standards • Phone and Modem standards • Environmental Conditions • Optional Mounting Bracket Physical Dimensions • 6.6 inches x 2..5 inches x 1.2 inches (168 mm x 64 mm x 30 mm) • 4.,8 ounces (136 grammes) • External 110 to 240 VAC power supply: +7VDC to +36VDC ‐ 300mA at 12V (3.6W) 1. Phone Port: RJ-11 2. Ethernet Port: RJ-45 auto-sensing 10base-T 3 2 3.
Host RJ-11 IP Gateway Phone and Modem standards • Bell 212A • ITU‐T V.22 • ITU‐T V.22bis • V.22 FastConnect (Hypercom) Environmental Conditions • Operating temperature range: ‐30 to 70°C • Storage temperature range: ‐30 to 70°C • Humidity range: 10% to 90% non‐condensing Optional Mounting Bracket The mounting bracket is designed to “snap” on to the back of the Host RJ‐11 IP Gateway for easy installation.
Figure 1-1: Mounting BracketSupport 100-170-1010 Rev 3.
Host RJ-11 IP Gateway 22 2120028
B: Web Interface • • • • • • • Web-based Interface Network Configuration Security Settings Status and Logs System Log Commands Reset/Reboot The Host RJ‐11 IP Gateway can be configured to handle a variety of devices which need to connect to an RJ‐11 port. Note: For configuration options for your Raven X, refer to the Raven x’s user guide. All user guides are available on the Sierra Wireless website: http://www.sierrawireless.com/support.
Host RJ-11 IP Gateway The web interface for the Host RJ‐11 IP Gateway, by default, has no security. If you made changes to the security configu‐ ration (“Security Settings” on page 24), you will be prompted for a user name and password before the web‐based interface will open. The menu selections for the configuration interface are on the left side of the window.
Figure 2-3: Host RJ-11 IP Gateway: Welcome - Device Server Information • Ethernet Address : MAC Address of the Host RJ‐11 IP Gateway. • IP Address : The current IP Address of the Host RJ‐11 IP Gateway and how the IP address was assigned (in the example, a Raven‐E in Public Mode used DHCP to give the Host RJ‐11 IP Gateway the IP addressed assigned by the cellular network). • IP Netmask : The current subnetmask of the Host RJ‐11 IP Gateway and how the device obtained it.
Host RJ-11 IP Gateway Figure 2-4: Host RJ-11 IP Gateway: Serial Settings • Enabling flow control enables it on both input and output. • The inactivity time‐out shuts down the service on the port if there is no input or output in the specified time‐out period. • With Modem Signal Loopbacks, the Host RJ‐11 IP Gateway eliminates the use of specialized cables required to change signal types and directions by performing the loopback of signal types to other signal types internally.
outgoing raw TCP or telnet connections to remote servers. In addition, the modem emulation feature may be enabled to allow a serial port to mimic a modem interface. • When using the modem service on the port, the phone number will be translated to a host/port pair then a TCP connection will be established to the remote host.
Host RJ-11 IP Gateway • Outgoing Network Connection : Enables an outgoing connection to the specified host. • Outgoing Telnet Connection : Enables an outgoing telnet connection to the specified host. • Modem Service Options : When Modem Service is selected, you may also configure the Source TCP Port. In most cases, the value used for the source port is arbitrary and you can leave this field set to 0 for “any”.
Figure 2-6: Host RJ-11 IP Gateway: Phone Number Translation Passerelle IP RJ-11 : Conversion des numéros de téléphone The Default Translation entry is used if the dialed phone number is not found in the list. (The dial backup number is not used in the Host RJ‐11 IP Gateway.) The phone number table has a number of features to ease initial configuration. When an attached device dials a number that is not in the table, the device server creates a dummy entry in the table.
Host RJ-11 IP Gateway Figure 2-7: Host RJ-11 IP Gateway: Network Tnaslation It is also possible to modify the network protocol traveling through the TCP pipe by using the Protocol Settings page to define the remote hostʹs protocol requirements. The most common use for this functionality is to add SSL encryption to an incoming TCP connection prior to sending it along to the remote host. The Network Translation table is used to define network mappings for TCP pipes.
Figure 2-8: Host RJ-11 IP Gateway: Protocol Settings The hosts are identified by their IP address or Hostname and TCP port. You may also specify wild cards. Specific host names and/or port numbers take precedence over the wild cards. An asterisk for the IP address/hostname (for instance “*:443”) means any other host when connecting on port 443. An asterisk for the port number (for instance “host.peer.com:*”) refers to any other port on that host. And a double asterisk (“*:*”) refers to all other hosts.
Host RJ-11 IP Gateway In one type of configuration, The Host RJ‐11 IP Gateway has been designed to work in conjunction with an AirLink Raven X. The IP address for the Host RJ‐11 IP Gateway and the IP address for the Raven X need to be on the same network. If you need to set a specific IP address for the Raven X and the HostRJ‐11 IP Gateway, you will need to use Private Mode for the Raven X. Setting Private Mode is covered in the Raven‐E User Guide.
To enable TCP keep‐alives on serial‐related network connec‐ tions, enter the total time (in seconds) that you will allow TCP connections to remain idle before resetting them. The first keep‐alive packet will be sent after the connection has been idle for half of this total time. After that, four more TCP keep‐ alive packets will be sent at regular intervals until a TCP response is received from the remote host.
Host RJ-11 IP Gateway Figure 2-10: Host RJ-11 IP Gateway: DNS Settings If the device server is configured to use DHCP, it will try to get DNS configuration information from the DHCP server. You may also manually set up static DNS entries on this page. Having DNS configured allows you to specify names in place of IP addresses in your configuration. The DNS Server IP Addresses are used to specify the addresses of one or more machines that can be used to resolve names to IP addresses.
Figure 2-11: Host RJ-11 IP Gateway: IP Routing If the device server is configured to use DHCP, it will try to get IP configuration information from the DHCP server. You may also manually set up static routes on this page. Each IP route consists of a destination IP address, a netmask, and a gateway IP address. Depending on the netmask, the destination IP can specify one of two route types: Rev 3.0 B 2/29/08 • Host route: This is a route to a specific IP host. The netmask is always 255.255.255.255.
Host RJ-11 IP Gateway The current routing table is also displayed on this page for your reference. Time Settings The Time Settings page allows you to configure NTP or HTTP time‐servers to get the system time from. If you are using SSL for peer verification, the device server must obtain a valid time from an external time‐server to verify the peer. Time is used in the system and other logs. Having the correct time can help to troubleshoot problems or simply to track occurrences of particular events.
If the device server is configured to use DHCP, it will try to get NTP server information from the DHCP server. You may also manually set up the addresses on this page. The NTP service uses UDP port 123. If your device server is behind a firewall you may need to allow accesses to this port through the firewall. Adding or changing the NTP server will trigger the Host RJ‐11 IP Gateway to get the time again. The HTTP server you specify need not be a designated time server – just a reliable server.
Host RJ-11 IP Gateway Figure 2-13: Host RJ-11 IP Gateway: Security Settings 38 • System Password: The Host RJ‐11 IP Gateway’s adminis‐ trative functions can be protected by a system password. By default, no system password is configured. Once a password is set, your web browser will prompt you for the system password whenever you try to access sensitive configuration pages. The browser will ask for a username and password. The username is always “admin”. The password will be what you configured.
Online Update You may configure your device server to make a connection to an update server and obtain updated software or configuration information from the server or send information to the server. Figure 2-14: Host RJ-11 IP Gateway: Online Update -top half of the page Rev 3.
Host RJ-11 IP Gateway To configure updates, first, select the update server to use and the SSL parameters for connecting to it. You may specify both the server name and the path for obtaining the updates. If the server requires HTTP authentication from the device server, specify the username and password to use. You can schedule the updates to happen periodically, or on every startup, or only when manually selected.
Figure 2-16: Host RJ-11 IP Gateway: Online Update - bottom of the page • Test Configuration – check to make sure the settings are right and the server is available. This will contact the server and go through the communication necessary to send and receive the files without actually doing so. • Update Now – contacts the server and sends and updates the files now. • Save Changes – save changes for later. Status and Logs The status and log pages display system and operation infor‐ mation.
Host RJ-11 IP Gateway Figure 2-17: Host RJ-11 IP Gateway: Troubleshooting System Log By default, the device server stores informational and error messages in the system log. You can also configure the device server to record debug trace data in this system log buffer (See “Log Files and Settings”). The log file is displayed with color‐ coding to make it easier to spot specific entries. You can save the System Log to a file to review separately.
Figure 2-18: Host RJ-11 IP Gateway: System Log Port Status The current status of the RJ‐11 port is displayed. Figure 2-19: Host RJ-11 IP Gateway: Port Status The DCD, RTS, CTS, DTR, DSR, and RI columns indicate the status of the modem signals for the RJ‐11 (phone) port. If the modem signal is present (either asserted if it is an outgoing signal, or detected if it is an incoming signal) its name will appear in the corresponding column.
Host RJ-11 IP Gateway Status may not necessarily match the settings you configured until the port is re-opened. Furthermore, some clients (like NativeCOM) can override the configured settings. The Input, Output, Parity Errors, Framing Errors, and Overrun Errors columns are tallies of activity on the port. Under each port row is a field indicating the current TCP connection status on the port. The display will update automatically every few seconds.
Figure 2-20: Host RJ-11 IP Gateway: Log Settings Tracing is generally used for troubleshooting problems. You can enable tracing for low‐level serial events and on system services such as HTTP (the web browser interface), DHCP, SDP (Systech Device Protocol ‐ used by Systech utilities to find Systech device servers on the network). For port tracing, you must select both the port (phone) and the events that you want to trace.
Host RJ-11 IP Gateway Figure 2-21: Host RJ-11 IP Gateway: Emailing Debug Information The SMTP Server Information is the SMTP (mail host) you will be using to send the debug information. You can usually find the SMTP settings in the email client you use. Not all email hosts will allow relaying through their host. Commands The Host RJ‐11 IP Gateway has some built in commands available. Ping You can use the Ping command to test a network connection.
Response from 209.75.217.6: icmp_seq=0, time=10.0 ms Response from 209.75.217.6: icmp_seq=1, time=10.0 ms Response from 209.75.217.6: icmp_seq=2, time=10.0 ms Response from 209.75.217.6: icmp_seq=3, time=10.0 ms Response from 209.75.217.6: icmp_seq=4, time=10.0 ms Response from 209.75.217.6: icmp_seq=5, time=10.0 ms Response from 209.75.217.6: icmp_seq=6, time=10.0 ms Response from 209.75.217.6: icmp_seq=7, time=10.0 ms Response from 209.75.217.6: icmp_seq=8, time=10.0 ms Response from 209.75.217.
Host RJ-11 IP Gateway Figure 2-23: Host RJ-11 IP Gateway: Reset/Reboot You can reset the phone port by selecting the port and pressing the Reset Port(s) button. This will kill whatever service was on the port and reset it back to the current configuration settings. You may reboot the entire device by pressing the Reboot button. This is the equivalent of power cycling the unit.
C: AT Commands • Response Codes • Modem Signal Behavior • Phone Numbers • Port Settings In addition to the web‐based interface, you can use some typed AT Commands with the Host RJ‐11 IP Gateway. To enter AT commands, you need to be connected to the device via telnet or by using the RJ‐11 port as you would a standard analog modem.
Host RJ-11 IP Gateway Command Qn 50 Function Result Codes 0=Enable result codes (default) 1=Supress result codes Sn=mm Sn? Set register to specified value Return current value formatted as 3 digit decimal Vn Result Code Format 0=Numerical result codes 1=Verbose result codes (default) Response OK(0) OK(0) Varies 0 OK Xn Result Code Format 0=“CONNECT” upon entering online data state 1-4=“CONNECT ” upon entering online data state OK(0) Zn Load factory default settings OK(0) &Cn D
Command Function Response &X Any other & command is ignored OK(0) %X Any % command is ignored OK(0) +X Any + command is ignored OK(0) $Xn Any $ command is ignored including 0 or more digits after the command. OK(0) S-Registers S Registers are 1 byte, volatile registers used to store configu‐ ration data. They are reset to the default state whenever modem emulation is enabled, or the ATZ/AT&F command is received. They can be saved to flash memory with the AT&W command.
Host RJ-11 IP Gateway Result Code (ATV1) Numeric (ATV0) Reason ERROR 4 Error in AT command string CONNECT 1200 5 Connected – Serial Port Speed is 1200 baud NO DIALTONE 6 Not Used BUSY 7 Not Used NO ANSWER 8 Not Used CONNECT 2400 10 Connected – Serial Port Speed is 2400 baud CONNECT 4800 11 Connected – Serial Port Speed is 4800 baud CONNECT 9600 12 Connected – Serial Port Speed is 9600 baud CONNECT 14400 13 Connected – Serial Port Speed is 14400 baud Modem Signal Behavior The R
Mode Modem DCD Settings Behavior Command/Data Always on (&C0) DTR is asserted Command/Data Follow connection (&C1) DTR is asserted only when TCP/IP connection is present and has been accepted via ATA or auto-answer. DTR is de-asserted when connection is lost The device server monitors its DCD signal in order to detect changes in the deviceʹs DTR signal. The following behaviors occur on loss of DCD only. .
Host RJ-11 IP Gateway Format Example Notes Fixed format aaabbbcccddd or 192168001001 12 digit IP address, each number is three decimal digits with leading zeroes Optional port number :xxxxx Decimal TCP port number from 0..65535 • If no phone number (IP address) is specified, the Desti‐ nation IP Address configured for the port is used. • If no port number is specified, the Destination TCP Port configured for the port is used.