Lantronix WiPort NR User Manual
  1. Manuals
  2. Brands
  3. Lantronix Manuals
  4. Server
  5. WiPort NR
  6. User manual

Lantronix WiPort NR User Manual

Embedded device server
Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
WiPort NR
Embedded Device Server
User Guide
Part Number 900-435
Revision D December 2017

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the WiPort NR and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for Lantronix WiPort NR

Summary of Contents for Lantronix WiPort NR

  • Page 1 WiPort NR Embedded Device Server User Guide Part Number 900-435 Revision D December 2017...

  • Page 2: Intellectual Property

    Intellectual Property © 2017 Lantronix, Inc. All rights reserved. No part of the contents of this publication may be transmitted or reproduced in any form or by any means without the written permission of Lantronix. Lantronix and WiPort are registered trademarks of Lantronix, Inc. in the United States and other countries.

  • Page 3: Disclaimer

    Disclaimer This equipment has been tested and found to comply with the limits for a Class B digital device, pursuant to Part 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference in a residential installation.

  • Page 4: Table Of Contents

    IP Address _________________________________________________________ 10 Port Numbers _______________________________________________________ 11 3: Using DeviceInstaller Accessing WiPort NR Embedded Device Server Using DeviceInstaller Utility ________ 12 Viewing the WiPort NR Current Configuration _________________________________ 12 4: Configuration Using Web Manager Accessing WiPort NR Web Manager Using DeviceInstaller Application _____________ 15...
  • Page 5 Contents 5: Configuration via Serial Mode or Telnet Port Accessing Setup Mode ___________________________________________________ 31 Telnet Access _______________________________________________________ 31 Serial Port Access ___________________________________________________ 32 Server Configuration _____________________________________________________ 33 Set the IP Address ___________________________________________________ 33 Set the Gateway IP Address ___________________________________________ 33 Set the Netmask_____________________________________________________ 33 Set DNS Server IP Address ____________________________________________ 34 Change Telnet/Web Manager Password __________________________________ 34...
  • Page 6 Contents TCP Re-transmission Timeout __________________________________________ 52 Alternate MAC Address _______________________________________________ 52 Ethernet Connection Type _____________________________________________ 52 Security Settings ________________________________________________________ 52 Disable SNMP ______________________________________________________ 52 SNMP Community Name ______________________________________________ 52 Disable Telnet Setup _________________________________________________ 52 Disable TFTP Firmware Upgrade _______________________________________ 53 Disable Port 77FE (Hex) ______________________________________________ 53 Disable Web Server __________________________________________________ 53 Disable Web Setup __________________________________________________ 53...

  • Page 7: 1: Using This Guide Purpose And Audience

    This guide provides the information needed to configure, use and update the WiPort® NR embedded device server and is intended for software developers and system integrators who are embedding the WiPort NR module in their designs. Chapter Summary The remaining chapters in this guide include:...

  • Page 8: Additional Documentation

    WiPort NR Evaluation Kit Quick Start Guide - Briefly explains the basics to get  the WiPort NR module up and running. WiPort NR Embedded Device Server Integration Guide - Provides information ...

  • Page 9: 2: Introduction

    It includes an operating system, an embedded Web server, and a full TCP/IP protocol stack. In addition, the WiPort NR module sends email alerts and supports numerous other network communication protocols, including ARP, UDP, TCP, ICMP, Telnet, AutoIP, DHCP, HTTP, SNMP, and SMTP.

  • Page 10: Protocol Support

    The hardware address is also referred to as the Ethernet address or the MAC address. The first three bytes of the Ethernet address are fixed and read 00-20-4A, identifying the unit as a Lantronix product. The fourth, fifth, and sixth bytes are unique numbers assigned to each unit.

  • Page 11: Port Numbers

    2: Introduction Port Numbers Every TCP connection and every UDP datagram is defined by a destination IP address and a port number. For example, a Telnet application commonly uses port number 23. A port number is similar to an extension on a phone system. The unit's serial channel (port) can be associated with a specific TCP/UDP port number.

  • Page 12: 3: Using Deviceinstaller

    2. The list of Lantronix devices available displays. 3. Expand the list of WiPort NR devices by clicking the + symbol next to the WiPort NR icon. Select the WiPort NR unit by clicking on its IP address to view its configuration.
  • Page 13 Non-configurable field. Displays the full version nomenclature of the firmware. Online Status Non-configurable field. Displays the WiPort NR status as online, offline, unreachable (the WiPort NR module is on a different subnet), or busy (the WiPort NR module is currently performing a task). IP Address Non-configurable field.
  • Page 14 3: Using DeviceInstaller Telnet Supported Non-configurable field. Permits Telnet sessions. Displays True. Telnet Port Non-configurable field. Displays the WiPort NR port for telnet sessions. Web Port Non-configurable field. Displays the WiPort NR port for Web Manager configuration. Maximum Baud Rate Non-configurable field.

  • Page 15: 4: Configuration Using Web Manager

    2. Select the WiPort NR unit by clicking on its IP address. 3. In the right window, click the Web Configuration tab. 4. To view the WiPort NR’s Web Manager in the current DeviceInstaller window, click the button in the upper right corner of the DeviceInstaller application.

  • Page 16: Network Configuration

    BOOTP server automatically assigns the IP address from a pool of addresses. DHCP Select Enable to permit Dynamic Host Configuration Protocol (DHCP). DHCP automatically assigns a leased IP address to the WiPort NR unit. WiPort® NR Embedded Device Server User Guide...

  • Page 17: Static Ip Address Configuration

    4: Configuration Using Web Manager Auto-IP The WiPort NR embedded device server generates an IP in the 169.254.x.x address range with a Class B subnet. Select the Enable checkbox to enable this feature. DHCP Host Name Enter the name of the host on the network providing the IP address.

  • Page 18: Server Configuration

    The unit’s server values display upon selecting Server from the main menu. The following sections describe the configurable parameters within the Server configuration menu. Figure 4-3. Server Settings To configure the WiPort NR device server settings: 1. Click Server from the main menu. 2. Configure or modify the following fields: Server Configuration...

  • Page 19: Host List Configuration

    4. On the main menu, click Apply Settings. Host List Configuration The WiPort NR embedded device server scrolls through the host list until it connects to a device listed in the host list table. After a successful connection, the unit stops trying to connect to any others.

  • Page 20: Channel 1 And Channel 2 Configuration

    2. Enter or modify the following fields from the Hostlist Settings window: Retry Settings Retry Counter Enter the value for the number of times the WiPort NR device should attempt to retry connecting to the host list. Retry Timeout Enter the duration (in seconds) the WiPort NR module should abandon attempting a connection to the host list.
  • Page 21 4: Configuration Using Web Manager Figure 4-5. Channel Serial Settings 2. In the available fields, enter the following information: Channel 1 Disable Serial Port Available on Channel 2 settings only. When selected, disables communication through the serial port. Note: Using a telnet session you may enter a baud rate of 00 in channel settings to disable the serial port.
  • Page 22 It indicates the end of transmission. Pack Control Enable Packing Select the checkbox to enable packing on the WiPort NR embedded device server. Two firmware-selectable packing algorithms define how and when packets are sent to the network. The standard algorithm...

  • Page 23: Connection Settings - Tcp

    4: Configuration Using Web Manager Connection Settings - TCP To configure a channel’s TCP settings: 1. From the main menu, click Connection for either Channel 1 or Channel 2 to display the Connection Settings page for the selected channel. 2. In the available fields, enter the following information: Connect Protocol Protocol Select TCP from the pull down menu.
  • Page 24 Telnet Com Port Cntrl This field is available for configuration only when Active Connection is set to None. Select Enable to permit Telnet communication to the WiPort NR unit. Terminal Name This field is available for configuration only when Telnet Mode is set to Enable.

  • Page 25: Connection Settings - Udp

    4: Configuration Using Web Manager Use Hostlist If this option is set to True, the device server scrolls through the host list until it connects to a device listed in the host list table. Once it connects, the unit stops trying to connect to any others.
  • Page 26 4: Configuration Using Web Manager Figure 4-7. UDP Connection Settings Datagram Mode Datagram Type Configures remote IP or network broadcast address and the remote port. Enter 01 for directed or broadcast UDP. Accept Incoming Select Yes to accept incoming UDP datagrams. Endpoint Configuration Local Port Enter the local port number.

  • Page 27: Email Configuration

    Enter the port number on the email server. Domain Name Enter the Email server’s domain name. Unit Name Enter the username used by the WiPort NR embedded device server to send Email messages. Note: Do not use spaces in the name.

  • Page 28: Trigger Configuration

    None. If both the serial sequence and the configurable pins are disabled, the trigger is disabled. To configure the WiPort NR email trigger settings: 1. From the main menu, select Trigger 1, Trigger 2, or Trigger 3 to configure the desired Trigger settings.

  • Page 29: Configurable Pin Settings

    3. Click the OK button when finished. 4. On the main menu, click Apply Settings. Configurable Pin Settings There are 11 configurable hardware pins on the WiPort NR unit. For each pin, configure the pin function, communication direction, and its activity level. For more information, see Configurable Pins on page 57.

  • Page 30: Applying Settings

    WiPort NR device. Applying Factory Defaults Click the Apply Defaults button from the main menu to apply the factory settings to the WiPort NR embedded device server. For a list of the default settings, refer to Default Settings on page 54.

  • Page 31: 5: Configuration Via Serial Mode Or Telnet Port

    Configure the unit so that it can communicate on a network with your serial device. As an alternative to Web Manager, the WiPort NR unit is configurable using a terminal program to access the serial port locally. Using this terminal program to respond to prompts is referred to as the Setup Mode.

  • Page 32: Serial Port Access

    The default serial port settings are 9600 baud, 8 bits, no parity, 1 stop bit, no flow control. 2. Reset the WiPort NR unit by cycling the unit's power (turning the power off and back on). Immediately upon resetting the device, enter three lowercase x characters (xxx).

  • Page 33: Server Configuration

    5: Configuration via Serial Mode or Telnet Port 5. The configuration settings display, followed by the setup menu options: Figure 5-4. Setup Menu Options Change Setup: 0 Server 1 Channel 1 2 Channel 2 3 E-mail 5 Expert 6 Security 7 Defaults 8 Exit without save 9 Save and exit...

  • Page 34: Set Dns Server Ip Address

    5: Configuration via Serial Mode or Telnet Port Table 5-1. Standard IP Network Netmasks Representing Host Bits Network Class Host Bits Netmask 255.0.0.0 255.255.0.0 255.255.255.0 Set DNS Server IP Address The DNS server allows the name of a remote machine to be resolved automatically. The default is N (No), indicating the DNS server address has not been set.

  • Page 35: Channel 1 And Channel 2 Configuration

    5: Configuration via Serial Mode or Telnet Port Numeric DHCP Name: You can change the DHCP name by specifying the last  octet of the IP address. When you use this method, the DHCP name is LTXYY where YY is what you chose for the last octet of the IP address. If the IP address you specify is 0.0.0.12, then the DHCP name is LTX12.

  • Page 36: Flow

    I/F Mode (4C) ? _ Note: RS-422 and RS-485 are available on Channel 2 only if the WiPort NR embedded device server is used with the WiPort NR evaluation board. Otherwise, RS-422 and RS-485 functions are available on only one channel;...

  • Page 37: Port Number

    5: Configuration via Serial Mode or Telnet Port Table 5-6. Flow Control Options Flow Control Option No flow control XON/XOFF flow control Hardware handshake with RTS/CTS lines XON/XOFF pass characters to host Port Number The Port No setting represents the source port number in TCP connections. It is the number that identifies the channel for remote initiating connections.
  • Page 38 5: Configuration via Serial Mode or Telnet Port Connect Mode Option Incoming Connection Never accept incoming Accept with modem_control_in Active Always Accept Response Nothing (quiet) Character response (C=connect, D=disconnect, N=unreachable) Active Startup No active startup With any character With modem_control_in Active With a specific start character Manual connection Autostart...
  • Page 39 5: Configuration via Serial Mode or Telnet Port Response Character Response A single character is transmitted to the serial port when there is a change in connection state: C = connected, D = disconnected, N = host unreachable. This option is overridden when the Active Start Modem Mode or Active Start Host List is in effect.
  • Page 40 5: Configuration via Serial Mode or Telnet Port Command String Result if remote IP is 129.1.2.3 and remote port is 1234 Connects to 129.1.2.5, port 1234 C28.10/12 Connects to 129.1.28.10, port 12 C0.0.0.0/0 Enters Monitor Mode WiPort® NR Embedded Device Server User Guide...
  • Page 41 5: Configuration via Serial Mode or Telnet Port Autostart (Automatic The unit automatically attempts a connection to the remote IP Connection) address and port after booting up. Hostlist If this option is set to True, the device server scrolls through the host list until it connects to the first available device listed in the host list table.
  • Page 42 3. After completing the hostlist, repeat the previous step if necessary to edit the hostlist again. 4. For Retrycounter, enter the number of times the Lantronix unit should try to make a good network connection to a hostlist entry that it has successfully ARPed.
  • Page 43 5: Configuration via Serial Mode or Telnet Port Numeric Response: The unit responds to a command with a numeric response. Table 5-10. Modem Mode Messages Message Meaning Full Verbose Command was executed without error. CONNECT A network connection has been established. NO CARRIER A network connection has been closed.

  • Page 44: Send The Escape Sequence (+++) In Modem Mode

    Send the Escape Sequence (+++) in Modem Mode Send ‘+++’ in Modem Mode (Y) ? _ Disable or enable the WiPort NR embedded device server’s ability to send the escape sequence. The default is Y (Yes) (send the escape sequence).

  • Page 45: Show Ip Address After Ring

    Modem Mode. The default is Y (Yes) (shows the IP address). Auto Increment Source Port Auto increment source port (N) ? _ Y (Yes) auto increment the source port. The WiPort NR embedded device server increments the port number used with each new connection. Remote IP Address This is the destination IP address used with an outgoing connection.

  • Page 46: Flush Mode

    State LED off with connection Disconnect with EOT (^D) (1) The WiPort NR embedded device server sends the "Terminal Type" upon an outgoing connection. (2) A password is required for a connection to the serial port from the network. (3) The TCP connection closes even if the remote site does not acknowledge the disconnection.
  • Page 47 5: Configuration via Serial Mode or Telnet Port Pack Control The packing algorithm defines how and when packets are sent to the network. The standard algorithm is optimized for applications in which the unit is used in a local environment. The alternate packing algorithm minimizes the packet count on the network and is especially useful in applications in a routed Wide Area Network (WAN).

  • Page 48: Disconntime (Inactivity Timeout)

    5: Configuration via Serial Mode or Telnet Port DisConnTime (Inactivity Timeout) Use this parameter to set an inactivity timeout. The unit drops the TCP connection to port 10001/10002* if there is no activity on the serial line before the set time expires. Enter time in the format mm:ss, where m is the number of minutes and s is the number of seconds.

  • Page 49: Mail Server

    The current value is displayed in parentheses. Mail server (0.0.0.0) ? (000) .(000) .(000) .(000) Enter the username used by the WiPort NR embedded device server to send Email Note: messages. The current value is displayed in parentheses.

  • Page 50: Recipient 2

    5: Configuration via Serial Mode or Telnet Port Recipient 2 Enter the full Email address of the trigger email recipient. The current value is displayed in parentheses. Recipient 2 () ? _ Trigger 1 A trigger event occurs when the unit receives the specified trigger input because of a specified combination of conditions on the configurable pins.

  • Page 51: Expert Settings

    ARP Cache timeout in s (1s - 600s) : (600) ? CPU Performance Select the WiPort NR performance mode. Higher performance settings require more energy. Low is 26 Mhz, Regular is 48 Mhz, High is 88 Mhz. The default is Regular. CPU performance (0=Regular, 1=Low, 2=High):...

  • Page 52: Tcp Re-Transmission Timeout

    This feature allows the configuration of the desired TCP re-transmission timeout value. If the ACK is not received for a packet sent from the WiPort NR unit, then the unit will retransmit the data. The valid range is 500-4000 msec with 500 msec as default.

  • Page 53: Disable Tftp Firmware Upgrade

    Note: Configuring encryption should be done through a local connection to the serial port of the WiPort NR device server, or via a secured network connection. Initial configuration information including the encryption key is sent in clear text over the network.

  • Page 54: Enable Enhanced Password

    Enable Enhanced Password (N) ? Disable Port 77F0 (Hex) Port 77F0 allows a custom application to query or set the eleven WiPort NR configurable pins when they are functioning as general purpose I/O (GPIO). Disable this capability, if desired, for security purposes.

  • Page 55: Channel 1 Configuration

    5: Configuration via Serial Mode or Telnet Port Channel 1 Configuration Baudrate 9600 I/F Mode 4C (1 stop bit, no parity, 8 bit, RS-232C, no flow control) Port No 10001 Connect Mode C0 (always accept incoming connection; no active connection startup) Hostlist Retry Counter Hostlist Retry Timeout 250 (msec)

  • Page 56: Security Settings

    5: Configuration via Serial Mode or Telnet Port Ethernet Connection Type 0 (auto negotiate) Security Settings Disable SNMP SNMP Community Name public Disable Telnet Setup Disable TFTP Firmware Update Disable Port 77FEh Disable Web Server Disable Web Setup Disable ECHO ports Enable Encryption Enable Enhanced password Disable Port 77F0h...

  • Page 57: 6: Configurable Pins

    6: Configurable Pins The WiPort NR embedded device server has eleven pins configurable for General Purpose I/O (GPIO). Use these GPIO pins to control devices such as relays, servers, lights, monitor switches, sensors, and even processes such as data transfer.

  • Page 58: Commands

    As you can, see there is no Set functions command. Since the pin’s function depends on the hardware in which the WiPort NR device server is embedded, that configuration is only allowed via 77FE. Settings changed by any of the Set commands are not stored and are lost when the unit is powered down or rebooted.
  • Page 59 6: Configurable Pins Command 11h, Get Directions Send: No parameters Response: 1 parameter Bytes 1-4: Directions Bit X 1 means GPIO X is an output. 0 means it is an input. Command 12h, Get Active Levels Send: No parameters Response: 1 parameter Bytes 1-4: Active levels Bit X...
  • Page 60 Example 1: PC sends command 10h to find out which configurable pins are available as GPIO. PC -> WiPort NR: 10h, 00h, 00h, 00h, 00h, 00h, 00h, 00h, 00h WiPort NR -> PC: 10h, 03h, 02h, 00h, 00h Command details:...
  • Page 61 Example 2: PC sends command 1Bh to change the current states of GPIO 0 and 1 (assuming they are configured as outputs). PC -> WiPort NR: 1Bh, 01h, 02h, 00h, 00h, 01h, 00h, 00h, 00h WiPort NR -> PC: 1Bh, 01h, 00h, 00h, 00h...

  • Page 62: 7: Monitor Mode

    7: Monitor Mode Monitor Mode is a command-line interface used for diagnostic purposes. There are two ways to enter Monitor Mode: locally via the serial port or remotely via the network. Entering Monitor Mode via the Serial Port To enter Monitor Mode locally: 1.
  • Page 63 8 = number of host bits 192.168.0.1 = gateway IP address 10001 = port number of the WiPort NR device 192.168.1.10 = IP address of the DNS Server The WiPort NR device stores the setup and performs a reset. It sends an X before the reset if the command was OK.
  • Page 64 7: Monitor Mode Note: Entering any of the commands listed in Table 7-1 generates one of the following command response codes: Table 7-2. Command Response Codes Response Meaning 0> OK; no error 1> No answer from remote device 2> Cannot reach remote device or no answer 8>...

  • Page 65: 8: Updating Firmware

    DeviceInstaller (the preferred way), via TFTP, or via the serial port. You can also update the unit's internal Web interface (*.COB) via TFTP or DeviceInstaller. Here are typical names for those files. Check the Lantronix web site for the latest versions and release notes.

  • Page 66: Using Tftp: Command Line Interface

    2. From the Tools menu, select Advanced/Recover Firmware. The Recover Firmware window displays. 3. Enter the com port on your PC and the location of the firmware file. The Device Model should indicate WiPort NR. 4. Click OK to download the file. Note: See also Recovering Firmware in the DeviceInstaller User Guide.

  • Page 67: 9: Aes Encryption

    9: AES Encryption AES encryption is standard on WiPort NR embedded device server. A configuration setting is available to enable or disable (default) Rijndael encryption. If you enable encryption, you must select the key length (128, 192, or 256 bits) and enter the encryption key in hexadecimal.

  • Page 68: 10: Troubleshooting

    This chapter discusses how you can diagnose and fix errors quickly without having to contact a dealer or Lantronix. The WiPort NR diagnostic LEDs indicate the unit’s status. It helps to connect a terminal to the serial port while diagnosing an error to view summary messages that may be displayed.

  • Page 69: Problems And Error Messages

    10: Troubleshooting Problems and Error Messages Problem/Message Reason Solution When you issue the ARP –S Your currently logged-in user Have someone from your IT command in Windows, The ARP does not have the right to use department log you in with entry addition failed: 5 message this command on this PC.
  • Page 70 10: Troubleshooting Problem/Message Reason Solution logical subnet. You did not choose the correct subnet mask. The device server is not The most likely reason is the The serial settings for the serial communicating with the serial wrong serial settings were device and the device server must device to which it is attached.
  • Page 71 10: Troubleshooting Problem/Message Reason Solution The device server appears to be If you are sure that the serial port You can check to see whether set up correctly, but you are not setting is correct, then you may there is a socket connection to or communicating with your device not be connecting to the correct from the device server by...

  • Page 72: Technical Support

    10: Troubleshooting Technical Support Lantronix offers many resources to support our customers and products at http://www.lantronix.com/support. For instance, ask a question, find firmware downloads, access the FTP site and search through tutorials, FAQs, bulletins, warranty information, extended support services, and product documentation.

Table of Contents