Data Acquisition Toolbox™

Building Simulink® Models to Acquire Data from a Device

Function Reference

The functions and the device objects they are associated with are categorized according to usage as shown below. The supported device objects include analog input (AI), analog output (AO), and digital I/O (DIO). The tables indicate which object types each function supports.

Creating Device Objects

Function	Purpose	AI	AO	DIO
`analoginput`	Create analog input object	✓
`analogoutput`	Create analog output object		✓
`digitalio`	Create digital I/O object			✓

Adding Channels and Lines

Function	Purpose	AI	AO	DIO
`addchannel`	Add hardware channels to analog input or analog output object	✓	✓
`addline`	Add hardware lines to digital I/O object			✓
`addmuxchannel`	Add hardware channels when using multiplexer board (National Instruments^® only)	✓

Getting and Setting Properties

Function	Purpose	AI	AO	DIO
`get`	Return device object properties	✓	✓	✓
`inspect`	Open Property Inspector	✓	✓	✓
`set`	Configure or display device object properties	✓	✓	✓
`setverify`	Configure and return specified property	✓	✓	✓

Executing the Object

Function	Purpose	AI	AO	DIO
`islogging`	Determine if analog input object is logging data	✓
`isrunning`	Determine if device object is running	✓	✓	✓
`issending`	Determine if analog output object is sending data		✓
`start`	Start device object	✓	✓	✓
`stop`	Stop device object	✓	✓	✓
`trigger`	Manually execute trigger	✓	✓
`wait`	Wait for device object to stop running	✓	✓

Working with Data

Function	Purpose	AI	AO	DIO
`flushdata`	Remove data from data acquisition engine	✓
`getdata`	Extract data, time, and event information from data acquisition engine	✓
`getsample`	Immediately acquire one sample	✓
`getvalue`	Read values from lines			✓
`peekdata`	Preview most recent acquired data	✓
`putdata`	Queue data in engine for eventual output		✓
`putsample`	Immediately output one sample		✓
`putvalue`	Write values to lines			✓

Getting Information and Help

Function	Purpose	AI	AO	DIO
`daqhelp`	Display help for device objects, constructors, adaptors, functions, and properties	✓	✓	✓
`daqhwinfo`	Display data acquisition hardware information	✓	✓	✓
`propinfo`	Return property characteristics for device objects, channels, or lines	✓	✓	✓

General Purpose

Function	Purpose	AI	AO	DIO
`binvec2dec`	Convert binary vector to decimal value			✓
`clear`	Remove device objects from MATLAB^® workspace	✓	✓	✓
`daqcallback`	Callback function that displays event information for specified event	✓	✓	✓
`daqfind`	Return device objects, channels, or lines from data acquisition engine to MATLAB workspace	✓	✓	✓
`daqmem`	Allocate or display memory resources	✓	✓
`daqread`	Read the Data Acquisition Toolbox™ (`.daq`) file	✓
`daqregister`	Register or unregister hardware driver adaptor	✓	✓	✓
`daqreset`	Remove device objects, engine MEX-file, and adaptor DLLs from memory	✓	✓	✓
`dec2binvec`	Convert decimal value to binary vector			✓
`delete`	Remove device objects, channels, or lines from data acquisition engine	✓	✓	✓
`disp`	Display summary information for device objects, channels, or lines	✓	✓	✓
`ischannel`	Check for channels	✓	✓	✓
`isdioline`	Check for lines	✓	✓	✓
`isvalid`	Determine if device objects, channels, or lines are valid	✓	✓	✓
`length`	Return length of device object, channel group, or line group	✓	✓	✓
`load`	Load device objects, channels, or lines into MATLAB workspace	✓	✓	✓
`makenames`	Generate list of descriptive channel or line names	✓	✓	✓
`muxchanidx`	Return multiplexed scanned channel index (National Instruments^® only)	✓
`obj2mfile`	Convert device objects, channels, or lines to the MATLAB code	✓	✓	✓
`save`	Save device objects to MAT-file	✓	✓	✓
`showdaqevents`	Display event log information	✓	✓
`size`	Return size of device object, channel group, or line group	✓	✓	✓

Building Simulink^® Models to Acquire Data from a Device

Functions — Alphabetical List