Skip to content

NI SWITCH Scanning Configuration Attributes

ni-siray edited this page May 7, 2021 · 2 revisions

Scanning Configuration Attributes

NISWITCH_ATTRIBUTE_CABLED_MODULE_SCAN_ADVANCED_BUS

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150009 ViInt32 R/W N/A None None

Description

This attribute has been deprecated and may be removed from a future release of NI-SWITCH. Use the niSwitch_RouteScanAdvancedOutput function instead.

Defined Values:

NISWITCH_VAL_NONE

NISWITCH_VAL_TTL0

NISWITCH_VAL_TTL1

NISWITCH_VAL_TTL2

NISWITCH_VAL_TTL3

NISWITCH_VAL_TTL4

NISWITCH_VAL_TTL5

NISWITCH_VAL_TTL6

NISWITCH_VAL_TTL7

NISWITCH_ATTRIBUTE_CABLED_MODULE_TRIGGER_BUS

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150008 ViInt32 R/W N/A None None

Description

This attribute has been deprecated and may be removed from a future release of NI-SWITCH. Use the niSwitch_RouteTriggerInput function instead.

Defined Values:

NISWITCH_VAL_NONE

NISWITCH_VAL_TTL0

NISWITCH_VAL_TTL1

NISWITCH_VAL_TTL2

NISWITCH_VAL_TTL3

NISWITCH_VAL_TTL4

NISWITCH_VAL_TTL5

NISWITCH_VAL_TTL6

NISWITCH_VAL_TTL7

NISWITCH_ATTRIBUTE_CONTINUOUS_SCAN

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1250026 ViBoolean R/W N/A None None

Description

When a switch is scanning, the switch can either stop scanning when the end of the scan (VI_FALSE) or continue scanning from the top of the scan list again (VI_TRUE).

Notice that if you set the scan to continuous (VI_TRUE), the Wait For Scan Complete operation will always time out and you must call Abort to stop the scan.

Defined Values:

VI_TRUE

VI_FALSE

Related Information

  • niSwitch Properties
  • Scanning

NISWITCH_ATTRIBUTE_DIGITAL_FILTER_ENABLE

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150016 ViBoolean RO N/A None None

Description

This attribute specifies whether to apply the pulse width filter to the Trigger Input. Set the property to TRUE to prevent the switch module from being triggered by pulses that are less than 150 ns on PXI trigger lines 0-7.

When this property is set to FALSE, noise on the PXI trigger lines might trigger the switch module. If the device triggering the switch module can send pulses greater than 150 ns, do not disable this property.

Defined Values:

VI_TRUE

VI_FALSE

NISWITCH_ATTRIBUTE_HANDSHAKING_INITIATION

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150013 ViInt32 R/W N/A None None

Description

Related Information

  • Handshaking
  • niSwitch Properties
  • Scanning

NISWITCH_ATTRIBUTE_IS_SCANNING

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150016 ViBoolean RW N/A None None

Description

This attribute indicates whether the switch has completed the scan operation. If VI_TRUE, the switch module is currently scanning through the scan list (i.e. it is not in the Idle state). If VI_FALSE, the switch module is not currently scaning through the scan list (i.e. it is in the idle state). The value VI_TRUE indicates that the scan is complete.

Defined Values:

VI_TRUE

VI_FALSE

Related Information

  • niSwitch Properties
  • Scanning

NISWITCH_ATTRIBUTE_IS_WAITING_FOR_TRIG

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150004 ViBoolean RO N/A None None

Description

In a scan list, a semicolon (;) is used to indicate that at that point in the scan list, the scan engine should pause until a trigger is received from the trigger input. If that trigger is user generated through either a hardware pulse or the Send SW Trigger operation, it is necessary for the user to know when the scan engine has reached such a state.

Defined Values:

VI_TRUE

VI_FALSE

Related Information

  • niSwitch_ConfigureScanList
  • niSwitch Properties
  • Scanning

NISWITCH_ATTRIBUTE_PARSED_SCAN_LIST

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150012 ViString RO N/A None None

Description

This attribute has been deprecated and may be removed from a future release of NI-SWITCH.

NISWITCH_ATTRIBUTE_MASTER_SLAVE_SCAN_ADVANCED_BUS

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150007 ViInt32 R/W N/A None None

Description

This attribute has been deprecated and may be removed from a future release of NI-SWITCH. Use the niSwitch_RouteScanAdvancedOutput function instead.

Defined Values:

NISWITCH_VAL_NONE

NISWITCH_VAL_TTL0

NISWITCH_VAL_TTL1

NISWITCH_VAL_TTL2

NISWITCH_VAL_TTL3

NISWITCH_VAL_TTL4

NISWITCH_VAL_TTL5

NISWITCH_VAL_TTL6

NISWITCH_VAL_TTL7

NISWITCH_ATTRIBUTE_SCAN_ADVANCED_OUTPUT

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1250023 ViInt32 R/W N/A None None

Description

This attribute specifies the method you want to use to notify another instrument that all signals going through the switch have settled following the processing of one entry in the scan list.

Defined Values:

NISWITCH_VAL_NONE

NISWITCH_VAL_EXTERNAL

NISWITCH_VAL_TTL0

NISWITCH_VAL_TTL1

NISWITCH_VAL_TTL2

NISWITCH_VAL_TTL3

NISWITCH_VAL_TTL4

NISWITCH_VAL_TTL5

NISWITCH_VAL_TTL6

NISWITCH_VAL_TTL7

NISWITCH_VAL_PXI_STAR

NISWITCH_VAL_REARCONNECTOR

NISWITCH_VAL_REARCONNECTOR_MODULE1

NISWITCH_VAL_REARCONNECTOR_MODULE2

NISWITCH_VAL_REARCONNECTOR_MODULE3

NISWITCH_VAL_REARCONNECTOR_MODULE4

NISWITCH_VAL_REARCONNECTOR_MODULE5

NISWITCH_VAL_REARCONNECTOR_MODULE6

NISWITCH_VAL_REARCONNECTOR_MODULE7

NISWITCH_VAL_REARCONNECTOR_MODULE8

NISWITCH_VAL_REARCONNECTOR_MODULE9

NISWITCH_VAL_REARCONNECTOR_MODULE10

NISWITCH_VAL_REARCONNECTOR_MODULE11

NISWITCH_VAL_REARCONNECTOR_MODULE12

NISWITCH_VAL_FRONTCONNECTOR

NISWITCH_VAL_FRONTCONNECTOR_MODULE1

NISWITCH_VAL_FRONTCONNECTOR_MODULE2

NISWITCH_VAL_FRONTCONNECTOR_MODULE3

NISWITCH_VAL_FRONTCONNECTOR_MODULE4

NISWITCH_VAL_FRONTCONNECTOR_MODULE5

NISWITCH_VAL_FRONTCONNECTOR_MODULE6

NISWITCH_VAL_FRONTCONNECTOR_MODULE7

NISWITCH_VAL_FRONTCONNECTOR_MODULE8

NISWITCH_VAL_FRONTCONNECTOR_MODULE9

NISWITCH_VAL_FRONTCONNECTOR_MODULE10

NISWITCH_VAL_FRONTCONNECTOR_MODULE11

NISWITCH_VAL_FRONTCONNECTOR_MODULE12

Notes  

- (0) NISWITCH_VAL_NONE The switch does not produce a Scan Advanced Output trigger.

- (2) NISWITCH_VAL_EXTERNAL External Trigger. The switch produces the Scan Advanced Output trigger on the "trigger out" connector.

- (111) NISWITCH_VAL_TTL0 The switch produces the Scan Advanced Output on the SCXI or PXI_TRIG0 line.

- (112) NISWITCH_VAL_TTL1 The switch produces the Scan Advanced Output on the PXI_TRIG1 line.

- (113) NISWITCH_VAL_TTL2 The switch produces the Scan Advanced Output on the SCXI or PXI_TRIG2 line.

- (114) NISWITCH_VAL_TTL3 The switch produces the Scan Advanced Output on the PXI_TRIG3 line.

- (115) NISWITCH_VAL_TTL4 The switch produces the Scan Advanced Output on the PXI_TRIG4 line.

- (116) NISWITCH_VAL_TTL5 The switch produces the Scan Advanced Output on the PXI_TRIG5 line.

- (117) NISWITCH_VAL_TTL6 The switch produces the Scan Advanced Output on the PXI_TRIG6 line.

- (118) NISWITCH_VAL_TTL7 The switch produces the Scan Advanced Output on the PXI_TRIG7 line.

- (125) NISWITCH_VAL_PXI_STAR The switch produces the Scan Advanced Output on the PXI STAR trigger bus.

- (1001) NISWITCH_VAL_FRONTCONNECTOR This indicates that the switch will send its SCANNER ADVANCED output to the front connector. When using SCXI switches as scanners, all the devices that are part of the scanner will send their SCANNER ADVANCED output to their respective front connectors.

Related Information

  • niSwitch Properties
  • Scanning

NISWITCH_ATTRIBUTE_SCAN_ADVANCED_POLARITY

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150011 ViInt32 R/W N/A None None

Description

Defined Values:

NISWITCH_VAL_RISING_EDGE

NISWITCH_VAL_FALLING_EDGE

Related Information

  • niSwitch Properties
  • Scanning

NISWITCH_ATTRIBUTE_SCAN_DELAY

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1250025 ViReal64 R/W N/A None None

Description

This attribute specifies the minimum amount of time the switch waits before it asserts the scan advanced output trigger after opening or closing the switch. The switch always waits for debounce before asserting the trigger. The units are seconds.

Note  PXI-2501/2503/2565/2590/2591 Users—the actual delay will always be the greater value of the settling time and the value you specify as the scan delay.

Related Information

  • niSwitch Properties
  • Scanning

NISWITCH_ATTRIBUTE_SCAN_LIST

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1250020 ViString R/W N/A None None

Description

This attribute contains a scan list)—a string that specifies channel connections and trigger conditions. The niSwitch_InitiateScan function makes or breaks connections and waits for triggers according to the instructions in the scan list. A scan list is comprised of channel names that you separate with special characters. These special characters determine the operations the scanner performs on the channels when it executes this scan list.

  • To create a path between two channels, use the following character between the two channel names: -> (a dash followed by a '>' sign) Example: \CH1->CH2\ tells the switch to make a path from channel CH1 to channel CH2.
  • To break or clear a path, use the following character as a prefix before the path: ~ (tilde) Example: ~CH1->CH2\ tells the switch to break the path from channel CH1 to channel CH2.
  • To tell the switch to wait for a trigger event, use the following character as a separator between paths: ; (semicolon) Example: \CH1->CH2;CH3->CH4\ tells the switch to make the path from channel CH1 to channel CH2, wait for a trigger, and then make the path from CH3 to CH4.
  • To tell the switch module to create multiple paths as quickly as possible, use the & (ampersand) or && (double ampersand) as a separator between the paths. The & in 'CH0->CH1;CH2->CH3&CH4->CH5' instructs the scanner to make the path between channels CH0 and CH1, wait for a trigger, and then make the paths between channels CH2 and CH3 and between channels CH4 and CH5 in no particular order without waiting for settling or waiting for a trigger. If wait for settling is desired, replace & with &&. The && in 'CH0->CH1;CH2->CH3&&CH4->CH5' instructs the scanner to make the path between channels CH0 and CH1, wait for a trigger, and then make the path between channels CH2 and CH3, wait for settling, then make the path between channels CH4 and CH5.

Refer to Scan Lists) for additional information.

Related Information

  • niSwitch Properties
  • Scan Lists
  • Scanning

NISWITCH_ATTRIBUTE_SCAN_MODE

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1250021 ViInt32 R/W N/A None None

Description

This attribute specifies what happens to existing connections that conflict with the connections you make in a scan list. For example, if CH1 is already connected to CH2 and the scan list instructs the switch to connect CH1 to CH3, this attribute specifies what happens to the connection between CH1 and CH2. If the value of this attribute is NISWITCH_VAL_NONE, the switch takes no action on existing paths. If the value is NISWITCH_VAL_BREAK_BEFORE_MAKE, the switch breaks conflicting paths before making new ones. If the value is NISWITCH_VAL_BREAK_AFTER_MAKE, the switch breaks conflicting paths after making new ones. Most switches support only one of the possible values. In such cases, this attribute serves as an indicator of the device's behavior.

Defined Values:

NISWITCH_VAL_NONE

NISWITCH_VAL_BREAK_BEFORE_MAKE

NISWITCH_VAL_BREAK_AFTER_MAKE

Related Information

  • niSwitch Properties
  • Scanning

NISWITCH_ATTRIBUTE_MASTER_SLAVE_TRIGGER_BUS

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150006 ViInt32 R/W N/A None None

Description

This attribute has been deprecated and may be removed from a future release of NI-SWITCH. Use the niSwitch_RouteTriggerInput function instead.

Defined Values:

NISWITCH_VAL_NONE

NISWITCH_VAL_TTL0

NISWITCH_VAL_TTL1

NISWITCH_VAL_TTL2

NISWITCH_VAL_TTL3

NISWITCH_VAL_TTL4

NISWITCH_VAL_TTL5

NISWITCH_VAL_TTL6

NISWITCH_VAL_TTL7

NISWITCH_VAL_FRONTCONNECTOR

NISWITCH_ATTRIBUTE_TRIGGER_INPUT

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1250022 ViInt32 R/W N/A None None

Description

This attribute specifies the source of the trigger for which the switch can wait when processing a scan list. The switch waits for a trigger when it encounters a semicolon in a scan list. When the trigger occurs, the switch advances to the next entry in the scan list.

Defined Values:

NISWITCH_VAL_IMMEDIATE

NISWITCH_VAL_EXTERNAL

NISWITCH_VAL_SOFTWARE_TRIG

NISWITCH_VAL_TTL0

NISWITCH_VAL_TTL1

NISWITCH_VAL_TTL2

NISWITCH_VAL_TTL3

NISWITCH_VAL_TTL4

NISWITCH_VAL_TTL5

NISWITCH_VAL_TTL6

NISWITCH_VAL_TTL7

NISWITCH_VAL_PXI_STAR

NISWITCH_VAL_REARCONNECTOR

NISWITCH_VAL_REARCONNECTOR_MODULE1

NISWITCH_VAL_REARCONNECTOR_MODULE2

NISWITCH_VAL_REARCONNECTOR_MODULE3

NISWITCH_VAL_REARCONNECTOR_MODULE4

NISWITCH_VAL_REARCONNECTOR_MODULE5

NISWITCH_VAL_REARCONNECTOR_MODULE6

NISWITCH_VAL_REARCONNECTOR_MODULE7

NISWITCH_VAL_REARCONNECTOR_MODULE8

NISWITCH_VAL_REARCONNECTOR_MODULE9

NISWITCH_VAL_REARCONNECTOR_MODULE10

NISWITCH_VAL_REARCONNECTOR_MODULE11

NISWITCH_VAL_REARCONNECTOR_MODULE12

NISWITCH_VAL_FRONTCONNECTOR

NISWITCH_VAL_FRONTCONNECTOR_MODULE1

NISWITCH_VAL_FRONTCONNECTOR_MODULE2

NISWITCH_VAL_FRONTCONNECTOR_MODULE3

NISWITCH_VAL_FRONTCONNECTOR_MODULE4

NISWITCH_VAL_FRONTCONNECTOR_MODULE5

NISWITCH_VAL_FRONTCONNECTOR_MODULE6

NISWITCH_VAL_FRONTCONNECTOR_MODULE7

NISWITCH_VAL_FRONTCONNECTOR_MODULE8

NISWITCH_VAL_FRONTCONNECTOR_MODULE9

NISWITCH_VAL_FRONTCONNECTOR_MODULE10

NISWITCH_VAL_FRONTCONNECTOR_MODULE11

NISWITCH_VAL_FRONTCONNECTOR_MODULE12

Notes  

- (1) NISWITCH_VAL_IMMEDIATE Immediate Trigger. The switch does not wait for a trigger before processing the next entry in the scan list.

- (2) NISWITCH_VAL_EXTERNAL External Trigger. The switch waits until it receives a trigger from an external source through the "trigger in" connector.

- (3) NISWITCH_VAL_SOFTWARE_TRIG The switch waits until you call the niSwitch_SendSWTrigger function.

- (111) NISWITCH_VAL_TTL0 The switch waits until it receives a trigger on the SCXI or PXI_TRIG0 line before processing the next entry in the scan list.

- (112) NISWITCH_VAL_TTL1 The switch waits until it receives a trigger on the PXI_TRIG1 line before processing the next entry in the scan list.

- (113) NISWITCH_VAL_TTL2 The switch waits until it receives a trigger on the SCXI or PXI_TRIG2 line before processing the next entry in the scan list.

- (114) NISWITCH_VAL_TTL3 The switch waits until it receives a trigger on the PXI_TRIG3 line before processing the next entry in the scan list.

- (115) NISWITCH_VAL_TTL4 The switch waits until it receives a trigger on the PXI_TRIG4 line before processing the next entry in the scan list.

- (116) NISWITCH_VAL_TTL5 The switch waits until it receives a trigger on the PXI_TRIG5 line before processing the next entry in the scan list.

- (117) NISWITCH_VAL_TTL6 The switch waits until it receives a trigger on the PXI_TRIG6 line before processing the next entry in the scan list.

- (118) NISWITCH_VAL_TTL7 The switch waits until it receives a trigger on the PXI_TRIG7 line before processing the next entry in the scan list.

- (125) NISWITCH_VAL_PXI_STAR The switch waits until it receives a trigger on the PXI STAR trigger bus before processing the next entry in the scan list.

- (1000) NISWITCH_VAL_REARCONNECTOR The switch waits until it receives a trigger on the Rear connector before processing the next entry in the scan list. This value is valid for SCXI scanners that consist of a single device. If more than one device is used, you must use niSwitch_RouteTriggerInput or niSwitch_RouteScanAdvancedOutput functions to route a trigger from the connector on another module to one of the TTL lines instead.

- (1001) NISWITCH_VAL_FRONTCONNECTOR The switch waits until it receives a trigger on the front connector before processing the next entry in the scan list. When using SCXI scanners, this variable is valid for scanners that consist of a single device. If more than one device is used, you must use the niSwitch_RouteTriggerInput or niSwitch_RouteScanAdvancedOutput functions to route a trigger from the connector on another module to one of the TTL lines instead.

Related Information

  • niSwitch_ConfigureScanList
  • niSwitch Properties
  • Scanning

NISWITCH_ATTRIBUTE_TRIGGER_INPUT_POLARITY

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150010 ViInt32 R/W N/A None None

Description

Determines the behavior of the trigger input.

Defined Values:

NISWITCH_VAL_RISING_EDGE

NISWITCH_VAL_FALLING_EDGE

Related Information

  • niSwitch Properties
  • Scanning

NISWITCH_ATTRIBUTE_TRIGGER_MODE

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150005 ViInt32 R/W N/A None None

Description

This attribute has been deprecated and may be removed from a future release of NI-SWITCH. Use the niSwitch_RouteTriggerInput and/or niSwitch_RouteScanAdvancedOutput functions instead.

Defined Values:

NISWITCH_VAL_SINGLE

NISWITCH_VAL_MASTER

NISWITCH_VAL_SLAVE

Table of Contents

Internal Development

Creating and Setting Up a gRPC Server

Server Security Support

Creating a gRPC Client

gRPC Client Examples

Session Utilities API Reference

Driver Documentation

gRPC API Differences From C API

Sharing Driver Sessions Between Clients

C API Docs
NI-DAQmx
NI-DCPOWER
NI-DIGITAL PATTERN DRIVER
NI-DMM
NI-FGEN
NI-FPGA
NI-RFmx Bluetooth
NI-RFmx NR
NI-RFmx WCDMA
NI-RFmx GSM
NI-RFmx CDMA2k
NI-RFmx Instr
NI-RFmx LTE
NI-RFmx SpecAn
NI-RFmx TD-SCDMA
NI-RFmx WLAN
NI-RFSA
NI-RFSG
NI-SCOPE
NI-SWITCH
NI-TCLK
NI-XNET
Clone this wiki locally