FunctionBlocks Read MC_ReadIntegersFB - ThorstenBrach/SRCI GitHub Wiki

MC_ReadIntegersFB

📝 Description:

Read integer values on RC.

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

Execution mode of the command

M

Priority

PriorityLevel

PriorityLevel.NORMAL

Priority of the command

M

ProcessingMode

ProcessingMode

-

ProcessingMode

M

SequenceFlag

SequenceFlag

-

Defines the target sequence in which the command will be executed For more information about the differentiation of sequences

M

Execute

BOOL

-

Start of the command at the rising edge

M

ParCmd

[ReadIntegersParCmd]

-

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

Valid

BOOL

-

TRUE, while the following outputs return valid values:
• Values

M

CommandAborted

BOOL

-

The command was aborted by another command

M

CommmandBuffered

BOOL

-

Command was transferred to the robot-controller and confirmed

M

CommandInterrupted

BOOL

-

TRUE, while command is interrupted during execution and can be continued

M

ParameterAccepted

BOOL

-

Receiving of input parameter values has been acknowledged by RC

M

OutCmd

[ReadIntegersOutCmd]

-

Command specific outputs

M

⚙️ FB Structures:

ReadIntegersParCmd
Parameter Data Type Default Value Description Required

Index

ARRAY[0..6] OF USINT

-

Specifies the desired target values that shall be read

ListenerID

SINT

0

ID of associated trigger function.
• 0: No Trigger (default) → No trigger related behavior
• >0: Trigger → Start executing when the trigger function with the identical EmitterID is triggered.
Always positive.
ReadIntegersOutCmd
Parameter Data Type Default Value Description Required

Values

ARRAY[0..6] OF INT

-

Returned values of integer register

OriginID

INT

-

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

InvocationCounter

USINT

-

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

⏳ 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 integers
  ReadIntegers : MC_ReadIntegersFB;
END_VAR
Call 
// Call functionblock
ReadIntegers
(
  Name           := 'SRCI_Robot',
  ExecMode       := ExecutionMode.PARALLEL,
  Priority       := PriorityLevel.NORMAL,
  ProcessingMode := ProcessingMode.PARALLEL,
  SequenceFlag   := SequenceFlag.NO_SEQUENCE,
  AxesGroup      := AxesGroup
);
Usage 
VAR_INPUT
  /// Start command execution
  Execute : BOOL;
  /// Command parameter
  ParCmd  : ReadIntegersParCmd;
END_VAR

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

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