Method - parameter (Init)
Parameter | Group | Return Type | Input Type | Explanation |
|---|---|---|---|---|
GetOperationMode | General | OperationMode | – | Returns the selected operation mode. |
GetEtherCatMasterSyncTaskObjectId | General | OTCID | – | Returns the EtherCAT Master Synchro Task Object ID. |
GetMoverType | Mover | MoverType | – | Returns the selected mover type. |
GetMagnetPlateType | Mover | MagnetPlateType | – | Returns the selected magnetic plate type. |
GetMoverSortOrder | Mover | SortOrderEnum | – | Returns the selected sort order of the movers. |
GetMoverWidth | Mover | LREAL | – | Returns the minimum distance between the movers. |
GetConfiguredDetectionCount | MoverDetection | UDINT | – | Returns the specified detection count. |
SetConfiguredDetectionCount | MoverDetection | BOOL | UDINT | Sets the detection count. |
TriggerDetection | MoverDetection | BOOL | – | Triggers a mover detection. |
TriggerRedetection | MoverDetection | BOOL | – | Triggers mover redetection. |
GetExpectedMoverIds | MoverIdDetection | ARRAY[1..2] OF ST_ExpectedMoverIds | – | Returns the expected mover IDs for ID detection with multiple Movers 1. |
GetMoverIdDetectionMode | MoverIdDetection | MoverIdDetectionMode | – | Returns the specified Mover ID detection mode |
GetMoverPositionAssignment | MoverIdDetection | MoverPositionAssignment | – | Returns the mover position assignment. |
TriggerMoverIdDetection | MoverIdDetection | BOOL | – | Triggers a Mover ID detection. |
SetExpectedMoverIds | MoverIdDetection | BOOL | ExpectedMoverIds : ARRAY[1..2] OF ST_ExpectedMoverIds | Sets the expected Mover IDs in ID detection with multiple Movers 1. |
SetMoverIdDetectionMode | MoverIdDetection | BOOL | MoverIdDetectionMode | Sets the Mover ID detection mode. |
SetMoverPositionAssignment | MoverIdDetection | BOOL | MoverPositionAssignment | Sets the assignment of the mover position. |
GetTeachingFileNumber | Teaching | UDINT | – | Returns the numbering/name of the teaching file. |
GetIsAbortOnTeachingWarningEnabled | Teaching | BOOL | – | Returns the setting of the teaching warning. If TRUE, the system start may be aborted because of the warning. |
Parameter | Group | Return Type | Input Type | Explanation |
|---|---|---|---|---|
GetIsTeachingCheckSumCheckEnabled | Teaching | BOOL | – | Returns the setting of the teaching checksum check. Returns TRUE if the specified checksum is used to verify that the correct teaching file is loaded and not corrupted. |
SetTeachingFileNumber | Teaching | BOOL | UDINT | Sets the numbering/name of the applied teaching file |
GetIsAutoDumpWriteEnabled | Diagnostics | BOOL | – | Returns the setting of automatic writing of the dump file. If TRUE, the driver automatically writes a dump file in certain situations like at startup or in case of an error. |
GetIsInputCheckEnabled | Diagnostics | BOOL | – | Returns the settings of the input check. If TRUE, all plausibility checks of all input channels in the system are activated. |
GetUsedEventLogger | Diagnostics | EventMessenger | – | Returns selected specifications how events and messages are transmitted by the driver |
WriteDump | Diagnostics | BOOL | – | Writes a dump file. |
SetIsInputCheckEnabled | Diagnostics | BOOL | BOOL | Sets the activation/deactivation of the input check |
GetIsCycleTimeWarningSuppressed | Advanced | BOOL | – | Returns the setting of the suppressed cycle time warning. If enabled, the warning that the driver is not running at a cycle time of 250 us is disabled. ATTENTION: Only available in simulation mode. |
GetIsMoverFrozenErrorActivated | Advanced | BOOL | – | Returns the setting of the error of a frozen mover. If enabled, the driver will give an error message instead of a warning when a position of the mover is frozen. |
GetIsPositionBasedErrorForwardingEnabled | Advanced | BOOL | – | Returns the setting of the position-related error forwarding. If enabled, a hardware fault is forwarded to movers located on the faulty modules based on their position. |
GetOptimization | Advanced | OptimizationEnum | – | Returns the selected optimization. |
GetIsPositionNoiseEnabled | Simulation | BOOL | – | Returns position noise in the simulation. |
GetIsRandomStartUpEnabled | Simulation | BOOL | – | Returns the setting of the random start position of movers. |
GetMoverDistance | Simulation | LREAL | – | Returns the mover distance at startup |
GetPositionOffset | Simulation | LREAL | – | Returns the position offset of the movers at startup |
GetPositionNoiseBandwidth | Simulation | LREAL | – | Returns the bandwidth of the position noise |
GetRandomStartUpBandwidth | Simulation | LREAL | – | Returns the bandwidth of the random start |
GetPositionStartUpSimulationMode | Simulation | PositionStartUpSimulationMode | – | Returns the selected mode for the start position |
GetMoverIdStartUpSimulationMode | Simulation | MoverIdStartUpSimulationMode | – | Returns the selected mode for generating the mover ID |
GetRandomInitMode | Simulation | RandomInitMode | – | Returns the selected mode for initialization of random selection |
GetRandomInitSeed | Simulation | DINT | – | Returns the start value used for random generation of mover position and mover ID. |