This readme file describes the use and risks of the programs in this directory.

Description:
The executable file, main.exe, in this directory is a Windows PC “frame simulator”
version of code which normally runs on the frame hardware.  By running this program 
on the same PC as the menu program, you can experiment with menu program options, 
and you can also load, modify and save configuration files without a connection to 
switcher hardware.

Installation:
Copy the main.exe program from this directory to a directory on a PC that has had the 
menu installed using the “Menu on PC” option of your switcher installation procedure.  
You may want to rename the file to something more meaningful such as “FrameSimulator.exe”
or “KalypsoSimulator.exe.”   It is suggested you also copy this readme.txt file to 
the same directory.

Usage:
Run the frame simulator. It will open up a command window that displays various messages 
from the frame simulator.  To exit the frame simulator, close this command window. 
Run the menu.  The menu will communicate with the frame simulator unless you change 
I.P. addresses for the menu / frame communications.
Grass Valley Thomson engineers expect that the main customer use of the frame simulator 
is to use the menu on a stand-alone PC to load, modify and save configuration files. 
A secondary use may be to navigate and experiment with various menu options.

Some actions, such as switching between SD and HD on a Duo system, or switching between 
suites and non-suites, require a reboot of the frame.  The menu will inform you when 
this is necessary.  When using a frame simulator, just close the frame simulator and 
restart it when you are asked to reboot the frame.

If you stop the frame simulator and restart a different frame simulator, you must also 
stop and restart the menu.

Caveats:
The frame simulator was developed as an internal tool developed by engineering at Grass 
Valley Thomson to allow software testing without access to switcher hardware.  It is 
not tested by our Quality Assurance department, and may have deficiencies.  The software 
is provided as-is.  In particular, Grass Valley Thomson makes no assurances that it will 
operate correctly or that it will provide a useful service.  Grass Valley Thomson will 
not be responsible for any damages, including loss of data, incurred by the use of 
this program.  Grass Valley Thomson does not agree to provide support for this tool 
through engineering, Customer Service, nor any other part of Grass Valley Thomson.

The frame simulator will attempt to communicate with devices that have been defined, 
and if the PC on which it is being run has net access to other devices, the frame simulator 
will send commands to connected devices to execute certain menu commands.  This can 
interfere with the control of these devices by other means.  It is strongly recommended 
that the frame simulator only be run on a stand-alone PC that is not connected through 
a network to any other devices.

The frame simulator will create several directories on the C: drive of the PC on which 
it is installed and will write files into these directories.  These directories include 
\NV, \logs, \DUMP and \User.

Various menu functions, especially File Ops, may write files to the PC and may create 
directories named \KalypsoUser or \ZodiakUser.  The use of the File Ops menu to modify 
files in either of these directories is unsupported.  When using the File Ops menu to 
rename and copy files with the assistance of the frame simulator, most operations require 
the use of DOS 8.3 naming restrictions – the most important of these is that the name 
must be no longer than 8 characters with no embedded spaces.

No installation process is provided with the frame simulator.  No de-install option is 
available to remove the frame simulator and the files it creates.

No visual feedback is provided by the frame simulator.  That is, it does not process 
video signals and produces no video output.

Some functions can only be invoked from the panel, not the menu.  This limits some menu 
options.  For instance, recalling and learning E-MEMs cannot be done with just the menu 
and frame simulator.

The Menu on PC does not have knobs that are available on switcher menu hardware.

The Kalypso HD frame simulator does not correctly handle 16x9 aspect ratio operations.

If you use the same PC for running Zodiak and Kalypso simulations, it is recommended that 
you delete the C:\NV directory between each simulation.