FunctionBlocks Additional MC_BrakeTestFB - ThorstenBrach/SRCI GitHub Wiki

MC_BrakeTestFB

📝 Description:

Activate robot cycle brake test and give feedback to PLC.

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

AbortingMode.BUFFER

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

M

SequenceFlag

SequenceFlag

SequenceFlag.PRIMARY_SEQUENCE

Defines the target sequence in which the command will be executed

M

Execute

BOOL

-

Start of the command at the rising edge

M

ParCmd

[BrakeTestParCmd]

-

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

Active

BOOL

-

During the realization of the brake test, the command controls the motion of the respective axis group.
TRUE: The brake test is being realized
FALSE: The brake test is not realized

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

[BrakeTestOutCmd]

-

Command specific outputs

M

⚙️ FB Structures:

BrakeTestParCmd
Parameter Data Type Default Value Description Required

RobotAxesActive

RobotAxesFlags

TRUE

Defines which robot axes are activated for the brake test.
• TRUE (default): Axis activated
• FALSE: Axis deactivated

ExternalAxesActive

ExternalAxesFlags

FALSE

Defines which external robot axes are activated for the brake test.
• TRUE: Axis activated
• FALSE (default): Axis deactivated
BrakeTestOutCmd
Parameter Data Type Default Value Description Required

RobotAxesStatus

RobotAxesFlags

-

Result of the brake test for robot axes.
• TRUE: Test successful
• FALSE: Test failed

ExternalAxesStatus

ExternalAxesFlags

-

Result of the brake test for external axes.
• TRUE: Test successful
• FALSE: Test failed

RobotAxesWarning

RobotAxesFlags

-

Warning status for robot axes brakes.
• TRUE: One or more warnings available
• FALSE: No warning

ExternalAxesWarning

ExternalAxesFlags

-

Warning status for external axes brakes.
• TRUE: One or more warnings available
• FALSE: No warning

⏳ Timing Diagram:

Work in progress – more content coming soon.

📋 Examples:

Declaration 
VAR_GLOBAL
  /// Robot assignment of function
  AxesGroup : AxesGroup;
  /// Robot Task
  RobotTask : MC_RobotTaskFB;
  /// Brake test
  BrakeTest : MC_BrakeTestFB;
END_VAR
Call 
// Call functionblock
BrakeTest
(
  Name         := 'SRCI_Robot',
  ExecMode     := ExecutionMode.SEQUENCE_PRIMARY,
  Priority     := PriorityLevel.NORMAL,
  SequenceFlag := SequenceFlagEnum.PRIMARY_SEQUENCE,
  AxesGroup    := AxesGroup
);
Usage 
VAR_INPUT
  /// Start command execution
  Execute : BOOL;
  /// Command parameter
  ParCmd  : BrakeTestParCmd;
END_VAR

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

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