FunctionBlocks Calculation MC_CalculateFrameFB - ThorstenBrach/SRCI GitHub Wiki

MC_CalculateFrameFB

📝 Description:

Calculate frame with three-point method.

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

AxesGroup

AxesGroup

-

Robot group assigned to the function

M

Execute

BOOL

-

Start of the command at the rising edge

M

ParCmd

[CalculateFrameParCmd]

-

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

FALSE

Error occurred during execution. See ErrorID for details

M

ErrorID

WORD

0

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

OutCmd

[CalculateFrameOutCmd]

-

Command specific outputs

M

⚙️ FB Structures:

CalculateFrameParCmd
Parameter Data Type Default Value Description Required

Mode

FrameCalculationMode

-

Method used to calculate the tool or user frame

FrameNo

USINT

Index of the frame to be calculated
• 0: WCS (default)
• 1..254: User frames

Position_X

RobotCartesianPosition

-

Cartesian position in the direction of the X-axis of the calculated frame
Relative to the reference frame

Position_XY

RobotCartesianPosition

-

Cartesian position in the XY-plane of the calculated frame
Relative to the reference frame

Origin

RobotCartesianPosition

-

Cartesian origin of the calculated frame
Relative to the reference frame

OriginShift

RobotCartesianPosition

-

Shifted position for origin if the real origin is not reachable by the robot
Used as auxiliary reference

ReferenceFrame

USINT

-

Index of the reference frame on which the calculated frame is based
• 0: WCS (default)
• 1..254: User frames
CalculateFrameOutCmd
Parameter Data Type Default Value Description Required

IEC_Date

IEC_DATE

-

Date when the frame was calculated
Standard IEC date format

IEC_Time

IEC_TIME

-

Time when the frame was calculated
Standard IEC time format

ReferenceFrame

USINT

-

Index of the base frame used for calculation
• 0: WCS (default)
• 1..254: User frames

Position

RobotCartesianPositionBase

-

Calculated frame position relative to the reference frame

⏳ Timing Diagram:

Work in progress – more content coming soon.

📋 Examples:

Declaration 
VAR_GLOBAL
  /// Robot assignment of function
  AxesGroup      : AxesGroup;
  /// Robot Task
  RobotTask      : MC_RobotTaskFB;
  /// Calculate frame
  CalculateFrame : MC_CalculateFrameFB;
END_VAR
Call 
// call function block
CalculateFrame
(
  Name      := 'SRCI_Robot',
  ExecMode  := ExecutionMode.PARALLEL,
  Priority  := PriorityLevel.NORMAL,
  AxesGroup := AxesGroup
);
Usage 
VAR_INPUT
  /// Start command execution
  Execute : BOOL;
  /// Command parameter
  ParCmd  : CalculateFrameParCmd;
END_VAR

VAR_OUTPUT
  /// Error ID
  ErrorID     : DINT;
  /// Error addition text
  ErrorAddTxt : STRING;
  /// Command outputs
  OutCmd      : CalculateFrameOutCmd;
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)
CalculateFrame.ParCmd := ParCmd;
// forwarding command output(s)
OutCmd := CalculateFrame.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 CalculateFrame.Busy  ) AND
         ( NOT CalculateFrame.Error ))
     THEN
       // start execution
       CalculateFrame.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 (CalculateFrame.Error)
       THEN
         ErrorID     := CalculateFrame.ErrorID;
         ErrorAddTxt := CONCAT('_stepCmd = ' , DINT_TO_STRING(_stepCmd));
       END_IF
     END_IF

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