User Manual

ControlFLASH Firmware Upgrade Software

Catalog Numbers ControlFLASH 12.00.00

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://www.rockwellautomation.com/literature/) describes some important differences between solid-state equipment and hard-wired electromechanical devices. Because of this difference, and also 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.
WARNING: 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. ATTENTION: Identifies information about practices or circumstances that can lead to personal injury or death, property damage, or economic loss. Attentions help you identify a hazard, avoid a hazard, and recognize the consequence SHOCK HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that dangerous voltage may be present. BURN HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that surfaces may reach dangerous temperatures. IMPORTANT Identifies information that is critical for successful application and understanding of the product.

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

Table of Contents
Preface
Purpose of This Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Whats New in ControlFLASH Software, version 11.00.00 . . . . . . . . . . . . 5 Who Should Use This Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 ...................................................................6 Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 What are the System Requirements? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Before You Begin. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 ...................................................................7 Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Locate and Download Firmware Bundles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Install the Firmware Kit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Configure ControlFLASH Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Prepare the Networks for Upgrades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Prepare the Device for Upgrades. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Use the ControlFLASH Software to Upgrade Firmware. . . . . . . . . . . . . Access Online Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Command Line Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Command Line Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Script Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Flash Multiple Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Example Script File Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Example Script File Text for Instance Number . . . . . . . . . . . . . . . . . . Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Error Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Aborted Script File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Stop a Command Line or Script Application. . . . . . . . . . . . . . . . . . . . Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Information Monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Event Log. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Audit Log. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . FactoryTalk AssetCentre . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Logging the Device Update Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Logging the Exit of ControlFLASH. . . . . . . . . . . . . . . . . . . . . . . . . . . . Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Example Automated Flash Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . How a Custom Upgrade Tool Works . . . . . . . . . . . . . . . . . . . . . . . . . . Example Visual Basic .NET Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 17 17 18 25 27 28 28 30 31 33 33 34 34 34 35 37 37 37 37 38 39 39 41 43 43 45 46

ControlFLASH Firmware Kit

Install the ControlFLASH Firmware Kit Configuring ControlFLASH Policy in FactoryTalk Policies Upgrade Firmware with ControlFLASH

Use the Command Line

ControlFLASH and Factory Talk AssetCentre Interaction

ControlFLASH Software Error Codes Create a Custom Interface to Process Firmware Downloads

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

Table of Contents

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

Preface

Preface

Purpose of This Manual

This manual describes how to use the ControlFLASH software to upgrade device firmware.

Whats New in ControlFLASH Software, version 12.00.00

ControlFLASH v12.00.00 includes the following new features: ControlFLASH v12.00.00 supports flashing PanelView 5000 using Large Packet (also known as connected messaging) service. If the target device supports connected messaging, ControlFlash uses the large packet service. If the target device does not support the large packet service, ControlFlash uses the standard packet service. If the target device does not support connected messaging, ControlFlash uses unconnected messaging. ControlFLASH v12.00.00 supports updating the firmware for the 1756L71S controller and its partner module via the controllers USB port and also via an EtherNet module in the backplane. ControlFLASH v12.00.00 provides an easier way to determine what firmware releases are installed on your PC by viewing the Firmware Inventory dialog. Firmware kit installation is more firmware-centric, now showing a list of firmware releases to be installed.

Who Should Use This Manual

You should use this manual if you need to maintain firmware revisions. The following is a list of hardware that ControlFLASH supports: ControlLogix controllers, communication, digital, analog, and motion modules CompactLogix controller, communication, digital, analog, and motion modules FlexLogix controllers and communication modules PowerFlex 700S drives with DriveLogix controllers and communication modules SoftLogix5800 controllers - Kinetix 6000, Kinetix 2000, Kinetix 7000, and 8720MC servo drives, communication, and motion modules MicroLogix controllers PLC-5 controllers You should also have the following knowledge:

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

Preface

A basic understanding of networking concepts. A basic familiarity of RSLinx Classic software.

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

Chapter

ControlFLASH Firmware Kit

Introduction

This chapter helps you get started with using the ControlFLASH Firmware Kit with your application. It includes the following content: The firmware of devices to be upgraded. The ControlFLASH software (including supported drivers and online help), which you can use to quickly upgrade the firmware for your devices.

What are the System Requirements?

To use the ControlFLASH Firmware Kit, your system must be at this minimum configuration: Personal computer with a Pentium 4 processor with at least 1GB of RAM Microsoft Windows 7, Microsoft Windows Server 2008 R2 Standard Edition Service Pack 1 or later operating systems RSLinx Classic Lite software, or better You need to have at least RSLinx Classic Lite software installed before you install ControlFLASH. The RSLinx software is a communication package that you use with a wide variety of Rockwell Automation software, applications, and hardware. The ControlFLASH software uses RSLinx Classic Lite software to communicate over Data Highway Plus, DF1, DH485, ControlNet, DeviceNet, and Ethernet networks. To install and use RSLinx Classic Lite software, refer to the printed or online help that comes with your RSLinx software package. If the RSLinx software is already installed on your computer, you may not need to install it now.

Before You Begin

Before you start using the ControlFLASH Firmware Kit, you need to: Verify that you have a version of RSLinx software installed. Configure RSLinx software. Install and configure your communication interface card. Verify your communication interface card operates correctly.

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

Chapter 1

ControlFLASH Firmware Kit

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

Chapter

Install the ControlFLASH Firmware Kit

Introduction

A version of ControlFLASH software is installed when you install RSLogix 5000 and Connected Components Workbench. A version is also included when you download firmware bundles from the My Support site at: http:// support.rockwellautomation.com/firmware.asp. To use this site, you must register a username and password, as well as provide a serial number of an RSLogix5000 product. A downloaded bundle contains these files: Firmware to upgrade your devices ControlFLASH installation file ControlFLASH drivers ControlFLASH online help

Locate and Download Firmware Bundles

Before you start, you need to have a serial number for a RSLogix 5000 product. Follow these instructions to locate firmware bundles. 1. Go to http://support.rockwellautomation.com/firmware.asp. 2. Click Control Hardware. The Flash Firmware Updates page appears.

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

Chapter 2

Install the ControlFLASH Firmware Kit

3. Scroll down to find the firmware bundle you need, for example, the 1756L63, series A controller.

4. Click the disk icon. 5. Enter your serial number and click the Qualify For Update button. 6. After you have entered a qualified serial number, you will be able to download the firmware bundle.

Install the Firmware Kit

If you have already downloaded and installed a firmware bundle, a version of ControlFLASH may already be on your machine. If the next firmware bundle you download has a newer version of ControlFLASH attached, then the newer version is installed. If you select a firmware bundle that has an older version of ControlFLASH attached, the newer version that is already installed remains. In all cases, any previously installed firmware remains accessible. Follow these steps to install a ControlFLASH Firmware Kit.
IMPORTANT

The illustrations of the ControlFLASH software dialog boxes shown in this manual are samples. Because your system configurations or the firmware kits are different, the dialog boxes you see when running the tool may be different from the ones you see here.

7. In the installation package, double-click ControlFLASH.msi. The Welcome dialog box appears. Click Next.

10

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

Install the ControlFLASH Firmware Kit

Chapter 2

8. Read and agree to the license and click Next.

9. Click Browse to select the location of the installation. The default location is C:\Program Files\ControlFLASH\. Click Next to continue.

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

11

Chapter 2

Install the ControlFLASH Firmware Kit

10. If needed, click Disk Cost to view your drives available and the required disk space and click OK .

11. In the Confirm Installation dialog box, to enable FactoryTalk Security, select the Enable FactoryTalk Security check box. You will be prompted to log on to FactoryTalk when starting ControlFLASH. Click Next.

12

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

Install the ControlFLASH Firmware Kit

Chapter 2

12. When the installation is complete, select the Yes, I want to launch ControlFLASH to launch ControlFLASH after installation check box.

13. Click Close to complete the installation.

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

13

Chapter 2

Install the ControlFLASH Firmware Kit

14

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

Chapter

Configuring ControlFLASH Policy in FactoryTalk Policies

Introduction

This chapter tells you how to configure ControlFLASH security policy in the FactoryTalk Administration Console.
IMPORTANT

The illustrations of the ControlFLASH software dialog boxes shown in this manual are samples. Because your system configuration is unique, the dialog boxes you see when running the tool may be different from the ones you see here.

Configure ControlFLASH Policy

Follow this procedure to configure security policy on ControlFLASH. 1. Open the FactoryTalk Administration Console. 2. In the Explorer area, expand System > Policies > Product Policies > ControlFLASH.

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

15

Chapter 3

Configuring ControlFLASH Policy in FactoryTalk Policies

3. Double-click Feature Security. The Feature Security Properties window is displayed. Feature Security is included in FactoryTalk Services Platform 2.30 or later.

4. In the Firmware: Update category, click Browse. The Configure Securable Action window is displayed. 5. Configure the policy settings as RSLogix 5000 does.

6. Click OK to complete the configuration.

16 Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

Chapter

Upgrade Firmware with ControlFLASH

Introduction

This chapter tells you how to upgrade firmware by using the ControlFLASH software.
IMPORTANT

The illustrations of the ControlFLASH software dialog boxes shown in this manual are samples. Because your system configuration is unique, the dialog boxes you see when running the tool may be different from the ones you see here.

Before you begin, make sure that you have prepared your network and device for updating. If you need help, refer to the back cover of this publication for support information.

Prepare the Networks for Upgrades

Follow this procedure to prepare the network for updating.

ATTENTION: You cannot perform the upgrade while running a process. Before performing the upgrade, choose an appropriate time to remove your device from service.

1. Choose an appropriate time after all processes can be stopped to remove the device from service. 2. Shut down the production line only if the device does not support removal/insertion under power (RIUP). To verify that your device supports RIUP, check with the documentation that comes with your hardware. For Rockwell Automation products you can visit http://literature.rockwellautomation.com to obtain the latest documentation or contact your local distributor or Rockwell Automation representative. 3. Verify that all network devices are properly connected.

Prepare the Device for Upgrades

Follow this procedure to prepare the device for updating.

ATTENTION: Be sure to back up any data or programs that you have downloaded to a device. When you upgrade the firmware, all data and programs are erased.

1. Back up any current programs or data on the devices that you are updating.
Rockwell Automation Publication 1756-UM105E-EN-E - October 2012 17

Chapter 4

Upgrade Firmware with ControlFLASH

2. Turn the key switch on your processor (if used) to Program mode. 3. Turn on power to the processor.

Use the ControlFLASH Software to Upgrade Firmware

Follow these steps to use ControlFLASH to upgrade the firmware on your devices. 1. Click Start > All Programs > FLASH Programming Tools > ControlFLASH. The Welcome to ControlFLASH dialog box appears.

18

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

Upgrade Firmware with ControlFLASH

Chapter 4

This dialog box tells you to be prepared with the following information: Catalog number of the target device Network configuration information (optional) Network path to the target device Firmware revision for this upgrade If you have selected the Enable FactoryTalk Security check box during installation, you will be prompted to select the FactoryTalk Directory. Select Network or Local and click OK .

If prompted to log on to FactoryTalk, enter your user name and passoword and click OK .

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

19

Chapter 4

Upgrade Firmware with ControlFLASH

TIP
Right-click on the ControlFLASH Icon.

A ControlFLASH menu is located in the upper left hand corner of the screen.

2. After you have the information, click Next.The Catalog Number dialog box appears.

3. Click View Inventory... to...

20

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

Upgrade Firmware with ControlFLASH

Chapter 4

4.

5. Select the catalog number of the target device and click Next. The device path dialog box allows you to specify the network path of the target module you are updating. The dialog box varies depending on the target module you are updating. If you are updating a device with MicroXA or AB_ASA protocol driver, the RSWho dialog box is displayed. To specify the network path, navigate to the network where the device is located and select the target module. Cick OK to go to the Firmware Revision dialog box. For more information about configuring and using RSWho, refer to RSLinx help. If you are updating a device with AB_SNMP protocol driver, the AB_SNMP.DLL - Enter IP Address dialog box is displayed.

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

21

Chapter 4

Upgrade Firmware with ControlFLASH

To specify the network path, in the device path box, enter the IP address or host name of the target module. Cick OK to go to the Firmware Revision dialog box. For more information about the device you are updating, click Get Info. The information is displayed in the Device Identification area. For more information about AB_SNMP protocol driver, click Help. If you are updating a device with AB_PLC5 protocol driver, the Device Path dialog box is displayed.

To specify the network path, in the device path box, enter the path in the box of the target module. Click Next to go to the Firmware Revision dialog box. For more information about the device you are updating, click Get Info. The information is displayed in the Device Identification area. 6. In the Firmware Revision dialog box, do one of the following:

To select a firmware revision, click the desired revision in the revision list.

22

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

Upgrade Firmware with ControlFLASH

Chapter 4

To see all available revisions that you can update to, select the Show all revisions check box. To locate another folder that contains the desired firmware revision, click Browse and select the desired folder.

ATTENTION: Be sure that this upgrade is the correct one for your device. If not, an unpredictable system result could occur. Contact your technical support specialist for more information.

7. Click Next to go to the Summary dialog box.

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

23

Chapter 4

Upgrade Firmware with ControlFLASH

8. Click More Info to review more about the revision you selected, and click OK to close the dialog box.

IMPORTANT

Be sure that this update is the correct one for your device. If not, an unpredictable system operation will result. Check with your technical support representative if you are unsure about making the update.

9. Click Finish when you are ready to upgrade the device. 10. Click Yes to continue with the update. The upgrade is in progress.

ATTENTION: If you are attempting to flash a CompactLogix L2x or L3x controller, it is extremely important to allow the upgrade to complete without interruption. ATTENTION: Interrupting the upgrade at this point may result in an inoperable product. Make sure the upgrade is going without interruption.

11. After the upgrade, the Update Status dialog box appears..

24

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

Upgrade Firmware with ControlFLASH

Chapter 4

12. To view the history of programming events, click View Log.

13. Click OK to complete the upgrade.

TIP

If the upgrade does not complete successfully, refer to Appendix A of this manual for more information about errors.

IMPORTANT

Test the operation of the device you upgraded before using it in its intended application.

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

25

Chapter 4

Upgrade Firmware with ControlFLASH

Access Online Help

There is additional information in the online help for this application. Access help from the button that appears on each ControlFLASH software dialog box.

For additional information about error messages, press F1 while the ControlFLASH software displays the error message.

26

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

Chapter

Use the Command Line

Introduction

This chapter explains how to use the command line to update module firmware and simplify firmware management. You can flash mutiple modules automatically and save time because you do not need to navigate through the software and select each module to flash. Using the command line to flash modules provides the following benefits: Create applications that flash upgrade groups of devices automatically without having to repeatedly use the ControlFLASH menus. These can be scripts or VB applications that list the modules to flash, the firmware revisions, and the path requirements. Reduce training requirements of technicians and improve time for commissioning machines or performing field upgrades. Leverage multi-threaded syntax to flash up to five modules simultaneously for improved performance.

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

27

Chapter 5

Use the Command Line

Command Line Mode

You can use the command line interface of ControlFLASH for flashing devices without user intervention. You can write a script file or some other Windows applications that pass the required parameters to ControlFLASH software. This can significantly improve the time required to flash large systems because each individual flash action does not have to be driven through the ControlFLASH GUI interface. Consider the following requirements for using the command line. Any device that you can flash with ControlFLASH software can be flashed by using the command line or scripting. You must have the proper firmware kit installed in ControlFLASH software before you use the command line or scripting. You must use valid catalog numbers when developing your script files. Otherwise, ControlFLASH does not recognize your modules. The only way to be sure you have the correct catalog number to include in a script is to run the GUI version of the ControlFLASH software and write down the catalog number as it is shown. For both the command line and script methods of flashing devices, it is required that a firmware kit containing the requested firmware revision is installed on the computer making the call to the ControlFLASH software. The firmware kits must be installed in the default installation folder for ControlFLASH: C:\Program Files\ControlFLASH. You must have a valid installation of ControlFLASH on the computer before you can flash by using the command line or scripting versions. You must also have the kits installed on that machine for the specific modules and firmware revisions you intend to flash.

Command Line Syntax

The following are the command line usages.
Syntax ControlFlash.exe -C <Catalog> -R <Revision> -P <Path> [-K] [-S] If FactoryTalk Services Platform 2.30 or later is installed, the syntax above uses the following format: ControlFlash.exe -O -C <Catalog> -R <Revision> -P <Path> [-K] [-S] ControlFlash.exe -F <Filename> ControlFlash.exe -I <Instance> ControlFlash.exe -? Points to command lines in a specific script file. Specifies the instance or port number of the device supporting multiple assemblies. Displays the help information. Use Displays the full command line syntax.

28

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

Use the Command Line

Chapter 5

Table 1 - Parameter Options

Parameter -C Description Catalog number of device as registered with the current installed ControlFLASH software. To identify installed kits, refer to the GUI version of ControlFLASH software. For example, -C 1756-L63/A Firmware revision you need to flash the device to. This revision must be registered for this device with the current install of the ControlFLASH software. To identify installed kits, refer to the GUI revision of ControlFLASH software. For example, -R 16.23 FactoryTalk RSLinx path to the target device. -P AB_PCIC-1, 2 2 1 7 |_______| | | | |___Node address | | | |____ Backplane | | |______PCICS Communication card address | |________ControlNet cable address |____________PCICS driver name -P AB_ETH-2,192.168.1.4,1,7 |______| |_______| | |__Node Address | | |____Backplane | |_________IP address |_______________Ethernet driver name -P AB_DF1-1,0,1 |_||__________| | |_______CIP path to target device over DF1 driver |_____________Parameter described CIP path to target device Example: Path = -P AB_DF1-1,0,1 -P AB_VBP-1,1,16 |_||___________| | |_______CIP path to target device over USB driver |_____________Parameter described CIP path to target device Example: Path = -P AB_VBP-1,1,16 Full path name to script file where target devices and options are specified. For example: -F MyScript.txt Refer to Script Files on page 30. Not including the -K parameter causes the device requested to flash, even if it is already at the same revision your moving the device to. Including the -K parameter skips the flash request if the target devices firmware is already at the requested firmware revision. Not including the -S parameter causes a second command window to open and displays progress on the current flashing activity. Including the -S parameter starts Silent mode, no progress status (percentage completion) or command window is displayed. The instance or port number of the device supporting multiple assemblies. The value should be between 0 and 15, for example, -I 5. Display help information.

-R

-P

-F

[-K] [-S] -I -?

Unless Use single sign-on in FactoryTalk Security Policy is enabled, ControlFLASH command-line mode does not support automatic logon without inputting the user name . You must manually specify the parameter of FactoryTalk Scope. See the parameter option defined in the Table below. If Use single sign-on is not selected, then ControlFLASH always prompts you to input the user name and password. This mechanism

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

29

Chapter 5

Use the Command Line

is determined by FactoryTalk Services Platform instead of ControlFLASH..

Parameter -O Required Description This parameter specifies FactoryTalk scope. Example: "-O Network" or "-O Local"

If FactoryTalk Services Platform is not installed on your machine, then parameter O is regarded as an invalid parameter with an error message Invalid combination of switches displayed on the screen and written to log file. If a correct version of FactoryTalk Services Platform is installed, but you do not input parameter O in the command-line mode, then the message Insufficient inputs, FactoryTalk Scope was not found. is displayed on the command-line window. You can use ControlFLASH.exe with the required and optional parameters at the command line: C:\Program Files\ControlFLASH\Controlflash followed by the appropriate parameters. A status window is displayed to indicate the progress. Both the command line and scripting versions provide a switch ( [-S] ) option to disable this function and run in Silent mode.
ATTENTION: If you disable the status window, there will be no visual indication that a flash operation has failed or is in progress. In this case, Rockwell Automation recommends that you provide some other forms of user interaction through your own application, which indicates the status information.

Script Files
With ControlFLASH software, you can create script files or execute your own C#, Java, or other language to have the ControlFLASH software push firmware to your devices. Your application can interact directly with ControlFLASH software through a command line with status and diagnostics available in the ControlFLASH log or echoed back to your application directly. Each device that you want to flash must have a unique Device#. ControlFLASH software begins flashing devices with [Device1], [Device2], and so forth. The software flashes the number of devices as indicated by the NumberDevices field. When you number your devices, do not skip a number and do not use [Device0]. The order of the file is not important, as long as each number exists once in the file. In this example, the NumberDevices is 4, so [Device5] will not be flashed.

30

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

Use the Command Line

Chapter 5

Flash Multiple Devices

When creating a script file, there is a switch in the header that lets you flash up to five devices simultaneously.
ATTENTION: You should not use this option if flashing network or bridging type devices. ControlFLASH software may start flashing a network card that is currently being used as part of the path to flash other devices under that communication card. This could render the child device unusable and require the device to have to be returned to the factory. ATTENTION: Use the Multi-flash mode only for devices that are not required to gain access to other parts of the architecture.

IMPORTANT

When flashing a network communication device, for example, Ethernet, ControlNet, DeviceNet, SERCOS, always disable MultiFlash by setting it to 0. When flashing I/O modules, enable the MultiFlash by setting it to 1.

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

31

Chapter 5

Use the Command Line

Entry Version AbortOnFail

Description Version of the script file. When flashing a device failed: 0 = continue flashing the remaining devices. 1 = stop flashing the remaining devices. If a device to flash already has the matching firmware as stated in the script: 0 = do not skip flashing the device. 1 = skip flashing the device. Flash the first # of devices in this script file, begin with [Device1]. 0 = ControlFLASH console window appears on screen and shows the flash progress. 1 = ControlFLASH console window does not appear on screen. You will not receive any flash status feedback. 0 = flash only one device at a time. 1 = flash up to five devices concurrently. Catalog number of device as registered with the current installed ControlFLASH software. To identify installed kits, refer to the GUI version of ControlFLASH software. For example: 1756-L63/A Firmware revision you need to flash the device to. This revision must be registered for this device with the current install of the ControlFLASH software. To identify installed kits, refer to the GUI revision of ControlFLASH software. For example: 16.23 FactoryTalk RSLinx path to the target device. AB_PCIC-1 2 2 1 7 |_______| | | | |___Node address | | | |_____Backplane | | |__ ____PCICS Communication card address | |________ControlNet cable address |____________PCICS driver name AB_ETH-2,192.168.1.4,1,7 |______| |_______| | |__Node Address | | |___ Backplane | |_________IP address |________________ Ethernet driver name

SkipOnFirmwareMatch

NumberDevices SilentMode

MultiFlash Catalog

Revision

Path

32

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

Use the Command Line

Chapter 5

Example Script File Text

[FlashScript] Version = 0.1 AbortOnFail = 1 SkipOnFirmwareMatch = 0 NumberDevices = 4 SilentMode = 0 MultiFlash = 0 [Device1] Catalog Revision Path [Device2] Catalog Revision Path [Device3] Catalog Revision Path [Device4] Catalog Revision Path [Device5] Catalog Revision Path = 1756-ENBT = 3.3.7 = AB_ETH-1,192.168.166.7,0 1,1 = 1756-CNBR/D = 5.45.10 = AB_ETH-1,192.168.166.7,0 1,2 = 1756-ENBT = 3.3.7 = AB_ETH-1,192.168.166.7,0 1,3 = 1756-DNB = 6.2.1 = AB_ETH-1,192.168.166.7,0 1,4 = 1756-CNBR/D = 5.45.10 = AB_ETH-1,192.168.166.7,0 1,5

Example Script File Text for Instance Number

[FlashScript] Version = 0.1 AbortOnFail = 0 SkipOnFirmwareMatch = 0 NumberDevices = 1 SilentMode = 0 MultiFlash = 0 [Device1] Catalog = PowerFlex 70 Revision = 2.9 Path = AB_ETH-1, 10.108.90.43 Instance = 1

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

33

Chapter 5

Use the Command Line

Troubleshooting

The first step to finding errors in your application is to use the ControlFLASH software log file. This file provides details about why your flashing script or command line request did not complete. This log file resides in the ControlFLASH directory. Before you spend a lot of time analyzing the log file however, make sure that you check the following: Target devices you are flashing have the correct firmware kit installed. ControlFLASH software has the correct RSLinx communication paths set up. The catalog number in your application matches the number in the ControlFLASH GUI.

Error Log
You can open the Error Log by clicking View Log on the ControlFLASH software dialog boxes.

Aborted Script File

If you have to abort a script file before completion or if the ControlFLASH software aborted the script because it received an error from a device, you can restart that script. ControlFLASH starts flashing from the beginning of the script. You can, however, use the SkipOnFirmwareMatch switch to tell ControlFLASH software to not flash any devices that are already at the requested revision.

34

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

Use the Command Line

Chapter 5

Stop a Command Line or Script Application

If you need to stop a flash operation that has already started, press CTRL+ALT+F. ControlFLASH stops executing the current script. ControlFLASH completes flashing any devices currently in the process of being flashed to prevent risk of damaging the target device. Other modules not started in the script are not flashed. If you are using your own interface to send commands to ControlFLASH, such as a script or C# application, pressing CTRL+ALT+F may not abort the operation and you must manage abort operations by using your application. Refer to the developer of that application for information on how to perform an abort.

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

35

Chapter 5

Use the Command Line

36

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

Chapter

ControlFLASH and Factory Talk AssetCentre Interaction

Introduction

ControlFLASH uses FactoryTalk AssetCentre to log user actions such as flashing a device or starting the application. The following information is included in the log: Windows credentials Device being flashed Path to the device being flashed Status of the operation The following information is also available in the ControlFLASH log file, as it was in previous versions.

Information Monitoring

In FactoryTalk-enabled software products, information such as system events and user actions are recorded in the Event Log and Audit Log.

Event Log
The Event Log displays database information regarding events that occur in the system. Events are generally system-initiated. For example, an upload occurred as scheduled, or an alarm condition occurred. Only events that occur in FactoryTalk-enabled products are recorded in the Event Log.

Audit Log
The Audit Log displays database information regarding actions that users perform in the system, such as editing an RSLogix 5000 project or checking-out a file from the FactoryTalk AssetCentre database. Audit records are generated by FactoryTalk-enabled products.

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

37

Chapter 6

ControlFLASH and Factory Talk AssetCentre Interaction

FactoryTalk AssetCentre

FactoryTalk AssetCentre offers a centralized repository for tracking and auditing the changes made to a plant-wide system. Any information related to an application is logged in to the FactoryTalk AssetCentre server. The details of the log usually contain the following fields: Date/Time User Name User Description (full user name, based on user information held in a security token or domain name; required for audit messages) Severity of message (error, warning, information, audit) Audience for message (operator, engineer, developer, FactoryTalk AssetCentre) Message text (text or resource ID that resolves to text when retrieved or passed between machine boundaries) Argument list (optional placeholders in message text) Any additional details, apart from the basic fields listed here, can also be logged on to FactoryTalk AssetCentre server. For example, the resource field of the Audit log is not a part of the basic message format and is considered an additional field. The following ControlFLASH activities are logged: Launch of ControlFLASH Flash burn started. Includes the following details: Date/Time the flash began Firmware Revision, both From and To Username Path to the device being flashed Device Target Module Name and Identifier Flash Burn Status (Success/Failure) Exit of ControlFLASH The ControlFLASH activities are logged only if the client is properly configured with FactoryTalk AssetCentre server. ControlFLASH logs the current windows user login. ControlFLASH software activities are logged into the log_AuditEventLog table of the FactoryTalk AssetCentre server. If the connection between the client and server is lost while ControlFLASH is used, all of the events are cached into a local log and are then updated into FactoryTalk AssetCentre server when the connection resumes.

38

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

ControlFLASH and Factory Talk AssetCentre Interaction

Chapter 6

The connectivity of the client to FactoryTalk AssetCentre server, if present, is identified with the help of the following registry entry. HKEY_LOCAL_MACHINE\SOFTWARE\Rockwell Software\ FactoryTalk AssetCentreClient\EventLog Key- Server Value- (Server Name) This registry search is done during the launch of the ControlFLASH application.

Logging the Device Update Status

The update status (Success or Failure) is logged into the FactoryTalk AssetCentre server. You can view the reasons for the Success or Failure in the ControlFLASH log. The status of the update process is logged into FactoryTalk AssetCentre with the following details:
Field Date and Time Source Location Resource Username Message Text Description Date and Time at which the update process has finished for the device. Application name, for example, ControlFLASH Computer name on which ControlFLASH is being executed. Name of the resource that is ControlFLASH. FTAssetSecurity Login, if present, else Windows login If update succeed: The device "device name" is SUCCESSFULLY updated from version "x.x" to "y.y" and the path to the device being flashed is "device path. If update failed: The update process of the device "device name" from version x.x to y.y FAILED and the path to the device being flashed is "device path.

Logging the Exit of ControlFLASH

When you exit ControlFLASH, a message is created and logged into the FactoryTalk AssetCentre Event Log with the following details.
Field Date and Time Source Location Resource Username Message Text Description Date and Time at which ControlFLASH application is closed. Application name, for example, ControlFLASH Computer name on which ControlFLASH is closed. Name of the resource, for example, ControlFLASH. FTAssetSecurity Login, if present, otherwise Windows login. ControlFLASH application closed.

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

39

Chapter 6

ControlFLASH and Factory Talk AssetCentre Interaction

40

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

Appendix

ControlFLASH Software Error Codes

Introduction

This appendix describes common error messages you may see when running the ControlFLASH software.
Error Message Log Viewer Error The event log viewer (Notepad.exe) could not be found Catalog Registry Error Load Driver Error Description Verify that the Notepad application is installed on your system. The catalog registry database could not be read. Check with your technical support representative to verify that the correct database is loaded. The ControlFLASH software could not find an essential support file for the selected catalog number. Check with your technical support representative to verify that the correct drivers is loaded. The catalog number of the target device you selected does not match the catalog number selected in the Catalog Number dialog box. You selected an incorrect target device or catalog number. Select a device that matches the catalog number or a different catalog number The catalog directory database could not be read. Check with a technical support representative to verify that the correct catalog database has been loaded. The upgrade revision selected is not compatible with the selected target device. The selected firmware revision is either: older than the firmware currently on the target device. incompatible with the revision level of the target device. ATTENTION: Do not continue with the upgrade until you have verified that the upgrade is compatible with the selected device. Unpredictable system operation could result. The target device did not report enough information to be properly identified. Check with a technical support representative for help in resolving this problem. The script file associated with the selected upgrade is corrupt. Check with a technical support representative to obtain a new script file. The data file used in programming could not be read. Check with a technical support representative to obtain a new data file. Your system is low on or out of RAM memory. The ControlFLASH software could not allocate enough memory for data. Free up RAM space by: Shutting down other applications currently running. Increasing the size of your virtual memory. Purchasing additional RAM, if necessary.

Invalid Catalog Number

Catalog Directory Error

Invalid Revision

Instance Validation Error

Script File Error Data File Error Out of Memory Error

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

41

Appendix A

ControlFLASH Software Error Codes

Error Message Out of Memory Error Log File Error

Description The log file could not be accessed because of a file error. Either the log file could not be: Opened. Written to because of an error. Written to because the disk is full. ATTENTION: Check with your application engineer or supervisor before deleting any files. Verify that you are not deleting any files necessary for system operation. If the disk is full, you can free up disk space by: Deleting files from your c:\windows\temp directory. Uninstalling any unnecessary applications. Shutting down and restarting your computer. The download restrictions placed on the selected revision could not be validated. Files containing validation information are corrupted or have been deleted. Check with a technical support representative for help in restoring your restriction files. The download restriction system could not read the master key disk. Check with a technical support representative for help in resolving this problem. An error occurred while the ControlFLASH software tried to install the network protocol driver (DTL32.DLL). Verify that RSLinx Classic software is properly installed and configured. An error occurred while the ControlFLASH software tried to communicate with the target device. Verify that: All cable connections are secure. The target device has power. RSLinx Classic software is properly configured.

Authenticate Error

Restriction System Error RSLinx Load Error

Communication Error

Mode Error Failed to communicate to the target device. You do not have the permission to perform this operation.

The target device is in a mode in which it cannot be programmed. Place the device into the appropriate mode. The error might be caused because that: The security authority identifier of the target device does not match the identifier in FactoryTalk Services Platform. Make sure you have the permission to perform the operation. The slot used for the controller is not a trusted slot. Make sure to use a trusted slot for the controller.

42

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

Appendix

Create a Custom Interface to Process Firmware Downloads

Introduction

This chapter gives you an overview on how you can create a custom interface to batch process firmware downloads. As discussed in previous chapters, you can automate firmware flashing by using a text file that lists devices and single command line. Create a text file that lists all the devices to be flashed and then use a single command line to flash everything on the list. This functionality provides the following benefits: Flash groups of devices automatically, without having to repeatedly use the ControlFLASH menus. Create your own applications that automates firmware upgrades.

Example Automated Flash Tool

The following example application represents a tool that you might want to create to configure ControlFLASH to read the text file at a command line that automates your system upgrades. This tool was created with Visual Basic .NET. In this type of custom tool, select the ControlFLASH Setup tab.

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

43

Appendix B

Create a Custom Interface to Process Firmware Downloads

Using the fields created, specify the path to the ControlFLASH executable, as well as the text script files you want to use.

This example uses separate script files to flash controllers, I/O modules, communication modules, and drives, but it is not required that they be separated. Assuming that the location of the executable and the script files do not change, these configurations need to be set only once. After configuration completes, click the Run Updates tab and select the actions that you want to perform, which include four boxes for the four different script files. Click Execute to run the selected actions.

44

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

Create a Custom Interface to Process Firmware Downloads

Appendix B

While modules are flashing, the tool displays the progress on the right hand side of the window and success or failure messages in the status box at the bottom.

Once all selected upgrades are run, the status box shows the overall completion status.

How a Custom Upgrade Tool Works

The tool in this example was created using Visual Basic .net, but any major programming language can be used. The script files are created manually in a text editor. The tool itself first reads the script file to get the number of devices being flashed, including the names and revision numbers. The tool uses this information to form the display.

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

45

Appendix B

Create a Custom Interface to Process Firmware Downloads

The tool then uses the System.Diagnostics.Process.Start function of the .NET framework to launch ControlFLASH software, giving as the arguments the path to the script file with a -T flag in front of it. Example: fileName = "C:\Program Files\ControlFLASH\ControlFLASH.exe" arguments = "-T C:\samplescript.txt" The tool then monitors the ControlFLASH process to detect when it has finished running so the tool can move on to the next step. The easiest way to view the status of the flash upgrade by using this method is to edit the ControlFLASH script file and set SilentMode = 0 to use ControlFLASH softwares built in status display. If developers want to show the progress themselves, as the example tool does, they can use the registered window messages to show progress with external applications. Some knowledge of Microsoft Windows messages is needed. ControlFLASH registers two Windows messages: WM_CFPROGRESS and WM_CFCOMPLETE. The WM_CFPROGRESS message is sent whenever ControlFLASH needs to report a change in progress of flashing a device. The WM_CFCOMPLETE message is sent whenever ControlFLASH finishes flashing a device. These messages can be received by any application that also registers messages of the same name. Refer to MSDN: http://msdn.microsoft.com/en-us/library/ ms644947(VS.85).aspx where lpString is WM_CFPROGRESS or WM_CFCOMPLETE

Example Visual Basic .NET Code

Private Declare Function RegisterWindowMessage Lib "user32" Alias "RegisterWindowMessageA" _ (ByVal lpString As String) As Integer Dim WM_CF_PROGRESS As Integer = RegisterWindowMessage("WM_CFPROGRESS") Dim WM_CF_COMPLETE As Integer = RegisterWindowMessage("WM_CFCOMPLETE") WM_CF_PROGRESS and WM_CF_COMPLETE are simply variable names used to store the integer values associated with the messages.

46

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

Create a Custom Interface to Process Firmware Downloads

Appendix B

After registering the two messages, an application must override the form's WndProc method to actually listen for these messages For more information, see MSDN: http://msdn.microsoft.com/en-us/library/ system.windows.forms.form.wndproc(VS.71).aspx Example: Protected Overrides Sub WndProc(ByRef recWinMessage As Windows.Forms.Message) In WndProc, you first need to determine if the message received is one of the two registered ones. This is done by checking (in this example): recWinMessage.Msg = WM_CF_PROGRESS (as defined in the above example) or recWinMessage.Msg = WM_CF_COMPLETE Assuming the message is one of the two, the details of what the message means are as follows: If the message is WM_CFPROGRESS: recWinMessage.WParam.ToInt32 is the number of the device currently being flashed. These numbers should correspond to the numbers listed in the script file recWinMessage.LParam.ToInt32 is the actual progress of the current device (as a percentage). Because of the way the system is designed, if recWinMessage.LParam.ToInt32 is 100, that does not mean the flashing of that device is complete. Flashing is only complete when the WM_CFCOMPLETE message is sent. If the message is WM_CFCOMPLETE: recWinMessage.WParam.ToInt32 is still the number of the device recWinMessage.LParam.ToInt32 indicates success or failure. If the value is 1, the flash succeeded; if 0, it failed. For more information, see MSDN http://msdn.microsoft.com/en-us/library/ system.windows.forms.message_members(VS.71).aspx

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

47

Appendix B

Create a Custom Interface to Process Firmware Downloads

In this tool, the progress messages are used to set the values of the progress bars, and the complete messages are used to trigger the success and failure status messages in the lower status box.
IMPORTANT At the end of your override of the WndProc method, you must call the base class' WndProc method to handle any other messages sent, or your application will not work. Example: MyBase.WndProc(recWinMessage) End Sub

48

Rockwell Automation Publication 1756-UM105E-EN-E - October 2012

Rockwell Automation Support

Rockwell Automation provides technical information on the Web to assist you in using its products. At http://www.rockwellautomation.com/support/, you can find technical manuals, a knowledge base of FAQs, technical and application notes, sample code and links to software service packs, and a MySupport feature that you can customize to make the best use of these tools. For an additional level of technical phone support for installation, configuration, and troubleshooting, we offer TechConnect support programs. For more information, contact your local distributor or Rockwell Automation representative, or visit http://www.rockwellautomation.com/support/.

Installation Assistance
If you experience a problem within the first 24 hours of installation, review the information that is contained in this manual. You can contact Customer Support for initial help in getting your product up and running.
United States or Canada Outside United States or Canada 1.440.646.3434 Use the Worldwide Locator at http://www.rockwellautomation.com/support/americas/phone_en.html, or contact your local Rockwell Automation representative.

New Product Satisfaction Return

Rockwell Automation tests all of its products to ensure that they are fully operational when shipped from the manufacturing facility. However, if your product is not functioning and needs to be returned, follow these procedures.
United States Outside United States Contact your distributor. You must provide a Customer Support case number (call the phone number above to obtain one) to your distributor to complete the return process. Please contact your local Rockwell Automation representative for the return procedure.

Documentation Feedback
Your comments will help us serve your documentation needs better. If you have any suggestions on how to improve this document, complete this form, publication RA-DU002, available at http://www.rockwellautomation.com/literature/.

Rockwell Otomasyon Ticaret A.., Kar Plaza Merkezi E Blok Kat:6 34752 erenky, stanbul, Tel: +90 (216) 5698400

Publication 1756-UM105E-EN-E - October 2012 50

Supersedes Publication 1756-UM105D-EN-E - April 2012 Copyright 2012 Rockwell Automation, Inc. All Rights Reserved. Printed in the U.S.A.