Configuration Host VIs

NI Reconfigurable Oscilloscopes Help

Edition Date: January 2017

Part Number: 374500C-01

View Product Info

DOWNLOAD (Windows Only)


LabVIEW Instrument Design Libraries for Reconfigurable Oscilloscopes

Open Session.vi

Opens the instrument I/O session.

niHSAI Group A Config v1 Host.lvclass:Open Session.vi

Input Parameters

register bus in specifies an instruction target that interfaces to read and write registers to the device.

fpga interface in specifies a LV FPGA interface wire to communicate with the FPGA and board driver.

subsystem map in indicates the location for the instruction framework.

calibration data in specifies calibration data provided to the Configuration library.

emulation model name specifies a device to emulate, if emulation is enabled.

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

Output Parameters

session out passes a reference to your session to the next VI. session out is obtained from the Open Session VI of this library.

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


Configure ADC Clock.vi

Configures the device ADC to use either an onboard clock or an external clock.

niHSAI Config v1 Host.lvclass:Configure ADC Clock.vi

Input Parameters

session in identifies your session. session in is obtained from the Open Session VI of this library.

clock type specifies the type of clock for the device to use.

Onboard: specifies an onboard clock.

External: specifies an external clock.

reference clock source specifies the source of the reference clock used to generate the onboard ADC Clock.

None (default): specifies that no reference clock will be used.

Clock In: specifies that the clock source is the Clock In connector on the device front panel.

PXI Clock: specifies that the clock source is the clock signal from the PXI chassis.

reference clock rate (Hz) specifies the input reference clock rate if the reference clock source is Clock In. This parameter is ignored if the reference clock source is None or PXI Clock.

external clock source specifies the source of the external clock that is divided to become the ADC clock.

Clock In (default): specifies that the clock source is the Clock In signal from the device front panel.

PXIe DStar A: specifies that the clock source is the signal from the PXIe DStar A line.

external clock rate (Hz) specifies the frequency of the source of the ADC clock. The default value is 0.

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

Output Parameters

session out passes a reference to your session to the next VI. session out is obtained from the Open Session VI of this library.

actual adc clock rate (Hz) returns the coerced value of the ADC clock rate.

fpga data clock rate (Hz) returns the rate of the FPGA data clock, which captures ADC samples.

actual reference clock rate (Hz) returns the coerced reference clock rate.

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


Configure ADC Clock For Onboard.vi

Configures the device to use an onboard clock as the source of the ADC clock. If a reference clock source is specified, this VI also phase locks the device to that clock.

niHSAI Config v1 Host.lvclass:Configure ADC Clock For Onboard.vi

Input Parameters

session in identifies your session. session in is obtained from the Open Session VI of this library.

reference clock source specifies the source of the reference clock used to generate the onboard ADC Clock.

None (default): specifies that no reference clock will be used.

Clock In: specifies that the clock source is the Clock In connector on the device front panel.

PXI Clock: specifies that the clock source is the clock signal from the PXI chassis.

reference clock rate (Hz) specifies the input reference clock rate if the reference clock source is Clock In. This parameter is ignored if the reference clock source is None or PXI Clock.

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

Output Parameters

session out passes a reference to your session to the next VI. session out is obtained from the Open Session VI of this library.

actual adc clock rate (Hz) returns the coerced value of the ADC clock rate.

fpga data clock rate (Hz) returns the rate of the FPGA data clock, which captures ADC samples.

actual reference clock rate (Hz) returns the coerced reference clock rate.

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


Configure ADC Clock For External.vi

Configures the device to use an external clock as the source of the ADC clock. You must run the Disable Data Clock VI before turning off the external clock source.

niHSAI Config v1 Host.lvclass:Configure ADC Clock For External.vi

Input Parameters

session in identifies your session. session in is obtained from the Open Session VI of this library.

external clock source specifies the source of the external clock that is divided to become the ADC clock.

Clock In (default): specifies that the clock source is the Clock In signal from the device front panel.

PXIe DStar A: specifies that the clock source is the signal from the PXIe DStar A line.

external clock rate (Hz) specifies the frequency of the source of the ADC clock. The default value is 0.

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

Output Parameters

session out passes a reference to your session to the next VI. session out is obtained from the Open Session VI of this library.

actual adc clock rate (Hz) returns the coerced value of the ADC clock rate.

fpga data clock rate (Hz) returns the rate of the FPGA data clock, which captures ADC samples.

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


Configure Channel.vi

Configures vertical range, vertical offset, bandwidth, coupling, and impedance for the specified channel.

niHSAI Config v1 Host.lvclass:Configure Channel.vi

Input Parameters

session in identifies your session. session in is obtained from the Open Session VI of this library.

channel specifies the channel to be configured. The default channel is 0.

vertical range (V) specifies in volts the absolute value of the input range for the channel. The default value is 1.0.

vertical offset (V) specifies in volts the location of the center of the vertical range input with respect to ground.

enable channel (T) specifies whether the channel is enabled for acquisition. The default value is TRUE.

additional channel configuration specifies additional configurable properties for the channel.

additional channel configuration.Bandwidth specifies the difference between limiting frequencies within which the input signal can pass through the system with minimal amplitude loss.

Default: The default bandwidth setting for the device. The bandwidth of the actual channel configuration will return the actual bandwidth value.

Full Bandwidth: No attenuation of the signal.

Anti-alias Filter: Attenuates unwanted high-frequency components of an analog signal prior to its conversion into a digital value. These signals would otherwise appear as undesired, aliased frequency components.

additional channel configuration.Coupling specifies which frequency components of a signal to pass through without attenuation.

Default: The default coupling setting of the device. The coupling of the actual channel configuration will return the actual coupling setting.

DC: Direct Current signal components will not be attenuated.

AC: Alternating Current signal components will not be attenuated.

additional channel configuration.Impedance specifies the impedance for the channel.

Default: The default impedance setting for the device. The impedance of the actual channel configuration will return the actual impedance value.

1 MOhm: The impedance of the channel will be configured at 1 MOhm.

50 Ohm: The impedance of the channel will be configured at 50 Ohms.

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

Output Parameters

session out passes a reference to your session to the next VI. session out is obtained from the Open Session VI of this library.

actual channel configuration returns the coerced configuration used to configure the channel.

actual channel configuration.channel is the channel that was configured.

actual channel configuration.coupling is the coupling configuration applied to the channel.

Default: The default coupling setting for the device.

DC: Direct Current coupling.

AC: Alternating Current coupling.

actual channel configuration.impedance is the impedance configuration applied to the channel.

Default: The channel was configured with the default impedance setting for the device.

1 mega ohm: The channel was configured with 1 MOhm of impedance.

50 ohm: The channel was configured with 50 Ohms of impedance.

actual channel configuration.bandwidth is the coerced bandwidth configuration applied to the channel.

Default: The default bandwidth setting for the device. The bandwidth of the actual channel configuration will return the actual bandwidth value.

Full Bandwidth: No attenuation of the signal.

Anti-alias Filter: Attenuates unwanted high-frequency signals of an analog signal prior to its conversion into a digital value. These signals would otherwise appear as undesired, aliased frequency components.

actual channel configuration.vertical range is the coerced input range applied to the channel.

actual channel configuration.vertical offset is the coerced vertical offset configuration applied to the channel.

scaling coefficients returns coefficients without any digital correction for a scaled fetch.

scaling coefficients.gain is the gain coefficient.

scaling coefficients.offset is the offset coefficient.

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


Close Session.vi

Closes the instrument I/O session.

niHSAI Config v1 Host.lvclass:Close Session.vi

Input Parameters

session in identifies your session. session in is obtained from the Open Session VI of this library.

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

Output Parameters

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


Configure Digital Correction.vi

Digitally corrects the data on the FPGA. This VI applies the calibrated digital correction and passes the scaling coefficients used to fetch scaled data.

niHSAI Config v1 Host.lvclass:Configure Digital Correction.vi

Input Parameters

session in identifies your session. session in is obtained from the Open Session VI of this library.

actual channel configuration specifies a reference to the coerced configuration used to configure the channel. This parameter is obtained from the Configure Channel VI.

actual channel configuration.channel specifies the channel that was configured.

actual channel configuration.coupling specifies the coupling of the channel.

Default: The default coupling setting for the device.

DC: Direct Current.

AC: Alternating Current.

actual channel configuration.impedance specifies the impedance of the channel.

Default: The default impedance setting for the device.

1 mega ohm: 1 MOhm impedance.

50 ohm: 50 Ohms impedance.

actual channel configuration.bandwidth specifies the bandwidth of the channel.

Default: The default bandwidth setting for the device.

Full Bandwidth: No attenuation of the signal.

Anti-alias Filter: Attenuates unwanted high-frequency signals of an analog signal prior to its conversion into a digital value. These signals would otherwise appear as undesired, aliased frequency components.

actual channel configuration.vertical range specifies the vertical range of the channel.

actual channel configuration.vertical offset specifies the vertical offset of the channel.

range adjust adjusts the digital corrected data using the scaling factor. This can be used to prevent clipping when the acquired data is slightly greater than the nominal range.

enable (T) specifies whether digital correction is enabled. The default value is TRUE.

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

Output Parameters

session out passes a reference to your session to the next VI. session out is obtained from the Open Session VI of this library.

scaling coefficients returns coefficients without any digital correction for a scaled fetch.

scaling coefficients.gain is the gain coefficient.

scaling coefficients.offset is the offset coefficient.

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


Export Clock.vi

Exports the ADC clock signal or reference clock signal to a specified output terminal. If the clock to export has not been configured, this VI will return an error.

niHSAI Config v1 Host.lvclass:Export Clock.vi

Input Parameters

session in identifies your session. session in is obtained from the Open Session VI of this library.

exported clock specifies the clock signal to export.

None: No clock signal will be exported.

ADC Clock: The ADC clock signal will be exported.

PLL Reference Clock: The phase-locked reference clock signal will be exported.

output terminal specifies the terminal to which the clock signal will be exported. You can choose not to export any signal.

Do Not Export: Specifies that the signal is not exported.

Clock Out: Specifies that the signal is exported to the CLK OUT terminal.

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

Output Parameters

session out passes a reference to your session to the next VI. session out is obtained from the Open Session VI of this library.

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


Disable Data Clock.vi

Disables the Data Clock. You should run this VI before turning off the source of an external clock. The Data Clock will be re-enabled when you run the Configure ADC Clock VI of this library.

niHSAI Config v1 Host.lvclass:Disable Data Clock.vi

Input Parameters

session in identifies your session. session in is obtained from the Open Session VI of this library.

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

Output Parameters

session out passes a reference to your session to the next VI. session out is obtained from the Open Session VI of this library.

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


Wait Until Settled.vi

Waits until the input signal settles. Call this VI after configuring the channel to wait for the input signal to settle.

niHSAI Config v1 Host.lvclass:Wait Until Settled.vi

Input Parameters

session in identifies your session. session in is obtained from the Open Session VI of this library.

timeout (5000 ms) specifies the maximum amount of time to wait until input signal is settled.

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

Output Parameters

session out passes a reference to your session to the next VI. session out is obtained from the Open Session VI of this library.

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


Check Channel Overload.vi

Checks all input channels on the device for overload conditions.

niHSAI Config v1 Host.lvclass:Check Channel Overload.vi

Input Parameters

session in identifies your session. session in is obtained from the Open Session VI of this library.

set error? (T) specifies whether or not to set an error if overload conditions are detected. If this parameter is TRUE, then this VI will return an error if it detects overload conditions on any channels.

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

Output Parameters

session out passes a reference to your session to the next VI. session out is obtained from the Open Session VI of this library.

overloaded? returns TRUE if one or more channels are overloaded.

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


Clear Channel Overload.vi

Clears the overload condition from all device input channels. If this VI clears an overloaded channel, you should wait the minimum wait time for the channel to settle before acquiring data from on that channel.

niHSAI Config v1 Host.lvclass:Clear Channel Overload.vi

Input Parameters

session in identifies your session. session in is obtained from the Open Session VI of this library.

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

Output Parameters

session out passes a reference to your session to the next VI. session out is obtained from the Open Session VI of this library.

min wait time (ms) is the minimum amount of time you should wait after an overloaded channel has been cleared before acquiring data from that channel.

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


Get Number Of Channels.vi

Returns the maximum number of channels supported by the device.

niHSAI Config v1 Host.lvclass:Get Number Of Channels.vi

Input Parameters

session in identifies your session. session in is obtained from the Open Session VI of this library.

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

Output Parameters

session out passes a reference to your session to the next VI. session out is obtained from the Open Session VI of this library.

number of channels is the maximum number of channels supported by the device.

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


Check Status.vi

Checks the overall status of the device and reports whether it is operating correctly. This VI checks for system monitor alarms, such as temperature error, power error, FPGA voltage errors, clock PLL lock errors, and channel overload errors.

niHSAI Config v1 Host.lvclass:Check Status.vi

Input Parameters

session in identifies your session. session in is obtained from the Open Session VI of this library.

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

Output Parameters

session out passes a reference to your session to the next VI. session out is obtained from the Open Session VI of this library.

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


Read Temperature.vi

Returns a specified temperature measurement, in degrees Celsius.

niHSAI Config v1 Host.lvclass:Read Temperature.vi

Input Parameters

session in identifies your session. session in is obtained from the Open Session VI of this library.

source specifies the source of the temperature measurement to be returned by the temperature output.

Device Temperature: specifies the temperature of the analog front-end of the device as the temperature to return.

Thermal Shutdown Margin: specifies the temperature difference between the FPGA temperature sensor and the FPGA temperature limit as the measurement to return.

FPGA Temperature: specifies the current FPGA die temperature as the measurement to return.

FPGA Temperature Limit: specifies the thermal shutdown limit of the FPGA sensor as the measurement to return.

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

Output Parameters

session out passes a reference to your session to the next VI. session out is obtained from the Open Session VI of this library.

temperature (°C) returns the temperature measurement in degrees Celsius.

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


Read Power.vi

Returns a specified power measurement, in Watts.

niHSAI Config v1 Host.lvclass:Read Power.vi

Input Parameters

session in identifies your session. session in is obtained from the Open Session VI of this library.

source the source of the power measurement to be returned by the power output.

Device Power Consumption (default): Specifies the total instantaneous power consumption of the device as the measurement source.

Power Shutdown Margin: Specifies the difference between the Power Limit and the Device Power Consumption as the measurement source.

Power Limit: Specifies the shutdown limit as the measurement source.

Default Power Limit: specifies the default power limit as the measurement source. The default power limit varies by device.

Maximum Power Limit: specifies the highest value accepted by the measurement source.

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

Output Parameters

session out passes a reference to your session to the next VI. session out is obtained from the Open Session VI of this library.

power (W) returns the power measurement in Watts.

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


Is DRAM Initialized.vi

Indicates whether the DRAM is ready to be used. After downloading a new FPGA VI to the device, you must wait until the DRAM banks are initialized, before accessing the DRAM.

niHSAI Config v1 Host.lvclass:Is DRAM Initialized.vi

Input Parameters

session in identifies your session. session in is obtained from the Open Session VI of this library.

set error? (T) Sets an error if one or more DRAM banks are not initialized.

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

Output Parameters

session out passes a reference to your session to the next VI. session out is obtained from the Open Session VI of this library.

dram initialized? Returns TRUE if the DRAM is ready to be used, and FALSE if the DRAM is not ready to be used.

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


Read Clocking Status.vi

Reads the status of a device to check for clock faults.

niHSAI Group A Config v1 Host.lvclass:Read Clocking Status.vi

Input Parameters

fpga interface in specifies a LV FPGA interface wire to communicate with the FPGA and board driver.

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

Output Parameters

fpga interface out passes a LV FPGA interface wire to the next VI.

clock fault? indicates whether the data clock is in a faulty state.

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

WAS THIS ARTICLE HELPFUL?

Not Helpful