NI-Sync LabVIEW API Reference

niSync Initialize (VI)

  • Updated2024-03-29
  • 7 minute(s) read

niSync Initialize (VI)

Installed With: NI-Sync

Creates a new NI-Sync instrument driver session.

You must invoke this VI any time you want to use NI-Sync VIs, and you must open a separate session for each device. You can use the instrument handle returned from this VI to identify the device to other NI-Sync VIs, including NI-Sync external calibration VIs.

niSync Initialize (Default)

Use this instance to select the device to initialize from a list of installed devices.

You can initialize both remote and local devices using this instance.

Note  In addition to selecting a device from the list, you can also enter a string in the resource name parameter to manually enter the device to initialize.

niSync Initialize (Default)

cio.gif

resource name specifies the resource name of the device you would like to initialize. You can assign the resource name of a device in Measurement & Automation Explorer (MAX). To display a list of resource names installed in the system, wire a control or constant to this terminal.

PXI Syntax

PXI[bus number]::device number

Note  VISA aliases are also valid for the resource name.

cDAQ and Embedded Syntax

sync://[hostname or IP]/system

You can find a device's hostname or IP address in MAX. To specify a local device in a Linux RT target, enter "localhost" or 127.0.0.1 instead of a hostname or IP.

Examples

Resource name Description
Dev1 DAQmx name (set in MAX)
PXI1Slot5 DAQmx name
PXI0::15::INSTR PXI bus 0, device number 15
PXI::15::INSTR PXI bus 0, device number 15
PXI4::9::INSTR PXI bus 4, device number 9
sync://10.2.172.5/system The remote device with the IP number of 10.2.172.5. You can find this IP number in MAX.
sync://NI-cRIO-9033-01A4B0BE/system The cRIO-9033 device with the hostname NI-cRIO-9033-01A4B0BE. You can find this hostname in MAX.
cbool.gif

id query specifies whether or not to query the instrument ID to determine if the instrument is compatible with the NI-Sync driver. The default is TRUE.

cbool.gif

reset device (F) specifies whether to reset the NI-Sync module to its default state—including the selected time reference, any connected terminals, and all scheduled future time events—during the initialization procedure. The default is FALSE.

Note  This parameter is not supported on Linux RT targets.
cerrcodeclst.gif

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

iio.gif

instrument handle out returns the instrument handle that you obtain from niSync Initialize.

ierrcodeclst.gif

error out returns error conditions that occur after this node runs. This output provides standard error out functionality.

niSync Initialize (IVI)

niSync Initialize (IVI)

cio.gif

resource name specifies the resource name of the device you would like to initialize. You can assign the resource name of a device in Measurement & Automation Explorer (MAX). To display a list of resource names installed in the system, wire a control or constant to this terminal.

PXI Syntax

PXI[bus number]::device number

Note  VISA aliases are also valid for the resource name.

cDAQ and Embedded Syntax

sync://[hostname or IP]/system

You can find a device's hostname or IP address in MAX. To specify a local device in a Linux RT target, enter "localhost" or 127.0.0.1 instead of a hostname or IP.

Examples

Resource name Description
Dev1 DAQmx name (set in MAX)
PXI1Slot5 DAQmx name
PXI0::15::INSTR PXI bus 0, device number 15
PXI::15::INSTR PXI bus 0, device number 15
PXI4::9::INSTR PXI bus 4, device number 9
sync://10.2.172.5/system The remote device with the IP number of 10.2.172.5. You can find this IP number in MAX.
sync://NI-cRIO-9033-01A4B0BE/system The cRIO-9033 device with the hostname NI-cRIO-9033-01A4B0BE. You can find this hostname in MAX.
cbool.gif

id query specifies whether or not to query the instrument ID to determine if the instrument is compatible with the NI-Sync driver. The default is TRUE.

cbool.gif

reset device (F) specifies whether to reset the NI-Sync module to its default state—including the selected time reference, any connected terminals, and all scheduled future time events—during the initialization procedure. The default is FALSE.

Note  This parameter is not supported on Linux RT targets.
cerrcodeclst.gif

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

iio.gif

instrument handle out returns the instrument handle that you obtain from niSync Initialize.

ierrcodeclst.gif

error out returns error conditions that occur after this node runs. This output provides standard error out functionality.

niSync Initialize (String)

Use this instance to manually enter a resource name for the NI-Sync session using a string constant or control.

niSync Initialize (String)

cstr.gif

resource name specifies the resource name of the device you would like to initialize. You can assign the resource name of a device in Measurement & Automation Explorer (MAX). To display a list of compatible resource names, wire a control or constant to this terminal.

PXI Syntax

PXI[bus number]::device number

Note  VISA aliases are also valid for the resource name.

cDAQ and Embedded Syntax

sync://[hostname or IP]/system

You can find a device's hostname or IP address in MAX. To specify a local device in a Linux RT target, enter "localhost" or "127.0.0.1" instead of a hostname or IP.

Examples

Resource name Description
Dev1 DAQmx name (set in MAX)
PXI1Slot5 DAQmx name
PXI0::15::INSTR PXI bus 0, device number 15
PXI::15::INSTR PXI bus 0, device number 15
PXI4::9::INSTR PXI bus 4, device number 9
sync://10.2.172.5/system The remote device with the IP number of 10.2.172.5. You can find this IP number in MAX.
sync://NI-cRIO-9033-01A4B0BE/system The cRIO-9033 device with the hostname NI-cRIO-9033-01A4B0BE. You can find this hostname in MAX.
cbool.gif

id query specifies whether or not to query the instrument ID to determine if the instrument is compatible with the NI-Sync driver. The default is TRUE.

cbool.gif

reset device (F) specifies whether to reset the NI-Sync module to its default state—including the selected time reference, any connected terminals, and all scheduled future time events—during the initialization procedure. The default is FALSE.

Note  This parameter is not supported on Linux RT targets.
cerrcodeclst.gif

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

iio.gif

instrument handle out returns the instrument handle that you obtain from niSync Initialize.

ierrcodeclst.gif

error out returns error conditions that occur after this node runs. This output provides standard error out functionality.

Log in to get a better experience