Lantronix WiPort User Manual
Lantronix WiPort User Manual

Lantronix WiPort User Manual

Wireless embedded device server
Hide thumbs Also See for WiPort:
Table of Contents

Advertisement

Quick Links

WiPort™ User Guide
Part Number 900-332
Revision F November 2005

Advertisement

Table of Contents
loading
Need help?

Need help?

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

Questions and answers

Summary of Contents for Lantronix WiPort

  • Page 1 WiPort™ User Guide Part Number 900-332 Revision F November 2005...
  • Page 2: Copyright And Trademark

    Copyright and Trademark © 2005, Lantronix. All rights reserved. No part of the contents of this book may be transmitted or reproduced in any form or by any means without the written permission of Lantronix. Printed in the United States of America.
  • Page 3: Disclaimer And Revisions

    FCC ID can not be used on the final product (including the transmitter) and obtaining a separate FCC authorization. Note 3: Changes or modifications to this device not explicitly approved by Lantronix will void the user's authority to operate this device. WiPort™ User Guide...
  • Page 4: Table Of Contents

    Hardware Address __________________________________________________________11 IP Address_________________________________________________________________12 Port Numbers ______________________________________________________________12 3: Using DeviceInstaller Accessing WiPort using DeviceInstaller _____________________________________13 Viewing the WiPort’s Current Configuration __________________________________13 4: Configuration Using Web-Manager Accessing WiPort Web-Manager using DeviceInstaller__________________________16 Network Configuration ___________________________________________________17 Automatic IP Address Configuration _____________________________________________18 Static IP Address Configuration ________________________________________________19...
  • Page 5 WPA _____________________________________________________________________56 Fixed or Automatic Data Rate__________________________________________________57 Transmission Data Rate ______________________________________________________57 Enable Power Management ___________________________________________________57 Transmission Power Level ____________________________________________________58 Expert Settings ________________________________________________________58 TCP Keepalive Time _________________________________________________________58 ARP Cache Timeout _________________________________________________________58 Enable High Performance_____________________________________________________58 HTTP Port Number __________________________________________________________59 WiPort™ User Guide...
  • Page 6 8: Updating Firmware Obtaining Firmware _____________________________________________________71 Reloading Firmware ____________________________________________________71 Using TFTP: Graphical User Interface ___________________________________________71 Using TFTP: Command Line Interface ___________________________________________72 Recovering the Firmware Using the Serial Port ____________________________________72 9: Troubleshooting Diagnostic LED States___________________________________________________73 Problems and Error Messages ____________________________________________74 WiPort™ User Guide...
  • Page 7 Contents Technical Support ______________________________________________________77 WiPort™ User Guide...
  • Page 8: 1: Using This Guide

    This guide provides the information needed to configure, use and update the WiPort and is intended for software developers and system integrators who are embedding the WiPort in their designs. This User Guide covers WiPort Device Server versions WP2001000-01, WP2002000-01, WP2004000-01 (WiPort-485), and WP2001000G-02 (WiPort-G).
  • Page 9: Additional Documentation

    Using This Guide Additional Documentation The following guides are available on the product CD and the Lantronix web site (www.lantronix.com) Briefly explains the basics to get the WiPort up WiPort Development Kit Quick and running. Start Guide Provides information about the WiPort...
  • Page 10: 2: Introduction

    IEEE 802.11b wireless standard. WiPort allows Original Equipment Manufacturers (OEMs) to add wireless connectivity to their products by incorporating it onto a circuit board. The WiPort functions independently of a PC, providing a fully integrated solution that combines a processor, memory, 802.11b, 802.11g...
  • Page 11: 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 12: Ip Address

    IP Address Every device connected to an IP network must have a unique IP address. This address is used to reference the specific unit. The WiPort is automatically assigned an IP address on DHCP-enabled networks as it is DHCP-enabled by default.
  • Page 13: 3: Using Deviceinstaller

    2. Click on the Wireless folder. The list of Lantronix wireless devices available displays. 3. Expand the list of WiPorts by clicking the + symbol next to the WiPort icon. Select the WiPort unit by clicking on its IP address to view its configuration.
  • Page 14 WiPort. Non-configurable field. Displays the WiPort’s status as online, Online Status offline, unreachable (the WiPort is on a different subnet), or busy (the WiPort is currently performing a task). Non-configurable field. Displays the WiPort’s port for telnet Telnet Port sessions.
  • Page 15 Non-configurable field. WiPort supports wired Ethernet. Supports Wired Ethernet Non-configurable field. WiPort supports HTTP setup. Supports HTTP Setup Non-configurable field. WiPort supports a baud rate of 230K. Supports 230K Baudrate Non-configurable field. WiPort supports email triggers. Supports Email Triggers Non-configurable field. WiPort supports communication via Supports GPIO General Purpose Input Output (GPIO).
  • Page 16: 4: Configuration Using Web-Manager

    3. Click on the Wireless folder. The list of Lantronix wireless devices available displays. 4. Expand the list of WiPorts by clicking the + symbol next to the WiPort icon. 5. Select the WiPort unit by clicking on its IP address.
  • Page 17: Network Configuration

    Figure 4-1. Web-Manager The main menu is displayed in the left side of the Web-Manager window. Note: Alternatively, access the WiPort’s Web-Manager if it is connected to the network by entering its IP address in a web browser. Network Configuration The unit’s network values display upon selecting Network from the main menu.
  • Page 18: Automatic Ip Address Configuration

    Select Enable to permit Dynamic Host Configuration Protocol DHCP (DHCP). DHCP automatically assigns a leased IP address to the WiPort unit. The WiPort generates an IP in the 169.254.x.x address range Auto-IP with a Class B subnet. Select the Disable checkbox to disable this feature.
  • Page 19: Static Ip Address Configuration

    4. Click the OK button when finished. 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 WiPort™ User Guide...
  • Page 20: Host List Configuration

    512 and 1400 bytes. The default is 1400 bytes. Host List Configuration The WiPort 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 21: Channel 1 And Channel 2 Configuration

    Figure 4-4. Hostlist Settings 2. Enter or modify the following fields from the Hostlist Settings window: Retry Settings Enter the value for the number of times the WiPort should Retry Counter attempt to retry connecting to the host list. Enter the duration (in seconds) the WiPort should abandon Retry Timeout attempting a connection to the host list.
  • Page 22 The stop bit follows the data and parity bits in serial Stop Bits communication. It indicates the end of transmission. Pack Control Select the checkbox to enable packing on the WiPort. Enable Packing Two firmware-selectable packing algorithms define how and when packets are sent to the network. The standard algorithm...
  • Page 23: Connection Settings - Tcp

    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 Select TCP from the pull down menu. Protocol WiPort™ User Guide...
  • Page 24 With Any Character: Attempts to connect when any character is received from the serial port. With Active Mdm Ctrl In: Accepts external connection requests only when the modem_control_in input is asserted. With Start Character: Attempts to connect when it WiPort™ User Guide...
  • Page 25 This field is available for configuration only when Active Telnet Mode Connection is set to None. Select Enable to permit Telnet communication to the WiPort unit. This field is available for configuration only when Telnet Mode Terminal Name is set to Enable.
  • Page 26: Connection Settings - Udp

    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 Select UDP from the pull down menu. Protocol WiPort™ User Guide...
  • Page 27: Email Configuration

    The unit sends an Email to multiple recipients when a specific trigger event occurs. There are three separate triggers, based on any combination of the configurable pins when selected as user I/O functions. Optionally, use a two-byte serial string to initiate WiPort™ User Guide...
  • Page 28: Trigger Configuration

    Enter the IP address of the mail server. Server IP Address Enter the Email server’s domain name. Domain Name Enter the username used by the WiPort to send Email Unit Name messages. Recipients Enter the email address designated to receive email Recipient 1: Email notifications.
  • Page 29: Wlan Configuration

    Indicates the time interval in which a new email message is Re-notification Interval sent to the recipient(s) when a single trigger event remains active. WLAN Configuration Without adequate protection, a wireless LAN is susceptible to access by unauthorized users. To configure the WiPort’s WLAN settings: WiPort™ User Guide...
  • Page 30 Configuration Using Web-Manager 1. Select WLAN from the main menu to open the WLAN Settings window. Figure 4-10. WLAN Settings WiPort™ User Guide...
  • Page 31 Select from the pull down menu the radio channel for the Ad Hoc network. The default value is 11. Wireless Network Security As a security measure, enable WEP or WPA on the WiPort. Security By default, wireless security is disabled on WiPort.
  • Page 32: Configurable Pin Settings

    Higher values span a wider range. The default is 18 dBm. Configurable Pin Settings There are 11 configurable hardware pins on the WiPort unit. For each pin, configure the pin function, communication direction, and its activity level. For more information, on page 64.
  • Page 33 Diagnostics LED is lit. chan 1 Indicates channel 2 status. Serial Status LED out, chan 2 Indicates errors and configurations. Diagnostics LED out Allows the external signal to reset the configuration back to Reset to Defaults in WiPort™ User Guide...
  • Page 34: Updating Settings

    Applying Factory Default Settings? Click the Defaults? button from the main menu to apply the factory Apply Factory settings to the WiPort. For a list of the default settings, refer to Default Settings page 61. WiPort™ User Guide...
  • Page 35: 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 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 36: 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 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 37: Server Configuration

    Netmask: Number of Bits for Host Part (0=default) (0) _ The unit prompts for the number of host bits to be entered, then calculates the netmask, which displays in standard decimal-dot notation when the saved parameters are displayed (for example, 255.255.255.0). WiPort™ User Guide...
  • Page 38: Change Telnet Configuration Password

    2 digit numbers (0-99). SHOULD IT BE 10-99? The third octet of the IP address sets the BootP/DHCP/AutoIP options. To disable an option, set the appropriate bit: 5-2. BootP/DHCP/AutoIP options Options AutoIP DHCP WiPort™ User Guide...
  • Page 39: Channel 1 And Channel 2 Configuration

    Note: RS-422 and RS-485 are available on Channel 2 only (WiPort-485 models) if the WiPort is used with the WiPort evaluation board. Otherwise, RS-422 and RS-485 functions are available on only one channel; depending on which channel the drivers were added, these functions are available on either channel 1 or channel 2.
  • Page 40: Flow

    (2) On WP2004000-01 (WiPort-485) only. Note: If attempting to select an I/F Mode bit pertaining to RS-422/485 on a WiPort model WP2001000-01, a “WARNING: RS-422/485 I/F Modes not supported” message displays. RS-422/485 settings are available on the WP2004000-01 (WiPort-485). The following table demonstrates some common I/F Mode settings: Table 5-4.
  • Page 41: Port Number

    Incoming TCP/UDP port and Outgoing TCP/UDP source port. Port No (10001) ? _ The current value is displayed in parentheses. The default setting for Port 1 is 10001. The range is 1-65535, except for the following reserved port numbers: WiPort™ User Guide...
  • Page 42: Connect Mode

    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 WiPort™ User Guide...
  • Page 43 Attempts to connect when the modem_control_in input changes Accept with from not asserted to asserted. modem_control_in Active Attempts to connect when it receives a specific start character With a Specific Start from the serial port. The default start character is carriage return. Character WiPort™ User Guide...
  • Page 44 Connects to 129.1.2.5, port 1234 C28.10/12 Connects to 129.1.28.10, port 12 C0.0.0.0/0 Connects to 129.1.28.10, port 12; enters Monitor Mode The unit automatically attempts a connection to the remote IP Autostart (Automatic address and port after booting up. Connection) WiPort™ User Guide...
  • Page 45 2. To delete, modify, or add an entry, select Yes. If entering an IP address of 0.0.0.0, that entry and all others after it are deleted. 3. After completing the hostlist, repeat the previous step if necessary to edit the hostlist again. WiPort™ User Guide...
  • Page 46 Configuration via Serial Mode or Telnet Port 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. The range is 1-15, with the default set to 3.
  • Page 47 The character string ATH is received, terminated with a carriage return. The unit responds affirmatively according to the selected echo/response mode and drops the network connection. The serial interface reverts to accepting command strings. WiPort™ User Guide...
  • Page 48: Send The Escape Sequence (+++) In Modem Mode

    Send the Escape Sequence (+++) in Modem Mode Send ‘+++’ in Modem Mode (Y) ? _ Disable or enable the WiPort’s ability to send the escape sequence. The default is Y (Yes) (send the escape sequence). Auto Increment Source Port Auto increment source port (N) ? _ Y (Yes) auto increment the source port.
  • Page 49: Remote Port

    State LED off with connection Disconnect with EOT (^D) (1) The WiPort 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 50: Flush Mode

    (WAN). Adjusting parameters in this mode can economize the network data stream. Pack control settings are enabled in Flush Mode. Set this value to 00 if specific functions are not needed. Table 5-13. Pack Control Options Option Packing Interval Interval: 12ms Interval: 52ms Interval: 250ms WiPort™ User Guide...
  • Page 51: Disconntime (Inactivity Timeout)

    If the unit receives a character on the serial line that matches one of these characters, it sends the character immediately, along with any awaiting characters, to the TCP connection. This action minimizes the response time for specific protocol WiPort™ User Guide...
  • Page 52 (for example, ETX, EOT). Setting the first SendChar to 00 disables the recognition of the characters. Alternatively, the unit can interpret two characters as a sequence (see on page 50). Pack Control WiPort™ User Guide...
  • Page 53: Telnet Terminal Type

    - Trigger 2 Serial trigger input: disabled Channel: 1 Match: 00 Trigger input1: X Trigger input2: X Trigger input3: X Message : Priority: L Min. notification interval: 1 s Re-notification interval : 0 s - Trigger 3 WiPort™ User Guide...
  • Page 54: Mail Server

    The current value is displayed in parentheses. Mail Server (0.0.0.0) ? ( 0) _ Unit Name Enter the username used by the WiPort to send Email messages. The current value is displayed in parentheses. Unit name () ? _ Domain Name Enter the Email server’s domain name.
  • Page 55: Trigger 2

    Email. WLAN Settings Without adequate protection, a wireless LAN is susceptible to access by unauthorized users. As such, WiPort features the WPA security standard, based on IEEE802.11i and IEEE802.1X. WEP is provided for backwards compatibility and interaction with older devices.
  • Page 56: Adhoc Network Channel

    Configuration via Serial Mode or Telnet Port Network name (LTRX_IBSS) ? _ Adhoc Network Channel When Adhoc is selected in the Topology parameter and the WiPort cannot find the specified network, it creates one with that name by transmitting a beacon on the selected channel.
  • Page 57: Fixed Or Automatic Data Rate

    Transmission Data Rate If the TX Data rate is set to 0 (fixed), the selected data rate is the the WiPort’s fixed transmission rate. If the TX Data rate is set to 1 (auto), the selected data rate is the the WiPort’s maximum data rate.
  • Page 58: Transmission Power Level

    Enable power management (N) ? _ Transmission Power Level Note: Available on WiPort version WP2001000G-02 (WiPort-G). Select the transmission power level. Higher values span a wider range. The default is 18 dBm. TX power level 0=0, 1=6, 2=12, 3=18 dBm (0) ? _...
  • Page 59: Http Port Number

    Enable alternate MAC (N) ? _ Ethernet Connection Type The WiPort allows for the Ethernet speed to be manually configured. Enter 0 for automatic negotiation (default). To select the speed and duplex, enter one of the following: 2 (10Mbit/half duplex), 3 (10Mbit/full duplex), 4 (100Mbit/half duplex), or 5 (100Mbit/full duplex).
  • Page 60: Disable Snmp

    Configuration via Serial Mode or Telnet Port Disable SNMP For security purposes, disable SNMP (if required) on the WiPort unit. The current setting is displayed in parentheses. Disable SNMP (N) ? _ SNMP Community Name The SNMP Community Name is a required field for NMS to read or write to a device.
  • Page 61: Enable Encryption

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

    TX Data Rate N (No) Enable Power Management 18 dBm TX Power Level* *On select models only Expert Settings 45 (seconds) TCP Keepalive 600 (seconds) ARP Cache Timeout N (No) Enable High Performance (N) No Disable Monitor Mode WiPort™ User Guide...
  • Page 63: Security Settings

    Select option 9 Save and exit from the Change Setup menu to save all changes and reboot the device. All values are stored in nonvolatile memory. Select option 8 Exit without save from the Change Setup menu to exit the configuration mode without saving any changes or rebooting. WiPort™ User Guide...
  • Page 64: 6: Configurable Pins

    The WiPort 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. Defaults Settings: Function: general purpose input/output Direction: input Active Level: low Set the functions for the three pins independently and in any combination.
  • Page 65: Commands

    As you can, see there is no Set functions command. Since the pin’s function depends on the hardware in which the WiPort 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 66 Bytes 5-8: New Directions Bit X 1 means GPIO X will become an output. 0 means it will become an input. Response: 1 parameter Bytes 1-4: The updated directions Command 1Ah, Set Active Levels Send: 2 parameters WiPort™ User Guide...
  • Page 67: Examples

    Examples Example 1: PC sends command 10h to find out which configurable pins are available as GPIO. PC -> WiPort: 10h, 00h, 00h, 00h, 00h, 00h, 00h, 00h, 00h WiPort -> PC: 10h, 03h, 00h, 02h, 00h Command details: 10h = command 10h...
  • Page 68 Configurable Pins PC -> WiPort: 1Bh, 01h, 00h, 02h, 00h, 01h, 00h, 00h, 00h WiPort -> PC: 1Bh, 03h, 00h, 00h, 00h Command details: 1Bh = command 1Bh 01h, 00h, 00h, 00h = the mask that determines which GPIOs will be changed.
  • Page 69: 7: Monitor Mode

    Table 7-1. Monitor Mode Commands Command Command Name Function Version Queries software header record (16 bytes) of unit. Get Configuration Gets configuration of unit as hex records (120 bytes). Send Configuration Sets configuration of unit from hex records. WiPort™ User Guide...
  • Page 70 Entering any of the commands listed above 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> Wrong parameter(s) 9> Invalid command WiPort™ User Guide...
  • Page 71: 8: Updating Firmware

    *.FWX): via 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 72: 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. 4. Click OK to download the file. Note: See also Recovering Firmware in the DeviceInstaller User Guide.
  • Page 73: 9: Troubleshooting

    This chapter discusses how you can diagnose and fix errors quickly without having to contact a dealer or Lantronix. The WiPort’s 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 74: Problems And Error Messages

    No response from device! Verify the IP, Hardware The IP address you are trying to Address and Network Class. assign is not a valid IP for your Please try again. logical subnet. WiPort™ User Guide...
  • Page 75 Use Connect Mode option C1 or C5 for a connection to the network from the device server. See the full list of Connect Mode options Connect Mode on page 42. WiPort™ User Guide...
  • Page 76 No Connection With on the device server. router that you are using on the The Device Server message network. Also, make sure that port displays. 77FEh is not disabled within the Security settings of the device server. WiPort™ User Guide...
  • Page 77 If you are experiencing an error that is not described in this chapter, or if you are unable to fix the error, you may: To check our online knowledge base or send a question to Technical Support, go to http://www.lantronix.com/support. Email us at support@lantronix.com.

Table of Contents