niRFSG_ResetDevice

NI-RFSG C Function

niRFSG_ResetDevice

C Function Prototype

ViStatus niRFSG_ResetDevice (ViSession vi);

Purpose

Performs a hard reset on the device which consists of the following actions:

  • Signal generation is stopped
  • All routes are released
  • External bidirectional terminals are tristated
  • FPGAs are reset
  • Hardware is configured to its default state
  • All session attributes are reset to their default states

During a reset, routes of signals between this and other devices are released, regardless of which device created the route.

  • NI 5610, NI 5670/5671/5672
  • — After calling this function, the device requires 25 seconds before returning to full functionality. NI-RFSG enforces this condition by adding a wait, if needed, the next time you try to access the device.
Note Note  You must call the niRFSG_ResetDevice function if the NI-RFSG device has shut down due to high temperature conditions.

Supported Devices: NI 5610 (upconverter only mode), NI 5650/5651/5652/5670/5671/5672

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. The ViSession handle is obtained from the niRFSG_init function or the niRFSG_InitWithOptions function and identifies a particular instrument session.

Default Value: None

Return Value

Name Type Description
status ViStatus Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an instrument driver function to determine if an error occurred.

To obtain a text description of the status code, call the niRFSG_error_message function. To obtain additional information about the error condition, call the niRFSG_GetError function. To clear the error information from the driver, call the niRFSG_ClearError function.

The general meaning of the status code is as follows:

ValueMeaning
0Success
Positive ValuesWarnings
Negative ValuesErrors