FunctionBlocks Additional MC_StopSubprogramFB - ThorstenBrach/SRCI GitHub Wiki

MC_StopSubprogramFB

📝 Description:

Stops an active subprogram.

⚙️ FB Variables:

VAR_INPUT
Parameter Data Type Default Value Description Required

InternalLogger

IMessageLogger

-

For internal usage only

-

ExternalLogger

IMessageLogger

-

For internal usage only

-

LogLevel

LogLevelEnum

-

For internal usage only

-

Name

STRING(20)

-

User defined command name

O

ExecMode

ExecutionMode

ExecutionMode.PARALLEL

Execution mode of the command

M

Priority

PriorityLevel

PriorityLevel.NORMAL

Priority of the command

M

ProcessingMode

ProcessingMode

-

Processing mode

M

SequenceFlag

SequenceFlag

-

Defines the target sequence in which the command will be executed

M

Execute

BOOL

-

Start of the command at the rising edge

M

ParCmd

[StopSubprogramParCmd]

-

Command specific parameter

M
VAR_IN_OUT
Parameter Data Type Default Value Description Required

AxesGroup

AxesGroup

-

Robot group assigned to the function

M
VAR_OUTPUT
Parameter Data Type Default Value Description Required

CommandData

RobotLibraryCommandDataFB

-

For internal usage only

-

ResponseData

RobotLibraryResponseDataFB

-

For internal usage only

-

Error

BOOL

-

Error occurred during execution. See ErrorID for details

M

ErrorID

WORD

-

Error ID as raw value for error diagnosis

M

ErrorIDEnum

RobotLibraryErrorIdEnum

-

Error ID as enumeration for error diagnosis

M

ErrorAddTxt

STRING(MAX_ADD_TEXT_LENGTH)

-

Additional error text information

M

WarningID

WORD

-

Warning ID as raw value for identifying warnings

M

WarningIDEnum

RobotLibraryWarningIdEnum

-

Warning ID as enumeration for identifying warning

M

InfoID

WORD

-

Info ID for as raw value for identifying additional information

M

InfoIDEnum

RobotLibraryInfoIdEnum

-

Info ID for as enumeration for identifying additional information

M

Done

BOOL

-

Command executed successfully

M

Busy

BOOL

-

Function block is being processed

M

CommmandBuffered

BOOL

-

Command was transferred to the robot-controller and confirmed

M

CommandAborted

BOOL

-

The command was aborted by another command

M

CommandInterrupted

BOOL

-

TRUE, while command is interrupted during execution and can be continued.

M

OutCmd

[StopSubprogramOutCmd]

-

Command specific outputs

M

⚙️ FB_Structures:

StopSubprogramParCmd
Parameter Data Type Default Value Description Required

StopMode

StopMode

-

Defines how the subprogram is identified for stopping (e.g. via JobID or InstanceID)

TargetID

DINT

-

Identifier of the subprogram to stop, depending on StopMode
• -1: Invalid (default)

SequenceFlag

SequenceFlag

-

Defines the sequence behavior of the command execution

ListenerID

SINT

-

ID of trigger function:
• 0: No trigger (default)
• >0: Execute when matching EmitterID is triggered

EmitterID

ARRAY [0..3] OF SINT

-

ID of Action triggered when this command is active:
• >0: Start action
• <0: Stop action
• 0: No action (default)
StopSubprogramOutCmd
Parameter Data Type Default Value Description Required

OriginID

INT

-

Unique system-generated ID of the action that was stopped
Used to identify the instance of the subprogram

InvocationCounter

USINT

-

Number of successful trigger-based command invocations
Relevant when ListenerID > 0

⏳ Timing Diagram:

Work in progress – more content coming soon.

📋 Examples:

Declaration 
VAR_GLOBAL
  /// Robot assignment of function
  AxesGroup      : AxesGroup;
  /// Robot Task
  RobotTask      : MC_RobotTaskFB;
  /// StopSubProgram
  StopSubProgram : MC_StopSubProgramFB;
END_VAR
Call 
// Call functionblock
StopSubProgram
(
  Name           := 'SRCI_Robot',
  ExecMode       := ExecutionMode.PARALLEL,
  Priority       := PriorityLevel.NORMAL,
  ProcessingMode := ProcessingModeEnum.PARALLEL,
  SequenceFlag   := SequenceFlagEnum.NO_SEQUENCE,
  AxesGroup      := AxesGroup
);
Usage 
VAR_INPUT
  /// Start command execution
  Execute : BOOL;
  /// Command parameter
  ParCmd  : StopSubProgramParCmd;
END_VAR

VAR_OUTPUT
  /// Error ID
  ErrorID     : DINT;
  /// Error addition text
  ErrorAddTxt : STRING;
  /// Command outputs
  OutCmd      : StopSubProgramOutCmd;
END_VAR

VAR
  /// internal step counter
 _stepCmd    : DINT;
  /// internal timer for command
 _timerCmd   : TON;
  /// internal timeout for command
 _timeoutCmd : TIME := T#5S;
END_VAR
// forwarding command parameter(s)
StopSubProgram.ParCmd := ParCmd;
// forwarding command output(s)
OutCmd := StopSubProgram.OutCmd;

CASE _stepCmd OF

  0: // start execution ?
     IF ( Execute )
     THEN
       // Reset request
       Execute := FALSE;
       // set timeout
       SetTimeout(PT := _timeoutCmd, rTimer := _timerCmd);
       // inc step counter
      _stepCmd := _stepCmd + 1;
     END_IF

  1: // Start Execution
     IF (( NOT StopSubProgram.Busy  ) AND
         ( NOT StopSubProgram.Error ))
     THEN
       // start execution
       StopSubProgram.Execute := TRUE;
       // set timeout
       SetTimeout(PT := _timeoutCmd, rTimer := _timerCmd);
       // inc step counter
      _stepCmd := _stepCmd + 1;
     ELSE
       // timeout exceeded ?
       IF (CheckTimeout(_timerCmd) = RobotLibraryConstants.OK)
       THEN
         ErrorID     := RobotLibraryErrorIdEnum.ERR_TIMEOUT_CMD;
         ErrorAddTxt := CONCAT('_stepCmd = ' , DINT_TO_STRING(_stepCmd));
       END_IF

       // Error occurred ?
       IF (StopSubProgram.Error)
       THEN
         ErrorID     := StopSubProgram.ErrorID;
         ErrorAddTxt := CONCAT('_stepCmd = ' , DINT_TO_STRING(_stepCmd));
       END_IF
     END_IF

  2: // Wait Execution done ?
     IF (( NOT StopSubProgram.Busy ) AND
         (     StopSubProgram.Done ))
     THEN
       // stop execution
       StopSubProgram.Execute := FALSE;
       // set timeout
       SetTimeout(PT := _timeoutCmd, rTimer := _timerCmd);
       // set step counter
      _stepCmd := 0;
     ELSE
       // timeout exceeded ?
       IF (CheckTimeout(_timerCmd) = RobotLibraryConstants.OK)
       THEN
         ErrorID     := RobotLibraryErrorIdEnum.ERR_TIMEOUT_CMD;
         ErrorAddTxt := CONCAT('_stepCmd = ' , DINT_TO_STRING(_stepCmd));
       END_IF

       // Error occurred ?
       IF (StopSubProgram.Error)
       THEN
         ErrorID     := StopSubProgram.ErrorID;
         ErrorAddTxt := CONCAT('_stepCmd = ' , DINT_TO_STRING(_stepCmd));
       END_IF
     END_IF

ELSE
  // invalid step
  ErrorID     := RobotLibraryErrorIdEnum.ERR_INVALID_STEP;
  ErrorAddTxt := CONCAT('_stepCmd = ' , DINT_TO_STRING(_stepCmd));
END_CASE

💡 Additional Information:

Work in progress – more content coming soon.

This project is made with ❤️ for automation ⚙️ and robotics 🤖

⚠️ **GitHub.com Fallback** ⚠️