Structures UserData - ThorstenBrach/SRCI GitHub Wiki

UserData

Parameter Data Type Default Value Description

EnableSync

DataEnableSync

-

state of the synchronizationrelated comparison mechanism

ActivateTwoSequences

BOOL

-

Set TRUE to define two sequences in one Telegram.

SynchronizationModes

SynchronizationModes

-

Synchronisation modes

DelayTime

UINT

-

Defines waiting time [ms] between receiving first move command and starting movement.

WaitForNrOfCmd

UINT

-

Define number of points required to calculate the blending.

WaitAtBlendingZone

BOOL

-

Defines blending behavior for single move commands
- 0 (default): Move to end position: Robot moves exactly to target position
- 1: Wait at blending parameter: Robot stops when blending parameter is reached

AllowSecSeqWhileSubprogram

BOOL

-

Allow a sequence switch from primary to secondary while a subprogram called via CallSubprogram

AllowDynamicBlending

BOOL

-

Allows blending when CallSubprogram is used and removed
- 0 (default): Dynamic blending is prevented
- 1: Dynamic blending is allowed

LifeSignTimeOut

TIME

-

Maximum allowed time [ms] between LifeSign increments
- <10 ms: Invalid
- 50 ms: default

SyncReaction

USINT

-

System reaction when inconsistency of sync data is detected

SyncDelay

UINT

-

Delay [ms] between detecting config inconsistency and applying SyncReaction

LogLevel

LogLevel

-

Severity level of messages stored in RC log

MessageLevel

MessageLevel

-

Severity level of messages sent to PLC message buffer

PLCLibraryVersion

VersionStruct

-

Version of client implementation in format (X.X.X)

RCManufacturer

STRING(20)

-

RC manufacturer name

RCOrderID

STRING(20)

-

RC part number

RCSerialNumber

STRING(16)

-

RC serial number

RASerialNumber

STRING(16)

-

RA serial number

RCFirmwareVersion

STRING(12)

-

Robot firmware version in manufacturer-specific format

RCInterpreterVersion

VersionStruct

-

Version of server implementation in format (X.X.X)

RCSRCIVersion

VersionStruct

-

Version of SRCI specification on which server implementation is based in format (X.X.X)

AxisJointUsed

AxisJointUsed

-

TRUE = Axis used in Robot, FALSE = Axis NOT used.

AxisExternalUsed

AxisExternalUsed

-

TRUE = Axis used by Robot, FALSE = Axis NOT used.

AxisJointUnit

AxisJointUnit

-

TRUE = mm, FALSE = °.

AxisExternalUnit

AxisExternalUnit

-

TRUE = mm, FALSE = °.

Initialized

BOOL

-

Interface is initialized and ready to process commands.

Synchronized

BOOL

-

All synchronization-related configuration data between client and server is synchronized.

ToolDataSynchronizing

BOOL

-

ToolData synchronization is activated.

FrameDataSynchronizing

BOOL

-

FrameData synchronization is activated.

LoadDataSynchronizing

BOOL

-

LoadData synchronization is activated.

WorkAreaDataSynchronizing

BOOL

-

WorkAreaData synchronization is activated.

SWLimitsSynchronizing

BOOL

-

SWLimits synchronization is activated.

DefaultDynamicsSynchronizing

BOOL

-

DefaultDynamics synchronization is activated.

ReferenceDynamicsSynchronizing

BOOL

-

ReferenceDynamics synchronization is activated.

IsMoving

BOOL

-

TRUE, when robot’s axes values change due to physical movement of axes. Can only be TRUE in sequence state "Executing".

PrimarySequencePaused

BOOL

-

TRUE, when move commands buffered by the primary sequence are currently not processed.

InPrimaryPos

BOOL

-

TRUE, when robot is moving in the primary sequence. FALSE, when it moves otherwise.

SecondarySequenceActive

BOOL

-

TRUE, when secondary sequence is active.

ErrorPending

BOOL

-

Shows that an error acknowledgement by the client is necessary.

RestartInProgress

BOOL

-

TRUE, when RC is restarting.

BrakeTestRequired

BOOL

-

Signals that a brake test is required in the defined monitoring time

Enabled

BOOL

-

RA power state.

Idle

BOOL

-

TRUE, while RA sequence state returns Idle.

Executing

BOOL

-

TRUE, while RA sequence state returns Executing.

Interrupted

BOOL

-

TRUE, while RA sequence state returns Interrupted.

IsBlending

BOOL

-

TRUE, when robot is blending between move commands (only in Executing).

OperationMode

OperationMode

-

Operation Mode

PathAccuracyMode

BOOL

-

PathAccuracyMode is active

AvoidSingularity

BOOL

-

AvoidSingularity is active

CollisionDetectionEnabled

BOOL

-

TRUE, while CollisionDetection is enabled

CollisionDetected

BOOL

-

TRUE, when collision was detected while CollisionDetection was active

RestartRequested

BOOL

-

TRUE, when RC requests restart due to specific function calls (e.g., WriteRobotSWLimits)

ActualOverride

REAL

-

Actual override

StepModeExactStopActive

BOOL

-

StepMode is active and set to ExactStop

StepModeBlendingActive

BOOL

-

StepMode is active and set to Blending

AcceleratingSupported

BOOL

-

Accelerating status bit is supported

Accelerating

BOOL

-

TRUE, when robot is currently accelerating

DeceleratingSupported

BOOL

-

Decelerating status bit is supported

Decelerating

BOOL

-

TRUE, when robot is currently decelerating

ConstantVelocitySupported

BOOL

-

ConstantVelocity status bit is supported

ConstantVelocity

BOOL

-

TRUE, while the robot velocity is constant

ReadingCartesianPosition

BOOL

-

TRUE, while the CartesianPosition is returned cyclically

ReadingExtCartesianPosition

BOOL

-

TRUE, while the ExtCartesianPosition is returned cyclically

ReadingJointPosition

BOOL

-

TRUE, while the JointPosition is returned cyclically

ReadingExtJointPosition

BOOL

-

TRUE, while the ExtJointPosition is returned cyclically

CartesianPosition

RobotCartesianPositionShort

-

Cyclically returned, absolute coordinates of current position in selected coordinate systems (see input parameters ToolNo and FrameNo of function ReadActualPositionCyclic 6.1.6)

ExtCartesianPosition

RobotCartesianPositionExt

-

Cyclically returned, absolute cartesian position of the external axes of the robot in selected coordinate systems (see input parameters ToolNo and FrameNo of function ReadActualPositionCyclic 6.1.6)

JointPosition

RobotJointPositionShort

-

Cyclically returned, absolute position of the robot in Joint position

ExtJointPosition

RobotJointPositionExt

-

Cyclically returned, absolute joint position of the external axes of the robot

RCSupportedFunctions

RCSupportedFunctions

-

TRUE: Function is supported by RC, FALSE: Function is not supported by RC

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