MC_Jog

Functional Description

This function block starts the operating mode Jog.

In the operating mode Jog, a movement is started via the inputs Forward and Backward.

If the inputs Forward and Backward are set to FALSE, the operating mode is terminated and the output Done is set to TRUE.

If the inputs Forward and Backward are set to TRUE, the operating mode remains active, the jog movement is stopped and the output Busy remains set to TRUE.

Library and Namespace

Library name: GMC Independent PLCopen MC

Namespace: GIPLC

Graphical Representation

Inputs

Input	Data type	Description
Forward	BOOL	Value range: FALSE, TRUE. Default value: FALSE. oForward = FALSE and Backward = FALSE: Movement is terminated. oForward = TRUE and Backward = FALSE: Movement in positive direction is started. oForward = FALSE and Backward = TRUE: Movement in negative direction is started. oForward = TRUE and Backward = TRUE: The operating mode remains active, the jog movement is stopped, and the output Busy remains set to TRUE.
Backward	BOOL
Velocity	DINT	Value range: 1...2147483647 Default value: 0. Velocity in user-defined units. NOTE: For Altivar, the values for LowFrequency and HighFrequency are set in the function block SetFrequencyRange_ATV. If the value for the target velocity Velocity is less than the value for LowFrequency, the movement is made with the velocity value for LowFrequency. No error is detected. If the value for the target velocity Velocity is greater than the value for HighFrequency, the movement is made with the velocity value for HighFrequency. No error is detected.

Input

Data type

Description

Forward

BOOL

Value range: FALSE, TRUE.

Default value: FALSE.

oForward = FALSE and Backward = FALSE: Movement is terminated.

oForward = TRUE and Backward = FALSE: Movement in positive direction is started.

oForward = FALSE and Backward = TRUE: Movement in negative direction is started.

oForward = TRUE and Backward = TRUE: The operating mode remains active, the jog movement is stopped, and the output Busy remains set to TRUE.

Backward

BOOL

Velocity

DINT

Value range: 1...2147483647

Default value: 0.

Velocity in user-defined units.

NOTE: For Altivar, the values for LowFrequency and HighFrequency are set in the function block SetFrequencyRange_ATV.

If the value for the target velocity Velocity is less than the value for LowFrequency, the movement is made with the velocity value for LowFrequency. No error is detected.

If the value for the target velocity Velocity is greater than the value for HighFrequency, the movement is made with the velocity value for HighFrequency. No error is detected.

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.

Inputs/Outputs

Input/Output	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.

Notes

If you have activated this function block, simultaneous use of the Control_ATV function block leads to unintended behavior.

WARNING

UNINTENDED EQUIPMENT OPERATION

oDo not activate the Control_ATV function block when this function block is active.

oDeactivate this function block or allow the function block to terminate before activating the Control_ATV function block.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

This function block uses library-specific acceleration and deceleration values for LXM32M (EtherNet/IP and Modbus/TCP) and for Lexium ILA, ILE and ILS integrated drives (EtherNet/IP only). This means that pre-configured values for these parameters (for example, via the commissioning tool) are overwritten when this function block is executed.

The default acceleration and deceleration values written by this function block are as follows:

oThe default value for acceleration is 600 user-defined units.

oThe default values for deceleration are 600 user-defined units for LXM32M and 750 user-defined units for Lexium ILA, ILE and ILS integrated drives.

If you require other acceleration and/or deceleration values, you must use the vendor-specific function blocks to do so. Use the function blocks SetDriveRamp_LXM32 and SetDriveRamp_ILX to define the acceleration and deceleration. The function block has to be executed only once if a change of the ramp values is required.

Additional Information

Transitions Between Function Blocks

Operating Mode Jog