FB_CarriageHmi

HMI parallel class of FB_Carriage class.

Syntax:

FUNCTION_BLOCK FB_ClampHmi EXTENDS FB_PtpMotionHmi

Properties

Name	Type	Access	Initial value	Description
Name	STRING	Get, Set	<SourceName>	Specifies the name of the class instance.
FB_CarriageHmi
EnableDynamicScaler	BOOL	Get, Set	FALSE	Function for adapting the axis dynamics to the commanded target velocity.
EnableSmoothStart	BOOL	Get, Set	FALSE	Function for smooth start outside the end positions. Useful for operating a crank drive.
ManualForBack	I_ManualFunctionHmi	Get	<Local>	HMI for the implementation of a manual function.
SmoothStartFactor	LREAL	Get, Set	0.25	Factor that is applied to the maximum dynamics in the event of a smooth start. Notice The `Deceleration` is not affected by the smooth start.
SmoothStartThreshold	LREAL	Get, Set	10.0	Threshold value of the distance to the end position from which the smoth start becomes active.
FB_PtpMotionHmi
ActiveMove	INT	Get, Set	0	Index of the active cluster.
ActiveSegment	INT	Get, Set	0	Index of the active segment.
AxisMove	REFERENCE TO FB_AxisMoveHmi	Get	<Local>	Motion configuration object.
EnableRecipe	BOOL	Get, Set	FALSE	Enables recipe handling via I_Recipe.
FB_AxisHmi
EncoderZeroShift	LREAL	Get, (Set)	0.0	Zero offset shift of the axis.
LimitingReference	LREAL	Get	100.0 [%]	Reference value (maximum) for commanded limiting values (pressure or torque limit).
MaxAcceleration	LREAL	Get	0.0	Maximum acceleration of the axis.
MaxDeceleration	LREAL	Get	0.0	Maximum deceleration of the axis.
MaxJerk	LREAL	Get	0.0	Maximum jerk of the axis.
MaxPosition	LREAL	Get	0.0	Maximum position of the axis.
MaxVelocity	LREAL	Get	0.0	Maximum velocity of the axis.
MinPostion	LREAL	Get	0.0	Minimum position of the axis.
MinVelocity	LREAL	Get	0.0	Minimum velocity of the axis.
Referencing	I_ReferencingHmi	Get	<Local>	Parameter sets and commands for referencing the axis.
SetPosition	LREAL	Get, Set	0.0	Position used when calling FB_Axis.SetPosition().
UnitGroup	STRING(64)	Get, Set	‘Length‘	Physical quantity with which the axis is parameterized and operated.
FB_MotionHmi
ActPosition	LREAL	Get	0.0	Current position of the connected motion object
ActVelocity	LREAL	Get	0.0	Current velocity of the connected motion object
JogLimitingNegative	LREAL	Get, Set	0.0	Limitation of the jog command via the FB_Motion.JogNegative() method Ignored for operation with an actuator.
JogLimitingPositive	LREAL	Get, Set	0.0	Limitation of the jog command via the FB_Motion.JogPositive() method Ignored for operation with an actuator.
JogVelocityNegative	LREAL	Get, Set	0.0	Velocity of the jog command via the FB_Motion.JogNegative() method Ignored for operation with an actuator.
JogVelocityPositive	LREAL	Get, Set	0.0	Velocity of the jog command via the FB_Motion.JogNegative() method Ignored for operation with an actuator.
ManualPower	I_ManualFunctionHmi	Get, Set	<Local>	Interface for a manual function to switch on the motion object.
Specific	REFERENCE TO FB_MotionSpecificHmi	Get	<Local>	Access to the technology-specific functions
FB_Base
BaseState	E_BaseState	Get	eNotHandled	Initialization state of the class instance.
Error	BOOL	Get	FALSE	Class is in an error state.
ResultMessage	I_AppMessage	Get	-	Access to the class-internal EventLogger.
[`PROTECTED`] _Name	STRING	Get	<SourceName>	`.Name` without leading 'fb'.

Local HMI variables

Name	Data type	Description
fbParamHandle	FB_MdHandleHmi	Handling interface for loading and saving machine data.
FB_CarriageHmi
fbManualForBack	FB_ManualFunctionHmi	HMI for the implementation of a manual function.
fbParamCarriage	FB_MdCarriageHmi	Entries in the HMI parameter list under Trolley.
FB_PtpMotionHmi
aRecipe	ARRAY[] OF FB_MoveClusterRecipe	Structured recipe values for the motion configuration.
fbAxisMove	FB_AxisMoveHmi	Motion configuration object.
fbParamPtpMotion	FB_MdPtpMotionHmi	Entries in the HMI parameter list under Linear motion.
FB_AxisHmi
fbParamAxis	FB_MdAxisHmi	Entries in the HMI parameter list under Axis.
fbParamHoming	FB_MdHomingHmi	Entries in the HMI parameter list under Homing.
fbReferencing	FB_ReferencingHmi	Parameter sets and commands for referencing.
FB_MotionHmi
fbManualPower	FB_ManualFunctionHmi	Interface for a manual function to switch on the motion object.
fbSpecific	FB_MotionSpecificHmi	Technology-specific functions of the motion object.

Methods

Name	Description
Reset()	Resets the error state of the class.
FB_PtpMotionHmi
Moves(`x`)	Returns an interface to the x-th Move-Cluster.
FB_BaseHmi
Init(`ipBase`)	Default initialization method to pass the base class.
FB_Base
GetHMI()	Returns the assigned HMI object. Notice The method is not implemented in the `FB_Base` class. If the method is not overwritten by inheritance, a pseudo variable is always returned.
SetHMI(`ipBase`)	General assignment method for an `FB_BaseHmi` extending class as a local HMI. Notice The method is not implemented in the `FB_Base` class. If the method is not overridden by inheritance, it always fails.
[`PROTECTED`] _QueryNamespace()	Extracts the first part of the instance path as an object namespace.
[`PROTECTED`] _QueryObjectName()	Extracts the last part of the instance path as the object name.

	Exceptions avoidance The list access functions (e.g. Channels(x), Groups(x), etc...) return a pseudo variable if the requested index is invalid. In addition, a message is thrown in the EventLogger.

Interfaces

Type	Description
I_Base	Standard interface on FB_Base.
I_ClampHmi	Standard interface on FB_ClampHmi.
I_PtpMotionHmi	Standard interface on FB_PtpMotionHmi.
I_Recipe	Interface for managing structured recipe values.
I_AxisHmi	Standard interface on FB_AxisHmi.
I_MotionHmi	Standard interface on FB_MotionHmi.
I_BaseMdHmi	Standard interface on FB_BaseMdHmi.
I_BaseHmi	Standard interface on FB_BaseHmi.
I_BaseEmpty	For extension without standard interface.
I_BaseDev	Covers all methods and properties of the base class.

Prerequisites

Development environment	Target platform	PLC libraries to include
TwinCAT >= v3.1.4024.54 (recommended) TwinCAT >= v3.1.4024.42 (required)	PC or CX (x64, x86)	Tc3_PlasticBaseApplication (>= v12.10.2.0)