File:   serialdr.txt
Author: Christian d'Heureuse


Inventec Serial Port Driver
===========================


How to use log files with the serial port driver
------------------------------------------------

The Inventec serial port driver includes a log file feature.
All data that is transmitted and received through the serial port
is written into the log file. The log file has a binary format.
The program DUMPCLOG.EXE is used to convert a binary log file
into an ASCII text file.

To activate the log file function, an environment variable (of the
operating system) must be set. If only a single serial port is open
at once, the variable COMLOG can be used. If multiple serial ports
are used at the same time in the same program, a separate log file
must be used for each serial port and the variable name must have
the form COMLOG_COMn, where <n> is the number of the serial port.

The environment variable contains the name of the binary log
file, followed by optional parameters. If the log file already
exists, new log data is appended to the existing file.

Examples to set environment variables for logging:
   SET COMLOG=temp.log
   SET COMLOG_COM1=temp1.log
   SET COMLOG_COM2=temp2.log TIMESTAMP(MSECS)
   SET COMLOG_COM3=temp3.log TIMESTAMP(DATETIME)

The parameter TIMESTAMP can be specified to include timestamps in
the log file. If TIMESTAMP(MSECS) is specified, each entry in the
log file is timestamped with the number of milliseconds passed
since the serial port has been opened. If TIMESTAMP(DATETIME) is
specified, each log file entry is associated with date and time.
