Transcript
INSYS VCom® 4.x
Manual
Virtual COM Port
Copyright © August 2016 INSYS MICROELECTRONICS GmbH Any duplication of this manual is prohibited. All rights on this documentation and the devices are with INSYS MICROELECTRONICS GmbH Regensburg. Trademarks The use of a trademark not shown below is not an indication that it is freely available for use. MNP is a registered trademark of Microcom Inc. IBM PC, AT, XT are registered trademarks of International Business Machine Corporation. INSYS®, VCom®, e-Mobility LSG® and e-Mobility PLC® are registered trademarks of INSYS MICROELECTRONICS GmbH. Windows™ is a registered trademark of Microsoft Corporation. Linux is a registered trademark of Linus Torvalds. Publisher: INSYS MICROELECTRONICS GmbH Hermann-Köhl-Str. 22 D-93049 Regensburg, Germany Phone: +49 941 58692 0 Fax: +49 941 58692 45 E-mail:
[email protected] Internet: http://www.insys-icom.com Date: Aug-16 Item: 10001096 Version: 1.3 Language: EN
Content
1
General Information ............................................................................... 5
2
Overview ............................................................................................... 6 2.1
Function Overview .............................................................................................. 6 2.1.1 2.1.2
2.2
Installation Requirements .................................................................................... 8 2.2.1 2.2.2 2.2.3
Meaning of the Symbols and the Formatting in this Manual ................. 10
4
Installation ........................................................................................... 11 4.1
Installation Process ........................................................................................... 11
4.2
Installed Files .................................................................................................... 14
4.3
Result of the Installation .................................................................................... 15
Short Description of the User Interface ................................................ 18 5.1
Overview ........................................................................................................... 18
5.2
Description of the User Interface Areas ............................................................. 19 5.2.1 5.2.2 5.2.3 5.2.4 5.2.5 5.2.6
6
7
Info ......................................................................................................... 19 Service .................................................................................................... 19 Error ........................................................................................................ 20 Configuration .......................................................................................... 20 Log ......................................................................................................... 20 Virtual COM Ports .................................................................................. 21
Commissioning .................................................................................... 23 6.1
Outgoing Connection ........................................................................................ 23
6.2
Incoming Connection ........................................................................................ 24
AT Command Reference ...................................................................... 26 7.1
Aug-16
Supported Operating System ................................................................... 8 Firewall Configuration .............................................................................. 9 User Rights ............................................................................................... 9
3
5
4
Overview .................................................................................................. 6 Functions .................................................................................................. 7
Summary .......................................................................................................... 26
8
Structure of the Configuration File ....................................................... 30
9
Uninstalling .......................................................................................... 34
10
Index.................................................................................................... 35
INSYS VCom® 4.x
1
General Information
General Information
The present user manual applies for the Windows software INSYS VCom® 4.x from version 4.3.0. The user manual is directed to technical personnel, especially programmers and commissioning technicians. General knowledge of communication technology is required to understand.
5
Overview
2
INSYS VCom® 4.x
Overview
The virtual COM port driver INSYS VCom® 4.x is a software enables to replace serial communication with IP-based communication without modifying the PC application. INSYS VCom® 4.x has especially been developed for the use in connection with the following INSYS products:
2.1
INSYS Ethernet and i-modul Ethernet INSYS WLAN serial and i-modul WLAN serial INSYS GPRS/EDGE 5.x serial and i-modul GPRS/EDGE 3.x serial MoRoS 2.1 / 2.2, MLR 3G 2.0 and IMON fault monitor INSYS SDSL 1.x MRX equipped with MRXcard SI
Function Overview
2.1.1 Overview
The virtual COM port driver INSYS VCom® 4.x simulates a serial interface at the PC. The data that are sent to this serial interface from any application will be forwarded to a connected INSYS IP device via a TCP/IP connection as if a serial connection would be present. This allows to bridge any distance via existing networks without having to modify existing systems (readout software, configuration software, etc.). The application does only "see" a usual modem connection or even a serial connection, but communicates via a TCP/IP network. The connection establishment can be initiated by the device or by the VCom® service with this. 6
INSYS VCom® 4.x
Overview
2.1.2 Functions
Windows applications that usually communicate directly via a COM interface or a remote data transmission modem, are now connected indirectly via COM interfaces that have been created by the virtual COM port driver INSYS VCom® 4.x. The COM port driver is connected to the VCom® service via the virtual serial bus driver. The service takes over the bidirectional conversion of serial data and TCP data streams. Connections can be established outgoing or incoming. The connection will be authenticated before via UDP or TCP. All system results will permanently be written to a log file. The VCom® configuration interface is connected to the service via a separate TCP port. The configuration program controls the status of the service and allows a comfortable adaptation of the server configuration file.
7
Overview
INSYS VCom® 4.x
Component
Function
VCom® service
Application runs as Windows service Up to 255 virtual COM ports configurable Dynamic creation and removal of virtual COM ports possible without restarting the computer Detailed log function for troubleshooting Support of AT commands
Interface
Incoming and outgoing TCP connections (also as leased line) possible Simple server administration via separate configuration program Display of log information Display of status information of the virtual COM port
2.2
Installation Requirements
2.2.1 Supported Operating System In principle, an operation is possible under the following operating systems: Windows 2000 SP5 Windows XP SP3 Windows 7 32/64-Bit Windows 8.1 32/64-Bit Windows 10 32/64-Bit Windows Server 2012 R2 In addition, Microsoft .NET Framework 2.0 must be installed.
Note Conflicts with virtual COM port drivers! Conflicts with other virtual COM port drivers may affect the operation. If virtual COM port drivers of INSYS or other manufacturers (Bluetooth, USB modem, etc.) are already installed on your computer, a proper operation cannot be ensured any more. It is therefore recommended to uninstall all other virtual COM port drivers before installing INSYS VCom® 4.x.
8
INSYS VCom® 4.x
Overview
2.2.2 Firewall Configuration The VCom® service installs itself as Windows service. To be able to accept incoming connections from INSYS devices, the firewall of the computer must be configured such that a TCP and/or UDP port are/is opened for incoming connections. To be able to configure the VCom® service using the graphical user interface, it is required to open another TCP port for incoming connections. The used ports are queried during the installation of the VCom® service and can be modified later using the graphical user interface.
2.2.3 User Rights The installation of the VCom® service requires administrator rights. The operation of the software is independent of the login of a user, because the application is installed as Windows service. You can configure the VCom® service such that the service will be activated automatically with system start without a certain user being logged on.
9
Meaning of Symbols and Formatting in this Manual
3
INSYS VCom® 4.x
Meaning of Symbols and Formatting in this Manual
This section describes the definition, formatting and symbols used in this manual. The various symbols are meant to help you read and find the information relevant to you. The following text is structured like a typical operating instruction of this manual. Bold print: This will tell you what the following steps will result in After that, there will be a detailed explanation why you could perform the following steps to be able to reach the objective indicated first. You can decide whether the section is relevant for you or not.
An arrow will indicate prerequisites which must be fulfilled to be able to process the subsequent steps in a meaningful way. You will also learn which software or which equipment you will need.
1.
One individual action step: This tells you what you need to do at this point. The steps are numbered for better orientation.
10
A result which you will receive after performing a step will be marked with a check mark. At this point, you can check if the previous steps were successful.
Additional information which you should consider are marked with a circled "i". At this point, we will indicate possible error sources and tell you how to avoid them.
Alternative results and steps are marked with an arrow. This will tell you how to reach the same results performing different steps, or what you could do if you didn't reach the expected results at this point.
INSYS VCom® 4.x
4
Installation
Installation This section explains how to install the INSYS VCom® 4.x software on your computer, into which directories the program data will be stored, and how you can test the successful installation.
4.1
Installation Process
Downloading the installation file How to download the installation file of the INSYS VCom® 4.x software.
You will need a computer with Internet connection or the Support CD.
1.
Open in the "Support and Downloads" menu the "Driver" page on the website (http://www.insys-icom.com/driver/) or Support CD.
2.
Right-click in the "Virtual COM Port" section onto the "VComSetup" file and select "Save target as…" in the context menu.
3.
Save the file on your computer.
You have downloaded the installation file successfully with this.
Installing INSYS VCom® 4.x How to install the INSYS VCom® 4.x software on your computer.
You have downloaded the installation file of the INSYS VCom® 4.x software.
The installation requirements (see page 8) are fulfilled.
1.
Open the directory where the installation file is located and doubleclick the installation file.
A Windows Vista or Windows 7 computer may require to right-click the installation file and select "Run as administrator" in the contexct menu.
2.
Select the desired installation language from the drop-down list and click on OK .
3.
Click in the Setup Wizard on Next > .
4.
Accept the license agreement and click on Next > .
5.
Specify a destination folder for the installation and click on Next > .
6.
Specify a start menu folder and click on Next > .
7.
Click Install to start the installation. 11
Installation
INSYS VCom® 4.x
8.
Enter the TCP port into the "TCP Port" entry field.
9.
A dialogue window for specifying TCP port, remote management port, and COM port appears.
A port must be entered here that is opened for incoming connections by your firewall or your router. It is important for the router configuration that the respective port is forwarded for both, UDP and TCP. The port entered here can still be changed later.
Enter the Remote management port into the "Remote Management Port" entry field.
This TCP port is only used for the internal communication between the VCom® service and the user interface and can be adjusted, if the default port is already used by another application.
10. Enter the designation of the first virtual COM port into the "Name of initial virtual COM Port" entry field.
You can enter the port designation here, for which a virtual COM port will be created after installation when starting the service. You can change this port later or add further ports; however, for the start of the VCom® service, it is necessary that at least one virtual COM port is created.
11. Click on Next > . 12
INSYS VCom® 4.x
Installation
12. Confirm the message about the successful driver installation with OK . 13. Click Finish to complete the installation.
You have installed the INSYS VCom® 4.x software successfully on your computer with this.
13
Installation
4.2
INSYS VCom® 4.x
Installed Files
Several files will be copied to the hard drive and settings will be made in the system registry during installation. The following table shows the installed files with storage location and function. File Storage location Description Vsb.inf
\WINDOWS\SYSTEM32
Vsb.sys Vsbsetup.exe
\WINDOWS\SYSTEM32\drivers Installation directory
Vserial.inf
\WINDOWS\SYSTEM32
Vserial.sys
\WINDOWS\SYSTEM32\drivers Installation directory
VSPort.dll
VCOM_Server.exe Installation directory VCOM_Server.exe.con- Installation directory fig VCOMServer.conf Installation directory
14
VcomConf.exe VcomConf.exe.config
Installation directory Installation directory
Logfile.txt
Installation directory
Unins000.exe
Installation directory
Further DLLs and language files
Installation directory
.INF file, necessary for the installation of the virtual serial bus device driver Virtual serial bus device driver Application for installing and registering the device drivers in the operating system .INF file, necessary for the installation of the virtual serial port device driver Virtual serial port device driver Virtual serial port ActiveX control VCom® Server service Configuration of the log function of the service Main configuration file of the VCom® service User interface Configuration of the user interface Log file of the VCom® service Uninstallation of the VCom® service
INSYS VCom® 4.x
4.3
Installation
Result of the Installation
You can verify the success of the installation in different ways. Displaying the Windows services How to display the Windows services to verify a successful installation. 1.
Select Start Control Panel.
2.
Double-click "Administrative Tools".
3.
Double-click "Services".
The "Services" window is displayed.
If the "VCom Server" service is displayed, you have installed INSYS VCom® 4.x successfully.
If you double-click the "VCom Server“ service, you can configure the service such that it starts automatically when starting the computer by selecting the "Automatic" startup type.
15
Installation
INSYS VCom® 4.x
Checking the virtual COM port access How to check the access to the virtual COM port. 1.
Open a terminal program, like PuTTY.
2.
Connect to the configured COM port.
3.
Enter ati and confirm with the Enter key.
16
If the "VCom Server" service returns its version, you have installed INSYS VCom® 4.x successfully.
INSYS VCom® 4.x
Installation
Checking the operation via user interface How to check the status of the VCom® service using the user interface. 1.
Select Start All programs INSYS VCom VComConfiguration.
2.
The INSYS VCom® 4.x user interface is displayed.
If required, start the service using the Start button in the "Service" panel.
If "Running" is displayed as status of the service, you have installed INSYS VCom® 4.x successfully.
17
Short Description of the User Interface
5
Short Description of the User Interface
5.1
Overview
INSYS VCom® 4.x
The most important settings of the VCom® service can be made comfortably via the user interface. The user interface identifies the configuration file settings via the VCom® service. Changes of the configuration can be made via the user interface. The new configuration will be stored as a file (VcomServer.conf_tmp) in the installation directory of the server after saving. When the server is started the next time, it will be checked, whether a new configuration is present, and, if yes, this will be loaded. The modified old configuration will be saved as VcomServer.conf_old. The user interface is divided into different areas with different functions.
The individual areas of the user interface and their function is explained in detail in the following.
18
INSYS VCom® 4.x
5.2
Short Description of the User Interface
Description of the User Interface Areas
5.2.1 Info
A help text to the control element actually being under the mouse pointer is displayed here.
5.2.2 Service
The current status of the VCom® service is displayed here: Stopped: The VCom® service is currently not active. It can be started using the Start button. Start Pending: The VCom® service is being started. Running: The VCom® service is currently running. It can be stopped using the Stop button. Stop Pending: The VCom® service is being stopped. The current status of the VCom® service can be retrieved manually using the Refresh button.
19
Short Description of the User Interface
INSYS VCom® 4.x
5.2.3 Error
Possible errors of the VCom® service are displayed here.
5.2.4 Configuration
The loading condition of the configuration file is indicated here. If the configuration has been changed in the meantime, the area appears red and the current settings can be saved using the Save button. The current settings can be discarded using the Cancel button
5.2.5 Log
The content of the log file is displayed here. The display will be updated automatically.
20
INSYS VCom® 4.x
Short Description of the User Interface
5.2.6 Virtual COM Ports
All information and settings of the virtual COM ports are displayed here. All settings and their respective parameters in the configuration file are described in the following. 5.2.6.1 Tree View The already configured COM ports and their connection status are displayed here. Another virtual COM port can be created using the Add button. A selected virtual COM port can be deleted using the Delete button. The tree view be refreshed using the Refresh button. If the "Auto" checkbox is checked, the tree view will be refreshed automatically. 5.2.6.2 Server Settings The communication settings of the VCom® service can be configured here. The interval for the dispatch of keep alive messages in seconds can be specifed in the "Keep Alive Interval" field (parameter keepaliveinterval in the configuration file). The remote management IP address for the internal communication between VCom® service and user interface can be specified in the "Host" field.. The remote management port for the internal communication between VCom® service and user interface can be specified in the "Port" field (remoting_port). The TCP port used by the VCom® service for incoming connections can be specified in the "TCP" field under "Incoming Listenport" (tcp_listen_port). The UDP port used by the VCom® service for incoming connections can be specified in the "UDP" field (udp_listen_port). 21
Short Description of the User Interface
INSYS VCom® 4.x
5.2.6.3 General General settings for the selected virtual COM port can be made here. The designation of the virtual COM port can be selected in the "COM name" drop-down list field (name). If the "Disconnect TCP connection at DTR drop" checkbox is checked, an existing TCP connection will be disconnected, as soon as the DTR signal is disabled (disconnonclosedport). If the "TCP-Keep-Alive" checkbox is checked, a connection check using keep alive packets will be performed (keepalive). If the "Response" checkbox is checked, the VCom® service will send typical modem responses (liek OK, CONNECT, NO CARRIER, etc.) to the serial interface (response). If the "Echo" checkbox is checked, the VCom® service will issue a local echo (echo). If the "Keyabort" checkbox is checked, data at the serial interface during the connection establishment will lead to an abort (keyabort). 5.2.6.4 Outgoing connections The settings for outgoing connections can be made here. If the "Enable" checkbox is checked, outgoing connections will be allowed (allowoutgoing). If the "Autodial" checkbox is checked, an automatic connection establishment to a configured address can be made (autodial). The IP address for the automatic connection establishment can be entered into the "Target" field (autodial). The associated port can be entered into the "Port" field (autodial). If the "Leased Line"“ checkbox is checked, the VCom® service will automatically re-establish a connection upon a connection loss without being initiated again (leasedline). If the "Establish outgoing connection on closed port" checkbox is checked, an automatic connection establishment will be made directly upon start of the VCom® service (connonclosedport_out). The authentication protocol can be selected under "Authentication" using the "UDP" and "TCP" radiobuttons (authoutgoing). 5.2.6.5 Incoming connections The settings for incoming connections can be made here. If the "Enable" checkbox is checked, incoming connections can be accepted (allowincoming). A unique identifier (IMEI number or MAC address) cann be entered for every virtual COM port into the "COM ID" field (id). If the "Accept incoming connections on closed port" checkbox is checked, incoming connections can also be accepted in case of a closed COM port (connonclosedport_in). The authentication protocol can be selected under "Authentication" using the "UDP" and "TCP" radiobuttons (authincoming).
22
INSYS VCom® 4.x
6
Commissioning
Commissioning This section explains the connection establishment between a PC with INSYS VCom® 4.x and a PC with a connected INSYS GPRS 5.x serial as an example. The commissioning with other suitable communication devices from INSYS is performed in a similar way.
6.1
Outgoing Connection
Establishing an outgoing connection from PC1 How to establish an outgoing connection from a PC with INSYS VCom® 4.x to an INSYS GPRS 5.x serial.
The INSYS GPRS 5.x serial has been put into operation and the establishment of a test connection to the Internet from PC2 was successful (see respective user manual).
The VCom® service is installed on PC1.
1.
Open on PC1 the configuration interface via Start (All) Programs INSYS VCom VComConfiguration.
The INSYS VCom® 4.x user interface is displayed.
2.
If required, start the VCom® service using the Start button in the "Service" panel.
3.
Select a COM port in the tree view.
4.
Check in the "Outgoing connections" panel the "Enable" checkbox.
5.
Check the "Autodial" checkbox and enter IP address and port of the INSYS GPRS 5.x serial.
6.
Save your settings using the Save button.
You have configured the INSYS VCom® 4.x for an outgoing connection to the INSYS GPRS 5.x serial with this.
23
Commissioning
INSYS VCom® 4.x
7.
Open on PC2 HSComm GPRS via Start (All) Programs INSYS HSComm HSComm GPRS.
8.
Check on the "Serial/VCom" tab in the "Virtual COM Port" panel the "Authentication on incoming TCP connection" checkbox.
9.
Check on the "Connections" tab in the "Incoming" panel the "Activate GPRS and accept TCP/IP connections on port" checkbox and enter the port for accepting the connections into the following field.
10. Click on Send settings to transfer the settings to the INSYS GPRS 5.x serial. 11. Start on PC1 a terminal program and open the virtual COM port.
6.2
Opening the COM port establishes a connection to the INSYS GPRS 5.x serial. The successful connection establishment is indicated in the terminal program by the CONNECT message and in the configuration interface in the tree view and the log. You have established an outgoing connection from a PC with INSYS VCom® 4.x to an INSYS GPRS 5.x serial with this.
Incoming Connection
Establishing an incoming connection from PC1 How to establish an incoming connection to a PC with INSYS VCom® 4.x from an INSYS GPRS 5.x serial.
The INSYS GPRS 5.x serial has been put into operation and the establishment of a test connection to the Internet from PC2 was successful (see respective user manual).
The VCom® service is installed on PC1.
Incoming TCP and UDP connections can be accepted by PC1. If required, appropriate firewall/router settings must be made in advance. A port must be forwarded to PC1 by the Internet router for both, TCP and UDP.
1.
Open on PC1 the configuration interface via Start (All) Programs INSYS VCom VComConfiguration.
24
The INSYS VCom® 4.x user interface is displayed.
2.
If required, start the VCom® service using the Start button in the "Service" panel.
3.
Select a COM port in the tree view.
INSYS VCom® 4.x
Commissioning
4.
Check in the "Incoming connections" panel the "Enable" checkbox.
5.
Enter the IMEI of the INSYS GPRS 5.x serial into the "COM ID" field.
6.
The IMEI is on the housing label and can also be read out with AT**IMEI?.
Save your settings using the Save button.
You have configured the INSYS VCom® 4.x for an incoming connection from the INSYS GPRS 5.x serial with this.
7.
Open on PC2 HSComm GPRS via Start (All) Programs INSYS HSComm HSComm GPRS.
8.
Select on the "Serial/VCom" tab in the "Virtual COM Port" panel under "Authentication on outgoing TCP connection" the "Authentication via UDP" radiobutton.
9.
Check on the "Connections" tab in the "Outgoing (leased line)" panel under "Standard destination" the "AutoDial IP address" radiobutton.
10. Enter in the "AutoDial destinations" panel under "Standard destination" the IP address of PC1 into the "IP address" field and the port for accepting the connection into the "Port" field. 11. Click on Send settings to transfer the settings to the INSYS GPRS 5.x serial. 12. Click on Reset to restart the INSYS GPRS 5.x serial.
The INSYS GPRS 5.x serial establishes a connection to the specified destination after the restart. The successful connection establishment is indicated in the configuration interface in the tree view and the log. You have established an incoming connection to a PC with INSYS VCom® 4.x from an INSYS GPRS 5.x serial with this.
25
AT Command Reference
INSYS VCom® 4.x
7
AT Command Reference
7.1
Summary
INSYS VCom® 4.x supports the AT commands listed in the following. Command
Description
ATD
:
Remote terminal is an IP address:
or
The remote terminal is specified in the form IP number:port.
ATD““:
ATD192.168.1.23:2345 establishes a direct TCP connection (instead of period and colon, it is also possible to use comma and double comma, e.g. ATD192,168,1,23,,2345) ATD“www.google.de“:80 dials the domain www.Google.de on port 80 after resolving the name.
AT&D
Behaviour on DTR drop If the DTR line is disabled during an existing connection, the function specified by AT&D will be executed.
ATE
ATH
AT&D0
Ignore DTR drop (for operation with applications that do not use the DTR line).
AT&D1
A DTR drop causes the VCom® service to terminate the TCP connection.
Enabling/disabling echo ATE0
Incoming characters at the COM port will not be sent back again.
ATE1
Incoming characters at the COM port will be sent back again (default).
Establishing the TCP connection An existing TCP connection will be closed immediately. The command is only effective in AT command mode.
ATI
Displaying the device identification ATI
26
The version designation (e.g. VCOM_SERVER_v4.3.0) will be output.
INSYS VCom® 4.x
AT Command Reference
Command
Description
AT&K
Data flow control
ATO
AT&K0
No data flow control will be used.
AT&K3
Hardware data flow control RTS/CTS will be used (default).
AT&K4
Software data flow control will be used.
Changing to connection mode If the COM port is in online AT command mode, ATO will initiate the change to connection mode. Subsequently incoming data at the COM port will be transferred to the remote terminal.
+++
Changing to online AT command mode If the escape sequence +++ is entered after a pause of 1s within a period of 1s, the VCom® port will change from connection state to online AT command mode. All following data currently sent via the COM port will be interpreted as AT commands. Data that is sent by the remote terminal during online AT command mode, will be buffered and output after changing to connection mode.
ATQ
ATV
Enabling/disabling quiet mode ATQ0
The VCom® service sends typical modem responses to the serial interface (default).
ATQ1
The VCom® service does not send typical modem responses to the serial interface.
Format of modem messages ATV0
The modem messages will be sent in short form (only numbers) (default).
ATV1
The modem messages will be sent in long form (text) and the quiet mode will be disabled (ATQ0).
27
AT Command Reference
INSYS VCom® 4.x
Command
Description
ATX
Extended result messages and dial tone detection The command determines, which message group is sent to the serial interface by the VCom® service.
AT**STATUS?
ATX0
No detection of the dialling tone, i.e. an unsuccessful dialling attempt leads to the message NO CARRIER. No detection of the busy signal, i.e. when calling a busy line the message NO CARRIER. The message is displayed without specifying the speed.
ATX1
Like ATX0, but the CONNECT message contains the baud rate information
ATX2
Dialling tone detection is active, i.e. a dialling attempt without the presence of a dialling tone leads to the message NO DIALTONE. No detection of the busy signal, i.e. when calling a busy line the message NO CARRIER.
ATX3
No detection of the dialling tone, i.e. an unsuccessful dialling attempt leads to the message NO CARRIER. Busy signal detection active, i.e. when calling a busy line the message BUSY is displayed.
ATX4
Dialing tone detection is active, i.e. a dialing attempt without the presence of a dialing tone leads to the message NO DIALTONE (default). Busy signal detection active, i.e. when calling a busy line the message BUSY is displayed.
Outputting status information of the COM ports The configuration settings of the currently used COM ports will be output. Example: COMPort: COM9 Virtual COM identification: 0005B60007C3 Close TCP on DTR drop: False Keep Connection after ATD: False Accept TCP if COM is closed: True AT command mode at incoming connections: False Autodial: False Leased Line: False KeepAlive: False Target IP: Serial Read Delay 1 Tcp Read Delay 3
28
INSYS VCom® 4.x
AT Command Reference
Command
Description
AT**SYSTEM?
Outputting system status information Basic settings of the VCom® service and active connections will be output: Example: Number of Virtual Ports: 1 Port: COM9 ID: 0005B60007C3 Tcp listening port: 26862 Udp listening port: 2345 Remoting listening port: 9000 Udp authentication: true Number of ServerThreads: 0
29
Structure of the Configuration File
8
INSYS VCom® 4.x
Structure of the Configuration File
You will see an example for a configuration file of the VCom® service in the following.
30
Parameters in the configuration file that are not listed in the following table, are not to be changed.
Parameter
Section
Type
Meaning
app_code
app
String
Version designation
keepaliveinterval
app
UInt
Duration between two subsequent TCP keep alive packets in seconds
tcp_listen_port
app
UInt
TCP port for incoming connections
udp_listen_port
app
UInt
UDP port for incoming connections
remoting_port
app
UInt
TCP port for the communication with the user interface
magic_key
app
String
Internal parameter
MAX_RSREC_BUFFER
app
UInt
Application constant (applies for all virtual COM interfaces) that specifies how much bytes are read from the serial interface in one cycle.
MAX_TCPREC_BUFFER
app
UInt
Application constant (applies for all virtual COM interfaces) that specifies how much bytes are read from the TCP socket in one cycle.
SerialReadDelay
app
UInt
Application constant (applies for all virtual COM interfaces) that specifies the time between two data read processes from the serial interface in ms.
TcpReadDelay
app
UInt
Application constant (applies for all virtual COM interfaces) that specifies the time between two data read processes from a TCP socket connection in ms.
INSYS VCom® 4.x
Structure of the Configuration File
Parameter
Section
Type
Meaning
name
port
String
Name of the virtual COM port
id
port
String
Identifier of the virtual COM port that is used for the assignment to a certain port in acse of incoming connections.
autodial
port
String
|’’: A TCP connection to the specified destination will be established when opening the COM port. "false": Function is disabled. Note: If a domain name is used instead of an IP address, this must be enclosed in single inverted commas.
Examples: autodial="87.156.56.148:4567" autodial="’meineFirma.de’:4567" keyabort
port
Bool
"true": Data at the serial interface during connection establishment lead to an abort. "false": Data at the serial interface during connection establishment do not lead to an abort.
connonclosedport_in
port
Bool
"true": Incoming connections are also accepted if the COM port is closed. "false": Incoming connections are only accepted if the COM port is open.
connonclosedport_out
port
Bool
"true": Outgoing connections are also accepted if the COM port is closed. "false": Outgoing connections are only accepted if the COM port is open.
keeptcpwhenconnected
port
Bool
"true": En existing connection will not be stopped by an ATD command. ATD causes to exit the online AT command mode. "false": En existing connection will be stopped by an ATD command. It will be tried to establish a new connection to the specified destination.
disconnonclosedport
port
Bool
"true": Closing the COM port leads to a stop of a possibly active TCP connection. "false": A possibly active TCP connection will be maintained after closing the COM port.
31
Structure of the Configuration File
INSYS VCom® 4.x
Parameter
Section
Type
Meaning
cmdmonincomingconn
port
Bool
"true": It will not be changed to connection mode immediately in case of an incoming connection. Incoming serial data are interpreted as AT command until the AT command mode is left again via ATO or ATD. "false": It will immediately be changed to connection mode after an incoming TCP connection has been established. Incoming serial data will be transferred to the TCP remote terminal. Incoming data via TCP will be output serially.
leasedline
port
Bool
"true": The destination specified by autodial will immediately be contacted again after the connection has been lost. The parameter will only be evaluated, if autodial is not set to "false". "false": A connection loss does not lead to a new connection establishment of the server.
keepalive
port
Bool
"true": Keep alive packets are sent to the remote terminal via TCP to check the availability of the connection. If the keep alive packets are not answered, the connection will be closed by the server. The time between sending two keep alive packets can be set to any value by the Windows registry. Enter a new DWORD value "KeepAliveTime" for this1. The value of the key specifies then the time in ms. "false": No dispatch of keep alive packets to the remote terminal.
response
port
Bool
"true": The VCom® service sends typical modem responses to the serial interface. "false": The VCom service does not send typical modem res®ponses to the serial interface.
echo
port
Bool
"true": The VCom® service issues a local echo. "false": The VCom® service does not issue a local echo.
1
Registry path: HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters 32
INSYS VCom® 4.x
Structure of the Configuration File
Parameter
Section
Type
Meaning
allowoutgoing
port
Bool
"true": Establishing outgoing connections is permitted. "false": Establishing outgoing connections is not permitted.
allowincoming
port
Bool
"true": Accepting incoming connections is permitted. "false": Accepting incoming connections is not permitted.
authincoming
port
String
"udp": Incoming connections will be authenticated via UDP. "tcp": Incoming connections will be authenticated via TCP.
authoutgoing
port
String
"udp": Outgoing connections will be authenticated via UDP. "tcp": Outgoing connections will be authenticated via TCP.
disablemodememulation
port
Bool
"true": The modem emulation is disabled. The parameters keyabort and echo will be set to "false" and the parameter response will be set to "true" regardless of the parameter setting. "false": The modem emulation is enabled.
33
Uninstalling
9
INSYS VCom® 4.x
Uninstalling This section explains how to uninstall the INSYS VCom® 4.x software from your computer. Uninstalling INSYS VCom® 4.x How to uninstall the INSYS VCom® 4.x software from your computer.
INSYS VCom® 4.x is installed on your PC.
1.
Select Start All programs INSYSVCom Uninstall.
2.
Confirm the safety query with the OK button.
3.
Select the OK button to restart your computer.
34
A dialogue window appears and informs about the uninstallation process.
You have uninstalled INSYS VCom® 4.x successfully with this.
INSYS VCom® 4.x
10
Index
Index
Additional information ..................... 10 Alternative results ........................... 10 AT command ................................... 26 Authentication ................................. 22 Checkmark ...................................... 10 COM interface ................................... 7 COM port ........................................ 12 Commissioning ............................... 23 Configuration file ....................... 21, 30 Connection Establishment .............. 23 DTR signal ....................................... 22 Firewall ............................................ 12 Formatting ....................................... 10 Incoming Connection ...................... 24 Incoming connections ..................... 22 Installation file ................................. 11 IP-based communication................... 6 Leased line operation ...................... 22 Outgoing connection....................... 23
Outgoing connections ..................... 22 Port .................................................. 12 Prerequisites.................................... 10 Remote management port .............. 12 Router.............................................. 12 Serial interface .................................. 6 Support CD...................................... 11 Symbol ............................................ 10 TCP ............................................ 12, 22 TCP port ...................................... 9, 12 TCP/IP connection ............................. 6 UDP ........................................... 12, 22 UDP port ........................................... 9 User interface .................................. 18 VCom® service....................... 7, 12, 18 Virtual COM port ............................. 21 Virtual COM port driver ..................... 6 Windows 7 ...................................... 11 Windows Vista ................................ 11
35