Device Class

Download PDF

Updated2023-02-21
17 minute(s) read

Device Class

Encapsulates a DAQ device and contains methods and properties that operate on devices outside the context of a task.

Inheritance Hierarchy

SystemObject
SystemMarshalByRefObject
NationalInstruments.DAQmxDevice

Namespace: NationalInstruments.DAQmx
Assembly: NationalInstruments.DAQmx (in NationalInstruments.DAQmx.dll) Version: 20.7.40.49302

Syntax

public class Device : MarshalByRefObject, IDisposable

Public Class Device
	Inherits MarshalByRefObject
	Implements IDisposable

The Device type exposes the following members.

Properties

	Name	Description
	AccessoryConnectionCount	Specifies the number of times a particular connection that results in tangible wear and tear of onboard components has been made on the accessory. This connection count is useful for tracking accessory life and usage.
	AccessoryProductNumbers	Indicates the unique hardware identification number for accessories connected to the device. Each array element corresponds to a connector. For example, index 0 corresponds to connector 0. The array contains 0 for each connector with no accessory connected.
	AccessoryProductTypes	Indicates the model names of accessories connected to the device. Each array element corresponds to a connector. For example, index 0 corresponds to connector 0. The array contains an empty string for each connector with no accessory connected.
	AccessorySerialNumbers	Indicates the serial number for accessories connected to the device. Each array element corresponds to a connector. For example, index 0 corresponds to connector 0. The array contains 0 for each connector with no accessory connected.
	AIBridgeRanges	Indicates pairs of input voltage ratio ranges, in volts per volt, supported by devices that acquire using ratiometric measurements. Each pair consists of the low value followed by the high value.
	AIChargeRanges	Indicates in coulombs pairs of input charge ranges for the device. Each pair consists of the low value followed by the high value.
	AICouplings	Indicates the coupling types supported by this device.
	AICurrentInternalExcitationDiscreteValues	Indicates the set of discrete internal current excitation values supported by this device.
	AICurrentRanges	Indicates the pairs of current input ranges supported by this device. Each pair consists of the low value, followed by the high value.
	AIFrequencyRanges	Indicates the pairs of frequency input ranges supported by this device. Each pair consists of the low value, followed by the high value.
	AIGains	Indicates the input gain settings supported by this device.
	AIMaximumMultiChannelRate	Indicates the maximum sampling rate for an analog input task from this device. To find the maximum rate for the task, take the minimum of AIMaximumSingleChannelRate or the indicated sampling rate of this device divided by the number of channels to acquire data from (including cold-junction compensation and autozero channels).
	AIMaximumSingleChannelRate	Indicates the maximum rate for an analog input task if the task contains only a single channel from this device.
	AIMinimumRate	Indicates the minimum rate for an analog input task on this device. NI-DAQmx returns a warning or error if you attempt to sample at a slower rate.
	AINumberOfSampleTimingEngines	Indicates the number of Analog Input sample timing engines supported by the device.
	AINumberOfSynchronizationPulseSources	Indicates the number of Analog Input synchronization pulse sources supported by the device.
	AIPhysicalChannels	Indicates an array containing the names of the analog input physical channels available on the device.
	AISampleModes	Gets the sample modes from devices that support sample clocked analog input.
	AISimultaneousSamplingSupported	Indicates if the device supports simultaneous sampling.
	AISupportedMeasurementTypes	Gets the measurement types supported by the physical channels of the device.
	AITriggerUsage	Indicates the analog input trigger types supported by this device.
	AIVoltageInternalExcitationDiscreteValues	Indicates the set of discrete internal voltage excitation values supported by this device. If the device supports ranges of internal excitation values, use AIVoltageInternalExcitationRangeValues to determine supported excitation values.
	AIVoltageInternalExcitationRangeValues	Indicates pairs of internal voltage excitation ranges supported by this device. Each pair consists of the low value, followed by the high value. If the device supports a set of discrete internal excitation values, use AIVoltageInternalExcitationDiscreteValues to determine the supported excitation values.
	AIVoltageRanges	Indicates pairs of input voltage ranges supported by this device. Each pair consists of the low value, followed by the high value.
	AnalogTriggerSupported	Indicates if the device supports analog triggering.
	AOCurrentRanges	Indicates pairs of output current ranges supported by this device. Each pair consists of the low value, followed by the high value.
	AOGains	Indicates the output gain settings supported by this device.
	AOMaximumRate	Indicates the maximum analog output rate of the device.
	AOMinimumRate	Indicates the minimum analog output rate of the device.
	AONumberOfSampleTimingEngines	Indicates the number of Analog Output sample timing engines supported by the device.
	AONumberOfSynchronizationPulseSources	Indicates the number of Analog Output synchronization pulse sources supported by the device.
	AOPhysicalChannels	Indicates an array containing the names of the analog output physical channels available on the device.
	AOSampleClockSupported	Indicates if the device supports the sample clock timing type for analog output tasks.
	AOSampleModes	Gets sample modes supported by devices that support sample clocked analog output.
	AOSupportedOutputTypes	Gets generation types supported by the physical channels of the device.
	AOTriggerUsage	Indicates the analog output trigger types supported by this device.
	AOVoltageRanges	Indicates pairs of output voltage ranges supported by this device. Each pair consists of the low value, followed by the high value.
	BusType	Indicates the bus type of the device.
	CarrierSerialNumber	Indicates the serial number of the device carrier. This value is zero if the carrier does not have a serial number.
	ChassisModuleDeviceNames	Indicates an array containing the names of the modules in the chassis.
	CIMaximumTimebase	Indicates in hertz the maximum counter timebase frequency.
	CIMaxSize	Indicates in bits the size of the counters on the device.
	CIPhysicalChannels	Indicates an array containing the names of the counter input physical channels available on the device.
	CISampleClockSupported	Indicates if the device supports the sample clock timing type for counter input tasks.
	CISampleModes	Gets sample modes supported by devices that support sample clocked counter input.
	CISupportedMeasurementTypes	Gets the measurement types supported by the physical channels of the device.
	CITriggerUsage	Indicates the counter input trigger types supported by this device.
	COMaximumTimebase	Indicates in hertz the maximum counter timebase frequency.
	COMaxSize	Indicates in bits the size of the counters on the device.
	CompactDaqChassisDeviceName	Indicates the name of the CompactDAQ chassis that contains this module.
	CompactDaqChassisSlotNumber	Indicates the slot number in which this module is located in the CompactDAQ chassis.
	CompactRioChassisDeviceName	Indicates the name of the CompactRIO chassis that contains this module.
	CompactRioSlotNumber	Indicates the slot number of the CompactRIO chassis where this module is located.
	COPhysicalChannels	Indicates an array containing the names of the counter output physical channels available on the device.
	COSampleClockSupported	Indicates if the device supports Sample Clock timing for counter output tasks.
	COSampleModes	Gets sample modes supported by devices that support sample clocked counter output.
	COSupportedOutputTypes	Gets the generation types supported by the physical channels of the device.
	COTriggerUsage	Indicates the counter output trigger types supported by this device.
	DeviceID	Gets the name of the device, as configured in Measurement Automation Explorer (MAX), to which this operation applies.
	DigitalFilterLowpassCutoffFrequencyDiscreteValues	Indicates the set of discrete lowpass cutoff frequencies supported by this device. If the device supports ranges of lowpass cutoff frequencies, use AI.DigFltr.Lowpass.CutoffFreq.RangeVals to determine supported frequencies.
	DigitalFilterLowpassCutoffFrequencyRangeValues	Indicates pairs of lowpass cutoff frequency ranges supported by this device. Each pair consists of the low value, followed by the high value. If the device supports a set of discrete lowpass cutoff frequencies, use AI.DigFltr.Lowpass.CutoffFreq.DiscreteVals to determine the supported frequencies.
	DigitalFilterTypes	Indicates the AI digital filter types supported by the device.
	DigitalTriggerSupported	Indicates if the device supports digital triggering.
	DILines	Indicates an array containing the names of the digital input lines available on the device.
	DIMaximumRate	Indicates the maximum digital input rate of the device.
	DINumberOfSampleTimingEngines	Indicates the number of Digital Input sample timing engines supported by the device.
	DIPorts	Indicates an array containing the names of the digital input ports available on the device.
	DITriggerUsage	Indicates the digital input trigger types supported by this device.
	DOLines	Indicates an array containing the names of the digital output lines available on the device.
	DOMaximumRate	Indicates the maximum digital output rate of the device.
	DONumberOfSampleTimingEngines	Indicates the number of Digital Output synchronization pulse sources supported by the device.
	DOPorts	Indicates an array containing the names of the digital output ports available on the device.
	DOTriggerUsage	Indicates the digital output trigger types supported by this device.
	ExternalCalibrationDate	Gets the last date and time that the device underwent an external calibration.
	ExternalCalibrationRecommendedInterval	Indicates in months the National Instruments recommended interval between each external calibration of the device.
	ExternalCalibrationTemperature	Indicates in degrees Celsius the temperature of the device at the time of the last external calibration. Compare this temperature to the current onboard temperature to determine if you should perform another calibration.
	FieldDaqBankDeviceNames	Indicates an array containing the names of the banks in the FieldDAQ.
	FieldDaqDeviceName	Indicates the parent device which this bank is located in.
	IsSelfCalibrationSupported	Indicates whether the device supports self-calibration.
	IsSimulated	Indicates if the device is a simulated device.
	LowpassCutoffFrequenciesDiscreteValues	Indicates the set of discrete lowpass cutoff frequencies supported by this device. If the device supports ranges of lowpass cutoff frequencies, use LowpassCutoffFrequenciesRangeValues to determine supported frequencies.
	LowpassCutoffFrequenciesRangeValues	Indicates pairs of lowpass cutoff frequency ranges supported by this device. Each pair consists of the low value, followed by the high value. If the device supports a set of discrete lowpass cutoff frequencies, use LowpassCutoffFrequenciesDiscreteValues to determine the supported frequencies.
	MaxUserDefinedCalibrationInfoSize	Indicates the maximum length in characters of UserDefinedCalibrationInfo.
	NumberOfDmaChannels	Indicates the number of DMA channels on the device.
	PciBusNumber	Indicates the PCI bus number of the device.
	PciDeviceNumber	Indicates the PCI slot number of the device.
	ProductCategory	Indicates the product category of the device. This category corresponds to the category displayed in MAX when creating NI-DAQmx simulated devices.
	ProductNumber	Indicates the unique hardware identification number for the device.
	ProductType	Indicates the product name of the device.
	PxiChassisNumber	Indicates the PXI chassis number of the device, as identified in MAX.
	PxiSlotNumber	Indicates the PXI slot number of the device.
	RecommendedAccessoryConnectionCountLimit	Indicates the recommended connection count limit for an accessory. If the accessory connection count exceeds this limit, the accessory could require maintenance.
	SelfCalibrationDateTime	Gets the last date and time that the device underwent a self-calibration.
	SelfCalibrationTemperature	Indicates in degrees Celsius the temperature of the device at the time of the last self-calibration. Compare this temperature to the current onboard temperature to determine if you should perform another calibration.
	SerialNumber	Indicates the serial number of the device. This value is zero if the device does not have a serial number.
	Switch	Obsolete. Gets a Switch class for this device that contains properties and methods specific to switch devices.
	TcpipEthernetIP	Indicates the IPv4 address of the Ethernet interface in dotted decimal format. This property returns 0.0.0.0 if the Ethernet interface cannot acquire an address.
	TcpipHostname	Indicates the IPv4 hostname of the device.
	TcpipWirelessIP	Indicates the IPv4 address of the 802.11 wireless interface in dotted decimal format. This property returns 0.0.0.0 if the wireless interface cannot acquire an address.
	TedsHardwareTedsSupported	Indicates whether the device supports hardware TEDS.
	Temperature	Indicates in degrees Celsius the current temperature of the device.
	TimestampEngineCount	Indicates the number of timestamp engines available on the device.
	TimeTriggerCount	Indicates the number of time triggers available on the device.
	TimeTriggerSupported	Indicates whether the device supports time triggering.
	UserDefinedCalibrationInfo	Specifies a string that contains arbitrary, user-defined information. This number of characters in this string can be no more than MaxUserDefinedCalibrationInfoSize.

Top

Methods

	Name	Description
	ChangeExternalCalibrationPassword	Changes the external calibration password of the device.
	CreateObjRef	Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
	DeleteNetworkDevice	Deletes a Network DAQ device previously added to the host.
	Dispose	Releases all resources used by Device.
	Dispose(Boolean)	Releases the managed and unmanaged resources used by Device or optionally releases only the unmanaged resources.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetLifetimeService	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	GetPhysicalChannels	Gets an array that contains the names of the physical channels on this device.
	GetPossibleSCExpressCalibrationAccessoryConnections	Gets the available connections on an SC Express accessory for the specified physical channel(s).
	GetTerminals	Gets an array that contains the names of the terminals on this device.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	InitializeLifetimeService	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	MemberwiseClone(Boolean)	Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
	ReserveNetworkDevice	Reserves the Network DAQ device for the current host. Reservation is required to run NI-DAQmx tasks, and the device must be added in MAX before it can be reserved. This method does not override any existing reservations on the device.
	ReserveNetworkDevice(Boolean)	Reserves the Network DAQ device for the current host. Reservation is required to run NI-DAQmx tasks, and the device must be added in MAX before it can be reserved. Use this method to specify whether to override an existing reservation.
	Reset	Immediately aborts all active tasks associated with a device and returns the device to an initialized state.
	RestoreLastExternalCalibration	Sets the self-calibration constants of the device to the current external calibration constants.
	SelfCalibrate	Measures the onboard reference voltage of the device and adjusts the self-calibration constants to account for any error caused by short-term fluctuation in the operating environment.
	SelfTest	Performs a brief test of the device resources. If a failure occurs, refer to your device documentation for more information.
	StartExternalCalibration	Starts an external calibration session on a device.
	ToString	Returns a string representation of the object. (Overrides ObjectToString.)
	UnreserveNetworkDevice	Unreserves or releases a Network DAQ device previously reserved by the host.

Top

Remarks

Tip
Example applications are located in the Public Documents\National Instruments\NI-DAQ\Examples\DotNET4.x directory or in the Start menu at National InstrumentsNI-DAQmxNI-DAQmx Examples.

You can use the Device class to perform operations on an NI-DAQmx device. You cannot instantiate the Device class directly. Instead, use the LoadDevice(String) method to obtain an instance of the Device class. For example, you can self-calibrate an NI-DAQmx device with the Device class.

Examples

Dim dev as Device
dev = DaqSystem.Local.LoadDevice("dev1")
dev.SelfCalibrate()

Examples

Device dev = DaqSystem.Local.LoadDevice("dev1");
dev.SelfCalibrate();

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

NI-DAQmx .NET Framework 4.0 API Reference

Filters

Content Type

Programming Language

Table of Contents

Device Class

Device Class

Inheritance Hierarchy

Syntax

Properties

Methods

Remarks

Examples

Examples

Thread Safety

See Also

Reference

In This Section

Additional Comments

Download PDF