MC_TouchProbe

Functional Description

This function block configures and starts position capture.

The function block returns the axis position at the occurrence of a trigger event. The drive trigger parameters are provided by the device implementation.

Executing the function block MC_AbortTrigger while MC_TouchProbe is busy aborts the function for the referenced trigger input.

A new rising edge at the input Execute overwrites and restarts the active trigger function.

Library and Namespace

Library name: GMC Independent PLCopen MC

Namespace: GIPLC

Graphical Representation

Inputs

Input	Data type	Description
Execute	BOOL	Value range: FALSE, TRUE. Default value: FALSE. A rising edge of the input Execute starts the function block. The function block continues execution and the output Busy is set to TRUE. This function block can be restarted while it is executed. The target values are overwritten by the new values at the point in time the rising edge occurs.

Input

Data type

Description

Execute

BOOL

Value range: FALSE, TRUE.

Default value: FALSE.

A rising edge of the input Execute starts the function block. The function block continues execution and the output Busy is set to TRUE.

This function block can be restarted while it is executed. The target values are overwritten by the new values at the point in time the rising edge occurs.

Outputs

Output	Data type	Description
Done	BOOL	Value range: FALSE, TRUE. Default value: FALSE. oFALSE: Execution has not been started, or an error has been detected. oTRUE: Execution terminated without an error detected.
Busy	BOOL	Value range: FALSE, TRUE. Default value: FALSE. oFALSE: Function block is not being executed. oTRUE: Function block is being executed.
CommandAborted	BOOL	Value range: FALSE, TRUE. Default value: FALSE. oFALSE: Execution has not been aborted. oTRUE: Execution has been aborted by another function block.
Error	BOOL	Value range: FALSE, TRUE. Default value: FALSE. oFALSE: Execution of the function block is running, no error has been detected. oTRUE: An error has been detected in the execution of the function block.
ErrorID	WORD	Returns the value of a diagnostic code. Refer to Library Diagnostic Codes. If the value is 0 and if the output Error of this function block is set to TRUE, then the diagnostic code can be read with the output AxisErrorID of the function block MC_ReadAxisError.
RecordedPosition	DINT	Returns the value of the axis position at the occurrence of a trigger event in user-defined units. Value range: -2147483648...2147483647 Default value: 0 Captured motor position.

Inputs/Outputs

Input/Output	Data type	Elements	Data type	Description
Axis	Axis_Ref	–	Reference to the axis (instance) for which the function block is to be executed (corresponds to the name of the axis). The name of the axis must be defined in the EcoStruxure Machine Expert Devices tree.
TriggerInput	MC_Trigger_Ref	TouchProbeNumber	UINT	Selects the capture unit of the drive.
TriggerEdge	ET_TriggerEdge	Edge to trigger position capture. o0 / RisingEdge: Rising edge. o1 / FallingEdge: Falling edge. o2 / BothEdges: Both rising edge and falling edge. See also Vendor-Specific Data Type ET_TriggerEdge.

Input/Output

Data type

Elements

Data type

Description

Axis

Axis_Ref

–

Reference to the axis (instance) for which the function block is to be executed (corresponds to the name of the axis). The name of the axis must be defined in the EcoStruxure Machine Expert Devices tree.

TriggerInput

MC_Trigger_Ref

TouchProbeNumber

UINT

Selects the capture unit of the drive.

TriggerEdge

ET_TriggerEdge

Edge to trigger position capture.

o0 / RisingEdge: Rising edge.

o1 / FallingEdge: Falling edge.

o2 / BothEdges: Both rising edge and falling edge.

Notes

Use MC_AbortTrigger function block to abort MC_TouchProbe function block execution.

Additional Information

Position Capture via Signal Input