niswitch.Session properties

niswitch.Session.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. Refer to the Using the Analog Bus on an NI SwitchBlock Carrier topic in the NI Switches Help for more information about sharing the analog bus.

Tip

This property can use repeated capabilities (usually channels). If set or get directly on the analog_bus_sharing_enable.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an analog_bus_sharing_enable.Session instance, and calling set/get value on the result.:

session['0,1'].analog_bus_sharing_enable = var
var = session['0,1'].analog_bus_sharing_enable

The following table lists the characteristics of this property.

Characteristic Value
Datatype bool
Permissions read-write
Channel Based True
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Channel Configuration:Analog Bus Sharing Enable
  • C Attribute: NISWITCH_ATTR_ANALOG_BUS_SHARING_ENABLE
niswitch.Session.bandwidth

This channel-based property returns the bandwidth for the channel. The units are hertz.

Tip

This property can use repeated capabilities (usually channels). If set or get directly on the bandwidth.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an bandwidth.Session instance, and calling set/get value on the result.:

session['0,1'].bandwidth = var
var = session['0,1'].bandwidth

The following table lists the characteristics of this property.

Characteristic Value
Datatype float
Permissions read only
Channel Based True
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Module Characteristics:Bandwidth
  • C Attribute: NISWITCH_ATTR_BANDWIDTH
niswitch.Session.cabled_module_scan_advanced_bus

This property has been deprecated and may be removed from a future release of NI-SWITCH. Use the niswitch.Session.route_scan_advanced_output() method instead.

The following table lists the characteristics of this property.

Characteristic Value
Datatype int
Permissions read-write
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Obsolete Attributes:Cabled Module Scan Advanced Bus
  • C Attribute: NISWITCH_ATTR_CABLED_MODULE_SCAN_ADVANCED_BUS
niswitch.Session.cabled_module_trigger_bus

This property has been deprecated and may be removed from a future release of NI-SWITCH. Use the niswitch.Session.route_trigger_input() method instead.

The following table lists the characteristics of this property.

Characteristic Value
Datatype int
Permissions read-write
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Obsolete Attributes:Cabled Module Trigger Bus
  • C Attribute: NISWITCH_ATTR_CABLED_MODULE_TRIGGER_BUS
niswitch.Session.cache

Specifies whether to cache the value of properties. When caching is enabled, the instrument driver keeps track of the current instrument settings and avoids sending redundant commands to the instrument. The instrument driver can choose always to cache or never to cache particular properties regardless of the setting of this property. The default value is True. Use the niswitch.Session.InitWithOptions() method to override this value.

Note

One or more of the referenced methods are not in the Python API for this driver.

The following table lists the characteristics of this property.

Characteristic Value
Datatype bool
Permissions read-write
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Inherent IVI Attributes:User Options:Cache
  • C Attribute: NISWITCH_ATTR_CACHE
niswitch.Session.channel_count

Indicates the number of channels that the specific instrument driver supports.

The following table lists the characteristics of this property.

Characteristic Value
Datatype int
Permissions read only
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Inherent IVI Attributes:Driver Capabilities:Channel Count
  • C Attribute: NISWITCH_ATTR_CHANNEL_COUNT
niswitch.Session.characteristic_impedance

This channel-based property returns the characteristic impedance for the channel. The units are ohms.

Tip

This property can use repeated capabilities (usually channels). If set or get directly on the characteristic_impedance.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an characteristic_impedance.Session instance, and calling set/get value on the result.:

session['0,1'].characteristic_impedance = var
var = session['0,1'].characteristic_impedance

The following table lists the characteristics of this property.

Characteristic Value
Datatype float
Permissions read only
Channel Based True
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Module Characteristics:Characteristic Impedance
  • C Attribute: NISWITCH_ATTR_CHARACTERISTIC_IMPEDANCE
niswitch.Session.continuous_scan

When a switch device is scanning, the swich can either stop scanning when the end of the scan (False) or continue scanning from the top of the scan list again (True). Notice that if you set the scan to continuous (True), the Wait For Scan Complete operation will always time out and you must call Abort to stop the scan.

The following table lists the characteristics of this property.

Characteristic Value
Datatype bool
Permissions read-write
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Scanning Configuration:Continuous Scan
  • C Attribute: NISWITCH_ATTR_CONTINUOUS_SCAN
niswitch.Session.digital_filter_enable

This property specifies whether to apply the pulse width filter to the Trigger Input. Enabling the Digital Filter (True) prevents the switch module from being triggered by pulses that are less than 150 ns on PXI trigger lines 0–7. When Digital Filter is disabled (False), it is possible for the switch module to be triggered by noise on the PXI trigger lines. If the device triggering the switch is capable of sending pulses greater than 150 ns, you should not disable the Digital Filter.

The following table lists the characteristics of this property.

Characteristic Value
Datatype bool
Permissions read-write
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Scanning Configuration:Digital Filter Enable
  • C Attribute: NISWITCH_ATTR_DIGITAL_FILTER_ENABLE
niswitch.Session.driver_setup

This property indicates the Driver Setup string that the user specified when initializing the driver. Some cases exist where the end-user must specify instrument driver options at initialization time. An example of this is specifying a particular instrument model from among a family of instruments that the driver supports. This is useful when using simulation. The end-user can specify driver-specific options through the DriverSetup keyword in the optionsString parameter to the niswitch.Session.InitWithOptions() method, or through the IVI Configuration Utility. If the user does not specify a Driver Setup string, this property returns an empty string.

Note

One or more of the referenced methods are not in the Python API for this driver.

The following table lists the characteristics of this property.

Characteristic Value
Datatype str
Permissions read only
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Inherent IVI Attributes:Advanced Session Information:Driver Setup
  • C Attribute: NISWITCH_ATTR_DRIVER_SETUP
niswitch.Session.group_capabilities

A string that contains a comma-separated list of class-extention groups that this driver implements.

The following table lists the characteristics of this property.

Characteristic Value
Datatype str
Permissions read only
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Inherent IVI Attributes:Driver Capabilities:Class Group Capabilities
  • C Attribute: NISWITCH_ATTR_GROUP_CAPABILITIES
niswitch.Session.handshaking_initiation

The following table lists the characteristics of this property.

Characteristic Value
Datatype enums.HandshakingInitiation
Permissions read-write
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Scanning Configuration:Handshaking Initiation
  • C Attribute: NISWITCH_ATTR_HANDSHAKING_INITIATION
niswitch.Session.instrument_firmware_revision

A string that contains the firmware revision information for the instrument you are currently using.

The following table lists the characteristics of this property.

Characteristic Value
Datatype str
Permissions read only
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Inherent IVI Attributes:Instrument Identification:Firmware Revision
  • C Attribute: NISWITCH_ATTR_INSTRUMENT_FIRMWARE_REVISION
niswitch.Session.instrument_manufacturer

A string that contains the name of the instrument manufacturer you are currently using.

The following table lists the characteristics of this property.

Characteristic Value
Datatype str
Permissions read only
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Inherent IVI Attributes:Instrument Identification:Manufacturer
  • C Attribute: NISWITCH_ATTR_INSTRUMENT_MANUFACTURER
niswitch.Session.instrument_model

A string that contains the model number or name of the instrument that you are currently using.

The following table lists the characteristics of this property.

Characteristic Value
Datatype str
Permissions read only
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Inherent IVI Attributes:Instrument Identification:Model
  • C Attribute: NISWITCH_ATTR_INSTRUMENT_MODEL
niswitch.Session.interchange_check

Specifies whether to perform interchangeability checking and retrieve interchangeability warnings when you call niswitch.Session.connect(), niswitch.Session.set_path() and niswitch.Session._initiate_scan() methods. The default value is False. Interchangeability warnings indicate that using your application with a different instrument might cause different behavior. You call niswitch.Session.GetNextInterchangeWarning() to extract interchange warnings. Call the niswitch.Session.ClearInterchangeWarnings() method to clear the list of interchangeability warnings without reading them. Interchangeability checking examines the properties in a capability group only if you specify a value for at least one property within that group. Interchangeability warnings can occur when a property affects the behavior of the instrument and you have not set that property, or the property has been invalidated since you set it.

Note

One or more of the referenced methods are not in the Python API for this driver.

The following table lists the characteristics of this property.

Characteristic Value
Datatype bool
Permissions read-write
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Inherent IVI Attributes:User Options:Interchange Check
  • C Attribute: NISWITCH_ATTR_INTERCHANGE_CHECK
niswitch.Session.io_resource_descriptor

Indicates the resource descriptor the driver uses to identify the physical device. If you initialize the driver with a logical name, this property contains the resource descriptor that corresponds to the entry in the IVI Configuration utility. If you initialize the instrument driver with the resource descriptor, this property contains that value.

The following table lists the characteristics of this property.

Characteristic Value
Datatype str
Permissions read only
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Inherent IVI Attributes:Advanced Session Information:IO Resource Descriptor
  • C Attribute: NISWITCH_ATTR_IO_RESOURCE_DESCRIPTOR
niswitch.Session.is_configuration_channel

This channel-based property specifies whether to reserve the channel for internal path creation. A channel that is available for internal path creation is called a configuration channel. The driver may use configuration channels to create paths between two channels you specify in the niswitch.Session.connect() method. Configuration channels are not available for external connections. Set this property to True to mark the channel as a configuration channel. Set this property to False to mark the channel as available for external connections. After you identify a channel as a configuration channel, you cannot use that channel for external connections. The niswitch.Session.connect() method returns the NISWITCH_ERROR_IS_CONFIGURATION_CHANNEL error when you attempt to establish a connection between a configuration channel and any other channel.

Tip

This property can use repeated capabilities (usually channels). If set or get directly on the is_configuration_channel.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an is_configuration_channel.Session instance, and calling set/get value on the result.:

session['0,1'].is_configuration_channel = var
var = session['0,1'].is_configuration_channel

The following table lists the characteristics of this property.

Characteristic Value
Datatype bool
Permissions read-write
Channel Based True
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Channel Configuration:Is Configuration Channel
  • C Attribute: NISWITCH_ATTR_IS_CONFIGURATION_CHANNEL
niswitch.Session.is_debounced

This property indicates whether the entire switch device has settled since the last switching command. A value of True indicates that all signals going through the switch device are valid.

The following table lists the characteristics of this property.

Characteristic Value
Datatype bool
Permissions read only
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Module Characteristics:Is Debounced
  • C Attribute: NISWITCH_ATTR_IS_DEBOUNCED
niswitch.Session.is_scanning

If True, the switch module is currently scanning through the scan list (i.e. it is not in the Idle state). If False, the switch module is not currently scanning through the scan list (i.e. it is in the Idle state).

The following table lists the characteristics of this property.

Characteristic Value
Datatype bool
Permissions read only
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Scanning Configuration:Is Scanning
  • C Attribute: NISWITCH_ATTR_IS_SCANNING
niswitch.Session.is_source_channel

This channel-based property specifies whether you want to identify the channel as a source channel. Typically, you set this property to True when you attach the channel to a power supply, a method generator, or an active measurement point on the unit under test, and you do not want to connect the channel to another source. The driver prevents source channels from connecting to each other. The niswitch.Session.connect() method returns the NISWITCH_ERROR_ATTEMPT_TO_CONNECT_SOURCES when you attempt to connect two channels that you identify as source channels.

Tip

This property can use repeated capabilities (usually channels). If set or get directly on the is_source_channel.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an is_source_channel.Session instance, and calling set/get value on the result.:

session['0,1'].is_source_channel = var
var = session['0,1'].is_source_channel

The following table lists the characteristics of this property.

Characteristic Value
Datatype bool
Permissions read-write
Channel Based True
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Channel Configuration:Is Source Channel
  • C Attribute: NISWITCH_ATTR_IS_SOURCE_CHANNEL
niswitch.Session.is_waiting_for_trig

In a scan list, a semi-colon (;) 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.

The following table lists the characteristics of this property.

Characteristic Value
Datatype bool
Permissions read only
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Scanning Configuration:Is Waiting for Trigger?
  • C Attribute: NISWITCH_ATTR_IS_WAITING_FOR_TRIG
niswitch.Session.logical_name

A string containing the logical name you specified when opening the current IVI session. You may pass a logical name to the niswitch.Session.init() or niswitch.Session.InitWithOptions() methods. The IVI Configuration utility must contain an entry for the logical name. The logical name entry refers to a virtual instrument section in the IVI Configuration file. The virtual instrument section specifies a physical device and initial user options.

Note

One or more of the referenced methods are not in the Python API for this driver.

The following table lists the characteristics of this property.

Characteristic Value
Datatype str
Permissions read only
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Inherent IVI Attributes:Advanced Session Information:Logical Name
  • C Attribute: NISWITCH_ATTR_LOGICAL_NAME
niswitch.Session.master_slave_scan_advanced_bus

This property has been deprecated and may be removed from a future release of NI-SWITCH. Use the niswitch.Session.route_scan_advanced_output() method instead.

The following table lists the characteristics of this property.

Characteristic Value
Datatype int
Permissions read-write
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Obsolete Attributes:Master Slave Scan Advanced Bus
  • C Attribute: NISWITCH_ATTR_MASTER_SLAVE_SCAN_ADVANCED_BUS
niswitch.Session.master_slave_trigger_bus

This property has been deprecated and may be removed from a future release of NI-SWITCH. Use the niswitch.Session.route_trigger_input() method instead.

The following table lists the characteristics of this property.

Characteristic Value
Datatype int
Permissions read-write
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Obsolete Attributes:Master Slave Trigger Bus
  • C Attribute: NISWITCH_ATTR_MASTER_SLAVE_TRIGGER_BUS
niswitch.Session.max_ac_voltage

This channel-based property returns the maximum AC voltage the channel can switch. The units are volts RMS.

Tip

This property can use repeated capabilities (usually channels). If set or get directly on the max_ac_voltage.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an max_ac_voltage.Session instance, and calling set/get value on the result.:

session['0,1'].max_ac_voltage = var
var = session['0,1'].max_ac_voltage

The following table lists the characteristics of this property.

Characteristic Value
Datatype float
Permissions read only
Channel Based True
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Module Characteristics:Maximum AC Voltage
  • C Attribute: NISWITCH_ATTR_MAX_AC_VOLTAGE
niswitch.Session.max_carry_ac_current

This channel-based property returns the maximum AC current the channel can carry. The units are amperes RMS.

Tip

This property can use repeated capabilities (usually channels). If set or get directly on the max_carry_ac_current.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an max_carry_ac_current.Session instance, and calling set/get value on the result.:

session['0,1'].max_carry_ac_current = var
var = session['0,1'].max_carry_ac_current

The following table lists the characteristics of this property.

Characteristic Value
Datatype float
Permissions read only
Channel Based True
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Module Characteristics:Maximum Carry AC Current
  • C Attribute: NISWITCH_ATTR_MAX_CARRY_AC_CURRENT
niswitch.Session.max_carry_ac_power

This channel-based property returns the maximum AC power the channel can carry. The units are volt-amperes.

Tip

This property can use repeated capabilities (usually channels). If set or get directly on the max_carry_ac_power.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an max_carry_ac_power.Session instance, and calling set/get value on the result.:

session['0,1'].max_carry_ac_power = var
var = session['0,1'].max_carry_ac_power

The following table lists the characteristics of this property.

Characteristic Value
Datatype float
Permissions read only
Channel Based True
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Module Characteristics:Maximum Carry AC Power
  • C Attribute: NISWITCH_ATTR_MAX_CARRY_AC_POWER
niswitch.Session.max_carry_dc_current

This channel-based property returns the maximum DC current the channel can carry. The units are amperes.

Tip

This property can use repeated capabilities (usually channels). If set or get directly on the max_carry_dc_current.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an max_carry_dc_current.Session instance, and calling set/get value on the result.:

session['0,1'].max_carry_dc_current = var
var = session['0,1'].max_carry_dc_current

The following table lists the characteristics of this property.

Characteristic Value
Datatype float
Permissions read only
Channel Based True
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Module Characteristics:Maximum Carry DC Current
  • C Attribute: NISWITCH_ATTR_MAX_CARRY_DC_CURRENT
niswitch.Session.max_carry_dc_power

This channel-based property returns the maximum DC power the channel can carry. The units are watts.

Tip

This property can use repeated capabilities (usually channels). If set or get directly on the max_carry_dc_power.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an max_carry_dc_power.Session instance, and calling set/get value on the result.:

session['0,1'].max_carry_dc_power = var
var = session['0,1'].max_carry_dc_power

The following table lists the characteristics of this property.

Characteristic Value
Datatype float
Permissions read only
Channel Based True
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Module Characteristics:Maximum Carry DC Power
  • C Attribute: NISWITCH_ATTR_MAX_CARRY_DC_POWER
niswitch.Session.max_dc_voltage

This channel-based property returns the maximum DC voltage the channel can switch. The units are volts.

Tip

This property can use repeated capabilities (usually channels). If set or get directly on the max_dc_voltage.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an max_dc_voltage.Session instance, and calling set/get value on the result.:

session['0,1'].max_dc_voltage = var
var = session['0,1'].max_dc_voltage

The following table lists the characteristics of this property.

Characteristic Value
Datatype float
Permissions read only
Channel Based True
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Module Characteristics:Maximum DC Voltage
  • C Attribute: NISWITCH_ATTR_MAX_DC_VOLTAGE
niswitch.Session.max_switching_ac_current

This channel-based property returns the maximum AC current the channel can switch. The units are amperes RMS.

Tip

This property can use repeated capabilities (usually channels). If set or get directly on the max_switching_ac_current.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an max_switching_ac_current.Session instance, and calling set/get value on the result.:

session['0,1'].max_switching_ac_current = var
var = session['0,1'].max_switching_ac_current

The following table lists the characteristics of this property.

Characteristic Value
Datatype float
Permissions read only
Channel Based True
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Module Characteristics:Maximum Switching AC Current
  • C Attribute: NISWITCH_ATTR_MAX_SWITCHING_AC_CURRENT
niswitch.Session.max_switching_ac_power

This channel-based property returns the maximum AC power the channel can switch. The units are volt-amperes.

Tip

This property can use repeated capabilities (usually channels). If set or get directly on the max_switching_ac_power.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an max_switching_ac_power.Session instance, and calling set/get value on the result.:

session['0,1'].max_switching_ac_power = var
var = session['0,1'].max_switching_ac_power

The following table lists the characteristics of this property.

Characteristic Value
Datatype float
Permissions read only
Channel Based True
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Module Characteristics:Maximum Switching AC Power
  • C Attribute: NISWITCH_ATTR_MAX_SWITCHING_AC_POWER
niswitch.Session.max_switching_dc_current

This channel-based property returns the maximum DC current the channel can switch. The units are amperes.

Tip

This property can use repeated capabilities (usually channels). If set or get directly on the max_switching_dc_current.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an max_switching_dc_current.Session instance, and calling set/get value on the result.:

session['0,1'].max_switching_dc_current = var
var = session['0,1'].max_switching_dc_current

The following table lists the characteristics of this property.

Characteristic Value
Datatype float
Permissions read only
Channel Based True
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Module Characteristics:Maximum Switching DC Current
  • C Attribute: NISWITCH_ATTR_MAX_SWITCHING_DC_CURRENT
niswitch.Session.max_switching_dc_power

This channel-based property returns the maximum DC power the channel can switch. The units are watts.

Tip

This property can use repeated capabilities (usually channels). If set or get directly on the max_switching_dc_power.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an max_switching_dc_power.Session instance, and calling set/get value on the result.:

session['0,1'].max_switching_dc_power = var
var = session['0,1'].max_switching_dc_power

The following table lists the characteristics of this property.

Characteristic Value
Datatype float
Permissions read only
Channel Based True
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Module Characteristics:Maximum Switching DC Power
  • C Attribute: NISWITCH_ATTR_MAX_SWITCHING_DC_POWER
niswitch.Session.number_of_relays

This property returns the number of relays.

The following table lists the characteristics of this property.

Characteristic Value
Datatype int
Permissions read only
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Module Characteristics:Number of Relays
  • C Attribute: NISWITCH_ATTR_NUMBER_OF_RELAYS
niswitch.Session.num_of_columns

This property returns the number of channels on the column of a matrix or scanner. If the switch device is a scanner, this value is the number of input channels. The niswitch.Session.wire_mode property affects the number of available columns. For example, if your device has 8 input lines and you use the four-wire mode, then the number of columns you have available is 2.

The following table lists the characteristics of this property.

Characteristic Value
Datatype int
Permissions read only
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Matrix Configuration:Number of Columns
  • C Attribute: NISWITCH_ATTR_NUM_OF_COLUMNS
niswitch.Session.num_of_rows

This property returns the number of channels on the row of a matrix or scanner. If the switch device is a scanner, this value is the number of output channels. The niswitch.Session.wire_mode property affects the number of available rows. For example, if your device has 8 input lines and you use the two-wire mode, then the number of columns you have available is 4.

The following table lists the characteristics of this property.

Characteristic Value
Datatype int
Permissions read only
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Matrix Configuration:Number of Rows
  • C Attribute: NISWITCH_ATTR_NUM_OF_ROWS
niswitch.Session.parsed_scan_list

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

The following table lists the characteristics of this property.

Characteristic Value
Datatype str
Permissions read only
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Obsolete Attributes:Parsed Scan List
  • C Attribute: NISWITCH_ATTR_PARSED_SCAN_LIST
niswitch.Session.power_down_latching_relays_after_debounce

This property specifies whether to power down latching relays after calling Wait For Debounce. When Power Down Latching Relays After Debounce is enabled (True), a call to Wait For Debounce ensures that the relays are settled and the latching relays are powered down.

The following table lists the characteristics of this property.

Characteristic Value
Datatype bool
Permissions read-write
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Module Characteristics:Power Down Latching Relays After Debounce
  • C Attribute: NISWITCH_ATTR_POWER_DOWN_LATCHING_RELAYS_AFTER_DEBOUNCE
niswitch.Session.range_check

Specifies whether to validate property values and method parameters. If enabled, the instrument driver validates the parameter values that you pass to driver methods. Range checking parameters is very useful for debugging. After you validate your program, you can set this property to False to disable range checking and maximize performance. The default value is True. Use the niswitch.Session.InitWithOptions() method to override this value.

Note

One or more of the referenced methods are not in the Python API for this driver.

The following table lists the characteristics of this property.

Characteristic Value
Datatype bool
Permissions read-write
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Inherent IVI Attributes:User Options:Range Check
  • C Attribute: NISWITCH_ATTR_RANGE_CHECK
niswitch.Session.record_coercions

Specifies whether the IVI engine keeps a list of the value coercions it makes for ViInt32 and ViReal64 properties. You call niswitch.Session.GetNextCoercionRecord() to extract and delete the oldest coercion record from the list. The default value is False. Use the niswitch.Session.InitWithOptions() method to override this value.

Note

One or more of the referenced methods are not in the Python API for this driver.

The following table lists the characteristics of this property.

Characteristic Value
Datatype bool
Permissions read-write
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Inherent IVI Attributes:User Options:Record Value Coercions
  • C Attribute: NISWITCH_ATTR_RECORD_COERCIONS
niswitch.Session.scan_advanced_output

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

The following table lists the characteristics of this property.

Characteristic Value
Datatype enums.ScanAdvancedOutput
Permissions read-write
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Scanning Configuration:Scan Advanced Output
  • C Attribute: NISWITCH_ATTR_SCAN_ADVANCED_OUTPUT
niswitch.Session.scan_advanced_polarity

The following table lists the characteristics of this property.

Characteristic Value
Datatype enums.ScanAdvancedPolarity
Permissions read-write
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Scanning Configuration:Scan Advanced Polarity
  • C Attribute: NISWITCH_ATTR_SCAN_ADVANCED_POLARITY
niswitch.Session.scan_delay

This property specifies the minimum amount of time the switch device waits before it asserts the scan advanced output trigger after opening or closing the switch. The switch device always waits for debounce before asserting the trigger. The units are seconds. the greater value of the settling time and the value you specify as the scan delay.

Note

NI PXI-2501/2503/2565/2590/2591 Users–the actual delay will always be

The following table lists the characteristics of this property.

Characteristic Value
Datatype float in seconds or datetime.timedelta
Permissions read-write
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Scanning Configuration:Scan Delay
  • C Attribute: NISWITCH_ATTR_SCAN_DELAY
niswitch.Session.scan_list

This property contains a scan list, which is a string that specifies channel connections and trigger conditions. The niswitch.Session._initiate_scan() method makes or breaks connections and waits for triggers according to the instructions in the scan list. The 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 device to wait for a trigger event, use the following character as a separator between paths: ; (semi-colon) 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.

The following table lists the characteristics of this property.

Characteristic Value
Datatype str
Permissions read-write
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Scanning Configuration:Scan List
  • C Attribute: NISWITCH_ATTR_SCAN_LIST
niswitch.Session.scan_mode

This property 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 device to connect CH1 to CH3, this property specifies what happens to the connection between CH1 and CH2. If the value of this property is NONE, the switch device takes no action on existing paths. If the value is BREAK_BEFORE_MAKE, the switch device breaks conflicting paths before making new ones. If the value is BREAK_AFTER_MAKE, the switch device breaks conflicting paths after making new ones. Most switch devices support only one of the possible values. In such cases, this property serves as an indicator of the device’s behavior.

Note

One or more of the referenced values are not in the Python API for this driver. Enums that only define values, or represent True/False, have been removed.

The following table lists the characteristics of this property.

Characteristic Value
Datatype enums.ScanMode
Permissions read-write
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Scanning Configuration:Scan Mode
  • C Attribute: NISWITCH_ATTR_SCAN_MODE
niswitch.Session.serial_number

This read-only property returns the serial number for the switch device controlled by this instrument driver. If the device does not return a serial number, the driver returns the IVI_ERROR_ATTRIBUTE_NOT_SUPPORTED error.

The following table lists the characteristics of this property.

Characteristic Value
Datatype str
Permissions read only
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Module Characteristics:Serial Number
  • C Attribute: NISWITCH_ATTR_SERIAL_NUMBER
niswitch.Session.settling_time

This channel-based property returns the maximum length of time from after you make a connection until the signal flowing through the channel settles. The units are seconds. the greater value of the settling time and the value you specify as the scan delay.

Note

NI PXI-2501/2503/2565/2590/2591 Users–the actual delay will always be

Tip

This property can use repeated capabilities (usually channels). If set or get directly on the settling_time.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an settling_time.Session instance, and calling set/get value on the result.:

session['0,1'].settling_time = var
var = session['0,1'].settling_time

The following table lists the characteristics of this property.

Characteristic Value
Datatype float in seconds or datetime.timedelta
Permissions read-write
Channel Based True
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Module Characteristics:Settling Time
  • C Attribute: NISWITCH_ATTR_SETTLING_TIME
niswitch.Session.simulate

Specifies whether or not to simulate instrument driver I/O operations. If simulation is enabled, instrument driver methods perform range checking and call Ivi_GetAttribute and Ivi_SetAttribute methods, but they do not perform instrument I/O. For output parameters that represent instrument data, the instrument driver methods return calculated values. The default value is False. Use the niswitch.Session.InitWithOptions() method to override this value.

Note

One or more of the referenced methods are not in the Python API for this driver.

The following table lists the characteristics of this property.

Characteristic Value
Datatype bool
Permissions read-write
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Inherent IVI Attributes:User Options:Simulate
  • C Attribute: NISWITCH_ATTR_SIMULATE
niswitch.Session.specific_driver_class_spec_major_version

The major version number of the IviSwtch class specification.

The following table lists the characteristics of this property.

Characteristic Value
Datatype int
Permissions read only
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Inherent IVI Attributes:Driver Identification:Class Specification Major Version
  • C Attribute: NISWITCH_ATTR_SPECIFIC_DRIVER_CLASS_SPEC_MAJOR_VERSION
niswitch.Session.specific_driver_class_spec_minor_version

The minor version number of the class specification with which this driver is compliant.

The following table lists the characteristics of this property.

Characteristic Value
Datatype int
Permissions read only
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Inherent IVI Attributes:Driver Identification:Class Specification Minor Version
  • C Attribute: NISWITCH_ATTR_SPECIFIC_DRIVER_CLASS_SPEC_MINOR_VERSION
niswitch.Session.specific_driver_description

A string that contains a brief description of the specific driver.

The following table lists the characteristics of this property.

Characteristic Value
Datatype str
Permissions read only
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Inherent IVI Attributes:Driver Identification:Description
  • C Attribute: NISWITCH_ATTR_SPECIFIC_DRIVER_DESCRIPTION
niswitch.Session.specific_driver_revision

A string that contains additional version information about this instrument driver.

The following table lists the characteristics of this property.

Characteristic Value
Datatype str
Permissions read only
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Inherent IVI Attributes:Driver Identification:Revision
  • C Attribute: NISWITCH_ATTR_SPECIFIC_DRIVER_REVISION
niswitch.Session.specific_driver_vendor

A string that contains the name of the vendor that supplies this driver.

The following table lists the characteristics of this property.

Characteristic Value
Datatype str
Permissions read only
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Inherent IVI Attributes:Driver Identification:Driver Vendor
  • C Attribute: NISWITCH_ATTR_SPECIFIC_DRIVER_VENDOR
niswitch.Session.supported_instrument_models

Contains a comma-separated list of supported instrument models.

The following table lists the characteristics of this property.

Characteristic Value
Datatype str
Permissions read only
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Inherent IVI Attributes:Driver Capabilities:Supported Instrument Models
  • C Attribute: NISWITCH_ATTR_SUPPORTED_INSTRUMENT_MODELS
niswitch.Session.temperature

This property returns the temperature as read by the Switch module. The units are degrees Celsius.

The following table lists the characteristics of this property.

Characteristic Value
Datatype float
Permissions read only
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Module Characteristics:Temperature
  • C Attribute: NISWITCH_ATTR_TEMPERATURE
niswitch.Session.trigger_input

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

The following table lists the characteristics of this property.

Characteristic Value
Datatype enums.TriggerInput
Permissions read-write
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Scanning Configuration:Trigger Input
  • C Attribute: NISWITCH_ATTR_TRIGGER_INPUT
niswitch.Session.trigger_input_polarity

Determines the behavior of the trigger Input.

The following table lists the characteristics of this property.

Characteristic Value
Datatype enums.TriggerInputPolarity
Permissions read-write
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Scanning Configuration:Trigger Input Polarity
  • C Attribute: NISWITCH_ATTR_TRIGGER_INPUT_POLARITY
niswitch.Session.trigger_mode

This property has been deprecated and may be removed from a future release of NI-SWITCH. Use the niswitch.Session.route_trigger_input() and/or niswitch.Session.route_scan_advanced_output() methods instead.

The following table lists the characteristics of this property.

Characteristic Value
Datatype int
Permissions read-write
Channel Based False
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Obsolete Attributes:Trigger Mode
  • C Attribute: NISWITCH_ATTR_TRIGGER_MODE
niswitch.Session.wire_mode

This property returns the wire mode of the switch device. This property affects the values of the niswitch.Session.num_of_rows and niswitch.Session.num_of_columns properties. The actual number of input and output lines on the switch device is fixed, but the number of channels depends on how many lines constitute each channel.

Tip

This property can use repeated capabilities (usually channels). If set or get directly on the wire_mode.Session object, then the set/get will use all repeated capabilities in the session. You can specify a subset of repeated capabilities using the Python index notation on an wire_mode.Session instance, and calling set/get value on the result.:

session['0,1'].wire_mode = var
var = session['0,1'].wire_mode

The following table lists the characteristics of this property.

Characteristic Value
Datatype int
Permissions read only
Channel Based True
Resettable No

Tip

This property corresponds to the following LabVIEW Property or C Attribute:

  • LabVIEW Property: Module Characteristics:Wire mode
  • C Attribute: NISWITCH_ATTR_WIRE_MODE