Your new Measurement Computing product comes with a fantastic extra —
Management committed to your satisfaction!
Thank you for choosing a Measurement Computing product—and congratulations! You own the finest, and you can now enjoy
the protection of the most comprehensive warranties and unmatched phone tech support. It’s the embodiment of our mission:
To provide data acquisition hardware and software that will save time and save money.
Simple installations minimize the time between setting up your system and actually making measurements. We offer quick and
simple access to outstanding live FREE technical support to help integrate MCC products into a DAQ system.
Limited Lifetime Warranty: Most MCC products are covered by a limited lifetime warranty against defects in materials or
workmanship for the life of the product, to the original purchaser, unless otherwise noted. Any products found to be defective in
material or workmanship will be repaired, replaced with same or similar device, or refunded at MCC’s discretion. For specific
information, please refer to the terms and conditions of sale.
Harsh Environment Program: Any Measurement Computing product that is damaged due to misuse, or any reason, may be
eligible for replacement with the same or similar device for 50% of the current list price. I/O boards face some harsh
environments, some harsher than the boards are designed to withstand. Contact MCC to determine your product’s eligibility for
this program.
30 Day Money-Back Guarantee: Any Measurement Computing Corporation product may be returned within 30 days of
purchase for a full refund of the price paid for the product being returned. If you are not satisfied, or chose the wrong product by
mistake, you do not have to keep it.
These warranties are in lieu of all other warranties, expressed or implied, including any implied warranty of merchantability or
fitness for a particular application. The remedies provided herein are the buyer’s sole and exclusive remedies. Neither
Measurement Computing Corporation, nor its employees shall be liable for any direct or indirect, special, incidental or
consequential damage arising from the use of its products, even if Measurement Computing Corporation has been notified in
advance of the possibility of such damages.
Trademark and Copyright Information
Measurement Computing Corporation, InstaCal, Universal Library, and the Measurement Computing logo are either trademarks
or registered trademarks of Measurement Computing Corporation. Refer to the Copyrights & Trademarks section on
mccdaq.com/legal for more information about Measurement Computing trademarks. Other product and company names
retrieval system, or transmitted, in any form by any means, electronic, mechanical, by photocopying, recording, or otherwise
without the prior written permission of Measurement Computing Corporation.
Notice
Measurement Computing Corporation does not authorize any Measurement Computing Corporation product for use
in life support systems and/or devices without prior written consent from Measurement Computing Corporation.
Life support devices/systems are devices or systems that, a) are intended for surgical implantation into the body, or
b) support or sustain life and whose failure to perform can be reasonably expected to result in injury. Measurement
Computing Corporation products are not designed with the components required, and are not subject to the testing
required to ensure a level of reliability suitable for the treatment and diagnosis of people.
Table of Contents
Preface
About this User's Guide ....................................................................................................................... 5
What you will learn from this user's guide ............................................................................................ 5
Conventions in this user's guide ......................................................................................................... 5
Where to find more information .......................................................................................................... 5
This user's guide explains how to install, configure, and use the DAQFlex Framework communication
protocol.
Conventions in this user's guide
For more information
Text presented in a box signifies additional information and helpful hints related to the subject matter you are reading.
Caution! Shaded caution statements present information to help you avoid injuring yourself and others,
damaging your hardware, or losing your data.
bold text Bold text is used for the names of objects on the screen, such as buttons, text boxes, and check boxes.
italic text Italic text is used for the names of manuals and help topic titles, and to emphasize a word or phrase.
Where to find more information
Additional information about DAQFlex software is available on our website at www.mccdaq.com. You can
also contact Measurement Computing Corporation with specific questions.
Knowledgebase: kb.mccdaq.com
Phone: 508-946-5100 and follow the instructions for reaching Tech Support
Fax: 508-946-9500 to the attention of Tech Support
Email: techsupport@mccdaq.com
5
Chapter 1
Introducing DAQFlex Software
DAQFlex is a framework that combines a small footprint driver with a message-based command
protocol. It is used to develop data acquisition applications that can be deployed across multiple
operating systems and custom embedded systems. The DAQFlex protocol greatly simplifies driver and
application development. All DAQ operations are programmed through a common command interface
composed of a cross-platform application programming interface (API) and open-source driver.
The DAQFlex framework consists of a software API, DAQFlex device driver, and the DAQ device message
engine. The message engine parses and converts the DAQFlex message-based command set into
DAQ-specific commands that control the device and process data.
Figure 1. DAQFlex Framework
A DAQFlex program sends DAQFlex methods to the driver. The driver sends the encapsulated messages
to the data acquisition device. The device interprets the message using the message engine, and sets its
corresponding attributes using the DAQ engine. The data acquisition device then returns the requested
data to the DAQFlex driver, which returns the data in an array (ScanData) to the program.
DAQFlex software includes the software API, device driver, FlexTest utility, and example programs.
Platform Support and Hardware Requirements
Installing the DAQFlex Software Library
Using DAQFlex Software
DAQFlex Software Reference
DAQFlex Message Reference
FlexTest Utility
C# and VB .NET Example programs
DAQFlex Hardware Reference
Platform support
You can run the DAQFlex communication protocol on a computer running one of the following operating
systems and software:
Microsoft Windows (32-bit or 64-bit)
o Windows 8
o Windows 7
o Windows Vista
o Windows XP
o Microsoft .NET® Framework 2.0 or later
o Microsoft Windows XP/Vista operating system
o Microsoft Visual Studio 2008 or later
o Microsoft .NET Compact Framework 3.5
o Microsoft ActiveSync
Deployment requirements:
o Windows CE 5.0
o X86 or ARM CPU
o Microsoft .NET Compact Framework 3.5
o DaqFlex.dll
o Mcusb.dll
o Mcwinceusb.dll
Macintosh (32-bit or 64-bit)
o MAC OS X
o Leopard 10.5 or later
o Mono Framework 2.0 or later
o libusb user-mode driver version 1.0.0.0
Linux (32-bit or 64-bit)
o Linux (2.4 kernel or later)
o Mono Framework 2.0 or later
o libusb user-mode driver version 1.0.0.0
Hardware requirements
Intel Pentium 4, 1 GHz or higher
Minimum of 512 MG of RAM (1 GB or higher recommended)
Video card with 128 MB memory
Video display with 800 x 600 resolution or greater, and 256 colors or greater
Microsoft-compatible mouse
Installing the DAQFlex software library
DAQFlex software operates with standard drivers for Windows, Mac, and Linux. Follow the procedure
below specific to your operating system to install the DAQFlex software.
Windows 8, Windows 7, Windows Vista, and Windows XP
1. Go to the DAQFlex download page at www.mccdaq.com/DAQFlexDL and select the Windows 32/64-
bit option.
2. Run the Windows DAQFlex.exe installer file.
3. Follow the installer instructions.
Connect your DAQFlex device after installing the software. You can run the FlexTest.exe test application,
or build and run the C# or VB .NET example programs included in the installation using ExampleBuilder
or Visual Studio (version 2005 or later).
Refer to the C# and VB Example Programs chapter on page 96 for instructions on running the DAQFlex
example programs, and to the Hardware Reference chapter on page 98 for the API components and
messages supported by DAQFlex supported hardware.
1. Go to the DAQFlex download page at www.mccdaq.com/DAQFlexDL and select the Windows CE
option.
2. Run the DAQFlex for Windows CE.msi installer file.
3. Follow the installer instructions.
4. After the DAQFlex software is installed, copy the Windows CE device drivers (mccusb.dll and
mccwinceusb.dll) from the DAQFlex for Windows CE\Drivers\ directory (\X86 or \XScale
folder) to the device's Windows directory.
Connect your DAQFlex device after installing the software. You can run the FlexTest.exe, or build and
run the C# or VB .NET example programs included in the installation using Visual Studio (version 2008
or later).
Refer to the C# and VB Example Programs chapter on page 96 for instructions on running the DAQFlex
example programs, and to the Hardware Reference chapter on page 98 for the API components and
messages supported by DAQFlex supported hardware.
Mac OS X
1. Go to the DAQFlex download page at www.mccdaq.com/DAQFlexDL and select the Mac OS option.
2. Run the DAQFlex installer package (DAQFlex.pkg).
3. Follow the installer instructions.
Connect your DAQFlex device after installing the software. You can run the FlexTest application located
in the /Applications/Measurement Computing/DAQFlex folder. Additionally, you can build and run
the example programs included in the installation using ExampleBuilder.
Refer to the C# and VB Example Programs chapter on page 96 for instructions on running the DAQFlex
example programs, and to the Hardware Reference chapter on page 98 for the API components and
messages supported by DAQFlex supported hardware.
Linux
1. Using your Software/Package manager, verify that the Mono framework (version 2.4 or later) and
the libusb user-mode driver are installed on your Linux system.
If these versions aren't listed, information on installing, updating, or adding software repositories to
your Software/Package manager can be found at the following links. Click here to go to the Mono
web site. Click here to go to the libusb web site.
2. As a root user, create a symbolic link to the libusb-1.0 shared object file. For example:
o ln -s /usr/lib/libusb-1.0.so.0/usr/lib/libusb-1.0.so
The actual file location may vary.
3. Extract the files from the DAQFlex-2.0.tar.gz archive file on the DAQFlex software CD using an
archive manager.
4. In a terminal window, set the current directory to DAQFlex/Source/DAQFlexAPI.
5. As a root user, run the following commands:
o make
o make install
6. Restart the system.
Connect your DAQFlex device after installing the software. You can run the FlexTest application by
running the command $ flextest from a terminal window. Additionally, you can build and run the C#
example programs included in the installation using MonoDevelop or the Mono command line
interpreter.
Refer to the C# and VB Example Programs chapter on page 96 for instructions on running the DAQFlex
example programs, and to the Hardware Reference chapter on page 98 for the API components and
messages supported by DAQFlex supported hardware.
The return values contain the device name with the device serial number
formatted as "DeviceName::SerialNumber".
NameAndID
The return values contains the device name with the device's user-defined ID
formatted as "DeviceName::DeviceID".
NameSernoAndID
The return values contains the device name, the device serial number and the
device's user-defined ID formatted as "DeviceName::SerialNumber::DeviceID".
DaqResponse response;
response = device.SendMessage("AI{0}:RANGE=BIP10V"); // set the input range for channel 0
response = device.SendMessage("?AI{0}:VALUE"); // read a single value from channel 0
Dim response As DaqResponse
response = device.SendMessage("AI{0}:RANGE=BIP10V") ' set the input range for channel 0
response = device.SendMessage("?AI{0}:VALUE") ' read a single value from channel 0
string value = response.ToString();
Dim value As String
value = response.ToString()
double value = response.ToValue();
Dim value As Double
value = response.ToValue()
DaqDeviceManager.ReleaseDevice(device);
DaqDeviceManager.ReleaseDevice(device)
VB
4. Once you have a DaqDevice object, use the SendMessage() method to program your DAQFlex-
supported device.
C#
VB
The DaqResponse object contains a method for getting the response as a string and a method for
getting the response as a numeric.
To get the response as a string, use the ToString() method:
C#
VB
To get the response as a numeric, use the ToValue() method:
C#
VB
If the response does not contain a numeric value, ToValue() returns Double.NaN.
When you no longer need the DaqDevice object, you can release it by calling the ReleaseDevice()
method:
C#
VB
10
DAQFlex Software User's Guide Using DAQFlex Software
Reading and writing software-paced I/O
The following examples demonstrate how to perform asynchronous single-point I/O using DAQFlex
software:
Reading an analog input channel
Writing to an analog output channel
Reading a digital bit
Writing to a digital bit
Reading a digital port
Writing to a digital port
Reading a counter input channel
11
DAQFlex Software User's Guide Using DAQFlex Software
// Read the value of analog input channel 0
String[] Devices;
DaqDevice MyDevice;
DaqResponse Response;
try
{
// Get a list of message-based DAQ devices
Devices = DaqDeviceManager.GetDeviceNames(DeviceNameFormat.NameAndSerno);
// Get a DaqDevice object for device 0
MyDevice = DaqDeviceManager.CreateDevice(Devices[0]);
// Send device messages using the DaqDevice object
MyDevice.SendMessage("AI{0}:RANGE=BIP10V");
MyDevice.SendMessage("AI:CAL=ENABLE");
MyDevice.SendMessage("AI:SCALE=ENABLE");
// Read and display the daq response
Response = MyDevice.SendMessage("?AI{0}:VALUE");
label1.Text = Response.ToString();
}
catch (Exception ex)
{
// handle error
label1.Text = ex.Message;
}
' Read the value of analog input channel 0
Dim Devices As String ()
Dim MyDevice As DaqDevice
Dim Response As DaqResponse
Try
' Get a list of message-based DAQ devices
Devices = DaqDeviceManager.GetDeviceNames(DeviceNameFormat.NameAndSerno)
' Get a DaqDevice object for device 0
MyDevice = DaqDeviceManager.CreateDevice(Devices(0))
' Send device messages using the DaqDevice object
MyDevice.SendMessage("AI{0}:RANGE=BIP10V")
MyDevice.SendMessage("AI:CAL=ENABLE")
MyDevice.SendMessage("AI:SCALE=ENABLE")
' Read and display the daq response
Response = MyDevice.SendMessage("?AI{0}:VALUE")
Label1.Text = Response.ToString()
Catch Ex As Exception
' handle error
Label1.Text = Ex.Message()
End Try
Reading an analog input channel
C#
VB
12
DAQFlex Software User's Guide Using DAQFlex Software
// Write a value to analog output channel 0
String[] Devices;
DaqDevice MyDevice;
try
{
// Get a list of message-based DAQ devices
Devices = DaqDeviceManager.GetDeviceNames(DeviceNameFormat.NameAndSerno);
// Get a DaqDevice object for device 0
MyDevice = DaqDeviceManager.CreateDevice(Devices[0]);
Sub CallbackMethod(ByVal errorCode As ErrorCodes, ByVal callbackType As CallbackType,
_ ByVal callbackData As Object)
Member Name
Description
OnDataAvailable
Specifies that the callback method will be invoked when a specified
number of samples becomes available for reading.
OnInputScanComplete
Specifies that the callback method will be invoked when a finite scan has
complete or when a continuous scan is stopped.
OnInputScanError
Specifies that the callback method will be invoked when an input scan
error occurs.
ReadScanData() parameters
The first parameter to the ReadScanData method is the number of samples to read.
The second parameter is a time out value in milli-seconds. A value of 0 indicates no timeout
specified.
The ReadScanData method is synchronous, and will return when the number of requested samples are
available for reading. When the number of requested samples are available, the DAQFlex software
copies the requested number of samples from an internal buffer to a new array of data. The DAQFlex
software keeps track of the buffer index so that multiple calls to ReadScanData always return
contiguous data.
Internal buffer
An alternative method for reading scan data is to enable a user-defined callback method. When you
enable a callback method, the DAQFlex software invokes your user-defined method when a specified
number of samples are available for reading, when a scan completes, or if a scan error occurs. This is
done using the EnableCallback method as shown below:
C#
VB
The callbackMethod is the name of the method that will be invoked by the DAQFlex software. The
callbackMethod is a class method that must have the following form:
C#
VB
The callbackType is an enumeration that defines when the callback method will be invoked.
CallbackType
Only one callback method can be specified for each callback type. When the callback type is set to
OnDataAvailable, set the callbackData parameter to the number of samples you wish to receive in the
callback method. When the callback type is set to OnInputScanComplete or OnInputScanError, set the
callbackData parameter to null or Nothing.
20
DAQFlex Software User's Guide Using DAQFlex Software
The first parameter to the WriteScanData method is the array containing the output scan data.
The second parameter is the number of samples to write.
The last parameter is a timeout value in milliseconds.
The WriteScanData method is synchronous, and will return when the number of samples specified have
been written to the device’s output buffer.
Each time the WriteScanData method is called, the data is written to an internal buffer starting at the
point after the last sample was written. When an output scan completes or is stopped, the write index is
reset to the beginning of the buffer.
Shared Function GetDeviceNames(ByVal format As DeviceNameFormat) As
String()
Value
Return string format
NameOnly
"Device name"
NameAndSerno
"Device name::Device serial number"
NameAndID
"Device name::Device ID"
NameSernoAndID
"Device name::Device serial number::Device ID"
Chapter 3
DAQFlex Software Reference
The DAQFlex Software API is an open source library that implements a simple message-based protocol
consisting of text-based commands, or messages. The API is written in C#, is designed for cross
platform portability, and does not require a separate configuration utility or a configuration file.
DAQFlex Software API contains two classes:
DaqDeviceManager class
DaqDevice class
DaqDeviceManager class
The DaqDeviceManager class includes the following methods:
GetDeviceNames() – gets a list of devices that support the message-based protocol.
CreateDevice() – creates a DaqDevice object, which contains the methods used to communicate
with a DAQ device.
ReleaseDevice() – frees the resources associated with a DaqDevice object.
DaqDeviceManager.GetDeviceNames()
Gets a list of DAQ devices that support the message-based protocol.
Parameter
format
The format to use for a device name. This parameter is a DeviceNameFormat enumeration. The
enumeration values and the format of the return strings are listed below:
Return value
An array of strings containing the device names of all DAQ devices that support the message-based
protocol.
Remarks
The values contained in the array can be used to create a DaqDevice object for the device that you
want to program.
The DaqDevice object is created using the DaqDeviceManager CreateDevice static method.
With the DaqDevice object, all DAQ operations are configured using one API method called
SendMessage() rather than using multiple operation-specific methods.
The NameOnly format is not useful if multiple devices of the same type are connected, since the
application won't be able to differentiate between one device and the other. If you are using
multiple devices of the same type, then use one of the other formats.
If using a device that does not have an ID assigned, you must use the NameOnly or NameAndSerno
format with the DaqDeviceManager.CreateDevice() method in order to create the device. A device
with no ID will not be created when using the NameAndID and NameSernoAndID format with
CreateDevice().
DaqDeviceManager.CreateDevice()
Creates a DaqDevice object. The DaqDevice object contains the methods used to configure, read data
from, or write data to a device. With the DaqDevice object, all DAQ operations are configured using one
API method called DaqDevice.SendMessage() rather than using multiple operation-specific methods.
SendMessage() takes a single parameter called message. This parameter is a text-based command that
the DAQ device parses to configure a particular operation.
Parameter
deviceName
One of the device names returned by the DaqDeviceManager.GetDevicenames() method.
Return value
An instance of a DaqDevice object.
Remarks
Depending on the DeviceNameFormat, the CreateDevice() method creates a DaqDevice object for
the device whose name, name and serial number, name and id, or name, serial number and id are
contained in the deviceName parameter.
The resources associated with the DaqDevice object can be freed by calling the ReleaseDevice()
method.
The CreateDevice() method can only be called once for a specific device, unless the ReleaseDevice()
method is called.
If CreateDevice() is called more than once for a specific device without calling ReleaseDevice(), the
DaqDevice object throws an exception, indicating that a driver handle has already been created for
Shared Sub ReleaseDevice(ByVal device As DaqDevice)
C#:
DaqResponse SendMessage (string message);
VB:
Function SendMessage (ByVal Message as String) As DaqResponse
DaqDeviceManager.ReleaseDevice()
Frees the resources associated with a DaqDevice object.
Parameter
Device
A DaqDevice object created by the CreateDevice() method.
DaqDevice class
The DaqDevice class includes the following methods:
SendMessage() – takes a single text-based command that the DAQ device parses to configure a
particular operation.
ReadScanData() – reads scan data.
WriteScanData() – outputs scan data.
EnableCallback() – enables a user-defined callback method to be invoked when a certain condition
is met. This method is used in conjunction with input scan operations.
DisableCallback() – the condition that invokes the callback method.
GetErrorMessage() – gets the error message associated with the error code that is passed to the
user-defined callback.
GetSupportedMessages() – returns a list of messages supported by a DAQ component.
DaqDevice.SendMessage()
Configures DAQ operations. This method takes a single text-based command that the DAQ device
parses to configure a particular operation.
Parameter
Message
The text-based message to send to the device.
Return value
The device response as an instance of a DaqResponse object.
Remarks
Message is a string containing a text-based command supported by the device, and Response is a
DaqResponse object containing the device's response.
The DaqResponse object includes two methods:
ToString(): gets the response as a string, for example "AI{0}:VALUE=139".
ToValue(): gets the response as a numeric value, for example "139.0000".
All messages provide a string response, but not all messages provide a numeric response. For those
messages that do not provide a numeric response, the numeric value is set to NaN (not a number).
double[,] ReadScanData(int samplesRequested, int timeOut);
VB:
Function ReadScanData(ByVal samplesRequested As Integer, ByVal timeOut
As Integer) As Double(,)
The ToString method has additional overloads that accept formatting parameters. The overloads are
ToString(string format), ToString(IFormatProvider provider) and ToString(string format,
IFormatProvider provider). The overloads can be used to format the numeric part of a response, if
present. If the response does not contain a numeric, these overloads are ignored.
If an error occurs while sending a message to a device, the SendMessage method will throw an
exception rather than returning an error code. This means the application should encapsulate calls
to SendMessage within a try/catch block.
Refer to the following sample code.
C#
VB
DaqDevice.ReadScanData()
Reads data for a scan operation.
Parameter
samplesRequested
The number of samples per channel to read.
timeOut
The number of milliseconds to wait for the samples requested to become available.
Return value
An array of data samples read from the device.
Remarks
The DAQFlex library always performs scan operations in the background, but ReadScanData()
always runs in the foreground. When called, ReadScanData() returns control to the application that
called it when the number of samples requested has been read. When timeOut is non-zero, if the
number of samples requested isn’t available within the time specified by timeOut, an exception is
thrown. The DAQFlex library manages all memory allocation and array indexing so the application
doesn't have to.
Sub EnableCallback(ByVal errorCode as ErrorCodes, ByVal callback as
InputScanCallbackDelegate, ByVal callbackType As CallbackType, ByVal
callbackData As Object)
DaqDevice.WriteScanData()
Outputs scan data.
Parameter
scanData
Array of data samples to output.
numberOfSamplesPerChannel
The number of data samples per channel to transfer from the scanData array to the device's output
buffer.
timeOut
The number of milliseconds to wait for available space in the buffer to write to. This only takes
effect when an output scan is running.
Remarks
WriteScanData may be called while a scan is running. However, the maximum number of total
samples must be less than or equal to half the number of samples for which the buffer is allocated.
Set the buffer size with the "AOSCAN:BUFSIZE" message.
DaqDevice.EnableCallback()
Enables a user-defined callback method to be invoked when a certain condition is met.
Parameter
callback
The method to be invoked when the condition specified by callbackType is met. Refer to
InputScanCallback Delegate on page 29 for the format of the method.
callbackType
The condition that invokes the callback method. Callback types are defined by the CallbackType
enumeration. The supported types are:
o CallbackType.OnDataAvailable – Invokes the callback method when the number of samples
available for reading data is ≥ the number of samples specified by the callbackData parameter.
o CallbackType.OnInputScanComplete – Invokes the callback method when an input scan
completes or is stopped.
oCallbackType.OnInputScanError – Invokes the callback method when an input scan error
occurs.
callbackData
When callbackType is set to OnDataAvailable, set callbackData to the number of samples per
channel to acquire before invoking the user-defined callback method. When callbackType is set to
OnInputScanComplete or OnInputScanError, set callbackData to null or Nothing.
public delegate void
InputScanCallbackDelegate(MeasurementComputing.DAQFlex.ErrorCodes
errorCode, MeasurementComputing.DAQFlex.CallbackType callbackType,
object callbackData)
VB:
Public Delegate Sub InputScanCallbackDelegate(ByVal errorCode As
MeasurementComputing.DAQFlex.ErrorCodes, ByVal callbackType As
MeasurementComputing.DAQFlex.CallbackType, ByVal callbackData As
Object)
C#:
void DisableCallback(CallbackType callbackType)
VB:
Sub DisableCallback(ByVal callbackType As CallbackType)
C#:
string GetErrorMessage(ErrorCodes errorCode)
VB:
Function GetErrorMessage(ByVal errorCode As ErrorCodes)
Return value
The value of callbackType.
Remarks
This method is used in conjunction with input scan operations.
EnableCallback may be called once for each callback type. If it is called more than once for the
sample callback type, a DaqException is thrown.
InputScanCallback Delegate
A delegate is a data structure that refers either to a static method, or to a class instance and an
instance method of that class. You call the delegate by passing either its address or a pointer to the
delegate to the callback parameter of the EnableCallback() method.
DaqDevice.DisableCallback()
Disables the invocation of the user-defined callback method associated with the callback type.
Parameter
callbackType
The callback type to disable.
DaqDevice.GetErrorMessage()
Gets the error message associated with the error code that is passed to the user-defined callback.
Parameter
errorCode
The error code that was passed to the user-defined callback method.
Return value
The error message associated with the error code passed to the user-defined callback method.
public List<string> GetSupportedMessages(string daqComponent);
VB:
Function GetSupportedMessages(ByVal daqComponent As String) As List(Of
String)
DaqDevice.GetSupportedMessages()
Gets the messages supported by a DAQ component.
Parameter
daqComponent
A DAQ component, such as AISCAN, DEV, TMR, and so on.
Return value
A list of messages supported by the daqComponent parameter.
30
Chapter 4
DAQFlex Message Reference
The software messages that you send to a DAQFlex supported device are text-based commands. Each
message pertains to a specific DAQ component. A DAQ component is a device element that
encapsulates a DAQ subsystem which has multiple properties or commands associated with it.
DAQFlex components
A DAQ component is a device element that encapsulates a DAQ subsystem which has multiple
properties or commands associated with it. The DAQFlex API defines the following DAQ components:
DEV — encapsulates device-level operations
AI — encapsulates single-point analog input operations
AICAL — encapsulates analog input self-calibration
AIQUEUE — encapsulates analog input gain queue operations
AISCAN — encapsulates analog input scanning operations
AITRIG — encapsulates analog input triggering operations
AO — encapsulates single-point analog output operations
AOCAL — encapsulates analog output self-calibration
AOSCAN — encapsulates analog output scanning operations
AOTRIG — encapsulates analog output triggering operations
DIO — encapsulates digital I/O operations
CTR — encapsulates counter input operations
TMR — encapsulates timer output operations
Each component has one or more properties associated with it. Each property supports one or more
text-based commands, or messages. These messages are used to communicate with DAQFlexsupported hardware.
DAQFlex supports two types of messages:
Device programming messages configure or retrieve a device property value.
Device reflection messages retrieve information about a device capability, such as the maximum
Call an AI:RANGES Reflection message to get the supported ranges. If the message
returned does not include PROG%, then the message does not apply to the device.
If ch is not specified, all channels are set to the range value.
If RANGE is not specified, the device power up default value is used.
Message
"?AI{ch}:RANGE"
Response
"AI{ch}:RANGE=value"
ch
The channel number.
value
The range value.
Example
"?AI{0}:RANGE"
Note
Call an AI:RANGES Reflection message to get the supported ranges. If the message
returned does not include PROG%, then the message does not apply to the device.
Get the A/D data rate in samples per channel for a specified channel.
OFFSET
Get the calibration offset coefficient for the specified channel.
The first character indicates if the value is signed (S) or unsigned (U). The second value
indicates the resolution in bits.
Message
"AI:SCALE=value"
Response
"AI:SCALE"
value
ENABLE, DISABLE
Example
"AI:SCALE=
Note
When SCALE is enabled, the device returns values that are converted to an appropriate
unit based on the CHMODE property. For example, when CHMODE is set to DIFF, values
are returned as voltage. When CHMODE is set to TC/OTD, values are returned as
temperature. When SCALE is disabled, values are returned as counts.
This message is processed by the DAQFlex Software library, and is not sent to the
device.
Message
"?AI:SCALE"
Response
"AI:SCALE=value"
value
ENABLE, DISABLE
Note
This message is processed by the DAQFlex Software library, and is not sent to the
device.
Message
"AI{ch}:SENSOR=TC/value"
Response
" AI:{ch}:SENSOR"
value
The thermocouple type.
Example
"AI{0}:SENSOR=TC/K"
Note
Thermocouple types B, E, J, K, N, R, S, and T are supported.
RES
Get the resolution of the A/D converter.
SCALE
Enable or disable scaling of A/D channels.
Get a value indicating whether scaling will be applied to the A/D channels.
RAW: returns uncalibrated A/D counts
VOLTS: returns a calibrated A/D voltage
DEGC: returns a calibrated temperature value in °C
DEGF: returns a calibrated temperature value in °F
KELVIN: returns a calibrated temperature value in Kelvin
value
The A/D value.
Example
"?AI{0}:VALUE/DEGC"
Note
This message is processed by the DAQFlex Software library, and is not sent to the
device.
Get the calibrated A/D count of a specified channel.
Get the A/D value in the specified format.
Working with the CAL and SCALE properties
The ENABLE/DISABLE setting of the CAL and SCALE properties affect the kind of data that is returned:
CAL=DISABLE, SCALE=DISABLE
If CAL and SCALE are both disabled, the data returned will be raw A/D integer values within the
range of 0 to 2
to the data by the application software, the data range may be limited to well within these values.
CAL=ENABLE, SCALE=DISABLE
When CAL is enabled and SCALE is disabled, the format of the analog data returned will depend on
the type of calibration implemented. If the calibration factors are stored on the device and applied
to the data by the application software, the data will be floating point values, not integer values,
and may exceed the theoretical limits and include negative values and values above 2
SCALE=ENABLE
When SCALE is enabled, scaled floating point values are returned. The limits of the data will depend
on the implementation of calibration, as described above. Data range limits may be a small
percentage less than or greater than the full scale range selected for devices for which the
calibration factors are stored on the device and applied to the data by the application software.
resolution
-1 of the device. If the calibration factors are stored on the device and applied
DISABLE (default): Do not monitor the buffer – allow overwrite.
ENABLE: Monitor the buffer and generate an error if unread data is being
overwritten.
Message
"?AISCAN:BUFOVERWRITE"
Response
"AISCAN:BUFOVERWRITE=value"
value
ENABLE, DISABLE
Note
ENABLE indicates that an attempt to overwrite unread data will generate an error
message.
DISABLE indicates that no error will be generated when data is overwritten.
This message is processed by the DAQFlex Software library, and is not sent to the
device.
Message
"AISCAN:BUFSIZE=value"
Response
"AISCAN:BUFSIZE"
value
The size in bytes of the buffer.
Example
"AISCAN:BUFSIZE=131072"
Note
The default buffer size 1,024,000 bytes. This should be sufficient for most
applications. The actual buffer size will always be an integer multiple of the device's
maximum packet size.
If this value is set, it should be at least (the number of bytes per sample) x (number
of channels) x (sample count) for finite mode. In continuous mode, a circular buffer
is used, so the size needs to be sufficient to allow reading the data before it is
overwritten.
AISCAN
Sets and gets property values when scanning analog input channels.
Refer to the device-specific information in the Hardware Reference section for the component properties
and commands supported by each DAQ device.
This message is processed by the DAQFlex Software library, and is not sent to the
device.
Message
"AISCAN:EXTPACER=value"
Response
"AISCAN:EXTPACER"
value
ENABLE (for most devices), DISABLE
Example
"AISCAN:EXTPACER= ENABLE"
Note
Some devices support ENABLE/MASTER, ENABLE/SLAVE, or ENABLE/GSLAVE.
For devices which do not support a master and slave configuration, the /MASTER and
/SLAVE designation is ignored.
For devices which do not support disabling of the pacer or SYNC input (for example,
the terminal is always enabled as either input or output), the DISABLE designation is
invalid.
Set to ENABLE if the device is paced using a continuous clock source, such as a
generator. In this mode, the first clock pulse after setting up the scan is ignored in
order to ensure adequate setup time for the first conversion.
Set to ENABLE/GSLAVE if the device is paced from a DAQFlex supported device. In
this mode, the first clock pulse after setting up the scan is held off to ensure
adequate setup time for the first conversion. No pulses are ignored.
When the external pacer is enabled, the AISCAN:RATE property should be set to
approximately what the external pacer rate will be, because internal transfer sizes
are calculated using the rate and channel count.
When not specified, the default is DISABLE.
Message
"?AISCAN:EXTPACER"
Response
"AISCAN:EXTPACER=value"
ch
The channel number.
value
ENABLE (for most devices).
Note
Some devices support ENABLE/MASTER, ENABLE/SLAVE, ENABLE/GSLAVE,
DISABLE/MASTER, or DISABLE/SLAVE.
COUNT
Get the number of samples per channel that have been acquired by the AISCAN operation.
EXTPACER
Set the configuration of the device's external pacer pin.
Get the configuration of the device's external pacer pin.
RESET resets the queue count to 0, and disables the gain queue.
Message
"?AISCAN:QUEUE"
Response
"AISCAN:QUEUE=value"
value
ENABLE, DISABLE
Message
"AISCAN:RANGE=value"
Response
"AISCAN:RANGE"
value
The range value.
Note
Call an AI:RANGES Reflection message to get the supported ranges. If the message
returned does not include PROG%, then the message does not apply to the device.
Message
"?AISCAN:RANGE"
Response
"AISCAN:RANGE=value"
value
The range value.
Note
If all channels are not set to the same range the device returns "MIXED".
Message
"AISCAN:RANGE{ch}=value"
Response
"AISCAN:RANGE{qcnt/ch}" (when QUEUE is enabled)
"AISCAN:RANGE{ch}" (when QUEUE is disabled.)
The response behavior is dependent on the QUEUE setting:
When QUEUE is enabled, an element is added to the queue and the specified channel
is set to the range specified.
When QUEUE is disabled, the specified channel is set to the range specified.
qcnt
The position of the element in the gain queue. This number increments by 1
for each successive message sent.
ch
The channel number.
value
The range value (see values listed above).
Example
"AISCAN:RANGE{2}=BIP20V"
Message
"AISCAN:RANGE{element/ch}=value"
Response
"AISCAN:RANGE{element/ch}"
Read whether the gain queue is used in the scanning operation.
RANGE
Set the range for all analog input channels to be scanned.
Get the range that is set for the analog input channels to be scanned.
Add the range value as the next element in the gain queue, or set the range value for a specified
channel (depending on the queue setting).
Set a specified element in the queue to a specified range (value) and channel (ch).
If element is greater than the size of the queue, the size of the queue is expanded to
element + 1.
Message
"?AISCAN:RANGE{x}"
Response
"AISCAN:RANGE{element/ch}=value" when QUEUE is enabled, or
"AISCAN:RANGE{ch}=value" when QUEUE is disabled.
x When QUEUE is disabled, x denotes the channel for which the range is
returned.
When QUEUE is enabled, x denotes the element in the queue for which the
range is returned.
element
The position of the element in the gain queue.
ch
The channel number.
value
The range value.
If all channels are not set to the same range, value returns MIXED.
Message
"AISCAN:RATE=value"
Response
"AISCAN:RATE"
value
0 to N
Example
"AISCAN:RATE=1000"
Note
If value is set is less than the device's minimum sampling rate, the minimum rate is
used. If value is set is greater than the device's maximum sampling rate, the maximum
rate is used.
Check the actual scan rate set using the "?AISCAN:RATE" query after setting the RATE.
Message
"?AISCAN:RATE"
Response
"AISCAN:RATE=value"
value
A value between the device's minimum and maximum rate.
Note
The value returned may not match the value requested using the
"AISCAN:RATE=value" message due to device limitations.
If the value returned is at or near the device's maximum sampling rate, you should
keep to a minimum other messages sent to the device. Otherwise, a data overrun may
occur. A data overrun occurs when the device fills its buffer with data faster than it is
read back.
Get the range value for a specified element or channel.
When SCALE is enabled, the device returns values that are converted to an appropriate
unit based on the CHMODE property. For example, when CHMODE is set to DIFF, values
are returned as voltage. When CHMODE is set to TC/OTD, values are returned as
temperature. When SCALE is disabled, values are returned as counts.
This message is processed by the DAQFlex Software library, and is not sent to the
device.
Message
"?AISCAN:SCALE"
Response
"AISCAN:SCALE=value"
value
ENABLE, DISABLE
Note
This message is processed by the DAQFlex Software library, and is not sent to the
device.
RESET
Reset the status of the AISCAN operation.
SAMPLES
Set the number of samples/channel to acquire in the scan.
Get the number of samples/channel acquired.
SCALE
Enable or disable scaling of the A/D data.
Get a value indicating whether scaling will be applied to the A/D data.
For SINGLEIO, the device transfers data after one sample per channel is acquired.
For BURSTIO, the number of samples is limited to the size of the device FIFO.
Message
"?AISCAN:XFRMODE"
Response
"AISCAN:XFRMODE=value"
value
SINGLEIO, BLOCKIO, BURSTIO
Message
"AITRIG:REARM=value"
Response
"AITRIG:REARM"
value
ENABLE, DISABLE
XFRMODE
Set the transfer mode for analog input scan data.
Get the transfer mode that is set for the scan.
Working with the CAL and SCALE properties
The ENABLE/DISABLE setting of the CAL and SCALE properties affect the kind of data that is returned:
CAL=DISABLE, SCALE=DISABLE
If CAL and SCALE are both disabled, the data returned will be raw A/D integer values within the
range of 0 to 2
resolution
-1 of the device. If the calibration factors are stored on the device and applied
to the data by the application software, the data range may be limited to well within these values.
CAL=ENABLE, SCALE=DISABLE
When CAL is enabled and SCALE is disabled, the format of the analog data returned will depend on
the type of calibration implemented. If the calibration factors are stored on the device and applied
to the data by the application software, the data will be floating point values, not integer values,
and may exceed the theoretical limits and include negative values and values above 2
resolution
–1.
SCALE=ENABLE
When SCALE is enabled, scaled floating point values are returned. The limits of the data will depend
on the implementation of calibration, as described above. Data range limits may be a small
percentage less than or greater than the full scale range selected for devices for which the
calibration factors are stored on the device and applied to the data by the application software.
AITRIG
Sets and gets analog input trigger property values.
Refer to the device-specific information in the Hardware Reference section for the component properties
and commands supported by each DAQ device.
Once the "AOCAL:START" message is sent, no other messages other than
"?AOCAL:STATUS" may be sent until the calibration process is complete.
Message
"?AOCAL:STATUS"
Response
"AOCAL:STATUS=value""
value
RUNNING, IDLE
Message
"AOSCAN:BUFSIZE=value"
Response
"AOSCAN:BUFSIZE"
value
The size in bytes of the output buffer.
Example
"AOSCAN:BUFSIZE=65536"
Notes
The default buffer size is 65536 bytes. This should be sufficient for most applications.
The actual buffer size will always be an integer multiple of the device's maximum
packet size.
Message
"?AOSCAN:BUFSIZE"
Response
"AOSCAN:BUFSIZE=value"
AOCAL
Gets the manufacturer calibration date and time.
Refer to the device-specific information in the Hardware Reference section for the component properties
and commands supported by each DAQ device.
Properties
START, STATUS
START
Start the D/A internal calibration. This operation calibrates the analog outputs and writes calibration
factors to the board.
STATUS
Get the status of the D/A internal calibration.
AOSCAN
Sets and gets property values when scanning analog output channels.
Refer to the device-specific information in the Hardware Reference section for the component properties
and commands supported by each DAQ device.
"The device is not responding" when value is set to SYSTEM.
(SYSTEM resets the USB interface to the device, and the device cannot send a
response; this value is not recommended for use through the software).
"DEV:RESET" when value is set to DEFAULT.
(DEFAULT resets all device parameters to the default value.)
value
SYSTEM, DEFAULT
Example
"DEV:RESET/DEFAULT"
Message
"?AI:STATUS/ISO"
Response
"AI:STATUS=value"
value
READY, NOTREADY
Get the minute in which the device was last calibrated.
Get the second in which the device was last calibrated.
MFGSER
Get the manufacturer serial number of the device.
For devices that support this message, the default power up value is "IN".
Message
"?DIO{port}:DIR"
Response
"DIO{port}:DIR=value"
port
The port number.
value
IN, OUT, or a number between 0 and 2n -1, where n is the number of bits
in the port.
Note
If the digital bits are not individually configurable, the value returned is either "IN" or
"OUT."
If each digital bit is individually configurable, value is a bit mask, in which 1 indicates
that the bit is configured for input, and 0 indicates that the bit is configured for
output.
Message
"DIO{port/bit}:DIR=value"
Response
"DIO{port/bit}:DIR"
port
The port number.
bit
The bit number.
value
IN, OUT
Example
"DIO{0/1}:DIR=IN"
Note
For devices that support this message, the default power up value is "IN".
Message
"?DIO{port/bit}:DIR"
Response
"DIO{port/bit}:DIR=value"
port
The port number.
bit
The bit number.
value
IN, OUT
Example
"?DIO{0/1}:DIR"
Message
"DIO{port}:LATCH=value"
Response
"DIO{port}:LATCH"
Get the direction of a port.
Set the direction of a bit.
Get the direction of a bit.
LATCH
LATCH applies to programmable ports. This property lets you set a digital output value while in input
mode. When programmed for output mode the latch value will be at the output.
Gets the analog input scanning properties of a device.
AITRIG
Gets the analog input triggering properties of a device.
AO
Gets the analog output properties of a device.
AOSCAN
Gets the analog output scanning properties of a device.
CTR
Gets the counter input properties of a device.
DIO
Gets the digital I/O properties of a device.
TMR
Gets the timer output properties of a device.
Message
"@AI{ch}:CJC"
Response
"AI{ch}:CJC=implementation>value"
ch
Channel number.
implementation
FIXED%, PROG% (programmable), HWSEL% (hardware selectable),
or not specified if value is NOT_SUPPORTED
value
Channel number for the CJC associated with the specified channel, or
returns NOT_SUPPORTED if the device doesn't support CJCs or the
value of {ch} is not valid for the device.
Example
"AI{0}:CJC=FIXED%0"
Reflection messages
Device reflection messages get information about the capabilities of a device, such as the maximum
scan rate or support for an external clock. Device reflection messages always start with the @ character.
Device features are stored on the device in EEPROM.
Click on a component below for the string messages, device responses, and property values supported
by the component.
FIXED%, PROG% (programmable), HWSEL% (hardware
selectable), or not specified if value is NOT_SUPPORTED
value
SE or DIFF, or returns NOT_SUPPORTED if the device doesn't
support analog input.
dependent
properties
One or more property that is dependent on the value of another
property. For example, the CHANNELS property is dependent on
whether the CHMODES value property is set to SE or DIFF.
Example
"AI:CHMODES=PROG%SE,DIFF<CHANNELS, RANGES>"
Message
"@AI:FACCAL"
Response
"AI:FACCAL=implementation>value"
implementation
FIXED%, or not specified if value is NOT_SUPPORTED
value
SUPPORTED, NOT_SUPPORTED
Example
"AI:FACCAL=FIXED%SUPPORTED"
CHANNELS
Get the number of analog input channels on a device.
CHMODES
Get the analog input channel modes that are supported by the device.
FACCAL
Get a value indicating if the device supports factory calibration for analog inputs.
FIXED%, PROG% (programmable), HWSEL% (hardware selectable),
or not specified if value is NOT_SUPPORTED
value
VOLTS, TEMP, CUR (current), or RES (resistance), or returns
NOT_SUPPORTED if the device doesn't support analog input or if the
value of {ch} is not valid for the device.
Example
"AI{0}:INPUTS=PROG%VOLTS,TEMP"
Message
"@AI:MAXCOUNT"
Response
implementation
FIXED%, or not specified if value is NOT_SUPPORTED
value
The maximum count of the A/D converter, or returns
NOT_SUPPORTED if the device doesn't support analog input.
Example
"AI:MAXCOUNT=FIXED%65535"
Message
"@AI:MAXRATE"
Response
"AI:MAXRATE=implementation>value"
Message
"@AI:RANGES"
"@AI{ch}:RANGES"
Response
"AI{ch}:RANGES=implementation>value"
ch
Channel number (if {ch} format is used).
implementation
FIXED%, PROG% (programmable), or HWSEL% (hardware
selectable), or not specified if value is NOT_SUPPORTED
value
A list of all valid ranges for the specified channel (using the {ch}
format) or device, or returns NOT_SUPPORTED if the device doesn't
support analog input, or the value of {ch} is not valid for the device.
Example
"AI{0}:RANGES=PROG%BIP10V,BIP5V"
INPUTS
Get the analog input signal types that are supported by the device or specified channel.
MAXCOUNT
Get the maximum count of the device's A/D converter.
MAXRATE
Get the maximum rate for software paced analog input operations.
RANGES
Get the analog input ranges that are supported by the device.
On some devices, the values returned may be dependent on channel configuration
settings.
Some devices require the {ch} format.
Message
"@AI:SELFCAL"
Response
"AI:SELFCAL=<implementation>value"
implementation
PROG% (programmable), or not specified if value is
NOT_SUPPORTED
value
SUPPORTED, NOT_SUPPORTED
Example
"AI:SELFCAL=PROG%SUPPORTED"
Message
"@AI:SENSORS"
"@AI{ch}:SENSORS"
Response
"AI{ch}:SENSORS=implementation>value"
ch
Channel number (if {ch} format is used).
implementation
FIXED%, PROG% (programmable), HWSEL% (hardware selectable),
or not specified if value is NOT_SUPPORTED
value
TC, RTD, THERM (thermistor), or SEMI (semiconductor), or returns
NOT_SUPPORTED if the device doesn't support analog input sensors
or the value of {ch} is not valid for the device.
Example
"AI{0}:SENSORS=FIXED%TC"
Message
"@AI{ch}:SENSORCONFIG"
Response
"AI{ch}:SENSORCONFIG=implementation>value"
ch
Channel number.
implementation
FIXED%, PROG% (programmable), HWSEL% (hardware selectable),
or not specified if value is NOT_SUPPORTED
value
2WIRE, 3WIRE, 4WIRE, FULLBRG, HALFBRG, QTRBRG, or returns
NOT_SUPPORTED if the device doesn't support configuration of
sensors or the value of {ch} is not valid for the device.
Example
"AI{0}:SENSORCONFIG=PROG%2WIRE,3WIRE,4WIRE"
SELFCAL
Get a value indicating if the device supports self-calibration for analog inputs.
SENSORS
Get the analog input sensor types that are supported by the device or specified channel.
SENSORCONFIG
Get the analog sensor configurations that are supported by the specified channel.
FIXED%, PROG%, or not specified if value is NOT_SUPPORTED
value
The channel format capability for the channel queue. This value can
be one or more of the following: ADJACENT, ASCENDING,
ANYORDER, DUPLICATE, or returns NOT_SUPPORTED if the device
doesn't support an analog input queue.
Example
"AISCAN: QUEUESEQ=FIXED%DUPLICATE,ANYORDER "
Note
Queue sequence format:
ADJACENT – only adjacent channels can appear in the sequence. Example: 2,3,4.
ASCENDING – channels must appear in ascending order in the sequence.
Example: 0,3,5.
ANYORDER – channels may appear in any order in the sequence. Example: 6,3,7,0.
DUPLICATE – a channel may appear more than once in the sequence.
Example: 0,2,2,3.
Message
"@AISCAN:TRIG"
Response
"AISCAN:TRIG=implementation>value"
implementation
PROG%, HWSEL% (hardware selectable), or not specified if value is
NOT_SUPPORTED.
value
ENABLE, DISABLE, or returns NOT_SUPPORTED if the device doesn't
support triggering analog input externally.
Example
"AISCAN:EXTTRIG=PROG%ENABLE, DISABLE"
Message
"@AISCAN:XFRMODES"
Response
"AISCAN:XFRMODES=implementation>value"
implementation
FIXED%, PROG% (programmable), or not specified if value is
NOT_SUPPORTED.
value
BLOCKIO, SINGLEIO, BURSTAD, BURSTIO, or returns
NOT_SUPPORTED if the device doesn't support transfer modes.
Example
"AISCAN:XFRMODES=PROG%BLOCKIO,SINGLEIO,BURSTIO"
QUEUESEQ
Get the channel sequence format of the analog input channel queue.
TRIG
Get a value indicating whether the device supports external triggering of analog input channels.
XFRMODES
Get the input transfer modes supported by a device.
FIXED%, or not specified if value is NOT_SUPPORTED
value
The number of bytes, or NOT_SUPPORTED
Example
"AISCAN:XFRSIZE=FIXED%2"
Message
"@AITRIG:RANGES"
Response
"AITRIG:RANGES=implementation>value"
implementation
FIXED%, PROG% (programmable), HWSEL% (hardware selectable),
or not specified if value is NOT_SUPPORTED
value
A list of all valid ranges for the specified analog trigger source or
device, or returns NOT_SUPPORTED if the device doesn't support
analog triggering of analog input or the trigger source is not valid for
the device.
Example
"AITRIG:RANGES=PROG%BIP10V,BIP5V"
Note
On some devices, the values returned may be dependent on channel configuration
settings.
Message
"@AITRIG:REARM"
Response
"AITRIG:REARM=implementation>value"
implementation
FIXED%, PROG%, or not specified if value is NOT_SUPPORTED
value
ENABLE, DISABLE, or returns NOT_SUPPORTED if the device doesn't
support continuous triggering of analog input.
Example
"AITRIG:REARM=PROG%ENABLE,DISABLE"
XFRSIZE
Get the number of bytes used in the transfer of each data sample.
AITRIG
Get the analog input trigger properties of a device.
Properties
RANGES, REARM, SRCS, TYPES
RANGES
Get the supported ranges for a device's analog input trigger circuit.
REARM
Get a value indicating whether the device supports continuous triggering of the analog input.
FIXED%, or not specified if value is NOT_SUPPORTED.
value
The maximum count of the timer, or returns NOT_SUPPORTED if the
device has no timer channels.
Example
"TMR{0}:MAXCOUNT=FIXED%4294967295"
Message
"@TMR{ch}:TYPE"
Response
"TMR{ch}:TYPE=<implementation>value"
ch
The number of the timer channel.
implementation
FIXED%, or not specified if value is NOT_SUPPORTED.
value
PULSE, NOT_SUPPORTED
Example
"TMR{0}:TYPE=FIXRD%PULSE"
MAXCOUNT
Get the maximum count for the specified timer channel.
TYPE
Get the type of timer for the specified timer channel.
91
Chapter 5
FlexTest Utility
FlexTest is an interactive GUI-based test utility that demonstrates how to communicate with a device
using the DAQFlex communication protocol and software.
This utility automatically recognizes an available DAQFlex device, shows all commands available for this
device, and allows users to interact with the device one command at a time. During this interaction, the
commands are captured in a log, allowing the user to cut and paste them directly into a program.
FlexTest is included on the driver CD, and is installed to the following location:
Windows 8, Windows 7, and Windows Vista —C:\Users\Public Documents\Measurement
Computing\DAQFlex For Windows\FlexTest.exe.
Windows XP, FlexTest —C:\Program Files\Measurement Computing\DAQFlex For
Windows\FlexTest.exe.
Windows CE —C:/Program Files/Measurement Computing/DAQFlex For Windows
CE/FlexTest.exe.
MAC OS X — FlexTest is installed to the /Applications folder.
Linux — FlexTest is extracted to the directory in which the compressed files were extracted.
To run FlexTest on Linux, do the following:
o In a terminal window, set the current directory to DAQFlex/Source/DAQFlexTest.
o As a root user, run the commands $ make and $ make install.
o From a terminal window, run the FlexTest application using the command $ flextest
Note: Connect a device that supports the DAQFlex protocol before running FlexTest.
When you run FlexTest, the main FlexTest window and a MessageLog window open:
92
DAQFlex Software User's Guide FlexTest Utility
FlexTest user interface
The FlexTest window features the following controls:
Devices drop-down list: displays the name and serial number of each connected DAQFlex-supported
device.
Show message log check box: When checked, the text of each message sent to the device appears
in the MessageLog window.
Component tabs: the DAQ components that are supported by the DAQFlex-supported device.
Message field and drop down list: displays the text messages that can be sent to the device. The
messages are specific to the component selected. An asterisk in the message indicates a variable
whose property value must be entered.
Refer to the DAQFlex Message Reference chapter for more information about the API messages.
Send Message button: click this button to send the selected message to the device.
Response field: Displays the response to the message that is returned from the device.
o Text messages display in a Text field.
o When a number is returned from the device, for example when reading the value of an analog
input channel, the value displays in a Numeric field.
o When multiple values are returned, such as when scanning data, the values display below the
message that is returned.
Show messagelog check box: When checked, the text of each message sent to the device appears
in the MessageLog window.
Status area: The bottom of the window displays either a status message or scan count:
oMessage status: When a message is successfully sent to a device, "Success" appears in the
status area. If a message cannot be sent, such as when a variable is either not set or is set to
an unsupported value, an error message appears in the status area.
oScan count: during a scan operation, the status area updates with the number of samples that
are read.
Messagelog window
The MessageLog window lists each message that is sent to the device. Note that the Show messagelog
checkbox on the FlexTest window must be checked in order to display messages on the Messagelog
window.
Click the Clear button to remove the messages.
Using FlexTest
The procedures below demonstrate how to read/display scan data, and how to calibrate a device with
FlexTest.
Read and display scan data
The following exercise demonstrates how to read and display multiple channel scan data using FlexTest.
For this exercise, you set the range of analog channels to scan (1 to 3), set the channel range to ±10
volts, the sample rate to 1000 Hz, and the number of samples to 256. After configuring the scan
parameters, you run the operation and view the resulting scan data.
Do the following:
1. Connect a device that supports the DAQFlex protocol to your system and run FlexTest.
2. Click on the AISCAN tab.
3. Configure the scan parameters using the text strings in the Message drop down list:
o Select AISCAN:LOWCHAN=*. Highlight the asterisk and enter "0", then click Send Message.
o Select AISCAN:HIGHCHAN=*. Highlight the asterisk and enter "1", then click Send Message.
93
DAQFlex Software User's Guide FlexTest Utility
o Select AISCAN:RANGE=*. Highlight the asterisk and enter "BIP10V", then click Send Message.
This field is not case-sensitive.
o Select AISCAN:RATE=*. Highlight the asterisk and enter "1000", then click Send Message.
o Select AISCAN:SAMPLES=*. Highlight the asterisk and enter "512", then click Send Message.
4. Start the scan operation: Select AISCAN:START and click Send Message.
The FlexTest window displays the scan data in the Response area, and the MessageLog window lists the
messages sent to the device.
Notes
String data entered into the Message field is not case sensitive.
Messages that begin with "?" are query messages. Select a query to read a value.
Calibrate a device
For devices that support self-calibration, FlexText displays a Calibrate button on the AI tab to calibrate
analog inputs. For devices with analog outputs FlexText displays a Calibrate button on the AO tab.
Calibrating analog inputs
To calibrate a device's analog inputs, do the following:
1. Select the AI tab.
2. Click the Calibrate button.
94
DAQFlex Software User's Guide FlexTest Utility
The Ai Self Calibration window opens.
3. Click the Start button to start calibrating the analog inputs.
The progress bar updates as the operation progresses. When calibration is done the window
displays Complete.
4. Click OK to close the window.
Calibrating analog outputs
To calibrate a device's analog outputs, do the following:
1. Select the AO tab.
2. Click the Calibrate button.
The Ao Self Calibration window opens.
3. Click the Start button to start calibrating the analog outputs.
The progress bar updates as the operation progresses. When calibration is done the window
displays Complete.
4. Click OK to close the window.
DAQFlex message reference
Refer to the DAQFlex Message Reference chapter on page 31 for the supported DAQFlex API messages.
Note: FlexTest cannot be run at the same time as the DAQFlex Firmware Loader utility
(DAQFlexFWLoader.exe).
95
Chapter 6
C# and VB Example Programs
Complete C# and VB example programs are installed with DAQFlex that demonstrate how to configure
DAQFlex-supported devices and perform DAQ operations with the DAQFlex Software API.
Default installation path
On Windows, the example programs are installed by default to CSharp and VB subfolders:
o Windows 8, Windows 7, and Windows Vista —C:\Users\Public Documents\Measurement
Computing\DAQFlex For Windows\Examples.
o Windows XP —C:\Program Files\Measurement Computing\DAQFlex For
Windows\Examples.
o Windows CE —C:\Program Files\Measurement Computing\DAQFlex For Windows
CE\Examples.
On Mac OS X, example programs are installed to Users/Shared/Measurement
Computing/DAQFlex/Examples.
On Linux, C# example programs are extracted to DAQFlex/Examples/CSharp.
Building the DAQFlex example programs
Windows 8/7/Vista/XP
Complete the following steps to run the DAQFlex example programs:
1. Go to Measurement Computing»DAQFlex»Examples»ExampleBuilder.
2. Run the ExampleBuilder script to build all CSharp and Visual Basic examples.
3. Go to Measurement Computing»DAQFlex»Examples»Go To Examples.
The example program directory opens. The example programs are installed by default to CSharp
and VB subfolders.
4. Double-click on a *.csproj or *.vbproj file to run the DAQFlex example program.
Windows CE
Complete the following steps to run the DAQFlex example programs:
1. Go to Measurement Computing»DAQFlex for Windows CE»Examples»Go to Examples.
The example program directory opens. The example programs are installed by default to CSharp
and VB subfolders.
2. Double-click on a *.csproj or *.vbproj file to run the DAQFlex example program.
Mac OS X
Complete the following steps to run the DAQFlex example programs:
1. Go to Users/Shared/Measurement Computing/DAQFlex/Examples.
2. Run the ExampleBuilder script to build all CSharp and Visual Basic examples.
3. From a terminal window, go to either CSharp/<application name>/bin/Debug or
VB/<application name>/bin/Debug, and run the following command:
o mono <application name>.exe
Linux
You run the DAQFlex C# example programs using MonoDevelop or the Mono command line interpreter.
Do the following:
1. In a terminal window, set the current directory to DAQFlex/Examples.
2. Run the following commands as a root user:
o make
o make install
3. Exit the root user shell.
96
DAQFlex Software User's Guide C# and VB Example Programs
4. From a terminal window, run the example programs as a non-root user by entering the application
name as a command, for example:
o ainscan
Refer to the readme.txt file for additional information about running the DAQFlex example programs.
97
Chapter 7
Hardware Reference
Select your DAQFlex-supported device below for the components and programming messages supported
by the device.
Note: You can use any of the device reflection messages to retrieve information about the device's
capabilities.
USB-200 Series
USB-1208FS-Plus
USB-1408FS-Plus
USB-1608FS-Plus
USB-1608G Series
USB-2001-TC
USB-2408 Series
USB-7202
USB-7204
98
DAQFlex Software User's Guide Hardware Reference – USB-200 Series
Component
Supported
Property/Command
Set/Get
Supported Values
AI
Get 8 CAL
Set/Get
ENABLE, DISABLE
CHMODE
Get
SE
RANGE
Get
BIP10V
RES
Get
U12
SCALE
Set/Get
ENABLE, DISABLE
AI{ch}
OFFSET
Get
4-byte floating point numeric
RANGE
Get
BIP10V
SLOPE
Get
4-byte floating point numeric
VALUE
Get
Unsigned integer numeric
VALUE/{format}
Get
RAW, VOLTS
AIQUEUE
CLEAR
Set COUNT
Get
0 to 7 elements
AIQUEUE{element}
CHAN
Set/Get
element: 0 to 7
value: 0 to 7
CHMODE
Get
element: 0 to 7
value: SE
RANGE
Get
element: 0 to 7
value: BIP10V
AISCAN
BUFOVERWRITE
Set/Get
ENABLE, DISABLE
BUFSIZE
Set/Get
EXTPACER
Set/Get
ENABLE, DISABLE
HIGHCHAN
Set/Get
0 to 7
INDEX
Get LOWCHAN
Set/Get
0 to 7
QUEUE
Set/Get
ENABLE, DISABLE
RANGE
Get
BIP10V
RANGE{ch}
Get
channel: 0 to 7
value: BIP10V
RATE
Set/Get
USB-204/USB-204-OEM and
USB-205/ USB-205-OEM: 500,000 Hz
USB-201/USB-201-OEM and
USB-202/USB-202-OEM: 100,000 Hz
USB-200 Series
The USB-200 Series includes the following devices: