Rockwell Automation ControlFLASH User Manual
ControlFLASH User Manual
User Manual |
Original Instructions |
ControlFLASH User Manual
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 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.
IMPORTANT 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.
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.
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 for Personal Protective Equipment (PPE).
2 |
Rockwell Automation Publication - 1756-UM105K-EN-E - December 2020 |
|
Table of Contents |
|
Preface |
Purpose of this manual............................................................................... |
5 |
|
New features and benefits ......................................................................... |
5 |
|
Who should use this manual ...................................................................... |
5 |
|
Legal Notices................................................................................................ |
5 |
|
Chapter 1 |
|
ControlFLASH Firmware Kit |
System requirements ................................................................................. |
7 |
|
Before you begin ......................................................................................... |
8 |
|
Chapter 2 |
|
Install ControlFLASH |
Introduction................................................................................................ |
9 |
|
About firmware kits .............................................................................. |
9 |
|
Install ControlFLASH through installation package ............................... |
10 |
|
Locate and download the installation package.................................. |
10 |
|
Install ControlFLASH .......................................................................... |
11 |
|
Step 1: Launch the Setup wizard and start the installation ........ |
11 |
|
Step 2: Read and accept license agreements................................ |
12 |
|
Step 3: Start the installation.......................................................... |
13 |
|
Step 4: Finish the installation........................................................ |
13 |
|
Install ControlFLASH with command-line parameters.......................... |
14 |
|
Perform silent or unattended installation ......................................... |
14 |
|
Command-line parameters for silent or unattended installation ... |
15 |
|
Install ControlFLASH through firmware ................................................. |
17 |
|
Locate and download firmware kits ................................................... |
17 |
|
Install ControlFLASH .......................................................................... |
18 |
Configure ControlFLASH policy
Upgrade firmware with ControlFLASH
Chapter 3 |
|
Introduction............................................................................................... |
21 |
Configure ControlFLASH policy in FactoryTalk policies........................ |
21 |
Chapter 4 |
|
Introduction.............................................................................................. |
25 |
Prepare for firmware upgrades ............................................................... |
25 |
Prepare the device for upgrades .............................................................. |
25 |
Use ControlFLASH to upgrade firmware ................................................ |
25 |
Access help .................................................................................................. |
31 |
|
Chapter 5 |
|
Use the command line |
Introduction............................................................................................... |
33 |
|
Command line mode ................................................................................. |
33 |
|
Rockwell Automation Publication - 1756-UM105K-EN-E - December 2020 |
3 |
Table of Contents
ControlFLASH and FactoryTalk AssetCentre interaction
Command line syntax.......................................................................... |
34 |
Script files ............................................................................................. |
36 |
Flash multiple devices.......................................................................... |
37 |
Example: script file ............................................................................. |
38 |
Example: script file for instance number........................................... |
39 |
Example: script file for NVS file updating ......................................... |
39 |
Example: script file for DMK file updating........................................ |
39 |
Troubleshooting ........................................................................................ |
40 |
Error Log.............................................................................................. |
40 |
Aborted script file................................................................................. |
41 |
Stop a command line or script application ........................................ |
41 |
Chapter 6 |
|
Introduction............................................................................................... |
43 |
Information monitoring ........................................................................... |
43 |
Event Log .............................................................................................. |
43 |
Audit Log............................................................................................... |
43 |
FactoryTalk AssetCentre............................................................................ |
43 |
Logging the device update status ....................................................... |
44 |
Logging the exit of ControlFLASH ..................................................... |
45 |
ControlFLASH error codes
Create a custom interface to process firmware downloads
Appendix A |
|
Introduction............................................................................................... |
47 |
Appendix B |
|
Introduction.............................................................................................. |
49 |
Example automated flash tool ................................................................. |
49 |
How a custom upgrade tool works ..................................................... |
51 |
Example Visual Basic .NET code........................................................ |
52 |
4 |
Rockwell Automation Publication - 1756-UM105K-EN-E - December 2020 |
Preface
Purpose of this manual
New features and benefits Who should use this manual
Legal Notices
This manual describes how to use the ControlFLASH™ software to upgrade device firmware.
There are no new or enhanced features in ControlFLASH version 15.04.00.
You should use this manual if you need to maintain firmware revisions. Refer to your product release notes to determine whether it support firmware updates via ControlFLASH.
You should also have the following knowledge:
•A basic understanding of networking concepts.
•A basic familiarity of RSLinx software.
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 default location of this file is:
C:\Program Files (x86)\Common Files\Rockwell\license.rtf.
Open Source Software Licenses
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.
The default location of this file is:
C:\Program Files (x86)\Common
Files\ControlFLASH\ControlFLASH Release
Notes\OPENSOURCE\index.htm
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-
Rockwell Automation Publication - 1756-UM105K-EN-E - December 2020 |
5 |
Preface
us/contact/contact.page. Please include "Open Source" as part of the request text.
6 |
Rockwell Automation Publication - 1756-UM105K-EN-E - December 2020 |
Chapter 1
ControlFLASH Firmware Kit
System requirements
This chapter helps you get started with using the ControlFLASH Firmware Kit with your application.
ControlFLASH works within the system requirements of all Rockwell Automation® software products. For the latest information regarding software platform support, refer to Rockwell Automation Product Compatibility and Download Center at http://compatibility.rockwellautomation.com/Pages/home.aspx.
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 is tested on operating systems installed from original Microsoft® media only. ControlFLASH runs on either the 32-bit or 64-bit versions of the following Windows® or Windows Server operating systems:
•Windows 10
•Windows 10 Enterprise LTSC 2019
•Windows Server® 2019
•Windows Server 2012 R2
•Windows Server 2012
•Windows Server 2016
Preferred operating systems
Preferred operating systems are prioritized for support, testing, and postrelease patch qualifications. These operating systems are preferred for this release:
•Windows 10 Professional (64-bit)
•Windows Server 2016 Standard (64-bit)
Rockwell Automation Publication - 1756-UM105K-EN-E - December 2020 |
7 |
Chapter 1 |
ControlFLASH Firmware Kit |
|
|
• Windows Server 2012 R2 Standard (64-bit)
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
One of the following communications software packages must be installed before running ControlFLASH:
•RSLinx® Classic Lite
•RSLinx Classic
•RSLinx Enterprise version 6.20 or FactoryTalk® Linx™ 6.20
Supported browsers
Before you begin
The following web browsers have been tested and are supported for use with this release:
•Google® Chrome™ browser
•Internet Explorer® 11
•Mozilla® Firefox®
Before you start using ControlFLASH Firmware Kit, you need to:
•Verify that you have a version of RSLinx software installed.
•Configure your configuration drivers in the RSLinx software.
•Verify your communication drivers operate correctly.
8 |
Rockwell Automation Publication - 1756-UM105K-EN-E - December 2020 |
Chapter 2
Install ControlFLASH
Introduction
ControlFLASH is installed when you install Studio 5000 Logix Designer® version 28.00 or later.
•You can download the standalone installation package from Rockwell Automation Product Compatibility and Download Center (PCDC). See Install ControlFLASH through installation package on page 10.
•When you download an older version of firmware kits from Rockwell Automation PCDC, ControlFLASH version 12.00 or earlier is also included. See Install ControlFLASH through firmware on page 17.
Important: The illustrations 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.
About firmware kits
In ControlFLASH version 12.00 and earlier, each firmware kit is delivered as an MSI install. It always includes the ControlFLASH application, the firmware NVS and BIN files. You always need to run the MSI file to install ControlFLASH and the included firmware kits on your computer.
Starting from ControlFLASH version 13.00, each new firmware kit is delivered as an individual Device Management Kit (DMK) file. The ControlFLASH tool is separate and needs to be installed only once.
In ControlFLASH version 15.00, family DMK and bundle DMK files are supported. A family DMK is a DMK file that contains multiple catalogs of the same revision and controller family. A bundle DMK is a DMK file that contains regular DMKs or family DMKs or both kinds of firmware kits.
Verification of DMK's publisher
The certificate of Rockwell Automation has changed since November 2019.
The new DMK is either:
•Signed by Rockwell Automation with a new certificate.
•Signed by a third party company.
If the new DMK's publisher is not in your system's trusted publisher list, you can log in as an administrator to choose to trust the publisher.
Rockwell Automation Publication - 1756-UM105K-EN-E - December 2020 |
9 |
Chapter 2 Install ControlFLASH
Install ControlFLASH through installation package
Locate and download the installation package
A DMK is a single, digitally signed file that contains the firmware binaries. ControlFLASH authenticates DMK's origin and validates its contents, providing enhanced protection against malicious threats. You can just download and use it, no need to install or unzip it. The file is named for easy identification and management, for example, 1756-L73_28.011.dmk. For more information, see ControlFLASH Help.
To install ControlFLASH through the installation package, complete the following operations:
•Locate and download the installation package on page 10
•Install ControlFLASH on page 11
Follow these instructions below:
1.From Internet Explorer, go to the PCDC website:
http://compatibility.rockwellautomation.com/Pages/home.aspx To use this site, you must register and log in.
2.In the Downloads area, click Find Downloads.
3. In the Find Downloads page, enter ControlFLASH and click Search.
4. Select the row of ControlFLASH and click Downloads to continue.
10 |
Rockwell Automation Publication - 1756-UM105K-EN-E - December 2020 |
Chapter 2 Install ControlFLASH
Install ControlFLASH
Step 1: Launch the Setup wizard and start the installation
5.In this page, click the Show downloads icon to show the available downloads.
6.In the Available Downloads page, select ControlFLASH and click Downloads.
7.Follow instructions on the web to download the installation package.
Starting from ControlFLASH version 13.00, when the installation completes, FactoryTalk® Security is enabled by default. When launched, ControlFLASH logs on to the FactoryTalk Network Directory.
To install ControlFLASH, follow the steps below:
•Step 1: Launch the Setup wizard and start the installation on page 11
•Step 2: Read and accept license agreements on page 12
•Step 3: Start the installation on page 13
•Step 4: Finish the installation on page 13
1.Close all open programs.
2.Place the ControlFLASH installation DVD in the computer's DVD
drive, or double click Setup.exe within the installation package.
Tip: If the installation does not start automatically, double-click D:\Setup.exe, where D:\ is the drive containing the DVD.
Rockwell Automation Publication - 1756-UM105K-EN-E - December 2020 |
11 |
Chapter 2 Install ControlFLASH
Step 2: Read and accept license agreements
3.If Microsoft .NET Framework 4.0 or later is not installed on your computer, the Microsoft .NET Framework Setup dialog box shows. Click Install.
4.(optional) On the ControlFLASH Setup page, select a language to be shown during the installation process. By default, your system language is selected.
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 12.
6.To change the installation location, click Customize.
7.On the Customize page, select the location for the software.
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.
12 |
Rockwell Automation Publication - 1756-UM105K-EN-E - December 2020 |
Chapter 2 Install ControlFLASH
Step 3: Start the installation
Step 4: Finish the installation
Some software products may be delivered or made available only after you agree to the terms and conditions of each of the license agreements.
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.
Tip: If you click Decline, you will return to the ControlFLASH 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 and subscribe.
Rockwell Automation Publication - 1756-UM105K-EN-E - December 2020 |
13 |
Chapter 2 Install ControlFLASH
Install ControlFLASH with command-line parameters
Perform silent or unattended installation
•To install the latest version of Adobe® Acrobat® Reader®, click Download it free and follow the on-screen instructions.
Click Close to exit the Setup wizard.
ControlFLASH supports silent or unattended installation using commandline 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.
The command-line installation requires the administrator permission. The steps may vary slightly depending on your operating system.
To perform silent or unattended installation:
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 installation package.
In this example, type D: and press Enter.
14 |
Rockwell Automation Publication - 1756-UM105K-EN-E - December 2020 |
Chapter 2 Install ControlFLASH
Tip: If User Account Control dialog box shows, click Yes.
4. Type a command with the following syntax and press Enter.
Setup.exe {/Q | /QS} /IAcceptAllLicenseTerms [/AutoRestart] [/SetupLanguage=language] [/Record] [/Playback] [/InstallDrive=drive] [/SerialNumber=serial_number] [/ProductKey=product_key] [/Version=product_version]
For more information about parameters, type Setup.exe /? or see Commandline parameters for silent or unattended installation on page 15.
Command-line parameters for silent or unattended installation
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").
Parameter |
Description |
|
|
/? |
Displays the usage options for installation parameters. |
/Q |
Silent Install, install runs in a quiet mode without any user interface. |
|
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. |
/QS |
Unattended Install, install runs in a quiet simple mode and shows progress through the UI, it does not |
|
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. |
|
This parameter is required if /Q or /Record is not specified. |
/IAcceptAllLicenseTerms |
Acknowledges acceptance of the license terms. |
|
This parameter is required for /Q or /QS parameters. |
/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 |
|
that must be agreed to before the installation is completed. |
Rockwell Automation Publication - 1756-UM105K-EN-E - December 2020 |
15 |
Chapter 2 |
Install ControlFLASH |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Parameter |
Description |
|
|
|
|
|
|
|
|
/SetupLanguage="value" |
Specifies which language will be displayed during install process. |
|
|
|
|
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 |
|
|
|
|
operating system user interface language. |
|
|
|
/Record |
Records the installation options chosen to a recording file. |
|
|
|
|
This parameter is optional. |
|
|
|
/Playback |
Plays back a recording file to specify the installation options. |
|
|
|
|
This parameter is optional. |
|
|
|
/InstallLocation="value" |
Specifies the install location or install drive respectively. |
|
|
|
Or |
This parameter is optional. If this parameter is not used, the default install location is "C:\Program |
|
|
|
/InstallDrive="value" |
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. |
|
Examples
The following examples show how to use the installation commands.
• To install the software with no user interface using the default settings during the installation process. (Silent install)
Setup.exe /Q /IAcceptAllLicenseTerms
• To install the software on the D: drive and display the progress, error, or complete messages during installation and restart the computer if necessary. (Unattended install)
Setup.exe /QS /IAcceptAllLicenseTerms /AutoRestart /InstallDrive=D:
Error codes
The following table identifies the error codes that can be returned by an installation.
|
Error Code |
|
Value |
Description |
|
|
|
|
|
|
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_BAD_CONFIGURATION |
|
1610 |
The configuration data for this product is corrupt. Contact your support personnel. |
16 |
|
Rockwell Automation Publication - 1756-UM105K-EN-E - December 2020 |
||
|
|
|
Chapter 2 |
Install ControlFLASH |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Error Code |
Value |
Description |
|
|
|
|
|
|
|
|
|
ERROR_SUCCESS_REBOOT_INITIATED |
1641 |
The installer has initiated a restart. After restart installation will continue. |
|
|
|
ERROR_SUCCESS_REBOOT_REQUIRED |
3010 |
A restart is required to complete the installation. After restart the product is |
||
|
|
|
successfully installed. |
|
|
|
ERROR_SUCCESS_RELAUNCH_REQUIRED |
3011 |
Restart of setup needed before installation can continue. |
|
|
Install ControlFLASH through firmware
Locate and download firmware kits
When you download an older version of firmware kits from Rockwell Automation PCDC, ControlFLASH version 12.00 or earlier is included. The firmware kit installation file also contains these files:
•ControlFLASH installation file
•ControlFLASH drivers
•ControlFLASH online help
Follow these instructions below:
1.From Internet Explorer, go to the PCDC website:
http://compatibility.rockwellautomation.com/Pages/home.aspx To use this site, you must register and log in.
2.In the Downloads area, click Find Downloads.
3.In the Find Downloads page, enter the catalog number or description that you want to download. You can also use the filter to limit the search.
Rockwell Automation Publication - 1756-UM105K-EN-E - December 2020 |
17 |
Loading...