WiPort, with its patent-pending technology, is a trademark of Lantronix.
Ethernet is a trademark of XEROX Corporation. UNIX is a registered trademark of
The Open Group. Windows 95, Windows 98, Windows 2000, Windows NT, and
Windows XP are trademarks of Microsoft Corp. Netscape is a trademark of Netscape
Communications Corporation.
Contacts
Lantronix Corporate Headquarters
15353 Barranca Parkway
Irvine, CA 92618, USA
Phone: 949-453-3990
Fax: 949-453-3995
Technical Support
Phone: 800-422-7044 or 949-453-7198
Fax: 949-450-7226
Online: www.lantronix.com/support
Email support@lantronix.comSales Offices
For a current list of our domestic and international sales offices, go to the Lantronix
web site at http://www.lantronix.com/about/contact/index.html
WiPort™ User Guide i
Disclaimer and Revisions
Note:This product has been designed to comply with the lim its for a Class B
digital device pursuant to Part 15 of FCC Rules. These limits are designed to
provide reasonable protection against harmful interference in a residential
installation. This equipment generates, uses, and can radiate radio frequency
energy, and if not installed and used in accordance with this guide, may
cause harmful interference to radio communications.
Changes or modifications to this device not explicitly approved by Lantronix will void
the user's authority to operate this device.
ii WiPort™ User Guide
Contents
Copyright and Trademark _________________________________________________ i
Contacts ______________________________________________________________ i
Disclaimer and Revisions _________________________________________________ ii
Telnet Access_____________________________________________________________ 5-1
Serial Port Access _________________________________________________________ 5-2
Server Configuration ___________________________________________________5-3
Set the IP Address _________________________________________________________ 5-3
Set the Gateway IP Address _________________________________________________ 5-3
Set the Netmask___________________________________________________________ 5-4
Change Telnet Configuration Password ________________________________________ 5-4
DHCP Name______________________________________________________________ 5-4
Channel 1 and Channel 2 Configuration ____________________________________5-5
Baudrate_________________________________________________________________ 5-5
I/F (Interface) Mode ________________________________________________________ 5-5
Flow ____________________________________________________________________ 5-6
Port Number ______________________________________________________________ 5-6
Connect Mode ____________________________________________________________ 5-7
Remote IP Address _______________________________________________________ 5-13
Remote Port _____________________________________________________________ 5-13
DisConnMode____________________________________________________________ 5-14
Flush Mode______________________________________________________________ 5-14
DisConnTime (Inactivity Timeout) ____________________________________________ 5-16
SendChar 1 and SendChar2 ________________________________________________ 5-16
Telnet Terminal Type ______________________________________________________ 5-16
Channel (Port) Password ___________________________________________________ 5-16
Entering Monitor Mode via the Serial Port___________________________________ 7-1
Entering Monitor Mode via the Network Port_________________________________ 7-1
Monitor Mode Commands _______________________________________________ 7-2
Using TFTP: Graphical User Interface __________________________________________ 8-1
Using TFTP: Command Line Interface __________________________________________ 8-2
Recovering the Firmware Using the Serial Port ___________________________________ 8-2
9: Troubleshooting 9-1
Problems and Error Messages ___________________________________________ 9-1
Technical Support _____________________________________________________ 9-4
WiPort™ User Guide v
11:: UUssiinngg TThhiiss GGuuiiddee
Purpose and Audience
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.
Chapter Summary
The remaining chapters in this guide include:
2:Introduction
3:Configuration using
DeviceInstaller
4:Configuration using WebManager
5:Configuration via Serial Mode
or Telnet Port
Describes the main features of the WiPort and the protocols it
supports.
Provides information for configuring the WiPort using
DeviceInstaller.
Details configuration using the Web-Manager to set parameters
such as port and server properties.
Provides instructions for accessing Setup Mode (command line
interface) using a Telnet connection through the network or a
terminal or terminal emulation program through the serial port.
Details the parameters that you must configure.
6:Configurable Pins
7:Monitor Mode
8:Updating Firmware
9:Troubleshooting
Provides instructions for configuring the eleven General Purpose
I/O pins.
Provides instructions for accessing and using the command line
interface for monitoring the network and diagnosing problems.
Provides instructions for obtaining the latest firmware and updating
the WiPort.
Describes common problems and error messages and how to
contact Lantronix Technical Support.
WiPort™ User Guide 1-1
Using This Guide
Additional Documentation
The following guides are available on the product CD and the Lantronix web site
(www.lantronix.com
)
WiPort Development Kit Quick
Start Guide
WiPort Integration Guide
DeviceInstaller User Guide
Com Port Redirector User Guide
Creating Custom Web Pages
Briefly explains the basics to get the WiPort up
and running.
Provides information about the WiPort
hardware and integrating the WiPort into
another product.
Provides instructions for using the Windows-
based utility to configure the WiPort and other
Lantronix device servers.
Provides information on using the Windowsbased utility to create a virtual com port.
Explains the detailed requirements for adding
web services to the WiPort and to other
Lantronix device servers.
1-2 WiPort™ User Guide
22:: IInnttrroodduuccttiioonn
WiPort is a wireless embedded device server that provides a network-enabling
solution based on the 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 transceiver, and dual high-speed serial
ports into a single compact module. It includes an operating system, an embedded
Web server, full TCP/IP protocol stack, and WEP security. In addition, the WiPort
sends email alerts and supports numerous other network communication protocols,
including ARP, UDP, TCP, ICMP, Telnet, AutoIP, DHCP, HTTP, SNMP, and SMTP.
For OEMs who wish to customize the user interface by employing common and
familiar tools, the WiPort serves applets to a Web browser, resulting in interactive
Web pages. This customization of HTML Web pages and configuration screens
tailors the WiPort to fit unique requirements.
Topic Page
Capabilities 2-1
Applications 2-2
Protocol Support 2-2
Configuration Methods 2-2
Capabilities
The WiPort device server has the following capabilities:
Communication between TCP and UDP to serial.
Wireless interface (802.11b).
Ethernet interface.
Email notification of configurable alarms and events.
Upgradeable firmware.
SNMP monitoring.
Connects devices through a TCP or UDP data channel to computers or to
Contains a web server allowing presentation of custom content and easy
Contains eleven programmable I/O pins used to monitor or control attached
Addresses and Port Numbers 2-3
another device server.
configuration through the browser.
devices.
WiPort™ User Guide 2-1
Introduction
Applications
The WiPort device server connects serial devices such as those listed below to
wireless and Ethernet networks using the IP protocol family.
Protocol Support
The WiPort device server uses the TCP/IP protocol stack for network
communications. Other supported protocols include:
Remote sensing
CNC controllers
Data collection devices
Telecommunications equipment
Data display devices
Security alarms and access control devices
Time clocks and terminals
ARP, UDP, TCP, ICMP, Telnet, TFTP, AutoIP, DHCP, HTTP, and SNMP for
network communications and management.
TCP, UDP, and Telnet for connections to the serial port.
TFTP for firmware and web page updates.
IP for addressing, routing, and data block handling over the network.
User Datagram Protocol (UDP) for typical datagram applications in which
devices interact with other devices without maintaining a point-to-point
connection.
SMTP for e-mail transmission.
Configuration Methods
For the unit to operate correctly on a network, it must have a unique IP address on
the network. There are three basic methods for logging into the device server and
assigning IP addresses (as well as setting other configurable parameters):
DeviceInstaller: Configure the ports and other features on the WiPort using a
Graphical User Interface (GUI) on a PC attached to a network. (See 3: Configuration
using DeviceInstaller.)
Web-Manager: Through a web interface, configure the WiPort and its settings using
the WiPort’s Web-Manager. (See 4: Configuration using Web-Manager.)
Serial & Telnet Ports: There are two approaches to accessing Serial Mode. Make
a Telnet connection to the network port (9999) or connect a terminal (or a PC running
a terminal emulation program) to the unit’s serial port. (See 5: Configuration via Serial
Mode or Telnet Port.)
2-2 WiPort™ User Guide
Addresses and Port Numbers
Hardware Address
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.
Example: 00-20-4A-14-01-18
Note: Make note of the MAC address. It is needed to locate the WiPort
using DeviceInstaller.
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.
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.
Introduction
The unit's serial channel (port) can be associated with a specific TCP/UDP port
number. Port number 9999 is reserved for access to the unit's Setup (configuration)
Mode window. Ports 0-1024 are reserved as well. For more information on reserved
port numbers, refer to Table 5-5. Reserved Port Numbers.
This chapter covers the steps for getting the WiPort device server online and
working. This chapter includes the following topics:
Topic Page
Accessing WiPort using DeviceInstaller 3-1
Server Configuration 3-1
WLAN Configuration 3-2
Host List Configuration 3-3
OEM Pin Configuration 3-3
Channel 1 and Channel 2 Configuration 3-4
Email Configuration 3-8
Accessing WiPort using DeviceInstaller
Note: Make note of the MAC address. It is needed to locate the WiPort
using DeviceInstaller. For more information on the hardware address, see
Hardware Address on page 2-3.
Follow the instructions on the product CD to install and run DeviceInstaller.
1. Click StartÆPrograms Æ LantronixÆDeviceInstallerÆDeviceInstaller. If the
PC has more than one network adapter, a message displays requesting the
selection of a network adapter. Select an adapter and click OK.
2. Click the Search icon and select the WiPort unit from the list of Lantronix device
servers on the local network.
3. Highlight the WiPort device in the list and click Settings. The Configure Device
window for the WiPort unit displays.
4. To store configuration changes, click OK. To store and apply modifications, click
Apply.
Server Configuration
Note: The IP address is assigned via DHCP (on DHCP-enabled networks).
Assign a static IP address only if necessary.
To manually assign an IP Address:
1. Click the Assign IP icon
2. If prompted, enter the hardware address (on the product label) and click Next.
.
WiPort™ User Guide 3-1
Configuration Using DeviceInstaller
3. Select Assign a specific IP address and click Next.
4. Enter the IP address. The Subnet mask displays automatically based on the IP
address; if desired, change it. On a local network, you can leave the Default gateway blank (all zeros). Click Next.
5. Click the Assign pushbutton and wait several seconds until a confirmation
message displays. Click Finish.
6. Select the device from the main window list and select Ping from the Tools
menu. The Ping Device dialog box shows the IP address of the selected unit.
7. Click the Ping button. The results display in the Status window. Click the Clear Status button to clear the window so you can ping the device again.
Note: If you do not receive “Reply” messages, make sure the unit is
properly attached to the network and that the IP address assigned is
valid for the particular network segment you are working with. If you are
not sure, check with your systems administrator.
8. Click the Close button to close the dialog box and return to the main window.
WLAN Configuration
Without adequate protection, a wireless LAN is susceptible to access by
unauthorized users. As such, WiPort includes the Wired Equivalent Privacy (WEP)
encryption standard as an additional means of security.
To configure the WiPort’s WLAN settings:
Note: These settings are dependent on a given network’s individual settings.
1. From the Configure Device window for the WiPort unit, click the Advanced tab.
2. In the WLAN Configurable Items section, enter the following fields:
Current Network
Interface
Network Name to Search Enter the name of the network in which the WiPort unit
Ad Hoc Network
Creation
Ad Hoc Network Name
Ad Hoc Country From the pull down menu, select a country for the Ad Hoc
Ad Hoc Network
Channel
Security As an additional security measure, enable WEP on the
Authentication Select an authentication scheme from the pull down menu
Use the pull down menu to select a WLAN interface or an
Ethernet interface.
resides.
Select Enable when using a client (such as a wireless card) to
associate to a network.
Enter the network name for the Ad Hoc network.
network. The default is United States.
Select the radio channel from the pull down menu for the Ad
Hoc network. The default value is 11.
WiPort. By default, WEP is disabled on WiPort.
(None or Shared). Selecting Shared requires manually
entering the authentication key.
Encryption Select the encryption type from the pull down menu. 128 bits
is the default encryption.
3-2 WiPort™ User Guide
Configuration Using DeviceInstaller
Encrypti on Key Alternatively, manually enter the EncryptionKeyin
hexadecimal value. 10 hexadecimal characters are required
for 64 bit encryption. 26 hexadecimal characters are required
for 128 bit encryption.
Data Rate
3. Click Apply to apply the changes immediately to the WiPort and automatically
reboot. Click OK to save the changes to apply at the next reboot.
Host List Configuration
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. Once it connects, the
unit stops further attempts. If this connection fails, the unit continues to scroll through
the table until it is able to connect to the next available IP address in the host list.
The host list supports a minimum of 1 and a maximum of 12 entries. Each entry
contains an IP address and a port number. This field is available for configuration
only when Active Connection is not set to None.
Note: The host list is disabled for Manual and Modem Mode. The unit will not
accept a data connection from a remote device when the hostlist option is
enabled.
To configure the WiPort’s host list:
1. From the Configure Device window for the WiPort unit, click the Advanced tab.
2. In the Host List section, modify the following fields:
Retry Counter Enter the value for the number of times the WiPort should
WiPort permits the control of the transmission rate (in Mbps).
attempt to retry connecting to the host list.
Retry Timeout Enter the duration (in seconds) the WiPort should abandon
3. Click the “…” next to the Host List field to open the HostListEntry Collection
Editor Window. The list of host list IP addresses display in the Members section.
4. Click on a host list member to highlight it and enter the following information in
the Properties section:
Host
Port
5. Click Apply to apply the changes immediately to the WiPort and automatically
reboot. Click OK to save the changes to apply at the next reboot.
OEM Pin Configuration
There are 11 configurable hardware pins on the WiPort unit. For each pin, configure
the pin function, communication direction, and its active level. For more information,
see Configurable Pins on page 6-1.
To configure the WiPort’s Configurable Pins:
1. From the Configure Device window for the WiPort unit, click the Advanced tab.
attempting connection to the host list.
Enter or modify the Host’s IP address.
Enter the port on which the Host’s IP address resides.
WiPort™ User Guide 3-3
Configuration Using DeviceInstaller
2. In the OEM Configurable Pins section, click the … button next to the
Configurable Pins field to open the ConfigurablePin Collection Editor window.
3. Highlight a Configurable Pin from the Members section to select it for
configuration.
4. In the Configurable Pin Properties section (right side of the window), modify the
following fields:
Config Pin Function From the pull down menu, select the purpose of the specified
Config Pin Direction Select whether the pin receives input or transmits output. This
pin.
field is modifiable only when Config Pin Function is set to
GPIO.
Config Pin Active Level
Select the signal active level (Low or High). The default is
Low.
5. Click OK to store the configurable pin settings and close the ConfigurablePin
Collection Editor.
6. Click Apply from the Configure Device window to apply the changes
immediately. The WiPort device automatically reboots.
Channel 1 and Channel 2 Configuration
Channel 1 and Channel 2 configurations define how the serial port responds to
network and serial communications.
To configure the channel configurations:
1. From the Configure Device window for the WiPort unit, click the Ports tab. The
list of available ports display.
2. Click on a port number and click Edit Settings. The Port Properties window
opens.
3. Click the Port Settings tab. In the available fields, change the following pull
down menu options as necessary:
Baud Rate The unit and attached serial device, such as a modem, must
agree on a speed or baud rate to use for the serial connection.
Valid baud rates are 300, 600, 1200, 2400, 4800, 9600
(default), 19200, 38400, 57600, 115200, 230400, 460800, or
921600.
Data bits
Parity Refers to the checking whether data has been lost or written
Stop bits The stop bit follows the data and parity bits in serial
Flow control Flow control manages data flow between devices in a network
Indicates the number of bits in a transmitted data package.
over when transmitted between computers. The default is
None.
communication. It indicates the end of transmission.
to ensure it is processed efficiently. Too much data arriving
before a device is prepared to manage it causes lost or
retransmitted data.
The following table demonstrates some common Interface Mode (I/F) settings:
3-4 WiPort™ User Guide
Configuration Using DeviceInstaller
Table 3-1. Common Interface Mode Settings
Common I/F Mode Setting
RS-232C, 8-bit, No Parity, 1 stop bit
RS-232C, 7-bit, Even Parity, 1 stop bit
To configure advanced channel configurations:
4. From the Configure Device window for the WiPort unit, click the Ports tab. The
list of available ports display.
5. Click on a port number and click Edit Settings. The Port Properties window
opens.
6. Click the Advanced tab. In the available fields, change the following pull down
menu options as necessary:
Serial Settings
Baud Rate The unit and attached serial device, such as a modem, must
agree on a speed or baud rate to use for the serial connection.
Valid baud rates are 300, 600, 1200, 2400, 4800, 9600
(default), 19200, 38400, 57600, 115200, 230400, 460800, or
921600.
Data bits
Flow control Flow control manages data flow between devices in a network
Stop bits The stop bit follows the data and parity bits in serial
Parity Refers to the checking whether data has been lost or written
Indicates the number of bits in a transmitted data package.
to ensure it is processed efficiently. Too much data arriving
before a device is prepared to manage it causes lost or
retransmitted data.
communication. It indicates the end of transmission.
over when transmitted between computers. The default is
None.
UDP Datagram Mode
Datagram Mode When the UDP option is in effect, the unit never attempts to
initiate a TCP connection because it uses UDP datagrams to
send and receive data. Select True to enable Datagram
Mode.
Datagram Type
Configurable when Datagram Mode is set to True.
Configures remote IP or network broadcast address and the
remote port. Enter 01 for directed or broadcast UDP.
Passive Connection
Accept Passive
Connection
Select Yes to permit incoming network connection on this
port.
Local Port Port number for an incoming connection. Also used as the
source port number.
Password Required Select True to require a password for incoming connections.
WiPort™ User Guide 3-5
Configuration Using DeviceInstaller
Port Password
This parameter appears only when Password Required is set
to True. Enter a password for the selected channel or serial
port.
Active Connection
Active Connection
Terminal Type This field is available for configuration only when Telnet Mode
Remote Port This field is available for configuration only when Active
Use Host List This field is available for configuration only when Active
Defines the unit’s connection method. The default is None
(no Active Connection).
to True.
Use the terminal name for the Telnet terminal type. Enter only
one name. When this option is enabled, the unit also reacts to
the EOR (end of record) and binary options, which can be
used for applications such as terminal emulation to UNIX
hosts.
Connection is not set to None.
Set the remote TCP port number for the unit to make outgoing
connections. This parameter defines the port number on the
target host to which a connection is attempted.
To connect an ASCII terminal to a host using the unit for login
purposes, use the remote port number 23 (Internet standard
port number for Telnet services).
Connection is not set to None.
If this option is set to True, the device server attempts a
connection from the host list. This process stops at the first
valid connection.
The host list is disabled for Manual or Modem Mode. The unit
will not accept a data connection from an incoming remote
device when the host list option is enabled.
For information on configuring the host list, see Host List
Configuration on page 3-3.
Modem Emulation Mode In Modem (Emulation) Mode, the unit presents a modem
interface to the attached serial device. It accepts AT-style
modem commands, and handles the modem signals
accordingly.
For more information on Modem Emulation Mode, see Modem
Mode on page 5-11.
Selecting Without Echo tells the modem not send an answer
to the commands received (or display typed data).
Choose Full Verbose for the unit to echo modem commands
and respond to a command with a message string.
Character Response tells the WiPort unit to echo modem
commands and respond to a command with a single character
response.
Telnet Mode This field is available for configuration only when Active
Connection is not set to None. Select True to permit a Telnet
connection to the WiPort unit.
Remote Host This field is available for configuration only when Active
Connection is not set to None.
Denotes the destination IP address used with an outgoing
connection.
3-6 WiPort™ User Guide
Configuration Using DeviceInstaller
Connection Response A single character is transmitted to the serial port when there
is a change in connection state. Default setting is None.
Disconnection
Disable Hard Disconnect The TCP connection closes even if the remote site does not
acknowledge a disconnect request.
Disconnect with
modem_control_in
Disconnect with EOT The connection is dropped when Ctrl-D or Hex 04 is detected.
Inactivity Timeout Use this parameter to set an inactivity timeout. The unit drops
The connection drops when modem_control_in transitions
from a high state to a low state.
Both Telnet mode and Disconnect with EOT must be enabled
for Disconnect with EOT to function properly. Ctrl D is only
detected going from the serial port to the network.
the connection 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. To
disable the inactivity timeout, enter 00:00.
Connection
Connection LED
Select Blink for the status LEDs to blink upon connection or
None for no LED output.
Buffer Flushing
Flush Input Buffer
At Time of Disconnect Clear the network buffer when a network connection to or from
the serial port drops.
On Active Connection
On Passive
Connection
Clear the network buffer upon initializing a connection.
Clear the buffer upon a connection initiated from the network
to the serial port.
Flush Output Buffer
At Time of Disconnect Clear the buffer when the network connection to or from the
device is dropped.
On Active Connection Clear the buffer with a new connection initiated from the
device to the network.
On Passive
Connection
Clear the buffer with a connection from the network to the
device.
WiPort™ User Guide 3-7
Configuration Using DeviceInstaller
Packing
Enable Packing Two firmware-selectable packing algorithms define how and
Idle Time Select the maximum time for inactivity between data bytes on
Match Byte 1 Use to set the termination byte. Set this value to 00 if not
Match Byte 2 Use to indicate the end of a series of data to be sent as one
when packets are sent to the network. The standard algorithm
is optimized for applications in which the unit is used in a local
environment, allowing for very small delays, while keeping the
packet count low. The alternate packing algorithm optimizes
the packet for the network and is especially useful in
applications in a routed Wide Area Network (WAN). Adjusting
parameters in this mode can economize the network data
stream.
Select True to enable packing on the WiPort.
the serial port. The default time is 12 milliseconds.
used.
group. Set this value to 00 if specific functions are not needed.
Match 2 Byte Sequence
Send Frame Only After the detection of the byte sequence, indicates whether to
Send Trailing Bytes Select the number of bytes to send after the end-of-sequence
7. To exit the Channel 1 and Channel 2 configurations, click OK.
Email Configuration
The unit sends an e-mail when a specific trigger event occurs. There are three
separate triggers, based on any combination of the configurable pins (PIO) when
selected as user I/O functions. Optionally, use a two-byte serial string to initiate a
trigger.
To configure the WiPort’s email settings:
1. From the Configure Device window for the WiPort unit, click the Advanced tab.
2. In the Email Notification section, enter the following fields:
Domain Name
Used with Match Byte 1 and Match Byte 2 to indicate the
end of a series of data to be sent as one group. The
sequence must occur sequentially to indicate to the WiPort
end of the data packet.
send the data frame or the entire buffer (i.e. include the trailing
bytes). Select True to send only the data frame.
characters.
Enter the Email server’s domain name.
Mail Server
Recipients
Enter the IP address of the mail server.
Click the “…” box to open the Email Recipient Collection
Editor window. Click on an entry in the Members section and
enter the email address in the Email Recipient Properties
window. Click OK when finished.
3-8 WiPort™ User Guide
Configuration Using DeviceInstaller
Triggers A trigger event occurs when the unit receives the specified
trigger input as a result of a specified combination of
conditions on the configurable pins.
Each trigger is independent of the others. Each condition
within an individual trigger must be met before the unit will
send the Email.
Click the “…” box to open the Email Trigger Collection Editor
window. Highlight a trigger in the Members section and
modify its properties in the Email Trigger Properties section.
Click OK when finished.
For more information on triggers, see Email Configuration on
page 5-17
Unit Name Enter the username used by the WiPort to send Email
messages.
3. Click Apply to apply the changes immediately to the WiPort.
WiPort™ User Guide 3-9
Loading...
+ 56 hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.