FunctionBlocks Additional MC_SoftSwitchTcpFB - ThorstenBrach/SRCI GitHub Wiki

MC_SoftSwitchTcpFB

📝 Description:

Push robot: Robot calculates opposite vector and moves slowly in that direction.

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

Execution mode of the command

M

Priority

PriorityLevel

PriorityLevel.NORMAL

Priority of the command

M

AbortingMode

AbortingMode

-

Parameter which determines the behavior towards the previously sent and still active or buffered commands

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

[SoftSwitchTcpParCmd]

-

Command specific parameter

M

VAR_INPUT
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

Active

BOOL

-

The command "SoftSwitchTCP" takes control of the according axis group

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

[SoftSwitchTcpOutCmd]

-

Command specific outputs

M

⚙️ FB Structures:

SoftSwitchTcpParCmd
Parameter Data Type Default Value Description Required

ReferenceType

ReferenceType

-

Defines the reference coordinate system for compliant movement

ReferenceNo

USINT

-

Index of tool or frame according to ReferenceType
• 0: Flange/WCS (default)
• 1..254: Tool/User frame

CompliantAxes

BYTE

-

Enables compliant movement for selected Cartesian axes
See Table 6-744 for bit assignment

LimitMode

LimitMode

-

Defines which parameters limit the compliant space
At least one mode must be supported

ResistanceForceMode

ResistanceForceMode

-

Type of resistance force applied during compliant movement

ResistanceForceTCP

REAL

100

Overall resistance level if ResistanceForceMode = ResistanceForceTCP
Range: 0–200

ResistanceForceAxis

ARRAY[0..5] OF REAL

100

Axis-specific resistance level if ResistanceForceMode = ResistanceForceAxis
Range per axis: 0–200

VectorData

ARRAY[0..5] OF REAL

-

Limit values (min/max) for Cartesian axes
Relevant if LimitMode = Limit defined

SoftSwitchTcpOutCmd
Parameter Data Type Default Value Description Required

SoftMovement

BOOL

-

TRUE if the robot arm is currently in compliant (soft) movement mode

⏳ Timing Diagram:

Work in progress – more content coming soon.

📋 Examples:

Declaration
VAR_GLOBAL
  /// Robot assignment of function
  AxesGroup     : AxesGroup;
  /// Robot Task
  RobotTask     : MC_RobotTaskFB;
  /// Soft switch Tcp
  SoftSwitchTcp : MC_SoftSwitchTcpFB;
END_VAR
Call
// Call functionblock
SoftSwitchTcp
(
  Name         := 'SRCI_Robot',
  ExecMode     := ExecutionMode.SEQUENCE_PRIMARY,
  Priority     := PriorityLevel.NORMAL,
  AbortingMode := AbortingModeEnum.BUFFER,
  SequenceFlag := SequenceFlagEnum.PRIMARY_SEQUENCE,
  AxesGroup    := AxesGroup
);
Usage
VAR_INPUT
  /// Start command execution
  Execute : BOOL;
  /// Command parameter
  ParCmd  : SoftSwitchTcpParCmd;
END_VAR

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

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