Commands

You are reading our Automation1 API documentation for the C programming language.

The Basics

In the C API, Commands lets you execute AeroScript commands on the Automation1 controller. This is one of three ways that you can command your controller. You can also command it by running AeroScript programs with Tasks and by using a Command Queue in the C API.

When you execute AeroScript commands through the C API, a quantity of fixed overhead occurs. When you execute two commands, one immediately after the other, there is a delay that occurs between the commands. This delay averages from 3 to 5 milliseconds, based on the performance of the PC. It also includes all the network latency delays that might occur.

IMPORTANT: If this delay is not compatible with your production environment, use Command Queue in the C API.

Command Queue lets you queue multiple commands on the controller to prevent overhead and delay. Some AeroScript commands are available only in Command Queue because they cannot accept this overhead and delay. These commands include all the AeroScript commands that require Lookahead Synchronization, such as velocity blending, cutter radius compensation, and corner rounding. If you execute a series of MovePt() or MovePvt() commands, this process also requires a command queue.

All C functions have the same blocking behavior as their AeroScript function equivalents. Thus if the AeroScript function blocks, the C function will block too.

All C functions will apply relative paths as absolute paths, which is different from their AeroScript function equivalents.

All the AeroScript commands execute on a controller task. You must select the task on which to execute the command by specifying the executionTaskIndex argument in each C function.

Tip: It is recommended that you use task 1. Task indices start at 1. Task index 0 is reserved and cannot be used.

How to Use

Commands is part of the controller runtime. Thus, the Automation1 controller must be running before you execute the commands. For more information, see the Controller page.

To execute an AeroScript command, call the C function that has the same arguments as its corresponding AeroScript function. To see a list of all the C functions that you can use for Commands, refer to the Full Reference section of this page. Some commands accept either axes or tasks. You must specify an axis by the axis index. You must specify a task by the task index.

Copy 
bool Automation1_Command_Enable(Automation1Controller controller, int32_t executionTaskIndex, int32_t* axes, int32_t axesLength);
bool Automation1_Command_MoveLinear(Automation1Controller controller, int32_t executionTaskIndex, int32_t* axes, int32_t axesLength, double* distances, int32_t distancesLength, double coordinatedSpeed);
bool Automation1_Command_Disable(Automation1Controller controller, int32_t* axes, int32_t axesLength);

You can execute most of the AeroScript commands through the C API. But there might be some special cases where you want to execute custom AeroScript. If this occurs, use the Automation1_Command_Execute() function to specify arbitrary AeroScript to execute.

Copy 
bool Automation1_Command_Execute(Automation1Controller controller, int32_t executionTaskIndex, const char* aeroScriptText);

Example Code

Copy 
// Enable the X axis. Move it 10 mm at 5 mm/s for a two second move. Then disable it.
// Do all of this on task 1.
int32_t task1 = 1;
int32_t axisX = 0;
double distance = 10.0;
if (!Automation1_Command_Enable(controller, task1, &axisX, 1)) { /* handle error */ }
if (!Automation1_Command_MoveLinear(controller, task1, &axisX, 1, &distance, 1, 5.0)) { /* handle error */ }
if (!Automation1_Command_Disable(controller, &axisX, 1)) { /* handle error */ }

Thread Safety

All the Automation1_Command_ functions are thread safe. You can call them from two or more threads without interference.

But because the C API is thread safe, this does not mean the controller can process the AeroScript commands that you are trying to execute. A single controller task can execute only one AeroScript command at a time. Thus if you try to execute two or more commands on the same task from different C threads, an error will occur.

Also, a single axis can do motion only from one AeroScript command. Thus if you try to execute a motion command on an axis that is currently executing a previous motion command, an error will occur.

To prevent controller errors from occurring, you must synchronize or coordinate your process.

For Example

You can make a single C thread responsible for a single controller task and some number of motion axes.

Full Reference

For more information about the functions that are available for Commands, refer to the list that follows.

Functions

Executes an AeroScript command on the Automation1 controller on the specified task.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

aeroScriptText (In): The null-terminated AeroScript string text to compile and execute.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Executes an AeroScript command on the Automation1 controller on the specified task and returns an AeroScript axis value, which is the index of the axis. To get a return value from the AeroScript command, set the value of the AeroScript $areturn[0] property in the AeroScript command. For Example: Let's say that you set the aeroScriptText function argument to "$areturn[0]=@1". As a result, this function sets the aeroScriptAxisIndexOut argument to axis index 1 after the AeroScript command completes execution.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

aeroScriptText (In): The null-terminated AeroScript string text to compile and execute.

aeroScriptAxisIndexOut (Out): The value of the AeroScript $areturn[0] property after the AeroScript command completes execution. Use this value only if the function call was successful.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Executes an AeroScript command on the Automation1 controller on the specified task and returns an AeroScript integer value. To get a return value from the AeroScript command, set the value of the AeroScript $ireturn[0] property in the AeroScript command. For Example: Let's say that you set the aeroScriptText function argument to "$ireturn[0]=9999". As a result, this function sets the aeroScriptIntegerOut argument to 9999 after the AeroScript command completes execution.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

aeroScriptText (In): The null-terminated AeroScript string text to compile and execute.

aeroScriptIntegerOut (Out): The value of the AeroScript $ireturn[0] property after the AeroScript command completes execution. Use this value only if the function call was successful.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Executes an AeroScript command on the Automation1 controller on the specified task and returns an AeroScript real value. To get a return value from the AeroScript command, set the value of the AeroScript $rreturn[0] property in the AeroScript command. For Example: Let's say that you set the aeroScriptText argument to "$rreturn[0]=0.0001". As a result, this function sets the aeroScriptRealOut argument to 0.0001 after the AeroScript command completes execution.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

aeroScriptText (In): The null-terminated AeroScript string text to compile and execute.

aeroScriptRealOut (Out): The value of the AeroScript $rreturn[0] property after the AeroScript command completes execution. Use this value only if the function call was successful.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Executes an AeroScript command on the Automation1 controller on the specified task and returns an AeroScript string value. To get a return value from the AeroScript command, set the value of the AeroScript $sreturn[0] property in the AeroScript command. For Example: Let's say that you set the aeroScriptText argument to "$sreturn[0]=\"HelloWorld\"". As a result, this function sets the aeroScriptStringOut argument to "HelloWorld" after the AeroScript command completes execution.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

aeroScriptText (In): The null-terminated AeroScript string text to compile and execute.

aeroScriptStringOut (Out): The null-terminated value of the AeroScript $sreturn[0] property after the AeroScript command completes execution. Use this value only if the function call was successful. This argument must have memory preallocated before you pass it into this function.

aeroScriptStringLength (In): The maximum number of elements to copy into the aeroScriptStringOut argument. This number must not be greater than the length of the aeroScriptStringOut array and must include space for the null-terminator.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Unloads a camming table from the SMC.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

tableNum (In): The camming table number to remove. This value must be greater than or equal to 0 and less than or equal to 99.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Loads a camming table into the SMC.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

tableNum (In): The camming table number to use. This value must be greater than or equal to 0 and less than or equal to 99. Use this number when using the CammingOn() and CammingFreeTable() functions.

leaderValues (In): Array of leader axis position values for the follower axis to track.

leaderValuesLength (In): The number of elements in the leaderValues function argument.

followerValues (In): Array of follower axis positions or velocities to use.

followerValuesLength (In): The number of elements in the followerValues function argument.

numValues (In): The number of values in the leaderValues and followerValues arrays.

unitsMode (In): The units of the values in the camming table.

interpolationMode (In): The interpolation type to use if the position of the leader axis is between two values in the table.

wrapMode (In): Determines how a leader axis position value outside of the table is treated.

tableOffset (In): An offset applied to all follower axis position or velocity values in the table.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Disables camming on the specified follower axis.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

followerAxis (In): The follower axis on which to disable camming.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Enables camming on the specified leader axis and follower axis.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

followerAxis (In): The axis to set as the follower axis.

leaderAxis (In): The axis to set as the leader axis.

tableNum (In): The camming table number to use. This value must be greater than or equal to 0 and less than or equal to 99.

source (In): The signal on the leader axis that the follower axis will track.

output (In): The output signal to generate and the synchronization mode to use on the camming follower axis.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Disables gearing on an axis.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

followerAxis (In): The axis on which to disable gearing.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Enables gearing on an axis.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

followerAxis (In): The axis on which to enable gearing.

filter (In): Type of filter applied to follower axis motion.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures gearing for an axis.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

followerAxis (In): Follower axis for the gearing setup.

leaderAxis (In): Leader axis for the gearing setup.

gearingSource (In): Input data source for gearing.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Sets the gearing ratio for an axis.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

followerAxis (In): The axis on which to set the gear ratio.

gearRatio (In): The scale factor applied to the motion of the follower axis, specified as the ratio of follower axis counts to leader axis counts. A negative gear ratio will cause the follower axis to move in the opposite direction of the motion of the leader axis.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Executes an asynchronous move on an axis to move it out of a limit condition.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to perform the move.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Executes an asynchronous move on an axis to move it into a limit condition in the counterclockwise direction.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to perform the move.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Executes an asynchronous move on an axis to move it into a limit condition in the clockwise direction.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to perform the move.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Disables normalcy mode.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Enables normalcy mode.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

normalcyAlignment (In): The type of the normalcy mode.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures the axes to use for normalcy mode.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

normalcyAxis (In): The normalcy axis. This must be a dependent type axis.

planeAxes (In): The axes to use as the X and Y axes of the normalcy plane. These axes must be dominant type axes.

planeAxesLength (In): The number of elements in the planeAxes function argument.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures the tolerance to use for normalcy mode.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

tolerance (In): The normalcy mode tolerance, in degrees.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Disables autofocus on an axis.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to disable autofocus.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Enables autofocus on an axis.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to enable autofocus.

focusMode (In): Selects if autofocus will run in continuous focus or single focus mode.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Loads and activates the specified axis calibration file or galvo power correction file.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

calibrationType (In): The type of calibration that the specified file represents.

controllerFileName (In): The path to the file to be loaded as a calibration file.

This string argument must be null terminated.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Deactivates and unloads the calibration for the specified calibration type.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

calibrationType (In): The type of calibration to be unloaded.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Reads the contents of the drive array into the valuesOut argument.

controller (In): The Automation1 controller on which to perform this AeroScript command.

axis (In): The axis from which to read the drive array.

startAddress (In): Byte-addressable index of the drive array from which to begin reading data.

numElements (In): The number of drive array elements to read.

driveArrayType (In): The underlying data type to read from the drive array.

valuesOut (Out): The array to populate with data that was read from the drive array. Only use this if the function call was successful. This argument must have memory preallocated before passing it into this function

valuesMaxLength (In): The maximum number of elements to copy to the valuesOut argument. This must not be greater than the length of the valuesOut array.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Writes the contents of the values argument to the drive array. This command is deprecated and will be removed in the next major version of Automation1 software. It will be replaced by a command with the same name that does not accept executionTaskIndex as an argument.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): This argument is unused and will be removed in the next major version of Automation1 software.

axis (In): The axis on which to write the drive array.

values (In): The data to write to the drive array.

valuesLength (In): The length of the values argument.

startAddress (In): Byte-addressable index of the drive array at which to begin writing data.

numElements (In): The number of drive array elements to write.

driveArrayType (In): The underlying data type to write to the drive array.

valuesOut (Out): The array to populate with data that was read from the drive array. Only use this if the function call was successful. This argument must have memory preallocated before passing it into this function

valuesMaxLength (In): The maximum number of elements to copy to the valuesOut argument. This must not be greater than the length of the valuesOut array.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Disengages the brake output and allows the axis to move freely.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to disengage the brake.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Engages the brake output and prevents the axis from moving freely.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to engage the brake.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures the drive array for drive data capture.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure the drive array for drive data capture.

configurationNumber (In): The data capture configuration number. When capturing one input signal on the specified axis, specify a value of 0. When capturing two input signals on the specified axis, specify 0 for the first signal and 1 for the second signal.

driveArrayStartAddress (In): The byte-addressable index of the drive array where the first drive data capture value will be written.

numberOfPoints (In): The number of points that will be written to the drive array by drive data capture.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Selects the signal that will be stored by drive data capture.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to select the drive data capture signal.

configurationNumber (In): The data capture configuration number. When capturing one input signal on the specified axis, specify a value of 0. When capturing two input signals on the specified axis, specify 0 for the first signal and 1 for the second signal.

input (In): The input signal for drive data capture.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Selects the event that will trigger drive data capture.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to select the drive data capture trigger.

configurationNumber (In): The data capture configuration number. When capturing one input signal on the specified axis, specify a value of 0. When capturing two input signals on the specified axis, specify 0 for the first signal and 1 for the second signal.

trigger (In): The trigger event for drive data capture.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Disables drive data capture of configured inputs.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to disable drive data capture.

configurationNumber (In): The data capture configuration number. When capturing one input signal on the specified axis, specify a value of 0. When capturing two input signals on the specified axis, specify 0 for the first signal and 1 for the second signal.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Enables drive data capture of configured inputs.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to enable drive data capture.

configurationNumber (In): The data capture configuration number. When capturing one input signal on the specified axis, specify a value of 0. When capturing two input signals on the specified axis, specify 0 for the first signal and 1 for the second signal.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Resets drive data capture configuration.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to reset drive data capture.

configurationNumber (In): The data capture configuration number. To reset the first configuration on the specified axis, specify a value of 0. To reset the second configuration on the specified axis, specify a value of 1.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Inverts the output signal of a specified channel.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to apply the configuration.

outputChannel (In): The outgoing encoder channel.

reverseDirection (In): Reverses the direction of the encoder output signal.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Applies a divider on the specified output channel, lowering the frequency of output signals.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to apply the configuration.

outputChannel (In): The outgoing encoder channel.

outputDivider (In): The divider to apply to encoder output.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures an output channel to echo encoder signals from the specified input channel.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to apply the configuration.

outputChannel (In): The outgoing encoder channel.

inputChannel (In): The incoming encoder channel.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Disables encoder output on the specified output channel.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to disable encoder output.

outputChannel (In): The outgoing encoder channel.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Enables encoder output on the specified output channel.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to enable encoder output.

outputChannel (In): The outgoing encoder channel.

outputMode (In): This argument is unused and will be removed in the next major version of Automation1 software. You must specify EncoderOutputMode.Default.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Gets the specified drive item from the specified axis.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis from which to retrieve the drive item value.

driveItem (In): The drive item to retrieve.

additionalData (In): Additional data for the specified drive item. This argument is required by some drive items.

returnOut (Out): The value of the specified drive item.

Only use this if the function call was successful.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures pulse streaming mode.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

outputAxis (In): The output axis on which to configure pulse streaming mode.

inputAxes (In): An array of one or more axes which will be tracked.

inputAxesLength (In): The number of elements in the inputAxes function argument.

inputScaleFactors (In): An array of scale factors to apply to each axis in the $inputAxes array.

inputScaleFactorsLength (In): The number of elements in the inputScaleFactors function argument.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures pulse streaming mode.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

outputAxis (In): The output axis on which to configure pulse streaming mode.

inputAxes (In): An array of one or more axes which will be tracked.

inputAxesLength (In): The number of elements in the inputAxes function argument.

inputScaleFactors (In): An array of scale factors to apply to each axis in the $inputAxes array.

inputScaleFactorsLength (In): The number of elements in the inputScaleFactors function argument.

signalMode (In): The signal mode used when DriveEncoderOutputConfigureInput() and DriveEncoderOutputOn() are configured to echo the Pulse Stream signal to an encoder output.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Disables pulse streaming mode on an axis.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

outputAxis (In): The axis on which to disable pulse streaming mode.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Enables pulse streaming mode on an axis.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

outputAxis (In): The axis on which to enable pulse streaming mode.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Deprecated: This command is deprecated and will be removed in the next major version of Automation1 software. This function has been obsoleted by DriveSetEncoderPosition(). Use that function instead to set the auxiliary feedback.

Sets the auxiliary feedback of the axis.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to set the auxiliary feedback.

auxiliaryFeedback (In): The feedback value to set.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Sets the hardware position counter of a drive encoder.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to set the hardware position counter of a drive encoder.

encoderChannel (In): The drive encoder on which to set the hardware position counter.

encoderValue (In): The value to set to the hardware position counter.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Sets the position command value of the specified axis at the servo loop level and adjusts the position feedback for position error.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to set the position command.

positionCommandValue (In): The position command value to set.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Sets the position command and the position feedback value of the specified axis at the servo loop level.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to set the position command.

positionFeedbackValue (In): The position feedback value to set.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures the relationship between the acceleration feedforward and analog input voltage, where Acceleration Feedforward = (Analog Input Voltage - ($inputOffset / 1000)) x $inputScale.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to apply the configuration for the Drive Analog Acceleration Feedforward feature.

analogInputNum (In): The analog input signal used in the acceleration feedforward computation.

inputScale (In): The scale value used in the acceleration feedforward computation to convert from volts to units/second^2.

inputOffset (In): The offset value in millivolts used in the acceleration feedforward computation. This argument has a minimum value of -1000 and a maximum value of 1000.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Disables the Drive Analog Acceleration Feedforward feature.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to disable the Drive Analog Acceleration Feedforward feature.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Enables the Drive Analog Acceleration Feedforward feature.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to enable the Drive Analog Acceleration Feedforward feature.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures the relationship between the output current and analog input voltage, where Current = (Analog Input Voltage - ($inputOffset / 1000)) x $inputScale.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to apply the configuration for the Drive Analog Current Control feature.

analogInputNum (In): The analog input signal used in the current computation.

digitalInputNum (In): The digital input signal used to enable and disable the axis.

inputScale (In): The scale value used in the current computation to convert from volts to amps.

inputOffset (In): The offset value in millivolts used in the current computation. This argument has a minimum value of -1000 and a maximum value of 1000.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Disables the Drive Analog Current Control feature.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to disable the Drive Analog Current Control feature.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Enables the Drive Analog Current Control feature.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to enable the Drive Analog Current Control feature.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures the relationship between the output position and analog input voltage, where Position = (Analog Input Voltage - $inputOffset) x $inputScale + (Starting Position). Starting Position is the position of the axis at the time DriveAnalogPositionControlOn() is called.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to apply the configuration for the Drive Analog Position Control feature.

inputNum (In): The analog input signal used in the position computation.

inputScale (In): The scale value used in the position computation.

inputOffset (In): The offset value used in the position computation.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures the maximum speed at which the controller commands the axis to move using the Drive Analog Position Control feature. If you do not use this function, then the controller does not limit the maximum speed.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to apply the configuration for the Drive Analog Position Control feature.

maxSpeed (In): The speed in user units per second. If you specify a value of 0 for this argument, then the controller does not limit the maximum speed.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Disable the Drive Analog Position Control feature.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to disable the Drive Analog Position Control feature.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Enable the Drive Analog Position Control feature.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to enable the Drive Analog Position Control feature.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures the relationship between the output velocity and analog input voltage, where Velocity = (Analog Input Voltage - ($inputOffset / 1000)) x $inputScale.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to apply the configuration for the Drive Analog Velocity Control feature.

analogInputNum (In): The analog input signal used in the velocity computation.

digitalInputNum (In): The digital input signal used to enable and disable the axis.

inputScale (In): The scale value used in the velocity computation to convert from volts to units/second.

inputOffset (In): The offset value in millivolts used in the velocity computation. This argument has a minimum value of -1000 and a maximum value of 1000.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Disables the Drive Analog Velocity Control feature.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to disable the Drive Analog Current Control feature.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Enables the Drive Analog Velocity Control feature.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to enable the Drive Analog Velocity Control feature.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures the relationship between the velocity feedforward and analog input voltage, where Velocity Feedforward = (Analog Input Voltage - ($inputOffset / 1000)) x $inputScale.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to apply the configuration for the Drive Analog Velocity Feedforward feature.

analogInputNum (In): The analog input signal used in the velocity feedforward computation.

inputScale (In): The scale value used in the velocity feedforward computation to convert from volts to units/second.

inputOffset (In): The offset value in millivolts used in the velocity feedforward computation. This argument has a minimum value of -1000 and a maximum value of 1000.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Disables the Drive Analog Velocity Feedforward feature.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to disable the Drive Analog Velocity Feedforward feature.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Enables the Drive Analog Velocity Feedforward feature.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to enable the Drive Analog Velocity Feedforward feature.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Acknowledges all axis faults and clears all task errors.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Acknowledges faults on axes.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axes (In): The axes on which to acknowledge faults.

axesLength (In): The number of elements in the axes function argument.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Causes faults on an axis.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to cause faults.

faultMask (In): The mask of faults to cause on the axis.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Clears the task error that is set on the given task.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

taskIndex (In): The task index on which to clear the task error.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Clears the task warning that is set on the given task.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

taskIndex (In): The task index on which to clear the task warning.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Causes a task error with the specified message on a task.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

taskIndex (In): The task on which to cause a task error.

errorMessage (In): The error message to display.

This string argument must be null terminated.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Deprecated: This command is deprecated and will be removed in the next major version of Automation1 software. This function overload has been obsoleted by the TaskSetError($taskIndex as integer, $errorMessage as string) overload. Use that overload instead to set a task error with your own specified message. Use the TaskClearError($taskIndex as integer) function to clear a task error.

Causes a specified task error on a task.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

taskIndex (In): The task on which to cause a task error.

error (In): The task error to cause. Specify 0 to clear the current task error.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Causes a task warning with the specified message on a task.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

taskIndex (In): The task on which to cause a task warning.

warningMessage (In): The warning message to display.

This string argument must be null terminated.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Deprecated: This command is deprecated and will be removed in the next major version of Automation1 software. This function overload has been obsoleted by the TaskSetWarning($taskIndex as integer, $warningMessage as string) overload. Use that overload instead to set a task warning with your own specified message. Use the TaskClearWarning($taskIndex as integer) function to clear a task warning.

Causes a specified task warning on a task.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

taskIndex (In): The task on which to cause a task warning.

warning (In): The task warning to cause. Specify 0 to clear the current task warning.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Specifies the pulse width, in microseconds, of the O1 signal.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure the laser 1 pulse width.

time (In): The time value in microseconds.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Specifies the pulse width, in microseconds, of the O2 signal.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure the laser 2 pulse width.

time (In): The time value in microseconds.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Specifies when the axis fires the laser relative to when you command the laser to power on and when the axis stops firing the laser relative to when you command the laser to power off.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure laser delays.

onDelay (In): The delay time, in microseconds, that is necessary for the laser to power on. If your program uses the automatic laser mode, this value must be greater than or equal to -32,768 and less than or equal to 32,767. If your program uses the manual laser mode or if you are operating in IFOV mode, this value must be greater than or equal to -975 and less than or equal to 32,767.

offDelay (In): The delay time, in microseconds, that is necessary for the laser to power off. This value must be greater than or equal to -975 and less than or equal to 2,000,000.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Specifies the mode in which the laser output signals operate.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure the laser mode.

laserMode (In): The value of the laser output mode.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Specifies the period, in microseconds, of the O1 and O2 signals.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure the laser output period.

time (In): The time value in microseconds.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Specifies the period, in microseconds, of the standby signals.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure the standby period.

time (In): The time value in microseconds.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Specifies the pulse width, in microseconds, of the standby signals.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure the standby pulse width.

time (In): The time value in microseconds.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Specifies the pulse width, in microseconds, of the suppression signal.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure the suppression pulse width.

time (In): The time value in microseconds.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Enables "marking on the fly" functionality.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure the encoder scale factor.

encoderScaleFactor (In): The ratio of scanner counts to encoder counts. This value must be greater than -32,768 and less than 32,767.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Specifies how the laser on a galvo axis is controlled.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure the laser state.

laserState (In): The mode to use to control the laser.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Disables the projective transformation on galvo axes.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The galvo axis on which to disable the projection.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Enables the projective transformation on galvo axes.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The galvo axis on which to apply the projection.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Specifies the projective transformation coefficients that are applied to galvo axes.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The galvo axis on which the projection is to be applied.

coefficients (In): The coefficients to use.

coefficientsLength (In): The number of elements in the coefficients function argument.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Specifies an angle of rotation that is applied to galvo axes.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The galvo axis on which the rotation is to be applied.

angle (In): The angle in degrees.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Disables the galvo wobble feature.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The galvo axis on which the galvo wobble is to be disabled.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Enables the galvo wobble feature.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The galvo axis on which the galvo wobble is to be applied.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures the wobble feature, which generates a wobble pattern that is added to the motion command of a galvo axis.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The galvo axis on which the galvo wobble is to be applied.

amplitudeParallel (In): The amplitude of the wobble shape parallel to the vector path.

amplitudePerpendicular (In): The amplitude of the wobble shape perpendicular to the vector path.

frequency (In): The frequency of the wobble oscillation. Specified in hertz for time-based mode or user units for distance-based mode.

wobbleMode (In): Specifies whether the wobble is repeated based on a fixed time or a fixed vector distance.

wobbleType (In): The type of figure that is generated by the wobble.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Disables Infinite Field of View (IFOV).

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Enables Infinite Field of View (IFOV).

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures axes to command in Infinite Field of View (IFOV).

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axisPairH (In): The horizontal axis pair. This pair consists of a galvo axis and its corresponding servo axis.

axisPairHLength (In): The number of elements in the axisPairH function argument.

axisPairV (In): The vertical axis pair. This pair consists of a galvo axis and its corresponding servo axis.

axisPairVLength (In): The number of elements in the axisPairV function argument.

scaleFactorH (In): Specifies the scaling from the servo axis to the galvo axis in the horizontal axis pair.

scaleFactorV (In): Specifies the scaling from the servo axis to the galvo axis in the vertical axis pair.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures the field of view size of the galvo head in Infinite Field of View (IFOV).

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

size (In): The field of view size, in user units, of the galvo head.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures more axes to command in Infinite Field of View (IFOV).

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axes (In): A list of axes to synchronize in Infinite Field of View in addition to those specified in IfovSetAxisPairs().

axesLength (In): The number of elements in the axes function argument.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures the maximum search time that the controller looks ahead in Infinite Field of View (IFOV).

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

time (In): The time, in milliseconds, that the controller looks ahead.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures the maximum acceleration of the servo axes while in Infinite Field of View (IFOV).

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

acceleration (In): The maximum acceleration, in user units/second squared, of the servo axes.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures the maximum speed of the servo axes while in Infinite Field of View (IFOV).

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

speed (In): The maximum speed, in user units/time base, of the servo axes.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Gets the value of a specified analog input.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to retrieve the value of the analog input.

inputNum (In): The number of the analog input to get.

returnOut (Out): The value of the specified analog input.

Only use this if the function call was successful.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures the specified analog output to use values from the drive array.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to apply the configuration.

outputNum (In): The number of the analog output to configure.

updateEvent (In): The event which causes a new analog output value to be read from the drive array.

driveArrayStartAddress (In): The byte-addressable index of the drive array where the first analog output value is stored.

numberOfPoints (In): The number of analog output values to read from the drive array.

divisor (In): Divides the default update event rate by the specified integer if $updateEvent is set to Time.

enableRepeat (In): Configures the specified analog output to start over at the first analog output value after the last value in the drive array is used.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures an analog output to be dependent on a specified real-time internal servo loop value of a single axis.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

outputAxis (In): The axis of the servo loop value that $trackingItem is tracking.

outputNum (In): The index of the analog output to update.

trackingItem (In): A servo loop value, such as position command, to track.

scaleFactor (In): The scale factor applied to the analog output.

offset (In): This value is applied with the tracking value to the analog output. Use this argument if you want to track position on a stage where the position can never be negative. The units are volts.

minVoltage (In): The minimum voltage that the analog output will be set to.

maxVoltage (In): The maximum voltage that the analog output will be set to.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Restores the analog output configuration to the default operating mode.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to apply the configuration.

outputNum (In): The number of the analog output to configure.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures an analog output to be dependent on the square root of the sum of squares of a specified real-time internal servo loop value of multiple axes. The tracked value is always positive or zero.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

outputAxis (In): The axis of the servo loop value that $trackingItem is tracking.

outputNum (In): The index of the analog output to update.

inputAxes (In): An array of axes from which to read the $trackingItem from, vectorizing the result, in order to update the analog output.

inputAxesLength (In): The number of elements in the inputAxes function argument.

trackingItem (In): A servo loop value, such as position command, to track.

scaleFactor (In): The scale factor applied to the analog output.

offset (In): This value is applied with the tracking value to the analog output. Use this argument if you want to track position on a stage where the position can never be negative. The units are volts.

minVoltage (In): The minimum voltage that the analog output will be set to.

maxVoltage (In): The maximum voltage that the analog output will be set to.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Gets the value of a specified analog output.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to retrieve the value of the analog output.

outputNum (In): The number of the analog output to get.

returnOut (Out): The value of the specified analog output.

Only use this if the function call was successful.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Sets the value of a specified analog output.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to set the value of the analog output.

outputNum (In): The number of the analog output to set.

value (In): The value to set to the specified analog output.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Gets the value of the specified digital input bit.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis from which to get the digital input bit.

inputNum (In): The digital input bit to get.

returnOut (Out): The value of the specified digital input bit.

Only use this if the function call was successful.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Gets the value of the specified digital output bit.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis from which to get the digital output bit.

outputNum (In): The digital output bit to get.

returnOut (Out): The value of the specified digital output bit.

Only use this if the function call was successful.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Sets the value of the specified digital output bit.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to set the digital output bit.

outputNum (In): The digital output bit to set.

value (In): The value of the specified digital output bit.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Sets the laser to manual mode and to the specified value.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure the laser state.

laserState (In): The value for the laser. To turn off the laser, specify a value of 0. To turn on the laser, specify a value of 1.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Gets the value of the specified virtual binary input bit.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

inputNum (In): The virtual binary input bit to get.

returnOut (Out): The value of the specified virtual binary input bit.

Only use this if the function call was successful.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Sets the value of the specified virtual binary input bit.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

inputNum (In): The virtual binary input bit to set.

value (In): The value to which you set the virtual binary input bit.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Gets the value of the specified virtual binary output bit.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

outputNum (In): The virtual binary output bit to get.

returnOut (Out): The value of the specified virtual binary output bit.

Only use this if the function call was successful.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Sets the value of the specified virtual binary output bit.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

outputNum (In): The virtual binary output bit to set.

value (In): The value to which you set the virtual binary output bit.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Gets the value of a specified virtual register input.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

inputNum (In): The number of the virtual register input to get.

returnOut (Out): The value of the specified virtual register input.

Only use this if the function call was successful.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Sets the value of a specified virtual register input.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

inputNum (In): The number of the virtual register input to set.

value (In): The value to set to the virtual register input.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Gets the value of a specified virtual register output.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

outputNum (In): The number of the virtual register output to get.

returnOut (Out): The value of the specified virtual register output.

Only use this if the function call was successful.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Sets the value of a specified virtual register output.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

outputNum (In): The number of the virtual register output to set.

value (In): The value to set to the virtual register output.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Adds an axis group configuration to the joystick configuration.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

motionAxes (In): An array of one or more axes to control with the joystick.

motionAxesLength (In): The number of elements in the motionAxes function argument.

joystickInputs (In): An array of one or more joystick inputs to use to control axes.

joystickInputsLength (In): The number of elements in the joystickInputs function argument.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Removes all axis group configurations from the joystick configuration.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Activates the joystick.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Aborts motion on the specified axes. The controller stops all motion and ramps the axes to zero speed. This function waits for the abort to start but it does not wait for the abort to complete. This function does not block. It is different from the AeroScript Abort() function, which does block. Use the Automation1_Command_WaitForMotionDone function to ensure aborted motion is done before executing the next command, otherwise an error might occur.

controller (In): The Automation1 controller on which to perform this AeroScript command.

axes (In): The axes to abort. This argument is an array.

axesLength (In): The number of elements in the axes argument.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Disables the axes so that you cannot command motion. This function waits for the disable to start but it does not wait for the disable to complete. This function does not block. It is different from the AeroScript Disable() function, which does block.

controller (In): The Automation1 controller on which to perform this AeroScript command.

axes (In): The axes to disable. This argument is an array.

axesLength (In): The number of elements in the axes argument.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Enables the axes so that you can command motion.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axes (In): The axes to enable.

axesLength (In): The number of elements in the axes function argument.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Performs a home cycle by moving the axes to a known hardware reference location. The task waits for completion of the home cycle.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axes (In): The axes to home.

axesLength (In): The number of elements in the axes function argument.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Performs a home cycle by moving the axes to a known hardware reference location. The controller performs the home cycle asynchronously so that the task moves on without waiting for completion.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axes (In): The axes to home.

axesLength (In): The number of elements in the axes function argument.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Executes an asynchronous point-to-point move to an absolute target-position on the specified axes.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axes (In): The axes on which to perform point-to-point motion.

axesLength (In): The number of elements in the axes function argument.

positions (In): The absolute target-positions of the move.

positionsLength (In): The number of elements in the positions function argument.

speeds (In): The speeds at which to move the specified axes.

speedsLength (In): The number of elements in the speeds function argument.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Executes a coordinated counterclockwise circular arc move on the specified axes. An arc move creates an arc in vector space using two axes.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axes (In): The axes on which to perform counterclockwise circular motion.

axesLength (In): The number of elements in the axes function argument.

distances (In): The end points of the circular arc.

distancesLength (In): The number of elements in the distances function argument.

radius (In): The radius of the circular arc.

coordinatedSpeed (In): The speed of the coordinated circular motion.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Executes a coordinated counterclockwise circular arc move on the specified axes. An arc move creates an arc in vector space using two axes.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axes (In): The axes on which to perform counterclockwise circular motion.

axesLength (In): The number of elements in the axes function argument.

distances (In): The end points of the circular arc.

distancesLength (In): The number of elements in the distances function argument.

center (In): The relative offsets of the center point from the starting positions of the axes.

centerLength (In): The number of elements in the center function argument.

coordinatedSpeed (In): The speed of the coordinated circular motion.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Executes a coordinated clockwise circular arc move on the specified axes. An arc move creates an arc in vector space using two axes.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axes (In): The axes on which to perform clockwise circular motion.

axesLength (In): The number of elements in the axes function argument.

distances (In): The end points of the circular arc.

distancesLength (In): The number of elements in the distances function argument.

radius (In): The radius of the circular arc.

coordinatedSpeed (In): The speed of the coordinated circular motion.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Executes a coordinated clockwise circular arc move on the specified axes. An arc move creates an arc in vector space using two axes.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axes (In): The axes on which to perform clockwise circular motion.

axesLength (In): The number of elements in the axes function argument.

distances (In): The end points of the circular arc.

distancesLength (In): The number of elements in the distances function argument.

center (In): The relative offsets of the center point from the starting positions of the axes.

centerLength (In): The number of elements in the center function argument.

coordinatedSpeed (In): The speed of the coordinated circular motion.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Commands axes to remain at zero velocity for a quantity of time.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axes (In): The axes on which to perform the delay.

axesLength (In): The number of elements in the axes function argument.

delayTime (In): Total delay time in milliseconds, rounded to the nearest time interval of the MotionUpdateRate parameter.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Executes an asynchronous freerun move on the specified axes. The axes will move indefinitely at the specified velocity.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axes (In): The axes on which to perform freerun motion.

axesLength (In): The number of elements in the axes function argument.

velocities (In): The velocities at which to move the specified axes. The signs of the velocities specify the directions of motion.

velocitiesLength (In): The number of elements in the velocities function argument.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Stops an asynchronous freerun move on the specified axes. The axis velocities decelerate to zero.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axes (In): The axes on which to stop freerun motion.

axesLength (In): The number of elements in the axes function argument.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Executes an asynchronous point-to-point move by an incremental distance on the specified axes.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axes (In): The axes on which to perform point-to-point motion.

axesLength (In): The number of elements in the axes function argument.

distances (In): The distances and directions to move the specified axes relative to the current positions. A distance of zero results in no motion.

distancesLength (In): The number of elements in the distances function argument.

speeds (In): The speeds at which to move the specified axes.

speedsLength (In): The number of elements in the speeds function argument.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Executes a coordinated linear move on the specified axes. A linear move creates a line in vector space on one or more axes.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axes (In): The axes on which to perform linear motion.

axesLength (In): The number of elements in the axes function argument.

distances (In): The end points of the linear move.

distancesLength (In): The number of elements in the distances function argument.

coordinatedSpeed (In): The speed of the coordinated linear motion.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Executes a point-to-point rapid move on the specified axes.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axes (In): The axes on which to perform point-to-point rapid motion.

axesLength (In): The number of elements in the axes function argument.

distances (In): The end points of the rapid move.

distancesLength (In): The number of elements in the distances function argument.

speeds (In): The speeds at which to move each of the axes.

speedsLength (In): The number of elements in the speeds function argument.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Clears the program position offsets on the specified axes. The program positions will be restored to the current axis positions.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axes (In): The axes on which to clear the program position offsets.

axesLength (In): The number of elements in the axes function argument.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Sets the program positions of the specified axes to the specified values. The controller applies an offset to the current axis positions so that the axes do not move. All moves that specify an absolute target-position will be relative to the new program position.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axes (In): The axes on which to set the program positions.

axesLength (In): The number of elements in the axes function argument.

programPositions (In): The new program positions to set.

programPositionsLength (In): The number of elements in the programPositions function argument.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Waits for motion to be done on the specified axes and for the axes to be in position. The motion is done when the commanded velocity is at zero. The axes are in position when the position error is at the threshold specified by the InPositionTime and InPositionDistance parameters.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axes (In): The axes on which to wait for motion to be done and in position.

axesLength (In): The number of elements in the axes function argument.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Waits for motion to be done on the specified axes. The motion is done when the commanded velocity is at zero.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axes (In): The axes on which to wait for motion to be done.

axesLength (In): The number of elements in the axes function argument.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures the specified work offset on the specified axes and values. Previously configured axes will retain their values unless overwritten.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

offsetNumber (In): The index of the work offset to configure. An integer between and including 1 and 100.

axes (In): The axes on which to configure work offset values.

axesLength (In): The number of elements in the axes function argument.

programPositions (In): The program positions to set as the work offset origin.

programPositionsLength (In): The number of elements in the programPositions function argument.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Deactivates work offsets for all axes on the controller.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axes (In): The axes on which to disable work offsets.

axesLength (In): The number of elements in the axes function argument.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Activates the specified work offset and applies offsets to the specified axes.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

offsetNumber (In): The index of the work offset to enable. An integer between and including 1 and 100.

axes (In): The axes on which to enable the specified work offset.

axesLength (In): The number of elements in the axes function argument.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Erases the work offset configurations on all axes. All work offsets must first be disabled.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Removes all motion restrictions from the selected axes.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axes (In): The axes from which to remove motion restrictions.

axesLength (In): The number of elements in the axes function argument.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Applies motion restrictions to the selected axes. This function restricts the motion, home, and enable features on the selected axes.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axes (In): The axes on which to apply motion restrictions.

axesLength (In): The number of elements in the axes function argument.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Sets a ramp type along with a ramp type value for accelerations and decelerations separately for an axis.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to set the ramp type.

rampTypeAccel (In): The ramping type to set during accelerations.

rampTypeArgAccel (In): The ramping type additional argument for accelerations. This is only used when $rampTypeAccel is RampType.SCurve and represents the s-curve percentage.

rampTypeDecel (In): The ramping type to set during decelerations.

rampTypeArgDecel (In): The ramping type additional argument for decelerations. This is only used when $rampTypeDecel is RampType.SCurve and represents the s-curve percentage.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Sets a ramp value for accelerations and decelerations separately for an axis.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to set the ramp value.

rampModeAccel (In): The ramping mode to set during accelerations.

rampValueAccel (In): The ramp value to set during accelerations.

rampModeDecel (In): The ramping mode to set during decelerations.

rampValueDecel (In): The ramp value to set during decelerations.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Sets the speed of an axis for MoveRapid() motion.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to set the speed.

speed (In): The speed to set.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Sets the maximum acceleration of coordinated motion on dominant axes on the current task.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

accelLimitNonTangent (In): The maximum acceleration of axes at non-tangent portions of a motion path.

accelLimitCircular (In): The maximum acceleration of axes at curved parts of a motion path.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Sets a coordinated ramp type along with a ramp type value for accelerations and decelerations separately for dominant axes on the current task.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

rampTypeAccel (In): The ramping type to set during accelerations.

rampTypeArgAccel (In): The ramping type additional argument for accelerations. This is only used when $rampTypeAccel is RampType.SCurve and represents the s-curve percentage.

rampTypeDecel (In): The ramping type to set during decelerations.

rampTypeArgDecel (In): The ramping type additional argument for decelerations. This is only used when $rampTypeDecel is RampType.SCurve and represents the s-curve percentage.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Sets a coordinated ramp value for accelerations and decelerations separately for dominant axes on the current task.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

rampModeAccel (In): The ramping mode to set during accelerations.

rampValueAccel (In): The ramp value to set during accelerations.

rampModeDecel (In): The ramping mode to set during decelerations.

rampValueDecel (In): The ramp value to set during decelerations.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Sets the coordinated speed for dominant axes on the current task.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

speed (In): The speed to set.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Sets the maximum acceleration of coordinated motion on dependent axes on the current task.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

accelLimitDependent (In): The maximum acceleration of axes at all portions of a motion path.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Sets a coordinated ramp rate for accelerations and decelerations separately for dependent axes on the current task.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

rampValueAccel (In): The ramp rate value to set during accelerations.

rampValueDecel (In): The ramp rate value to set during decelerations.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Sets the coordinated speed for dependent axes on the current task.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

speed (In): The speed to set.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Sets the distance units of the current task.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

distanceUnits (In): The distance units to set.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Sets the target mode of the current task.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

targetMode (In): The target mode to set.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Sets the time units of the current task.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

timeUnits (In): The time units to set.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Sets the wait mode of the current task.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

waitMode (In): The wait mode to set.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures an array of PSO bit data words, where each word is a 32-bit integer.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure the bit data.

driveArrayStartAddress (In): The byte-addressable index of the drive array where the first word of bit data is stored.

numberOfPoints (In): The number of bit data words to be read from the drive array.

enableRepeat (In): Configures PSO to continue to use bit data words after the last word in the array is used, starting over at the first word.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures the distance counter tracking directions that will cause PSO distance events.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure the distance event directions.

eventDirection (In): The distance event directions to set.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures an array of distances in counts that the PSO counter or counters must travel for an event to occur.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure the distances.

driveArrayStartAddress (In): The byte-addressable index of the drive array where the first distance is stored.

numberOfDistances (In): The number of distances to be read from the drive array.

enableRepeat (In): Configures PSO to continue to use distances after the last distance in the array is used, starting over at the first distance.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures the conditions which will reset the PSO distance counters.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure the distance counter reset conditions.

optionsMask (In): A bitmask of PSO distance counter reset options. Use the values from the PsoDistanceCounterResetMask enum.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures the distance in counts that the PSO counter or counters must travel for an event to occur.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure the distance.

distance (In): The distance in counts.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Selects the source of each PSO distance counter.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure the distance counter sources.

inputs (In): An array of one to three input sources, one for each distance counter.

inputsLength (In): The number of elements in the inputs function argument.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures the PSO distance counters to apply an integer scale factor for each tracking input.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure the scale factors.

scaleFactors (In): An array of one to three integer scale factors, one per tracking input.

scaleFactorsLength (In): The number of elements in the scaleFactors function argument.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Disables the PSO distance counters, causing them to retain their values and ignore their configured inputs.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to disable the PSO distance counters.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Enables the PSO distance counters, allowing them to track their configured inputs.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to enable the PSO distance counters.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Disables PSO distance events.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to disable distance events.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Enables PSO distance events.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to enable distance events.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures additional conditions to prevent PSO events from occurring.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure the event mask conditions.

eventMask (In): A bitmask of event mask conditions. Use the values from the PsoEventMask enum.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Immediately halts active continuous PSO events.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to halt the events.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Immediately causes continuous PSO events to occur.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to cause the events.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Immediately causes a single PSO event to occur.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to cause the event.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Disables PSO laser events.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to disable PSO laser events.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures the PSO to generate an event when the laser command bit turns on.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to generate laser PSO events.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Selects the output pin on which to drive the PSO output.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to select the PSO output pin.

output (In): The selected output pin.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Selects which internal PSO signal to drive onto the output pin.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to select the PSO output source.

outputSource (In): The selected output source.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Immediately deactivates the PSO output.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to deactivate the PSO output.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Immediately activates the PSO output.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to activate the PSO output.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Resets all PSO configuration, which restores all PSO settings to their default values.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to reset the PSO configuration.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures a PSO input transformation channel.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure the transformation channel.

transformationChannel (In): The transformation channel to configure.

inputA (In): The first input to the transformation.

inputB (In): The second input to the transformation.

transformationFunction (In): The function of the transformation.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Disables a PSO input transformation channel.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to disable the transformation channel.

transformationChannel (In): The transformation channel to disable.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Enables a PSO input transformation channel.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to enable the transformation channel.

transformationChannel (In): The transformation channel to enable.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Checks for a valid configuration of pulse mode parameters and applies the configuration to the waveform module.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to apply the pulse configuration.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Checks for a valid configuration of PWM mode parameters and applies the configuration to the waveform module.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to apply the PWM configuration.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures the waveform module to wait for the specified time after a PSO event before beginning to output a waveform.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure the waveform output delay.

delayTime (In): The delay time in microseconds.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Selects the output mode of the waveform module.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to select the output mode of the waveform module.

waveformMode (In): Mode selection for the waveform module output.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures an array of pulse counts for a sequence of waveform module outputs in pulse mode. The pulse count specifies the number of periods that will be generated from a single PSO event.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure the pulse counts.

driveArrayStartAddress (In): The byte-addressable index of the drive array where the first pulse count is stored.

numberOfPoints (In): The number of pulse counts to be read from the drive array.

enableRepeat (In): Configures PSO to continue to use pulse counts after the last pulse count in the array is used, starting over at the first pulse count.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures an array of on times for a sequence of waveform module outputs in pulse mode. The on time specifies the active portion of the pulse period.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure the on times.

driveArrayStartAddress (In): The byte-addressable index of the drive array where the first on time is stored.

numberOfPoints (In): The number of on times to be read from the drive array.

enableRepeat (In): Configures PSO to continue to use on times after the last on time in the array is used, starting over at the first on time.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures an array of total times for a sequence of waveform module outputs in pulse mode. The total time specifies the full period of the pulse.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure the total times.

driveArrayStartAddress (In): The byte-addressable index of the drive array where the first total time is stored.

numberOfPoints (In): The number of total times to be read from the drive array.

enableRepeat (In): Configures PSO to continue to use total times after the last total time in the array is used, starting over at the first total time.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures the maximum number of events in the queue. Each event in the queue will cause a PSO waveform pulse generation to occur after the active waveform period completes.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure the queue for the PSO waveform pulse event.

maxQueuedEvents (In): The maximum number of events to put in the queue.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures the fixed pulse count of the waveform module output in pulse mode, which will be applied to all pulses. The pulse count specifies the number of periods that will be generated from a single PSO event.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure the number of pulses.

pulseCount (In): The integer number of pulses.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures the fixed on time of the waveform module output in pulse mode, which will be applied to all pulses. The on time specifies the active portion of the pulse period.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure the on time.

onTime (In): The on time in microseconds.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures the fixed total time of the waveform module output in pulse mode, which will be applied to all pulses. The total time specifies the full period of the pulse.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure the total time.

totalTime (In): The total time in microseconds.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures additional conditions to disable the PSO waveform output in pulse mode.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure PSO waveform pulse mode masking options.

pulseMask (In): A bitmask of PSO waveform pulse mode masking options. Use the values from the PsoWaveformPulseMask enum.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Allows or prevents the waveform module from outputting truncated waveform outputs in pulse mode.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure the pulse truncation prevention feature.

preventTruncation (In): Configures the waveform module to not allow the generation of truncated waveform outputs in pulse mode.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures an array of on times for a sequence of waveform module outputs in PWM mode. The on time specifies the variable active portion of the PWM signal.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure the on times.

driveArrayStartAddress (In): The byte-addressable index of the drive array where the first on time is stored.

numberOfPoints (In): The number of on times to be read from the drive array.

enableRepeat (In): Configures PSO to continue to use on times after the last on time in the array is used, starting over at the first on time.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures the fixed total time of the waveform module output in PWM mode. The total time specifies the full period of the PWM signal.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure the total time.

totalTime (In): The total time in microseconds.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures the delay mode of the waveform module when you use the external synchronization signal.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure the external sync delay mode.

delayMode (In): The external sync delay mode.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Disables the external sync option for the waveform module.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to disable external sync option.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures the waveform module to wait for the rising edge of the external sync signal before beginning to output a waveform.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to enable external sync option.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Disables the waveform module, preventing PSO events from triggering it.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to disable the waveform module.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Enables the waveform module, allowing PSO events to trigger it.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to enable the waveform module.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Specifies the configuration of the optional PSO waveform scaling feature.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure PSO waveform scaling.

scalingMode (In): Specifies the waveform parameters to which to apply the PSO waveform scaling.

scalingInput (In): Specifies the input to the PSO waveform scaling.

inputRange (In): Specifies the range of values in which the configured input will be used to calculate the scale factor to apply to the waveform parameters.

inputRangeLength (In): The number of elements in the inputRange function argument.

scaleFactorRange (In): Specifies the valid range of scale factor outputs from the PSO waveform scaling feature.

scaleFactorRangeLength (In): The number of elements in the scaleFactorRange function argument.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Deactivates PSO waveform scaling.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to deactivate PSO waveform scaling.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Activates PSO waveform scaling.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to activate PSO waveform scaling.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures an array of window range pairs each consisting of a lower bound followed by an upper bound.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure the window ranges.

windowNumber (In): The number of the window on which to configure the ranges.

driveArrayStartAddress (In): The byte-addressable index of the drive array where the lower bound of the first range pair is stored.

numberOfRanges (In): The number of range value pairs to be read from the drive array.

enableRepeat (In): Configures PSO to continue to use range pairs after the last range pair in the array is used, starting over at the first range pair.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Deprecated: This command is deprecated and will be removed in the next major version of Automation1 software. This function has been obsoleted by PsoWindowConfigureEventDirection(). Use that function instead to specify the update behavior of the PSO Window ranges in array mode.

Configures the array of window range pairs to update when exiting the active window range in specific directions.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure the window array update direction.

windowNumber (In): The number of the window on which to configure the array update direction.

windowUpdateDirection (In): Mode selection to select the active window range exit directions on which to update the window range.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures the conditions which will reset the PSO window counters.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure the window counter reset conditions.

optionsMask (In): A bitmask of PSO window counter reset options. Use the values from the PsoWindowCounterResetMask enum.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures the directions which will trigger an internal window event upon entering or exiting the active window.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure the window event direction.

windowNumber (In): The number of the window on which to configure the window event direction.

windowEventDirection (In): Specifies the directions which will trigger an internal window event upon entering or exiting the active window.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures the conditions which will generate PSO window events.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure the window event conditions.

eventMode (In): The specified window event mode.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Configures a fixed window range consisting of a lower bound and an upper bound for the specified window.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to configure the window range.

windowNumber (In): The number of the window on which to configure the range.

lowerBound (In): The value for the window range lower bound.

upperBound (In): The value for the window range upper bound.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Selects the source of the specified window counter.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to select the window counter input source.

windowNumber (In): The window number for which to select the counter input source.

input (In): The window counter input source.

reverseDirection (In): Configures the window counter to count in the opposite direction of its input source.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Sets the specified window counter to the specified value.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to set the window counter.

windowNumber (In): The number of the window on which to set the counter.

value (In): The new counter value.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Disables the specified window output.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to disable the window output.

windowNumber (In): The number of the window on which to disable the output.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Enables the specified window output.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to enable the window output.

windowNumber (In): The number of the window on which to enable the output.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Adds a boundary to the specified safe zone.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

zone (In): The index of the safe zone on which to add a boundary.

axis (In): The axis that represents the boundary to add.

lowerBound (In): The safe zone lower boundary, specified in user units.

upperBound (In): The safe zone upper boundary, specified in user units.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Removes the specified boundary from the specified safe zone.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

zone (In): The index of the safe zone on which to remove a boundary.

axis (In): The axis that represents the boundary to remove.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Removes all boundaries from the specified safe zone.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

zone (In): The index of the safe zone on which to remove all boundaries.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Disables the specified safe zone.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

zone (In): The safe zone to disable.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Enables the specified safe zone.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

zone (In): The safe zone to enable.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Sets the safe zone type for the specified safe zone.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

zone (In): The safe zone on which to set the safe zone type.

zoneType (In): The safe zone type to set.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Sets the specified feedforward gain values on the specified axis.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to set the gain values.

feedforwardGains (In): An array of feedforward gains to set.

feedforwardGainsLength (In): The number of elements in the feedforwardGains function argument.

feedforwardGainValues (In): An array of feedforward gain values to set.

feedforwardGainValuesLength (In): The number of elements in the feedforwardGainValues function argument.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Generates an open-loop current command at a fixed electrical angle.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to command current.

current (In): The current to output, specified in amperes.

angle (In): The electrical angle, specified in degrees. 360 degrees is one electrical commutation cycle of the motor.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Generates an open-loop current command at a rotating electrical angle.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to command current.

current (In): The current to output, specified in amperes.

duration (In): The amount of time to output current, specified in milliseconds. Specify 0 to output current continuously.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Sets the specified servo loop gain values on the specified axis.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis on which to set the gain values.

servoGains (In): An array of servo loop gains to set.

servoGainsLength (In): The number of elements in the servoGains function argument.

servoGainValues (In): An array of servo loop gain values to set.

servoGainValuesLength (In): The number of elements in the servoGainValues function argument.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Disable a C transformation. This will stop running inverse and forward computations for this transformation.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

transformationName (In): The name specified in the C Transformation configuration.

This string argument must be null terminated.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Enable a C transformation. This will begin running inverse and forward computations for the specified transformation. All axes part of the transformation must be enabled at any time the transformation is enabled. If the transformation is enabled while there is synchronous motion on the same task, then the motion program will wait for motion to complete before enabling the transformation.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

transformationName (In): The name specified in the C Transformation configuration.

This string argument must be null terminated.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Call the OnGetProperty() C function defined in a C transformation.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

transformationName (In): The name specified in the C Transformation configuration.

This string argument must be null terminated.

property (In): The property argument provided to the OnGetProperty() C function.

This string argument must be null terminated.

returnOut (Out): The value argument set by the OnGetProperty() C function.

Only use this if the function call was successful.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Set the input axes of a C transformation.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

transformationName (In): The name specified in the C Transformation configuration.

This string argument must be null terminated.

inputAxes (In): The input axes of the transformation. Motion from these axes are input to the transformation.

inputAxesLength (In): The number of elements in the inputAxes function argument.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Set the output axes of a C transformation.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

transformationName (In): The name specified in the C Transformation configuration.

This string argument must be null terminated.

outputAxes (In): The output axes of the transformation. The transformation outputs motion to these axes.

outputAxesLength (In): The number of elements in the outputAxes function argument.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Call the OnSetProperty() C function defined in a C transformation.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

transformationName (In): The name specified in the C Transformation configuration.

This string argument must be null terminated.

property (In): The property argument provided to the OnSetProperty() C function.

This string argument must be null terminated.

value (In): The value argument provided to the OnSetProperty() C function.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Returns the value in user units of a specified value in counts.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis to use when performing the conversion.

counts (In): The value in counts.

returnOut (Out): The value converted to user units.

Only use this if the function call was successful.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.

Returns the value in counts of a specified value in user units.

controller (In): The Automation1 controller on which to perform this AeroScript command.

executionTaskIndex (In): The index of the task on which to execute the AeroScript command.

axis (In): The axis to use when performing the conversion.

units (In): The value in user units.

returnOut (Out): The value converted to counts.

Only use this if the function call was successful.

Returns: True if the AeroScript command executed successfully on the controller. False if the AeroScript command did not execute on the controller. See the Automation1_GetLastError() and Automation1_GetLastErrorMessage() functions for more information. You can find information about these functions in the Errors and Error Handling section of the C API Guidelines.