Calrec Service Utilities
---------------------------

These scripts are very basic and will not check that your input makes sense. Please read the on-screen 
instructions carefully. 

The scripts use SSH to connect to the panels. If a panel has never had an SSH connection from the front-end PC,
(e.g. PuTTY, WinSCP) then you will be asked to accept the host key during the script execution. Answer 'y' to
these prompts. The prompt will timeout after a short time; if this happens, the panel will be skipped.

All scripts now prompt for the first (Customer) and second (Desk/Rack) IP address octets.

Most of the scripts in this collection require the plink.exe and pscp.exe applications (command-line versions
of PuTTY and PSFTP). Some of the scripts require other files present in this directory. To make sure these
scripts function correctly, the best practise is to copy this whole folder onto a USB drive and run the 
appropriate script by double clicking on it (unless the description below states otherwise). If a single
utility from this distribution is to be sent to an engineer, it should be sent along with any other required
files/programs as noted in the descriptions below.

The following scripts are provided:

MEMTEST_ALL	-- This script configures all of the panels in the desk to run Memtest86+ on the next boot. After
		this script runs, a surface reset or power cycle will cause all of the panels to boot Memtest.
		Memtest86+ runs continuously. A second surface reset or power cycle will restart all the panels 
		into normal operation. (Requires: plink.exe)

MEMTEST_SINGLE	-- This script immediately reboots a single panel into Memtest86+. The memory test runs 
		continuously. A surface reset or power cycle will restart all the panel into normal operation.
		The panel to be tested is specified by its PoE number (1, 2, 3, 4...) and Port number (1-6). 
		(Requires: plink.exe)
	   
SET_LED_TYPE_ALL -- NOTE: This method of setting the LED colour palette is obsolete as of release v1.6. 
		Please see the COPY_ALL_COLOURMAP script below. This script prompts for the LED type string and 
		sets the LED_TYPE environment variable on every panel in the desk. (Requires: plink.exe)

SET_LED_TYPE_SINGLE -- NOTE: This method of setting the LED colour palette is obsolete as of release v1.6. 
		Please see the COPY_SINGLE_COLOURMAP script below. This script prompts for the LED type string 
		and set LED_TYPE environment variable on specified panels in the desk. (Requires: plink.exe)
		
SET_DANGLY_LED_TYPE -- NOTE: This method of setting the LED colour palette is obsolete as of release v1.6. 
		Please see the COPY_DANGLY_COLOURMAP script below. This script prompts for the LED type string 
		for setting the DANGLY_LED_TYPE environment variable on the master panel of a dangly/master pair. 
		(Requires: plink.exe) 
	
QUERY_LED_TYPE -- This script will try to connect to every panel in the desk and query the LED colour palette 
		settings. It will look for the LED_TYPE and DANGLY_LED_TYPE environment variable assignments in 
		/etc/init.d/rc.local and it will look for Panel and Dangly palette sections in the 
		colourmap.properties file. From Apollo/Artemis software release v1.6 onwards, the 
		colourmap.properties palette definitions take precedence over the LED_TYPE environment variables.
		See COPY_COLOUR_PROPERTIES scripts below. (Requires: plink.exe)

SET_LINEUP 	-- This script runs the fader lineup calibration command on all panels in the desk that have 
		faders. It also sets the OLED type on these panels since this value would otherwise get wiped in
		the process. This would not generally be a problem for fader panels since they default to 
		Univision 2, but some dangly panels have a non-usable default for this setting, so to be sure, 
		we prompt the user for the OLED type, and set this parameter before running the fader calibration
		command. This version of the script has the module number of panels with faders hard coded in, so
		any new fader panel we create will require a modification of this script. This script lives in its 
		own directory because it has its own set of support utilities and does not use any of the files 
		in the parent CalrecUtils directory. (Requires: ncat.exe, echo.exe, libeay32.dll, ssleay32.dll)

MCS_BACKUP 	-- This script makes a backup of all configurable option files, shows, memories, etc, then 
		downloads a tarball of these files to the front-end computer. If it is necessary to send this 
		application to the customer, make sure it is in a folder along with plink.exe and pscp.exe.
		(Requires: plink.exe, pscp.exe)

MCS_RECOVER	-- This script unpacks the backup file created by MCS_BACKUP onto a target Master Controller.
		It is a good idea to make sure the target MCS has the same software release version as the 
		MCS used to make the backup. The best way to use this application is to drag and drop the 
		backup file onto the icon for this script. Alternately, the location of the backup file can
		be specified on the command line. If it is necessary to give this script to a customer, be
		sure to include plink.exe and pscp.exe in the same folder. (Requires: plink.exe, pscp.exe)
		
ELAPSED_TIME -- This script displays the total elapsed run time for a panel. This feature only exists
		in panels manufactured after 5 July 2010. (Requires: plink.exe)

MASTER_OR_SLAVE -- This script allows the setting of a Primary Router to be a Master or Slave Router.
		(Requires: plink.exe)

RETRIEVE_LOGS -- This script will copy all logs from the MCS and Routers and creates a tarball file for each
		card that exists in the rack. The script will attempt to copy Router Expansion card logs if they
		exist. These are then copied to the CalrecAudioAdmin Desktop in a newly created folder called 
		CalrecLogs. A suitable compression utility such as Winzip or 7-Zip is required to then extract
		the logs from the .tgz file. Users must be logged in as CalrecAudioAdmin and Program Updater must 
		be running in the background. (Requires: plink.exe, pscp.exe)

COPY_ALL_COLOURMAP -- As of Apollo/Artemis release v1.6, the panel colour palettes are stored in a file 
		on the panel CF card. This script connects to every panel in the desk and copies a 
		colourmap.properties file on to the CF card. This script is intended to be used by drag and 
		dropping the appropriate .properties file onto the script icon. (Requires: plink.exe, pscp.exe)
		
COPY_SINGLE_COLOURMAP -- As of Apollo/Artemis release v1.6, the panel colour palettes are stored in a 
		file on the panel CF card. This script connects to a single panel in the desk and copies the 
		colourmap.properties file on to the CF card. This script is intended to be used by drag and 
		dropping the appropriate .properties file onto the script icon. (Requires: plink.exe, pscp.exe)

COPY_DANGLY_COLOURMAP -- As of Apollo/Artemis release v1.6, the dangly panel colour palettes are stored 
		in a file on the panel CF card of the dangly pair master. This script connects to a single panel
		in the desk - the pair master - and appends the colourmap.properties file onto the CF card with 
		the dangly palette. This script is intended to be used by drag and dropping the appropriate 
		.properties file onto the script icon. (Requires: plink.exe, pscp.exe)
		
DELETE_ALL_COLOURMAP -- As of Apollo/Artemis release v1.6, the panel colour palettes are stored in a file
		on the panel CF card. This script connects to every panel in the desk and removes this colour
		palette file. (Requires: plink.exe)
		
DELETE_SINGLE_COLOURMAP -- As of Apollo/Artemis release v1.6, the panel colour palettes are stored in a 
		file on the panel CF card. This script connects to a single panel in the desk and removes this
		colour palette file. (Requires: plink.exe)