PLC Lib: Tc3 - Packml - V2: Manual

Manual
PLC Lib: Tc3_PackML_V2
TwinCAT 3
Version: 1.1
Date: 2017-02-01
Table of contents
Table of contents
1 Foreword .................................................................................................................................................... 4
1.1 Notes on the documentation........................................................................................................... 4
1.2 Safety instructions .......................................................................................................................... 5
2 Packaging Machine State ......................................................................................................................... 6

2.1 Interfaces ........................................................................................................................................ 6
2.1.1 ITF_UnitState ..................................................................................................................... 6
2.2 Data types....................................................................................................................................... 7
2.2.1 E_PMLCommand............................................................................................................... 7
2.2.2 E_PMLState ....................................................................................................................... 8
2.2.3 E_PMLProtectedUnitMode ................................................................................................ 8
2.2.4 ST_PMLSubUnitInfoRef..................................................................................................... 9
2.2.5 ST_PMLSubUnitInfo .......................................................................................................... 9
2.2.6 ST_PMLStateMachineOptions......................................................................................... 10
2.3 Function Blocks ............................................................................................................................ 10
2.3.1 PML_StateMachine.......................................................................................................... 10
2.3.2 PML_UnitModeConfig ...................................................................................................... 14
2.3.3 PML_UnitModeManager .................................................................................................. 16
3 Packaging Machine Tags ....................................................................................................................... 19

3.1 Introduction ................................................................................................................................... 19
3.2 Tag Types..................................................................................................................................... 19
3.3 Tag Details.................................................................................................................................... 20
3.4 Data types..................................................................................................................................... 24
3.4.1 Alarm................................................................................................................................ 24
3.4.2 Common........................................................................................................................... 25
3.4.3 ST_PMLa ......................................................................................................................... 26
3.4.4 ST_PMLc ......................................................................................................................... 27
3.4.5 ST_PMLs ......................................................................................................................... 27
3.5 Global parameters ........................................................................................................................ 28
3.6 Global Constants .......................................................................................................................... 28
4 Appendix .................................................................................................................................................. 29
4.1 Example Tc3_PackML_V2 ........................................................................................................... 29
PLC Lib: Tc3_PackML_V2 Version: 1.1 3

Foreword
1 Foreword
1.1 Notes on the documentation

This description is only intended for the use of trained specialists in control and automation engineering who
are familiar with the applicable national standards.
It is essential that the documentation and the following notes and explanations are followed when installing
and commissioning the components.
It is the duty of the technical personnel to use the documentation published at the respective time of each
installation and commissioning.
The responsible staff must ensure that the application or use of the products described satisfy all the
requirements for safety, including all the relevant laws, regulations, guidelines and standards.
Disclaimer
The documentation has been prepared with care. The products described are, however, constantly under
development.
We reserve the right to revise and change the documentation at any time and without prior announcement.
No claims for the modification of products that have already been supplied may be made on the basis of the
data, diagrams and descriptions in this documentation.
Trademarks
Beckhoff®, TwinCAT®, EtherCAT®, Safety over EtherCAT®, TwinSAFE®, XFC® and XTS® are registered
trademarks of and licensed by Beckhoff Automation GmbH.
Other designations used in this publication may be trademarks whose use by third parties for their own
purposes could violate the rights of the owners.
Patent Pending
The EtherCAT Technology is covered, including but not limited to the following patent applications and
patents:
EP1590927, EP1789857, DE102004044764, DE102007017835
with corresponding applications or registrations in various other countries.
The TwinCAT Technology is covered, including but not limited to the following patent applications and
patents:
EP0851348, US6167425 with corresponding applications or registrations in various other countries.
EtherCAT® is registered trademark and patented technology, licensed by Beckhoff Automation GmbH,
Germany
Copyright
© Beckhoff Automation GmbH & Co. KG, Germany.

The reproduction, distribution and utilization of this document as well as the communication of its contents to
others without express authorization are prohibited.
Offenders will be held liable for the payment of damages. All rights reserved in the event of the grant of a
patent, utility model or design.
4 Version: 1.1 PLC Lib: Tc3_PackML_V2

Foreword
1.2 Safety instructions

Safety regulations
Please note the following safety instructions and explanations!

Product-specific safety instructions can be found on following pages or in the areas mounting, wiring,
commissioning etc.
Exclusion of liability
All the components are supplied in particular hardware and software configurations appropriate for the
application. Modifications to hardware or software configurations other than those described in the
documentation are not permitted, and nullify the liability of Beckhoff Automation GmbH & Co. KG.
Personnel qualification
This description is only intended for trained specialists in control, automation and drive engineering who are
familiar with the applicable national standards.
Description of symbols
In this documentation the following symbols are used with an accompanying safety instruction or note. The
safety instructions must be read carefully and followed without fail!
Serious risk of injury!

Failure to follow the safety instructions associated with this symbol directly endangers the
life and health of persons.
DANGER
Risk of injury!
Failure to follow the safety instructions associated with this symbol endangers the life and
health of persons.
WARNING
Personal injuries!
Failure to follow the safety instructions associated with this symbol can lead to injuries to
persons.
CAUTION
Damage to the environment or devices

Failure to follow the instructions associated with this symbol can lead to damage to the en-
vironment or equipment.
Attention
Tip or pointer
This symbol indicates information that contributes to better understanding.
Note

Packaging Machine State
2 Packaging Machine State

The “Packaging Machine State” function blocks have a common interface to the existing “PackML Machine
State Model” versions.
It is expected that application-specific logic such as state transitions are programmed in external function
blocks and that the “Packaging Machine State” function block takes over the central logic of the state
machine and the state display. For that reason there is a recommendation for this function block with regard
to how it can be combined with other logic.
The state transition in a machine application is always application-specific. For that reason it is best to
design linked “State” function blocks with PackML State Machine V3 in order to simplify the standardization.
The “State” function blocks acquire application-specific signals and represent the transition logic to adjacent
states (see PackML state model). The “State” function blocks supply feedback to
PS_PackML_State_Machine_V3, as a result of which a standard state machine and a state message are
possible. The “State” function blocks contain the machine execution code and the application-specific
transition logic.
The “State” function blocks are listed below and are programmed by the application programmer in such a
way that the integrity and functionality of the PackML State Machine are retained:
Names of the “PackML State Machine V3” function blocks:

• PS_Starting
• PS_Completing
• PS_Resetting
• PS_Holding
• PS_unHolding
• PS_Suspending
• PS_Clearing
• PS_Stopping
• PS_Aborting
• PS_Execute
• PS_Complete
• PS_Idle
• PS_Held
• PS_Suspended
• PS_Stopped
• PS_Aborted
Requirements
Development environment Target system type PLC libraries to include

TwinCAT v3.1 Build 4018 and PC (i386) Tc3_PackML_V2
higher
2.1 Interfaces
2.1.1 ITF_UnitState
This interface can be implemented in the unit function blocks of the application and makes available all
methods of the Packaging State Model, which can then be filled as required with application code.
These methods are:

M_Aborted
M_Aborting
M_Clearing
M_Complete
M_Completing
M_Execute
M_Held
M_Holding
M_Idle
M_Resetting
M_Starting
M_StateComplete
M_Stopped
M_Stopping
M_Suspended
M_Suspending
M_Undefined
M_Unholding
M_Unsuspending
2.2 Data types
2.2.1 E_PMLCommand
E_PMLCommand
TYPE E_PMLCommand :
(
(* states according to PackTags v3.0 *)
ePMLCommand_Undefined := 0,
ePMLCommand_Reset := 1,
ePMLCommand_Start := 2,
ePMLCommand_Stop := 3,
ePMLCommand_Hold := 4,
ePMLCommand_Unhold := 5,
ePMLCommand_Suspend := 6,
ePMLCommand_Unsuspend := 7,
ePMLCommand_Abort := 8,
ePMLCommand_Clear := 9
);
END_TYPE
Requirements

higher

2.2.2 E_PMLState
E_PMLState
TYPE E_PMLState :
(
(* states according to PackTags v3.0 *)
ePMLState_Undefined := 0,
ePMLState_Clearing := 1,
ePMLState_Stopped := 2,
ePMLState_Starting := 3,
ePMLState_Idle := 4,
ePMLState_Suspended := 5,
ePMLState_Execute := 6,
ePMLState_Stopping := 7,
ePMLState_Aborting := 8,
ePMLState_Aborted := 9,
ePMLState_Holding := 10,
ePMLState_Held := 11,
ePMLState_Unholding := 12,
ePMLState_Suspending := 13,
ePMLState_Unsuspending := 14,
ePMLState_Resetting := 15,
ePMLState_Completing := 16,
ePMLState_Complete := 17
);
END_TYPE
Requirements

higher
2.2.3 E_PMLProtectedUnitMode
E_PMLProtectedUnitMode
TYPE E_PMLProtectedUnitMode :
(
ePMLUnitMode_Invalid := 0,
ePMLUnitMode_Production := 1,
ePMLUnitMode_Maintenance := 2,
ePMLUnitMode_Manual := 3
);
END_TYPE
Requirements

higher

2.2.4 ST_PMLSubUnitInfoRef
ST_PMLSubUnitInfoRef
TYPE ST_PMLSubUnitInfoRef :
STRUCT
pArray : POINTER TO ST_PMLSubUnitInfo;
nArraySize : UDINT;
nNoOfSubUnits : UDINT;
END_STRUCT
END_TYPE
pArray Address of a one-dimensional array of the type ST_PMLSubUnitInfo. Each array

element contains the state of a subordinated machine part.
Example:
stSubUnitInfo : ARRAY[1..10] OF ST_PMLSubUnitInfo;
pArray := ADR(stSubUnitInfo);
nArraySize Memory size of the one-dimensional array, which can be determined with the
SIZEOF function.
Example:
nArraySize := SIZEOF(stSubUnitInfo);
nNoOfSubUnits Number of relevant subordinated machine parts.
Requirements

higher
2.2.5 ST_PMLSubUnitInfo
ST_PMLSubUnitInfo
TYPE ST_PMLSubUnitInfo :
STRUCT
bActive : BOOL;
eState : E_PMLState;
END_STRUCT
END_TYPE
bActive Signals that this subordinated machine part is active and follows the state
presets of the state machine.
eState Enumeration that reflects the current state of the subordinated machine part.
Requirements

higher

2.2.6 ST_PMLStateMachineOptions
ST_PMLStateMachineOptions
TYPE ST_PMLStateMachineOptions :
STRUCT
END_STRUCT
END_TYPE
Requirements

higher
2.3 Function Blocks
2.3.1 PML_StateMachine
In the updated form the PML_StateMachine function block has a common interface with the PackML
Machine State Model V3. It is assumed that application-specific logic, such as state transitions, is
programmed in external function blocks and that the PML_StateMachine function block deals with the central
logic of the state machine and the state representation. The Machine State Model has a different
appearance due to the currently active UnitMode (eMode). Three basic modules are preconfigured for this
(E_PMLProtectedUnitMode [} 8]).

ePMLProtUnitMode_Production

ePMLProtUnitMode_Maintenance

ePMLProtUnitMode_Manual
Furthermore, other user-specific models can be created in a simple manner with the aid of the function block
PML_UnitModeConfig [} 14] and are thus very flexible in use.
The logic for transitions, in particular between production, maintenance and manual mode, depends on the
application. The states in which UnitMode changes are permissible for the basic models are described more
precisely in the description of the function block PML_UnitModeManager [} 16].
Inputs
VAR_INPUT
eMode : DINT;
eCommand : E_PMLCommand;
stSubUnitInfoRef : ST_PMLSubUnitInfoRef;
stOptions : ST_PMLStateMachineOptions;
END_VAR
eMode: Current PML UnitMode.
eCommand: Enumeration [} 7] with the various PML commands of the function block.
stSubUnitInfoRef: Structure [} 9] that points to an array of the current PML states of subordinated machine
units
stOptions: Not used at present
Outputs
VAR_OUTPUT
eState : E_PMLState;
bError : BOOL;
nErrorId : UDINT;
END_VAR

eState: Enumeration [} 8] that delivers the current PML state of the automatic state machine.
bError: Becomes TRUE, as soon as an error occurs.
nErrorID: Supplies the error number when the output bError is set.
Requirements

higher
2.3.2 PML_UnitModeConfig
Machines may have unit modes other than "Production", "Maintenance" and "Manual". This function block
enables the user to configure further models (UnitModes).
The number of the new model, the existing states and the states in which a model change is possible can be
freely defined.
Inputs
VAR_INPUT
eMode : DINT;
bDisableClearing : BOOL;
bDisableStarting : BOOL;
bDisableSuspended : BOOL;
bDisableStopping : BOOL;
bDisableAborting : BOOL;
bDisableHolding : BOOL;
bDisableHeld : BOOL;
bDisableUnholding : BOOL;
bDisableSuspending : BOOL;
bDisableUnsuspending : BOOL;
bDisableResetting : BOOL;
bDisableIdle : BOOL;
bDisableCompleting : BOOL;
bDisableComplete : BOOL;
bEnableUnitModeChangeStopped : BOOL;
bEnableUnitModeChangeIdle : BOOL;
bEnableUnitModeChangeSuspended : BOOL;
bEnableUnitModeChangeExecute : BOOL;
bEnableUnitModeChangeAborted : BOOL;

bEnableUnitModeChangeHeld : BOOL;
bEnableUnitModeChangeComplete : BOOL;
END_VAR
eMode: Number of the new PML-UnitMode [4 to 31].
bDisableClearing: Deactivates the PML state "Clearing".
bDisableStarting: Deactivates the PML state "Starting".
bDisableSuspended: Deactivates the PML state "Suspended".

The deactivation of the static state also causes the PML states "Suspending" and "Unsuspending" to be
deactivated.
bDisableStopping: Deactivates the PML state "Stopping".
bDisableAborting: Deactivates the PML state "Aborting".
bDisableHolding: Deactivates the PML state "Holding".
bDisableHeld: Deactivates the PML state "Held".

The deactivation of the static state also causes the PML states "Holding" and "Unholding" to be deactivated.
bDisableUnholding: Deactivates the PML state "Unholding".
bDisableSuspending: Deactivates the PML state "Suspending".
bDisableUnsuspending: Deactivates the PML state "Unsuspending".
bDisableResetting: Deactivates the PML state "Resetting".
bDisableIdle: Deactivates the PML state "Idle".

The deactivation of the static state also causes the PML state "Resetting" to be deactivated.
bDisableCompleting: Deactivates the PML state "Completing".
bDisableComplete: Deactivates the PML state "Complete".

The deactivation of the static state also causes the PML state "Completing" to be deactivated.
bEnableUnitModeChangeStopped: Enables a mode change in the PML state "Stopped".
bEnableUnitModeChangeIdle: Enables a mode change in the PML state "Idle".
bEnableUnitModeChangeSuspended: Enables a mode change in the PML state "Suspended".
bEnableUnitModeChangeExecute: Enables a mode change in the PML state "Execute".
bEnableUnitModeChangeAborted: Enables a mode change in the PML state "Aborted".
bEnableUnitModeChangeHeld: Enables a mode change in the PML state "Held".
bEnableUnitModeChangeComplete: Enables a mode change in the PML state "Complete".
Outputs
VAR_OUTPUT
bError : BOOL;
nErrorID : UDINT;
END_VAR
Requirements

higher

2.3.3 PML_UnitModeManager
Machines have system modes other than “Production”. Each unit mode is defined by its own state model. A
"Mode Manager" must be defined for transitions between the modes. The “Mode Manager” decides how and
in which state a machine can change unit modes; i.e. built-in barriers prevent the machine from changing to
unsuitable states. These barriers are permanently defined for the base modes “Production”, “Maintenance”
and “Manual”, as the illustration below shows. This can be individually specified for other modes defined via
the PML_UnitModeConfig [} 14] function block.
NOTE! The logic for transitions between the modes depends on the application, especially for
transitions between "Manual" and "Production" mode. In addition, hardware barriers or safety
equipment may be necessary for such mode changes. The responsibility for proper mode changes lies
with whoever implements them.

Inputs
VAR_INPUT
bExecute : BOOL;
eModeCommand : DINT;
ePMLState : E_PMLState;
END_VAR
bExecute: On a rising edge at this input, an attempt is made to perform the mode change.
eModeCommand: Requested mode.
ePMLState: Enumeration [} 8] that delivers the current PML state of the automatic state machine.
Outputs
VAR_OUTPUT
eModeStatus : DINT;
bDone : BOOL;

bError : BOOL;
bErrorID : UDINT;
END_VAR
eModeStatus: Current PML UnitMode.
bDone: Becomes TRUE as soon as the mode change has been successfully carried out.
Requirements

higher

Packaging Machine Tags
3 Packaging Machine Tags
3.1 Introduction
PackTags provides a uniform set of naming conventions for data elements that are used in the procedural
elements of the Base State Model. As described, the Base State Model provides a uniform set of machine
states, so that all automated machines can be considered in the same way. PackTags are data elements
provided with names for the interoperable data exchange between automated machines with open
architectures. This documentation contains the key names of the data elements, data types, values, fields
and data structures, if applicable. PackTags are used for machine-to-machine communication, e.g. between
a bottle filler and a cap fitter. PackTags can also be used for the exchange of data between a machine and
superordinated information systems such as Manufacturing Operations Management and Enterprise
Information Systems.
The documentation describes all PackTags for the navigation through a state model and for the definition
and actuation of the system control mode. Furthermore, this documentation defines a list of PackTags, which
may describe important machine information. All PackTags must be used in order to conform to the
principles of integrated connectivity with systems with the same implementation.
The tags required are those that are needed for the function of the automated machine or for the connectivity
to control or remote systems.
3.2 Tag Types

PackTags are broken down into three groups: Command, Status and Administration. Command and State
tags contain data for interfacing the machine with the line control for coordination or for downloading recipes/
parameters. Command tags are transferred as “information recipients” to the machine program and
“consumed” by it. State tags are created and read by the machine program. Administration tags contain data,
which are collected by higher-level systems for machine performance analysis or operator information.
The grouping of data should take place in adjacent registers, in order to optimize the communication.
Information data are usually transferred via OPC in an Ethernet-based communication network.
The prefix of Command tags is “PMLc”.
The prefix of State tags is “PMLs”.
The prefix of Administration tags is “PMLa”.

3.3 Tag Details

The following section provides an overview of the tags. Command, state and administration PackTags are
listed in the following tables.
Command structure PMLc

Tag Name Data Type
PMLc PMLc ST_PMLc
UnitMode PMLc.UnitMode DINT
UnitModeChangeRequest PMLc.UnitModeChangeRequest BOOL
MachSpeed PMLc.MachSpeed REAL
MaterialInterlock PMLc.MaterialInterlock DINT
CntrlCmd PMLc.CntrlCmd DINT
CmdChangeRequest PMLc.CmdChangeRequest BOOL
RemoteInterface[#] PMLc.RemoteInterface[#] ST_Interface
Number PMLc.RemoteInterface[#] DINT
ControlCmd- PMLc.RemoteInterface[#] DINT
Number
CmdValue PMLc.RemoteInterface[#] DINT
Parameter[#] PMLc.RemoteInterface[#].Parameter[#] ST_Descriptor
Id PMLc.RemoteInterface[#].Parameter[#].Id DINT
Name PMLc.RemoteInterface[#].Parame- STRING
ter[#].Name
Unit PMLc.RemoteInterface[#].Parameter[#].Unit STRING(5)
Value PMLc.RemoteInterface[#].Parame- REAL
ter[#].Value
Parameter[#] PMLc.Parameter[#] ST_Descriptor
Id PMLc..Parameter[#].Id DINT
Name PMLc..Parameter[#].Name STRING
Unit PMLc..Parameter[#].Unit STRING(5)
Value PMLc..Parameter[#].Value REAL
Product[#] PMLc.Product[#] ST_Product
ProductId PMLc.Product[#] DINT
ProcessVari- PMLc.Product[#].ProcessVariables[#] ST_Descriptor
ables[#]
Id PMLc.Product[#].ProcessVariables[#].Id DINT
Name PMLc.Product[#].ProcessVariables[#].Name STRING
Unit PMLc.Product[#].ProcessVariables[#].Unit STRING(5)
Value PMLc.Product[#].ProcessVariables[#].Value REAL
Ingredients[#] PMLc.Product[#].Ingredients[#] ST_Ingredient
Ingredien- PMLc.Product[#].Ingredients[#].IngredientId DINT
tId
Parame- PMLc.Product[#].Ingredients[#].Parameter[#] ST_Descriptor
ter[#]
Id PMLc.Product[#].Ingredients[#].Parame- DINT
ter[#].Id
Name PMLc.Product[#].Ingredients[#].Parame- STRING
ter[#].Name
Unit PMLc.Product[#].Ingredients[#].Parame- STRING(5)
ter[#].Unit
Value PMLc.Product[#].Ingredients[#].Parame- REAL
ter[#].Value
State structure PMLs

Tag Name Data Type
PMLs PMLs ST_PMLs
UnitModeCurrent PMLs.UnitModeCurrent DINT
UnitModeRequested PMLs.UnitModerequested DINT
UnitModeChangeInPro- PMLs.UnitModeChangeInProcess BOOL
cess

StateCurrent PMLs.StateCurrent DINT

StateRequested PMLs.StateRequested DINT
StateChangeInProcess PMLs.StateChangeInProcess BOOL
MachineSpeed PMLs.MachineSpeed REAL
CurMachineSpeed PMLs.CurMachineSpeed REAL
MaterialInterlock PMLs.MaterialInterlock DINT
EquipmentInterlock PMLs.EquipmentInterlock ST_Equipment
Blocked PMLs.EquipmentInterlock.Blocked BOOL
Starved PMLs.EquipmentInterlock.Starved BOOL
RemoteInterface[#] PMLs.RemoteInterface[#] ST_Interface
Number PMLs.RemoteInterface[#] DINT
ControlCmd- PMLs.RemoteInterface[#] DINT
Number
CmdValue PMLs.RemoteInterface[#] DINT
Parameter[#] PMLs.RemoteInterface[#].Parameter[#] ST_Descriptor
Id PMLs.RemoteInterface[#].Parameter[#].Id DINT
Name PMLs.RemoteInterface[#].Parame- STRING
ter[#].Name
Unit PMLs.RemoteInterface[#].Parameter[#].Unit STRING(5)
Value PMLs.RemoteInterface[#].Parame- REAL
ter[#].Value
Parameter[#] PMLs.Parameter[#] ST_Descriptor
Id PMLs..Parameter[#].Id DINT
Name PMLs..Parameter[#].Name STRING
Unit PMLs..Parameter[#].Unit STRING(5)
Value PMLs..Parameter[#].Value REAL
Product[#] PMLc.Product[#] ST_Product
ProductId PMLc.Product[#] DINT
ProcessVari- PMLc.Product[#].ProcessVariables[#] ST_Descriptor
ables[#]
Id PMLc.Product[#].ProcessVariables[#].Id DINT
Name PMLc.Product[#].ProcessVariables[#].Name STRING
Unit PMLc.Product[#].ProcessVariables[#].Unit STRING(5)
Value PMLc.Product[#].ProcessVariables[#].Value REAL
Ingredients[#] PMLc.Product[#].Ingredients[#] ST_Ingredient
Ingredien- PMLc.Product[#].Ingredients[#].IngredientId DINT
tId
Parame- PMLc.Product[#].Ingredients[#].Parameter[#] ST_Descriptor
ter[#]
Id PMLc.Product[#].Ingredients[#].Parame- DINT
ter[#].Id
Name PMLc.Product[#].Ingredients[#].Parame- STRING
ter[#].Name
Unit PMLc.Product[#].Ingredients[#].Parame- STRING(5)
ter[#].Unit
Value PMLc.Product[#].Ingredients[#].Parame- REAL
ter[#].Value
PMLa administration structure

Tag Name Data Type
PMLa Admin ST_PMLa
Parameter[#] PMLa.Parameter[#] ST_Descriptor
Id PMLa..Parameter[#].Id DINT
Name PMLa..Parameter[#].Name STRING
Unit PMLa..Parameter[#].Unit STRING(5)
Value PMLa..Parameter[#].Value REAL
Alarm[#] PMLa.Alarm[#] ST_Alarm
Trigger PMLa.Alarm[#].Trigger BOOL
Id PMLa.Alarm[#].Id DINT
Value PMLa.Alarm[#].Value DINT
Message PMLa.Alarm[#].Message STRING

Category PMLa.Alarm[#].Category DINT

DateTime PMLa.Alarm[#].DateTime ARRAY [0..6]
OF DINT
Year PMLa.Alarm[#].DateTime[0] DINT
Month PMLa.Alarm[#].DateTime[1] DINT
Day PMLa.Alarm[#].DateTime.[2] DINT
Hour PMLa.Alarm[#].DateTime[3] DINT
Minute PMLa.Alarm[#].DateTime[4] DINT
Second PMLa.Alarm[#].DateTime[5] DINT
mSec PMLa.Alarm[#].DateTime[6] DINT
AckDateTime PMLa.Alarm[#].AckDateTime ARRAY [0..6]
OF DINT
Year PMLa.Alarm[#].AckDateTime[0] DINT
Month PMLa.Alarm[#].AckDateTime[1] DINT
Day PMLa.Alarm[#].AckDateTime[2] DINT
Hour PMLa.Alarm[#].AckDateTime[3] DINT
Minute PMLa.Alarm[#].AckDateTime[4] DINT
Second PMLa.Alarm[#].AckDateTime[5] DINT
mSec PMLa.Alarm[#].AckDateTime[6] DINT
AlarmExtent PMLa.AlarmExtent DINT
AlarmHistory[#] PMLa.AlarmHistory[#] ST_Alarm
Trigger PMLa.AlarmHistory[#].Trigger BOOL
Id PMLa.AlarmHistory[#].Id DINT
Value PMLa.AlarmHistory[#].Value DINT
Message PMLa.AlarmHistory[#].Message STRING
Category PMLa.AlarmHistory[#].Category DINT
DateTime PMLa.AlarmHistory[#].DateTime ARRAY [0..6]
OF DINT
Year PMLa.AlarmHistory[#].DateTime[0] DINT
Month PMLa.AlarmHistory[#].DateTime[1] DINT
Day PMLa.AlarmHistory[#].DateTime[2] DINT
Hour PMLa.AlarmHistory[#].DateTime[3] DINT
Minute PMLa.AlarmHistory[#].DateTime[4] DINT
Second PMLa.AlarmHistory[#].DateTime[5] DINT
mSec PMLa.AlarmHistory[#].DateTime[6] DINT
AckDateTime PMLa.AlarmHistory[#].AckDateTime ARRAY [0..6]
OF DINT
Year PMLa.AlarmHistory[#].AckDateTime[0] DINT
Month PMLa.AlarmHistory[#].AckDateTime[1] DINT
Day PMLa.AlarmHistory[#].AckDateTime[2] DINT
Hour PMLa.AlarmHistory[#].AckDateTime[3] DINT
Minute PMLa.AlarmHistory[#].AckDateTime[4] DINT
Second PMLa.AlarmHistory[#].AckDateTime[5] DINT
mSec PMLa.AlarmHistory[#].AckDateTime[6] DINT
AlarmHistoryExtent PMLa.AlarmHistoryExtent DINT
StopReason[#] PMLa.StopReason[#] ST_Alarm
Trigger PMLa.StopReason[#].Trigger BOOL
Id PMLa.StopReason[#].Id DINT
Value PMLa.StopReason[#].Value DINT
Message PMLa.StopReason[#].Message STRING
Category PMLa.StopReason[#].Category DINT
DateTime PMLa.StopReason[#].DateTime ARRAY [0..6]
OF DINT
Year PMLa.StopReason[#].DateTime[0] DINT
Month PMLa.StopReason[#].DateTime[1] DINT
Day PMLa.StopReason[#].DateTime[2] DINT
Hour PMLa.StopReason[#].DateTime[3] DINT
Minute PMLa.StopReason[#].DateTime[4] DINT
Second PMLa.StopReason[#].DateTime[5] DINT
mSec PMLa.StopReason[#].DateTime[6] DINT

AckDateTime PMLa.StopReason[#].AckDateTime ARRAY [0..6]

OF DINT
Year PMLa.StopReason[#].AckDateTime[0] DINT
Month PMLa.StopReason[#].AckDateTime[1] DINT
Day PMLa.StopReason[#].AckDateTime[2] DINT
Hour PMLa.StopReason[#].AckDateTime[3] DINT
Minute PMLa.StopReason[#].AckDateTime[4] DINT
Second PMLa.StopReason[#].AckDateTime[5] DINT
mSec PMLa.StopReason[#].AckDateTime[6] DINT
StopReasonExtent PMLa.StopReasonExtent DINT
Warning[#] PMLa.Warning[#] ST_Alarm
Trigger PMLa.Warning [#].Trigger BOOL
Id PMLa.Warning[#].Id DINT
Value PMLa.Warning[#].Value DINT
Message PMLa.Warning[#].Message STRING
Category PMLa.Warning[#].Category DINT
DateTime PMLa.Warning[#].DateTime ARRAY [0..6]
OF DINT
Year PMLa.Warning[#].DateTime[0] DINT
Month PMLa.Warning[#].DateTime[1] DINT
Day PMLa.Warning[#].DateTime[2] DINT
Hour PMLa.Warning[#].DateTime[3] DINT
Minute PMLa.Warning[#].DateTime[4] DINT
Second PMLa.Warning[#].DateTime[5] DINT
mSec PMLa.Warning[#].DateTime[6] DINT
AckDateTime PMLa.Warning[#].AckDateTime ARRAY [0..6]
OF DINT
Year PMLa.Warning[#].AckDateTime[0] DINT
Month PMLa.Warning[#].AckDateTime[1] DINT
Day PMLa.Warning[#].AckDateTime[2] DINT
Hour PMLa.Warning[#].AckDateTime[3] DINT
Minute PMLa.Warning[#].AckDateTime[4] DINT
Second PMLa.Warning[#].AckDateTime[5] DINT
mSec PMLa.Warning[#].AckDateTime[6] DINT
WarningExtent PMLa.WarningExtent DINT
ModeCurrentTime[#] PMLa.ModeCurrentTime[#] DINT
ModeCummulativeTime[#] PMLa.ModeCummulativeTime[#] DINT
StateCurrentTime[#,#] PMLa.StateCurrentTime[#,#] DINT
StateCummulative- PMLa.StateCummulativeTime[#,#] DINT
Time[#,#]
ProdConsumedCount[#] PMLa.ProdConsumedCount[#]
Id PMLa.ProdConsumedCount[#].Id DINT
Name PMLa.ProdConsumedCount[#].Name STRING
Unit PMLa.ProdConsumedCount[#].Unit STRING(5)
Count PMLa.ProdConsumedCount[#].Count DINT
AccCount PMLa.ProdConsumedCount[#].AccCount DINT
ProdProcessedCount[#] PMLa.ProdProcessedCount[#]
Id PMLa.ProdProcessedCount[#].Id DINT
Name PMLa.ProdProcessedCount[#].Name STRING
Unit PMLa.ProdProcessedCount[#].Unit STRING(5)
Count PMLa.ProdProcessedCount[#].Count DINT
AccCount PMLa.ProdProcessedCount[#].AccCount DINT
ProdDefectiveCount[#] PMLa.ProdDefectiveCount[#]
Id PMLa.ProdDefectiveCount[#].Id DINT
Name PMLa.ProdDefectiveCount[#].Name STRING
Unit PMLa.ProdDefectiveCount[#].Unit STRING(5)
Count PMLa.ProdDefectiveCount[#].Count DINT
AccCount PMLa.ProdDefectiveCount[#].AccCount DINT
AccTimeSinceReset PMLa.AccTimeSinceReset DINT
MachDesignSpeed PMLa.MachDesignSpeed REAL

StatesDisabled PMLa.StatesDisabled DINT

PlcDateTime PMLa.PlcDateTime ARRAY [0..6]
OF DINT
Year PMLa.PlcDateTime[0] DINT
Month PMLa.PlcDateTime[1] DINT
Day PMLa.PlcDateTime[2] DINT
Hour PMLa.PlcDateTime[3] DINT
Minute PMLa.PlcDateTime[4] DINT
Second PMLa.PlcDateTime[5] DINT
mSec PMLa.PlcDateTime[6] DINT
3.4 Data types
3.4.1 Alarm
3.4.1.1 ST_Alarm
Collection of tags for the description of alarm events.
TYPE ST_Alarm :
STRUCT
Trigger : BOOL;
Id : DINT;
Value : DINT;
Message : STRING;
Category : DINT;
DateTime : ARRAY [0..6] OF DINT;
AckDateTime : ARRAY [0..6] OF DINT;
END_STRUCT
END_TYPE
Requirements

higher
3.4.1.2 ST_DateAndTime
This structure is used for saving the date and time of an event or for the acknowledgement of an event.
TYPE ST_DateAndTime :
STRUCT
Year : DINT;
Month : DINT;
Day : DINT;
Hour : DINT;
Minute : DINT;
Second : DINT;
mSec : DINT;
END_STRUCT
END_TYPE
Requirements

higher

3.4.2 Common
3.4.2.1 ST_Count
Collection of tags for the description of parameters in the machine.
TYPE ST_Count :
STRUCT
Id : DINT;
Name : STRING;
Unit : STRING(5);
Count : DINT;
AccCount : DINT;
END_STRUCT
END_TYPE
Requirements

higher
3.4.2.2 ST_Descriptor
TYPE ST_Descriptor :
STRUCT
Id : DINT;
Name : STRING;
Unit : STRING(5);
Value : REAL;
END_STRUCT
END_TYPE
Requirements

higher
3.4.2.3 ST_Equipment
TYPE ST_Descriptor :
STRUCT
Blocked : BOOL;
Starved : BOOL;
END_STRUCT
END_TYPE
Requirements

higher

3.4.2.4 ST_Ingredient
Collection of tags for the description of the raw materials required for the product.
TYPE ST_Ingredient :
STRUCT
IngredientId : DINT;
Parameter : ARRAY [1..MaxIngredientParameters] OF ST_Descriptor;
END_STRUCT
END_TYPE
Requirements

higher
3.4.2.5 ST_Interface
Collection of tags for the description of materials in the machine.
TYPE ST_Interface :
STRUCT
Number : DINT;
ControlCmdNumber : DINT;
CmdValue : DINT;
Parameter : ARRAY [1..MaxInterfaceParameters] OF ST_Descriptor;
END_STRUCT
END_TYPE
Requirements

higher
3.4.2.6 ST_Product
Collection of tags for the description of the product manufactured on the machine.
TYPE ST_Product :
STRUCT
ProductId : DINT;
ProcessVariables : ARRAY [1..MaxProductProcessVariables] OF ST_Descriptor;
Ingredients : ARRAY [1..MaxIngredients] OF ST_Ingredient;
END_STRUCT
END_TYPE
Requirements

higher
3.4.3 ST_PMLa
Collection of all Administration tags of the PackTag structure.
TYPE ST_PMLa :
STRUCT
Parameter : ARRAY [1..MaxAdminParameters] OF ST_Descriptor;
Alarm : ARRAY [1..MaxAlarms] OF ST_Alarm;
AlarmExtent : DINT := MaxAlarms;

AlarmHistory : ARRAY [1..MaxHistoryAlarms] OF ST_Alarm;

AlarmHistoryExtent : DINT := MaxHistoryAlarms;
StopReason : ARRAY [1..MaxStopReasons] OF ST_Alarm;
StopReasonExtent : DINT := MaxStopReasons;
Warning : ARRAY [1..MaxWarnings] OF ST_Alarm;
WarningExtent : DINT := MaxWarnings;
ModeCurrentTime : ARRAY [1..MaxUnitMode] OF DINT;
ModeCummulativeTime : ARRAY [1..MaxUnitMode] OF DINT;
StateCurrentTime : ARRAY [1..MaxUnitMode, 0..MaxMachineState] OF DINT;
StateCummulativeTime : ARRAY [1..MaxUnitMode, 0..MaxMachineState] OF DINT;
ProdConsumedCount : ARRAY [1..MaxConsumedCounts] OF ST_Count;
ProdProcessedCount : ARRAY [1..MaxProductCounts] OF ST_Count;
ProdDefectiveCount : ARRAY [1..MaxProductCounts] OF ST_Count;
AccTimeSinceReset : DINT;
MachDesignSpeed : REAL;
StatesDisabled : DINT;
PlcDateTime : ARRAY [0..6] OF DINT;
END_STRUCT
END_TYPE
Requirements

higher
3.4.4 ST_PMLc
Collection of all Command tags of the PackTag structure.
TYPE ST_PMLc :
STRUCT
UnitMode : DINT;
UnitModeChangeRequest : BOOL;
MachSpeed : REAL;
MaterialInterlock : DINT;
CntrlCmd : DINT;
CmdChangeRequest : BOOL;
RemoteInterface : ARRAY [1..MaxCommandRemoteInterfaces] OF ST_Interface;
Parameter : ARRAY [1..MaxCommandParameters] OF ST_Descriptor;
Product : ARRAY [1..MaxCommandProducts] OF ST_Product;
END_STRUCT
END_TYPE
Requirements

higher
3.4.5 ST_PMLs
Collection of all state tags of the PackTag structure.
TYPE ST_PMLs :
STRUCT
UnitModeCurrent : DINT;
UnitModeRequested : DINT;
UnitModeChangeInProcess : BOOL;
StateCurrent : DINT;
StateRequested : DINT;
StateChangeInProcess : BOOL;
MachineSpeed : REAL;
CurMachineSpeed : REAL;
MaterialInterlock : DINT;
EquipmentInterlock : ST_Equipment;
RemoteInterface : ARRAY [1..MaxStatusRemoteInterfaces] OF ST_Interface;
Parameter : ARRAY [1..MaxStatusParameters] OF ST_Descriptor;
Product : ARRAY [1..MaxStatusProducts] OF ST_Product;
END_STRUCT
END_TYPE

Requirements

higher
3.5 Global parameters

Parameters for the construction of the packaging machine tag structures. These can be adapted when
inserting the library for the current project.
(* PMLc / PMLs *)
MaxInterfaceParameter : INT := 5
MaxProductProcessVariables : INT := 10
MaxIngredients : INT := 10
MaxIngredientParameters : INT := 10
(* PMLc *)
MaxCommandRemoteInterfaces : INT := 2
MaxCommandParameters : INT := 10
MaxCommandProducts : INT := 5
(* PMLs *)
MaxStatusRemoteInterfaces : INT := 2
MaxStatusParameters : INT := 10
MaxStatusProducts : INT := 5
(* PMLa *)
MaxAdminParameters : INT := 10
MaxAlarms : INT := 10
MaxHistoryAlarms : INT := 10
MaxStopReasons : INT := 10
MaxWarnings : INT := 10
MaxConsumedCounts : INT := 10
MaxProductCounts : INT := 10
Requirements

higher
3.6 Global Constants

Constants for the construction of the packaging machine tag structures. These cannot be changed.
(* PMLa *)
MaxUnitMode : INT := 31
MaxMachineState : INT := 17
Requirements

higher

Appendix
4 Appendix
4.1 Example Tc3_PackML_V2

Based on a visualized sorting unit, the example illustrates how the Tc3_PackML_V2 library can be used as
the basis for a machine control system:
http://infosys.beckhoff.com/content/1033/TcPlcLib_Tc3_PackML_V2/Resources/zip/3414434955.zip

PLC Lib: Tc3 - Packml - V2: Manual

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

PLC Lib: Tc3 - Packml - V2: Manual

Uploaded by

Copyright:

Available Formats

Manual

PLC Lib: Tc3_PackML_V2

2 Packaging Machine State ......................................................................................................................... 6

3 Packaging Machine Tags ....................................................................................................................... 19

PLC Lib: Tc3_PackML_V2 Version: 1.1 3

1.1 Notes on the documentation

© Beckhoff Automation GmbH & Co. KG, Germany.

4 Version: 1.1 PLC Lib: Tc3_PackML_V2

1.2 Safety instructions

Please note the following safety instructions and explanations!

Serious risk of injury!

Damage to the environment or devices

PLC Lib: Tc3_PackML_V2 Version: 1.1 5

2 Packaging Machine State

Names of the “PackML State Machine V3” function blocks:

Development environment Target system type PLC libraries to include

These methods are:

6 Version: 1.1 PLC Lib: Tc3_PackML_V2

2.2 Data types

Development environment Target system type PLC libraries to include

PLC Lib: Tc3_PackML_V2 Version: 1.1 7

Development environment Target system type PLC libraries to include

Development environment Target system type PLC libraries to include

8 Version: 1.1 PLC Lib: Tc3_PackML_V2

pArray Address of a one-dimensional array of the type ST_PMLSubUnitInfo. Each array

Development environment Target system type PLC libraries to include

Development environment Target system type PLC libraries to include

PLC Lib: Tc3_PackML_V2 Version: 1.1 9

Development environment Target system type PLC libraries to include

2.3 Function Blocks

10 Version: 1.1 PLC Lib: Tc3_PackML_V2

PLC Lib: Tc3_PackML_V2 Version: 1.1 11

12 Version: 1.1 PLC Lib: Tc3_PackML_V2

eMode: Current PML UnitMode.

stOptions: Not used at present

PLC Lib: Tc3_PackML_V2 Version: 1.1 13

bError: Becomes TRUE, as soon as an error occurs.

Development environment Target system type PLC libraries to include

14 Version: 1.1 PLC Lib: Tc3_PackML_V2

eMode: Number of the new PML-UnitMode [4 to 31].

bDisableClearing: Deactivates the PML state "Clearing".

bDisableStarting: Deactivates the PML state "Starting".

bDisableSuspended: Deactivates the PML state "Suspended".

bDisableStopping: Deactivates the PML state "Stopping".

bDisableAborting: Deactivates the PML state "Aborting".

bDisableHolding: Deactivates the PML state "Holding".

bDisableHeld: Deactivates the PML state "Held".

bDisableUnholding: Deactivates the PML state "Unholding".

bDisableSuspending: Deactivates the PML state "Suspending".

bDisableUnsuspending: Deactivates the PML state "Unsuspending".

bDisableResetting: Deactivates the PML state "Resetting".

bDisableIdle: Deactivates the PML state "Idle".

bDisableCompleting: Deactivates the PML state "Completing".

bDisableComplete: Deactivates the PML state "Complete".

bEnableUnitModeChangeStopped: Enables a mode change in the PML state "Stopped".

bEnableUnitModeChangeIdle: Enables a mode change in the PML state "Idle".

bEnableUnitModeChangeSuspended: Enables a mode change in the PML state "Suspended".

bEnableUnitModeChangeExecute: Enables a mode change in the PML state "Execute".

bEnableUnitModeChangeAborted: Enables a mode change in the PML state "Aborted".

bEnableUnitModeChangeHeld: Enables a mode change in the PML state "Held".

bEnableUnitModeChangeComplete: Enables a mode change in the PML state "Complete".

bError: Becomes TRUE, as soon as an error occurs.

Development environment Target system type PLC libraries to include