personal injury or death, property damage, or economic loss.
Attentions help you identify a hazard, avoid a hazard, and recognize the consequence.
IMPORTANT
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.
temperatures.
for Personal Protective Equipment (PPE).
Important User Information
Read this document and the documents listed in the additional resources section about installation, configuration, and
operation of this equipment before you install, configure, operate, or maintain this product. Users are required to familiarize
themselves with installation and wiring instructions in addition to requirements of all applicable codes, laws, and standards.
Activities including installation, adjustments, putting into service, use, assembly, disassembly, and maintenance are required to
be carried out by suitably trained personnel in accordance with applicable code of practice.
If this equipment is used in a manner not specified by the manufacturer, the protection provided by the equipment may be
impaired.
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
ATTENTION: Identifies information about practices or circumstances that can lead to personal injury or death, property damage, or economic loss.
Identifies information that is critical for successful application and understanding of the product.
Labels may also be on or inside the equipment to provide specific precautions.
BURN HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that surfaces may reach dangerous
ARC FLASH HAZARD: Labels may be on or inside the equipment, for example, a motor control center, to alert people to potential Arc Flash. Arc Flash
will cause severe injury or death. Wear proper Personal Protective Equipment (PPE). Follow ALL Regulatory requirements for safe work practices and
2 Rockwell Automation Publication CFP-QS001F-EN-E - December 2020
Preface
Start with ControlFLASH Plus
Install ControlFLASH Plus
Explore the ControlFLASH Plus
Browse devices
Table of Contents
Purpose of this manual ............................................................................... 7
Who should use this manual ...................................................................... 7
Access help ................................................................................................... 7
Logging the device update status ...................................................... 70
Appendix A
Rockwell Automation Publication CFP-QS001F-EN-E - December 2020 5
Purpose of this manual
Who should use this manual
Access help
Legal Notices
Preface
This quick start guide describes how to use the ControlFLASH Plus™ software
to upgrade device firmware.
You should use this manual if you need to maintain firmware revisions. Refer
to your product release notes to determine whether it supports firmware
updates via ControlFLASH Plus.
You should also have the following knowledge:
• A basic understanding of networking concepts.
• A basic familiarity of FactoryTalk® Linx™ software.
There is additional information in the help for this application. Access help by
clicking that appears at the top right corner of the ControlFLASH Plus
software window.
Rockwell Automation publishes legal notices, such as privacy policies, license
agreements, trademark disclosures, and other terms and conditions on the
Legal Notices
page of the Rockwell Automation website.
End User License Agreement (EULA)
You can view the Rockwell Automation End User License Agreement (EULA)
by opening the license.rtf file located in your product's install folder on your
hard drive.
The software included in this product contains copyrighted software that is
licensed under one or more open source licenses.
You can view a full list of all open source software used in this product and
their corresponding licenses by opening the index.html file located your
product's OPENSOURCE folder on your hard drive.
Rockwell Automation Publication CFP-QS001F-EN-E - December 2020 7
You may obtain Corresponding Source code for open source packages
included in this product from their respective project web site(s).
Alternatively, you may obtain complete Corresponding Source code by
contacting Rockwell Automation via the Contact form on the Rockwell
Automation website:
http://www.rockwellautomation.com/global/about-
Preface
us/contact/contact.page. Please include "Open Source" as part of the request
text.
8 Rockwell Automation Publication CFP-QS001F-EN-E - December 2020
Important:
ControlFLASH Plus overview
System requirements
Chapter 1
Start with ControlFLASH Plus
This chapter helps you get started with using the ControlFLASH Plus
software.
ControlFLASH Plus™ is a software tool used for electronically changing
firmware revisions in hardware devices. It provides an intuitive, easy-to-use
interface that can:
• Flash one or multiple devices within a single operation.
• Manage firmware revisions and firmware locations.
• Download firmware revisions from the Product Compatibility and
Download Center.
• Manage and use devices' revisions favorites.
ControlFLASH Plus only supports the firmware update for devices
supporting the Common Industrial Protocol (CIP). To perform
updates of non-CIP devices, use the ControlFLASH tool.
ControlFLASH Plus works within the system requirements of all Rockwell
Automation® software products. For the latest information regarding
software platform support, refer to Rockwell Automation
Compatibility and Download Center.
Product
Hardware requirements
• An Intel® Core 2 Duo processor running at 2.8 GHz or faster or another
processor with equivalent specifications
• 4 GB or more memory RAM
• At least 16GB of available hard drive space
Software requirements
Operating systems
ControlFLASH Plus has been tested on 64-bit versions of the following
Windows® operating systems:
• Windows 10
• Windows 10 Enterprise LTSC 2019
• Windows Server® 2019
• Windows Server 2012 R2
Rockwell Automation Publication CFP-QS001F-EN-E - December 2020 9
Chapter 1 Start with ControlFLASH Plus
• Windows Server 2012
• Windows Server 2016
Rockwell Automation Test Environment
Rockwell Automation tests software products under a standard configuration
of operating systems and antivirus software. For additional information see
the Knowledgebase Document ID:
PN24 - Rockwell Software Products and
Antivirus Software.
Additional software
The following communications software must be installed before running
ControlFLASH Plus:
• FactoryTalk® Linx™ version 6.20.00 or later.
We provide the installation package that includes FactoryTalk Linx in
ControlFLASH Plus version 2.00.00 or later.
The installation package also includes FactoryTalk Updater, FactoryTalk
Updater Agent is selected by default when installing ControlFLASH Plus.
Install FactoryTalk Updater Client and Server as needed. Refer to
FactoryTalk
Updater Release Notes > Application Notes for more information.
Supported browsers
The following web browsers have been tested and are supported for use with
this release:
• Google® Chrome™ browser
• Microsoft® Edge™
• Mozilla® Firefox®
Security requirements
To help meet secure system design requirements review these publications:
• Configure System Security Features User Manual
SECURE-UM001)
• System Security Design Guidelines (publication SECURE-RM001)
10 Rockwell Automation Publication CFP-QS001F-EN-E - December 2020
(publication
Tip:
Tip:
s/gr/lnxent-gr001_-en-e.pdf.
Before you begin
Chapter 1 Start with ControlFLASH Plus
• Converged Plantwide Ethernet (CPwE) Design and Implementation
Guide (publication ENET-TD001)
To learn about implementing CIP Security, see CIP Security with Rockwell
Automation Products (publication SECURE-AT001).
Before using ControlFLASH Plus, you need to:
• Install FactoryTalk® Linx™ version 6.20.00 and FactoryTalk® Services
Platform version 6.20.00.
We provide the installation package that includes FactoryTalk Linx and
FactoryTalk Services Platform in ControlFLASH Plus version 2.00.00 and
later.
• Configure communication drivers in the FactoryTalk Linx software.
• Verify that your communications drivers work correctly.
For more information about FactoryTalk Linx, refer to the FactoryTalk Linx
Getting Results Guide at
3. In the Find Downloads page, enter ControlFLASH Plus and click
Search.
4. Select the row of ControlFLASH Plus and click Downloads to continue.
5. In this page, click the Show downloads icon to show the available
downloads.
6. In the Available Downloads page, select ControlFLASH Plus and click
Downloads.
7. Follow instructions on the web to download the installation package.
Rockwell Automation Publication CFP-QS001F-EN-E - December 2020 13
Chapter 2 Install ControlFLASH Plus
Note:
about FactoryTalk Updater, refer to FactoryTalk Updater Release Notes > Application Notes.
Step 1: Launch the Setup
When the installation completes, FactoryTalk® Security is enabled by default.
When started, ControlFLASH Plus logs on to the FactoryTalk Network
Directory.
To install ControlFLASH Plus, follow the steps below:
wizard and start the
installation
• Step 1: Launch the Setup wizard and start the installation on page 14
• Step 2: Read and accept license agreements on page 15
• Step 3: Start the installation on page 15
• Step 4: Finish the installation on page 15
• Step 5: View the release notes on page 16
1. Close all open programs.
2. In the ControlFLASH Plus installation package, double-click Setup.exe.
3. If Microsoft .NET Framework 4.8 is not installed on your computer, it
will be automatically installed during the process of installation.
4. (Optional) On the ControlFLASH Plus Setup page, select a language to
be shown during the installation process. By default, your system
language is selected.
Click Release notes to view the ControlFLASH Plus Release Notes in
your browser.
5. To install the software using the recommended installation location,
click Install now and skip to
Step 2: Read and accept license
agreements on page 15.
6. To select which components to install and change installation location,
click Customize.
If you download the installation package that only includes
ControlFLASH Plus and FactoryTalk Updater, the other components
won't show.
We provide the installation package that includes FactoryTalk Updater, FactoryTalk Updater
Agent is selected by default. Install the Client and Server as needed. For more information
7. On the Customize page, select the components. There may be three
options shown:
14 Rockwell Automation Publication CFP-QS001F-EN-E - December 2020
Tip:
Tip:
Step 2: Read and accept
license agreements
Step 3: Start the installation
Step 4: Finish the
Chapter 2 Install ControlFLASH Plus
•Mandatory (grayed-out and selected check box) indicates software
that will be automatically installed as part of the selected
application.
•Recommended (selected check box) indicates software that
Rockwell recommends for the application. You may decide to clear
the check box so the software does not install.
•Optional (clear check box) indicates software that you may wish to
include depending on your system. Select the box to include the
software during installation. To change the installation location,
click Customize.
8. Click Install.
End-user license agreements (EULA) spell out your rights and
responsibilities. Depending on the components being installed, there may be
more than one license agreement on this page. The individual license
agreements are listed above the text box.
Some software products may be delivered or made available only after you
agree to the terms and conditions of each of the license agreements.
installation
1. On the End User License Agreements page, select each agreement and
read the agreement carefully.
2. When all license agreements have been read, click Accept All.
If you click Decline, you will return to the ControlFLASH Plus Setup page.
After accepting the license agreements, the Setup wizard automatically
installs the software and does not require any input.
The installation completes.
• To view the installation details, click Installation Summary.
• To receive the latest product updates and patch notification, click
Register for updates.
• To install the latest version of Adobe® Acrobat® Reader®, click
Download it free and follow the on-screen instructions.
Restart the computer to complete the installation.
After installing the software, you can repair, modify, or uninstall the
software from the Setup wizard or Windows Control Panel.
Rockwell Automation Publication CFP-QS001F-EN-E - December 2020 15
Chapter 2 Install ControlFLASH Plus
Step 5: View the release
Install ControlFLASH Plus
Perform silent or
notes
If you also install FactoryTalk Updater Client on your computer, use it to
check the latest version of ControlFLASH Plus from the Product Compatibility
and Download Center.
After ControlFLASH Plus is installed, view the release notes to learn about the
system requirements, system features, anomalies, and application notes for
this release.
with command-line
parameters
unattended installation
1.Click Start > All Programs > FLASH Programming Tools >
ControlFLASH Plus.
2. After ControlFLASH Plus is opened, click .
3. In the Settings dialog box, click About> ControlFLASH Plus Release Notes.
4. The release notes will be opened with the browser.
ControlFLASH Plus supports silent or unattended installation using
command-line parameters. Silent installation runs in a quiet mode without
any user interface, while unattended installation runs in a quiet simple mode
and shows progress through the UI. Unattended installation does not accept
any input, but still shows error or restart messages.
Use command-line parameters to perform a silent or unattended installation
of ControlFLASH Plus.
The command-line installation requires the administrator permission. The
steps may vary slightly depending on your operating system.
To perform silent or unattended installation:
16 Rockwell Automation Publication CFP-QS001F-EN-E - December 2020
1. Close all Windows programs.
2. Open the Command Prompt window.
3. In the Command Prompt window, navigate to D:, where D: is the drive
containing the ControlFLASH Plus installation package.
In this example, type D: and press Enter.
Tip:
Parameter
Description
/?
Displays the usage options for installation parameters.
/QS
Unattended Install, install runs in a quiet simple mode and shows progress through the UI, it does not
This parameter is required if /Q or /Record is not specified.
This parameter is required for /Q or /QS parameters.
that must be agreed to before the installation is completed.
Command-line parameters
If User Account Control dialog box shows, click Yes.
Chapter 2 Install ControlFLASH Plus
4. Type a command with the following syntax and press Enter.
For more information about parameters, type Setup.exe /? or see Command-
line parameters for silent or unattended installation on page 17.
for silent or unattended
installation
/Q Silent Install, install runs in a quiet mode without any user interface.
Unattended or silent install
Use command-line parameters to perform an unattended or silent
installation of the software.
Command-line parameters
The following table identifies the installation command-line parameters.
Command-line parameters are case-insensitive. However, if a specified value
includes a space, be sure to enclose the value in quotation marks (for example,
"value with spaces").
This parameter is recommended if you are deploying the software installation using an IT tool or
script, and don’t expect to see any error or restart messages. When using this parameter, your IT tool
or script should check the error codes, and respond as needed. For example, if the installation
returns error code 1641, then the IT tool or script should restart the computer and relaunch the
installation after restart.
This parameter is required if /QS or /Record is not specified.
accept any input but still shows error or restart messages.
When using this parameter, you will not have to check the error codes, and the installation will stop
and display a prompt if there are error or restart messages. For example, if an immediate restart is
required to complete the install, a restart message will be displayed for you to confirm the restart.
Installation resumes automatically from the point of interruption after restart.
/IAcceptAllLicenseTerms Acknowledges acceptance of the license terms.
/AutoRestart Automatically restarts the computer after the installation is complete. Used when a restart is
required to complete the installation.
This parameter is optional. If this parameter is not used silent install (/Q) will return either error code
1641 or 3010 if a restart is required, and unattended install (/QS) will result in a confirmation prompt
Rockwell Automation Publication CFP-QS001F-EN-E - December 2020 17
Chapter 2 Install ControlFLASH Plus
Parameter
Description
operating system user interface language.
This parameter is optional.
This parameter is optional.
This parameter is optional. If it is not specified, the setup exits when a warning occurs.
/Uninstall
Uninstalls the product.
This parameter is optional.
/InstallDrive="value"
Specifies the install drive.
This parameter is optional. If this parameter is not used, the default install drive is C:.
Error Code
Value
Description
ERROR_BAD_CONFIGURATION
1610
The configuration data for this product is corrupt. Contact your support personnel.
ERROR_SUCCESS_REBOOT_INITIATED
1641
The installer has initiated a restart. After restart installation will continue.
successfully installed.
ERROR_SUCCESS_RELAUNCH_REQUIRED
3012
Restart pending. Restart computer for installation to continue.
ERROR_SUCCESS_NOT_APPLICABLE
3013
The installation cannot proceed because the products are already installed.
/SetupLanguage="value" Specifies which language will be displayed during install process.
/Record Records the installation options chosen to a recording file.
/Playback Plays back a recording file to specify the installation options.
/IgnoreWarning Specifies that the setup ignores warnings and continues.
The value must be the one of the following:
• ENU
• CHS
• DEU
• ESP
• FRA
• ITA
• JPN
• KOR
• PTB
This parameter is optional. If this parameter is not used, the default language is the current user or
/Repair Runs a repair operation on the installed products.
/InstallLocation="value" Specifies the install location.
This parameter is optional. If this parameter is not used, the default install location is "C:\Program
Files (x86)\Rockwell Software".
Some software restricts the installer to only change the drive the software is installed on. Use /? to
determine which parameter is supported.
Error codes
The following table identifies the error codes that can be returned by an
installation.
ERROR_SUCCESS 0 The installation completed successfully.
ERROR_INVALID_PARAMETER 87 One of the parameters was invalid.
ERROR_INSTALL_USEREXIT 1602 The installation was cancelled by the user.
ERROR_INSTALL_FAILURE 1603 A fatal error occurred during installation.
ERROR_SUCCESS_REBOOT_REQUIRED 3010 A restart is required to complete the installation. After restart the product is
18 Rockwell Automation Publication CFP-QS001F-EN-E - December 2020
Item
Description
Product Compatibility and Download Center.
Chapter 3
Explore the ControlFLASH Plus user interface
This chapter introduces the user interface of ControlFLASH Plus, including:
• Components on the ControlFLASH Plus window
• Settings dialog box
• Flash Devices tab
• Manage Firmware tab
• Manage Favorites tab
Flash Devices tab Allows you to browse devices, select firmware revisions, and start
Rockwell Automation Publication CFP-QS001F-EN-E - December 2020 19
The following table explains the items in the ControlFLASH Plus window and
their meanings.
a flash operation. When ControlFLASH Plus can access the Product
Compatibility and Download Center, you can select a device's
firmware revisions from the Product Compatibility and Download
Center. You can also access up to date hardware and firmware
lifecycle states, release notes, important notices, and copyright
information. To download the firmware revisions, sign in to the
Chapter 3 Explore the ControlFLASH Plus user interface
Item
Description
favorite lists.
Plus Quick Start Guide.
Opens the Settings dialog box.
firmware kits.
Settings dialog box
Manage Firmware tab Shows devices' firmware revisions in the monitored folders. When
Manage Favorites tab Allows you to create, view, manage, and make changes to the
ControlFLASH Plus can access the Product Compatibility and
Download Center, you can select the firmware revisions from the
Product Compatibility and Download Center. You can also access
up to date hardware and firmware lifecycle states, release notes,
important notices, and copyright information. To download
firmware revisions, sign in to the Product Compatibility and
Download Center. It also allows you to delete one or multiple
unused firmware revisions.
Opens the ControlFLASH Plus online help.
Tip: To access the ControlFLASH Plus Quick Start Guide, click Start
> All Programs > FLASH Programming Tools > ControlFLASH
Refreshes the firmware as found in the monitored folders.
Tip: To save time, refresh firmware after installing all non-DMK
Shows the connection status indicator to the Product Compatibility
and Download Center with different colors.
• Red
• Disconnected from Download Center
ControlFLASH Plus cannot access the Product Compatibility
and Download Center. In most cases, when you don't have the
Internet connectivity, this will occur.
• User doesn't have permission to connect to Download
Center
The current user has no access to device revision on the
Product Compatibility and Download Center.
• Green
ControlFLASH Plus can access the Product Compatibility and
Download Center, you have signed in, and it allows you to
download firmware revisions.
• Yellow
ControlFLASH Plus can access the Product Compatibility and
Download Center and Sign in shows. To download firmware
revisions, sign in to the Product Compatibility and Download
Center.
20 Rockwell Automation Publication CFP-QS001F-EN-E - December 2020
Use the Settings dialog box to configure the settings for ControlFLASH Plus,
including:
• General
• Reports
• Security
• Firmware Locations
• Options
• About
Tip:
Sign in to the Product
Compatibility and Download
Sign out of the Product
General tab
Center
When connected to the Internet, sign in to the Product Compatibility and
Download Center to download firmware revisions and view firmware
revisions' Important Notice.
Chapter 3 Explore the ControlFLASH Plus user interface
Prerequisites
• Make sure the currently logged on user has the permission to connect
to the Product Compatibility and Download Center. For how to
configure the connection permission, refer to
System Configuration Guide.
FactoryTalk Security
To sign in to the Product Compatibility and Download Center
1. In the lower left of the ControlFLASH Plus window, select Sign in.
In the Settings dialog box, select General, and then select Sign in.
2. In the Sign in webpage, enter a registered account and its password.
3. (optional) To view firmware revisions' Important Notice easily, select
Keep me signed in to enable single signed on.
4. Select Sign in.
Compatibility and Download
Center
After signing out of the Product Compatibility and Download Center,
downloading firmware revisions and viewing firmware revisions' Important
Notice from the Product Compatibility and Download Center is not allowed.
To sign out of the Product Compatibility and Download Center
1. In the ControlFLASH Plus window, select .
2. In the Settings dialog box, select General.
3. Select Sign out.
Rockwell Automation Publication CFP-QS001F-EN-E - December 2020 21
Chapter 3 Explore the ControlFLASH Plus user interface
Options
Description
Select Revision for All dialog box.
devices of the same type.
confirmation dialog box.
function.
the application logs to find causes of the errors.
Center sign-in webpage. When you are signed in, the account shows.
The following table lists the options in the General tab and their meanings.
FlashUses Flash to configure whether one selected revision will always be
applied to all devices of the same type and the default behavior of the
Let me choose each time (show messages) When selecting a firmware revision in the Flash To column of the Flash
Devices tab, with this option selected, a confirmation dialog box always
opens giving you options to decide if you want to apply the revision to all
Yes, always select for all devices (do not show messages) When selecting a firmware revision in the Flash To column of the Flash
Devices tab, with this option selected, the selected revision will always
be applied to all devices of the same type without showing a
No, never select for all devices (do not show messages) When selecting a firmware revision in the Flash To column of the Flash
Devices tab, with this option selected, the selected revision will not be
applied to other devices of the same type without showing a
confirmation dialog box.
The confirmation dialog box has a check box used to turn off this
Enable enhanced concurrent flashing algorithmWith this check box selected, the enhanced concurrent flashing is turned
on to flash up to 20 devices regardless of the topology.
With this mode turned on, devices in parent/children relationships and
the ones connected on Ethernet linear/DLR topologies are also flashed
concurrently.
This check box is selected by default.
Enable application log for troubleshootingWith this check box selected, the default path for application logs
appears and ControlFLASH Plus generates logs anytime it is started and
stopped.
Tip: When application errors occurred during operations, you can view
Sign in Selects this button to open the Product Compatibility and Download
22 Rockwell Automation Publication CFP-QS001F-EN-E - December 2020
Options
Description
Download Center.
Tip:
application logs.
Enable application log
Reports tab
Sign out Selects this button to sign out of the Product Compatibility and
Chapter 3 Explore the ControlFLASH Plus user interface
When an application error occurred during operations, view the application
log to check causes of the error.
Prerequisites
•In Settings > General, select Enable application log for
troubleshooting and restart ControlFLASH Plus.
To enable application log
1. In the ControlFLASH Plus window, select .
2. In the Settings dialog box, select the General tab.
3. On the General tab, select the Enable application log for troubleshooting check box.
The default path for application logs shows and you are prompt with a
dialog box indicating that when launching ControlFLASH Plus next
time, application logging will begin.
4. Select Close.
The application logs will be created on application start and stopped at
application stop. Select the path link to open the default folder for
Use the Reports tab to configure the automatic saving settings for reports of
each flash operation, including:
• Option to turn on or off the automatic saving
• Location of the saved report
With the Save a report for each flash operation automatically check box
selected, a report summarizing the flash result is automatically saved when a
flash operation completes.
Rockwell Automation Publication CFP-QS001F-EN-E - December 2020 23
Loading...
+ 52 hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.