Data Acquisition Toolbox

Properties - By Category

This section contains brief descriptions of all toolbox base properties. The properties are categorized according to these subsystems:

• Analog input properties
• Analog output properties
• Digital I/O properties

Depending on the hardware device you are using, additional property names or property values might be present. The additional property names are described in Device-Specific Property Reference. For example, only analog input and analog output objects associated with a sound card have a BitsPerSample property. The additional property values are also device-specific but are included in this chapter. For example, all supported devices have an InputType property, but the value AC-Coupled is unique to analog input objects associated with a sound card.

Analog Input Properties

Analog input base properties are divided into two main categories: common properties and channel properties. Common properties apply to every channel contained by the analog input object, while channel properties can be configured for individual channels.

Common Properties

The analog input common properties are grouped into the following categories based on usage.

Analog Input Basic Setup Properties
SamplesPer Trigger	Specify the number of samples to acquire for each channel group member for each trigger that occurs.
SampleRate	Specify the per-channel rate at which analog data is converted to digital data.
TriggerType	Specify the type of trigger to execute.

Analog Input Logging Properties
LogFileName	Specify the name of the disk file to which information is logged.
Logging	Indicate whether data is being logged to memory or to a disk file.
LoggingMode	Specify the destination for acquired data.
LogToDiskMode	Specify whether data, events, and hardware information are saved to one disk file or to multiple disk files.

Analog Input Trigger Properties
InitialTrigger Time	Indicate the absolute time of the first trigger.
ManualTrigger HwOn	Specify that the hardware device starts when a manual trigger is issued.
TriggerFcn	Specify the M-file callback function to execute when a trigger occurs.
TriggerChannel	Specify the channels serving as trigger sources.
TriggerCondition	Specify the condition that must be satisfied before a trigger executes.
TriggerCondition Value	Specify one or more voltage values that must be satisfied before a trigger executes.
TriggerDelay	Specify the delay value for data logging.
TriggerDelay Units	Specify the units in which trigger delay data is measured.
TriggerRepeat	Specify the number of additional times the trigger executes.
TriggersExecuted	Indicate the number of triggers that execute.
TriggerType	Specify the type of trigger to execute.

Analog Input Status Properties
Logging	Indicate if data is being logged to memory or to a disk file.
Running	Indicate whether the device object is running.
SamplesAcquired	Indicate the number of samples acquired per channel.
SamplesAvailable	Indicate the number of samples available per channel in the engine.

Analog Input Hardware Configuration Properties
ChannelSkew	Specify the time between consecutive scanned hardware channels.
ChannelSkewMode	Specify how the channel skew is determined.
ClockSource	Specify the clock used to govern the hardware conversion rate.
InputType	Specify the analog input hardware channel configuration.
SampleRate	Specify the per-channel rate at which analog data is converted to digital data.

Analog Input Callback Properties
DataMissedFcn	Specify the M-file callback function to execute when data is missed.
InputOverRange Fcn	Specify the M-file callback function to execute when acquired data exceeds the valid hardware range.
RuntimeErrorFcn	Specify the M-file callback function to execute when a run-time error occurs.
SamplesAcquired Fcn	Specify the M-file callback function to execute every time a predefined number of samples is acquired for each channel group member.
SamplesAcquired FcnCount	Specify the number of samples to acquire for each channel group member before a samples acquired event is generated.
StartFcn	Specify the M-file callback function to execute just before the device object starts running.
StopFcn	Specify the M-file callback function to execute just after the device object stops running.
TimerFcn	Specify the M-file callback function to execute whenever a predefined period of time passes.
TimerPeriod	Specify the period of time between timer events.
TriggerFcn	Specify the M-file callback function to execute when a trigger occurs.

Analog Input General Purpose Properties
BufferingConfig	Specify the per-channel allocated memory.
BufferingMode	Specify how memory is allocated.
Channel	Contain hardware channels added to the device object.
EventLog	Store information for specific events.
Name	Specify a descriptive name for the device object.
Tag	Specify a device object label.
Timeout	Specify an additional waiting time to extract data.
Type	Indicate the device object type.
UserData	Store data that you want to associate with a device object.

Channel Properties

The analog input channel properties are given below.

Analog Input Channel Properties
ChannelName	Specify a descriptive channel name.
HwChannel	Specify the hardware channel ID.
Index	Indicate the MATLAB index of a hardware channel.
InputRange	Specify the range of the analog input subsystem.
NativeOffset	Indicate the offset to use when converting between the native data format and doubles.
NativeScaling	Indicate the scaling to use when converting between the native data format and doubles.
Parent	Indicate the parent (device object) of a channel.
SensorRange	Specify the range of data you expect from your sensor.
Type	Indicate a channel.
Units	Specify the engineering units label.
UnitsRange	Specify the range of data as engineering units.

Getting Command Line Property Help

Analog Output Properties