MC_GrpDisable

PLCopen motion icon Pipe Network motion icon

Function Block - Changes the state of a group to GroupDisabled.

Inputs

Input	Data Type	Range	Unit	Default	Description
Execute	BOOL	0, 1	N/A	No default	On the rising edge, request to disable the axis group.
AxesGroup	AXES_GROUP_REF	No range	N/A	No default	The axis group to be disabled.

Output	Data Type	Range	Unit	Description
Done	BOOL	No range	N/A	If TRUE, the command completed successfully.
Error	BOOL	No range	N/A	If TRUE, an error has occurred.
ErrorID	INT	No range	N/A	Indicates the error if the Error output is set to TRUE. See PLCopen Function Block ErrorIDs.

Output

Data Type

Range

Unit

Description

Done

BOOL

No range

N/A

If TRUE, the command completed successfully.

Error

BOOL

No range

N/A

If TRUE, an error has occurred.

ErrorID

INT

No range

N/A

Indicates the error if the Error output is set to TRUE.

This function block starts a motion-related action and stores data for calculations and error checking.
If using a dual-core controller, see Call Function Blocks Multiple Times in the Same Cycle.

See Coordinated Motion, the top-level topic for Coordinated Motion.
If the group is already in GroupDisabled, then MC_GrpDisable does nothing.
This function block can be issued in the group states: (GroupDisabled, GroupStandby, or GroupErrorStop).
See Group State Diagrams for more information.

MC_GrpDisable fails if the group is in any state other than GroupStandby or GroupDisabled.

Figure 1: MC_GrpDisable

            BEGIN_IL
            
     CAL Inst_MC_GrpDisable( DisableGroup, Group1_Ref )
END_IL

(* Inst_MC_GrpDisableST example *)
Inst_MC_GrpDisable( DisableGroup, Group1_Ref );