Documentation

Instrument Control Toolbox Functions

Direct Interface Communication

Direct Interface Communication

fclose Disconnect interface object from instrument
fopen Connect interface object to instrument
fprintf Write text to instrument
fread Read binary data from instrument
fscanf Read data from instrument, and format as text
fwrite Write binary data to instrument
readasync Read data asynchronously from instrument
stopasync Stop asynchronous read and write operations
bluetooth Create Bluetooth object
i2c Create I2C object
spi Create SPI object
tcpip Create TCPIP object
udp Create UDP object
serial Create serial port object
get Instrument object properties
set Configure or display instrument object properties
propinfo Instrument object property information
instrhwinfo Information about available hardware
instrreset Disconnect and delete all instrument objects
clear Remove instrument objects from MATLAB workspace
delete Remove instrument objects from memory
binblockread Read binblock data from instrument
binblockwrite Write binblock data to instrument
disp Display instrument object summary information
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
flushoutput Remove data from output buffer
inspect Open Property Inspector
instrcallback Display event information when event occurs
instrfind Read instrument objects from memory to MATLAB workspace
instrfindall Find visible and hidden instrument objects
instrhelp Help for instrument object type, function, or property
instrid Define and retrieve commands that identify instruments
instrnotify Define notification for instrument events
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
query Write text to instrument, and read data from instrument
record Record data and event information to file
save Save instrument objects and variables to MAT-file
scanstr Read data from instrument, format as text, and parse
serial Create serial port object
size Size of instrument object array
tcpip Create TCPIP object
tmtool Open Test & Measurement Tool
udp Create UDP object

Bluetooth Communication

bluetooth Create Bluetooth object
fopen Connect interface object to instrument
fclose Disconnect interface object from instrument
fprintf Write text to instrument
fread Read binary data from instrument
fscanf Read data from instrument, and format as text
fwrite Write binary data to 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
flushoutput Remove data from output buffer
binblockread Read binblock data from instrument
binblockwrite Write binblock data to instrument
query Write text to instrument, and read data from instrument
readasync Read data asynchronously from instrument
stopasync Stop asynchronous read and write operations
scanstr Read data from instrument, format as text, and parse
get Instrument object properties
set Configure or display instrument object properties
disp Display instrument object summary information
instrhwinfo Information about available hardware
methods Class method names and descriptions
record Record data and event information to file
clear Remove instrument objects from MATLAB workspace
delete Remove instrument objects from memory
instrcallback Display event information when event occurs
instrfind Read instrument objects from memory to MATLAB workspace
instrfindall Find visible and hidden instrument objects
instrhelp Help for instrument object type, function, or property
instrid Define and retrieve commands that identify instruments
instrnotify Define notification for instrument events
instrreset Disconnect and delete all instrument objects
inspect Open Property Inspector
isvalid Determine whether instrument objects are valid
length Length of instrument object array
load Load instrument objects and variables into MATLAB workspace
obj2mfile Convert instrument object to MATLAB code
propinfo Instrument object property information
save Save instrument objects and variables to MAT-file
size Size of instrument object array

I2C Communication

i2c Create I2C object
clear Remove instrument objects from MATLAB workspace
delete Remove instrument objects from memory
disp Display instrument object summary information
fclose Disconnect interface object from instrument
fopen Connect interface object to instrument
fread Read binary data from instrument
fwrite Write binary data to instrument
get Instrument object properties
instrhwinfo Information about available hardware
methods Class method names and descriptions
record Record data and event information to file
set Configure or display instrument object properties

SPI Communication

instrhwinfo Information about available hardware
spi Create SPI object
read Read binary data from SPI instrument
write Write binary data to SPI instrument
writeAndRead Write and read binary data from SPI instrument
methods Class method names and descriptions
disp Display instrument object summary information
connect Connect device object to instrument
disconnect Disconnect device object from instrument
clear Remove instrument objects from MATLAB workspace

TCP/IP and UDP Interface

clear Remove instrument objects from MATLAB workspace
delete Remove instrument objects from memory
echotcpip Start or stop TCP/IP echo server
echoudp Start or stop UDP echo server
fclose Disconnect interface object from instrument
fopen Connect interface object to instrument
fprintf Write text to instrument
fread Read binary data from instrument
fscanf Read data from instrument, and format as text
fwrite Write binary data to instrument
get Instrument object properties
instrhwinfo Information about available hardware
instrreset Disconnect and delete all instrument objects
propinfo Instrument object property information
readasync Read data asynchronously from instrument
resolvehost Network name or network address
set Configure or display instrument object properties
stopasync Stop asynchronous read and write operations
tcpip Create TCPIP object
udp Create UDP object
binblockread Read binblock data from instrument
binblockwrite Write binblock data to instrument
disp Display instrument object summary information
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
flushoutput Remove data from output buffer
instrcallback Display event information when event occurs
instrfind Read instrument objects from memory to MATLAB workspace
instrfindall Find visible and hidden instrument objects
instrhelp Help for instrument object type, function, or property
instrid Define and retrieve commands that identify instruments
instrnotify Define notification for instrument events
inspect Open Property Inspector
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
query Write text to instrument, and read data from instrument
save Save instrument objects and variables to MAT-file
scanstr Read data from instrument, format as text, and parse
size Size of instrument object array
tmtool Open Test & Measurement Tool

Serial Port Interface

clear Remove instrument objects from MATLAB workspace
delete Remove instrument objects from memory
fclose Disconnect interface object from instrument
fopen Connect interface object to instrument
fprintf Write text to instrument
fread Read binary data from instrument
fscanf Read data from instrument, and format as text
fwrite Write binary data to instrument
get Instrument object properties
instrhwinfo Information about available hardware
instrreset Disconnect and delete all instrument objects
propinfo Instrument object property information
readasync Read data asynchronously from instrument
set Configure or display instrument object properties
stopasync Stop asynchronous read and write operations
serial Create serial port object
binblockread Read binblock data from instrument
binblockwrite Write binblock data to instrument
disp Display instrument object summary information
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
flushoutput Remove data from output buffer
instrcallback Display event information when event occurs
instrfind Read instrument objects from memory to MATLAB workspace
instrfindall Find visible and hidden instrument objects
instrhelp Help for instrument object type, function, or property
instrid Define and retrieve commands that identify instruments
instrnotify Define notification for instrument events
inspect Open Property Inspector
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
query Write text to instrument, and read data from instrument
save Save instrument objects and variables to MAT-file
scanstr Read data from instrument, format as text, and parse
size Size of instrument object array
tmtool Open Test & Measurement Tool

Interface-Based Instrument Communication

Instrument Interface Communication

binblockread Read binblock data from instrument
binblockwrite Write binblock data to instrument
clear Remove instrument objects from MATLAB workspace
delete Remove instrument objects from memory
disp Display instrument object summary information
fclose Disconnect interface object from instrument
fopen Connect interface object to instrument
fprintf Write text to instrument
fscanf Read data from instrument, and format as text
get Instrument object properties
gpib Create GPIB object
instrhwinfo Information about available hardware
instrreset Disconnect and delete all instrument objects
set Configure or display instrument object properties
serial Create serial port object
tcpip Create TCPIP object
tmtool Open Test & Measurement Tool
udp Create UDP object
visa Create VISA object
bluetooth Create Bluetooth object
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
flushoutput Remove data from output buffer
fread Read binary data from instrument
fwrite Write binary data to instrument
i2c Create I2C object
instrcallback Display event information when event occurs
instrfind Read instrument objects from memory to MATLAB workspace
instrfindall Find visible and hidden instrument objects
instrhelp Help for instrument object type, function, or property
instrid Define and retrieve commands that identify instruments
instrnotify Define notification for instrument events
inspect Open Property Inspector
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
propinfo Instrument object property information
query Write text to instrument, and read data from instrument
readasync Read data asynchronously from instrument
record Record data and event information to file
save Save instrument objects and variables to MAT-file
scanstr Read data from instrument, format as text, and parse
size Size of instrument object array
stopasync Stop asynchronous read and write operations

GPIB Interface

binblockread Read binblock data from instrument
binblockwrite Write binblock data to instrument
clear Remove instrument objects from MATLAB workspace
clrdevice Clear instrument buffer
delete Remove instrument objects from memory
disp Display instrument object summary information
fclose Disconnect interface object from instrument
fopen Connect interface object to instrument
fprintf Write text to instrument
fscanf Read data from instrument, and format as text
get Instrument object properties
gpib Create GPIB object
instrhwinfo Information about available hardware
instrreset Disconnect and delete all instrument objects
propinfo Instrument object property information
set Configure or display instrument object properties
spoll Perform serial poll on GPIB objects
trigger Send trigger message to instrument
tmtool Open Test & Measurement Tool
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
flushoutput Remove data from output buffer
fread Read binary data from instrument
fwrite Write binary data to instrument
instrcallback Display event information when event occurs
instrfind Read instrument objects from memory to MATLAB workspace
instrfindall Find visible and hidden instrument objects
instrhelp Help for instrument object type, function, or property
instrid Define and retrieve commands that identify instruments
instrnotify Define notification for instrument events
isvalid Determine whether instrument objects are valid
inspect Open Property Inspector
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
query Write text to instrument, and read data from instrument
readasync Read data asynchronously from instrument
record Record data and event information to file
save Save instrument objects and variables to MAT-file
scanstr Read data from instrument, format as text, and parse
size Size of instrument object array
stopasync Stop asynchronous read and write operations

VISA Interface (Includes VXI, PXI, USB)

binblockread Read binblock data from instrument
binblockwrite Write binblock data to instrument
clear Remove instrument objects from MATLAB workspace
clrdevice Clear instrument buffer
delete Remove instrument objects from memory
disp Display instrument object summary information
fclose Disconnect interface object from instrument
fopen Connect interface object to instrument
fprintf Write text to instrument
fscanf Read data from instrument, and format as text
get Instrument object properties
instrhwinfo Information about available hardware
instrreset Disconnect and delete all instrument objects
propinfo Instrument object property information
set Configure or display instrument object properties
tmtool Open Test & Measurement Tool
trigger Send trigger message to instrument
visa Create VISA object
visa.spoll Perform serial poll on VISA objects
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
flushoutput Remove data from output buffer
fread Read binary data from instrument
fwrite Write binary data to instrument
inspect Open Property Inspector
instrcallback Display event information when event occurs
instrfind Read instrument objects from memory to MATLAB workspace
instrfindall Find visible and hidden instrument objects
instrhelp Help for instrument object type, function, or property
instrid Define and retrieve commands that identify instruments
instrnotify Define notification for instrument events
isvalid Determine whether instrument objects are valid
length Length of instrument object array
load Load instrument objects and variables into MATLAB workspace
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
methods Class method names and descriptions
obj2mfile Convert instrument object to MATLAB code
query Write text to instrument, and read data from instrument
readasync Read data asynchronously from instrument
record Record data and event information to file
save Save instrument objects and variables to MAT-file
scanstr Read data from instrument, format as text, and parse
size Size of instrument object array
stopasync Stop asynchronous read and write operations

TCP/IP Instrument Communication

binblockread Read binblock data from instrument
binblockwrite Write binblock data to instrument
clear Remove instrument objects from MATLAB workspace
delete Remove instrument objects from memory
disp Display instrument object summary information
echotcpip Start or stop TCP/IP echo server
fclose Disconnect interface object from instrument
fopen Connect interface object to instrument
fprintf Write text to instrument
fscanf Read data from instrument, and format as text
get Instrument object properties
instrreset Disconnect and delete all instrument objects
instrhwinfo Information about available hardware
propinfo Instrument object property information
resolvehost Network name or network address
set Configure or display instrument object properties
tcpip Create TCPIP object
tmtool Open Test & Measurement Tool
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
flushoutput Remove data from output buffer
fread Read binary data from instrument
fwrite Write binary data to instrument
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
isvalid Determine whether instrument objects are valid
inspect Open Property Inspector
instrhelp Help for instrument object type, function, or property
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
query Write text to instrument, and read data from instrument
readasync Read data asynchronously from instrument
record Record data and event information to file
save Save instrument objects and variables to MAT-file
scanstr Read data from instrument, format as text, and parse
size Size of instrument object array
stopasync Stop asynchronous read and write operations

Serial Port Instrument Communication

binblockread Read binblock data from instrument
binblockwrite Write binblock data to instrument
clear Remove instrument objects from MATLAB workspace
delete Remove instrument objects from memory
disp Display instrument object summary information
fclose Disconnect interface object from instrument
fopen Connect interface object to instrument
fprintf Write text to instrument
fscanf Read data from instrument, and format as text
get Instrument object properties
instrhwinfo Information about available hardware
instrreset Disconnect and delete all instrument objects
propinfo Instrument object property information
set Configure or display instrument object properties
serial Create serial port object
serialbreak Send break to instrument
tmtool Open Test & Measurement Tool
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
flushoutput Remove data from output buffer
fread Read binary data from instrument
fwrite Write binary data to instrument
inspect Open Property Inspector
instrhelp Help for instrument object type, function, or property
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
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
query Write text to instrument, and read data from instrument
readasync Read data asynchronously from instrument
record Record data and event information to file
save Save instrument objects and variables to MAT-file
scanstr Read data from instrument, format as text, and parse
size Size of instrument object array
stopasync Stop asynchronous read and write operations

Driver-Based Instrument Communication

Instrument Driver Communication

connect Connect device object to instrument
clear Remove instrument objects from MATLAB workspace
delete Remove instrument objects from memory
devicereset Reset instrument
disconnect Disconnect device object from instrument
disp Display instrument object summary information
get Instrument object properties
icdevice Create device object
inspect Open Property Inspector
instrhelp Help for instrument object type, function, or property
instrhwinfo Information about available hardware
instrreset Disconnect and delete all instrument objects
invoke Execute driver-specific function on device object
methods Class method names and descriptions
propinfo Instrument object property information
save Save instrument objects and variables to MAT-file
set Configure or display instrument object properties
tmtool Open Test & Measurement Tool
geterror Check and return error message from instrument
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
isvalid Determine whether instrument objects are valid
length Length of instrument object array
load Load instrument objects and variables into MATLAB workspace
makemid Convert driver to MATLAB instrument driver format
obj2mfile Convert instrument object to MATLAB code
selftest Run instrument self-test
size Size of instrument object array

IVI Driver

add Add entry to IVI configuration store object
clear Remove instrument objects from MATLAB workspace
commit Save IVI configuration store object to data file
devicereset Reset instrument
disp Display instrument object summary information
fgen Create Quick-Control Function Generator object
get Instrument object properties
getWaveform Returns waveform displayed on scope
instrhwinfo Information about available hardware
instrreset Disconnect and delete all instrument objects
iviconfigurationstore Create IVI configuration store object
oscilloscope Create Quick-Control Oscilloscope object
remove Remove entry from IVI configuration store object
set Configure or display instrument object properties
tmtool Open Test & Measurement Tool
update Update entry of IVI configuration store object
connect Connect device object to instrument
delete Remove instrument objects from memory
disconnect Disconnect device object from instrument
geterror Check and return error message from instrument
icdevice Create device object
inspect Open Property Inspector
instrhelp Help for instrument object type, function, or property
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
invoke Execute driver-specific function on device object
isvalid Determine whether instrument objects are valid
makemid Convert driver to MATLAB instrument driver format
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
propinfo Instrument object property information
save Save instrument objects and variables to MAT-file
selftest Run instrument self-test
size Size of instrument object array

VXI plug and play Driver

clear Remove instrument objects from MATLAB workspace
connect Connect device object to instrument
delete Remove instrument objects from memory
disconnect Disconnect device object from instrument
disp Display instrument object summary information
devicereset Reset instrument
get Instrument object properties
geterror Check and return error message from instrument
icdevice Create device object
instrhwinfo Information about available hardware
instrreset Disconnect and delete all instrument objects
invoke Execute driver-specific function on device object
propinfo Instrument object property information
set Configure or display instrument object properties
tmtool Open Test & Measurement Tool
trigger Send trigger message to instrument
instrhelp Help for instrument object type, function, or property
inspect Open Property Inspector
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
isvalid Determine whether instrument objects are valid
length Length of instrument object array
load Load instrument objects and variables into MATLAB workspace
makemid Convert driver to MATLAB instrument driver format
methods Class method names and descriptions
obj2mfile Convert instrument object to MATLAB code
save Save instrument objects and variables to MAT-file
selftest Run instrument self-test
size Size of instrument object array

Generic Instrument Drivers

clear Remove instrument objects from MATLAB workspace
connect Connect device object to instrument
delete Remove instrument objects from memory
disp Display instrument object summary information
disconnect Disconnect device object from instrument
get Instrument object properties
inspect Open Property Inspector
instrhelp Help for instrument object type, function, or property
instrhwinfo Information about available hardware
instrreset Disconnect and delete all instrument objects
invoke Execute driver-specific function on device object
makemid Convert driver to MATLAB instrument driver format
methods Class method names and descriptions
midedit Open graphical tool for creating and editing MATLAB instrument driver
propinfo Instrument object property information
save Save instrument objects and variables to MAT-file
set Configure or display instrument object properties
tmtool Open Test & Measurement Tool
devicereset Reset instrument
geterror Check and return error message from instrument
icdevice Create device object
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
isvalid Determine whether instrument objects are valid
length Length of instrument object array
load Load instrument objects and variables into MATLAB workspace
obj2mfile Convert instrument object to MATLAB code
selftest Run instrument self-test
size Size of instrument object array

Instrument Driver Editing and Testing

clear Remove instrument objects from MATLAB workspace
connect Connect device object to instrument
delete Remove instrument objects from memory
disconnect Disconnect device object from instrument
disp Display instrument object summary information
get Instrument object properties
inspect Open Property Inspector
instrhwinfo Information about available hardware
instrreset Disconnect and delete all instrument objects
invoke Execute driver-specific function on device object
makemid Convert driver to MATLAB instrument driver format
methods Class method names and descriptions
midedit Open graphical tool for creating and editing MATLAB instrument driver
midtest Open graphical tool for testing MATLAB instrument driver
propinfo Instrument object property information
save Save instrument objects and variables to MAT-file
selftest Run instrument self-test
set Configure or display instrument object properties
tmtool Open Test & Measurement Tool
Was this topic helpful?