Admin Production ni-theme
Current Publication

Configure Channel

IVI Compliance Package

IviScope Configure Channel

IviScope Base Capability Group

This VI configures the most commonly configured properties of the oscilloscope channel sub-system. These properties are the range, offset, coupling, probe attenuation, and whether the channel is enabled.

instrument handle The instrument handle that you obtain from the IviScope Initialize or the IviScope Initialize With Options VI.
channel name Pass the virtual channel name that you assign to the instrument in MAX.

Virtual channel names are aliases for instrument specific channel strings. The instrument specific channel strings can differ from one instrument to another. Virtual channel names allow you to use and swap instruments without having to change the channel names in your source code. You assign a virtual channel name to an instrument specific channel through MAX. This control accepts virtual channel names you have assigned to the specific instrument you are using. It also accepts the instrument specific channel names.

Default Value: "CHANNEL1"

vertical range Pass the value of the input range the oscilloscope uses for the channel. The driver sets the IviScope Vertical Range property to this value.

For example, to acquire a sine wave that spans between –5.0 and 5.0 V, pass 10.0 as the value of this parameter.

Units: volts

vertical offset Pass the location of the center of the range that you specify with the Vertical Range parameter. Express the value with respect to ground. The driver sets the IviScope Vertical Offset to this value.

For example, to acquire a sine wave that spans between 0.0 and 10.0 V, pass 5.0 as the value of this parameter.

Units: volts

Default value: 0.0

vertical coupling Specify how you want the oscilloscope to couple the input signal for the channel. The driver sets the IviScope Vertical Coupling property to this value.

Defined Values:

IVISCOPE_VAL_AC—AC Coupling

IVISCOPE_VAL_DC—DC Coupling

IVISCOPE_VAL_GND—Ground Coupling

Default value: IVISCOPE_VAL_DC

probe attenuation Pass the scaling factor by which the probe you attach to the channel attenuates the input. For example, when you use a 10:1 probe, set this parameter to 10.0. The driver sets the IviScope Probe Attenuation property to this value.

This driver reserves negative values to control the oscilloscope's automatic probe sense capability. Setting this parameter to IVISCOPE_VAL_PROBE_SENSE_ON configures the oscilloscope to sense the attenuation of the probe automatically.

Defined Values:

IVISCOPE_VAL_PROBE_SENSE_ONE—enables the oscilloscope's automatic probe sense capability.

Default Value: 1.0

Notes
  1. If the oscilloscope is set to sense the probe attenuation automatically, setting this parameter to a positive value disables the automatic probe sense and configures the oscilloscope to use the manual probe attenuation you specify.
  2. If you use a manual probe attenuation, you must set the probe attenuation to reflect the new probe attenuation each time you attach a different probe.
  3. Use the IviScope Auto Probe Sense Value [PAS] VI to obtain the actual probe attenuation while the automatic probe sense capability is enabled.
  4. If you set the oscilloscope to sense the probe attenuation automatically, the probe attenuation value can change at any time. When the oscilloscope detects a new probe attenuation value, other settings in the oscilloscope might also change. The driver has no way of knowing when these changes occur. Therefore, when you enable the automatic probe sense capability, this driver disables caching for properties that depend on the probe attenuation. These properties include IviScope Vertical Range, IviScope Vertical Offset, and all the properties that configure trigger levels. To maximize performance, set this parameter to a manual probe attenuation setting.
channel enabled Specify whether you want the oscilloscope to acquire a waveform for the channel when you call the IviScope Initiate Acquisition, IviScope Read Waveform, IviScope Read Min Max Waveform [MmW], or IviScope Read Waveform Measurement [WM] VI. The driver sets the IviScope Channel Enabled property to this value.

Default Value: TRUE

error in (no error) The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

instrument handle out The instrument handle that you obtain from the IviScope Initialize or the IviScope Initialize With Options VI.
error out The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.