Lantronix WiPort NR, User Manual

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

Page 2: ...other trademarks and trade names are the property of their respective holders Export of Encryption Items The products described in this user guide contain encryption technology Technology hardware and software containing encryption technologies are subject to the U S Export Administration Regulations Each OEM is responsible to ensure that its use and or distribution of the products is in complianc...

Page 3: ...the interference by one of the following measures Reorient or relocate the receiving antenna Increase the separation between the equipment and receiver Connect the equipment into an outlet on a circuit different from that to which the receiver is connected Consult the dealer or an experienced radio TV technician for help This device complies with Part 15 of the FCC Rules Operation is subject to th...

Page 4: ...t Numbers_______________________________________________________11 3 Using DeviceInstaller 12 Accessing WiPort NR Embedded Device Server Using DeviceInstaller Utility ________12 Viewing the WiPort NR Current Configuration _________________________________12 4 Configuration Using Web Manager 15 Accessing WiPort NR Web Manager Using DeviceInstaller Application _____________15 Network Configuration _...

Page 5: ..._________________________________________________45 Remote Port________________________________________________________45 DisConnMode ______________________________________________________45 Flush Mode ________________________________________________________46 DisConnTime Inactivity Timeout _______________________________________48 SendChar 1 and SendChar 2_________________________________________...

Page 6: ...__________________________________________________55 Security Settings ____________________________________________________56 Email Settings ______________________________________________________56 Exit Configuration Mode __________________________________________________56 6 Configurable Pins 57 Defaults Settings ____________________________________________________57 Features ____________________...

Page 7: ... as port and server properties 5 Configuration via Serial Mode or Telnet Port 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 Provides instructions for configuring the eleven General Purpose I O pi...

Page 8: ...ation for the latest documentation and the following 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 about the WiPort NR hardware and integrating the WiPort NR device server into another product ...

Page 9: ...wser resulting in interactive Web pages This customization of HTML Web pages and configuration screens tailors the WiPort NR module to fit unique requirements Capabilities The WiPort NR device server has the following capabilities Communication between TCP and UDP to serial Ethernet interface Email notification of configurable alarms and events Upgradeable firmware SNMP monitoring Connects devices...

Page 10: ...Web Manager Through a web interface configure the WiPort NR embedded device server and its settings using the WiPort NR 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 Configurati...

Page 11: ...net 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 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 7 Reserved Port Numbers ...

Page 12: ...spond to the installation wizard prompts If prompted to select an installation type select Typical Click Start All Programs Lantronix DeviceInstaller 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 Viewing the ...

Page 13: ...on configurable field Displays the WiPort NR current IP address To change the IP address see 4 Configuration Using Web Manager or 5 Configuration via Serial Mode or Telnet Port IP Address was Obtained Displays Dynamically if the device automatically received an IP address e g from DHCP Displays Statically if the IP address was configured manually If the IP address was assigned dynamically the foll...

Page 14: ...figurable Pins Non configurable field The WiPort NR embedded device server supports configurable pins Supports Email Triggers Non configurable field WiPort NR device supports email triggers Supports AES Data Stream Non configurable field Displays True if the WiPort NR unit supports AES encryption Supports 485 Non configurable field WiPort NR embedded device server supports the RS 485 protocol Supp...

Page 15: ...ller see 3 Using DeviceInstaller 1 Run DeviceInstaller and search for the list of available Lantronix device servers 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 5 To open the Web...

Page 16: ...a static IP address if preferred Figure 4 2 Network Settings Automatic IP Address Configuration To assign an IP address and its network configuration automatically 1 Click Network from the main menu 2 Select Obtain IP address automatically 3 Enter the following as necessary BOOTP Select Enable to permit the Bootstrap Protocol BOOTP The BOOTP server automatically assigns the IP address from a pool ...

Page 17: ...e host part Default Gateway The gateway address or router allows communication to other LAN segments The gateway address should be the IP address of the router connected to the same LAN segment as the unit The gateway address must be within the local network DNS Server The DNS server allows the name of a remote machine to be resolved automatically Enter the IP address of the DNS server If the devi...

Page 18: ...ings 1 Click Server from the main menu 2 Configure or modify the following fields Server Configuration Enhanced Password Note We recommend that you always enable the enhanced password setting and create a strong 16 character password Select whether to enable enhanced password Enable selecting this option enables advanced password creation allowing you to create passwords up to 16 bytes in length D...

Page 19: ...ular HTTP Server Port This option allows the configuration of the web server port number The valid range is 1 65535 The default HTTP server port number is 80 Config Server Port Not applicable for this product MTU Size The Maximum Transmission Unit MTU is the largest physical packet size a network can transmit for TCP and UDP Enter between 512 and 1400 bytes The default is 1400 bytes TCP Re transmi...

Page 20: ... seconds the WiPort NR module should abandon attempting a connection to the host list Host Information Host Address Enter or modify the host IP address Port Enter the target port number 3 Click the OK button when finished 4 On the main menu click Apply Settings Channel 1 and Channel 2 Configuration Channel 1 and Channel 2 configurations define how the serial ports respond to network and serial com...

Page 21: ...he pull down menu for the selected channel Flow Control Flow control manages data flow between devices in a network to ensure it is processed efficiently Too much data arriving before a device is prepared to manage it causes lost or retransmitted data 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 a...

Page 22: ...ule the end of the data collection Match Bytes Use to indicate the end of a series of data to be sent as one group Set this value to 00 if specific functions are not needed Send Frame Immediate After the detection of the byte sequence indicates whether to send the data frame or the entire buffer Select Yes to send only the data frame Send Trailing Bytes Select the number of bytes to send after the...

Page 23: ...n 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 Figure 4 6 TCP Connection Settings Connect Mode Passive Connection Accept Incoming Select Yes to accept incoming connections Password Required Determines whether a password is required for an incoming passive connection Field is not availab...

Page 24: ... field Modem Mode Indicates the on screen response type when in Modem Mode if Modem Mode is enabled Show IP After RING Indicates whether to display the remote IP address upon connection The default setting is Yes Endpoint Configuration Local Port Enter the local port number Auto increment for active connect Select to auto increment the local port number for new outgoing connections The range of au...

Page 25: ...ction closes even if the remote site does not acknowledge the disconnect request Check EOT Ctrl D Choose Yes to drop the connection when Ctrl D or Hex 04 is detected 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 Inactivity Timeout Use this parameter to set an inactivity timeout...

Page 26: ...figuration Local Port Enter the local port number Remote Port Enter the port number of the remote device Remote Host Enter the IP address of the remote device Use Broadcast Select to broadcast the UDP datagram Datagrams of type 01 can be sent as a broadcast by enabling this option The default is not to broadcast Note Datagrams are sent as subnet directed broadcasts Device Address Table Fields are ...

Page 27: ...ort NR email settings 1 From the main menu select Email to open the Email Settings window Figure 4 8 Email Settings 2 Configure the following fields Server IP Address Enter the IP address of the mail server Server Port 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 me...

Page 28: ...rigger 1 Trigger 2 or Trigger 3 to configure the desired Trigger settings The Email Trigger Settings page opens Figure 4 9 Email Trigger Settings 2 Configure the following fields Conditions Configurable Pins Select the condition from the pull down menu for the configurable pins Repeat for each Trigger Input field Enable Serial Trigger Input When selected specified serial communications count as a ...

Page 29: ... 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 To configure the WiPort NR OEM Configurable Pins 1 Click Configurable Pins from the main menu to...

Page 30: ...rors and configurations RS485 Select Selects between RS 232 and RS 485 line drivers RS485 2 Wire Selects 2 wire line drivers Usable as a half full duplex selector RS485 4 Wire Selects 4 wire line drivers Reset to Defaults Ethernet Asserting during bootup for at least 7 seconds resets the configuration back to factory default Used when network access is impossible because of improper configuration ...

Page 31: ...vice Not all devices display information in the same manner Accessing Setup Mode Telnet Access Note Alternatively use DeviceInstaller to access Telnet Select the device from the main window list and click the Telnet Configuration tab in the right window If using Telnet from the DeviceInstaller toolbar skip steps 1 through 3 To configure the unit over the network establish a Telnet connection to po...

Page 32: ...boots Serial Port Access To configure the unit through a serial connection 1 Connect a console terminal or PC running a terminal emulation program to your unit s serial port 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 th...

Page 33: ... Server configuration menu Set the IP Address If DHCP is not used to assign IP addresses enter it manually The IP address must be set to a unique value in the network Enter each octet and press Enter between each section inputted The current value is displayed in parentheses IP Address 000 000 000 000 _ Set the Gateway IP Address The gateway address or router allows communication to other LAN segm...

Page 34: ...select Y to enable Telnet Web Manager password Enable the enhanced password setting and create a strong 16 character password For details see Security Settings on page 51 Note We do not recommend that you only use the 4 character basic password as it does not offer sufficient security Using no password is very dangerous Change Telnet Web Manager password N _ DHCP Name If a DHCP server has automati...

Page 35: ... of 0 and 2 This is the most common setting when using DHCP Channel 1 and Channel 2 Configuration Select option 1 Channel 1 or 2 Channel 2 from the Change Setup menu to define how the serial port responds to network and serial communications The following sections describe the configurable parameters within the Channel configuration menu Table 5 3 Serial and Telnet Port Parameters Baudrate 9600 I ...

Page 36: ... 4 Interface Mode Options I F Mode Option 7 6 5 4 3 2 1 0 RS 232 1 0 0 RS 422 4 wire 0 1 RS 485 2 wire 1 1 7 Bit 1 0 8 Bit 1 1 No Parity 0 0 Even Parity 1 1 Odd Parity 0 1 1 stop bit 0 1 2 stop bits 1 1 1 1 2 stop bits are implemented by the software This might influence performance The following table demonstrates some common I F Mode settings Table 5 5 Common Interface Mode Settings Common I F M...

Page 37: ...except for the following reserved port numbers Table 5 7 Reserved Port Numbers Port Numbers Reserved for 1 1024 Reserved 9999 Telnet setup 14000 14009 Reserved for Redirector 30704 Reserved 77F0h 30718 Reserved 77FEh Note It is recommended to not use the reserved port numbers for this setting as incorrect operation may result Use Port 0 for the outgoing local port to change with each connection Th...

Page 38: ... start character 0 0 1 1 Manual connection 0 1 0 0 Autostart 0 1 0 1 Hostlist 0 0 1 0 d Datagram Type Directed UDP 1 1 0 0 e Modem Mode No Echo 0 0 1 1 Echo Modem Response Numeric 0 1 1 1 1 Echo Modem Response Verbose 0 1 1 1 0 Modem Response Only Numeric 0 0 1 1 1 1 Modem Response Only Verbose 0 0 1 1 1 0 Incoming Connection Never Accept Incoming Rejects all external connection attempts Accept wi...

Page 39: ...ll or partial destination IP address and can include a destination port number The IP address must be in standard dot decimal notation and may be a partial address representing the least significant 1 2 or 3 bytes of the remote IP address The period is required between each pair of IP address numbers If present the port number must follow the IP address must be presented as a decimal number in the...

Page 40: ...elnet Port WiPort NR Embedded Device Server User Guide 40 Command String Result if remote IP is 129 1 2 3 and remote port is 1234 C5 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 ...

Page 41: ...nd for Modem Mode The unit will not accept a data connection from a remote device when the hostlist option is enabled Figure 5 5 Hostlist Example Baudrate 9600 I F Mode 4C Flow 00 Port No 10001 ConnectMode C0 25 Hostlist No Entry Change Hostlist N Y 01 IP address 000 172 000 19 000 0 000 1 Port 0 23 02 IP address 000 172 000 19 000 0 000 2 Port 0 3001 03 IP address 000 172 000 19 000 0 000 3 Port ...

Page 42: ... connected to a remote machine A user must dial from the local PC to the remote machine accumulating phone charges for each connection Modem Mode allows you to replace modems with WiPort NR embedded device servers and to use an Ethernet connection instead of a phone call By not having to change communications applications you avoid potentially expensive phone calls To select Modem Mode set the Con...

Page 43: ...ull Verbose option is in effect the unit responds to an unrecognized command string that is otherwise formatted correctly begins with AT and ends with carriage return with the OK message and takes no further action If the Numeric Response option is in effect the unit responds to an unrecognized command string that is otherwise formatted correctly with the OK message and takes no further action Whe...

Page 44: ...remote IP address and port settings to initiate a connection ATDx x x x Makes a connection to an IP address x x x x and the remote port number defined within the unit ATH Hangs up the connection Entered as ATH ATS0 n Enables or disables connections from the network going to the serial port n 0 disables the ability to make a connection from the network to the serial port n 1 9 enables the ability t...

Page 45: ...for the unit to make outgoing connections This parameter defines the port number on the target host to which a connection is attempted Remote Port 0 _ 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 Note This option is not displayed when Hostlist is enabled from the ConnectMode prompt see page ...

Page 46: ...the network 6 When modem_control_in transitions from a high state to a low state the network connection to or from the serial port drops Flush Mode The FlushMode buffer flushing parameter controls line handling and network buffers with connection startup and disconnect FlushMode 00 _ Select between two different packing algorithms the current configuration is displayed within the parentheses Avail...

Page 47: ... Sequence 1 Send Immediately After Send chars 1 Packing Interval Packing Interval defines how long the unit should wait before sending accumulated characters This wait period is between successive network segments containing data For alternate packing the default interval is 12 ms Trailing Characters In some applications CRC Checksum or other trailing characters follow the end of sequence characte...

Page 48: ... 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 Pack Control on page 47 Telnet Terminal Type This parameter displays only if the terminal type option is enabled in Disconnect Mode If this option is enabled use the terminal name for the Telnet terminal type Enter only one name If t...

Page 49: ...input2 A I X X Trigger input3 A I X X Message Priority L Min notification interval 1 s Re notification interval 0 s Mail Server Enter the IP address of the mail server Enter each 3 digit section and press Enter between each section inputted 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...

Page 50: ...isabled To change the configurable pins settings send setup records to Port 77FE The Message is the subject line of the trigger event Email to the specified recipient s The Priority is the priority level for the trigger even Email Enter L for normal priority or H for high priority The Minimum notification interval is the minimum time allowed between individual triggers If a trigger event occurs wi...

Page 51: ...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 0 Disable Monitor Mode Disables entry into Monitor Mode via the yyy or xx1 key sequence at startup This command prevents the unit from entering Monitor Mode by interpreting the stream of characters that are received during the device server s initialization at s...

Page 52: ...ex 3 10Mbit full duplex 4 100Mbit half duplex or 5 100Mbit full duplex Ethernet connection type 0 _ Security Settings Security settings can only be changed via the setup menu telnet or serial Caution It is recommended to set security over a dedicated network or over the serial setup to prevent eavesdropping Note To prevent any unauthorized access from the network disable the Telnet setup port 77FE...

Page 53: ...s to the N option Disable Web Setup N _ Disable ECHO Ports This setting controls whether port 7 echoes characters it receives Disable ECHO ports Y _ Enable Encryption Rijndael is the block cipher algorithm chosen by the National Institute of Science and Technology NIST as the Advanced Encryption Standard AES to be used by the US government The WiPort NR device supports 128 192 and 256 bit encrypti...

Page 54: ...tworking utilities tools scpr html Enable Enhanced Password The Enhanced Password setting allows you to set a password of up to 16 characters for protecting Telnet and Web Page access We recommend that you select the Y Yes option and enable the enhanced password setting Avoid using either the 4 character basic password setting or no password at all as they are not secure options Enable Enhanced Pa...

Page 55: ...her parameters 0 Channel 2 Configuration Baudrate 9600 I F Mode 4C 1 stop bit no parity 8 bit RS 232C no flow control Port No 10002 Connect Mode C0 always accept incoming connection no active connection startup Hostlist Retry Counter 3 Hostlist Retry Timeout 250 msec Send Character 0x0D CR All other parameters 0 Expert Settings TCP Keepalive 45 seconds ARP Cache Timeout 600 seconds CPU Performance...

Page 56: ... Yes Enable Encryption No Enable Enhanced password No Disable Port 77F0h No Email Settings Trigger Priority L Min notification interval 1 second All other parameters 0 e g Email notification and triggers are disabled Exit Configuration Mode To exit setup mode 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 memo...

Page 57: ... 32 GPIO for future products Function configuration can be retrieved Input or output selection can be retrieved and controlled Active low or high selection can be retrieved and controlled Active or inactive selection can be retrieved and controlled 77F0 can be disabled Every change of state active inactive requires a command over TCP or UDP and thus is not very fast If you use this port for data t...

Page 58: ... 16 23 24 31 When sending a command TCP and UDP wait for the response before sending the next command Commands Byte 0 Command Types 10h Get functions 11h Get directions input or output 12h Get active levels high active or low active 13h Get current states active or not active 19h Set directions 1Ah Set active levels 1Bh Set current states As you can see there is no Set functions command Since the ...

Page 59: ...nactive 0 means it is active high 3 3V when active 0V when inactive Command 13h Get Current States Send No parameters Response 1 parameter Bytes 1 4 States Bit X 1 means GPIO X is active 0 means it is inactive Command 19h Set Directions Send 2 parameters Bytes 1 4 Mask Bit X 1 means the direction for GPIO X will be updated with the value in the second parameter 0 means the direction for that GPIO ...

Page 60: ...with the value in the second parameter 0 means the state for that GPIO will not change Bytes 5 8 New States Bit X 1 means GPIO X will become active 0 means it will become inactive Response 1 parameter Bytes 1 4 Updated states Examples 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 00...

Page 61: ...h 00h 00h 00h Command details 1Bh command 1Bh 01h 00h 00h 00h the mask that determines which GPIOs will be changed bit 0 and 9 are 1 GPIO0 and GPIO9 will be changed bit 1 is 0 GPIO1 will remain the same 01h 00h 00h 00h the new states bit 0 is 1 GPIO0 will become 1 bit 1 is ignored since it is masked out bit 0 is 0 GPIO9 will become 0 Response details 1Bh response to command 1Bh 01h 00h 00h 00h bit...

Page 62: ...twork connections A 0 prompt indicates that you have successfully entered Monitor Mode Entering Monitor Mode via the Network Port To enter Monitor Mode using a Telnet connection 1 Establish a Telnet session to the configuration port 9999 The following message appears MAC address 00204AFFFF30 Software version V6 9 0 4 130628 Press Enter for Setup Mode 2 Type M upper case A 0 prompt indicates that y...

Page 63: ... byte MAC SS Set Security record Sets the Security record without the encryption key and length parameters The entire record must still be written but the encryption specific bytes do not need to be provided they can be null since they are not overwritten NS Network Status Reports the network interfaces statuses Includes potentially negotiated parameters like speed duplex for Ethernet or BSSID enc...

Page 64: ...ring 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 Wrong parameter s 9 Invalid command ...

Page 65: ...6904 rom fpt_webm_2004 cob Please refer to the DeviceInstaller Online Help for information about reloading firmware using DeviceInstaller The other methods are discussed below Using TFTP Graphical User Interface To download new firmware from a computer 1 Use a TFTP client to put a binary file to the unit ROM to upgrade the unit s internal operational code and COB to upgrade its internal Web interf...

Page 66: ...92 168 1 111 put fpt_6904 rom FX tftp i 192 168 1 111 put fpt_webm_2004 cob WEB1 Recovering the Firmware Using the Serial Port If for some reason the firmware is damaged you can recover the firmware file by using the serial port to download the ROM file 1 Start DeviceInstaller 2 From the Tools menu select Advanced Recover Firmware The Recover Firmware window displays 3 Enter the com port on your P...

Page 67: ... 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 Rijndael is the block cipher algorithm chosen by the National Institute of Science and Technology NIST as the Advanced Encryption Standard AES to be used by the US government ...

Page 68: ...t your unit s IP address is unique When troubleshooting the following problems make sure that the WiPort NR embedded device server is powered up Confirm that you are using a good network connection Diagnostic LED States Condition Diagnostic LED Channel 1 Status LED No Errors OFF N A Firmware storage checksum error ON Blink 1x 4 seconds RAM error ON Blink 2x 4 seconds Network controller error ON Bl...

Page 69: ... Enter to go into Setup Mode message When you Telnet to port 1 to assign an IP address to the device server the Telnet window does not respond for a long time You may have entered the Ethernet address incorrectly with the ARP command Confirm that the Ethernet address that you entered with the ARP command is correct The Ethernet address may only include numbers 0 9 and letters A F In Windows and us...

Page 70: ...e The issue is most likely something covered in the previous problem or possibly you have Caps Lock on Double check everything in the problem above Confirm that Caps Lock is not on You can ping the device server but not Telnet to the device server on port 9999 There may be an IP address conflict on your network You are not Telneting to port 9999 The Telnet configuration port 9999 is disabled withi...

Page 71: ...has been configured for LED1 functionality If the state of CP1 is blinking consistently or is completely off then there is a good socket connection If the state of CP1 is low use the Connect Mode option C0 for making a connection to the device server from the network 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 in...

Page 72: ...ort services and product documentation To contact technical support or sales look up your local office at http www lantronix com about contact html When you report a problem please provide the following information Your name company name address and phone number Lantronix product and model number Lantronix MAC number or serial number Firmware version and current configuration Description of the pr...