Auto Script Functions

<< Click to Display Table of Contents >>

Navigation:  Explain™ Control Language  > Auto Scripts >

Auto Script Functions

Description

 

Gamry tip bulb

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()

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

 

Gamry tip bulb

Your script must include the AUTO UTILITIES.exp script file in order to call this function.

 

Type

REGULAR FUNCTION

 

Usage

Status = Delay(Seconds)

 

Seconds

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()

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

 

Gamry tip bulb

Your script must include the AUTO UTILITIES.exp script file in order to call this function.

 

Type

REGULAR 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()

This function loads and runs another script.

 

Gamry tip bulb

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.

 

Type

REGULAR FUNCTION

 

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 (1 to 4).

ChannelNo

INDEX

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

Result

BOOL

TRUE = Experiment launched and ran okay.

FALSE = Experiment aborted or a problem occurs.

 

WakeUp()

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

 

Gamry tip bulb

Your script must include the AUTO UTILITIES.exp script file in order to call this function.

 

Type

REGULAR 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.

 

Status

NIL

Today.

BOOL

TRUE = Woke up OK, or operator selected Skip.

FALSE = Operator selected Abort.