niSwitch Properties
- Updated2023-02-21
- 8 minute(s) read
August 2013
Use the NI-SWITCH properties to access advanced configuration options for switch applications.
© 2007–2013 National Instruments. All rights reserved.
Property | Description |
---|---|
Active Channel |
Specifies the channel name the instrument driver uses to access all subsequent channel-based properties in this property node. Set the active channel before setting channel-based properties. Details |
Channel Configuration:Is Configuration Channel |
Specifies whether to designate the channel as a configuration channel—a channel reserved for internal path creation. The instrument driver uses configuration channels to create paths between the channels you specify in the niSwitch Connect Channels VI. Details |
Channel Configuration:Is Source Channel |
Specifies whether to designate the channel as a source channel. Details |
Channel Configuration:Analog Bus Sharing Enable |
Enables or disables sharing of an analog bus line so that multiple NI SwitchBlock devices may connect to it simultaneously. To enable multiple NI SwitchBlock devices to share an analog bus line, set this property to TRUE for each device on the channel that corresponds with the shared analog bus line. The default value for all devices is FALSE, which disables sharing of the analog bus. Details |
Inherent IVI Attributes:Advanced Session Information:Driver Setup |
Contains the Driver Setup string that you specified when initializing the instrument driver. Details |
Inherent IVI Attributes:Advanced Session Information:IO Resource Descriptor |
Contains the resource descriptor the instrument driver uses to identify the physical device. Details |
Inherent IVI Attributes:Advanced Session Information:Logical Name |
Contains the logical name you specified when opening the current IVI session. Details |
Inherent IVI Attributes:Driver Capabilities:Channel Count |
Contains the number of channels that the instrument driver supports. Details |
Inherent IVI Attributes:Driver Capabilities:Class Group Capabilities |
Contains a comma-separated (,) list of class-extension groups that the instrument driver implements. Details |
Inherent IVI Attributes:Driver Capabilities:Supported Instrument Models |
Contains a comma-separated (,) list of supported instrument models. Details |
Inherent IVI Attributes:Driver Identification:Class Specification Major Version |
Contains the major version number of the IviSwtch class specification. Details |
Inherent IVI Attributes:Driver Identification:Class Specification Minor Version |
Contains the minor version number of the class specification with which the instrument driver is compliant. Details |
Inherent IVI Attributes:Driver Identification:Description |
Contains a brief description of the instrument driver. Details |
Inherent IVI Attributes:Driver Identification:Driver Prefix |
Contains the prefix for all of the instrument driver VIs. Details |
Inherent IVI Attributes:Driver Identification:Driver Vendor |
Contains the name of the vendor that supplies the instrument driver. Details |
Inherent IVI Attributes:Driver Identification:Revision |
Contains additional version information about the instrument driver. Details |
Inherent IVI Attributes:Instrument Identification:Firmware Revision |
Contains the firmware revision information for the instrument currently in use. Details |
Inherent IVI Attributes:Instrument Identification:Manufacturer |
Contains the name of the manufacturer of the instrument currently in use. Details |
Inherent IVI Attributes:Instrument Identification:Model |
Contains the model number or name of the instrument currently in use. Details |
Inherent IVI Attributes:User Options:Cache |
Specifies whether to cache the value of properties. The default value is TRUE. Use the niSwitch Initialize With Options VI to override the default value. Details |
Inherent IVI Attributes:User Options:Interchange Check |
Specifies whether to perform interchangeability checking and retrieve interchangeability warnings when you call the niSwitch Connect Channels, niSwitch Set Path and niSwitch Initiate Scan VIs. The default value is FALSE. Details |
Inherent IVI Attributes:User Options:Query Instrument Status |
Specifies whether the instrument driver queries the instrument status after each operation. The default value is TRUE. Use the niSwitch Initialize With Options VI to override the default value. Details |
Inherent IVI Attributes:User Options:Range Check |
Specifies whether to validate property values and VI parameters. The default value is TRUE. Use the niSwitch Initialize With Options VI to override the default value. Details |
Inherent IVI Attributes:User Options:Record Value Coercions |
Specifies whether the IVI engine keeps a list of the value coercions it makes for properties with ViInt32 and ViReal64 datatypes. The default value is FALSE. Use the niSwitch Initialize With Options VI to override the default value. Details |
Inherent IVI Attributes:User Options:Simulate |
Specifies whether to simulate instrument driver I/O operations. The default value is FALSE. Use the niSwitch Initialize With Options VI to override the default value. Details |
Matrix Configuration:Number of Columns |
Returns the number of channels on the column of a matrix or scanner. If the switch module is a scanner, this property returns the number of input channels. Details |
Matrix Configuration:Number of Rows |
Returns the number of channels on the row of a matrix or scanner. If the switch module is a scanner, this property returns the number of output channels. Details |
Module Characteristics:Bandwidth |
Returns the bandwidth for the channel in hertz. Details |
Module Characteristics:Characteristic Impedance |
Returns the characteristic impedance for the channel in ohms. Details |
Module Characteristics:Is Debounced |
Indicates whether the entire switch module has settled since the last switching command. A value of TRUE indicates that all signals going through the switch module are valid. Details |
Module Characteristics:Maximum AC Voltage |
Returns the maximum AC voltage the channel can switch in volts RMS. Details |
Module Characteristics:Maximum Carry AC Current |
Returns the maximum AC current the channel can carry in amperes RMS. Details |
Module Characteristics:Maximum Carry AC Power |
Returns the maximum AC power the channel can carry in volt-amperes. Details |
Module Characteristics:Maximum Carry DC Current |
Returns the maximum DC current the channel can carry in amperes. Details |
Module Characteristics:Maximum Carry DC Power |
Returns the maximum DC power the channel can carry in watts. Details |
Module Characteristics:Maximum DC Voltage |
Returns the maximum DC voltage the channel can switch in volts. Details |
Module Characteristics:Maximum Switching AC Current |
Returns the maximum AC current the channel can switch in amperes RMS. Details |
Module Characteristics:Maximum Switching AC Power |
Returns the maximum AC power the channel can switch in volt-amperes. Details |
Module Characteristics:Maximum Switching DC Current |
Returns the maximum DC current the channel can switch in amperes. Details |
Module Characteristics:Maximum Switching DC Power |
Returns the maximum DC power the channel can switch in watts. Details |
Module Characteristics:Number of Relays |
Returns the number of relays that the instrument driver supports. Details |
Module Characteristics:Power Down Latching Relays After Debounce |
Specifies whether to power down latching relays after calling the niSwitch Wait For Debounce VI. Set this property to TRUE to ensure that the relays settle and the latching relays power down after you call the niSwitch Wait for Debounce VI. Details |
Module Characteristics:Serial Number |
Returns the serial number for the switch module controlled by the instrument driver. If the switch module does not return a serial number, the instrument driver returns the Invalid Attribute error. Details |
Module Characteristics:Settling Time |
Returns the maximum length of time in seconds from after you make a connection until the signal flowing through the channel settles. Settling time can vary depending on the switch module. Details |
Module Characteristics:Temperature |
Returns the temperature as read by the Switch module in degrees Celsius. Refer to the device documentation for more information. Details |
Module Characteristics:Wire mode |
Returns the wire mode of the switch module. This property affects the values of the Number of Rows and Number of Columns properties. The actual number of input and output lines on the switch module does not change, but the number of channels depends on how many lines constitute each channel. Details |
Scanning Configuration:Continuous Scan |
Specifies whether to continuously scan through a scan list. Set the property to FALSE to stop scanning after one pass through the scan list. Set this property to TRUE to loop continuously through the scan list. Details |
Scanning Configuration:Digital Filter Enable |
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. Details |
Scanning Configuration:Handshaking Initiation |
Specifies how to start handshaking with a measurement device. Details |
Scanning Configuration:Is Scanning |
Indicates whether the switch module has completed the scan operation. TRUE indicates that the scan has completed. Details |
Scanning Configuration:Is Waiting for Trigger? |
Indicates with a semi-colon (;) that at that point in the scan list, the scan engine should pause until a trigger is received from the trigger input. If you generate that trigger through either a hardware pulse or the niSwitch Send Software Trigger VI, you must know when the scan engine has reached such a state. Details |
Scanning Configuration:Scan Advanced Output |
Specifies the method to use to notify another instrument that all signals through the switch module have settled following the processing of one entry in the scan list. Details |
Scanning Configuration:Scan Advanced Polarity |
Specifies the driving level for the Scan Advanced Output signal sent from the switch module through either the external (PXI/PXIe) or front connector (SCXI) lines. When the Scan Advanced Output signal is sent to one of the PXI_Trig lines, the driven level is always low and this property is ignored. Between each Scan Advanced Output signal, the line is not driven and is in a high-impedance state. Details |
Scanning Configuration:Scan Delay |
Specifies the minimum amount of time the switch module waits before it asserts the scan advanced output trigger after opening or closing the switch. The switch module always waits for debounce before asserting the trigger. Thus, the actual delay will always be the greater value of the settling time and the value you specify as the switch delay, measured in seconds. Settling time can vary depending on the switch module. Details |
Scanning Configuration:Scan List |
Contains a scan list (a string that specifies channel connections and trigger conditions). The niSwitch Initiate Scan VI makes or breaks connections and waits for triggers according to the instructions in the scan list. The scan list is comprised of channel names separated by special characters that determine the operations the scanner performs on the channels when it executes the scan list. Details |
Scanning Configuration:Scan Mode |
Specifies how to handle 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 module to connect CH1 to CH3, this property specifies what happens to the connection between CH1 and CH2. Details |
Scanning Configuration:Trigger Input |
Specifies the source of the trigger for which the switch module can wait upon encountering a semi-colon (;) when processing a scan list. When the trigger occurs, the switch module advances to the next entry in the scan list. Details |
Scanning Configuration:Trigger Input Polarity |
Determines the behavior of the trigger input. Details |
Obsolete Attributes:Cabled Module Scan Advanced Bus |
This property has been deprecated and might be removed from a future release of NI-SWITCH. Use niSwitch Route Scan Advanced Output VI instead. Details |
Obsolete Attributes:Cabled Module Trigger Bus |
This property has been deprecated and might be removed from a future release of NI-SWITCH. Use the niSwitch Route Trigger Input VI instead. Details |
Obsolete Attributes:Master Slave Scan Advanced Bus |
This property has been deprecated and might be removed from a future release of NI-SWITCH. Use niSwitch Route Scan Advanced Output VI instead. Details |
Obsolete Attributes:Master Slave Trigger Bus |
This property has been deprecated and might be removed from a future release of NI-SWITCH. Use the niSwitch Route Trigger Input VI instead. Details |
Obsolete Attributes:Parsed Scan List |
This property has been deprecated and might be removed from a future release of NI-SWITCH. Details |
Obsolete Attributes:Serial Number |
This property has been deprecated and might be removed from a future release of NI-SWITCH. Details |
Obsolete Attributes:Trigger Mode |
This property has been deprecated and might be removed from a future release of NI-SWITCH. Use the niSwitch Route Trigger Input and/or niSwitch Route Scan Advanced Output VIs instead. Details |