User guide - Ser_Ip

Purpose

Transform an ASCII equipement using a serial port into a network equipment (TCP/IP)

A client or server application; 

An open way to TCP/IP network; 

See : http://members.wbs.net/homepages/i/n/t/intbobqcenfrancais/index.html

Required hardware

*null* modem and RS-232 cable for connection between ASCII equipment and computer running Ser_Ip.

Required software

Visual Basic 5.0 RUNTIME must be present on computer running Ser_Ip application.

Ser_Ip installation

1- Unzip Ser_Ip compressed file in a working directory. Note : as I use a french version of Visual Basic, the standard install wizard is in french, you can replace this by english version in unzipping, on the same directory, VbSetUp.zip contained in the Ser_Ip compressed file.  This unzip action replace french Setup programs on this working directory. 
2- Run Setup program et follow installation instruction provided by "installation Wizard". 
3- Select usage mode and language of Ser_Ip.  This can be done from "File menu" under "Basic configuration option".  
4- At initialisation of Ser_Ip, the usage mode is visible in the title section of the application.
5- You are now able to customise your Ser_Ip application depending on your needs.

Parameters explanation.

Menu of Ser_Ip Start-Up and configuration :
File menu contain thoses selections :
	'Basic configuration', whose give you the ability to specify mode of operation and language in usage.
	'Execution on start-up' which is a toggle option.  In cheching it, Ser_Ip will be start in running mode directly at the next start-up.  This option is available too in the running mode panel.
	'Terminate application', self explanatory.

"Serial port" button
This button open a window where the user can custom serial port caracteristics.
Comport :	1 to 8
Parity:	often "N"
Data bits:	often "8"
Stop bits:	often "1"
Speed:	selection in combo box, from 300bps to 56kbps.
Application:used as documentation reference for the user.
Connection
protocol:	Value is"NONE" or "HAYES".
		Selecting HAYES specify that Ser_Ip application respond to 
		Hayes	commands send by the ASCII equipement before exchanging 
		data over TCP/IP network.

"TCP/IP -Client" button (depending on usage mode selected)
In client mode, the application Ser_Ip does requests of connection to host in listen mode (server mode).

The Ser_Ip client customisation window is used to specify host and service listening for connection of Ser_Ip client.

You can specify more than one destination IP address. To add an IP address, use the "Add" button and specify address in "xxx.xxx.xxx.xxx" format, the listening service of the previous address and the application field (not used by Ser_Ip but used as documentation reference).  To complete the inscription of the IP address, click on "Confirm change" button.

To update IP address defined, click on "Update" button, select IP address to modify or suppress, do the change and click on "Confirm change" or "Delete this entry" depending on the action required.

"TCP/IP - Server" button (depending on usage mode selected)

In Ser_Ip server mode, the application can receive one connection from another host on TCP/IP network.  In fact, the service port specified is in listen mode for only one host.

Clicking the above button, open a window which permit to specify the service port of the Ser-Ip running host listening for connection.  Pay attention to standard service number used by manufacturers and Internet.

"Serial port protocole" button.

Often two application use a specialised protocol for bi-directionnal transmission.  They use begin and trailer bytes to packetize all frames transmitted.  In some case, the trailer bytes can be followed by some bytes used for integrity validation or else.  The window presented in clicking the above button offer the ability to custom the flow of frames between ASCII equipement and Ser_Ip application before sending frames over the TCP/IP network.

Example:

An ASCII equipment connected to Ser_Ip running computer send always ASCII value decimal  03 and decimal 01 followed by two bytes of CRC check a the end of each frames.  Moreover, the ASCII serial port is very slow and takes near of 1/2 second to complete the transmission.  In this case, the serial port protocol could be customised like this:

Caracter(s) of frame ending:				03;01
Number of caracter(s) following frame end:	2
Wait time for end of frame:				500

--------------------------------------------------------------------------------

At the end of customisation, you can active Ser_Ip application in "running mode". This activation open a window showing the serial port and IP address caracteristics.

You have Tx and Rx counts showing the number of frames tranmitted between ASCII equipement and Ser_Ip application and between Ser_Ip application and TCP/IP host.


*****************************
* Ser_Ip is usefull for you *
*****************************

Send a payment of 25$ CAN for each permanent license needed.  I will send you an authorization file to install on your Ser_Ip directory.
  
Send your payment and your eMail address to:

	R. Laflamme
	Plante Street
	St-Redempteur (Qc)
	Canada
	G6K 1K4.

Please indicate the number of license needed.



