# Do not edit this file; it was automatically generated.
import collections
import ctypes
import deprecation
import numpy
from nidaqmx import utils
from nidaqmx.system._collections.device_collection import DeviceCollection
from nidaqmx.system._collections.persisted_channel_collection import (
PersistedChannelCollection)
from nidaqmx.system._collections.persisted_scale_collection import (
PersistedScaleCollection)
from nidaqmx.system._collections.persisted_task_collection import (
PersistedTaskCollection)
from nidaqmx.utils import flatten_channel_string, unflatten_channel_string
from nidaqmx.constants import (
AOPowerUpOutputBehavior, LogicFamily, PowerUpChannelType, PowerUpStates, ResistorState,
SignalModifiers, WAIT_INFINITELY)
from nidaqmx.types import (
AOPowerUpState, CDAQSyncConnection, DOPowerUpState, DOResistorPowerUpState)
from nidaqmx.system.device import _DeviceAlternateConstructor
__all__ = ['System']
[docs]class System:
"""
Represents a DAQmx system.
Contains static properties that access tasks, scales, and global channels
stored in Measurement Automation Explorer (MAX), performs immediate
operations on DAQ hardware, and creates classes from which you can get
information about the hardware.
"""
def __init__(self, grpc_options=None):
"""
Args:
grpc_options (Optional[:class:`~nidaqmx.GrpcSessionOptions`]): Specifies
the gRPC session options.
"""
self._interpreter = utils._select_interpreter(grpc_options)
[docs] @staticmethod
def local():
"""
nidaqmx.system.system.System: Represents the local DAQmx system.
"""
return System()
[docs] @staticmethod
def remote(grpc_options):
"""
nidaqmx.system.system.System: Represents the remote DAQmx system.
Args:
grpc_options (:class:`~nidaqmx.GrpcSessionOptions`): Specifies
the gRPC session options.
"""
return System(grpc_options)
@property
def devices(self):
"""
nidaqmx.system._collections.DeviceCollection: Indicates the
collection of devices for this DAQmx system.
"""
return DeviceCollection(self._interpreter)
DriverVersion = collections.namedtuple(
'DriverVersion', ['major_version', 'minor_version',
'update_version'])
@property
def driver_version(self):
"""
collections.namedtuple: Indicates the major, minor and update
portions of the installed version of NI-DAQmx.
- major_version (int): Indicates the major portion of the
installed version of NI-DAQmx, such as 7 for version 7.0.
- minor_version (int): Indicates the minor portion of the
installed version of NI-DAQmx, such as 0 for version 7.0.
- update_version (int): Indicates the update portion of the
installed version of NI-DAQmx, such as 1 for version 9.0.1.
"""
return System.DriverVersion(self._major_version, self._minor_version,
self._update_version)
@property
def global_channels(self):
"""
nidaqmx.system._collections.PersistedChannelCollection: Indicates
the collection of global channels for this DAQmx system.
"""
return PersistedChannelCollection(self._interpreter)
@property
def scales(self):
"""
nidaqmx.system._collections.PersistedScaleCollection: Indicates
the collection of custom scales for this DAQmx system.
"""
return PersistedScaleCollection(self._interpreter)
@property
def tasks(self):
"""
nidaqmx.system._collections.PersistedTaskCollection: Indicates
the collection of saved tasks for this DAQmx system.
"""
return PersistedTaskCollection(self._interpreter)
@property
def _major_version(self):
"""
int: Indicates the major portion of the installed version of NI-
DAQmx, such as 7 for version 7.0.
"""
val = self._interpreter.get_system_info_attribute_uint32(0x1272)
return val
@property
def _minor_version(self):
"""
int: Indicates the minor portion of the installed version of NI-
DAQmx, such as 0 for version 7.0.
"""
val = self._interpreter.get_system_info_attribute_uint32(0x1923)
return val
@property
def _update_version(self):
"""
int: Indicates the update portion of the installed version of
NI-DAQmx, such as 1 for version 9.0.1.
"""
val = self._interpreter.get_system_info_attribute_uint32(0x2f22)
return val
[docs] def connect_terms(
self, source_terminal, destination_terminal,
signal_modifiers=SignalModifiers.DO_NOT_INVERT_POLARITY):
"""
Creates a route between a source and destination terminal. The
route can carry a variety of digital signals, such as triggers,
clocks, and hardware events.
Args:
source_terminal (str): Specifies the originating terminal of
the route. A DAQmx terminal constant lists all terminals
available on devices installed in the system. You also
can specify a source terminal by specifying a string
that contains a terminal name.
destination_terminal (str): Specifies the receiving terminal
of the route. A DAQmx terminal constant provides a list
of all terminals available on devices installed in the
system. You also can specify a destination terminal by
specifying a string that contains a terminal name.
signal_modifiers (Optional[nidaqmx.constants.SignalModifiers]):
Specifies whether to invert the signal this function
routes from the source terminal to the destination
terminal.
"""
self._interpreter.connect_terms(
source_terminal, destination_terminal, signal_modifiers.value)
[docs] def disconnect_terms(self, source_terminal, destination_terminal):
"""
Removes signal routes you created by using the DAQmx Connect
Terminals function. The DAQmx Disconnect Terminals function
cannot remove task-based routes, such as those you create
through timing and triggering configuration.
Args:
source_terminal (str): Specifies the originating terminal of
the route. A DAQmx terminal constant lists all terminals
available on devices installed in the system. You also
can specify a source terminal by specifying a string
that contains a terminal name.
destination_terminal (str): Specifies the receiving terminal
of the route. A DAQmx terminal constant provides a list
of all terminals available on devices installed in the
system. You also can specify a destination terminal by
specifying a string that contains a terminal name.
"""
self._interpreter.disconnect_terms(
source_terminal, destination_terminal)
[docs] def tristate_output_term(self, output_terminal):
"""
Sets a terminal to high-impedance state. If you connect an
external signal to a terminal on the I/O connector, the terminal
must be in high-impedance state. Otherwise, the device could
double-drive the terminal and damage the hardware. If you use
this function on a terminal in an active route, the function
fails and returns an error.
Args:
output_terminal (str): Specifies the terminal on the I/O
connector to set to high-impedance state. A DAQmx
terminal constant lists all available terminals on
installed devices. You also can specify an output
terminal by using a string that contains a terminal
name.
"""
self._interpreter.tristate_output_term(
output_terminal)
# region Power Up States Functions
[docs] def set_digital_power_up_states(
self, device_name, power_up_states):
"""
Updates power up states for digital physical channels.
Args:
device_name (str): Specifies the name as configured in MAX
of the device to which this operation applies.
power_up_states (List[nidaqmx.types.DOPowerUpState]):
Contains the physical channels and power up states to
set. Each element of the list contains a physical channel
and the power up state to set for that physical channel.
- physical_channel (str): Specifies the digital line or
port to modify. You cannot modify dedicated digital
input lines.
- power_up_state (:class:`nidaqmx.constants.PowerUpStates`):
Specifies the power up state to set for the physical
channel specified with the **physical_channel** input.
"""
channel_names = []
states = []
for p in power_up_states:
channel_names.append(p.physical_channel)
states.append(p.power_up_state.value)
self._interpreter.set_digital_power_up_states(device_name, channel_names, states)
[docs] def get_digital_power_up_states(self, device_name):
"""
Gets the power up states for digital physical lines.
Args:
device_name (str): Specifies the name as configured in MAX
of the device to which this operation applies.
Returns:
List[nidaqmx.types.DOPowerUpState]:
Contains the physical channels and power up states set. Each
element of the list contains a physical channel and the power
up state set for that physical channel.
- physical_channel (str): Indicates the physical channel that
was modified.
- power_up_state (:class:`nidaqmx.constants.PowerUpStates`):
Indicates the power up state set for the physical channel
specified with the **physical_channel** output.
"""
device = _DeviceAlternateConstructor(device_name, self._interpreter)
channel_names = []
for do_line in device.do_lines:
channel_names.append(do_line.name)
states = self._interpreter.get_digital_power_up_states(device_name, channel_names)
power_up_states = []
for d, p in zip(device.do_lines, states):
power_up_states.append(
DOPowerUpState(physical_channel=d.name,
power_up_state=PowerUpStates(p)))
return power_up_states
[docs] def set_digital_pull_up_pull_down_states(
self, device_name, power_up_states):
"""
Sets the resistor level to pull up or pull down for lines when
they are in tristate logic.
Args:
device_name (str): Specifies the name as configured in MAX
of the device to which this operation applies.
power_up_states (List[nidaqmx.types.DOResistorPowerUpState]):
Contains the physical channels and power up states to
set. Each element of the list contains a physical channel
and the power up state to set for that physical channel.
- physical_channel (str): Specifies the digital line or
port to modify. You cannot modify dedicated digital
input lines.
- power_up_state (:class:`nidaqmx.constants.ResistorState`):
Specifies the power up state to set for the physical
channel specified with the **physical_channel** input.
"""
channel_names = []
states = []
for p in power_up_states:
channel_names.append(p.physical_channel)
states.append(p.power_up_state.value)
self._interpreter.set_digital_pull_up_pull_down_states(device_name, channel_names, states)
[docs] def get_digital_pull_up_pull_down_states(self, device_name):
"""
Gets the resistor level for lines when they are in tristate
logic.
Args:
device_name (str): Specifies the name as configured in MAX
of the device to which this operation applies.
Returns:
List[nidaqmx.types.DOResistorPowerUpState]:
Contains the physical channels and power up states set. Each
element of the list contains a physical channel and the power
up state set for that physical channel.
- physical_channel (str): Indicates the physical channel that
was modified.
- power_up_state (:class:`nidaqmx.constants.ResistorState`):
Indicates the power up state set for the physical channel
specified with the **physical_channel** output.
"""
channel_names = []
states = []
device = _DeviceAlternateConstructor(device_name, self._interpreter)
for do_line in device.do_lines:
channel_names.append(do_line.name)
states = self._interpreter.get_digital_pull_up_pull_down_states(device_name, channel_names)
power_up_states = []
for d, p in zip(device.do_lines, states):
power_up_states.append(
DOResistorPowerUpState(
physical_channel=d.name,
power_up_state=ResistorState(p)))
return power_up_states
[docs] @deprecation.deprecated(deprecated_in="0.8.0", details="Use set_analog_power_up_states_with_output_type instead.")
def set_analog_power_up_states(self, device_name, power_up_states):
"""
Updates power up states for analog physical channels.
Args:
device_name (str): Specifies the name as configured in MAX
of the device to which this operation applies.
power_up_states (List[nidaqmx.types.AOPowerUpState]):
Contains the physical channels and power up states to
set. Each element of the list contains a physical channel
and the power up state to set for that physical channel.
- physical_channel (str): Specifies the physical channel
to modify.
- power_up_state (float): Specifies the power up state to
set for the physical channel specified with the
**physical_channel** input.
- channel_type (:class:`nidaqmx.constants.AOPowerUpOutputBehavior`):
Specifies the output type for the physical channel
specified with the **physical_channel** input.
"""
channel_names = []
states = []
channel_types = []
for p in power_up_states:
channel_names.append(p.physical_channel)
states.append(p.power_up_state)
channel_types.append(p.channel_type.value)
self._interpreter.set_analog_power_up_states(device_name, channel_names, states, channel_types)
[docs] def set_analog_power_up_states_with_output_type(
self, power_up_states):
"""
Updates power up states for analog physical channels.
Args:
power_up_states (List[nidaqmx.types.AOPowerUpState]):
Contains the physical channels and power up states to
set. Each element of the list contains a physical channel
and the power up state to set for that physical channel.
- physical_channel (str): Specifies the physical channel to
modify.
- power_up_state (float): Specifies the power up state
to set for the physical channel specified with the
**physical_channel** input.
- channel_type (:class:`nidaqmx.constants.AOPowerUpOutputBehavior`):
Specifies the output type for the physical channel
specified with the **physical_channel** input.
"""
physical_channel = flatten_channel_string(
[p.physical_channel for p in power_up_states])
state = numpy.float64(
[p.power_up_state for p in power_up_states])
channel_type = numpy.int32(
[p.channel_type.value for p in power_up_states])
self._interpreter.set_analog_power_up_states_with_output_type(physical_channel, state, channel_type)
[docs] @deprecation.deprecated(deprecated_in="0.8.0", details="Use get_analog_power_up_states_with_output_type instead.")
def get_analog_power_up_states(self, device_name):
"""
Gets the power up states for analog physical channels.
Args:
device_name (str): Specifies the name as configured in MAX
of the device to which this operation applies.
Returns:
power_up_states (List[nidaqmx.types.AOPowerUpState]):
Contains the physical channels and power up states set. Each
element of the list contains a physical channel and the
power up state set for that physical channel.
- physical_channel (str): Specifies the physical channel that
was modified.
- power_up_state (float): Specifies the power up state set
for the physical channel specified with the
**physical_channel** input.
- channel_type (:class:`nidaqmx.constants.AOPowerUpOutputBehavior`):
Specifies the output type for the physical channel
specified with the **physical_channel** input.
"""
device = _DeviceAlternateConstructor(device_name, self._interpreter)
channel_names = device.ao_physical_chans.channel_names
# Here get_analog_power_up_states is not called, since it is deprecated and passes channel_type in wrong direction
return self.get_analog_power_up_states_with_output_type(channel_names)
[docs] def get_analog_power_up_states_with_output_type(self, physical_channels):
"""
Gets the power up states for analog physical channels.
Args:
physical_channels (List[str]): Indicates the physical
channels that were modified.
Returns:
power_up_states (List[nidaqmx.types.AOPowerUpState]):
Contains the physical channels and power up states set. Each
element of the list contains a physical channel and the
power up state set for that physical channel.
- physical_channel (str): Specifies the physical channel that
was modified.
- power_up_state (float): Specifies the power up state set
for the physical channel specified with the
**physical_channel** input.
- channel_type (:class:`nidaqmx.constants.AOPowerUpOutputBehavior`):
Specifies the output type for the physical channel
specified with the **physical_channel** input.
"""
states, channel_types = self._interpreter.get_analog_power_up_states_with_output_type(
flatten_channel_string(physical_channels), len(physical_channels))
assert len(states) == len(physical_channels)
assert len(channel_types) == len(physical_channels)
power_up_states = []
for p, s, c in zip(physical_channels, states, channel_types):
power_up_states.append(
AOPowerUpState(
physical_channel=p,
power_up_state=float(s),
channel_type=PowerUpChannelType(c)))
return power_up_states
[docs] def set_digital_logic_family_power_up_state(
self, device_name, logic_family):
"""
Sets the digital logic family to use when the device powers up.
Args:
device_name (str): Specifies the name as configured in MAX
of the device to which this operation applies.
logic_family (nidaqmx.constants.LogicFamily): Specifies the
logic family set to the device to when it powers up. A
logic family corresponds to voltage thresholds that are
compatible with a group of voltage standards. Refer to
device documentation for information on the logic high
and logic low voltages for these logic families.
"""
self._interpreter.set_digital_logic_family_power_up_state(device_name, logic_family.value)
[docs] def get_digital_logic_family_power_up_state(self, device_name):
"""
Gets the digital logic family for a device.
Args:
device_name (str): Specifies the name as configured in MAX
of the device to which this operation applies.
Returns:
nidaqmx.constants.LogicFamily:
Specifies the logic family to set the device to when it powers
up. A logic family corresponds to voltage thresholds that are
compatible with a group of voltage standards. Refer to device
documentation for information on the logic high and logic low
voltages for these logic families.
"""
logic_family = self._interpreter.get_digital_logic_family_power_up_state(device_name)
return LogicFamily(logic_family)
# endregion
# region cDAQ Sync Functions
[docs] def add_cdaq_sync_connection(self, ports_to_connect):
"""
Adds a cDAQ Sync connection between devices. The connection is
not verified.
Args:
ports_to_connect (nidaqmx.types.CDAQSyncConnection):
Specifies the cDAQ Sync ports to connect.
"""
port_list = flatten_channel_string(
[ports_to_connect.output_port, ports_to_connect.input_port])
self._interpreter.add_cdaq_sync_connection(port_list)
[docs] def remove_cdaq_sync_connection(self, ports_to_disconnect):
"""
Removes a cDAQ Sync connection between devices. The connection
is not verified.
Args:
ports_to_disconnect (nidaqmx.types.CDAQSyncConnection):
Specifies the cDAQ Sync ports to disconnect.
"""
port_list = flatten_channel_string(
[ports_to_disconnect.output_port, ports_to_disconnect.input_port])
self._interpreter.remove_cdaq_sync_connection(port_list)
# endregion