MC_GrpWriteBoolPar

PLCopen motion icon Pipe Network motion icon

 Function BlockClosed A function block groups an algorithm and a set of private data. It has inputs and outputs. - Writes a value to the specified Boolean group parameter.

Inputs

Input

Data Type

Range

Unit

Default

Description

Execute

BOOL

0, 1

N/A

No default

On the rising edgeClosed A rising edge is the transition of a digital signal from low to high. It is also called positive edge, request to write a value to the specified Boolean group parameter.

AxesGroupRef

AXES_GROUP_REF

No range

N/A

No default

The axis group the Boolean parameter value is written to.

ParamNum

UINT

No range

N/A

No default

The ID number of the Boolean parameter that is to be written.

  • IGNORE_AXIS_ESTOP
    • BoolID = 1000

ParamValue

BOOL

0, 1

N/A

No default

TRUE, FALSE

Outputs

Output

Data Type

Range

Unit

Description

Done

BOOL

 

 

If TRUE, the command completed successfully.

Busy

BOOL

 

 

If TRUE, the function block is executing.

Error

BOOL

 

 

If TRUE, an error has occurred.

ErrorID

INT

 

 

Indicates the error if Error output is TRUE.

See the table in PLCopen Function Block ErrorIDs.

Remarks

  • See Coordinated Motion, the top-level topic for Coordinated Motion.
  • See Function Blocks - General Rules for more information about how inputs and outputs work.
  • See Recovery of the System State After an Axis Error for more information.
  • IGNORE_AXIS_ESTOP
    • BoolID = 1000.
    • Value can be either TRUE or FALSE.
  • Setting this Boolean Parameter to TRUE results in the Coordinated Motion Engine NOT stopping all axes in a group when one of them is stopped due to an Axis Estop Error.
    • Only the axis experiencing the error stops when this Parameter is set to TRUE.
  • When this parameter is FALSE (Default), all axes in a group are stopped and the power off request is asserted for each axis.

Figure 6-124: MC_GrpWriteBoolPar

FBD Language Example

FFLD Language Example

IL Language Example

            BEGIN_ILClosed "Instruction List"
This is a low-level language and resembles assembly    
Cal Inst_MC_GrpWriteBoolPar( ExecuteWrite, Group1Ref, IGNORE_AXIS_ESTOP, true )
END_IL

ST Language Example

Inst_MC_GrpWriteBoolPar( ExecuteWrite, Group1Ref, IGNORE_AXIS_ESTOP, true );

See Also