Upgrade Firmware (VI)

NI System Configuration API 18.0 Help

Edition Date: May 2018

Part Number: 373107N-01

»View Product Info
Download Help (Windows Only)
Installed With: NI System Configuration

Updates the firmware on the target. You can specify to update a file or the version.

Use the pull-down menu to select an instance of this VI.

Upgrade Firmware (File)

Updates the firmware on the target using a firmware file on the local computer.

Upgrade Firmware (File)

/images/reference/en-XX/help/373107N-01/cbool.gif

Stop Tasks Automatically specifies to automatically end all tasks running on the target, even if they are incomplete and switch to firmware update mode. The default is TRUE.

/images/reference/en-XX/help/373107N-01/crn.gif

Resource in is the resource to be changed.

/images/reference/en-XX/help/373107N-01/cpath.gif

Firmware File specifies the name and location of the firmware file on the local computer.

/images/reference/en-XX/help/373107N-01/cbool.gif

Always Overwrite specifies to overwrite the destination firmware image even if the version is the same as or older than the version of the destination firmware image. If FALSE, the function checks the version of the firmware and returns an error if the current version is newer than the version to which you are upgrading. If the firmware version is the same and this parameter is set to FALSE, the VI does not upgrade the firmware and returns success. If TRUE, this VI automatically upgrades the firmware, regardless of the version of the destination firmware image. By default, this VI will overwrite the firmware image only if the specified version is newer.

/images/reference/en-XX/help/373107N-01/cerrcodeclst.gif

error in (no error) describes error conditions that occur before this node runs. This input provides standard error in functionality.

/images/reference/en-XX/help/373107N-01/cu32.gif

Remote Timeout specifies the time in milliseconds that this VI waits to initiate the firmware process before it times out. The default amount of time that the VI waits for a response on the network before timing out is 5 minutes. This timeout is for remote systems only.

/images/reference/en-XX/help/373107N-01/irn.gif

Resource out returns basic information about the system resource.

/images/reference/en-XX/help/373107N-01/istr.gif

Detailed Result is a string containing results of any errors that may have occurred during the VI execution. This parameter also may return additional information about the value returned in Firmware Status .

/images/reference/en-XX/help/373107N-01/ii32.gif

Firmware Status returns the status of the firmware update. If this parameter returns update pending user restart , call the Restart VI. If this parameter returns update pending user action , refer to Detailed Result for more information.

/images/reference/en-XX/help/373107N-01/ierrcodeclst.gif

error out returns error information. This output provides standard error out functionality.

Upgrade Firmware (Version)

Updates the firmware on the target to a specific version.

Upgrade Firmware (Version)

/images/reference/en-XX/help/373107N-01/cbool.gif

Stop Tasks Automatically specifies to automatically end all tasks running on the target, even if they are incomplete and switch to firmware update mode. The default is TRUE.

/images/reference/en-XX/help/373107N-01/crn.gif

Resource in is the resource to be changed.

/images/reference/en-XX/help/373107N-01/cstr.gif

Firmware Version specifies the firmware version you want to apply to the target.

/images/reference/en-XX/help/373107N-01/cbool.gif

Always Overwrite specifies to overwrite the destination firmware image even if the version is the same as or older than the version of the destination firmware image. If FALSE, the function checks the version of the firmware and returns an error if the current version is newer than the version to which you are upgrading. If the firmware version is the same and this parameter is set to FALSE, the VI does not upgrade the firmware and returns success. If TRUE, this VI automatically upgrades the firmware, regardless of the version of the destination firmware image. By default, this VI will overwrite the firmware image only if the specified version is newer.

/images/reference/en-XX/help/373107N-01/cerrcodeclst.gif

error in (no error) describes error conditions that occur before this node runs. This input provides standard error in functionality.

/images/reference/en-XX/help/373107N-01/cu32.gif

Remote Timeout specifies the time in milliseconds that this VI waits to initiate the firmware process before it times out. The default amount of time that the VI waits for a response on the network before timing out is 5 minutes. This timeout is for remote systems only.

/images/reference/en-XX/help/373107N-01/irn.gif

Resource out returns basic information about the system resource.

/images/reference/en-XX/help/373107N-01/istr.gif

Detailed Result is a string containing results of any errors that may have occurred during the VI execution. This parameter also may return additional information about the value returned in Firmware Status .

/images/reference/en-XX/help/373107N-01/ii32.gif

Firmware Status returns the status of the firmware update. If this parameter returns update pending user restart , call the Restart VI. If this parameter returns update pending user action , refer to Detailed Result for more information.

/images/reference/en-XX/help/373107N-01/ierrcodeclst.gif

error out returns error information. This output provides standard error out functionality.

WAS THIS ARTICLE HELPFUL?

Not Helpful