FunctionBlocks Read MC_ReadActualPositionFB - ThorstenBrach/SRCI GitHub Wiki

MC_ReadActualPositionFB

📝 Description:

Read the actual TCP and Joint position

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

Execute

BOOL

-

Start of the command at the rising edge

M

ParCmd

[ReadActualPositionParCmd]

-

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

OutCmd

[ReadActualPositionParCmd]

-

Command specific outputs

M

⚙️ FB Structures:

ReadActualPositionParCmd
Parameter Data Type Default Value Description Required

ToolNo

INT

-

Index of tool of returned position
• -1: Currently used tool on RC
• 0: Flange (default)
• 1..254: Tool frames

M

FrameNo

INT

-

Index of frame of returned position
• -1: Currently used frame on RC
• 0: WCS (default)
• 1..254: User frames

M

ListenerID

SINT

-

ID of associated trigger function
• 0: No Trigger (default) → No trigger-related behavior
• >0: Trigger → Start when trigger with matching EmitterID is activated.

M

ReadActualPositionOutCmd
Parameter Data Type Default Value Description Required

InvocationCounter

USINT

-

Relates to ListenerID > 0
Number of successful trigger-based command invocations

M

OriginID

INT

-

Unique system-generated ID of the "Action" when the function is triggered.
• >0: "Action" started by trigger function with identical FollowID
• <0: "Action" stopped by trigger function with identical FollowID

M

ToolNoReturn

INT

-

Index of tool of returned position
• -1: Currently used tool on RC
• 0: Flange (default)
• 1..254: Tool frames

M

FrameNoReturn

INT

-

Index of frame of returned position
• -1: Currently used frame on RC
• 0: WCS (default)
• 1..254: User frames

M

ActualCartesianPosition

RobotCartesianPosition

-

Absolute coordinates in the active coordinate system

M

ActualJointPosition

RobotJointPosition

-

Absolute position of the robot in Joint position

M

⏳ Timing Diagram:

Work in progress – more content coming soon.

📋 Examples:

Declaration
VAR_GLOBAL
  /// Robot assignment of function
  AxesGroup          : AxesGroup;
  /// Robot Task
  RobotTask          : MC_RobotTaskFB;
  /// Read actual position
  ReadActualPosition : MC_ReadActualPositionFB;
END_VAR
Call
// Call functionblock
ReadActualPosition
(
  Name           := 'SRCI_Robot',
  ExecMode       := ExecutionMode.PARALLEL,
  ProcessingMode := ProcessingMode.PARALLEL,
  SequenceFlag   := SequenceFlag.NO_SEQUENCE,
  Priority       := PriorityLevel.NORMAL,
  AxesGroup      := AxesGroup
);
Usage
VAR_INPUT
  /// Start command execution
  Execute : BOOL;
  /// Command parameter
  ParCmd  : ReadActualPositionParCmd;
END_VAR

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

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

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