On-the-Fly command line options

Top  Previous  Next

Options of the OFControl.exe command line

 

The command line format is: OFControl.exe [Options] [@<Option File>] [Options]

 

Note: In the descriptions of the command line option formats optional parameters are shown in square brackets [], in real option notation these brackets should be omitted. The angle brackets below <> serves for a clearer presentation only and should be omitted in the option notation. For example, instead of the -G[+] use the -G+; instead of -G[+][<C:\Temp\UPC.log] use the -G+C:\Temp\UPC.log.

 

Option

Description

 

-D

Include extended information to the Console dump and in the log file if it is specified. This option if helpful for On-the-Fly Control utility debugging.
 

-G[+][<log file name and path>]

Duplicate records outputting to the ChipProgUSB Console window to a log file. If the + sign follows the -G option name the information will be appended to the end of the log file, if it exists. Absence of the + sign will force creation of a new log file.  The default name of the log file is OFControl.log and it resides in the ChipProgUSB  working folder but you can specify a new file name and location.

 

Examples:

 -G     - create a new log file, named OFControl.log, in the OFControl.exe working folder.

 -G+   - append records to the OFControl.log file if it exists.  If it doesn’t exist, create it and append records to the file.

 -G+C:\Temp\OFC.log - append records to the C:\Temp\OFC.log file if it exists. If it doesn’t exist, create it and append records to this file.

 

-WK

Keep the On-the-Fly Control running until any key on the keyboard is pressed. This allows looking up the utility output in the Console window before it exits.

 

-L< ChipProgUSB executable file name and command line options>

Launch the ChipProg device programmer if it is not running.  If it was already launched the option will be ignored. The On-the-Fly Control utility executes the -L option before any others specified in the command line: before loading a project, launching scripts, or any operations with the device. The -L option is incompatible with use of  the -R option (see below).

 

Example:  -L"UProgNT2.exe /g1"

 

-R<device programmer's serial number>

If more than one ChipProg device programmers are working under control of the PC in the gang mode, connect and drive the unit whose serial number is specified by this option. This option is incompatible with use of the -L option. If more than one programmer is working under control of the PC and the On-the-Fly Control utility does not include the -R option, the utility returns an error (#14).

 

-C

Copy an error text to the Windows clipboard. If the On-the-Fly Control utility completes and returns the code = 0, then an error has taken place (with the exception of the reaction to the -T option, see below). If the command line includes the -C option, the error description will be copied to the clipboard; otherwise the clipboard contents remain unchanged.

 

If more than one operation on the target device specified in the On-the-Fly Control command line returns errors, then, if the command line also includes the -I option (ignore errors), descriptions of all the errors will be copied to the Windows clipboard.
 

-M[=<timeout in seconds>]

Specify a timeout in seconds of waiting for readiness of the device programmer before certain events: loading the project, launching scripts and a chain of the programming operations and quitting triggered by the -X option. If the -M option is not specified, the On-the-Fly Control utility does not check whether the ChipProgUSB is in the stop mode so an attempt to launch a programming function will cause quitting the utility with an error.

 

If the -M option is specified without the [=<timeout in seconds>] parameter then the On-the-Fly Control utility will indefinitely wait for the programmer readiness. In this case you can break the utility execution and quit by pressing the Ctrl+C keys.

 

-B

Stop an operation with the device. If the ChipProg executes a programming function (Read, Program, Verify, etc.), the operation will be interrupted. This action takes place prior to all the actions specified by the options -P, -S, -F, -X.  It is possible, however, that the -B option does not cause a break of an operation on the target device.  This happens when the utility issues an interactive operation error dialog that requires an action of the operator. In this case, the On-the-Fly Control utility exits with an error code.

 

-P<project file>

Load a specified project file. Project files with .UPP extensions include all the information and settings for a programming session (device type, file(s) to be written to the device, customized device and algorithm parameters, interface settings, device serialization options, scripts, etc.).

 

Before loading the project the On-the-Fly Control utility waits until the programmer stops the operations on the device (see the -M option).  If the -P option is specified in the On-the-Fly Control command line along with the -S and/or -F options, then the project loads before launching scripts and any operations with the target device.

 

Example: -P"C:\Prog\Projects\Antenna-01 Test.upp"

 

-S<script file>

Launch a specified script. Before starting a script the On-the-Fly Control utility waits until the programmer stops the operations on the device (see the -M option).  By default the On-the-Fly Control utility waits for the the script completion. To allow the On-the-Fly Control utility to continue working while the script is running, add the -NWS option to the option list.

 

Example: -S"D:\Prog Scripts\Checksum.cmd"

 

-NWS

Do not wait for completion of the script specified by the -S option.

 

-F<function list>

Execute listed operations (functions) with the target device. Names of the functions in the list should be separated by semicolons (;). In order to execute the Auto Programming function the -F option should be followed by an asterisk character (*).

 

If the command line includes more than one -F option they will be executed in the order in which they are specified in the command line.

 

If the -F option(s) is (are) specified in the command line along with the options -P (load project) and/or -S (launch script) then all the functions specified by the -F option(s) will start after loading the project and/or launching the script.

 

By default the On-the-Fly Control utility waits for function completion. To enable the utility to keep running while the function specified by the -F option is also executing, add the -NWF option to the command line. In this case you may include only one -F option in the command line.

 

If the -F option specifies a sub-function displayed in the drop-down menus of the Program Manager function tree, then specify both the menu name and the function itself, separated by the '^' character.  For example: -FProgram (for the Code Memory chip layer) but -FData Memory^Program (for the Data Memory) .

 

Examples:

 

 -F*  - launch the Auto Programming function.

 -FErase;Blank Check;Program;Verify - erase the device, check if it is blank, write the file from the programmer buffer and compare the buffer and device memory contents.

 "-F*;Verify;Device Parameters^Program HSB and XAF" - execute the Auto Programming function, then compare the buffer and device memory contents, then launch the function Program HSB & XAF from the Device Parameters sub-menu.

 

-NWF

Do not wait for completion of the function specified by the -F option. This option is incompatible with the -X option.

 

-I

Ignore errors that occur during programming operations. By default the On-the-Fly Control utility stops operations with the target device in case of any error.  The -I option enables the operations regardless of the result that allows logging of all the errors that occurred.

 

-T[+][W=<delay in milliseconds>]

Get the programmer status ["Ready" or "Busy"].  The On-the-Fly Control  utility returns the code 0 (zero) if the ChipProg stops and is ready for executing a programming operation, or 1 if the programmer is in the process of operating with the target device ("Busy").

 

If the '+' sign is present in the -T option declaration then, if the programmer operates on the target device, a current function name (Read, Program, etc.) will be output to the Console window along with the percentage of the function being executed.  For example: Program, 87%.

 

The optionally specified [W=<delay in milliseconds>] parameter sets a delay before getting the programmer status. Delays allow checking the programmer status within a settable period of time.

 

Examples:

 

 -T - get the programmer status "Ready" or "Busy"

 -TW=1000 - wait for 1 sec, then get the programmer status "Ready" or "Busy"

 -T+ - get the programmer status "Ready" or "Busy". Then output to the Console window the name of the currently executed function and the percentage of its completion.  An example of the function status string: Read 56%.

 

-V=[0 | 1]

Hide (-V=0) or make it visible (-V=1) in the ChipProgUSB main window.

 

If the ChipProgUSB main window is hidden, the programmer will be invisible among other open applications in the Applications tab of the Windows Task Manager. So, in order to close the running ChipProgUSB program you will have to open the Process tab of the Task Manager, then locate and highlight the programmer executable name (UprogNT2.exe) and click the End Process button.

 

-X

Stop the programmer and quit the program. To quit the ChipProgUSB program, the programmer must complete all the previously launched operations on the device. So the On-the-Fly Control utility waits for completing the current programming operation for a timeout period specified by the -M option. If this option is omitted or the timeout period expired the On-the-Fly Control returns an error code.

 

-? or -H

Output a brief description of the On-the-Fly Control utility options and quit.