Auto Script Functions

Auto Script Functions

NOTE: With the advent of the Sequence Wizard, creating auto scripts is unnecessary. We include the discussion pages concerning auto scripts for the sake of completeness, and instead, recommend you use the Sequence Wizard for automated experiments.

Delay()

Type: REGULAR FUNCTION

Purpose: Sleep for a number of seconds. Operator can use the Skip-F2 button to wake up early.

NOTE: Your script must include the AUTO UTILITIES.EXP script file in order to call this function.

Usage:

Status = Delay(Seconds)

 

Minutes

INDEX

Number of seconds to delay

 
 

Status

BOOL

TRUE

Woke up OK, or operator selected SKIP and Continue.

     

FALSE

Operator selected SKIP and Terminate.


DelayFrom()

Type: REGULAR FUNCTION

Purpose: Sleep for a number of minutes after a fixed point in time. Operator can use the Skip-F2 button to wake up early.

NOTE: Your script must include the AUTO UTILITIES.EXP script file in order to call this function.

Usage:

Status = DelayFrom(Minutes, StartTime)

 

Minutes

INDEX

Number of minutes to delay

 
 

StartTime

INDEX

Reference time

 

 

Status

BOOL

TRUE

Woke up OK, or operator selected SKIP and Continue.

     

FALSE

Operator selected SKIP and Terminate.

LaunchWait()

Type: REGULAR FUNCTION

Purpose: This function loads and runs another script.

NOTE: Your script must include the AUTO UTILITIES.EXP script file in order to call this function.

LaunchWait() is defined in AUTO UTILITIES.EXP and calls ExecWait(). The Launch() command updates the master script window before calling the corresponding Exec() function. It also deals with error-returns a bit better.

Normally you call LaunchWait(). Use LaunchWait() when you want to run two sequential experiments on the same potentiostat.

Usage:

Result = LaunchWait(ScriptFile,SetupFile,SetupName,OutputFile,PstatNo,ChannelNo)

ScriptFile

STRING

Name of script file to launch.

SetupFile

STRING

Name of file containing setup parameters.

SetupName

STRING

Name of the specific setup in the setup file to be used.

OutputFile

STRING

Name of the output file for saving experimental data.

PstatNo

INDEX

Number of the potentiostat and multiplexer to be used(14).

ChannelNo

INDEX

Multiplexer channel to use. NIL implies either no multiplexer or use default channel setting.

Result

BOOL

TRUE if experiment launched and ran okay

FALSE if aborted or a problem occurs.


WakeUp()

Type: REGULAR FUNCTION

Purpose: Sleep until a preset time and date. Operator can use the Skip-F2 button to wake up early.

NOTE: Your script must include the AUTO UTILITIES.EXP script file in order to call this function.

Usage:

Status = WakeUp(TimeString, DateString)

 

TimeString

STRING

Time in format HH:MM:SS. Use Windows® Control Panel to set non-USA formats.  
 

DateString

STRING

Date in format MM/DD/YY. Use Windows Control Panel to set non-USA formats.

 
   

NIL

Today

 
 

Status

BOOL

TRUE

Woke up OK, or operator selected SKIP-F2

     

FALSE

Operator selected Abort