Documentation

This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English verison of the page.

Note: This page has been translated by MathWorks. Please click here
To view all translated materals including this page, select Japan from the country navigator on the bottom of this page.

Instrument Control Toolbox Functions

Alphabetical List By Category

Interface-Based Instrument Communication

Interface-Based Communication

bluetoothCreate Bluetooth object
i2cCreate I2C object
spiCreate SPI object
tcpipCreate TCPIP object
udpCreate UDP object
serialCreate serial port object
tmtoolOpen Test & Measurement Tool
fcloseDisconnect interface object from instrument
fopenConnect interface object to instrument
fprintfWrite text to instrument
freadRead binary data from instrument
fscanfRead data from instrument, and format as text
fwriteWrite binary data to instrument
readasyncRead data asynchronously from instrument
stopasyncStop asynchronous read and write operations
binblockreadRead binblock data from instrument
binblockwriteWrite binblock data to instrument
flushinputRemove data from input buffer
flushoutputRemove data from output buffer
getInstrument object properties
setConfigure or display instrument object properties
propinfoInstrument object property information
dispDisplay instrument object summary information
instrhwinfoInformation about available hardware
instrresetDisconnect and delete all instrument objects
clearRemove instrument objects from MATLAB workspace
deleteRemove instrument objects from memory
fgetlRead line of text from instrument and discard terminator
fgetsRead line of text from instrument and include terminator
inspectOpen Property Inspector
instrcallbackDisplay event information when event occurs
instrfindRead instrument objects from memory to MATLAB workspace
instrfindallFind visible and hidden instrument objects
instrhelpHelp for instrument object type, function, or property
instridDefine and retrieve commands that identify instruments
instrnotifyDefine notification for instrument events
isvalidDetermine whether instrument objects are valid
lengthLength of instrument object array
loadLoad instrument objects and variables into MATLAB workspace
methodsClass method names and descriptions
obj2mfileConvert instrument object to MATLAB code
queryWrite text to instrument, and read data from instrument
recordRecord data and event information to file
saveSave instrument objects and variables to MAT-file
scanstrRead data from instrument, format as text, and parse
serialCreate serial port object
sizeSize of instrument object array

Bluetooth Communication

bluetoothCreate Bluetooth object
fopenConnect interface object to instrument
fcloseDisconnect interface object from instrument
fprintfWrite text to instrument
freadRead binary data from instrument
fscanfRead data from instrument, and format as text
fwriteWrite binary data to instrument
fgetlRead line of text from instrument and discard terminator
fgetsRead line of text from instrument and include terminator
flushinputRemove data from input buffer
flushoutputRemove data from output buffer
binblockreadRead binblock data from instrument
binblockwriteWrite binblock data to instrument
queryWrite text to instrument, and read data from instrument
readasyncRead data asynchronously from instrument
stopasyncStop asynchronous read and write operations
scanstrRead data from instrument, format as text, and parse
getInstrument object properties
setConfigure or display instrument object properties
dispDisplay instrument object summary information
instrhwinfoInformation about available hardware
methodsClass method names and descriptions
recordRecord data and event information to file
clearRemove instrument objects from MATLAB workspace
deleteRemove instrument objects from memory
instrcallbackDisplay event information when event occurs
instrfindRead instrument objects from memory to MATLAB workspace
instrfindallFind visible and hidden instrument objects
instrhelpHelp for instrument object type, function, or property
instridDefine and retrieve commands that identify instruments
instrnotifyDefine notification for instrument events
instrresetDisconnect and delete all instrument objects
inspectOpen Property Inspector
isvalidDetermine whether instrument objects are valid
lengthLength of instrument object array
loadLoad instrument objects and variables into MATLAB workspace
obj2mfileConvert instrument object to MATLAB code
propinfoInstrument object property information
saveSave instrument objects and variables to MAT-file
sizeSize of instrument object array

I2C Communication

i2cCreate I2C object
clearRemove instrument objects from MATLAB workspace
deleteRemove instrument objects from memory
dispDisplay instrument object summary information
fcloseDisconnect interface object from instrument
fopenConnect interface object to instrument
freadRead binary data from instrument
fwriteWrite binary data to instrument
getInstrument object properties
instrhwinfoInformation about available hardware
methodsClass method names and descriptions
recordRecord data and event information to file
setConfigure or display instrument object properties

SPI Communication

instrhwinfoInformation about available hardware
spiCreate SPI object
readRead binary data from SPI instrument
writeWrite binary data to SPI instrument
writeAndReadWrite and read binary data from SPI instrument
methodsClass method names and descriptions
dispDisplay instrument object summary information
connectConnect device object to instrument
disconnectDisconnect device object from instrument
clearRemove instrument objects from MATLAB workspace

MODBUS Communication

modbusCreate MODBUS object
readRead data from a MODBUS server
writePerform a write operation to the connected MODBUS server
writeReadPerform a write then read operation on groups of holding registers in a single MODBUS transaction
maskWritePerform mask write operation on a holding register
instrhwinfoInformation about available hardware
clearRemove instrument objects from MATLAB workspace

TCP/IP and UDP Interface

tcpipCreate TCPIP object
udpCreate UDP object
echotcpipStart or stop TCP/IP echo server
echoudpStart or stop UDP echo server
resolvehostNetwork name or network address
tmtoolOpen Test & Measurement Tool
fopenConnect interface object to instrument
fcloseDisconnect interface object from instrument
freadRead binary data from instrument
fwriteWrite binary data to instrument
fscanfRead data from instrument, and format as text
fprintfWrite text to instrument
readasyncRead data asynchronously from instrument
stopasyncStop asynchronous read and write operations
binblockreadRead binblock data from instrument
binblockwriteWrite binblock data to instrument
fgetlRead line of text from instrument and discard terminator
fgetsRead line of text from instrument and include terminator
queryWrite text to instrument, and read data from instrument
scanstrRead data from instrument, format as text, and parse
clearRemove instrument objects from MATLAB workspace
deleteRemove instrument objects from memory
instrhwinfoInformation about available hardware
instrfindRead instrument objects from memory to MATLAB workspace
instrfindallFind visible and hidden instrument objects
instrresetDisconnect and delete all instrument objects
flushinputRemove data from input buffer
flushoutputRemove data from output buffer
instrcallbackDisplay event information when event occurs

Serial Port Interface

clearRemove instrument objects from MATLAB workspace
deleteRemove instrument objects from memory
fcloseDisconnect interface object from instrument
fopenConnect interface object to instrument
fprintfWrite text to instrument
freadRead binary data from instrument
fscanfRead data from instrument, and format as text
fwriteWrite binary data to instrument
getInstrument object properties
instrhwinfoInformation about available hardware
instrresetDisconnect and delete all instrument objects
propinfoInstrument object property information
readasyncRead data asynchronously from instrument
setConfigure or display instrument object properties
serialCreate serial port object
seriallistList of serial ports connected to your system
stopasyncStop asynchronous read and write operations
binblockreadRead binblock data from instrument
binblockwriteWrite binblock data to instrument
dispDisplay instrument object summary information
flushinputRemove data from input buffer
flushoutputRemove data from output buffer
tmtoolOpen Test & Measurement Tool
fgetlRead line of text from instrument and discard terminator
fgetsRead line of text from instrument and include terminator
instrcallbackDisplay event information when event occurs
instrfindRead instrument objects from memory to MATLAB workspace
instrfindallFind visible and hidden instrument objects
instrhelpHelp for instrument object type, function, or property
instridDefine and retrieve commands that identify instruments
instrnotifyDefine notification for instrument events
inspectOpen Property Inspector
isvalidDetermine whether instrument objects are valid
lengthLength of instrument object array
loadLoad instrument objects and variables into MATLAB workspace
methodsClass method names and descriptions
obj2mfileConvert instrument object to MATLAB code
queryWrite text to instrument, and read data from instrument
saveSave instrument objects and variables to MAT-file
scanstrRead data from instrument, format as text, and parse
sizeSize of instrument object array

GPIB Interface

binblockreadRead binblock data from instrument
binblockwriteWrite binblock data to instrument
clearRemove instrument objects from MATLAB workspace
clrdeviceClear instrument buffer
deleteRemove instrument objects from memory
dispDisplay instrument object summary information
fcloseDisconnect interface object from instrument
fopenConnect interface object to instrument
fprintfWrite text to instrument
fscanfRead data from instrument, and format as text
getInstrument object properties
gpibCreate GPIB object
instrhwinfoInformation about available hardware
instrresetDisconnect and delete all instrument objects
propinfoInstrument object property information
setConfigure or display instrument object properties
spollPerform serial poll on GPIB objects
triggerSend trigger message to instrument
tmtoolOpen Test & Measurement Tool
fgetlRead line of text from instrument and discard terminator
fgetsRead line of text from instrument and include terminator
flushinputRemove data from input buffer
flushoutputRemove data from output buffer
freadRead binary data from instrument
fwriteWrite binary data to instrument
isvalidDetermine whether instrument objects are valid
inspectOpen Property Inspector
lengthLength of instrument object array
loadLoad instrument objects and variables into MATLAB workspace
methodsClass method names and descriptions
obj2mfileConvert instrument object to MATLAB code
queryWrite text to instrument, and read data from instrument
readasyncRead data asynchronously from instrument
recordRecord data and event information to file
saveSave instrument objects and variables to MAT-file
scanstrRead data from instrument, format as text, and parse
sizeSize of instrument object array
stopasyncStop asynchronous read and write operations
instrcallbackDisplay event information when event occurs
instrfindRead instrument objects from memory to MATLAB workspace
instrfindallFind visible and hidden instrument objects
instrhelpHelp for instrument object type, function, or property
instridDefine and retrieve commands that identify instruments
instrnotifyDefine notification for instrument events

VISA Interface (Includes VXI, PXI, USB)

binblockreadRead binblock data from instrument
binblockwriteWrite binblock data to instrument
clearRemove instrument objects from MATLAB workspace
clrdeviceClear instrument buffer
deleteRemove instrument objects from memory
dispDisplay instrument object summary information
fcloseDisconnect interface object from instrument
fopenConnect interface object to instrument
fprintfWrite text to instrument
fscanfRead data from instrument, and format as text
getInstrument object properties
instrhwinfoInformation about available hardware
instrresetDisconnect and delete all instrument objects
propinfoInstrument object property information
setConfigure or display instrument object properties
tmtoolOpen Test & Measurement Tool
triggerSend trigger message to instrument
visaCreate VISA object
visa.spollPerform serial poll on VISA objects
fgetlRead line of text from instrument and discard terminator
fgetsRead line of text from instrument and include terminator
flushinputRemove data from input buffer
flushoutputRemove data from output buffer
freadRead binary data from instrument
fwriteWrite binary data to instrument
inspectOpen Property Inspector
isvalidDetermine whether instrument objects are valid
lengthLength of instrument object array
loadLoad instrument objects and variables into MATLAB workspace
methodsClass method names and descriptions
obj2mfileConvert instrument object to MATLAB code
queryWrite text to instrument, and read data from instrument
readasyncRead data asynchronously from instrument
recordRecord data and event information to file
saveSave instrument objects and variables to MAT-file
scanstrRead data from instrument, format as text, and parse
sizeSize of instrument object array
stopasyncStop asynchronous read and write operations
instrcallbackDisplay event information when event occurs
instrfindRead instrument objects from memory to MATLAB workspace
instrfindallFind visible and hidden instrument objects
instrhelpHelp for instrument object type, function, or property
instridDefine and retrieve commands that identify instruments
instrnotifyDefine notification for instrument events
memmapMap memory for low-level memory read and write operations
mempeekLow-level memory read from VXI register
mempokeLow-level memory write to VXI register
memreadHigh-level memory read from VXI register
memunmapUnmap memory for low-level memory read and write operations
memwriteHigh-level memory write to VXI register

Driver-Based Instrument Communication

Instrument Driver Communication

connectConnect device object to instrument
clearRemove instrument objects from MATLAB workspace
deleteRemove instrument objects from memory
deviceresetReset instrument
disconnectDisconnect device object from instrument
dispDisplay instrument object summary information
getInstrument object properties
icdeviceCreate device object
inspectOpen Property Inspector
instrhelpHelp for instrument object type, function, or property
instrhwinfoInformation about available hardware
instrresetDisconnect and delete all instrument objects
invokeExecute driver-specific function on device object
methodsClass method names and descriptions
propinfoInstrument object property information
saveSave instrument objects and variables to MAT-file
setConfigure or display instrument object properties
tmtoolOpen Test & Measurement Tool
geterrorCheck and return error message from instrument
instrcallbackDisplay event information when event occurs
instrfindRead instrument objects from memory to MATLAB workspace
instrfindallFind visible and hidden instrument objects
instridDefine and retrieve commands that identify instruments
instrnotifyDefine notification for instrument events
isvalidDetermine whether instrument objects are valid
lengthLength of instrument object array
loadLoad instrument objects and variables into MATLAB workspace
makemidConvert driver to MATLAB instrument driver format
obj2mfileConvert instrument object to MATLAB code
selftestRun instrument self-test
sizeSize of instrument object array

IVI Driver

addAdd entry to IVI configuration store object
clearRemove instrument objects from MATLAB workspace
commitSave IVI configuration store object to data file
deviceresetReset instrument
dispDisplay instrument object summary information
fgenCreate Quick-Control Function Generator object
getInstrument object properties
getWaveformReturns waveform displayed on scope
instrhwinfoInformation about available hardware
instrresetDisconnect and delete all instrument objects
iviconfigurationstoreCreate IVI configuration store object
oscilloscopeCreate Quick-Control Oscilloscope object
removeRemove entry from IVI configuration store object
setConfigure or display instrument object properties
tmtoolOpen Test & Measurement Tool
updateUpdate entry of IVI configuration store object
connectConnect device object to instrument
deleteRemove instrument objects from memory
disconnectDisconnect device object from instrument
geterrorCheck and return error message from instrument
icdeviceCreate device object
inspectOpen Property Inspector
invokeExecute driver-specific function on device object
isvalidDetermine whether instrument objects are valid
makemidConvert driver to MATLAB instrument driver format
lengthLength of instrument object array
loadLoad instrument objects and variables into MATLAB workspace
methodsClass method names and descriptions
obj2mfileConvert instrument object to MATLAB code
propinfoInstrument object property information
saveSave instrument objects and variables to MAT-file
selftestRun instrument self-test
sizeSize of instrument object array
instrhelpHelp for instrument object type, function, or property
instrcallbackDisplay event information when event occurs
instrfindRead instrument objects from memory to MATLAB workspace
instrfindallFind visible and hidden instrument objects
instridDefine and retrieve commands that identify instruments
instrnotifyDefine notification for instrument events

Quick-Control Interfaces

oscilloscopeCreate Quick-Control Oscilloscope object
fgenCreate Quick-Control Function Generator object
rfsiggenCreate Quick-Control RF Signal Generator object
readWaveformReturns waveform displayed on scope
downloadDownloads arbitrary waveform to RF signal generator
startEnables RF signal generator signal output and modulation output
resourcesList of available instrument resources for Quick-Control interfaces
driversList of available instrument drivers for Quick-Control interfaces
connectConnect device object to instrument
disconnectDisconnect device object from instrument

VXI plug and play Driver

clearRemove instrument objects from MATLAB workspace
connectConnect device object to instrument
deleteRemove instrument objects from memory
disconnectDisconnect device object from instrument
dispDisplay instrument object summary information
deviceresetReset instrument
getInstrument object properties
geterrorCheck and return error message from instrument
icdeviceCreate device object
instrhwinfoInformation about available hardware
instrresetDisconnect and delete all instrument objects
invokeExecute driver-specific function on device object
propinfoInstrument object property information
setConfigure or display instrument object properties
tmtoolOpen Test & Measurement Tool
triggerSend trigger message to instrument
instrhelpHelp for instrument object type, function, or property
inspectOpen Property Inspector
instrcallbackDisplay event information when event occurs
instrfindRead instrument objects from memory to MATLAB workspace
instrfindallFind visible and hidden instrument objects
instridDefine and retrieve commands that identify instruments
instrnotifyDefine notification for instrument events
isvalidDetermine whether instrument objects are valid
lengthLength of instrument object array
loadLoad instrument objects and variables into MATLAB workspace
makemidConvert driver to MATLAB instrument driver format
methodsClass method names and descriptions
obj2mfileConvert instrument object to MATLAB code
saveSave instrument objects and variables to MAT-file
selftestRun instrument self-test
sizeSize of instrument object array

Generic Instrument Drivers

clearRemove instrument objects from MATLAB workspace
connectConnect device object to instrument
deleteRemove instrument objects from memory
dispDisplay instrument object summary information
disconnectDisconnect device object from instrument
getInstrument object properties
inspectOpen Property Inspector
instrhelpHelp for instrument object type, function, or property
instrhwinfoInformation about available hardware
instrresetDisconnect and delete all instrument objects
invokeExecute driver-specific function on device object
makemidConvert driver to MATLAB instrument driver format
methodsClass method names and descriptions
mideditOpen graphical tool for creating and editing MATLAB instrument driver
propinfoInstrument object property information
saveSave instrument objects and variables to MAT-file
setConfigure or display instrument object properties
tmtoolOpen Test & Measurement Tool
deviceresetReset instrument
geterrorCheck and return error message from instrument
icdeviceCreate device object
instrcallbackDisplay event information when event occurs
instrfindRead instrument objects from memory to MATLAB workspace
instrfindallFind visible and hidden instrument objects
instridDefine and retrieve commands that identify instruments
instrnotifyDefine notification for instrument events
isvalidDetermine whether instrument objects are valid
lengthLength of instrument object array
loadLoad instrument objects and variables into MATLAB workspace
obj2mfileConvert instrument object to MATLAB code
selftestRun instrument self-test
sizeSize of instrument object array

Instrument Driver Editing and Testing

clearRemove instrument objects from MATLAB workspace
connectConnect device object to instrument
deleteRemove instrument objects from memory
disconnectDisconnect device object from instrument
dispDisplay instrument object summary information
getInstrument object properties
inspectOpen Property Inspector
instrhwinfoInformation about available hardware
instrresetDisconnect and delete all instrument objects
invokeExecute driver-specific function on device object
makemidConvert driver to MATLAB instrument driver format
methodsClass method names and descriptions
mideditOpen graphical tool for creating and editing MATLAB instrument driver
midtestOpen graphical tool for testing MATLAB instrument driver
propinfoInstrument object property information
saveSave instrument objects and variables to MAT-file
selftestRun instrument self-test
setConfigure or display instrument object properties
tmtoolOpen Test & Measurement Tool
Was this topic helpful?