FB_PlcStateToHmi

FB_PlcStateToHmi 1:

Implements the handshake procedure for the TF8550 recipe management on the PLC side.

Syntax:

FUNCTION_BLOCK FB_PlcStateToHmi EXTENDS FB_HandshakeHmi

FB_PlcStateToHmi 2: Handshake signal properties

Name

Type

Access

Initial value

Description

PLC / HMI1

Reset

BOOL

Get, Set

FALSE

Request to reinitialize the communication.

HMI

FB_PlcStateToHmi

AxesInitialised

BOOL

Get, Set

FALSE

Axes have been initialized, the recipe may be initialized.

PLC

ClientID

UINT

Get, Set

0

Alias to CompanionID.

HMI

DataReqFailed

BOOL

Get, Set

FALSE

Errors in communication. The PLC is waiting for a reset.

PLC

DataRequestPlc

BOOL

Get, Set

FALSE

Requesting data during the start-up phase or a product change.

PLC

DataRequestPlcActiveHmi

BOOL

Get, Set

FALSE

Writing recipe data to the PLC active.

HMI

DataRequestPlcQuitHmi

BOOL

Get, Set

FALSE

Writing of recipe data to the PLC completed.

HMI

DataValidPlc

BOOL

Get, Set

FALSE

The recipe data has been loaded completely.

PLC

PlcInitialized

BOOL

Get, Set

FALSE

Alias to AxesInitialized.

PLC

ProductChangeConfirmPlc

BOOL

Get, Set

FALSE

The request to change the product is accepted.

PLC

ProductChangeEnable

BOOL

Get, Set

FALSE

Signals the possibility to change the recipe to the HMI.

PLC

ProductRequestHmi

BOOL

Get, Set

FALSE

Requests of a product change.

HMI

SaveDataQuitPlc

BOOL

Get, Set

FALSE

Confirms the processing of a recipe storage.

HMI

SaveDataRequestPlc

BOOL

Get, Set

FALSE

Request to save the recipe.

PLC

FB_HandshakeHmi

CompanionID

UINT

Get, Set

0

ID of the currently connected HMI Companion.

HMI

LiveSignHMI

UINT

Get, Set

0

Changing value of the HMI client to signal an active connection.

HMI

1The PLC/HMI column describes the assignment of the write access.

FB_PlcStateToHmi 3: Properties

Name

Type

Access

Initial value

Description

Name

STRING

Get, Set

<SourceName>

Specifies the name of the class instance.

FB_PlcStateToHmi

VersionBaseApplication

STRING

Get

'v0.0.0.0'

Plastic Base Application version.

VersionTF8540

STRING

Get

'v0.0.0.0'

Version of the Temperature Control (TF8540, Plastic Processing Framework)

VersionTF8560

STRING

Get

'v0.0.0.0'

Plastic Technology Functions version (TF8560).

VersionPlasticFunctions1

STRING

Get

'v0.0.0.0'

Plastic Technology Functions version (TF8560).

FB_HandshakeHmi

CompanionTimeout

LREAL

Get, Set

5.0

Time after which the Companion is considered disconnected (no longer connected) if there is no sign of life.

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'.

1Obsolete

FB_PlcStateToHmi 4: Methods

Name

Description

Reset()

Resets the error state of the class.

FB_PlcStateToHmi

DeclareBeta()1

Adds a beta label to the display version of the Plastic Base Application.

FB_HandshakeHmi

Cyclic()

Cycle method

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.

1Is obsolete

FB_PlcStateToHmi 5: Interfaces

Type

Description

I_Base

Standard interface on FB_Base.

I_RecipeState

Interface for the handshake variables to be processed in the main procedure.

I_HandshakeHmi

Standard interface on FB_HandshakeHmi

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)