Command Queue in the C API
You are reading our Automation1 API documentation for the C programming language.
The Basics
In the C API, Command Queue lets you execute AeroScript commands on the Automation1 controller in a first-in, first-out process.
IMPORTANT: Before you read more about the command queue, make sure that you read the Commands page first. This page builds on that information.
When you execute non-queued AeroScript commands through the C API, a quantity of fixed overhead occurs. When you execute two commands, one immediately after the other, there is some delay that occurs between the commands. This delay averages from 3 to 5 milliseconds, based on network latency and 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.
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. If you do not use one, your profile will stutter and drop out because of the delay that occurs between the commands. If you are doing submillisecond PVTs, you must add the PVTs inside of a CriticalSectionStart() / CriticalSectionEnd() block. If you do not use the critical section functions, the motion will not be continuous. Refer to the Task Scheduling section of Task and Program Functions for more information.
A command queue on a task stores all the AeroScript commands that you add. It executes them sequentially in the order that they were added, which is a first-in, first-out process. If you add AeroScript commands to the command queue, the C function that you called to add the commands does not block unless the conditions that follow occur:
- The command queue is full.
- You specified the command queue to block when it is full.
If these two conditions do not occur, the AeroScript commands are added to the command queue. But all the commands that were previously added will execute first. Then the AeroScript commands will execute.
Typically, it is necessary for you to use a command queue when one of these conditions apply:
- Your process cannot accept the delay that occurs between AeroScript commands that are executing.
- You want to use AeroScript commands that are compatible only with a command queue.
A command queue exists on a specific controller task. That task can execute only queued commands while the command queue is active. While a command queue is active, the restrictions that follow apply:
- Non-queued AeroScript commands cannot execute.
- AeroScript programs cannot run.
- You cannot use retrace.
- You cannot use interrupt motion.
- You cannot use the AeroScript sync statement to execute a function on the controller task where a command queue exists. You can use the AeroScript sync statement to execute a function on a different task.
- You cannot use the AeroScript statements that follow:
- program statement
- if statement
- switch statement
- goto statement
- break statement
- continue statement
- while loop
- for loop
- foreach loop
- repeat loop
- You cannot declare an AeroScript variable, struct, enum, property, or function.
- You cannot execute the AeroScript functions that follow:
- ProgramStop()
- ProgramPause()
- ProgramReset()
- ProgramRestart()
- ProgramLoad()
- ProgramStepInto()
- ProgramStepOver()
- ProgramStepOut()
- AeroScript functions apply all relative paths as absolute paths.
WARNING: You must keep the command queue populated at all times. If the command queue is not populated, your process will stall and motion problems might occur.
If the command queue is emptied, this will interrupt any velocity blending or lookahead synchronization and the axes will decelerate to zero velocity. Make sure that you add AeroScript commands to the command queue faster than the command queue can execute them.
Tip: After you begin a command queue, you might want to pause it. Then you can add many AeroScript commands before you continue the command queue.
How to Use
Command Queue is part of the controller runtime. Thus the Automation1 controller must be running before you do work with a command queue. For more information, see the Controller page. If you reset the Automation1 controller, this process will stop all the active command queues.
To use a command queue, you must first begin a command queue on a specific task and with a specific AeroScript command capacity. Use the Automation1_CommandQueue_Begin() function. This function gives you an Automation1CommandQueue handle. The shouldBlockIfFull argument controls the behavior of how an AeroScript command is added to a command queue that is full:
- If you specify the argument as true, the add blocks until the AeroScript command can be added to the queue.
- If you specify the argument as false, the add returns an error.
bool Automation1_CommandQueue_Begin(Automation1Controller controller, int32_t taskIndex, int32_t commandCapacity, bool shouldBlockIfFull, Automation1CommandQueue* commandQueueOut);The command capacity specifies the maximum number of AeroScript commands that you can add to the command queue before it is full. When the command queue is full, you cannot continue to add new AeroScript commands. A larger command capacity uses more controller memory. The controller memory is limited.
WARNING: If you specify a command capacity that is too large, memory allocation errors can occur. If they occur, you must decrease your command capacity.
When the command queue begins on a specific task, non-queued AeroScript commands cannot execute and AeroScript programs cannot run on that task.
Also, the execution of commands is not paused. Thus, AeroScript commands that you add to the queue will immediately start to execute and the state of the task becomes Queue Running. If you enable the feedhold state on the task, the state of the task continues as Queue Running.
To pause the execution of commands in the command queue, use Queue Paused. Refer to the example that follows.
bool Automation1_CommandQueue_Pause(Automation1CommandQueue commandQueue);If the execution of commands is paused in the command queue, you can use
bool Automation1_CommandQueue_Resume(Automation1CommandQueue commandQueue);You can use functions to add AeroScript commands to the command queue. These functions require an Automation1CommandQueue handle. When you add AeroScript commands, they are not executed immediately. Instead, they are queued for execution. All the commands that you previously added are executed first. Then the newest AeroScript commands that you added will execute. These functions do not block unless the conditions that follow occur:
- The command queue is full.
- You specified the command queue to block when it is full.
bool Automation1_CommandQueue_Enable(Automation1CommandQueue commandQueue, int32_t* axes, int32_t axesLength);
bool Automation1_CommandQueue_MoveLinear(Automation1CommandQueue commandQueue, int32_t* axes, int32_t axesLength, double* distances, int32_t distancesLength, double coordinatedSpeed);
bool Automation1_CommandQueue_Disable(Automation1CommandQueue commandQueue, int32_t* axes, int32_t axesLength);To see a list of all the C functions that you can use for Command Queue, refer to the Full Reference section of this page.
While the command queue is active, you can examine its status to find the information that follows:
- The number of AeroScript commands that were executed.
- The number of AeroScript commands in the command queue that still need to be executed.
bool Automation1_CommandQueue_GetStatus(Automation1CommandQueue commandQueue, Automation1CommandQueueStatus* commandQueueStatusOut);If you want to wait for the command queue to empty and complete its execution of all the commands that you added to it, use the Automation1_CommandQueue_WaitForEmpty() function. This function blocks until the command queue is fully empty. Then this function returns and your code execution continues.
bool Automation1_CommandQueue_WaitForEmpty(Automation1CommandQueue commandQueue, int32_t millisecondsTimeout);When you are done using the command queue, call the Automation1_CommandQueue_End() function. This function ends the command queue, frees memory, and returns the task to its normal state.
Automation1_CommandQueue_End(Automation1CommandQueue commandQueue, int32_t millisecondsTimeout);If you end a command queue that is currently executing a command, that command is aborted and all the queued AeroScript commands are discarded. To prevent this from occurring, use the Automation1_CommandQueue_WaitForEmpty() function when you end the command queue. This function makes sure that the command queue is not executing commands.
If you execute AeroScript motion commands that require Lookahead Synchronization such as velocity blending, cutter radius compensation, and corner rounding, or if you execute a series of MovePt() or MovePvt() commands, the command queue can finish executing commands before the controller finishes producing motion for those commands. Use the WaitForMotionDone() command or the WaitForInPosition() command to prevent the command queue from finishing executing commands before the controller finishes producing motion.
After you end the command queue, non-queued AeroScript commands can execute and AeroScript programs can run on that task. You cannot continue to use the Automation1CommandQueue handle. To make a new command queue, you must call the Automation1_CommandQueue_Begin() function again.
Execute Custom AeroScript
You can execute most AeroScript commands through the C API. In some special cases, you must execute custom AeroScript directly or execute a file that contains the custom AeroScript.
Execute Custom AeroScript Directly
To execute custom AeroScript directly, use the Automation1_CommandQueue_Execute() function to specify the custom AeroScript that you want to add to the command queue. Refer to the example that follows.
bool Automation1_CommandQueue_Execute(Automation1CommandQueue commandQueue, const char* aeroScriptText);The aeroScriptText parameter can include one or more lines of AeroScript. You can separate one or more lines of AeroScript with newline characters, which include CR, LF, and CRLF. If the aeroScriptText parameter has one or more lines, the Automation1TaskStatusItem_CommandQueueLineNumber status item will be incremented by the number of lines in the string. If the Automation1TaskStatusItem_CommandQueueExecutedCount status item and the Automation1CommandQueueStatus struct member NumberOfExecutedCommands have one or more lines, they will be incremented by 1. This occurs because there is a difference between lines of AeroScript and a command that has one or more lines of AeroScript.
Execute Custom AeroScript from a File
You can have the C API read from a file and automatically insert lines of AeroScript as commands into a command queue. You can do this with an MDK file or a controller file. This process can help you if you already have a file with all of your AeroScript or if you want to separate your AeroScript process from your custom C application. The specified file can include simple lines of AeroScript only. The file cannot have variables, if statements, loops, or other control flow statements.
To execute an MDK file that has lines of AeroScript, use the Automation1_CommandQueue_ExecuteFromMdkFile() function. To execute a controller file that has lines of AeroScript, use the Automation1_CommandQueue_ExecuteFromControllerFile() function. For more information about the MDK and controller file systems, see Working with Files.
Aerotech recommends that you set the shouldBlockIfFull argument to True when you create a command queue that is executed from a file. If it is set to False and the command queue fills while reading the file, then Automation1_CommandQueue_Execute() or Automation1_CommandQueue_ExecuteFromFile() will return False.
To increase throughput, lines of AeroScript from the file are added to the command queue as commands that have one or more lines. The numberOfLinesPerCommand argument defines the number of file lines to read from the file for each command. You can set the numberOfLinesPerCommand argument to 1000, which is applicable most of the time. If the command queue is empty before the file is fully read, set the numberOfLinesPerCommand argument to more than 1000. The value of this argument depends on the performance of your PC and is not deterministic.
WARNING: If you specify a value for the numberOfLinesPerCommand argument that is too large, memory allocation errors can occur. If you get memory allocation errors, decrease the value of this argument.
When the Automation1_CommandQueue_ExecuteFromMdkFile() or Automation1_CommandQueue_ExecuteFromControllerFile() function returns, there can be remaining lines of AeroScript from the file that were executed and are still in the command queue. Use the Automation1_CommandQueue_WaitForEmpty() function to make sure all AeroScript commands have executed. Refer to the example that follows.
Automation1CommandQueue commandQueueOut = NULL;
if (!Automation1_CommandQueue_Begin(controller, 1, 100, true, &commandQueueOut)) { /* handle error */}
if (!Automation1_CommandQueue_ExecuteFromMdkFile(commandQueueOut, "MovePvt20kHz.txt" , 1000)) { /* handle error */ }
if (!Automation1_CommandQueue_WaitForEmpty(commandQueue, -1)) { /* handle error */ }If the controller executes blank lines on the command queue, this will not cause an exception.
AeroScript Commands
You can use AeroScript commands to change the state of a command queue.
If the execution of queued AeroScript commands from the command queue is not paused at this time, use the AeroScript functions that follow to pause the execution of commands from the queue.
CommandQueuePause($task as integer)
If the execution of queued AeroScript commands from the command queue is currently paused, use the AeroScript function that follows to continue the execution of commands from the queue.
Use the AeroScript functions that follow to stop the command queue.
CommandQueueStop($task as integer)
Example Code
int32_t task1 = 1;
int32_t axisX = 0;
double distance1 = 10.0;
double distance2 = 10.0;
Automation1CommandQueue commandQueue = NULL;
// Begin a new command queue on task 1.
if (!Automation1_CommandQueue_Begin(controller, task1, 10, true, &commandQueue)) { /* handle error */ }
// First, pause the command queue so that you can add all the commands before they are executed.
if (!Automation1_CommandQueue_Pause(commandQueue)) { /* handle error */ }
// Add all the AeroScript commands that you want to execute.
if (!Automation1_CommandQueue_VelocityBlendingOn(commandQueue)) { /* handle error */ }
if (!Automation1_CommandQueue_Enable(commandQueue, &axisX, 1)) { /* handle error */ }
if (!Automation1_CommandQueue_MoveLinear(commandQueue, &axisX, 1, &distance1, 1, 5.0)) { /* handle error */ }
if (!Automation1_CommandQueue_MoveLinear(commandQueue, &axisX, 1, &distance2, 1, 5.0)) { /* handle error */ }
if (!Automation1_CommandQueue_Disable(commandQueue, &axisX, 1)) { /* handle error */ }
if (!Automation1_CommandQueue_VelocityBlendingOff(commandQueue)) { /* handle error */ }
// Resume the command queue so that all the commands that you added start to execute.
if (!Automation1_CommandQueue_Resume(commandQueue)) { /* handle error */ }
// Here you can do other things, such as more process, get status, etc.
// You can do these things because the command queue is executing commands on the controller and is not blocking your code execution.
// Here you wait to make sure that the command queue executes all the commands. You must do this before you end the command queue.
// When you end the command queue, this process aborts all motion and commands.
if (!Automation1_CommandQueue_WaitForEmpty(commandQueue, -1)) { /* handle error */ }
// At this time, end the command queue.
// You can also call the Automation1_CommandQueue_End() function to abort the command that is currently executing and discard the remaining commands.
if (!Automation1_CommandQueue_End(commandQueue, -1)) { /* handle error */ }
// Set the command queue handle to null because it is not valid after you end the command queue.
commandQueue = NULL;Thread Safety
The Automation1_CommandQueue_Begin() function is thread safe. You can call it from two or more threads without interference.
The Automation1_CommandQueue_End() function is not thread safe. Only one thread should call this function for a single Automation1CommandQueue handle.
The other Automation1_CommandQueue_ functions and the Automation1CommandQueue handle are not thread safe. Only one thread at a time can call these functions or access this handle. If it is necessary for two or more threads to call these functions or access this handle, you must use locks to limit the access.
Full Reference
For more information about the structs and functions that are available for Command Queue, refer to the lists that follow.
Automation1CommandQueueStatus struct
Represents the status of a command queue on an Automation1 controller.
bool IsPaused
Gets information that lets you know if the command queue is currently paused.
bool isEmpty
Gets information that lets you know if the command queue is empty. If it is empty, there is no AeroScript command that is currently executing and there are no other AeroScript commands in the command queue.
int32_t NumberOfExecutedCommands
Gets the total number of commands that the command queue executed over its full lifespan. One command can have one or more lines of AeroScript if you call the Automation1_CommandQueue_Execute() function with a string of AeroScript that has one or more lines. This status item gets the number of commands that were executed in the command queue, even when there are one or more lines of AeroScript in each command.
int32_t NumberOfUnexecutedCommands
Gets the total number of commands that were added to the command queue and still need to execute. If there is an AeroScript command that is currently executing, it is included in this number. One command can have one or more lines of AeroScript if you call the Automation1_CommandQueue_Execute() function with a string of AeroScript that has one or more lines. This status item gets the number of commands in the command queue that were not executed, even when there are one or more lines of AeroScript in each command.
int32_t NumberOfTimesEmptied
Gets the number of times the command queue was emptied.
Functions
> bool Automation1_CommandQueue_GetStatus(Automation1CommandQueue commandQueue, Automation1CommandQueueStatus* commandQueueStatusOut)
Gets the current status of a command queue.
commandQueue (In): The command queue for which to retrieve the status.
commandQueueStatusOut (Out): The current status of the command queue. Use this argument only if the function call was successful. This argument must have memory preallocated before you pass it into this function.
Returns: True if the status of the command queue was retrieved successfully. False if the status of the command queue was not retrieved. 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.
> bool Automation1_CommandQueue_Begin(Automation1Controller controller, int32_t taskIndex, int32_t commandCapacity, bool shouldBlockIfFull, Automation1CommandQueue* commandQueueOut)
Starts a command queue on the specified task. A command queue on a task will store all the AeroScript commands that are added to the command queue and execute them sequentially, in the order that they were added. When you add AeroScript commands to the command queue, this process does not block unless the command queue is full and the argument shouldBlockIfFull is true. Instead, the AeroScript command is added to the command queue and will be executed in the future after all the previously added commands are executed. A command queue is usually used to prevent communication latency from occurring between AeroScript commands when you execute motion with the Commands API. (For Example: Let's say that you use velocity blending. For this type of motion, the communication latency will cause deceleration to occur.) The specified task can execute only queued commands while the command queue is active. Non-queued commands from the Commands API and AeroScript programs cannot run while the command queue is active. When you are done using the command queue, call the Automation1_CommandQueue_End() function to prevent memory from leaking, stop the command queue on the specified task, and return the task to normal AeroScript execution.
controller (In): A handle that represents a connection to an Automation1 controller.
taskIndex (In): The index of the task on which to create a command queue.
commandCapacity (In): The maximum number of unexecuted AeroScript commands that can be stored in the command queue, after which the command queue is full. If the number of unexecuted AeroScript commands in the command queue increases to this number, the next AeroScript command that you add will either block until the command can be added (if shouldBlockIfFull is true) or return an error (if shouldBlockIfFull is false).
shouldBlockIfFull (In): Whether or not to block if you add an AeroScript command while the command queue is full. If true, the add will block until the command can be added. If false, an error will occur.
commandQueueOut (Out): A handle that represents a command queue on a task on the Automation1 controller. Use this handle only if the function call was successful.
Returns: True if the creation of the command queue was successful. False if the creation of the command queue was not successful. 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.
> bool Automation1_CommandQueue_WaitForEmpty(Automation1CommandQueue commandQueue, int32_t millisecondsTimeout)
Waits for the command queue to become empty, blocking until all the AeroScript commands that you added to the command queue are executed. You can use this function to make sure that the command queue is done executing commands before you end it with the Automation1_CommandQueue_End() function.
commandQueue (In): The command queue for which you wait for the execution of all the AeroScript commands to be completed.
millisecondsTimeout (In): The number of milliseconds that you wait for the command queue to empty. If the command queue uses more than this quantity of time to become empty, this function will return. If you set this value to -1, this function will wait indefinitely for the command queue to become empty.
Returns: True if the command queue successfully completed the execution of all of its AeroScript commands or the timeout has been reached. False if the command queue did not execute all of its AeroScript commands or the timeout was not reached. 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.
> bool Automation1_CommandQueue_Resume(Automation1CommandQueue commandQueue)
Resumes the execution of queued AeroScript commands from a command queue.
commandQueue (In): The command queue from which to start the execution of commands.
Returns: True if the execution of AeroScript commands has resumed or the command queue was already executing AeroScript commands. False if the execution of commands did not resume or the command queue was not already executing AeroScript commands. 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.
> bool Automation1_CommandQueue_Pause(Automation1CommandQueue commandQueue)
Pauses the execution of queued AeroScript commands from a command queue. If there is an AeroScript command that is currently executing, it will complete normally. The command will not be aborted.
commandQueue (In): The command queue for which to pause the execution of AeroScript commands.
Returns: True if the execution of AeroScript commands has paused or the command queue was already paused. False if the execution of AeroScript commands did not pause or the command queue was not already paused. 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.
> bool Automation1_CommandQueue_End(Automation1CommandQueue commandQueue, int32_t millisecondsTimeout)
Stops the command queue on the task and returns the task to normal AeroScript execution. If there is an AeroScript command that is currently executing, it will be aborted. All the remaining AeroScript commands that are queued will be discarded. After you calling this function, you cannot continue to use this command queue handle.
commandQueue (In): The command queue to end.
millisecondsTimeout (In): The number of milliseconds to wait to end the command queue. If the command queue uses more than this quantity of time to end, the function will fail. If you set this value to -1, this function will wait indefinitely for the command queue to end.
Returns: True if the execution of commands from the command queue has stopped. False if the execution of commands from the command queue did not stop. 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.
> bool Automation1_CommandQueue_Execute(Automation1CommandQueue commandQueue, const char* aeroScriptText)
Adds an AeroScript command to the command queue. This function does not block unless the command queue is full and commandQueue argument shouldBlockIfFull is set to true. Instead, the AeroScript command is added to the command queue and will execute in the future after all the commands that you previously added are executed.
commandQueue (In): The command queue on which to perform this AeroScript command.
aeroScriptText (In): The null-terminated AeroScript string text to compile and add to the command queue.
Returns: True if the AeroScript command was compiled and added to the command queue. False if the AeroScript command was not compiled and added to the command queue. 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.
> bool Automation1_CommandQueue_CammingFreeTable(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int64_t tableNum)
Adds the CammingFreeTable command to the command queue.
Unloads a camming table from the SMC.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_CammingLoadTableFromArray(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int64_t tableNum, double* leaderValues, int32_t leaderValuesLength, double* followerValues, int32_t followerValuesLength, int64_t numValues, Automation1CammingUnits unitsMode, Automation1CammingInterpolation interpolationMode, Automation1CammingWrapping wrapMode, double tableOffset)
Adds the CammingLoadTableFromArray command to the command queue.
Loads a camming table into the SMC.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_CammingOff(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t followerAxis)
Adds the CammingOff command to the command queue.
Disables camming on the specified follower axis.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
followerAxis (In): The follower axis on which to disable camming.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_CammingOn(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t followerAxis, int32_t leaderAxis, int64_t tableNum, Automation1CammingSource source, Automation1CammingOutput output)
Adds the CammingOn command to the command queue.
Enables camming on the specified leader axis and follower axis.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_CornerRoundingOff(Automation1CommandQueue commandQueue, int32_t executionTaskIndex)
Adds the CornerRoundingOff command to the command queue.
Disables corner rounding.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_CornerRoundingOn(Automation1CommandQueue commandQueue, int32_t executionTaskIndex)
Adds the CornerRoundingOn command to the command queue.
Enables corner rounding.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_CornerRoundingSetAxes(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t* axes, int32_t axesLength)
Adds the CornerRoundingSetAxes command to the command queue.
Configures axes to use for corner rounding.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axes (In): The axes on which corner rounding is done.
axesLength (In): The number of elements in the axes function argument.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_CornerRoundingSetTolerance(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, double tolerance)
Adds the CornerRoundingSetTolerance command to the command queue.
Configures the tolerance to use for corner rounding.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
tolerance (In): The rounding tolerance, in user units.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_CutterCompensationSetAxes(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t* cutterAxes, int32_t cutterAxesLength)
Adds the CutterCompensationSetAxes command to the command queue.
Sets the axes to use in cutter offset and cutter radius compensation.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
cutterAxes (In): The axes to use. You must specify either 2 or 3 axes.
cutterAxesLength (In): The number of elements in the cutterAxes function argument.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_CutterCompensationSetOffsets(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, double* cutterOffsets, int32_t cutterOffsetsLength)
Adds the CutterCompensationSetOffsets command to the command queue.
Sets the offsets to use in cutter offset compensation. The number of offsets that you specify must be the same as the number of axes specified to CutterCompensationSetAxes().
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
cutterOffsets (In): The cutter offsets. You must specify either 2 or 3 offsets.
cutterOffsetsLength (In): The number of elements in the cutterOffsets function argument.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_CutterCompensationSetRadius(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, double cutterRadius)
Adds the CutterCompensationSetRadius command to the command queue.
Sets the radius to use in cutter radius compensation.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
cutterRadius (In): The cutter radius.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_GearingOff(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t followerAxis)
Adds the GearingOff command to the command queue.
Disables gearing on an axis.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
followerAxis (In): The axis on which to disable gearing.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_GearingOn(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t followerAxis, Automation1GearingFilter filter)
Adds the GearingOn command to the command queue.
Enables gearing on an axis.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_GearingSetLeaderAxis(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t followerAxis, int32_t leaderAxis, Automation1GearingSource gearingSource)
Adds the GearingSetLeaderAxis command to the command queue.
Configures gearing for an axis.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_GearingSetRatio(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t followerAxis, double gearRatio)
Adds the GearingSetRatio command to the command queue.
Sets the gearing ratio for an axis.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_MoveOutOfLimit(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the MoveOutOfLimit command to the command queue.
Executes an asynchronous move on an axis to move it out of a limit condition.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to perform the move.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_MoveToLimitCcw(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the MoveToLimitCcw command to the command queue.
Executes an asynchronous move on an axis to move it into a limit condition in the counterclockwise direction.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to perform the move.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_MoveToLimitCw(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the MoveToLimitCw command to the command queue.
Executes an asynchronous move on an axis to move it into a limit condition in the clockwise direction.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to perform the move.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_NormalcyOff(Automation1CommandQueue commandQueue, int32_t executionTaskIndex)
Adds the NormalcyOff command to the command queue.
Disables normalcy mode.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_NormalcyOn(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, Automation1NormalcyAlignment normalcyAlignment)
Adds the NormalcyOn command to the command queue.
Enables normalcy mode.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
normalcyAlignment (In): The type of the normalcy mode.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_NormalcySetAxes(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t normalcyAxis, int32_t* planeAxes, int32_t planeAxesLength)
Adds the NormalcySetAxes command to the command queue.
Configures the axes to use for normalcy mode.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_NormalcySetTolerance(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, double tolerance)
Adds the NormalcySetTolerance command to the command queue.
Configures the tolerance to use for normalcy mode.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
tolerance (In): The normalcy mode tolerance, in degrees.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_VelocityBlendingOff(Automation1CommandQueue commandQueue, int32_t executionTaskIndex)
Adds the VelocityBlendingOff command to the command queue.
Disables velocity profiling mode.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_VelocityBlendingOn(Automation1CommandQueue commandQueue, int32_t executionTaskIndex)
Adds the VelocityBlendingOn command to the command queue.
Enables velocity profiling mode.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_AutofocusOff(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the AutofocusOff command to the command queue.
Disables autofocus on an axis.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to disable autofocus.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_AutofocusOn(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, Automation1AutofocusFocusMode focusMode)
Adds the AutofocusOn command to the command queue.
Enables autofocus on an axis.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_CalibrationLoad(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, Automation1CalibrationType calibrationType, const char* controllerFileName)
Adds the CalibrationLoad command to the command queue.
Loads and activates the specified axis calibration file or galvo power correction file.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_CalibrationUnload(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, Automation1CalibrationType calibrationType)
Adds the CalibrationUnload command to the command queue.
Deactivates and unloads the calibration for the specified calibration type.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
calibrationType (In): The type of calibration to be unloaded.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_DriveBrakeOff(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the DriveBrakeOff command to the command queue.
Disengages the brake output and allows the axis to move freely.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to disengage the brake.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_DriveBrakeOn(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the DriveBrakeOn command to the command queue.
Engages the brake output and prevents the axis from moving freely.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to engage the brake.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_DriveDataCaptureConfigureArray(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t configurationNumber, int64_t driveArrayStartAddress, int64_t numberOfPoints)
Adds the DriveDataCaptureConfigureArray command to the command queue.
Configures the drive array for drive data capture.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_DriveDataCaptureConfigureInput(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t configurationNumber, Automation1DriveDataCaptureInput input)
Adds the DriveDataCaptureConfigureInput command to the command queue.
Selects the signal that will be stored by drive data capture.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_DriveDataCaptureConfigureTrigger(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t configurationNumber, Automation1DriveDataCaptureTrigger trigger)
Adds the DriveDataCaptureConfigureTrigger command to the command queue.
Selects the event that will trigger drive data capture.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_DriveDataCaptureOff(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t configurationNumber)
Adds the DriveDataCaptureOff command to the command queue.
Disables drive data capture of configured inputs.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_DriveDataCaptureOn(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t configurationNumber)
Adds the DriveDataCaptureOn command to the command queue.
Enables drive data capture of configured inputs.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_DriveDataCaptureReset(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t configurationNumber)
Adds the DriveDataCaptureReset command to the command queue.
Resets drive data capture configuration.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_DriveEncoderOutputConfigureDirection(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, Automation1EncoderOutputChannel outputChannel, int64_t reverseDirection)
Adds the DriveEncoderOutputConfigureDirection command to the command queue.
Inverts the output signal of a specified channel.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_DriveEncoderOutputConfigureDivider(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, Automation1EncoderOutputChannel outputChannel, int64_t outputDivider)
Adds the DriveEncoderOutputConfigureDivider command to the command queue.
Applies a divider on the specified output channel, lowering the frequency of output signals.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_DriveEncoderOutputConfigureInput(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, Automation1EncoderOutputChannel outputChannel, Automation1EncoderInputChannel inputChannel)
Adds the DriveEncoderOutputConfigureInput command to the command queue.
Configures an output channel to echo encoder signals from the specified input channel.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_DriveEncoderOutputOff(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, Automation1EncoderOutputChannel outputChannel)
Adds the DriveEncoderOutputOff command to the command queue.
Disables encoder output on the specified output channel.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to disable encoder output.
outputChannel (In): The outgoing encoder channel.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_DriveEncoderOutputOn(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, Automation1EncoderOutputChannel outputChannel, Automation1EncoderOutputMode outputMode)
Adds the DriveEncoderOutputOn command to the command queue.
Enables encoder output on the specified output channel.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_DrivePulseStreamConfigure(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t outputAxis, int32_t* inputAxes, int32_t inputAxesLength, double* inputScaleFactors, int32_t inputScaleFactorsLength)
Adds the DrivePulseStreamConfigure command to the command queue.
Configures pulse streaming mode.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_DrivePulseStreamConfigureWithSignalMode(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t outputAxis, int32_t* inputAxes, int32_t inputAxesLength, double* inputScaleFactors, int32_t inputScaleFactorsLength, Automation1DrivePulseStreamSignalMode signalMode)
Adds the DrivePulseStreamConfigure command to the command queue.
Configures pulse streaming mode.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_DrivePulseStreamOff(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t outputAxis)
Adds the DrivePulseStreamOff command to the command queue.
Disables pulse streaming mode on an axis.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
outputAxis (In): The axis on which to disable pulse streaming mode.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_DrivePulseStreamOn(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t outputAxis)
Adds the DrivePulseStreamOn command to the command queue.
Enables pulse streaming mode on an axis.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
outputAxis (In): The axis on which to enable pulse streaming mode.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_DriveSetAuxiliaryFeedback(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, double auxiliaryFeedback)
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.
Adds the DriveSetAuxiliaryFeedback command to the command queue.
Sets the auxiliary feedback of the axis.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to set the auxiliary feedback.
auxiliaryFeedback (In): The feedback value to set.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_DriveSetEncoderPosition(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, Automation1DriveEncoderChannel encoderChannel, double encoderValue)
Adds the DriveSetEncoderPosition command to the command queue.
Sets the hardware position counter of a drive encoder.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_DriveSetPositionCommand(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, double positionCommandValue)
Adds the DriveSetPositionCommand command to the command queue.
Sets the position command value of the specified axis at the servo loop level and adjusts the position feedback for position error.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_DriveSetPositionFeedback(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, double positionFeedbackValue)
Adds the DriveSetPositionFeedback command to the command queue.
Sets the position command and the position feedback value of the specified axis at the servo loop level.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_DriveAnalogAccelerationFeedforwardConfigureInput(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t analogInputNum, double inputScale, double inputOffset)
Adds the DriveAnalogAccelerationFeedforwardConfigureInput command to the command queue.
Configures the relationship between the acceleration feedforward and analog input voltage, where Acceleration Feedforward = (Analog Input Voltage - ($inputOffset / 1000)) x $inputScale.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_DriveAnalogAccelerationFeedforwardOff(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the DriveAnalogAccelerationFeedforwardOff command to the command queue.
Disables the Drive Analog Acceleration Feedforward feature.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to disable the Drive Analog Acceleration Feedforward feature.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_DriveAnalogAccelerationFeedforwardOn(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the DriveAnalogAccelerationFeedforwardOn command to the command queue.
Enables the Drive Analog Acceleration Feedforward feature.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to enable the Drive Analog Acceleration Feedforward feature.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_DriveAnalogCurrentControlConfigureInput(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t analogInputNum, int64_t digitalInputNum, double inputScale, double inputOffset)
Adds the DriveAnalogCurrentControlConfigureInput command to the command queue.
Configures the relationship between the output current and analog input voltage, where Current = (Analog Input Voltage - ($inputOffset / 1000)) x $inputScale.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_DriveAnalogCurrentControlOff(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the DriveAnalogCurrentControlOff command to the command queue.
Disables the Drive Analog Current Control feature.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to disable the Drive Analog Current Control feature.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_DriveAnalogCurrentControlOn(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the DriveAnalogCurrentControlOn command to the command queue.
Enables the Drive Analog Current Control feature.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to enable the Drive Analog Current Control feature.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_DriveAnalogPositionControlConfigureInput(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t inputNum, double inputScale, double inputOffset)
Adds the DriveAnalogPositionControlConfigureInput command to the command queue.
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.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_DriveAnalogPositionControlConfigureSpeedClamp(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, double maxSpeed)
Adds the DriveAnalogPositionControlConfigureSpeedClamp command to the command queue.
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.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_DriveAnalogPositionControlOff(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the DriveAnalogPositionControlOff command to the command queue.
Disable the Drive Analog Position Control feature.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to disable the Drive Analog Position Control feature.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_DriveAnalogPositionControlOn(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the DriveAnalogPositionControlOn command to the command queue.
Enable the Drive Analog Position Control feature.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to enable the Drive Analog Position Control feature.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_DriveAnalogVelocityControlConfigureInput(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t analogInputNum, int64_t digitalInputNum, double inputScale, double inputOffset)
Adds the DriveAnalogVelocityControlConfigureInput command to the command queue.
Configures the relationship between the output velocity and analog input voltage, where Velocity = (Analog Input Voltage - ($inputOffset / 1000)) x $inputScale.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_DriveAnalogVelocityControlOff(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the DriveAnalogVelocityControlOff command to the command queue.
Disables the Drive Analog Velocity Control feature.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to disable the Drive Analog Current Control feature.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_DriveAnalogVelocityControlOn(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the DriveAnalogVelocityControlOn command to the command queue.
Enables the Drive Analog Velocity Control feature.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to enable the Drive Analog Velocity Control feature.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_DriveAnalogVelocityFeedforwardConfigureInput(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t analogInputNum, double inputScale, double inputOffset)
Adds the DriveAnalogVelocityFeedforwardConfigureInput command to the command queue.
Configures the relationship between the velocity feedforward and analog input voltage, where Velocity Feedforward = (Analog Input Voltage - ($inputOffset / 1000)) x $inputScale.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_DriveAnalogVelocityFeedforwardOff(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the DriveAnalogVelocityFeedforwardOff command to the command queue.
Disables the Drive Analog Velocity Feedforward feature.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to disable the Drive Analog Velocity Feedforward feature.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_DriveAnalogVelocityFeedforwardOn(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the DriveAnalogVelocityFeedforwardOn command to the command queue.
Enables the Drive Analog Velocity Feedforward feature.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to enable the Drive Analog Velocity Feedforward feature.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_GalvoConfigureLaser1PulseWidth(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, double time)
Adds the GalvoConfigureLaser1PulseWidth command to the command queue.
Specifies the pulse width, in microseconds, of the O1 signal.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_GalvoConfigureLaser2PulseWidth(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, double time)
Adds the GalvoConfigureLaser2PulseWidth command to the command queue.
Specifies the pulse width, in microseconds, of the O2 signal.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_GalvoConfigureLaserDelays(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, double onDelay, double offDelay)
Adds the GalvoConfigureLaserDelays command to the command queue.
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.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_GalvoConfigureLaserMode(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t laserMode)
Adds the GalvoConfigureLaserMode command to the command queue.
Specifies the mode in which the laser output signals operate.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_GalvoConfigureLaserOutputPeriod(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, double time)
Adds the GalvoConfigureLaserOutputPeriod command to the command queue.
Specifies the period, in microseconds, of the O1 and O2 signals.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_GalvoConfigureStandbyPeriod(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, double time)
Adds the GalvoConfigureStandbyPeriod command to the command queue.
Specifies the period, in microseconds, of the standby signals.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to configure the standby period.
time (In): The time value in microseconds.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_GalvoConfigureStandbyPulseWidth(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, double time)
Adds the GalvoConfigureStandbyPulseWidth command to the command queue.
Specifies the pulse width, in microseconds, of the standby signals.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_GalvoConfigureSuppressionPulseWidth(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, double time)
Adds the GalvoConfigureSuppressionPulseWidth command to the command queue.
Specifies the pulse width, in microseconds, of the suppression signal.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_GalvoEncoderScaleFactorSet(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, double encoderScaleFactor)
Adds the GalvoEncoderScaleFactorSet command to the command queue.
Enables "marking on the fly" functionality.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_GalvoLaserOutput(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, Automation1GalvoLaser laserState)
Adds the GalvoLaserOutput command to the command queue.
Specifies how the laser on a galvo axis is controlled.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_GalvoProjectionOff(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the GalvoProjectionOff command to the command queue.
Disables the projective transformation on galvo axes.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The galvo axis on which to disable the projection.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_GalvoProjectionOn(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the GalvoProjectionOn command to the command queue.
Enables the projective transformation on galvo axes.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The galvo axis on which to apply the projection.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_GalvoProjectionSetCoefficients(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, double* coefficients, int32_t coefficientsLength)
Adds the GalvoProjectionSetCoefficients command to the command queue.
Specifies the projective transformation coefficients that are applied to galvo axes.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_GalvoRotationSet(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, double angle)
Adds the GalvoRotationSet command to the command queue.
Specifies an angle of rotation that is applied to galvo axes.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_GalvoWobbleOff(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the GalvoWobbleOff command to the command queue.
Disables the galvo wobble feature.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The galvo axis on which the galvo wobble is to be disabled.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_GalvoWobbleOn(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the GalvoWobbleOn command to the command queue.
Enables the galvo wobble feature.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The galvo axis on which the galvo wobble is to be applied.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_GalvoWobbleSetConfiguration(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, double amplitudeParallel, double amplitudePerpendicular, double frequency, Automation1GalvoWobbleMode wobbleMode, Automation1GalvoWobbleType wobbleType)
Adds the GalvoWobbleSetConfiguration command to the command queue.
Configures the wobble feature, which generates a wobble pattern that is added to the motion command of a galvo axis.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_IfovOff(Automation1CommandQueue commandQueue, int32_t executionTaskIndex)
Adds the IfovOff command to the command queue.
Disables Infinite Field of View (IFOV).
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_IfovOn(Automation1CommandQueue commandQueue, int32_t executionTaskIndex)
Adds the IfovOn command to the command queue.
Enables Infinite Field of View (IFOV).
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_IfovSetAxisPairs(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t* axisPairH, int32_t axisPairHLength, int32_t* axisPairV, int32_t axisPairVLength, double scaleFactorH, double scaleFactorV)
Adds the IfovSetAxisPairs command to the command queue.
Configures axes to command in Infinite Field of View (IFOV).
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_IfovSetSize(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, double size)
Adds the IfovSetSize command to the command queue.
Configures the field of view size of the galvo head in Infinite Field of View (IFOV).
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
size (In): The field of view size, in user units, of the galvo head.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_IfovSetSyncAxes(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t* axes, int32_t axesLength)
Adds the IfovSetSyncAxes command to the command queue.
Configures more axes to command in Infinite Field of View (IFOV).
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_IfovSetTime(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int64_t time)
Adds the IfovSetTime command to the command queue.
Configures the maximum search time that the controller looks ahead in Infinite Field of View (IFOV).
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
time (In): The time, in milliseconds, that the controller looks ahead.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_IfovSetTrackingAcceleration(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, double acceleration)
Adds the IfovSetTrackingAcceleration command to the command queue.
Configures the maximum acceleration of the servo axes while in Infinite Field of View (IFOV).
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
acceleration (In): The maximum acceleration, in user units/second squared, of the servo axes.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_IfovSetTrackingSpeed(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, double speed)
Adds the IfovSetTrackingSpeed command to the command queue.
Configures the maximum speed of the servo axes while in Infinite Field of View (IFOV).
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
speed (In): The maximum speed, in user units/time base, of the servo axes.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_AnalogOutputConfigureArrayMode(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t outputNum, Automation1AnalogOutputUpdateEvent updateEvent, int64_t driveArrayStartAddress, int64_t numberOfPoints, int64_t divisor, int64_t enableRepeat)
Adds the AnalogOutputConfigureArrayMode command to the command queue.
Configures the specified analog output to use values from the drive array.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_AnalogOutputConfigureAxisTrackingMode(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t outputAxis, int64_t outputNum, Automation1AnalogOutputAxisTrackingItem trackingItem, double scaleFactor, double offset, double minVoltage, double maxVoltage)
Adds the AnalogOutputConfigureAxisTrackingMode command to the command queue.
Configures an analog output to be dependent on a specified real-time internal servo loop value of a single axis.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_AnalogOutputConfigureDefaultMode(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t outputNum)
Adds the AnalogOutputConfigureDefaultMode command to the command queue.
Restores the analog output configuration to the default operating mode.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_AnalogOutputConfigureVectorTrackingMode(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t outputAxis, int64_t outputNum, int32_t* inputAxes, int32_t inputAxesLength, Automation1AnalogOutputVectorTrackingItem trackingItem, double scaleFactor, double offset, double minVoltage, double maxVoltage)
Adds the AnalogOutputConfigureVectorTrackingMode command to the command queue.
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.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_AnalogOutputSet(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t outputNum, double value)
Adds the AnalogOutputSet command to the command queue.
Sets the value of a specified analog output.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_DigitalOutputSet(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t outputNum, int64_t value)
Adds the DigitalOutputSet command to the command queue.
Sets the value of the specified digital output bit.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_LaserOutputSet(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t laserState)
Adds the LaserOutputSet command to the command queue.
Sets the laser to manual mode and to the specified value.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_VirtualBinaryInputSet(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int64_t inputNum, int64_t value)
Adds the VirtualBinaryInputSet command to the command queue.
Sets the value of the specified virtual binary input bit.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_VirtualBinaryOutputSet(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int64_t outputNum, int64_t value)
Adds the VirtualBinaryOutputSet command to the command queue.
Sets the value of the specified virtual binary output bit.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_VirtualRegisterInputSet(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int64_t inputNum, double value)
Adds the VirtualRegisterInputSet command to the command queue.
Sets the value of a specified virtual register input.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_VirtualRegisterOutputSet(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int64_t outputNum, double value)
Adds the VirtualRegisterOutputSet command to the command queue.
Sets the value of a specified virtual register output.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_Disable(Automation1CommandQueue commandQueue, int32_t* axes, int32_t axesLength)
Adds the Disable AeroScript command to the command queue.
Disables the axes so that you cannot command motion.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axes (In): The axes to disable.
axesLength (In): The number of elements in the axes function argument.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_Dwell(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, double dwellTime)
Adds the Dwell command to the command queue.
Suspends the execution of the task for a specified quantity of time.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
dwellTime (In): The quantity of time to suspend the task, in seconds.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_Enable(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t* axes, int32_t axesLength)
Adds the Enable command to the command queue.
Enables the axes so that you can command motion.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axes (In): The axes to enable.
axesLength (In): The number of elements in the axes function argument.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_Home(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t* axes, int32_t axesLength)
Adds the Home command to the command queue.
Performs a home cycle by moving the axes to a known hardware reference location. The task waits for completion of the home cycle.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axes (In): The axes to home.
axesLength (In): The number of elements in the axes function argument.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_HomeAsync(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t* axes, int32_t axesLength)
Adds the HomeAsync command to the command queue.
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.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axes (In): The axes to home.
axesLength (In): The number of elements in the axes function argument.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_MoveAbsolute(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t* axes, int32_t axesLength, double* positions, int32_t positionsLength, double* speeds, int32_t speedsLength)
Adds the MoveAbsolute command to the command queue.
Executes an asynchronous point-to-point move to an absolute target-position on the specified axes.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_MoveCcwByRadius(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t* axes, int32_t axesLength, double* distances, int32_t distancesLength, double radius, double coordinatedSpeed)
Adds the MoveCcw command to the command queue.
Executes a coordinated counterclockwise circular arc move on the specified axes. An arc move creates an arc in vector space using two axes.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_MoveCcwByCenter(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t* axes, int32_t axesLength, double* distances, int32_t distancesLength, double* center, int32_t centerLength, double coordinatedSpeed)
Adds the MoveCcw command to the command queue.
Executes a coordinated counterclockwise circular arc move on the specified axes. An arc move creates an arc in vector space using two axes.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_MoveCwByRadius(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t* axes, int32_t axesLength, double* distances, int32_t distancesLength, double radius, double coordinatedSpeed)
Adds the MoveCw command to the command queue.
Executes a coordinated clockwise circular arc move on the specified axes. An arc move creates an arc in vector space using two axes.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_MoveCwByCenter(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t* axes, int32_t axesLength, double* distances, int32_t distancesLength, double* center, int32_t centerLength, double coordinatedSpeed)
Adds the MoveCw command to the command queue.
Executes a coordinated clockwise circular arc move on the specified axes. An arc move creates an arc in vector space using two axes.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_MoveDelay(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t* axes, int32_t axesLength, double delayTime)
Adds the MoveDelay command to the command queue.
Commands axes to remain at zero velocity for a quantity of time.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_MoveFreerun(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t* axes, int32_t axesLength, double* velocities, int32_t velocitiesLength)
Adds the MoveFreerun command to the command queue.
Executes an asynchronous freerun move on the specified axes. The axes will move indefinitely at the specified velocity.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_MoveFreerunStop(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t* axes, int32_t axesLength)
Adds the MoveFreerunStop command to the command queue.
Stops an asynchronous freerun move on the specified axes. The axis velocities decelerate to zero.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_MoveIncremental(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t* axes, int32_t axesLength, double* distances, int32_t distancesLength, double* speeds, int32_t speedsLength)
Adds the MoveIncremental command to the command queue.
Executes an asynchronous point-to-point move by an incremental distance on the specified axes.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_MoveLinear(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t* axes, int32_t axesLength, double* distances, int32_t distancesLength, double coordinatedSpeed)
Adds the MoveLinear command to the command queue.
Executes a coordinated linear move on the specified axes. A linear move creates a line in vector space on one or more axes.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_MovePt(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t* axes, int32_t axesLength, double* positions, int32_t positionsLength, double time)
Adds the MovePt command to the command queue.
Specifies a single point in an arbitrary motion profile. The point contains the position of one or more axes and a time interval. You must call this function for each point in the motion profile.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axes (In): The axes of the motion profile point.
axesLength (In): The number of elements in the axes function argument.
positions (In): The positions of each axis at the end of the time interval.
positionsLength (In): The number of elements in the positions function argument.
time (In): The total time interval of the motion profile point in milliseconds.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_MovePvt(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t* axes, int32_t axesLength, double* positions, int32_t positionsLength, double* velocities, int32_t velocitiesLength, double time)
Adds the MovePvt command to the command queue.
Specifies a single point in an arbitrary motion profile. The point contains the position and velocity of one or more axes and a time interval. You must call this function for each point in the motion profile.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axes (In): The axes of the motion profile point.
axesLength (In): The number of elements in the axes function argument.
positions (In): The positions of each axis at the end of the time interval.
positionsLength (In): The number of elements in the positions function argument.
velocities (In): The velocities, in user units per time base, at which each axis will be moving at the end of the time interval.
velocitiesLength (In): The number of elements in the velocities function argument.
time (In): The total time interval of the motion profile point in milliseconds.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_MoveRapid(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t* axes, int32_t axesLength, double* distances, int32_t distancesLength, double* speeds, int32_t speedsLength)
Adds the MoveRapid command to the command queue.
Executes a point-to-point rapid move on the specified axes.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PositionOffsetClear(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t* axes, int32_t axesLength)
Adds the PositionOffsetClear command to the command queue.
Clears the program position offsets on the specified axes. The program positions will be restored to the current axis positions.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PositionOffsetSet(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t* axes, int32_t axesLength, double* programPositions, int32_t programPositionsLength)
Adds the PositionOffsetSet command to the command queue.
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.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_WaitForInPosition(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t* axes, int32_t axesLength)
Adds the WaitForInPosition command to the command queue.
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.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_WaitForMotionDone(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t* axes, int32_t axesLength)
Adds the WaitForMotionDone command to the command queue.
Waits for motion to be done on the specified axes. The motion is done when the commanded velocity is at zero.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_WorkOffsetConfigureOffset(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int64_t offsetNumber, int32_t* axes, int32_t axesLength, double* programPositions, int32_t programPositionsLength)
Adds the WorkOffsetConfigureOffset command to the command queue.
Configures the specified work offset on the specified axes and values. Previously configured axes will retain their values unless overwritten.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_WorkOffsetDisable(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t* axes, int32_t axesLength)
Adds the WorkOffsetDisable command to the command queue.
Deactivates work offsets for all axes on the controller.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_WorkOffsetEnable(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int64_t offsetNumber, int32_t* axes, int32_t axesLength)
Adds the WorkOffsetEnable command to the command queue.
Activates the specified work offset and applies offsets to the specified axes.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_WorkOffsetResetConfiguration(Automation1CommandQueue commandQueue, int32_t executionTaskIndex)
Adds the WorkOffsetResetConfiguration command to the command queue.
Erases the work offset configurations on all axes. All work offsets must first be disabled.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_MotionRestrictionOff(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t* axes, int32_t axesLength)
Adds the MotionRestrictionOff command to the command queue.
Removes all motion restrictions from the selected axes.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_MotionRestrictionOn(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t* axes, int32_t axesLength)
Adds the MotionRestrictionOn command to the command queue.
Applies motion restrictions to the selected axes. This function restricts the motion, home, and enable features on the selected axes.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_SetupAxisRampType(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, Automation1RampType rampTypeAccel, double rampTypeArgAccel, Automation1RampType rampTypeDecel, double rampTypeArgDecel)
Adds the SetupAxisRampType command to the command queue.
Sets a ramp type along with a ramp type value for accelerations and decelerations separately for an axis.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_SetupAxisRampValue(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, Automation1RampMode rampModeAccel, double rampValueAccel, Automation1RampMode rampModeDecel, double rampValueDecel)
Adds the SetupAxisRampValue command to the command queue.
Sets a ramp value for accelerations and decelerations separately for an axis.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_SetupAxisSpeed(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, double speed)
Adds the SetupAxisSpeed command to the command queue.
Sets the speed of an axis for MoveRapid() motion.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to set the speed.
speed (In): The speed to set.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_SetupCoordinatedAccelLimit(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, double accelLimitNonTangent, double accelLimitCircular)
Adds the SetupCoordinatedAccelLimit command to the command queue.
Sets the maximum acceleration of coordinated motion on dominant axes on the current task.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_SetupCoordinatedRampType(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, Automation1RampType rampTypeAccel, double rampTypeArgAccel, Automation1RampType rampTypeDecel, double rampTypeArgDecel)
Adds the SetupCoordinatedRampType command to the command queue.
Sets a coordinated ramp type along with a ramp type value for accelerations and decelerations separately for dominant axes on the current task.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_SetupCoordinatedRampValue(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, Automation1RampMode rampModeAccel, double rampValueAccel, Automation1RampMode rampModeDecel, double rampValueDecel)
Adds the SetupCoordinatedRampValue command to the command queue.
Sets a coordinated ramp value for accelerations and decelerations separately for dominant axes on the current task.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_SetupCoordinatedSpeed(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, double speed)
Adds the SetupCoordinatedSpeed command to the command queue.
Sets the coordinated speed for dominant axes on the current task.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
speed (In): The speed to set.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_SetupDependentCoordinatedAccelLimit(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, double accelLimitDependent)
Adds the SetupDependentCoordinatedAccelLimit command to the command queue.
Sets the maximum acceleration of coordinated motion on dependent axes on the current task.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
accelLimitDependent (In): The maximum acceleration of axes at all portions of a motion path.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_SetupDependentCoordinatedRampRate(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, double rampValueAccel, double rampValueDecel)
Adds the SetupDependentCoordinatedRampRate command to the command queue.
Sets a coordinated ramp rate for accelerations and decelerations separately for dependent axes on the current task.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_SetupDependentCoordinatedSpeed(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, double speed)
Adds the SetupDependentCoordinatedSpeed command to the command queue.
Sets the coordinated speed for dependent axes on the current task.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
speed (In): The speed to set.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_SetupTaskDistanceUnits(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, Automation1DistanceUnits distanceUnits)
Adds the SetupTaskDistanceUnits command to the command queue.
Sets the distance units of the current task.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
distanceUnits (In): The distance units to set.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_SetupTaskTargetMode(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, Automation1TargetMode targetMode)
Adds the SetupTaskTargetMode command to the command queue.
Sets the target mode of the current task.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
targetMode (In): The target mode to set.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_SetupTaskTimeUnits(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, Automation1TimeUnits timeUnits)
Adds the SetupTaskTimeUnits command to the command queue.
Sets the time units of the current task.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
timeUnits (In): The time units to set.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_SetupTaskWaitMode(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, Automation1WaitMode waitMode)
Adds the SetupTaskWaitMode command to the command queue.
Sets the wait mode of the current task.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
waitMode (In): The wait mode to set.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoBitmapConfigureArray(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t driveArrayStartAddress, int64_t numberOfPoints, int64_t enableRepeat)
Adds the PsoBitmapConfigureArray command to the command queue.
Configures an array of PSO bit data words, where each word is a 32-bit integer.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoDistanceConfigureAllowedEventDirection(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, Automation1PsoDistanceAllowedEventDirection eventDirection)
Adds the PsoDistanceConfigureAllowedEventDirection command to the command queue.
Configures the distance counter tracking directions that will cause PSO distance events.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoDistanceConfigureArrayDistances(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t driveArrayStartAddress, int64_t numberOfDistances, int64_t enableRepeat)
Adds the PsoDistanceConfigureArrayDistances command to the command queue.
Configures an array of distances in counts that the PSO counter or counters must travel for an event to occur.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoDistanceConfigureCounterReset(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t optionsMask)
Adds the PsoDistanceConfigureCounterReset command to the command queue.
Configures the conditions which will reset the PSO distance counters.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoDistanceConfigureFixedDistance(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t distance)
Adds the PsoDistanceConfigureFixedDistance command to the command queue.
Configures the distance in counts that the PSO counter or counters must travel for an event to occur.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to configure the distance.
distance (In): The distance in counts.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoDistanceConfigureInputs(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, Automation1PsoDistanceInput* inputs, int32_t inputsLength)
Adds the PsoDistanceConfigureInputs command to the command queue.
Selects the source of each PSO distance counter.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoDistanceConfigureScaling(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t* scaleFactors, int32_t scaleFactorsLength)
Adds the PsoDistanceConfigureScaling command to the command queue.
Configures the PSO distance counters to apply an integer scale factor for each tracking input.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoDistanceCounterOff(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the PsoDistanceCounterOff command to the command queue.
Disables the PSO distance counters, causing them to retain their values and ignore their configured inputs.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to disable the PSO distance counters.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoDistanceCounterOn(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the PsoDistanceCounterOn command to the command queue.
Enables the PSO distance counters, allowing them to track their configured inputs.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to enable the PSO distance counters.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoDistanceEventsOff(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the PsoDistanceEventsOff command to the command queue.
Disables PSO distance events.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to disable distance events.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoDistanceEventsOn(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the PsoDistanceEventsOn command to the command queue.
Enables PSO distance events.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to enable distance events.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoEventConfigureMask(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t eventMask)
Adds the PsoEventConfigureMask command to the command queue.
Configures additional conditions to prevent PSO events from occurring.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoEventContinuousOff(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the PsoEventContinuousOff command to the command queue.
Immediately halts active continuous PSO events.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to halt the events.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoEventContinuousOn(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the PsoEventContinuousOn command to the command queue.
Immediately causes continuous PSO events to occur.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to cause the events.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoEventGenerateSingle(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the PsoEventGenerateSingle command to the command queue.
Immediately causes a single PSO event to occur.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to cause the event.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoLaserEventsOff(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the PsoLaserEventsOff command to the command queue.
Disables PSO laser events.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to disable PSO laser events.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoLaserEventsOn(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the PsoLaserEventsOn command to the command queue.
Configures the PSO to generate an event when the laser command bit turns on.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to generate laser PSO events.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoOutputConfigureOutput(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, Automation1PsoOutputPin output)
Adds the PsoOutputConfigureOutput command to the command queue.
Selects the output pin on which to drive the PSO output.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to select the PSO output pin.
output (In): The selected output pin.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoOutputConfigureSource(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, Automation1PsoOutputSource outputSource)
Adds the PsoOutputConfigureSource command to the command queue.
Selects which internal PSO signal to drive onto the output pin.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to select the PSO output source.
outputSource (In): The selected output source.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoOutputOff(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the PsoOutputOff command to the command queue.
Immediately deactivates the PSO output.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to deactivate the PSO output.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoOutputOn(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the PsoOutputOn command to the command queue.
Immediately activates the PSO output.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to activate the PSO output.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoReset(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the PsoReset command to the command queue.
Resets all PSO configuration, which restores all PSO settings to their default values.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to reset the PSO configuration.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoTransformationConfigure(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t transformationChannel, Automation1PsoTransformationInput inputA, Automation1PsoTransformationInput inputB, Automation1PsoTransformationFunction transformationFunction)
Adds the PsoTransformationConfigure command to the command queue.
Configures a PSO input transformation channel.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoTransformationOff(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t transformationChannel)
Adds the PsoTransformationOff command to the command queue.
Disables a PSO input transformation channel.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to disable the transformation channel.
transformationChannel (In): The transformation channel to disable.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoTransformationOn(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t transformationChannel)
Adds the PsoTransformationOn command to the command queue.
Enables a PSO input transformation channel.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to enable the transformation channel.
transformationChannel (In): The transformation channel to enable.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoWaveformApplyPulseConfiguration(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the PsoWaveformApplyPulseConfiguration command to the command queue.
Checks for a valid configuration of pulse mode parameters and applies the configuration to the waveform module.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to apply the pulse configuration.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoWaveformApplyPwmConfiguration(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the PsoWaveformApplyPwmConfiguration command to the command queue.
Checks for a valid configuration of PWM mode parameters and applies the configuration to the waveform module.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to apply the PWM configuration.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoWaveformConfigureDelay(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, double delayTime)
Adds the PsoWaveformConfigureDelay command to the command queue.
Configures the waveform module to wait for the specified time after a PSO event before beginning to output a waveform.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoWaveformConfigureMode(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, Automation1PsoWaveformMode waveformMode)
Adds the PsoWaveformConfigureMode command to the command queue.
Selects the output mode of the waveform module.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoWaveformConfigurePulseArrayCounts(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t driveArrayStartAddress, int64_t numberOfPoints, int64_t enableRepeat)
Adds the PsoWaveformConfigurePulseArrayCounts command to the command queue.
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.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoWaveformConfigurePulseArrayOnTimes(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t driveArrayStartAddress, int64_t numberOfPoints, int64_t enableRepeat)
Adds the PsoWaveformConfigurePulseArrayOnTimes command to the command queue.
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.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoWaveformConfigurePulseArrayTotalTimes(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t driveArrayStartAddress, int64_t numberOfPoints, int64_t enableRepeat)
Adds the PsoWaveformConfigurePulseArrayTotalTimes command to the command queue.
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.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoWaveformConfigurePulseEventQueue(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t maxQueuedEvents)
Adds the PsoWaveformConfigurePulseEventQueue command to the command queue.
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.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoWaveformConfigurePulseFixedCount(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t pulseCount)
Adds the PsoWaveformConfigurePulseFixedCount command to the command queue.
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.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoWaveformConfigurePulseFixedOnTime(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, double onTime)
Adds the PsoWaveformConfigurePulseFixedOnTime command to the command queue.
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.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to configure the on time.
onTime (In): The on time in microseconds.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoWaveformConfigurePulseFixedTotalTime(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, double totalTime)
Adds the PsoWaveformConfigurePulseFixedTotalTime command to the command queue.
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.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to configure the total time.
totalTime (In): The total time in microseconds.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoWaveformConfigurePulseMask(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t pulseMask)
Adds the PsoWaveformConfigurePulseMask command to the command queue.
Configures additional conditions to disable the PSO waveform output in pulse mode.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoWaveformConfigurePulseTruncation(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t preventTruncation)
Adds the PsoWaveformConfigurePulseTruncation command to the command queue.
Allows or prevents the waveform module from outputting truncated waveform outputs in pulse mode.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoWaveformConfigurePwmOnTimes(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t driveArrayStartAddress, int64_t numberOfPoints, int64_t enableRepeat)
Adds the PsoWaveformConfigurePwmOnTimes command to the command queue.
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.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoWaveformConfigurePwmTotalTime(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, double totalTime)
Adds the PsoWaveformConfigurePwmTotalTime command to the command queue.
Configures the fixed total time of the waveform module output in PWM mode. The total time specifies the full period of the PWM signal.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to configure the total time.
totalTime (In): The total time in microseconds.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoWaveformExternalSyncConfigureDelayMode(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, Automation1PsoWaveformExternalSyncDelayMode delayMode)
Adds the PsoWaveformExternalSyncConfigureDelayMode command to the command queue.
Configures the delay mode of the waveform module when you use the external synchronization signal.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoWaveformExternalSyncOff(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the PsoWaveformExternalSyncOff command to the command queue.
Disables the external sync option for the waveform module.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to disable external sync option.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoWaveformExternalSyncOn(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the PsoWaveformExternalSyncOn command to the command queue.
Configures the waveform module to wait for the rising edge of the external sync signal before beginning to output a waveform.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to enable external sync option.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoWaveformOff(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the PsoWaveformOff command to the command queue.
Disables the waveform module, preventing PSO events from triggering it.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to disable the waveform module.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoWaveformOn(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the PsoWaveformOn command to the command queue.
Enables the waveform module, allowing PSO events to trigger it.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to enable the waveform module.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoWaveformScalingConfigure(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, Automation1PsoWaveformScalingMode scalingMode, Automation1PsoWaveformScalingInput scalingInput, double* inputRange, int32_t inputRangeLength, double* scaleFactorRange, int32_t scaleFactorRangeLength)
Adds the PsoWaveformScalingConfigure command to the command queue.
Specifies the configuration of the optional PSO waveform scaling feature.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoWaveformScalingOff(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the PsoWaveformScalingOff command to the command queue.
Deactivates PSO waveform scaling.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to deactivate PSO waveform scaling.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoWaveformScalingOn(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis)
Adds the PsoWaveformScalingOn command to the command queue.
Activates PSO waveform scaling.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
axis (In): The axis on which to activate PSO waveform scaling.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoWindowConfigureArrayRanges(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t windowNumber, int64_t driveArrayStartAddress, int64_t numberOfRanges, int64_t enableRepeat)
Adds the PsoWindowConfigureArrayRanges command to the command queue.
Configures an array of window range pairs each consisting of a lower bound followed by an upper bound.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoWindowConfigureArrayUpdateDirection(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t windowNumber, Automation1PsoWindowUpdateDirection windowUpdateDirection)
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.
Adds the PsoWindowConfigureArrayUpdateDirection command to the command queue.
Configures the array of window range pairs to update when exiting the active window range in specific directions.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoWindowConfigureCounterReset(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t optionsMask)
Adds the PsoWindowConfigureCounterReset command to the command queue.
Configures the conditions which will reset the PSO window counters.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoWindowConfigureEventDirection(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t windowNumber, Automation1PsoWindowEventDirection windowEventDirection)
Adds the PsoWindowConfigureEventDirection command to the command queue.
Configures the directions which will trigger an internal window event upon entering or exiting the active window.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoWindowConfigureEvents(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, Automation1PsoWindowEventMode eventMode)
Adds the PsoWindowConfigureEvents command to the command queue.
Configures the conditions which will generate PSO window events.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoWindowConfigureFixedRange(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t windowNumber, int64_t lowerBound, int64_t upperBound)
Adds the PsoWindowConfigureFixedRange command to the command queue.
Configures a fixed window range consisting of a lower bound and an upper bound for the specified window.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoWindowConfigureInput(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t windowNumber, Automation1PsoWindowInput input, int64_t reverseDirection)
Adds the PsoWindowConfigureInput command to the command queue.
Selects the source of the specified window counter.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoWindowCounterSetValue(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t windowNumber, int64_t value)
Adds the PsoWindowCounterSetValue command to the command queue.
Sets the specified window counter to the specified value.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoWindowOutputOff(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t windowNumber)
Adds the PsoWindowOutputOff command to the command queue.
Disables the specified window output.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_PsoWindowOutputOn(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, int64_t windowNumber)
Adds the PsoWindowOutputOn command to the command queue.
Enables the specified window output.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_SafeZoneBoundaryAdd(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int64_t zone, int32_t axis, double lowerBound, double upperBound)
Adds the SafeZoneBoundaryAdd command to the command queue.
Adds a boundary to the specified safe zone.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_SafeZoneBoundaryRemove(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int64_t zone, int32_t axis)
Adds the SafeZoneBoundaryRemove command to the command queue.
Removes the specified boundary from the specified safe zone.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_SafeZoneBoundaryRemoveAll(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int64_t zone)
Adds the SafeZoneBoundaryRemoveAll command to the command queue.
Removes all boundaries from the specified safe zone.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
zone (In): The index of the safe zone on which to remove all boundaries.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_SafeZoneOff(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int64_t zone)
Adds the SafeZoneOff command to the command queue.
Disables the specified safe zone.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
zone (In): The safe zone to disable.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_SafeZoneOn(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int64_t zone)
Adds the SafeZoneOn command to the command queue.
Enables the specified safe zone.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
zone (In): The safe zone to enable.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_SafeZoneSetType(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int64_t zone, Automation1SafeZoneType zoneType)
Adds the SafeZoneSetType command to the command queue.
Sets the safe zone type for the specified safe zone.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_TuningSetFeedforwardGains(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, Automation1FeedforwardGain* feedforwardGains, int32_t feedforwardGainsLength, double* feedforwardGainValues, int32_t feedforwardGainValuesLength)
Adds the TuningSetFeedforwardGains command to the command queue.
Sets the specified feedforward gain values on the specified axis.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_TuningSetMotorAngle(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, double current, double angle)
Adds the TuningSetMotorAngle command to the command queue.
Generates an open-loop current command at a fixed electrical angle.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_TuningSetMotorCurrent(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, double current, int64_t duration)
Adds the TuningSetMotorCurrent command to the command queue.
Generates an open-loop current command at a rotating electrical angle.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_TuningSetServoLoopGains(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, int32_t axis, Automation1ServoLoopGain* servoGains, int32_t servoGainsLength, double* servoGainValues, int32_t servoGainValuesLength)
Adds the TuningSetServoLoopGains command to the command queue.
Sets the specified servo loop gain values on the specified axis.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_CTransformationDisable(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, const char* transformationName)
Adds the CTransformationDisable command to the command queue.
Disable a C transformation. This will stop running inverse and forward computations for this transformation.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
transformationName (In): The name specified in the C Transformation configuration.
This string argument must be null terminated.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_CTransformationEnable(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, const char* transformationName)
Adds the CTransformationEnable command to the command queue.
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.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
transformationName (In): The name specified in the C Transformation configuration.
This string argument must be null terminated.
Returns: True if the AeroScript command was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_CTransformationSetInputAxes(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, const char* transformationName, int32_t* inputAxes, int32_t inputAxesLength)
Adds the CTransformationSetInputAxes command to the command queue.
Set the input axes of a C transformation.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_CTransformationSetOutputAxes(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, const char* transformationName, int32_t* outputAxes, int32_t outputAxesLength)
Adds the CTransformationSetOutputAxes command to the command queue.
Set the output axes of a C transformation.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
> bool Automation1_CommandQueue_CTransformationSetProperty(Automation1CommandQueue commandQueue, int32_t executionTaskIndex, const char* transformationName, const char* property, double value)
Adds the CTransformationSetProperty command to the command queue.
Call the OnSetProperty() C function defined in a C transformation.
Executes on this command queue's task.
commandQueue (In): The command queue to add this AeroScript command to.
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 was successfully added to the command queue. False if the AeroScript command was not added to the command queue. 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.
