Documenti di Didattica
Documenti di Professioni
Documenti di Cultura
Manual
Content
Overview ............................................................................................... 6
2.1
2.2
Installation ........................................................................................... 11
4.1
4.2
4.3
Overview ........................................................................................................... 18
5.2
Info ......................................................................................................... 19
Service .................................................................................................... 19
Error ........................................................................................................ 20
Configuration .......................................................................................... 20
Log ......................................................................................................... 20
Virtual COM Ports .................................................................................. 21
Commissioning .................................................................................... 23
6.1
6.2
Aug-16
Overview .................................................................................................. 6
Functions .................................................................................................. 7
Summary .......................................................................................................... 26
Uninstalling .......................................................................................... 34
10
Index.................................................................................................... 35
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.
Overview
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
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
Overview
2.1.2 Functions
Overview
Component
Function
VCom service
Interface
2.2
Installation Requirements
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.
Overview
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.
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.
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.
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
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.
3.
You have downloaded the installation file of the INSYS VCom 4.x software.
1.
Open the directory where the installation file is located and doubleclick the installation file.
2.
Select the desired installation language from the drop-down list and
click on OK .
3.
4.
5.
Specify a destination folder for the installation and click on Next > .
6.
7.
Installation
8.
Enter the TCP port into the "TCP Port" entry field.
9.
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.
Installation
You have installed the INSYS VCom 4.x software successfully on your
computer with this.
13
Installation
4.2
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
Installation directory
4.3
Installation
2.
3.
Double-click "Services".
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
2.
3.
16
If the "VCom Server" service returns its version, you have installed
INSYS VCom 4.x successfully.
Installation
2.
If required, start the service using the Start button in the "Service"
panel.
17
5.1
Overview
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
5.2
5.2.1 Info
A help text to the control element actually being under the mouse pointer is
displayed here.
5.2.2 Service
19
5.2.3 Error
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
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
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
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
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).
1.
2.
If required, start the VCom service using the Start button in the
"Service" panel.
3.
4.
5.
Check the "Autodial" checkbox and enter IP address and port of the
INSYS GPRS 5.x serial.
6.
You have configured the INSYS VCom 4.x for an outgoing connection
to the INSYS GPRS 5.x serial with this.
23
Commissioning
7.
8.
Check on the "Serial/VCom" tab in the "Virtual COM Port" panel the
"Authentication on incoming TCP connection" checkbox.
9.
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
Incoming Connection
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).
1.
24
2.
If required, start the VCom service using the Start button in the
"Service" panel.
3.
Commissioning
4.
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?.
7.
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.
25
AT Command Reference
AT Command Reference
7.1
Summary
Description
ATD<IP Ad-
dress>:<Port>
or
ATD<Domain
Example:
Name>:<Port>
AT&D<n>
ATE<n>
ATH
AT&D0
AT&D1
Enabling/disabling echo
ATE0
ATE1
ATI<n>
26
AT Command Reference
Command
Description
AT&K<n>
ATO
AT&K0
AT&K3
AT&K4
<Pause>+++
ATQ<n>
ATV<n>
ATQ1
ATV1
27
AT Command Reference
Command
Description
ATX<n>
AT**STATUS?
ATX0
ATX1
ATX2
ATX3
ATX4
28
AT Command Reference
Command
Description
AT**SYSTEM?
29
You will see an example for a configuration file of the VCom service in the
following.
<?xml version="1.0" encoding="utf-8"?>
<vcom>
<configuration>
<app app_code="VCOM_SERVER_v4.2.0"
keepaliveinterval="1" tcp_listen_port="2345" udp_listen_port="2345"
remoting_port="9000" mtu= magic_key="lmr" MAX_RSREC_BUFFER="128"
MAX_TCPREC_BUFFER="512" SerialReadDelay="1" TcpReadDelay="3" />
<port name="COM9" id="" autodial="192.168.200.123:1234" keyabort=false
blocksize="10" connonclosedport_in="true" connonclosedport_out="false"
keeptcpwhenconnected="false" disconnonclosedport="false"
cmdmonincomingconn="false" leasedline="false" keepalive="false"
response="true" echo="true" baurate="" allowoutgoing="true"
allowincoming="false" authincoming="udp" authoutgoing="udp"
disablemodememulation="false" />
</configuration>
</vcom>
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
tcp_listen_port
app
UInt
udp_listen_port
app
UInt
remoting_port
app
UInt
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.
Parameter
Section
Type
Meaning
name
port
String
id
port
String
autodial
port
String
<IP address>|<domain>:<port>
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
connonclosedport_in
port
Bool
connonclosedport_out
port
Bool
keeptcpwhenconnected
port
Bool
disconnonclosedport
port
Bool
31
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
keepalive
port
Bool
response
port
Bool
echo
port
Bool
Parameter
Section
Type
Meaning
allowoutgoing
port
Bool
allowincoming
port
Bool
authincoming
port
String
authoutgoing
port
String
disablemodememulation
port
Bool
33
Uninstalling
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.
1.
2.
3.
34
10
Index
Index
35