Application Data Collection Functions
You can use the Application Data Collection functions to configure signals for 1D Data Collection and collect data from AeroScript in the Data Visualizer module.
Use the Data Visualizer module to configure, collect, and look at data from the controller and also set the rate at which data collection occurs. You can also save, open, and look at plot files. To use the condensed version of this module in the Develop workspace, see Data Visualizer Module. To use the larger version of this module in the Visualize workspace, see Visualize Workspace. In an AeroScript program or library, use the functions on this page to configure and collect data for the Data Visualizer module.
Configure Data Collection
Use the AppDataCollectionAdd*Signal() functions to configure the items for which data should be collected. When you add an item to data collection, you can use the AppDataCollectionSnapshot() function to collect data. You can start and stop data collection from any task after it is configured. Use the AppDataCollectionReset() function to remove all the configured items from data collection. Before you use these functions, you can use their related AppDataCollection*IsRegistered() functions to see if they are registered with an Automation1 Studio, Automation1 MachineApps, or a custom .NET application.
function AppDataCollectionReset()
Resets the application's data collection configuration. This function must have a connected Automation1 Studio, Automation1 MachineApps, or a custom .NET application that registers to handle it. If there is not an application connected to your controller that can handle this function, an error will occur. If you need to do a check, call the AppDataCollectionResetIsRegistered() function.
function AppDataCollectionResetIsRegistered() as integer
Returns if the AppDataCollectionReset() function is registered by an application.
Returns
If the function is registered by an application, returns 1. Otherwise, returns 0.
Configure Axis Signals
Use the AppDataCollectionAddAxisSignal() and AppDataCollectionAddAxisSignalIsRegistered() functions to configure the axis signals to collect for data collection:
function AppDataCollectionAddAxisSignal($axis as axis, $dataSignal as AxisDataSignal)
Adds an axis status signal to the application's data collection configuration. This function must have a connected Automation1 Studio, Automation1 MachineApps, or a custom .NET application that registers to handle it. If there is not an application connected to your controller that can handle this function, an error will occur. If you need to do a check, call the AppDataCollectionAddAxisSignalIsRegistered() function.
Arguments
$axis The axis from which to retrieve the status signal value.
$dataSignal The data signal to retrieve.
enum AxisDataSignal
| enum AxisDataSignal
PositionFeedback = 0 PositionCommand = 1 PositionError = 2 VelocityFeedback = 3 VelocityCommand = 4 VelocityError = 5 AccelerationCommand = 6 CurrentFeedback = 7 CurrentCommand = 8 CurrentError = 9 AnalogInput0 = 10 AnalogInput1 = 11 PositionCommandRaw = 12 VelocityCommandRaw = 13 AuxiliaryFeedback = 14 DigitalInput = 15 DigitalOutput = 16 WorkOffsetValue = 18 PhaseACurrentFeedback = 19 PhaseBCurrentFeedback = 20 EncoderSine = 21 EncoderCosine = 22 AnalogInput2 = 23 AnalogInput3 = 24 FrequencyResponseBefore = 25 FrequencyResponseAfter = 26 AnalogOutput0 = 31 AnalogOutput1 = 32 AnalogOutput2 = 33 AnalogOutput3 = 34 DriveMemoryInt32 = 35 DriveMemoryFloat = 36 DriveMemoryDouble = 37 PsoStatus = 38 DriveTimerDebug = 39 CoordinatedPositionTarget = 41 DriveStatus = 42 AxisStatus = 43 AxisFault = 44 AccelerationCommandRaw = 45 PositionCalibrationAll = 50 PositionFeedbackRollover = 63 PositionCommandRollover = 64 VelocityFeedbackAverage = 65 CurrentFeedbackAverage = 66 AxisParameter = 68 Backlash = 72 HomeState = 73 PositionCalibration2D = 74 NormalcyDebug = 75 TotalMoveTime = 76 PositionFeedbackDrive = 77 JerkCommandRaw = 78 ProgramPositionCommand = 79 PositionOffset = 80 PositionCommandRawBackwardsDiff = 82 VelocityCommandRawBackwardsDiffDelta = 83 PositionCommandDrive = 84 DriveStatusActual = 85 WorkOffsetIndex = 88 ProgramPositionFeedback = 89 JogTrajectoryStatus = 94 PingTest = 95 AccelerationTime = 109 DecelerationTime = 110 AccelerationRate = 111 DecelerationRate = 112 AccelerationType = 113 DecelerationType = 114 AccelerationMode = 115 DecelerationMode = 116 ProgramPosition = 124 DriveMemoryInt16 = 125 DriveMemoryInt8 = 126 SpeedTarget = 128 PositionCommandPacket = 131 DriveSmcMotionState = 132 PositionCommandRawCal = 140 VelocityCommandRawCal = 141 VelocityCommandDrive = 142 AccelerationCommandDrive = 143 GalvoLaserOutputRaw = 144 DriveInterfacePacketInt32 = 147 DriveInterfacePacketInt16 = 148 DriveInterfacePacketInt8 = 149 DriveInterfacePacketDouble = 150 DriveInterfacePacketFloat = 151 DriveInterfaceCommandCode = 152 AccelerationFeedback = 153 AccelerationCommandRawCal = 154 PositionCalibrationAllDrive = 155 BacklashTarget = 156 DriveMotionRate = 158 DriveMotionDelay = 159 CalibrationAdjustmentValue = 160 ServoRounding = 161 ServoLoopFeedforwardControlEffortRaw = 162 DriveInterfacePacketInfoBitValue = 164 AccelerationError = 165 SuppressedFaults = 167 DriveInterfacePacketStreamingData = 168 PositionCommandRawUnfiltered = 169 TransitionOffsetErrors = 170 PsoCounter0 = 171 PsoCounter1 = 172 PsoCounter2 = 173 PsoWindow0 = 174 PsoWindow1 = 175 DriveDataCaptureSamples = 176 PositionCommandGalvo = 178 FreezeVelocityCommand = 179 FreezeVelocityFeedback = 180 InternalPositionOffsets = 181 StatusHighLevelOffsetsLastMsec = 182 ProgramVelocityCommand = 183 ProgramVelocityFeedback = 184 DriveMotionDelayLive = 185 DriveCommunicationDelay = 186 DriveCommunicationDelayLive = 187 DriveInterfacePacketResponseInt32 = 189 DriveInterfacePacketResponseInt16 = 190 DriveInterfacePacketResponseInt8 = 191 DriveInterfacePacketResponseDouble = 192 DriveInterfacePacketResponseFloat = 193 DriveInterfacePacketBit = 194 DriveInterfacePacketResponseBit = 195 SpeedTargetActual = 196 PrimaryEnDatAbsolutePosition = 197 CoordinatedDistanceRemaining = 199 ServoLoopControlEffort = 201 PhaseAVoltageCommand = 208 PhaseBVoltageCommand = 209 PhaseCVoltageCommand = 210 AmplifierPeakCurrent = 211 FpgaVersion = 212 DriveTypeId = 213 PsoWindow0ArrayIndex = 214 PsoWindow1ArrayIndex = 215 PsoDistanceArrayIndex = 216 AmplifierTemperature = 217 PsoBitArrayIndex = 218 MxAbsolutePosition = 219 ServoUpdateRate = 220 SettlingTime = 221 InternalStatusCode = 222 FirmwareVersionMajor = 223 FirmwareVersionMinor = 224 FirmwareVersionPatch = 225 FirmwareVersionBuild = 226 DriveTimerDebugMax = 227 MarkerSearchDistance = 228 SafeZoneState = 230 PositionFeedbackGalvo = 234 PositionErrorGalvo = 235 LatchedMarkerPosition = 236 MoveReferencePosition = 237 MoveReferenceOffsetCutterRadius = 250 MoveReferenceOffsetCornerRounding = 251 MoveReferenceOffsetTotal = 252 PrimaryBissAbsolutePosition = 255 FaultPositionFeedback = 258 MotorCommutationAngle = 259 ExpansionBoardOption = 260 BusVoltage = 261 PiezoVoltageCommand = 262 PiezoVoltageFeedback = 263 DistanceLog = 264 TimeSinceReset = 273 MaximumVoltage = 274 CommandOutputType = 275 ServoLoopFeedforwardControlEffort = 290 LastTickCounter = 291 BoardRevision = 292 GalvoLaserOutput = 294 LaserOutputRawAdvance = 296 GalvoLaserOnDelay = 297 GalvoLaserOffDelay = 298 GalvoLaserPowerCorrectionOutput = 299 CapacitanceSensorRawPosition = 300 CalibrationAdjustmentState = 301 AccuracyCorrectionStartingPosition = 302 AccuracyCorrectionEndingPosition = 303 PositionCalibrationGalvo = 304 DriveCommandsDelayed = 309 DriveCommandsLost = 310 BusVoltageNegative = 325 ProcessorTemperature = 326 StoStatus = 327 InternalStatusTimestamp = 328 AnalogSensorInput = 329 MotorTemperature = 330 PrimaryBissStatus = 332 DriveAssert = 336 PsoExternalSyncFrequency = 337 EncoderSineRaw = 346 EncoderCosineRaw = 347 FpgaTemperature = 353 PrimaryEnDatStatus = 355 DriveTimerHighPriorityThread = 356 DriveTimerLowPriorityThread = 357 DriveTimerLowPriorityPacket = 358 DriveTimerServoPacket = 359 DriveTimerServoThread = 360 DriveTimerCurrentPacket = 361 DriveTimerCommonCoreThread = 362 DriveTimerServoCorePacket = 363 MultiplierOption = 365 PrimaryFeedback = 366 ServoLoopFeedbackInput0 = 367 ServoLoopFeedbackInput1 = 368 AccelerationSCurvePercentage = 371 DecelerationSCurvePercentage = 372 FaultSubcode = 376 ProcessorTemperatureMax = 378 DriveTimerHyperWireDma = 381 AmplifierTemperatureMax = 382 AuxiliaryEnDatAbsolutePosition = 383 AuxiliaryEnDatStatus = 384 AuxiliaryBissAbsolutePosition = 385 AuxiliaryBissStatus = 386 PsoOption = 387 DriveArraySize = 388 RatedMotorSupplyVoltageOption = 389 GantryMarkerDifference = 390 AbsoluteEncoderOption = 391 PrimaryFeedbackStatus = 392 AuxiliaryFeedbackStatus = 393 AmplifierStatus = 394 LatchedCwLimitPosition = 395 LatchedCcwLimitPosition = 396 LaserFpgaTransitionDelay = 397 HomeTargetPosition = 398 GantryRealignmentMoveTargetPosition = 399 GantryDriveControlRealignmentState = 400 PiezoAccumulatedCharge = 401 PiezoChargingTime = 402 PrimarySsiAbsolutePosition = 403 PrimarySsiStatus = 404 AuxiliarySsiAbsolutePosition = 405 AuxiliarySsiStatus = 406 PsoDistanceActiveDistance = 407 PsoWindow0ActiveLowerBound = 408 PsoWindow0ActiveUpperBound = 409 PsoWindow1ActiveLowerBound = 410 PsoWindow1ActiveUpperBound = 411 PsoWaveformActiveTotalTime = 412 PsoWaveformActiveOnTime = 413 PsoWaveformActivePulseCount = 414 PsoEventActiveBitValue = 415 DriveTimerDriveBasedControllerOutputDma = 419 DriveTimerPcieInboundFsm = 420 DriveStackUsage = 427 DriveInterfacePositionCommandPhysical = 434 DriveControlReason = 435 ShuntResistorTemperature = 436 SyncPortAPosition = 444 SyncPortBPosition = 445 HighSpeedOutputEncoderPosition = 446 AuxiliaryEncoderOutputPosition = 447 SyncPortAStatus = 448 SyncPortBStatus = 449 HighSpeedOutputEncoderStatus = 450 AuxiliaryEncoderOutputStatus = 451 DriveMemoryUInt32 = 454 DriveMemoryUInt16 = 455 DriveMemoryUInt8 = 456 CurrentLoopFeedbackControlEffort = 458 CurrentLoopFeedforwardControlEffort = 459 HighSpeedInput = 460 PositionCommandEncoder = 461 PositionFeedbackEncoder = 462 ServoLoopFeedbackControlEffort = 463 AnalogOutputHardwareStatus = 464 DigitalOutputHardwareStatus = 465 EnhancedScannerControlOption = 466 AnalogOutput4 = 467 AnalogOutput5 = 468 MoveReferenceOffsetCutterOffset = 471 LaserOutputRaw = 485 LaserOutput = 486 AutofocusError = 487 MotionRestrictionMask = 488 PWMPlusAmplifierType = 490 DriveTimerCurrentThread = 491 DriveTimerServoThread2 = 492 PhysicalSensor0Position = 495 PhysicalSensor1Position = 496 PhysicalSensor0PositionServo = 497 PhysicalSensor1PositionServo = 498 end |
function AppDataCollectionAddAxisSignal($axis as axis, $dataSignal as AxisDataSignal, $additionalData as integer)
Adds an axis status signal to the application's data collection configuration. This function must have a connected Automation1 Studio, Automation1 MachineApps, or a custom .NET application that registers to handle it. If there is not an application connected to your controller that can handle this function, an error will occur. If you need to do a check, call the AppDataCollectionAddAxisSignalIsRegistered() function.
Arguments
$axis The axis from which to retrieve the status signal value.
$dataSignal The data signal to retrieve.
$additionalData Additional data for the specified status signal. This argument is required by some status signals.
enum AxisDataSignal
| enum AxisDataSignal
PositionFeedback = 0 PositionCommand = 1 PositionError = 2 VelocityFeedback = 3 VelocityCommand = 4 VelocityError = 5 AccelerationCommand = 6 CurrentFeedback = 7 CurrentCommand = 8 CurrentError = 9 AnalogInput0 = 10 AnalogInput1 = 11 PositionCommandRaw = 12 VelocityCommandRaw = 13 AuxiliaryFeedback = 14 DigitalInput = 15 DigitalOutput = 16 WorkOffsetValue = 18 PhaseACurrentFeedback = 19 PhaseBCurrentFeedback = 20 EncoderSine = 21 EncoderCosine = 22 AnalogInput2 = 23 AnalogInput3 = 24 FrequencyResponseBefore = 25 FrequencyResponseAfter = 26 AnalogOutput0 = 31 AnalogOutput1 = 32 AnalogOutput2 = 33 AnalogOutput3 = 34 DriveMemoryInt32 = 35 DriveMemoryFloat = 36 DriveMemoryDouble = 37 PsoStatus = 38 DriveTimerDebug = 39 CoordinatedPositionTarget = 41 DriveStatus = 42 AxisStatus = 43 AxisFault = 44 AccelerationCommandRaw = 45 PositionCalibrationAll = 50 PositionFeedbackRollover = 63 PositionCommandRollover = 64 VelocityFeedbackAverage = 65 CurrentFeedbackAverage = 66 AxisParameter = 68 Backlash = 72 HomeState = 73 PositionCalibration2D = 74 NormalcyDebug = 75 TotalMoveTime = 76 PositionFeedbackDrive = 77 JerkCommandRaw = 78 ProgramPositionCommand = 79 PositionOffset = 80 PositionCommandRawBackwardsDiff = 82 VelocityCommandRawBackwardsDiffDelta = 83 PositionCommandDrive = 84 DriveStatusActual = 85 WorkOffsetIndex = 88 ProgramPositionFeedback = 89 JogTrajectoryStatus = 94 PingTest = 95 AccelerationTime = 109 DecelerationTime = 110 AccelerationRate = 111 DecelerationRate = 112 AccelerationType = 113 DecelerationType = 114 AccelerationMode = 115 DecelerationMode = 116 ProgramPosition = 124 DriveMemoryInt16 = 125 DriveMemoryInt8 = 126 SpeedTarget = 128 PositionCommandPacket = 131 DriveSmcMotionState = 132 PositionCommandRawCal = 140 VelocityCommandRawCal = 141 VelocityCommandDrive = 142 AccelerationCommandDrive = 143 GalvoLaserOutputRaw = 144 DriveInterfacePacketInt32 = 147 DriveInterfacePacketInt16 = 148 DriveInterfacePacketInt8 = 149 DriveInterfacePacketDouble = 150 DriveInterfacePacketFloat = 151 DriveInterfaceCommandCode = 152 AccelerationFeedback = 153 AccelerationCommandRawCal = 154 PositionCalibrationAllDrive = 155 BacklashTarget = 156 DriveMotionRate = 158 DriveMotionDelay = 159 CalibrationAdjustmentValue = 160 ServoRounding = 161 ServoLoopFeedforwardControlEffortRaw = 162 DriveInterfacePacketInfoBitValue = 164 AccelerationError = 165 SuppressedFaults = 167 DriveInterfacePacketStreamingData = 168 PositionCommandRawUnfiltered = 169 TransitionOffsetErrors = 170 PsoCounter0 = 171 PsoCounter1 = 172 PsoCounter2 = 173 PsoWindow0 = 174 PsoWindow1 = 175 DriveDataCaptureSamples = 176 PositionCommandGalvo = 178 FreezeVelocityCommand = 179 FreezeVelocityFeedback = 180 InternalPositionOffsets = 181 StatusHighLevelOffsetsLastMsec = 182 ProgramVelocityCommand = 183 ProgramVelocityFeedback = 184 DriveMotionDelayLive = 185 DriveCommunicationDelay = 186 DriveCommunicationDelayLive = 187 DriveInterfacePacketResponseInt32 = 189 DriveInterfacePacketResponseInt16 = 190 DriveInterfacePacketResponseInt8 = 191 DriveInterfacePacketResponseDouble = 192 DriveInterfacePacketResponseFloat = 193 DriveInterfacePacketBit = 194 DriveInterfacePacketResponseBit = 195 SpeedTargetActual = 196 PrimaryEnDatAbsolutePosition = 197 CoordinatedDistanceRemaining = 199 ServoLoopControlEffort = 201 PhaseAVoltageCommand = 208 PhaseBVoltageCommand = 209 PhaseCVoltageCommand = 210 AmplifierPeakCurrent = 211 FpgaVersion = 212 DriveTypeId = 213 PsoWindow0ArrayIndex = 214 PsoWindow1ArrayIndex = 215 PsoDistanceArrayIndex = 216 AmplifierTemperature = 217 PsoBitArrayIndex = 218 MxAbsolutePosition = 219 ServoUpdateRate = 220 SettlingTime = 221 InternalStatusCode = 222 FirmwareVersionMajor = 223 FirmwareVersionMinor = 224 FirmwareVersionPatch = 225 FirmwareVersionBuild = 226 DriveTimerDebugMax = 227 MarkerSearchDistance = 228 SafeZoneState = 230 PositionFeedbackGalvo = 234 PositionErrorGalvo = 235 LatchedMarkerPosition = 236 MoveReferencePosition = 237 MoveReferenceOffsetCutterRadius = 250 MoveReferenceOffsetCornerRounding = 251 MoveReferenceOffsetTotal = 252 PrimaryBissAbsolutePosition = 255 FaultPositionFeedback = 258 MotorCommutationAngle = 259 ExpansionBoardOption = 260 BusVoltage = 261 PiezoVoltageCommand = 262 PiezoVoltageFeedback = 263 DistanceLog = 264 TimeSinceReset = 273 MaximumVoltage = 274 CommandOutputType = 275 ServoLoopFeedforwardControlEffort = 290 LastTickCounter = 291 BoardRevision = 292 GalvoLaserOutput = 294 LaserOutputRawAdvance = 296 GalvoLaserOnDelay = 297 GalvoLaserOffDelay = 298 GalvoLaserPowerCorrectionOutput = 299 CapacitanceSensorRawPosition = 300 CalibrationAdjustmentState = 301 AccuracyCorrectionStartingPosition = 302 AccuracyCorrectionEndingPosition = 303 PositionCalibrationGalvo = 304 DriveCommandsDelayed = 309 DriveCommandsLost = 310 BusVoltageNegative = 325 ProcessorTemperature = 326 StoStatus = 327 InternalStatusTimestamp = 328 AnalogSensorInput = 329 MotorTemperature = 330 PrimaryBissStatus = 332 DriveAssert = 336 PsoExternalSyncFrequency = 337 EncoderSineRaw = 346 EncoderCosineRaw = 347 FpgaTemperature = 353 PrimaryEnDatStatus = 355 DriveTimerHighPriorityThread = 356 DriveTimerLowPriorityThread = 357 DriveTimerLowPriorityPacket = 358 DriveTimerServoPacket = 359 DriveTimerServoThread = 360 DriveTimerCurrentPacket = 361 DriveTimerCommonCoreThread = 362 DriveTimerServoCorePacket = 363 MultiplierOption = 365 PrimaryFeedback = 366 ServoLoopFeedbackInput0 = 367 ServoLoopFeedbackInput1 = 368 AccelerationSCurvePercentage = 371 DecelerationSCurvePercentage = 372 FaultSubcode = 376 ProcessorTemperatureMax = 378 DriveTimerHyperWireDma = 381 AmplifierTemperatureMax = 382 AuxiliaryEnDatAbsolutePosition = 383 AuxiliaryEnDatStatus = 384 AuxiliaryBissAbsolutePosition = 385 AuxiliaryBissStatus = 386 PsoOption = 387 DriveArraySize = 388 RatedMotorSupplyVoltageOption = 389 GantryMarkerDifference = 390 AbsoluteEncoderOption = 391 PrimaryFeedbackStatus = 392 AuxiliaryFeedbackStatus = 393 AmplifierStatus = 394 LatchedCwLimitPosition = 395 LatchedCcwLimitPosition = 396 LaserFpgaTransitionDelay = 397 HomeTargetPosition = 398 GantryRealignmentMoveTargetPosition = 399 GantryDriveControlRealignmentState = 400 PiezoAccumulatedCharge = 401 PiezoChargingTime = 402 PrimarySsiAbsolutePosition = 403 PrimarySsiStatus = 404 AuxiliarySsiAbsolutePosition = 405 AuxiliarySsiStatus = 406 PsoDistanceActiveDistance = 407 PsoWindow0ActiveLowerBound = 408 PsoWindow0ActiveUpperBound = 409 PsoWindow1ActiveLowerBound = 410 PsoWindow1ActiveUpperBound = 411 PsoWaveformActiveTotalTime = 412 PsoWaveformActiveOnTime = 413 PsoWaveformActivePulseCount = 414 PsoEventActiveBitValue = 415 DriveTimerDriveBasedControllerOutputDma = 419 DriveTimerPcieInboundFsm = 420 DriveStackUsage = 427 DriveInterfacePositionCommandPhysical = 434 DriveControlReason = 435 ShuntResistorTemperature = 436 SyncPortAPosition = 444 SyncPortBPosition = 445 HighSpeedOutputEncoderPosition = 446 AuxiliaryEncoderOutputPosition = 447 SyncPortAStatus = 448 SyncPortBStatus = 449 HighSpeedOutputEncoderStatus = 450 AuxiliaryEncoderOutputStatus = 451 DriveMemoryUInt32 = 454 DriveMemoryUInt16 = 455 DriveMemoryUInt8 = 456 CurrentLoopFeedbackControlEffort = 458 CurrentLoopFeedforwardControlEffort = 459 HighSpeedInput = 460 PositionCommandEncoder = 461 PositionFeedbackEncoder = 462 ServoLoopFeedbackControlEffort = 463 AnalogOutputHardwareStatus = 464 DigitalOutputHardwareStatus = 465 EnhancedScannerControlOption = 466 AnalogOutput4 = 467 AnalogOutput5 = 468 MoveReferenceOffsetCutterOffset = 471 LaserOutputRaw = 485 LaserOutput = 486 AutofocusError = 487 MotionRestrictionMask = 488 PWMPlusAmplifierType = 490 DriveTimerCurrentThread = 491 DriveTimerServoThread2 = 492 PhysicalSensor0Position = 495 PhysicalSensor1Position = 496 PhysicalSensor0PositionServo = 497 PhysicalSensor1PositionServo = 498 end |
function AppDataCollectionAddAxisSignalIsRegistered() as integer
Returns if the AppDataCollectionAddAxisSignal() function is registered by an application.
Returns
If the function is registered by an application, returns 1. Otherwise, returns 0.
Configure Task Signals
Use the AppDataCollectionAddTaskSignal() and AppDataCollectionAddTaskSignalIsRegistered() functions to configure the task signals to collect for data collection:
function AppDataCollectionAddTaskSignal($taskIndex as integer, $dataSignal as TaskDataSignal)
Adds a task status signal to the application's data collection configuration. This function must have a connected Automation1 Studio, Automation1 MachineApps, or a custom .NET application that registers to handle it. If there is not an application connected to your controller that can handle this function, an error will occur. If you need to do a check, call the AppDataCollectionAddTaskSignalIsRegistered() function.
Arguments
$taskIndex The task from which to retrieve the status signal value.
$dataSignal The data signal to retrieve.
enum TaskDataSignal
| enum TaskDataSignal
ProgramLineNumber = 17 CoordinatedFlags = 40 CoordinatedArcStartAngle = 53 CoordinatedArcEndAngle = 54 CoordinatedArcRadius = 55 CoordinatedArcRadiusError = 56 CoordinatedPositionCommand = 57 CoordinatedSpeedCommand = 58 CoordinatedAccelerationCommand = 59 CoordinatedTotalDistance = 60 CoordinatedPercentDone = 61 CoordinatedPositionCommandBackwardsDiff = 62 TaskParameter = 69 TaskError = 70 TaskWarning = 71 CoordinatedSpeedTargetActual = 86 DependentCoordinatedSpeedTargetActual = 87 TaskStatus0 = 90 TaskStatus1 = 91 TaskStatus2 = 92 SpindleSpeedTarget = 93 CoordinateSystem1I = 96 CoordinateSystem1J = 97 CoordinateSystem1K = 98 CoordinateSystem1Plane = 99 Mfo = 101 CoordinatedSpeedTarget = 102 DependentCoordinatedSpeedTarget = 103 CoordinatedAccelerationRate = 104 CoordinatedDecelerationRate = 105 CoordinatedAccelerationTime = 106 CoordinatedDecelerationTime = 107 TaskMode = 108 TaskState = 117 TaskStateInternal = 118 ExecutionMode = 121 EnableAlignmentAxes = 127 CoordinatedLaserOutput = 133 CoordinatedMotionRate = 145 CoordinatedTaskCommand = 146 EnableState = 166 LookaheadMovesExamined = 200 ProfileControlMask = 231 CoordinatedArcRadiusReciprocal = 253 MotionEngineStage = 254 CoordinatedTimeScale = 256 CoordinatedTimeScaleDerivative = 257 IfovSpeedScale = 266 IfovSpeedScaleAverage = 267 IfovGenerationFrameCounter = 268 IfovGenerationTimeOriginal = 269 IfovGenerationTimeModified = 270 IfovCoordinatedPositionCommand = 271 IfovCoordinatedSpeedCommand = 272 IfovCenterPointH = 276 IfovCenterPointV = 277 IfovTrajectoryCount = 278 IfovTrajectoryIndex = 279 IfovAttemptCode = 280 IfovGenerationFrameIndex = 281 IfovMaximumVelocity = 282 IfovIdealVelocity = 283 TaskInternalDebug = 284 IfovCoordinatedAccelerationCommand = 285 IfovFovPositionH = 286 IfovFovPositionV = 287 IfovFovDimensionH = 288 IfovFovDimensionV = 289 MotionBufferElements = 311 MotionBufferMoves = 312 MotionLineNumber = 313 MotionBufferRetraceMoves = 314 MotionBufferRetraceElements = 315 MotionBufferIndex = 316 MotionBufferIndexLookahead = 317 MotionBufferProcessingBlocked = 318 ActiveMoveValid = 319 TaskExecutionLines = 320 SchedulerTaskHolds = 321 SchedulerProgramLoopRuns = 322 SchedulerTaskBlocked = 323 CriticalSectionsActive = 324 AxesSlowdownReason = 331 TaskExecutionTime = 333 TaskExecutionTimeMaximum = 334 TaskExecutionLinesMaximum = 335 LookaheadDecelReason = 338 LookaheadDecelMoves = 339 LookaheadDecelDistance = 340 ProgramCounter = 341 StackPointer = 342 FramePointer = 343 StringStackPointer = 344 ProgramLineNumberSourceFileId = 349 MotionLineNumberSourceFileId = 350 ProgramLineNumberSourcePathId = 351 MotionLineNumberSourcePathId = 352 StringArgumentStackPointer = 354 CoordinatedAccelerationSCurvePercentage = 369 CoordinatedDecelerationSCurvePercentage = 370 DependentCoordinatedAccelerationRate = 373 DependentCoordinatedDecelerationRate = 374 CriticalSectionTimeout = 375 CommandQueueCapacity = 421 CommandQueueUnexecutedCount = 422 CommandQueueTimesEmptied = 423 CommandQueueExecutedCount = 424 CommandQueueLineNumber = 452 TaskReal = 469 TaskInteger = 470 MotionRestrictionAllowSectionsActive = 489 end |
function AppDataCollectionAddTaskSignal($taskIndex as integer, $dataSignal as TaskDataSignal, $additionalData as integer)
Adds a task status signal to the application's data collection configuration. This function must have a connected Automation1 Studio, Automation1 MachineApps, or a custom .NET application that registers to handle it. If there is not an application connected to your controller that can handle this function, an error will occur. If you need to do a check, call the AppDataCollectionAddTaskSignalIsRegistered() function.
Arguments
$taskIndex The task from which to retrieve the status signal value.
$dataSignal The data signal to retrieve.
$additionalData Additional data for the specified status signal. This argument is required by some status signals.
enum TaskDataSignal
| enum TaskDataSignal
ProgramLineNumber = 17 CoordinatedFlags = 40 CoordinatedArcStartAngle = 53 CoordinatedArcEndAngle = 54 CoordinatedArcRadius = 55 CoordinatedArcRadiusError = 56 CoordinatedPositionCommand = 57 CoordinatedSpeedCommand = 58 CoordinatedAccelerationCommand = 59 CoordinatedTotalDistance = 60 CoordinatedPercentDone = 61 CoordinatedPositionCommandBackwardsDiff = 62 TaskParameter = 69 TaskError = 70 TaskWarning = 71 CoordinatedSpeedTargetActual = 86 DependentCoordinatedSpeedTargetActual = 87 TaskStatus0 = 90 TaskStatus1 = 91 TaskStatus2 = 92 SpindleSpeedTarget = 93 CoordinateSystem1I = 96 CoordinateSystem1J = 97 CoordinateSystem1K = 98 CoordinateSystem1Plane = 99 Mfo = 101 CoordinatedSpeedTarget = 102 DependentCoordinatedSpeedTarget = 103 CoordinatedAccelerationRate = 104 CoordinatedDecelerationRate = 105 CoordinatedAccelerationTime = 106 CoordinatedDecelerationTime = 107 TaskMode = 108 TaskState = 117 TaskStateInternal = 118 ExecutionMode = 121 EnableAlignmentAxes = 127 CoordinatedLaserOutput = 133 CoordinatedMotionRate = 145 CoordinatedTaskCommand = 146 EnableState = 166 LookaheadMovesExamined = 200 ProfileControlMask = 231 CoordinatedArcRadiusReciprocal = 253 MotionEngineStage = 254 CoordinatedTimeScale = 256 CoordinatedTimeScaleDerivative = 257 IfovSpeedScale = 266 IfovSpeedScaleAverage = 267 IfovGenerationFrameCounter = 268 IfovGenerationTimeOriginal = 269 IfovGenerationTimeModified = 270 IfovCoordinatedPositionCommand = 271 IfovCoordinatedSpeedCommand = 272 IfovCenterPointH = 276 IfovCenterPointV = 277 IfovTrajectoryCount = 278 IfovTrajectoryIndex = 279 IfovAttemptCode = 280 IfovGenerationFrameIndex = 281 IfovMaximumVelocity = 282 IfovIdealVelocity = 283 TaskInternalDebug = 284 IfovCoordinatedAccelerationCommand = 285 IfovFovPositionH = 286 IfovFovPositionV = 287 IfovFovDimensionH = 288 IfovFovDimensionV = 289 MotionBufferElements = 311 MotionBufferMoves = 312 MotionLineNumber = 313 MotionBufferRetraceMoves = 314 MotionBufferRetraceElements = 315 MotionBufferIndex = 316 MotionBufferIndexLookahead = 317 MotionBufferProcessingBlocked = 318 ActiveMoveValid = 319 TaskExecutionLines = 320 SchedulerTaskHolds = 321 SchedulerProgramLoopRuns = 322 SchedulerTaskBlocked = 323 CriticalSectionsActive = 324 AxesSlowdownReason = 331 TaskExecutionTime = 333 TaskExecutionTimeMaximum = 334 TaskExecutionLinesMaximum = 335 LookaheadDecelReason = 338 LookaheadDecelMoves = 339 LookaheadDecelDistance = 340 ProgramCounter = 341 StackPointer = 342 FramePointer = 343 StringStackPointer = 344 ProgramLineNumberSourceFileId = 349 MotionLineNumberSourceFileId = 350 ProgramLineNumberSourcePathId = 351 MotionLineNumberSourcePathId = 352 StringArgumentStackPointer = 354 CoordinatedAccelerationSCurvePercentage = 369 CoordinatedDecelerationSCurvePercentage = 370 DependentCoordinatedAccelerationRate = 373 DependentCoordinatedDecelerationRate = 374 CriticalSectionTimeout = 375 CommandQueueCapacity = 421 CommandQueueUnexecutedCount = 422 CommandQueueTimesEmptied = 423 CommandQueueExecutedCount = 424 CommandQueueLineNumber = 452 TaskReal = 469 TaskInteger = 470 MotionRestrictionAllowSectionsActive = 489 end |
function AppDataCollectionAddTaskSignalIsRegistered() as integer
Returns if the AppDataCollectionAddTaskSignal() function is registered by an application.
Returns
If the function is registered by an application, returns 1. Otherwise, returns 0.
Configure System Signals
Use the AppDataCollectionAddSystemSignal() and AppDataCollectionAddSystemSignalIsRegistered() functions to configure the system signals to collect for data collection:
function AppDataCollectionAddSystemSignal($dataSignal as SystemDataSignal)
Adds a system status signal to the application's data collection configuration. This function must have a connected Automation1 Studio, Automation1 MachineApps, or a custom .NET application that registers to handle it. If there is not an application connected to your controller that can handle this function, an error will occur. If you need to do a check, call the AppDataCollectionAddSystemSignalIsRegistered() function.
Arguments
$dataSignal The data signal to retrieve.
enum SystemDataSignal
| enum SystemDataSignal
VirtualBinaryInput = 46 VirtualBinaryOutput = 47 VirtualRegisterInput = 48 VirtualRegisterOutput = 49 Timer = 51 TimerPerformance = 52 GlobalReal = 67 CommunicationRealTimeErrors = 81 LibraryCommand = 119 DataCollectionSampleTime = 120 DataCollectionSampleIndex = 129 ModbusClientConnected = 134 ModbusServerConnected = 135 ModbusClientError = 136 ModbusServerError = 137 StopWatchTimer = 157 ScopetrigId = 163 EstimatedProcessorUsage = 177 DataCollectionStatus = 188 SignalLogState = 198 SafeZoneViolationMask = 207 SafeZoneActiveMask = 229 ModbusClientInputWords = 240 ModbusClientOutputWords = 241 ModbusClientInputBits = 242 ModbusClientOutputBits = 243 ModbusClientOutputBitsStatus = 244 ModbusClientOutputWordsStatus = 245 ModbusServerInputWords = 246 ModbusServerOutputWords = 247 ModbusServerInputBits = 248 ModbusServerOutputBits = 249 SystemParameter = 265 ThermoCompSensorTemperature = 305 ThermoCompControllingTemperature = 306 ThermoCompCompensatingTemperature = 307 ThermoCompStatus = 308 GlobalInteger = 345 AliveAxesMask = 348 SignalLogPointsStored = 377 ControllerInitializationWarning = 379 StopWatchTimerMin = 416 StopWatchTimerMax = 417 StopWatchTimerAvg = 418 EthercatEnabled = 428 EthercatError = 429 EthercatTxPdo = 430 EthercatTxPdoSize = 431 EthercatRxPdo = 432 EthercatRxPdoSize = 433 EthercatState = 437 ModbusClientEnabled = 438 ModbusServerEnabled = 439 HyperWireExternalSynchronizationActive = 440 HyperWireExternalSynchronizationFrequency = 441 HyperWireExternalSynchronizationLagging = 442 HyperWireExternalSynchronizationAdjustmentNanoseconds = 443 CallbackSlotProcessingState = 453 ControllerAssertCount = 457 VirtualBinaryInputBit = 472 VirtualBinaryOutputBit = 473 EtherNetIpAdapterEnabled = 474 EtherNetIpAdapterConnected = 475 EtherNetIpAdapterError = 476 EtherNetIpAdapterInputBlock0Size = 477 EtherNetIpAdapterInputBlock1Size = 478 EtherNetIpAdapterOutputBlock0Size = 479 EtherNetIpAdapterOutputBlock1Size = 480 EtherNetIpAdapterInputBlock0 = 481 EtherNetIpAdapterInputBlock1 = 482 EtherNetIpAdapterOutputBlock0 = 483 EtherNetIpAdapterOutputBlock1 = 484 ModbusClientProtocolError = 493 ModbusServerProtocolError = 494 end |
function AppDataCollectionAddSystemSignal($dataSignal as SystemDataSignal, $additionalData as integer)
Adds a system status signal to the application's data collection configuration. This function must have a connected Automation1 Studio, Automation1 MachineApps, or a custom .NET application that registers to handle it. If there is not an application connected to your controller that can handle this function, an error will occur. If you need to do a check, call the AppDataCollectionAddSystemSignalIsRegistered() function.
Arguments
$dataSignal The data signal to retrieve.
$additionalData Additional data for the specified status signal. This argument is required by some status signals.
enum SystemDataSignal
| enum SystemDataSignal
VirtualBinaryInput = 46 VirtualBinaryOutput = 47 VirtualRegisterInput = 48 VirtualRegisterOutput = 49 Timer = 51 TimerPerformance = 52 GlobalReal = 67 CommunicationRealTimeErrors = 81 LibraryCommand = 119 DataCollectionSampleTime = 120 DataCollectionSampleIndex = 129 ModbusClientConnected = 134 ModbusServerConnected = 135 ModbusClientError = 136 ModbusServerError = 137 StopWatchTimer = 157 ScopetrigId = 163 EstimatedProcessorUsage = 177 DataCollectionStatus = 188 SignalLogState = 198 SafeZoneViolationMask = 207 SafeZoneActiveMask = 229 ModbusClientInputWords = 240 ModbusClientOutputWords = 241 ModbusClientInputBits = 242 ModbusClientOutputBits = 243 ModbusClientOutputBitsStatus = 244 ModbusClientOutputWordsStatus = 245 ModbusServerInputWords = 246 ModbusServerOutputWords = 247 ModbusServerInputBits = 248 ModbusServerOutputBits = 249 SystemParameter = 265 ThermoCompSensorTemperature = 305 ThermoCompControllingTemperature = 306 ThermoCompCompensatingTemperature = 307 ThermoCompStatus = 308 GlobalInteger = 345 AliveAxesMask = 348 SignalLogPointsStored = 377 ControllerInitializationWarning = 379 StopWatchTimerMin = 416 StopWatchTimerMax = 417 StopWatchTimerAvg = 418 EthercatEnabled = 428 EthercatError = 429 EthercatTxPdo = 430 EthercatTxPdoSize = 431 EthercatRxPdo = 432 EthercatRxPdoSize = 433 EthercatState = 437 ModbusClientEnabled = 438 ModbusServerEnabled = 439 HyperWireExternalSynchronizationActive = 440 HyperWireExternalSynchronizationFrequency = 441 HyperWireExternalSynchronizationLagging = 442 HyperWireExternalSynchronizationAdjustmentNanoseconds = 443 CallbackSlotProcessingState = 453 ControllerAssertCount = 457 VirtualBinaryInputBit = 472 VirtualBinaryOutputBit = 473 EtherNetIpAdapterEnabled = 474 EtherNetIpAdapterConnected = 475 EtherNetIpAdapterError = 476 EtherNetIpAdapterInputBlock0Size = 477 EtherNetIpAdapterInputBlock1Size = 478 EtherNetIpAdapterOutputBlock0Size = 479 EtherNetIpAdapterOutputBlock1Size = 480 EtherNetIpAdapterInputBlock0 = 481 EtherNetIpAdapterInputBlock1 = 482 EtherNetIpAdapterOutputBlock0 = 483 EtherNetIpAdapterOutputBlock1 = 484 ModbusClientProtocolError = 493 ModbusServerProtocolError = 494 end |
function AppDataCollectionAddSystemSignalIsRegistered() as integer
Returns if the AppDataCollectionAddSystemSignal() function is registered by an application.
Returns
If the function is registered by an application, returns 1. Otherwise, returns 0.
Configure Industrial Ethernet Signals
Use the AppDataCollectionAddIndustrialEthernetMappingSignal() and AppDataCollectionAddIndustrialEthernetMappingSignalIsRegistered() functions to configure the Industrial Ethernet signals to collect for data collection. See EtherCAT Overview, Modbus TCP/IP Overview, or EtherNet/IP Overview for more information about Industrial Ethernet.
function AppDataCollectionAddIndustrialEthernetMappingSignal($variableName as string)
Adds an Industrial Ethernet mapping signal to the application's data collection configuration. To check if an application is registered to handle this function, you can call AppDataCollectionAddIndustrialEthernetMappingSignalIsRegistered() function.
Arguments
$variableName The variable name of the Industrial Ethernet mapping to retrieve.
function AppDataCollectionAddIndustrialEthernetMappingSignalIsRegistered() as integer
Returns if the AppDataCollectionAddIndustrialEthernetMappingSignal() function is registered by an application.
Returns
If the function is registered by an application, returns 1. Otherwise, returns 0.
How to Use Industrial Ethernet Data Collection Functions
The examples that follow show you how to retrieve some Industrial Ethernet signals.
Program Example: Collect a Scalar Industrial Ethernet Mapping
// Configure Data Collection to collect a scalar mapping (with a Count of 1) named "inputBit".
AppDataCollectionAddIndustrialEthernetMappingSignal("inputBit")
Program Example: Collect an Element of an Industrial Ethernet Array Mapping
// Configure Data Collection to collect an element of an array mapping (with a Count that is more than 1) that
// is named "outputBits".
AppDataCollectionAddIndustrialEthernetMappingSignal("outputBits[2]")
Configure the Number of Samples and Sample Time for Data Collection
Use the AppDataCollectionConfigure() function to configure the number of samples and the sample time for data collection. Before you use this function, you can use the related AppDataCollection*IsRegistered() functions to see if it is registered with an Automation1 Studio, Automation1 MachineApps, or a custom .NET application.
The $numSamples argument specifies the number of samples collected by data collection. The $sampleTime argument specifies the number of milliseconds between each sample that is collected. Convert a sample frequency to a sample time with the formula that follows.
For example, to collect data with a sample rate of 20 kHz, specify a value of (1.0 / 20.0) or 0.05 for the $sampleTime argument. For more information about sample rates that the controller supports, refer to Data Collection Rates.
Calculate the duration of data collection with the formula that follows.
Use the DataCollectionItems Parameter and the DataCollectionPoints Parameter to configure the amount of controller memory that is available for data collection. To determine how much memory is available for data collection, use the formula that follows.
Memory allocation is necessary for collecting data. If the memory allocation does not complete correctly, a memory allocation error occurs. If memory resources are low, you can decrease the value of the DataCollectionItems parameter and the DataCollectionPoints parameter to release memory for other Automation1 features.
function AppDataCollectionConfigure($numSamples as integer, $sampleTime as real)
Configures application data collection. This function must have a connected Automation1 Studio, Automation1 MachineApps, or a custom .NET application that registers to handle it. If there is not an application connected to your controller that can handle this function, an error will occur. If you need to do a check, call the AppDataCollectionConfigureIsRegistered() function.
Arguments
$numSamples Specifies the number of data samples to collect.
$sampleTime Specifies the sample time in milliseconds.
function AppDataCollectionConfigureIsRegistered() as integer
Returns if the AppDataCollectionConfigure() function is registered by an application.
Returns
If the function is registered by an application, returns 1. Otherwise, returns 0.
How to Configure the Data Collection Rate and Number of Samples
The examples that follow show you how to configure the number of samples and the sample time used for data collection.
Program Example: Collect 10 Seconds of Data at 1 kHz
// Configure Data Collection to collect data for 10 seconds at a rate of 1 kHz (1 / 1 = 1 msec per sample). AppDataCollectionConfigure(10 * 1000 * 1, 1)
Program Example: Collect 10 seconds of data at 20 kHz
// Configure Data Collection to collect data for 10 seconds at a rate of 20 kHz (1 / 20 = 0.05 msec per sample). AppDataCollectionConfigure(10 * 20.0 * 1000, 1.0 / 20.0)
Start and Stop Data Collection with AppDataCollection Functions
After you have configured data collection, use the AppDataCollectionSnapshot() function to start data collection. You can only collect snapshots of data with these functions. You cannot collect continuous data.
When you issue the AppDataCollectionSnapshot() function, the controller continues to collect data for the specified number of samples. You can use the AppDataCollectionStop() function to stop data collection before the controller has collected the specified number of samples.
function AppDataCollectionSnapshot()
Triggers data collection.
function AppDataCollectionSnapshot($id as integer)
Triggers data collection in the specified application.
Arguments
$id The ID that corresponds to the application in which to trigger data collection.
function AppDataCollectionStop()
Stops data collection.
Configure Auto-Save for Snapshots
Use the AppDataCollectionAutoSaveOn() function to automatically save snapshots collected with AppDataCollectionSnapshot(). You must specify the path and the type of the file to save. Relative paths are supported and are relative to the Automation1 folder in your Documents folder. To save to an absolute path outside of the MDK folder, turn on the Allow Automatic Saving to Absolute Paths toggle in the Data Visualizer module settings in Automation1 Studio. Network and controller paths are not supported. Supported file types include Automation1 Plot, CSV, and JSON.
If auto-save is enabled, each snapshot overwrites the file you specify. The file overwrite does not occur if you issue the AppDataCollectionAutoSaveOn() function with a different file name before each snapshot or if automatic timestamps are enabled. To enable automatic timestamps, turn on the Timestamp Saved AppDataCollection Snapshots toggle. To find this, click the Settings button on the top-right corner of Studio. When the Settings dialog comes into view, select the Data Visualizer tab.
Use the AppDataCollectionAutoSave* functions to configure auto-saving. Before you use these functions, you can use their related AppDataCollection*IsRegistered() functions to see if they are registered with an Automation1 Studio, Automation1 MachineApps, or a custom .NET application.
function AppDataCollectionAutoSaveOn($mdkFilePath as string, $fileType as DataCollectionFileType)
Enables automatic saving of data collected through AppDataCollectionSnapshot(). To generate a unique file name for each snapshot, enable automatic timestamps in the application's settings. This function must have a connected Automation1 Studio, Automation1 MachineApps, or a custom .NET application that registers to handle it. If there is not an application connected to your controller that can handle this function, an error will occur. If you need to do a check, call the AppDataCollectionAutoSaveOnIsRegistered() function.
Arguments
$mdkFilePath The path that specifies where the data collection data will be saved. If the application settings do not allow saving to absolute paths, the file path will be relative to the MDK documents folder.
$fileType The format of the data collection file that will be saved.
enum DataCollectionFileType
| enum DataCollectionFileType
Plt = 0 Csv = 1 Json = 2 end |
function AppDataCollectionAutoSaveOnIsRegistered() as integer
Returns if the AppDataCollectionAutoSaveOn() function is registered by an application.
Returns
If the function is registered by an application, returns 1. Otherwise, returns 0.
function AppDataCollectionAutoSaveOff()
Disables automatic saving of data collected through the application. This function must have a connected Automation1 Studio, Automation1 MachineApps, or a custom .NET application that registers to handle it. If there is not an application connected to your controller that can handle this function, an error will occur. If you need to do a check, call the AppDataCollectionAutoSaveOffIsRegistered() function.
function AppDataCollectionAutoSaveOffIsRegistered() as integer
Returns if the AppDataCollectionAutoSaveOff() function is registered by an application.
Returns
If the function is registered by an application, returns 1. Otherwise, returns 0.
App Data Collection Example
The example that follows shows how to perform data collection with the AppDataCollection*() functions.
#define DATA_RATE 1.0 // kHz #define DATA_DURATION 5.0 // seconds AppDataCollectionReset() AppDataCollectionAddAxisSignal(X, AxisDataSignal.PositionCommand) AppDataCollectionAddAxisSignal(X, AxisDataSignal.VelocityCommand) AppDataCollectionAddAxisSignal(X, AxisDataSignal.AccelerationCommand) AppDataCollectionConfigure(DATA_DURATION * DATA_RATE * 1000.0, 1.0 / DATA_RATE) AppDataCollectionSnapshot()
