addAnalogInputChannel

(Not recommended) Add analog input channel

This session object function is not recommended. Use DataAcquisition object functions instead. See Compatibility Considerations.

Syntax

addAnalogInputChannel(s,deviceID,channelID,measurementType)

ch = addAnalogInputChannel(s,deviceID,channelID,measurementType)

[ch,idx] = addAnalogInputChannel(s,deviceID,channelID,measurementType)

Description

addAnalogInputChannel(s,deviceID,channelID,measurementType) adds a channel on the device represented by deviceID, with the specified channelID, and channel measurement type represented by measurementType, to the session s. Measurement types are vendor-specific.

• Use daq.createSession to create a session object before you use this method.

• To use counter channels, see addCounterInputChannel.

ch = addAnalogInputChannel(s,deviceID,channelID,measurementType) creates and returns the channel object ch.

[ch,idx] = addAnalogInputChannel(s,deviceID,channelID,measurementType) creates and returns the object ch, representing the channel that was added, and the index idx, which is an index into the array of the session object Channels property.

Examples

Add an Analog Input Current Channel

s = daq.createSession('ni')
addAnalogInputChannel(s,'cDAQ1Mod3','ai0','Current');

Add an Analog Input Channel and Return Its Index

s = daq.createSession('ni')
[ch,idx] = addAnalogInputChannel(s,'cDAQ2Mod6','ai0','Thermocouple')

Add a Range of Analog Input Channels

s = daq.createSession('ni')
ch = addAnalogInputChannel(s,'cDAQ1Mod1',[0 2 4],'Voltage');

Input Arguments

s — Data acquisition session

session object handle

Data acquisition session specified as a session object handle, created using daq.createSession. Use the data acquisition session for acquisition and generation operations. Create one session per vendor and use that vendor session to perform all data acquisition operations.

For a list of relevant session object properties, see the following Tips.

deviceID — Device ID

character vector or string

Device ID specified as a character vector or string, as defined by the device vendor. Obtain the device ID by calling daq.getDevices.

Data Types: char | string

channelID — Channel ID

numeric value, character vector, or string

Channel ID specified as a numeric value, character vector, or string; or the physical location of the channel on the device. Supported values are specific to the vendor and device. You can add multiple channels by specifying the channel ID as a numeric vector, or an array of character vectors or strings. The index for this channel in the session display indicates the position of this channel in the session. This channel ID is not the same as channel index in the session: if you add a channel with ID 2 as the first channel in a session, the session channel index is 1.

measurementType — Channel measurement type

character vector or string

Channel measurement type specified as a character vector or string. measurementType represents a vendor-defined measurement type. Valid measurement types include:

• 'Voltage'

• 'Thermocouple'

• 'Current'

• 'Accelerometer'

• 'RTD'

• 'Bridge'

• 'Microphone'

• 'IEPE'

Not all devices support all types of measurement.

Data Types: char | string

Output Arguments

ch — Analog input channel object

1-by-n array

Analog input channel that you add, returned as an object containing a 1-by-n array of vendor-specific channel information. Use this channel object to access device and channel properties.

idx — Channel index

numeric

Channel index returned as a numeric value. With this index, you can access the array of the session object Channels property.

Tips

The relevant properties of the data acquisition session are:

ADCTimingMode	Set channel timing mode
BridgeMode	Specify analog input device bridge mode
Coupling	Specify input coupling mode
Device	Channel device information
ExcitationCurrent	Current of external source of excitation
ExcitationSource	External source of excitation
ExcitationVoltage	Voltage of excitation source
ExternalTriggerTimeout	Specify maximum wait time for external trigger
ID	ID of channel in session
MaxSoundPressureLevel	Sound pressure level for microphone channels
MeasurementType	Channel measurement type
Name	Specify descriptive name for the channel
NominalBridgeResistance	Resistance of sensor
R0	Specify resistance value
RTDConfiguration	Specify wiring configuration of RTD device
RTDType	Specify sensor sensitivity
Range	Specify channel measurement range
ScansAcquired	Number of scans acquired during operation
Sensitivity	Sensitivity of an analog channel
ShuntLocation	Indicate location of channel’s shunt resistor
ShuntResistance	Resistance value of channel’s shunt resistor
TerminalConfig	Specify terminal configuration
ThermocoupleType	Select thermocouple type
Units	Specify unit of RTD measurement

Version History

Introduced in R2010b

R2020a: session object interface is not recommended

Not recommended starting in R2020a

Use of this function with a session object is not recommended. To access a data acquisition device, use a DataAcquisition object with its functions and properties instead.

For more information about using the recommended functionality, see Transition Your Code from Session to DataAcquisition Interface.