Instrument Control Toolbox™Building Simulink® Models to Send and Receive Data   Functions — Alphabetical List
  

Function Reference

Click for Alphabetical List Alphabetical List
Instrument Object CreationCreate interface objects and device objects
State ChangeConnect to instruments, disconnect from instruments, and record information to disk
Property Display and ConfigurationReturn properties, configure properties, and open property inspector
Reading DataRead text, binary, and binblock data for interface objects
Writing DataWrite text, binary, and binblock data for interface objects
Information and HelpReturn function help, property help, and property characteristics
Graphical ToolsTools that facilitate instrument control in graphical environment
General PurposeDelete, clear, find, save, and load objects, convert objects to M-code
Interface ObjectsFunctions listed by interface type (GPIB, VISA-VXI, and so on)
Device ObjectsFunctions used only with device objects
IVI Configuration Store ObjectsFunctions used only with IVI configuration store objects

Back to Top

Instrument Object Creation

Interface ObjectCreate interface object
Device ObjectCreate device object

Back to Top of Section

Interface Object

gpibCreate GPIB object
serialCreate serial port object
tcpipCreate TCPIP object
udpCreate UDP object
visaCreate VISA object

Back to Top of Section

Device Object

icdeviceCreate device object

Back to Top

State Change

Interface ObjectControl interface object
Device ObjectControl device object

Back to Top of Section

Interface Object

fcloseDisconnect interface object from instrument
fopenConnect interface object to instrument
recordRecord data and event information to file

Back to Top of Section

Device Object

connectConnect device object to instrument
disconnectDisconnect device object from instrument

Back to Top

Property Display and Configuration

getInstrument object properties
inspectOpen Property Inspector
setConfigure or display instrument object properties

Back to Top

Reading Data

binblockreadRead binblock data from instrument
fgetlRead line of text from instrument and discard terminator
fgetsRead line of text from instrument and include terminator
flushinputRemove data from input buffer
freadRead binary data from instrument
fscanfRead data from instrument, and format as text
queryWrite text to instrument, and read data from instrument
readasyncRead data asynchronously from instrument
scanstrRead data from instrument, format as text, and parse
stopasyncStop asynchronous read and write operations

Back to Top

Writing Data

binblockwriteWrite binblock data to instrument
flushoutputRemove data from output buffer
fprintfWrite text to instrument
fwriteWrite binary data to instrument
queryWrite text to instrument, and read data from instrument
stopasyncStop asynchronous read and write operations

Back to Top

Information and Help

instrhelpHelp for instrument object type, function, or property
instrhwinfoInformation about available hardware
propinfoInstrument object property information

Back to Top

Graphical Tools

Interface ObjectGraphical tools for interface objects
Device ObjectGraphical tools for device objects

Back to Top of Section

Interface Object

tmtoolOpen Test & Measurement Tool

Back to Top of Section

Device Object

mideditOpen graphical tool for creating and editing MATLAB® instrument driver
midtestOpen graphical tool for testing MATLAB® instrument driver
tmtoolOpen Test & Measurement Tool

Back to Top

General Purpose

clearRemove instrument objects from MATLAB® workspace
deleteRemove instrument objects from memory
dispDisplay instrument object summary information
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
instrresetDisconnect and delete all instrument objects
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
saveSave instrument objects and variables to MAT-file
sizeSize of instrument object array

Back to Top

Interface Objects

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

Back to Top of Section

GPIB

clrdeviceClear instrument buffer
gpibCreate GPIB object
spollPerform serial poll
triggerSend trigger message to instrument

Back to Top of Section

Serial Port

serialCreate serial port object
serialbreakSend break to instrument

Back to Top of Section

TCP/IP

echotcpipStart or stop TCP/IP echo server
resolvehostNetwork name or network address
tcpipCreate TCPIP object

Back to Top of Section

UDP

echoudpStart or stop UDP echo server
resolvehostNetwork name or network address
udpCreate UDP object

Back to Top of Section

VISA-GPIB

clrdeviceClear instrument buffer
triggerSend trigger message to instrument
visaCreate VISA object

Back to Top of Section

VISA-GPIB-VXI

clrdeviceClear instrument buffer
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
visaCreate VISA object

Back to Top of Section

VISA-Serial

visaCreate VISA object

Back to Top of Section

VISA-VXI

clrdeviceClear instrument buffer
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
triggerSend trigger message to instrument
visaCreate VISA object

Back to Top

Device Objects

deviceresetReset instrument
geterrorCheck and return error message from instrument
invokeExecute driver-specific function on device object
makemidConvert driver to MATLAB® instrument driver format
selftestRun instrument self-test

Back to Top

IVI Configuration Store Objects

addAdd entry to IVI configuration store object
commitSave IVI configuration store object to data file
iviconfigurationstoreCreate IVI configuration store object
removeRemove entry from IVI configuration store object
updateUpdate entry of IVI configuration store object
  

Building Simulink® Models to Send and Receive DataBuilding Simulink® Models to Send and Receive Data Functions — Alphabetical ListFunctions — Alphabetical List

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