Rockwell Automation Application Content

Machine Builder Libraries

Quick Start Guide

November, 2017
 Machine Builder Libraries

Important User Information

Solid-state equipment has operational characteristics differing from those of electromechanical equipment. Safety
Guidelines for the Application, Installation and Maintenance of Solid State Controls (publication SGI-1.1 available
from your local Rockwell Automation sales office or online at http://literature.rockwellautomation.com) describes
some important differences between solid-state equipment and hard-wired electromechanical devices. Because of
this difference, and because of the wide variety of uses for solid-state equipment, all persons responsible for
applying this equipment must satisfy themselves that each intended application of this equipment is acceptable.

In no event will Rockwell Automation, Inc. be responsible or liable for indirect or consequential damages resulting
from the use or application of this equipment.

The examples and diagrams in this manual are included solely for illustrative purposes. Because of the many
variables and requirements associated with any particular installation, Rockwell Automation, Inc. cannot assume
responsibility or liability for actual use based on the examples and diagrams.

No patent liability is assumed by Rockwell Automation, Inc. with respect to use of information, circuits, equipment,
or software described in this manual.

Reproduction of the contents of this manual, in whole or in part, without written permission of Rockwell Automation,
Inc., is prohibited.

Throughout this manual, when necessary, we use notes to make you aware of safety considerations.

Identifies information about practices or circumstances that can cause an explosion in a

hazardous environment, which may lead to personal injury or death, property damage, or
economic loss.

Identifies information that is critical for successful application and understanding of the product.

Identifies information about practices or circumstances or death, property damage, or

economic loss. Attentions avoid a hazard, and recognize the consequence.

Labels may be on or inside the equipment, that dangerous voltage may be present.

Labels may be on or inside the equipment, for example, a drive or motor, to alert people
that surfaces may reach dangerous temperatures.

Allen-Bradley, Rockwell Automation, and TechConnect are trademarks of Rockwell Automation, Inc.Trademarks not belonging to Rockwell Automation are property of their respective companies.

2
 Machine Builder Libraries

Table of Contents
1 Introduction .................................................................................................................................................................. 4

2 Deploying Logical Objects ............................................................................................................................................. 5

2.1 Registering Machine Builder Libraries ......................................................................................................................... 5
2.2 Controller ..................................................................................................................................................................... 7
2.3 IO Modules ................................................................................................................................................................... 9
2.4 Equipment Framework ............................................................................................................................................... 11
2.5 Functional Objects...................................................................................................................................................... 16

3 Deploying Visualization Objects .................................................................................................................................. 26

3.1 Importing Studio Architect Libraries .......................................................................................................................... 26
3.2 Creating a Visualization Project ................................................................................................................................. 29
3.3 Adding Machine Builder Library Content ................................................................................................................... 31

4 For More Information ................................................................................................................................................. 42

3
 Machine Builder Libraries

1 Introduction
The purpose of this document is to provide a quick reference on how to begin using library content.

Once the release package has been downloaded from the Product Compatibility and Download Center,
extract the files to the PC to a desirable location.

Once extracted, the contents can be browsed.

Folder Contents
00_GeneralDocuments Quick Start
Product Profile
Release Notes
01_ReferenceManuals Reference Manuals for all Machine Builder Library content.
(*.pdf)
02_ApplicationCodeManagerLibraries Registerable libraries for use with Application Code Manager 2.0 and forward.
(*.hsl4)
03_StudioArchitectLibraries Importable library for use with Studio 5000 Architect 2.0 and forward.
(*.LAL)
04_ViewDesigner FWK-B_PV5500-800x480.VPD

4
 Machine Builder Libraries

2 Deploying Logical Objects

2.1 Registering Machine Builder Libraries

Locate the Machine Builder Libraries download, and ensure the compressed file is properly extracted. Once
extracted, library objects can be registered. With Application Code Manager open, the registered libraries
will appear on the right.

Selecting ‘Registered Libraries’ and choosing ‘Register’ will launch windows explorer and the library file
directory can be navigated to.

5
 Machine Builder Libraries

Select all library files to be registered and open.

The Libraries Registration window will display status of the registration process.

When finished, newly registered libraries will appear in the registered libraries window.

6
 Machine Builder Libraries

2.2 Controller

In the Controller Preview or Class View windows, select ‘Controllers’ and choose ‘Add New’.

Select the desired controller from those available in the libraries.

Name the controller and configure the controller and motion parameters.

7
 Machine Builder Libraries

Preview the contents in the Controller Preview window. When the controller library is added, we can see
that it has been preconfigured with user tasks for immediate content deployment.

8
 Machine Builder Libraries

2.3 IO Modules

I/O modules can be also added into the ACM project. In the Controller Preview, select the backplane in the
I/O configuration and choose ‘Add New’.

Add an Ethernet card by expanding ‘Communication’ and selecting the desired communication card.

9
 Machine Builder Libraries

Provide the module a name and desired module configuration.

Once the module configuration is finished, it will be displayed in the Controller Preview and can be
reconfigured at any time.

10
 Machine Builder Libraries

2.4 Equipment Framework

Equipment Framework ‘B’ provides machine code framework based on international standards with the
Physical Model (equipment hierarchy) derived from ISA-88 and a Procedural Model that follows
ISA-TR88.00.02 defined modes and states.

2.4.1 Unit

The ‘ObjPrg_UnitModule’ object is a program folder that provides defined inputs for attachment of field
devices that drive the mode/state model contained within, as well as defined outputs of mode and state for
use in the rest of the control code. It can be used stand-alone, or with one or more equipment modules.

In the Controller Preview window, select the desired task and add a new Unit Module to the task.

11
 Machine Builder Libraries

In the Object Configuration window, enter the name of the Unit Module instance and choose if
ISA-TR88.00.02 ‘PackTags’ data structures are to be instantiated into the project as well.

When finished, the Unit Module can be viewed in the Controller Preview window as well as in the Class
View window.

12
 Machine Builder Libraries

2.4.2 Equipment Modules

Select the desired task in the Controller Preview and add a new ‘ObjPrg_EquipmentModule’ object.

On the Parameters tab, enter an object name and an equipment module ID (EMID) which is a unique
number between 1 and 31 serving as an identifier for each EM associated to a Unit.

13
 Machine Builder Libraries

On the Linked Libraries tab associate the equipment module with a unit, which is a linked library to an
equipment module. This linking will make all connections between objects.

After the equipment module is added, it is visible in both the Controller Preview and Class View windows.

14
 Machine Builder Libraries

An additional equipment module called ‘EM02_Batter’ is added and assigned an equipment module ID of
2 and linked to the same unit. Once added, the second equipment module is visible in both windows.

15
 Machine Builder Libraries

2.5 Functional Objects

2.5.1 Equipment Indicators

Add New Equipment Audio Visual Indicator Object to the Unit

Configure the library object.

16
 Machine Builder Libraries

Once instantiated, a new routine is created that contains the TowerLight01 instance and a jump to that routine
(JSR) is added to the MainRoutine in the Unit program.

17
 Machine Builder Libraries

2.5.2 Device Handlers

Device Handler (DH) requires 3 programs (DH program, language pack program, SysIni power-up handler
program).

Each program is separate library object, where SysIni and Language Pack are linked libraries to Device
Handler library objects.

Select the desired task in the Controller Preview and add a new ‘DvcHdlr – CIP Motion’ object. A PowerFlex
527 Device Handler will be added for the conveyor.

18
 Machine Builder Libraries

On the Parameter tab, configure the Device Handler by assigning a name for the Device Handler, name of the
axis, and if the axis is to be created.

On the Linked Libraries tab, select an existing ‘raM_Dvc_DH_SysIni’ object or create a new instance if one
does not exist. It is advisable not to change the default name as the default name will be immediately
recognized by subsequent Device Handlers as they are added. There is otherwise no configuration required.

19
 Machine Builder Libraries

As with the system initialization program, it is also advisable to leave the default name of the language pack to
minimize configuration. Choose a task to schedule the language pack within, and select which languages are
going to be required.

When finished, the object appears in the controller preview and ACM shows green checkbox in front of the
library name.

20
 Machine Builder Libraries

When all parameters and linked libraries are set correctly, click finish and Device Handler is added to the
project.

A second Device Handler for EM02_Batter called ‘CM_Valve’ is done the same way. In this example, a
Kinetix5500 was chosen to operate the batter valve.

21
 Machine Builder Libraries

2.5.3 Methods

Methods will also be added to perform specific functions on the PowerFlex and Kinetix drives. Begin by
adding basic axis state operations such as Energize, DeEnergize, and Clear Faults. Selecting
‘EM01_Conveyor’, choose ‘Add New’, and add the ‘raM_Opr_Energize_CD’ method.

Provide a name for the method instance and a name for the routine it will be instantiated in.

22
 Machine Builder Libraries

Each method exchanges information with a Device Handler, so the method must be associated with a
specific handler. Selecting the handler parameter will launch a reference selection dialogue box.
Highlighting and selecting ‘Finish’ will establish this association.

Once the instance has been named and parameters configured, select ‘Finish’ to add the method to the
project.

23
 Machine Builder Libraries

This process is repeated then for DeEnergize and Clear adding each to EM01_Conveyor, as well as adding
the same 3 methods to EM02_Batter to provide control for the valve. Once completed, they can be viewed
in the Controller Preview and Class View windows.

To generate the Logix Designer project file, select ‘Controllers’ and generate controllers.

24
 Machine Builder Libraries

Check ‘Create ACD’, the path to save the output, and then generate the files.

Monitor the process in the status field and when finished, the ACD file can be opened using Logix
Designer.

25
 Machine Builder Libraries

3 Deploying Visualization Objects

3.1 Importing Studio Architect Libraries

Launch Studio 5000 and create a new project.

Select a blank Architect project and provide a project name.

26
 Machine Builder Libraries

Once Architect has opened, locate the Toolbox window. In the Toolbox window locate ‘Libraries’ and
choose to import a library.

Locate the Machine Builder Libraries download, and ensure the compressed file is properly extracted. Once
extracted, locate the Architect library for import and open the file.

27
 Machine Builder Libraries

Once imported, the library ‘(RA-LIB) Machine Builder’ should be visible in the Toolbox.

The contents of the Architect library are as follows:

 00 – Common
o Reference manuals
o Visualization components common across all visualization objects provided

 01 – Equipment Frameworks
o Reference manuals
o Visualization components for all equipment frameworks included in the Machine Builder
Libraries

 02 – Device
o Reference manuals
o Visualization components for all device objects included in the Machine Builder Libraries

 03 – Operation
o Reference manuals
o Visualization components for all operation objects included in the Machine Builder
Libraries

 04 – Technology
o Reference manuals
o Visualization components for all technology objects included in the Machine Builder
Libraries

Note: Only objects’ associated visualization components are included in the Architect library.

28
 Machine Builder Libraries

3.2 Creating a Visualization Project

Create a new visualization project by adding a View ME Station.

Name the project, and select the desired display resolution / hardware platform. The Equipment
Frameworks provided included in Machine Builder Libraries are built for specific display resolutions, so
scaling will not be required.

29
 Machine Builder Libraries

Once the project has been added, the project will be visible in the Project Explorer, and a PC will be visible
in the Hardware Diagram.

30
 Machine Builder Libraries

3.3 Adding Machine Builder Library Content

3.3.1 Equipment Frameworks

Begin by adding common components from the 00 - Common folder. In the FactoryTalk View ME folder
all images used across Machine Builder Libraries can be selected and dragged to the project in the Project
Explorer. This can be done individually, by multi-selecting, or by simply selecting the parent folder.

The *.png images should now be visible in the project’s images folder.

31
 Machine Builder Libraries

In the Equipment Frameworks folder, locate Framework B and drag and drop common objects as well as
objects built for 800x480 display resolution.

The project should now contain displays and global objects.

32
 Machine Builder Libraries

3.3.2 Mode and State Models

Add the ISA-TR88.00.02 Mode and State model faceplate and associated global objects by selecting the
parent folder and dragging it into the project.

Once complete, the faceplates and associated global objects should be visible in the project explorer.

33
 Machine Builder Libraries

3.3.3 Equipment Indicators

Add a Tower light to the project.

Once complete, the faceplate and associated global objects should be visible in the project explorer.

34
 Machine Builder Libraries

3.3.4 Axis Device Handlers

Add a faceplate for a Kinetix 5500 device handler and a PowerFlex 527; again by selecting the parent
folder and dragging it into the project.

Once complete, the faceplates and associated global objects should be visible in the project explorer.

35
 Machine Builder Libraries

Select the project folder and commit project changes.

Once the commit process has completed, select the project folder again and open the project in the design
software.

The project will now open in the appropriate design software.

36
 Machine Builder Libraries

3.3.5 Project Personalization

To personalize the equipment framework displays to the specific application, begin by opening the startup
configuration dialogue.

Change the initial graphic from the default ‘Main’ to ‘S000_PowerUp_800x480’.

37
 Machine Builder Libraries

In the Alarm Setup dialogue box, change the alarm display to ‘S009_Alarms_800x480’

Launch the Find and Replace and replace the default unit module program name (ObjPrg_UnitModule)
with ‘UN01_PCM53204’.

38
 Machine Builder Libraries

Configure communications by opening ‘Communication Setup’ and adding a device shortcut and setting
the communication path to the controller. The default shortcut used by the equipment framework is
‘Framework’.

Note: If a different device shortcut is used, perform an addition find and replace on [Framework] in the
project.

Test the application to verify functionality by using the ‘Test Application’ function.

39
 Machine Builder Libraries

Using the navigation button, launch the machine state model faceplate. The equipment framework
navigation is pre-configured to call the ISA-TR88.00.02 faceplate.

Returning to the design software, additional faceplate call-ups can be added to the application. Each
faceplate is accompanied with a *._GFX global object that contains faceplate call-up objects.

40
 Machine Builder Libraries

Open the global objects for the Tower light, Kinetix drive, and PowerFlex drive and add a call-up to the
home screen by copy and pasting from the global object to the home screen. Developers can also create
their own call-up buttons if desired.

Connect the global object parameters to the appropriate backing tag / backing program, and if desired set
screen location where the faceplates upper left corner will be located when launched.

Developers can now extend and customize the HMI to fit the application.

41
 Machine Builder Libraries

4 For More Information

Contact the Machine Builder Libraries team at [email protected].

42