ControlFLASH Firmware

Upgrade Kit

Quick Start
(Catalog Numbers ControlFLASH 7.0)
Important User Information
Solid state equipment has operational characteristics differing from those of electromechanical equipment. Safety Guidelines for the Appli-
cation, 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 also because of the wide variety of uses for solid state equipment, all persons re-
sponsible 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 as-
sociated with any particular installation, Rockwell Automation, Inc. cannot assume responsibility or liability for actual use based on the ex-
amples 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

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

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

Identifies information about practices or circumstances that can lead to personal injury or death,
ATTENTION
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.

Allen-Bradley, Rockwell Automation, ControlFLASH, 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
What’s New in ControlFLASH Software, Version 7.0 . . . . . . . . . . . . . 5
Who Should Use This Manual. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Chapter 1
Upgrading Your Firmware with Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
ControlFLASH Software What is ControlFLASH Software? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
What is the ControlFLASH Firmware Upgrade Kit?. . . . . . . . . . . . . . . 7
What are the System Requirements? . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
RSLinx Software. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Before You Begin to Use the ControlFLASH Firmware Upgrade Kit . 8

Chapter 2
Installing the ControlFLASH Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Firmware Upgrade Kit Navigate to Download Firmware Bundles . . . . . . . . . . . . . . . . . . . . . . . 9
Install the ControlFLASH Firmware Upgrade Kit. . . . . . . . . . . . . . . . 10

Chapter 3
Using the ControlFLASH Software Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
to Upgrade Firmware Prepare the Networks for Upgrades . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Prepare the Device for Upgrades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Use the ControlFLASH Software to Upgrade Firmware. . . . . . . . . . . 16
Accessing the ControlFLASH Software Online Help . . . . . . . . . . . . . 23

Chapter 4
Using the Command Line to Update Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Firmware Command Line Mode for ControlFLASH Software, Version 7.0 . . . 26
Compatible Devices. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Device Catalog Numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Finding Required Firmware Kits. . . . . . . . . . . . . . . . . . . . . . . . . . . 26
ControlFLASH Software Install Location . . . . . . . . . . . . . . . . . . . 26
Command Line Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Script Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Flashing Multiple Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Example Script File Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Error Log Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Aborted Script File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Stopping a Command Line or Script Application . . . . . . . . . . . . . 33

3Publication 1756-QS105C-EN-E - August 2008 3

Table of Contents

Appendix A
ControlFLASH Software Error Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Messages
Appendix B
Creating a Custom Interface to Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Process Firmware Downloads Example Automated Flash Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
How a Custom Upgrade Tool Works. . . . . . . . . . . . . . . . . . . . . . . 40
Example Visual Basic .NET Code . . . . . . . . . . . . . . . . . . . . . . . . . 40
Rockwell Automation Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Installation Assistance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
New Product Satisfaction Return . . . . . . . . . . . . . . . . . . . . . . . . . . 45

4 Publication 1756-QS105C-EN-E - August 2008

 Preface

Purpose of This Manual This manual describes how you can use the ControlFLASH software to
upgrade device firmware.

What’s New in There are two new features to ControlFLASH software, version 7.0.
ControlFLASH Software, • Use the command line to flash a single module.
Version 7.0 • Use a script file to flash multiple modules. The ability to flash multiple
modules automatically is a significant time saver because you no longer
need to navigate through the software and select each module to flash.

Who Should Use You should use this manual if you need to maintain firmware revisions. The
following is a list of hardware that the ControlFLASH software supports:
This Manual
• 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

You should also:

• have a basic understanding of networking concepts.

• have a basic familiarity of RSLinx Classic software.

5Publication 1756-QS105C-EN-E - August 2008 5

Notes:

6 Publication 1756-QS105C-EN-E - August 2008

 Chapter 1

Upgrading Your Firmware with ControlFLASH

Software

Introduction This chapter helps you to get started with using the ControlFLASH Firmware
Upgrade Kit with your application.

This chapter:

• describes the ControlFLASH software programming tool and the parts

of the kit.
• describes system requirements.
• tells you what to do before you begin.
• tells you where to go for more information.

What is ControlFLASH The ControlFLASH software is an application that lets you quickly upgrade
hardware firmware.
Software?

What is the ControlFLASH The ControlFLASH Firmware Upgrade Kit includes the:
Firmware Upgrade Kit? • firmware of device (s) to be upgraded.
• ControlFLASH programming tool, along with its support drivers and
online help.
• Quick Start.

What are the System To use the ControlFLASH Firmware Upgrade Kit, your system must be at this
minimum configuration:
Requirements?
• Personal computer with at least a 486 processor
• Windows 2000, NT, VISTA, or XP operating systems
• RSLinx Classic Lite software, or better

RSLinx Software You need to have at least RSLinx Classic Lite software installed before you
install the ControlFLASH software. RSLinx software, is a communication
package that you can use with a wide variety of Rockwell Automation software,
applications, and hardware.

7Publication 1756-QS105C-EN-E - August 2008 7

1 Upgrading Your Firmware with ControlFLASH Software

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 documentation (printed or online) that came with your RSLinx software
package. If RSLinx software is already installed on your computer, you may not
need to install it now.

Before You Begin to Use the Before you start using the ControlFLASH Firmware Upgrade Kit, you need
to:
ControlFLASH Firmware
Upgrade Kit • 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.

8 Publication 1756-QS105C-EN-E - August 2008

 Chapter 2

Installing the ControlFLASH Firmware

Upgrade Kit

Introduction This chapter explains how to install the ControlFLASH software and
download firmware bundles. A version of ControlFLASH software is installed
when you install RSLogix5000. 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
will be required to register a username and password as well as provide a serial
number of a Logix5000 product.
A downloaded bundle contains these files:
• Firmware to upgrade your devices
• ControlFLASH executable file
• ControlFLASH drivers
• ControlFLASH online help

Navigate to Download Follow these instructions to locate firmware bundles.

Firmware Bundles 1. Go to http://support.rockwellautomation.com/firmware.asp.

2. Click on Control Hardware.

3. Enter your username and password. If you have not registered, do so.
You will need to have a serial number for a Logix5000 product.

9Publication 1756-QS105C-EN-E - August 2008 9

2 Installing the ControlFLASH Firmware Upgrade Kit

The Flash Firmware Updates page displays.

4. Scroll down to find the firmware bundle you need, for example, the
1756-L64, series B controller.

5. Click on the disk icon.

6. Enter your serial number and you’ll be able to browse to a location

where you can save the firmware bundle.

Install the ControlFLASH Follow these steps to install a ControlFLASH Firmware Upgrade Kit.
Firmware Upgrade Kit
IMPORTANT The illustrations of the ControlFLASH software dialog boxes
shown in this manual are samples. Because your system
configuration is unique or the firmware kits are different, the
dialog boxes you see when running the tool may be different
from the ones you see here.

You will have the software on a release CD or you have downloaded the
software as part of the firmware bundle. 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

10 Publication 1756-QS105C-EN-E - August 2008

 Installing the ControlFLASH Firmware Upgrade Kit 2

of ControlFLASH attached, then the newer version will be installed. If you

select a firmware bundle that has an older version of ControlFLASH attached,
the newer version that is already installed will remain. In all cases, any
previously installed firmware will remain accessible.

1. Browse to the location of the firmware kit install .msi file.

The location and name of the file depends on where you saved the file
and what you named it when you saved it.
2. Double-click the icon or select Start -> Run -> Browse -> location of
the firmware .msi file.

3. Click Next.
4. Read and agree to the license and click Next.

Publication 1756-QS105C-EN-E - August 2008 11

2 Installing the ControlFLASH Firmware Upgrade Kit

5. Click Browse to select the location of the installation.

The default location is C:\Program Files\ControlFLASH\.

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

7. Confirm installation and click Next

12 Publication 1756-QS105C-EN-E - August 2008

 Installing the ControlFLASH Firmware Upgrade Kit 2

ControlFLASH software installs.

Installation completes.

8. Click Close to finish installation.

Publication 1756-QS105C-EN-E - August 2008 13

2 Installing the ControlFLASH Firmware Upgrade Kit

Notes:

14 Publication 1756-QS105C-EN-E - August 2008

 Chapter 3

Using the ControlFLASH Software to Upgrade

Firmware

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

This chapter:

• tells you what to do before you begin.

• describes how to run the ControlFLASH software.
• describes online help.

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 Follow this procedure to prepare the network for updating.
Upgrades
ATTENTION You cannot perform this 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.

15Publication 1756-QS105C-EN-E - August 2008 15

3 Using the ControlFLASH Software to Upgrade Firmware

2. Shut down the production line only if the device does not support
removal/insertion under power (RIUP).

To find out if 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 Follow this procedure to prepare the device for updating.
Upgrades
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.

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

3. Turn on power to the processor.

Use the ControlFLASH Follow these steps to use the ControlFLASH software to upgrade the
firmware on your devices.
Software to Upgrade
Firmware 1. Run the ControlFLASH software by using one of the following
methods:

• Double-click the ControlFLASH icon on your desktop.

• Click Start>Programs>Flash Programming Tools>ControlFLASH.

16 Publication 1756-QS105C-EN-E - August 2008

 Using the ControlFLASH Software to Upgrade Firmware 3

The Welcome dialog box displays.

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

TIP A ControlFLASH menu is located in the upper left hand

corner of the screen.

Right-click on the
ControlFLASH Icon.

Publication 1756-QS105C-EN-E - August 2008 17

3 Using the ControlFLASH Software to Upgrade Firmware

2. When you have gathered your information, click Next.

The Catalog Number dialog box displays.

3. Select the catalog number of the device and current firmware revision
you are updating and click Next.

The ControlFLASH software accesses RSWho browser

18 Publication 1756-QS105C-EN-E - August 2008

 Using the ControlFLASH Software to Upgrade Firmware 3

4. Select the device you want to upgrade.

5. Double-click the device.

6. Click Next.

7. Select the correct revision for this upgrade and click Next.

ATTENTION Be sure that this upgrade is the correct one to make for your
device. If it is not, unpredictable system operation could result.
Contact your technical support specialist for more information.

8. Choose the location of the firmware kit.

Publication 1756-QS105C-EN-E - August 2008 19

3 Using the ControlFLASH Software to Upgrade Firmware

The Summary dialog box displays.

9. Click More Info to review more about the revision you selected.

10. Click Finish when you are ready to upgrade the device.

11. Click Yes to continue with the update.

12. Click Yes if you are sure you want to upgrade the target device.

20 Publication 1756-QS105C-EN-E - August 2008

 Using the ControlFLASH Software to Upgrade Firmware 3

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.
If you interrupt the firmware upgrade in the software or by
disturbing the physical media, you may render the packaged
controller inoperable.
For more information about upgrading your CompactLogix
packaged controller firmware, see the Technical Note ID# 53989
at: http://www.rockwellautomation.com/knowledgebase/.

IMPORTANT Interrupting the upgrade at this point may result in an

inoperable product. Allow the upgrade to continue without
interruption.

After the upgrade, the Update Status dialog box displays.

13. Click OK.

Publication 1756-QS105C-EN-E - August 2008 21

3 Using the ControlFLASH Software to Upgrade Firmware

14. Click View Log for a history of programming events in Notepad.

15. Click OK.

TIP If the upgrade does not complete successfully, refer to

Appendix A of this manual for more information about errors.

The upgrade is now complete.

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

22 Publication 1756-QS105C-EN-E - August 2008

 Using the ControlFLASH Software to Upgrade Firmware 3

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

For additional information about error messages, press F1 while the

ControlFLASH software displays the error message.

Publication 1756-QS105C-EN-E - August 2008 23

3 Using the ControlFLASH Software to Upgrade Firmware

Notes:

24 Publication 1756-QS105C-EN-E - August 2008

 Chapter 4

Using the Command Line to Update Firmware

Introduction This chapter explains how to use the command line to update module
firmware and simplify firmware management. You can flash a single module or
multiple modules from a script file. The ability to flash multiple modules
automatically is a significant time saver because you no longer 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 can flash upgrade groups of devices

automatically without having to repeatedly use the ControlFLASH
menus. They can be scripts or VB applications that list the modules to
flash, firmware revisions, and path requirements.
• Reduce training requirements of technicians and improve time to
commission a machine or performing field upgrades.
• Multi-threaded to allow ControlFLASH software to flash up to five
modules simultaneously for improved performance.

25Publication 1756-QS105C-EN-E - August 2008 25

4 Using the Command Line to Update Firmware

Command Line Mode for ControlFLASH software, version 7.0 lets you use the command line interface
for flashing devices without user intervention. You can write a script file or
ControlFLASH Software, some other Windows application that passes the required parameters to
Version 7.0 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.

Compatible Devices

Any device that you can flash with ControlFLASH software, version 7.0 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.

Device Catalog Numbers

You must use valid catalog numbers when developing your script files. If you
don’t ControlFLASH will 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.

Finding Required Firmware Kits

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.

ControlFLASH Software Install Location

You must have a valid installation of ControlFLASH software, version 7.0 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.

26 Publication 1756-QS105C-EN-E - August 2008

 Using the Command Line to Update Firmware 4

Command Line Syntax

The following are the command line usages.

Usage 1

ControlFlash.exe -C <Catalog> -R <Revision> -P <Path> [-K] [-S]

Usage 2

ControlFlash.exe -F <Filename>

Usage 3

ControlFlash.exe -?

Parameter Options

Parameter Description
-C Catalog number of device as registered with the current installed
ControlFLASH software. To identify installed kits refer to the GUI
version of ControlFLASH software. Example: -C 1756-L63/A
-R 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. Example: -R 16.23
-P 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
-F Full path name to script file where target devices and options are
specified. Example: -F MyScript.txt

Refer to Script Files on page 28.

Publication 1756-QS105C-EN-E - August 2008 27

4 Using the Command Line to Update Firmware

Parameter Options

Parameter Description
[-K] 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

device’s firmware is already at the requested firmware revision.
[-S] 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.
-? Display help information.

You can use the ControlFLASH.exe with the required and optional
parameters at the command line:
C:\Program Files\ControlFLASH\Controlflash
followed by the appropriate parameters.

ControlFLASH software displays a status window indicating the

progress. Both the command line and scripting versions provide a
switch ( [-S] )to disable this function and run in Silent mode.

ATTENTION If you disable this status window, there will be no visual

indication that a flash operation has failed or that one is in
progress. We recommended that if you disable the status
window that you also provide some other form of user
interaction through your own application that provides
status.

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 need to flash must have a unique Device#.
ControlFLASH software begins flashing devices with [Device1], [Device2],
and so forth. The software will flash 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 doesn't matter, as long as each
number exists once in the file. In this example, NumberDevices = 4 so
[Device5] will not be flashed.

28 Publication 1756-QS105C-EN-E - August 2008

 Using the Command Line to Update Firmware 4

Flashing 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 a return to the factory.
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.

Publication 1756-QS105C-EN-E - August 2008 29

4 Using the Command Line to Update Firmware

Entry Description
Version Version of the script file.
AbortOnFail When flashing a device failed:
0 = continue flashing the remaining devices.
1 = stop flashing the remaining devices.
SkipOnFirmwareMatch 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.
NumberDevices Flash the first # of devices in this script file, begin with
[Device1].
SilentMode 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.
MultiFlash 0 = flash only one device at a time.
1 = flash up to five devices concurrently.

30 Publication 1756-QS105C-EN-E - August 2008

 Using the Command Line to Update Firmware 4

Entry Description
Catalog Catalog number of device as registered with the current
installed ControlFLASH software. To identify installed kits refer
to the GUI version of ControlFLASH software. Example:
1756-L63/A
Revision 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. Example: 16.23
Path 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

Publication 1756-QS105C-EN-E - August 2008 31

4 Using the Command Line to Update Firmware

Example Script File Text

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

Troubleshooting The first step to finding errors in your application is to use the ControlFLASH
software log file. This file provides details as to the 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 proper RSLinx communication paths
set up.
• The catalog number in your application matches in the ControlFLASH
GUI.

32 Publication 1756-QS105C-EN-E - August 2008

 Using the Command Line to Update Firmware 4

Error Log Example

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
re-start that script. ControlFLASH will start 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.

Stopping a Command Line or Script Application

If you need to stop a flash operation that has already started: press <Ctrl C>.
This tells the ControlFLASH software to stop executing the current script.

ControlFLASH software will complete 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 will not be flashed.

If you are using your own interface to send commands to ControlFLASH

software, like a script or C# application, you must manage abort operations by
using that application and pressing Ctrl+C may not abort the operation. Refer
to the developer of that application for information on how to perform an
abort.

Publication 1756-QS105C-EN-E - August 2008 33

4 Using the Command Line to Update Firmware

Notes:

34 Publication 1756-QS105C-EN-E - August 2008

 Appendix A

ControlFLASH Software Error Messages

Introduction This appendix describes common error messages you may see when running
the ControlFLASH software.

Error Message Description

Log Viewer Error The Verify that the Notepad application has been installed on
event log viewer your system.
(Notepad.exe) could not
be found
Catalog Registry Error The catalog registry database could not be read. Check
with your technical support representative to verify that
the correct database has been loaded.
Load Driver Error 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 have been loaded.
Invalid Catalog Number 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
Catalog Directory Error The catalog directory database could not be read. Check
with a technical support representative to verify that the
correct catalog database has been loaded.
Invalid Revision 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.
Instance Validation Error The target device did not report enough information to be
properly identified. Check with a technical support
representative for help in resolving this problem.
Script File Error The script file associated with the selected upgrade is
corrupt. Check with a technical support representative to
obtain a new script file.

35Publication 1756-QS105C-EN-E - August 2008 35

A ControlFLASH Software Error Messages

Error Message Description

Data File Error The data file used in programming could not be read.
Check with a technical support representative to obtain a
new data file.
Out of Memory Error 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.
Out of Memory Error Log The log file could not be accessed because of a file error.
File Error Either the log file:

• could not be opened.

• could not be written to because of an error.
• could not be 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.
Authenticate Error 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.
Restriction System Error The download restriction system could not read the
master key disk. Check with a technical support
representative for help in resolving this problem.
RSLinx Load Error 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.
Communication Error 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.
Mode Error The target device is in a mode in which it cannot be
programmed. Place the device into the appropriate mode.

36 Publication 1756-QS105C-EN-E - August 2008

 Appendix B

Creating 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, ControlFLASH software lets you automate

firmware flashing by using a text file that lists devices and single command
line. First you 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 these 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 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
Tool automates your system upgrades. This tool was created with Visual Basic.NET.

In this type of custom tool, you would select the ControlFLASH Setup tab.

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

37Publication 1756-QS105C-EN-E - August 2008 37

Appendix B Creating a Custom Interface to Process Firmware Downloads

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 being configured, you go
to the Run Updates tab and select which actions you want to perform, which
include four boxes for the four different script files. You would click Execute
to run the selected actions.

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.

38 Publication 1756-QS105C-EN-E - August 2008

 Creating a Custom Interface to Process Firmware Downloads Appendix B

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

Publication 1756-QS105C-EN-E - August 2008 39

Appendix B Creating a Custom Interface to Process Firmware Downloads

How a Custom Upgrade Tool Works

This tool in this example was created by using Visual Basic .net, but any major
programming language could 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.

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 software’s built in status display.

If a developer wants to show the progress themselves, like this example tool
does, there is a way for external applications to show progress, by using
registered window messages, some knowledge of Microsoft Windows
messages would be needed.

ControlFLASH software registers two Windows messages:

WM_CFPROGRESS and WM_CFCOMPLETE. The WM_CFPROGRESS
message is sent whenever ControlFLASH software wants to report a change in
progress of one of the devices it is flashing, and the WM_CFCOMPLETE
message is sent whenever ControlFLASH software 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

40 Publication 1756-QS105C-EN-E - August 2008

 Creating a Custom Interface to Process Firmware Downloads Appendix B

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.

After registering those two messages, an application must override the form's
WndProc method to actually listen for these messages

Refer to MSDN:
http://msdn.microsoft.com/en-us/library/system.windows.forms.form.wndp
roc(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 those two, then 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/failure. If the value is 1, the

flash succeeded; if 0, it failed.

Publication 1756-QS105C-EN-E - August 2008 41

Appendix B Creating a Custom Interface to Process Firmware Downloads

MSDN:
http://msdn.microsoft.com/en-us/library/system.windows.forms.message_
members(VS.71).aspx

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/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

42 Publication 1756-QS105C-EN-E - August 2008

 How Are We Doing?
Your comments on our technical publications will help us serve you better in the future.
Thank you for taking the time to provide us feedback.

You can complete this form and mail (or fax) it back to us or email us at
[email protected].

Pub. Title/Type ControlFLASH Firmware Upgrade Kit

Cat. No. ControlFLASH 7.0 Pub. No. 1756-QS105C-EN-E Pub. Date August 2008 Part No.

Please complete the sections below. Where applicable, rank the feature (1=needs improvement, 2=satisfactory, and 3=outstanding).
Overall Usefulness 1 2 3 How can we make this publication more useful for you?

1 2 3 Can we add more information to help you?

Completeness
(all necessary information procedure/step illustration feature
is provided)
example guideline other
explanation definition

Technical Accuracy 1 2 3 Can we be more accurate?

(all provided information
is correct) text illustration

Clarity 1 2 3 How can we make things clearer?

(all provided information is
easy to understand)

Other Comments You can add additional comments on the back of this form.

Your Name
Your Title/Function Would you like us to contact you regarding your comments?
Location/Phone ___No, there is no need to contact me
___Yes, please call me
___Yes, please email me at _______________________
___Yes, please contact me via _____________________
Return this form to: Rockwell Automation Technical Communications, 1 Allen-Bradley Dr., Mayfield Hts., OH 44124-9705
Fax: 440-646-3525 Email: [email protected]

Publication CIG-CO521D-EN-P- July 2007

 PLEASE FASTEN HERE (DO NOT STAPLE)

Other Comments

PLEASE REMOVE
PLEASE FOLD HERE

NO POSTAGE
NECESSARY
IF MAILED
IN THE
UNITED STATES

BUSINESS REPLY MAIL

FIRST-CLASS MAIL PERMIT NO. 18235 CLEVELAND OH

POSTAGE WILL BE PAID BY THE ADDRESSEE

1 ALLEN-BRADLEY DR
MAYFIELD HEIGHTS OH 44124-9705
Rockwell Automation Rockwell Automation provides technical information on the Web to assist you
in using its products. At http://support.rockwellautomation.com, you can find
Support 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://support.rockwellautomation.com.

Installation Assistance

If you experience a problem within the first 24 hours of installation, please

review the information that's contained in this manual. You can also contact a
special Customer Support number for initial help in getting your product up
and running.

United States 1.440.646.3434

Monday – Friday, 8am – 5pm EST
Outside United Please contact your local Rockwell Automation representative for any
States technical support issues.

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 Contact your distributor. You must provide a Customer Support case
number (call the phone number above to obtain one) to your distributor
in order to complete the return process.
Outside United Please contact your local Rockwell Automation representative for the
States return procedure.

Publication 1756-QS105C-EN-E - August 2008 45

Supersedes Publication 1756-QS105B-EN-E - July 2008 Copyright © 2008 Rockwell Automation, Inc. All rights reserved. Printed in the U.S.A.