PremierWaveTM EN User Guide Part Number 900-579 Revision A January 2011
Copyright & Trademark © 2011 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. Ethernet is a trademark of XEROX Corporation. Windows is a trademark of Microsoft Corporation. Linux is a registered trademark of Linus Torvalds.
Table of Contents Copyright & Trademark ___________________________________________________ 2 Contacts ______________________________________________________________ 2 Disclaimer & Revisions ___________________________________________________ 2 Revision History ________________________________________________________ 2 Table of Contents _______________________________________________________ 3 List of Figures __________________________________________________________ 6 List of Tables _______________________
WLAN Profile WEP Settings ___________________________________________ 27 WLAN Profile WPA and WPA2/IEEE802.
10: Advanced Settings 49 Command Line Interface Settings __________________________________________ 49 Basic CLI Settings __________________________________________________ 49 Telnet Settings _____________________________________________________ 50 SSH Settings ______________________________________________________ 50 XML Configuration _____________________________________________________ 51 XML: Export Configuration ____________________________________________ 51 XML: Import System Configuration Page ___
Index 67 List of Figures Figure 2-1 Sample Hardware Address______________________________________ 14 Figure 2-2.
Table 5-8 Using the XML to Configure Tunnel Packing Mode Settings ____________ 36 Table 7-1 DNS Configuration _____________________________________________ 40 Table 7-2 Syslog Configuration ___________________________________________ 40 Table 8-1 Certificate Upload Settings ______________________________________ 41 Table 8-2 Using the CLI to Upload an Existing SSL Certificate/Key Pair ___________ 41 Table 8-3 Using XML to Upload an Existing SSL Certificate/Key Pair _____________ 41 Table 8-4 Authority Certi
Table 10-12 Import Configuration from Filesystem Settings _____________________ 52 Table 10-13 Using the CLI to Import and XML Settings ________________________ 52 Table 13-1 Binary to Hexadecimal Conversion _______________________________ 60 PremierWave EN User Guide 8
1: Using This Guide Purpose and Audience This guide provides the information needed to configure, use, and update the PremierWave EN. It is intended for software developers and system integrators who are embedding PremierWave in their designs. Summary of Chapters The remaining chapters in this guide include: Chapter Description 2: Introduction Main features of the product and the protocols it supports. Includes technical specifications.
1: Using This Guide Chapter Description A: Technical Support Instructions for contacting Lantronix Technical Support. B: Binary to Hexadecimal Conversions Instructions for converting binary values to hexadecimals. C: Compliance Lantronix compliance information. D: Warranty Lantronix warranty statement. E: USB-CDC-ACM Device Driver File for Windows Hosts Information about the device driver file for windows host.
1: Using This Guide Additional Documentation Visit the Lantronix Web site at www.lantronix.com/support/documentation for the latest documentation and the following additional documentation. Document PremierWave EN Integration Guide PremierWave EN Command Reference PremierWave Eval Board Quick Start Description Information about the PremierWave EN hardware, testing the PremierWave EN using the demonstration board, and integrating the PremierWave EN into your product.
2: Introduction The PremierWave EN embedded Ethernet Device Server is a complete network-enabling solution in a 30 (1.181) X 55 (2.165) X 6.45 (0.248) package. This miniature device server empowers original equipment manufacturers (OEMs) to go to market quickly and easily with Ethernet and/or wireless networking and web page serving capabilities built into their products. [DIMS = mm (in.)] Key Features Power Supply: Regulated 3.3V input required. There is a step-down converter to 1.
2: Introduction Data display devices Security alarms and access control devices Handheld instruments Modems Time/attendance clocks and terminals’ Patient Monitoring Devices Glucose Analyzers Infusion Pumps Protocol Support The PremierWave EN device server contains a full-featured IP stack. Supported protocols include: ARP, IP, UDP, TCP, ICMP, BOOTP, DHCP, Auto IP, Telnet, DNS, FTP, TFTP, SSH, SSL/TLS, and Syslog for network communications and management.
2: Introduction XML: The PremierWave EN supports XML-based configuration and setup records that make device configuration transparent to users and administrators. XML is easily editable with a standard text or XML editor. (See the PremierWave EN Command Reference Guide for instructions and commands.) Addresses and Port Numbers Hardware Address The hardware address is also referred to as the Ethernet address or MAC address.
2: Introduction Product Information Label The product information label on the unit contains the following information about the specific unit: Bar code Product Revision Part number Hardware Address (MAC Address) Manufacturing Date Code Figure 2-2.
3: Using DeviceInstaller This chapter covers the steps for locating a PremierWave EN unit and viewing its properties and device details. Notes: For instructions on using DeviceInstaller to configure the IP address and related settings or for more advanced features, see the Device Installer online Help. Auto IP generates a random IP address in the range of 169.254.0.1 to 169.254.255.254, with a netmask of 255.255.0.0, if no BOOTP or DHCP server is found.
3: Using DeviceInstaller Device Details Summary Note: The settings are Display Only in this table unless otherwise noted. Current Settings Description Name Name identifying the PremierWave EN. DHCP Device Name The name associated with the PremierWave EN module’s current IP address, if the IP address was obtained dynamically. Group Configurable field. Enter a group to categorize the PremierWave EN. Double-click the field, type in the value, and press Enter to complete.
3: Using DeviceInstaller Current Settings Description Telnet Port Shows the PremierWave EN port for Telnet sessions. Web Enabled Indicates whether Web Manager access is enabled on this PremierWave EN. Web Port Shows the PremierWave EN port for Web Manager configuration (if Web Enabled field is True). Firmware Upgradeable Shows True, indicating the PremierWave EN firmware is upgradeable as newer versions become available.
4: Network Settings The Network Settings show the status of the Ethernet or WLAN interface/link and let you configure the settings on the device. Interface settings are related to the configuration of the IP and related protocols. Link settings are related to the physical link connection, which carries the IP traffic. The PremierWave EN contains two network interfaces, only one of which may be active at a time.
4: Network Settings Network Interface Configuration Settings Description Hostname Enter the hostname for the interface. It must begin with a letter or number, continue with a sequence of letters, numbers, or hyphens, and end with a letter or number. Note: This setting will take effect immediately, but will not register the hostname with a DNS server until the next reboot. Domain Enter the domain name suffix for the interface.
4: Network Settings Network Link Settings The Network Link settings allow you to configure the physical link parameters for a Network Interface. The Ethernet and WLAN link settings are described below. Table 4-3 Network 1 Ethernet (eth0) Link Settings Network 1 Ethernet (eth0) Link Settings Description Speed Select the Ethernet link speed. (Default is Auto) Auto = Auto-negotiation of Link Speed 10 = Force 10 Mbps 100 = Force 100 Mbps Duplex Select the Ethernet link duplex mode.
4: Network Settings Network 2 WLAN (wlan0) Link Settings Description Debugging Level The Debugging Level sets the verbosity level for printing WLAN Link messages to the TLOG.
4: Network Settings WLAN Link Scan Results Field Description Flags Indicates the security suite in use by the device as well as whether it is operating in Adhoc (IBSS) mode. SSID The Service Set Identifier (network name) of the device.
4: Network Settings WLAN Profiles A WLAN profile defines all of the settings necessary to establish a wireless connection with either an access point (in infrastructure mode) or another wireless client (in Adhoc mode.) A maximum of six profiles can exist on the PremierWave EN at a time. Of these, up to four can be configured as active (see Profile Choices under WLAN Settings on page 22). WLAN Profile Management Commands These commands create, edit and remove WLAN profiles on the PremierWave EN.
4: Network Settings WLAN Profile Basic Settings WLAN Profile Basic Settings Description Network Name The name of the wireless network (SSID.) Note: The PremierWave EN performs only passive scans on the DFS channels (52–140.) In order for the PremierWave EN to connect with an access point on one of these channels, the access point must be configured to broadcast the SSID in its beacons. Topology Specifies Infrastructure (ESS) or Adhoc (IBSS) mode.
4: Network Settings WLAN Profile Advanced Settings Description Antenna Diversity Selects the antenna the radio will use or allows the PremierWave EN to automatically make the selection. Enabled = allow the PremierWave EN to select the antenna. Antenna 1 = use the internal antenna. Antenna 2 = use the external antenna. Power Management Power management reduces the overall power consumption of the PremierWave EN unit, but can increase latency.
4: Network Settings WLAN Profile Security Settings Description Passphrase The passphrase consists of up to 63 characters. Note: Lantronix recommends using a passphrase of 20 characters or more for maximum security. Spaces and punctuation characters are permitted. Note: The passphrase input is not the same as ASCII input (as used on some products.
4: Network Settings Table 4-18 Using the CLI to Configure WLAN Profile WEP Settings Command level enable>configure>wlan profiles>edit (profile name)>security>wep Table 4-19 Using XML to Configure WLAN Profile WEP Settings Configuration group name wlan profile:(profile name) WLAN Profile WPA and WPA2/IEEE802.11i Settings WPA and WPA2/IEEE802.11i security suites are available for Infrastructure mode only.
4: Network Settings WLAN Profile WPA & WPA2 Settings Description IEEE 802.1X Selects the protocol to use to authenticate the WLAN client. LEAP = Lightweight Extensible Authentication Protocol. A derivative of the original Cisco LEAP, which was a predecessor of 802.1X. Real Cisco LEAP uses a special MAC layer authentication (called Network EAP) and cannot work with WPA/WPA2. The PremierWave EN uses a more generic version to be compatible with other major brand WiFi equipment.
4: Network Settings WLAN Profile WPA & WPA2 Settings Description Encryption Select one or more encryption types, listed from strongest to least strong. At least one selection will have to match the Access Points intended to connect with. CCMP = Uses AES as basis and is the strongest encryption option. TKIP = Uses WEP as the basis, but adds extra checks and variations for added protection. WEP = Based on RC4.
5: Line and Tunnel Settings The PremierWave EN contains three Lines. Lines 1 and 2 are standard RS232/RS485 serial ports, while Line 3 is an emulated serial port over the USB Device (USB-CDC-ACM). RS232/RS485 Lines 1 and 2 can be configured to operate in the following modes: RS232 RS485 Full Duplex RS485 Half Duplex, with and without termination impedance All serial settings such as Baud Rate, Parity, Data Bits, etc, apply to these Lines.
5: Line and Tunnel Settings Line Settings The Line Settings allow configuration of the serial Lines (ports). Some settings may be specific to only certain Lines. Such settings are noted below. Line Settings Description Name Enter a name or short description for the line, if desired. By default, there is no name specified. A name that contains whitespace must be quoted. Interface Sets the interface type for the Line. The default is RS232 for Lines 1 and 2, and USB-CDC-ACM for Line 3.
5: Line and Tunnel Settings Line Settings Description Mode, a CLI session operates exclusively on the Line. Choices are: Disable Always Note: In order to enable command mode on the Line, Tunneling on the Line must be Disabled (both connect and accept modes).
5: Line and Tunnel Settings Tunnel Accept Mode Settings Description CP – Group Configures the name of the CP Group to set upon making or breaking an Accept mode connection. By default, there is no CP Group set. Note: See Chapter 6: Configurable Pin Manager for information on how to configure the CP groups and pins. CP – Connection Value Sets the value to output to the CP Group upon Accept mode connection. Default is 0.
5: Line and Tunnel Settings Connect Mode In Connect Mode, the PremierWave EN continues to attempt an outgoing connection on the network, until established. If the connection attempt fails or the connection drops, then it retries after a timeout. Tunnel Connect Mode Settings Description Connect Mode Sets the method to be used to attempt a connection to a remote host or device. Choices are: Always = a connection is attempted until one is made.
5: Line and Tunnel Settings Packing Mode With Packing, data from the serial Line is not sent over the network immediately. Instead, data is queued and sent in segments, when either the timeout or byte threshold is reached. Packing applies to both Accept and Connect Modes. Tunnel Packing Settings Description Threshold Sets the threshold (byte count). If the received serial data reaches this threshold, then the data will be sent on the network. Valid range is 100 to 2048 bytes. Default is 2048.
6: Configurable Pin Manager The Configurable Pin Manager is responsible for assignment and control of the configurable pins (CPs) available on the PremierWave EN. There are nine configurable pins on the PremierWave EN. You can configure the CPs by making them part of a group. A CP Group may consist of one or more CPs This increases flexibility when incorporating the PremierWave EN into another system. CPM: Configurable Pins Each CP is associated with an external hardware pin.
6: Configurable Pin Manager CPM – CPs Configuration Description Bit : 8 7 6 5 4 3 2 1 0 : -----------------Level : : -----------------I/O : I :------------------Logic : : -----------------Binary: x x x x x x x x 0 : -----------------CP# : 0 0 0 0 0 0 0 0 1 :------------------- CPM – CPs Status Description Name Shows the CP number. State Shows the current enable state of the CP. Value Shows the last bit in the CP current value. Bit Visual display of the bitwise 32 bit placeholders for a CP.
6: Configurable Pin Manager CPM: Groups The CP Groups page allows for the management of CP groups. Groups can be created or deleted. CPs can be added to or removed from groups. A group, based on its state, can trigger outside events (such as sending email messages). Only an enabled group can be a trigger. Group name State CP info test1 Enabled 1 CPs assigned test2 Enabled 1 CPs assigned CPM – Groups Current Configuration Description Group Name Shows the CP group’s name.
7: Services Settings DNS Configuration This page shows the active run-time settings for the domain name system (DNS) protocol. The primary and secondary DNS addresses come from the active interface. The static addresses from the Network Interface Configuration page may be overridden by DHCP or BOOTP. The DNS page also shows any contents in the DNS cache. When a DNS name is resolved using a forward lookup, the results are stored in the DNS cache temporarily.
8: Security Settings SSL Settings Secure Sockets Layer (SSL) is a protocol for managing the security of data transmission over the Internet. It provides encryption, authentication, and message integrity services. SSL is widely used for secure communication to a web server, and also for wireless authentication. Certificate/Private key combinations can be obtained from an external Certificate Authority (CA) and uploaded into the unit.
8: Security Settings Authority Certificate Settings One or more authority certificates are needed to verify a peer's identity. Authority certificates are used with some wireless authentication methods. These certificates do not require a private key. Table 8-4 Authority Certificate Settings Authority Certificate Settings Authority Description SSL authority certificate. RSA or DSA certificates are allowed. The format of the authority certificate can be PEM or PKCS7.
8: Security Settings Certificate Generation Settings Key length Description Select the bit size of the new self-signed certificate. Choices are: 512 bits 768 bits 1024 bits 2048 bits The larger the bit size, the longer it takes to generate the key.
9: Maintenance and Diagnostics Settings File System Configuration The PremierWave EN uses a flash file system to store files. Use the filesystem commands to list, view,.add, remove, and transfer files. File Display Commands It is possible to view the list of existing files, and to view their contents in the ASCII or hexadecimal formats. Table 9-1 File Display Commands File Display Commands ls Description Displays a list of files on the PremierWave, and their respective sizes.
9: Maintenance and Diagnostics Settings File Transfer Commands Files can be transferred to and from the PremierWave via the TFTP protocol. This can be useful for saving and restoring XML configuration files. Table 9-5 File Transfer Commands File Transfer Settings TFTP Description Action Host Select the action that is to be performed via TFTP: Get = a “get” command will be executed to store a file locally. Put = a “put” command will be executed to send a file to a remote location.
9: Maintenance and Diagnostics Settings Diagnostics The PremierWave EN has several tools for diagnostics and statistics. The options at the top of the page allow for the configuration or viewing of IP socket information, ping, traceroute, DNS lookup, memory, and processes. IP Sockets You can view the list of listening and connected IP sockets. Table 9-10 Using the CLI to View IP Sockets enable show ip sockets Command level Command Ping The ping command can be used to test connectivity to a remote host.
9: Maintenance and Diagnostics Settings Table 9-14 Using the CLI to Perform the Trace Route Command enable trace route Command level Command DNS Lookup Here you can specify a DNS Hostname for a forward lookup or an IP address for a reverse lookup. Note: A DNS server must be configured for DNS Lookup to work.
9: Maintenance and Diagnostics Settings System Configuration The PremierWave EN allows for rebooting the device, restoring factory defaults, and uploading new firmware. Table 9-19 System Settings System Settings Description Reboot Device Run the reload command. Restore Factory Defaults Run the reload factory defaults command. All configuration settings will be lost. The PremierWave EN automatically reboots upon setting back to the defaults. Upload New Firmware FTP to the PremierWave.
10: Advanced Settings Command Line Interface Settings The Command Line Interface settings allow you to control how users connect to and interact with the PremierWave’s command line. It is possible to configure access via the Telnet and SSH protocols, in addition to general CLI options. Basic CLI Settings The basic CLI settings control general CLI access and usability options.
10: Advanced Settings Telnet Settings The telnet settings control CLI access to the PremierWave EN over the Telnet protocol. Table 10-4 Telnet Settings Telnet Settings Description state Enable or disable CLI access via telnet authentication Enable or disable authentication for telnet logins.
10: Advanced Settings XML Configuration The PremierWave EN allows for the configuration of units using an XML configuration file. Export a current configuration for use on other PremierWave ENs or import a saved configuration file. XML: Export Configuration You can export the current system configuration in XML format. The generated XML file can be imported later to restore a configuration. It can also be modified and imported to update the configuration on this PremierWave EN unit or another.
10: Advanced Settings XML: Import System Configuration Page Here you can import a system configuration from an XML file. The XML data can be imported from a file on the file system or pasted into a CLI session. The groups to import can be specified at the command line, the default is all groups. Import Configuration from External File This import option requires entering the path and file name of the external XCR file you want to import.
11: Tunneling Tunneling allows serial devices to communicate over a network, without “being aware” of the devices which establish the network connection between them. Tunneling parameters are configured using the CLI Tunnel menu and submenus (see the PremierWave EN Command Reference for the full list of commands.) The PremierWave EN supports Connect Mode and Accept Mode connections, but only one mode may be enabled at a time on each serial Line.
11: Tunneling TCP Accept Mode has the following states: Disabled (never a connection) Always (always listening for a connection) Packing Mode Packing Mode takes data from the serial port, groups it together, and sends it out on the network. When either a queued Threshold (number of bytes) or a Timeout is reached, the data is sent. Packing Mode cannot be disabled.
12: Security in Detail Secure Sockets Layer (SSL) SSL uses digital certificates for authentication and cryptography against eavesdropping and tampering. Sometimes only the server is authenticated, sometimes both server and client. The PremierWave EN can be server and/or client, depending on the application. Public key encryption systems exchange information and keys and set up the encrypted tunnel. Efficient symmetric encryption methods encrypt the data going through the tunnel after it is established.
12: Security in Detail Obtaining a Certificate and Private Key You can obtain a certificate by completing a certificate request and sending it to a certificate authority that will create a certificate/key combo, usually for a fee. Or generate your own. A few utilities exist to generate self-signed certificates or sign certificate requests. The PremierWave EN also has the ability to generate its own self-signed certificate/key combo.
12: Security in Detail SBR accepts trusted-root certificates in the DER format. Again, OpenSSL can convert any format into DER: openssl x509 –inform pem –in mp_cert.pem –outform der –out mp_cert.der Note: With SBR, when the identity information includes special characters such as dashes and periods, SBR changes the format it uses to store these strings and becomes incompatible with the current PremierWave EN release. We will add support for this and other formats in future releases.
13: Updating Firmware Obtaining Firmware Obtain the most up-to-date firmware and release notes for the unit from the Lantronix Web site (www.lantronix.com/support/documentation) or by using anonymous FTP (ftp://ftp.lantronix.com/). Loading New Firmware Firmware may be updated by sending the file to the PremierWave EN over a FTP connection. The destination file name on the PremierWave EN must be “firmware.rom”. The device will reboot upon successful completion of the firmware upgrade.
A: Technical Support If you are unable to resolve an issue using the information in this documentation, please contact Technical Support: Technical Support US Check our online knowledge base or send a question to Technical Support at http://www.lantronix.com/support. Technical Support Europe, Middle East, Africa Phone: +33 13 930 4172 Email: eu_techsupp@lantronix.com or eu_support@lantronix.com Firmware downloads, FAQs, and the most up-to-date documentation are available at http://www.lantronix.
B: Binary to Hexadecimal Conversions Many of the unit’s configuration procedures require you to assemble a series of options (represented as bits) into a complete command (represented as a byte). The resulting binary value must be converted to a hexadecimal representation. Use this chapter to learn to convert binary values to hexadecimals or to look up hexadecimal values in the tables of configuration options.
B: Binary to Hexadecimal Conversions Scientific Calculator Another simple way to convert binary to hexadecimal is to use a scientific calculator, such as the one available on the Windows operating systems. For example: 1. On the Windows Start menu, click ProgramsAccessoriesCalculator. 2. On the View menu, select Scientific. The scientific calculator appears. 3. Click Bin (Binary), and type the number you want to convert. 4. Click Hex. The hexadecimal value appears.
C: Compliance (According to ISO/IEC Guide 17050-1, 17050-2 and EN 45014) Manufacturer’s Name & Address: Lantronix 167 Technology Drive, Irvine, CA 92618 USA Product Name Model: PremierWave EN Embedded Device Server Conforms to the following standards or other normative documents: FCC Part 15.247/15.407 Class B RSS-210 RSS-Gen Issue 2 ICES-003 Issue 4 ETSI EN 301 489-1 V1.8.1 ETSI EN 301 489-17 V1.3.2 ETSI EN 300 328 V1.7.1 ETSI EN 301 893 V1.5.
C: Compliance RoHS Notice: All Lantronix products in the following families are China RoHS-compliant and free of the following hazardous substances and elements: • • Lead (Pb) Cadmium (Cd) Product Family Name UDS1100 and 2100 EDS MSS100 IntelliBox XPress DR & XPress-DR+ SecureBox 1101 & 2101 WiBox UBox MatchPort SLC XPort WiPort SLB SLP SCS SLS DSC PremierWave • • Mercury (Hg) Hexavalent Chromium (Cr (VI)) • • • Toxic or hazardous Substances and Elements Lead Mercury Cadmium Hexavalent (Pb) (Hg) (Cd
D: Warranty For details on the Lantronix warranty replacement policy, go to our web site at http://www.lantronix.com/support/warranty/index.
E: USB-CDC-ACM Device Driver File for Windows Hosts The following file may be used to enable Windows to recognize the USB-CDC-ACM connection to the PremierWave EN's USB Device port. This file is copied verbatim from the Linux distribution (2.6.36+) at Documentation/usb/linux-cdc-acm.inf. Place this file on the Windows host somewhere. When Windows prompts for a device driver for the USB connection, point it to this file.
E: USB-CDC-ACM Device Driver File for Windows Hosts [DriverService.NTamd64] DisplayName=%SERVICE% ServiceType=1 StartType=3 ErrorControl=1 ServiceBinary=%12%\USBSER.sys ;-----------------------------------------------------------------------------; Vendor and Product ID Definitions ;-----------------------------------------------------------------------------; When developing your USB device, the VID and PID used in the PC side ; application program and the firmware on the microcontroller must match.
Index A I Accessing PremierWave EN, 16 Additional Documentation, 11 Address Ethernet, 14 Hardware, 14, 15 IP, 14 MAC, 14, 15 Applications, 12 IP B Bar code, 15 Binary to hexadecimal conversions, 60 C Command Line Interface Settings, 49 Configuration methods, 13 CPM, 37 D Address, 14 K Key Features, 12 L Label, 15 Lantronix Discovery Protocol, 14 Line Settings, 31, 32 locating a PremierWave EN unit, 16 M MAC Address, 14, 15 Maintenance Settings, 9, 44 O OpenSSL, 56 default server port numbers, 14
Index Troubleshooting Capabilities, 13 Tunnel Settings Accept Mode, 33 Connect Mode, 35 Packing Mode, 36 Tunneling Accept Mode, 53 Connect Mode, 53 Packing Mode, 54 U Updating Firmware, 58 PremierWave EN User Guide W WLAN Settings Network 1 Ethernet Link, 21, 22, 24, 25, 26, 27, 28 X XML Export Configuration, 51 Import System Configuration, 52 XML, 14 XML Configuration, 51 68
