Toolbox Functions (Data Acquisition Toolbox)

Data Acquisition Toolbox

Toolbox Functions

The Data Acquisition Toolbox functions are M-files which allow you to access your hardware's capabilities and perform any data acquisition task. Toolbox functions can be divided into the groups shown below. For a complete description of all functions, refer to Chapter 6, "Function Reference."

Creating Device Objects

Each device object has a corresponding creation function (or constructor), named for the device object it creates. The toolbox creation functions are shown below.


Function	Description
`analoginput`	Create an analog input object.
`analogoutput`	Create an analog output object.

Configuring Device Objects, Channels and Lines

After a device object is created, it must configured. Configuring a device object requires adding channels or lines and setting property values to establish acquisition behavior. The toolbox configuration functions are shown below.


Function	Description
`addchannel`	Add hardware channels to an analog input or analog output object.
`addline`	Add hardware lines to a digital I/O object.
`get`	Return property values.
`set`	Configure or display property values.
`setverify`	Set and return the specified property value.

Executing the Device Object

Executing the device object involves functions that start, stop, and trigger your acquisition. The toolbox execution functions are shown below


Function	Description
`start`	Start the execution of a device object.
`stop`	Stop the execution of a device object.
`trigger`	Manually execute a trigger.

Working with Data

With any data acquisition application, you must send data to your hardware or receive data from your hardware. The toolbox functions that allow you to work with data are shown below.


Function	Description
`flushdata`	Remove data from the data acquisition engine.
`getdata`	Return data, time, and event information to the MATLAB workspace for an analog input object.
`getsample`	Return one sample for each analog input channel group member or digital I/O line group member.
`peekdata`	Immediately return data to the MATLAB workspace for an analog input object.
`putdata`	Queues data in the engine for eventual output to the D/A hardware.
`putsample`	Send one sample for each analog output channel group member or digital I/O line group member.

Getting Information and Help

Functions that provide information or help about installed hardware, driver adaptors, device objects, channels, lines, or properties are shown below.


Functions	Description
`daqhelp`	Display help for device objects, constructors, functions, and properties.
`daqhwinfo`	Display data acquisition hardware information.
`nidaq`	Display information about National Instruments adaptor
`propinfo`	Return property information for device objects, channels, or lines.
`winsound`	Display information for sound card adaptor

General Purpose

The remaining toolbox functions are shown below. Several of these functions are built-in MATLAB functions that have been overloaded (modified) for use with Data Acquisition Toolbox objects.


Function	Description
`clear`	Clear device objects from the MATLAB workspace.
`daqaction`	Display event information for specified event
`daqfind`	Return device objects, channels, or lines from the data acquisition engine to the workspace.
`daqread`	Read a Data Acquisition Toolbox (`.daq`) file.
`daqmem`	Allocate or display memory for one or more device objects.
`daqregister`	Register or unregister a Data Acquisition Toolbox adaptor.
`daqreset`	Remove data acquisition objects and .`dll` files from memory.
`delete`	Delete device objects, channels, or lines.
`disp`	Display device object, channel, and line information.
`ischannel`	Check for channels.
`isline`	Check for lines
`isvalid`	Check for valid device objects, channels, or lines.
`length`	Determine length of data acquisition objects.
`load`	Load device objects into the MATLAB workspace
`makenames`	Generate a list of channel or line names.
`obj2code`	Convert device objects, channels, or lines to MATLAB code and save to disk.
`save`	Save device objects to a MAT-file.
`size`	Determine size of data acquisition objects.

[ Previous | Help Desk | Next ]