Function Reference

Alphabetical List

---

Instrument Object Creation Create interface objects and device objects State Change Connect to instruments, disconnect from instruments, and record information to disk Property Display and Configuration Return properties, configure properties, and open property inspector Data Reading Read text, binary, and binblock data for interface objects Data Writing Write text, binary, and binblock data for interface objects Information and Help Return function help, property help, and property characteristics Graphical Tools Tools that facilitate instrument control in graphical environment Utilities Delete, clear, find, save, and load objects, convert objects to code Interface Objects Functions listed by interface type (GPIB, VISA-VXI, and so on) Device Objects Functions used only with device objects IVI Configuration Store Objects Functions used only with IVI configuration store objects

Back to Top

Instrument Object Creation

Interface Object Create interface object Device Object Create device object

Back to Top of Section

Interface Object

bluetooth	Create Bluetooth object
fgen	Create Quick-Control Function Generator object
gpib	Create GPIB object
i2c	Create I2C object
oscilloscope	Create Quick-Control Oscilloscope object
serial	Create serial port object
tcpip	Create TCPIP object
udp	Create UDP object
visa	Create VISA object

Back to Top of Section

Device Object

icdevice

Create device object

Back to Top

State Change

Interface Object Control interface object Device Object Control device object

Back to Top of Section

Interface Object

fclose	Disconnect interface object from instrument
fopen	Connect interface object to instrument
record	Record data and event information to file

Back to Top of Section

Device Object

connect	Connect device object to instrument
disconnect	Disconnect device object from instrument

Back to Top

Property Display and Configuration

get	Instrument object properties
inspect	Open Property Inspector
set	Configure or display instrument object properties

Back to Top

Data Reading

binblockread	Read binblock data from instrument
fgetl	Read line of text from instrument and discard terminator
fgets	Read line of text from instrument and include terminator
flushinput	Remove data from input buffer
fread	Read binary data from instrument
fscanf	Read data from instrument, and format as text
getWaveform	Returns waveform displayed on scope
query	Write text to instrument, and read data from instrument
readasync	Read data asynchronously from instrument
scanstr	Read data from instrument, format as text, and parse
stopasync	Stop asynchronous read and write operations

Back to Top

Data Writing

binblockwrite	Write binblock data to instrument
flushoutput	Remove data from output buffer
fprintf	Write text to instrument
fwrite	Write binary data to instrument
query	Write text to instrument, and read data from instrument
stopasync	Stop asynchronous read and write operations

Back to Top

Information and Help

instrhelp	Help for instrument object type, function, or property
instrhwinfo	Information about available hardware
propinfo	Instrument object property information

Back to Top

Graphical Tools

Interface Object Graphical tools for interface objects Device Object Graphical tools for device objects

Back to Top of Section

Interface Object

tmtool

Open Test & Measurement Tool

Back to Top of Section

Device Object

midedit	Open graphical tool for creating and editing MATLAB instrument driver
midtest	Open graphical tool for testing MATLAB instrument driver
tmtool	Open Test & Measurement Tool

Back to Top

Utilities

clear	Remove instrument objects from MATLAB workspace
delete	Remove instrument objects from memory
disp	Display instrument object summary information
instrcallback	Display event information when event occurs
instrfind	Read instrument objects from memory to MATLAB workspace
instrfindall	Find visible and hidden instrument objects
instrid	Define and retrieve commands that identify instruments
instrnotify	Define notification for instrument events
instrreset	Disconnect and delete all instrument objects
isvalid	Determine whether instrument objects are valid
length	Length of instrument object array
load	Load instrument objects and variables into MATLAB workspace
methods	Class method names and descriptions
obj2mfile	Convert instrument object to MATLAB code
save	Save instrument objects and variables to MAT-file
size	Size of instrument object array

Back to Top

Interface Objects

GPIB Create GPIB object, clear instrument buffer, send trigger message, perform serial poll Serial Port Create serial port object, send break to instrument TCP/IP Create TCP/IP object, return host information, start or stop echo server UDP Create UDP object, return host information, start or stop echo server VISA-GPIB Create VISA-GPIB object, clear instrument buffer, send trigger message VISA-GPIB-VXI Create VISA-GPIB-VXI object, low level memory operations, high level memory operations, send trigger VISA-Serial Create VISA-Serial object VISA-VXI Create VISA-VXI object, low level memory operations, high level memory operations, send trigger

Back to Top of Section

GPIB

clrdevice	Clear instrument buffer
gpib	Create GPIB object
spoll	Perform serial poll on GPIB objects
trigger	Send trigger message to instrument

Back to Top of Section

Serial Port

serial	Create serial port object
serialbreak	Send break to instrument

Back to Top of Section

TCP/IP

echotcpip	Start or stop TCP/IP echo server
resolvehost	Network name or network address
tcpip	Create TCPIP object

Back to Top of Section

UDP

echoudp	Start or stop UDP echo server
resolvehost	Network name or network address
udp	Create UDP object

Back to Top of Section

VISA-GPIB

clrdevice	Clear instrument buffer
spoll (visa)	Perform serial poll on VISA objects
trigger	Send trigger message to instrument
visa	Create VISA object

Back to Top of Section

VISA-GPIB-VXI

clrdevice	Clear instrument buffer
memmap	Map memory for low-level memory read and write operations
mempeek	Low-level memory read from VXI register
mempoke	Low-level memory write to VXI register
memread	High-level memory read from VXI register
memunmap	Unmap memory for low-level memory read and write operations
memwrite	High-level memory write to VXI register
spoll (visa)	Perform serial poll on VISA objects
visa	Create VISA object

Back to Top of Section

VISA-Serial

spoll (visa)	Perform serial poll on VISA objects
visa	Create VISA object

Back to Top of Section

VISA-VXI

clrdevice	Clear instrument buffer
memmap	Map memory for low-level memory read and write operations
mempeek	Low-level memory read from VXI register
mempoke	Low-level memory write to VXI register
memread	High-level memory read from VXI register
memunmap	Unmap memory for low-level memory read and write operations
memwrite	High-level memory write to VXI register
trigger	Send trigger message to instrument
visa	Create VISA object

Back to Top

Device Objects

devicereset	Reset instrument
geterror	Check and return error message from instrument
invoke	Execute driver-specific function on device object
makemid	Convert driver to MATLAB instrument driver format
selftest	Run instrument self-test

Back to Top

IVI Configuration Store Objects

add	Add entry to IVI configuration store object
commit	Save IVI configuration store object to data file
iviconfigurationstore	Create IVI configuration store object
remove	Remove entry from IVI configuration store object
update	Update entry of IVI configuration store object

Building Simulink Models to Send and Receive Data

Functions — Alphabetical List

© 1984-2012- The MathWorks, Inc.    -   Site Help   -   Patents   -   Trademarks   -   Privacy Policy   -   Preventing Piracy   -   RSS