FC_AxisYOffsetStart

 

FC_AxisYOffsetStart - General Information

Overview

Type:

Function

Available as of:

SystemInterface_1.32.6.0

Versions:

Current version

Task

Create Y-offset for an axis.

Description

This function starts a positioning with the YOffsetGenerator of the axis i_AxisId. A modification of the current positioning is caused by starting a new positioning.

A restart lets you modify the parameters.

The Y offset generator starts only in AxisState 3 to 6. AxisStop or detected errors stop the Y offset generator with the YOffsetRefDeceleration.

If a Setpos function is executed while positioning is active, the travel path remains unchanged.

Interface

Input

Data type

Description

i_stAxisId

ST_LogicalAddress

Logical address of the axis

i_lrPosition

LREAL

Encoder position

i_rVelocity

REAL

Maximum velocity

i_rAcceleration

REAL

Maximum acceleration

i_rDeceleration

REAL

Maximum deceleration

i_etPosMode

ET_PosMode

ET_PosMode

Return Value

Data type

Description

DINT

0: OK

-1: i_stAxisId is invalid

-2: i_rVelocity <= 0

-3: i_rAcceleration or i_rDeceleration <= 0

-4: i_etPosMode is invalid

-5: The axis is not ready (AxisState < 3)

-6: YOffsetEnable = FALSE