FunctionBlocks Write MC_WriteFrameDataFB - ThorstenBrach/SRCI GitHub Wiki

MC_WriteFrameDataFB

📝 Description:

Change configuration of selected user frame number.

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

[WriteFrameDataParCmd]

-

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

[WriteFrameDataOutCmd]

-

Command specific outputs

M

⚙️ FB_Structures:

WriteFrameDataParCmd
Parameter Data Type Default Value Description Required

FrameNo

USINT

-

Frame index
• 0: WCS (default) O
• 1..254: UCS (User frames)

M

FrameData

FrameData

-

Frame data

M
WriteFrameDataOutCmd
Parameter Data Type Default Value Description Required

OriginID

INT

-

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

M

InvocationCounter

USINT

-

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

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;
  /// Write frame data
  WriteFrameData : MC_WriteFrameDataFB;
END_VAR
Call 
// call function block
WriteFrameData
(
  Name         := 'SRCI_Robot',
  ExecMode     := ExecutionMode.PARALLEL,
  SequenceFlag := SequenceFlag.PRIMARY_SEQUENCE,
  Priority     := PriorityLevel.VERY_HIGH,
  AxesGroup    := AxesGroup
);
Usage 
VAR_INPUT
  /// Start command execution
  Execute : BOOL;
  /// Command parameter
  ParCmd  : WriteFrameDataParCmd;
END_VAR

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

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