niScope Initialize With Options

NI High-Speed Digitizers Help (NI-SCOPE)

Edition Date: January 2017

Part Number: 370592AB-01

View Product Info

DOWNLOAD (Windows Only)


NI-SCOPE (English | Japanese)

Performs the following initialization actions:

-Creates a new IVI instrument driver and optionally sets the initial state of the following session properties: Range Check, Cache, Simulate, Record Value Coercions.

-Opens a session to the device that you specify in the resource name parameter.

-Resets the instrument to a known state if the reset device parameter is set to TRUE; refer to niScope Reset for the default state of each digitizer.

-Queries the instrument ID and verifies that it is valid for this instrument driver if the id query parameter is set to TRUE.

-Returns an instrument handle that you use to identify the instrument in all subsequent instrument driver VI calls.

Related topics

niScope Initialize With Options

/images/reference/en-XX/help/370592AB-01/cio.gif

resource name specifies the device name assigned by Measurement & Automation Explorer (MAX).

Examples

Example Device Type Syntax
1 Traditional NI-DAQ device DAQ::1 (1 = device number)
2 NI-DAQmx device myDAQmxDevice (myDAQmxDevice = device name)
3 NI-DAQmx device DAQ::myDAQmxDevice (myDAQmxDevice = device name)
4 NI-DAQmx device DAQ::2 (2 = device name)
5 IVI logical name or IVI virtual name myLogicalName (myLogicalName = name)

For Traditional NI-DAQ devices, the syntax is DAQ::n, where n is the device number assigned by MAX, as shown in Example 1.

For NI-DAQmx devices, the syntax is just the device name specified in MAX, as shown in Example 2. Typical default names for NI-DAQmx devices in MAX are Dev1 or PXI1Slot1. You can rename an NI-DAQmx device by right-clicking on he name in MAX and entering a new name.

An alternative syntax for NI-DAQmx devices consists of DAQ::NI-DAQmx device name, as shown in Example 3. This naming convention allows for the use of an NI-DAQmx device in an application that was originally designed for a Traditional NI-DAQ device. For example, if the application expects DAQ::1, you can rename the NI-DAQmx device to 1 in MAX and pass in DAQ::1 for the resource name, as shown in Example 4.

If you use the DAQ::n syntax and an NI-DAQmx device name already exists with that same name, the NI-DAQmx device is matched first.

You can also pass in the name of an IVI logical name or an IVI virtual name configured with the IVI Configuration utility, as shown in Example 5. A logical name identifies a particular virtual instrument. A virtual name identifies a specific device and specifies the initial settings for the session.

Caution  Traditional NI-DAQ and NI-DAQmx device names are not case-sensitive. However, all IVI names, such as logical names, are case-sensitive. If you use logical names, driver session names, or virtual names in your program, you must make sure that the name you use matches the name in the IVI Configuration Store file exactly, without any variations in the case of the characters.
/images/reference/en-XX/help/370592AB-01/cbool.gif

id query verifies that the digitizer you initialize is supported by NI-SCOPE. NI-SCOPE automatically performs this query, so setting this parameter is not necessary.

/images/reference/en-XX/help/370592AB-01/cstr.gif

option string sets the initial value of certain properties for the session.

The following table lists the properties and the name you use in this parameter to identify the property.

Name Attribute Defined Constant Default Value
RangeCheck niScope»Inherent IVI Settings»User Options»Range Check TRUE
Cache niScope»Inherent IVI Settings»User Options»Cache TRUE
Simulate niScope»Inherent IVI Settings»User Options»Simulate FALSE
RecordCoercions niScope»Inherent IVI Settings»User Options»Record Value Coercions FALSE
QueryInstrStatus niScope»Inherent IVI Settings»User Options»Query Instrument Status TRUE

Default Values: "Simulate=0,RangeCheck=1,Cache=1"

You can use the DriverSetup flag to simulate a device, attach an accessory to your device session, or load a bitfile to a device FPGA.

  • To simulate a device, specify the model and board type you wish to simulate. For example, Simulate = 1, DriverSetup = Model:5122; BoardType:PXI will simulate a NI 5122.
  • To attach an accessory to your device session, specify the name given to the accessory by MAX. For example, DriverSetup = Accessory:Dev1 will attach the accessory named "Dev1" in MAX to your device session.
  • For instructions on how to load a bitfile to a device FPGA, refer to Using NI-SCOPE Instrument Driver FPGA Extensions.

For more information about simulation, refer to the niScope EX Simulated Acquisition example.

To see this parameter used in a VI, refer to the niScope EX External Amplifier example.

/images/reference/en-XX/help/370592AB-01/cbool.gif

reset device specifies whether to reset the instrument during the initialization procedure.

Default Value: TRUE

Note  For the NI 5112, repeatedly resetting the device may cause excessive wear on the electromechanical relays. Refer to NI 5112 Electromechanical Relays for recommended programming practices.
/images/reference/en-XX/help/370592AB-01/cerrcodeclst.gif

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

/images/reference/en-XX/help/370592AB-01/iio.gif

instrument handle identifies a particular instrument session.

/images/reference/en-XX/help/370592AB-01/ierrcodeclst.gif

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

WAS THIS ARTICLE HELPFUL?

Not Helpful