FunctionBlocks General MC_EnableRobotFB - ThorstenBrach/SRCI GitHub Wiki

MC_EnableRobotFB

📝 Description:

Enable/Disable robot into RA power state "Enabled".

⚙️ 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

PriorityMode.NORMAL

Priority of the command

M

Enable

BOOL

-

Enable / Disable the command at rising / falling edge

M

ParCmd

[EnableRobotParCmd]

-

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

Busy

BOOL

-

Function block is being processed

M

Enabled

BOOL

-

Command enabled successfully

M

CommmandBuffered

BOOL

-

Command was transferred to the robot-controller and confirmed

M

CommmandAccepted

BOOL

-

Receiving of input parameter values has been acknowledged by RC

M

⚙️ FB Structures:

EnableRobotParCmd
Parameter Data Type Default Value Description Required

HoldToRun

BOOL

-

The robot will move while HoldToRun is set TRUE

M

StepMode

StepMode

-

While activated the RI state switches to interrupted when a buffered command returns Done TRUE - at least one of the optional modes must be supported.

M

ManualStep

BOOL

-

Relates to StepMode 1 (Blending) and 2 (Exact stop) - Start the next buffered command with the rising edge in T1 External or T2 External

O

⏳ Timing Diagram:

Work in progress – more content coming soon.

📋 Examples:

Declaration 
VAR_GLOBAL
  /// Robot assignment of function
  AxesGroup   : AxesGroup;
  /// Robot Task
  RobotTask   : MC_RobotTaskFB;
  /// Enable Robot
  EnableRobot : MC_EnableRobotFB;
END_VAR
Parameterization 
EnableRobot.ParCmd.ManualStep := FALSE;
EnableRobot.ParCmd.StepMode   := StepMode.DEACTIVATE;
Call 
// call function block
EnableRobot
(
  Name      := 'SRCI_Robot',
  ExecMode  := ExecutionMode.PARALLEL,
  Priority  := PriorityLevel.NORMAL,
  AxesGroup := AxesGroup,
);
Usage 
VAR_INPUT
  /// Enable command
  Enable : BOOL;
  /// Command parameter
  ParCmd : EnableRobotParCmd;
END_VAR

VAR_OUTPUT
  /// Error ID
  ErrorID     : DINT;
  /// Error addition text
  ErrorAddTxt : STRING;
  /// Command outputs
  OutCmd      : EnableRobotOutCmd;
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) / command outputs
EnableRobot.ParCmd := ParCmd;
// forwarding command output(s)
OutCmd := EnableRobot.OutCmd;

CASE _stepCmd OF

  0: // Enable or disable function ?
     IF (( Enable           ) XOR
         ( UserData.Enabled ))
     THEN
       // set timeout
       SetTimeout(PT := _timeoutCmd, rTimer := _timerCmd);
       // inc step counter
      _stepCmd := _stepCmd + 1;
     END_IF

  1: // Start Execution
     IF (( NOT EnableRobot.Busy  ) AND
         ( NOT EnableRobot.Error ))
     THEN
       // enable/disable robot
       EnableRobot.Enable := Enable;
       // 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 (EnableRobot.Error)
       THEN
         ErrorID     := EnableRobot.ErrorID;
         ErrorAddTxt := CONCAT('_stepCmd = ' , DINT_TO_STRING(_stepCmd));
       END_IF
     END_IF


  2: // Wait Execution done ?
     IF (( NOT EnableRobot.Busy                    ) AND
         (     EnableRobot.Enabled = Enable ))
     THEN
       // 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 (EnableRobot.Error)
       THEN
         ErrorID     := EnableRobot.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** ⚠️