FB_ReferencingHmi

HMI class parallel to the referencing class of an axis.

Syntax:

FUNCTION_BLOCK FB_ReferencingHmi EXTENDS FB_BaseHmi

Properties

Name	Type	Access	Initial value	Description
Name	STRING	Get, Set	<SourceName>	Specifies the name of the class instance.
FB_ReferencingHmi
Busy	BOOL	Get, (Set)	FALSE	The axis is referencing and/or is in the active referencing state.
DetectionVeloTimeMax	LREAL	Get, Set	10.0 [s]	Maximum adjustable duration of the detection velocity
DistanceMax	LREAL	Get, Set	800.0	Maximum adjustable distance
DoHomingAbort	BOOL	Get, Set	FALSE	Aborts the current homing process.
DoHomingAbsSwitch	BOOL	Get, Set	FALSE	Starting homing to an absolute switch
DoHomingAbsSwitchDetect	BOOL	Get, Set	FALSE	Start calibration of the absolute switch position.
DoHomingAbsSwitchDetect	BOOL	Get, Set	FALSE	Start a sequence from `AbsSwitch` and `Finish`.
DoHomingBlock	BOOL	Get, Set	FALSE	Start homing to an end stop.
DoHomingBlockDetect	BOOL	Get, Set	FALSE	Start the calibration of an end stop position.
DoHomingBlockSequence	BOOL	Get, Set	FALSE	Start a sequence from `Block`, `BlockDetect` and `Finish`.
DoHomingFinish	BOOL	Get, Set	FALSE	Complete the homing process.
DoHomingLimitSwitch	BOOL	Get, Set	FALSE	Start homing to an end position sensor.
DoHomingLimitSwitchDetect	BOOL	Get, Set	FALSE	Start the calibration of an end position sensor.
DoHomingLimitSwitchSequence	BOOL	Get, Set	FALSE	Start a sequence from `LimitSwitch`, `LimitSwitchDetect` and `Finish`.
DoSetZero	BOOL	Get, Set	FALSE	Sets the current axis position to `0`.
Enable	BOOL	Get, (Set)	FALSE	The homing of the axis is enabled by the PLC.
EnableAutoSave	BOOL	Get, Set	FALSE	Once a homing process has been successfully completed, the axis parameters should be saved in the machine data.
HomingAbsSwitch	I_HomingSwitchHmi	Get	<Local>	Parameter set for homing via absolute switch.
HomingAbsSwitchDetect	I_HomingSwitchDetectHmi	Get	<Local>	Parameter set for calibrating an absolute switch.
HomingBlock	I_HomingBlockHmi	Get	<Local>	Parameter set for homing via end stop.
HomingBlockDetect	I_HomingBlockDetectHmi	Get	<Local>	Parameter set for calibrating an end stop position.
HomingFinish	I_HomingFinishHmi	Get	<Local>	Parameter set for finishing a homing process.
HomingLimitSwitch	I_HomingSwitchHmi	Get	<Local>	Parameter set for homing via end position sensor.
HomingLimitSwitchDetect	I_HomingSwitchDetectHmi	Get	<Local>	Parameter set for calibrating an end position sensor.
IsHomed	BOOL	Get, Set	FALSE	The last completed homing process was successful.
PositionMax	LREAL	Get, Set	500.0	Maximum adjustable position.
PositionMin	LREAL	Get, Set	0.0	Minimum adjustable position.
TimeLimitMax	LREAL	Get, Set	30.0	Maximum adjustable time limit.

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
fbHomingBlock	FB_HomingBlockHmi	Parameter set for homing via end stop.
fbHomingBlockDetect	FB_HomingBlockDetectHmi	Parameter set for calibrating an end stop position.
fbHomingAbsSwitch	FB_HomingSwitchHmi	Parameter set for homing via absolute switch.
fbHomingAbsSwitchDetect	FB_HomingSwitchDetectHmi	Parameter set for calibrating an absolute switch.
fbHomingLimitSwitch	FB_HomingSwitchHmi	Parameter set for homing via end position sensor.
fbHomingLimitSwitchDetect	FB_HomingSwitchDetectHmi	Parameter set for calibrating an end position sensor.
fbHomingFinish	FB_HomingFinishHmi	Parameter set for finishing a homing process.

Methods

Name	Description
Reset()	Resets the error state of the class.
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.

Interfaces

Type	Description
I_Base	Standard interface on FB_Base.
I_ReferencingHmi	Standard interface on FB_ReferencingHmi.
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)

Further Information