Contents

Index

• Getting Started

• Instrument Control Session

• Using Interface Objects

• Controlling Instruments Using GPIB

• Controlling Instruments Using VISA

• Controlling Instruments Using the Serial Port

• Controlling Instruments Using TCP/IP and UDP

• Using Device Objects

• Using VXIplug&play Drivers

• Using IVI Drivers

• Using Generic Instrument Drivers

• Saving and Loading the Session

• Test & Measurement Tool

• Using the Instrument Driver Editor

• Using the Instrument Driver Testing Tool

• Using the Instrument Control Toolbox Block Library

• Property Reference

• Interface Object Base Properties

General Purpose

• Interface-Specific Properties

Device Object Base Properties

IVI Configuration Store Object Properties

• Vendor Driver Requirements and Limitations

• Release Notes

Learn more about Instrument Control Toolbox

Property Reference

Click for Alphabetical List

Alphabetical List

Interface Object Base Properties

Writing Data	Output buffer parameters, timeout, status
Reading Data	Input buffer parameters, timeout, status
Recording Data	Record file parameters, status
Callbacks	M-file callback functions to execute when specific events occur
General Purpose	Object description, byte order, status

Back to Top of Section

Writing Data

BytesToOutput	Number of bytes currently in output buffer
OutputBufferSize	Specify size of output buffer in bytes
Timeout	Specify waiting time to complete read or write operation
TransferStatus	Status of whether asynchronous read or write operation is in progress
ValuesSent	Total number of values written to instrument

Back to Top of Section

Reading Data

BytesAvailable	Number of bytes available in input buffer
InputBufferSize	Specify size of input buffer in bytes
Timeout	Specify waiting time to complete read or write operation
TransferStatus	Status of whether asynchronous read or write operation is in progress
ValuesReceived	Total number of values read from instrument

Back to Top of Section

Recording Data

RecordDetail	Specify amount of information saved to record file
RecordMode	Specify whether data and event information are saved to one or to multiple record files
RecordName	Specify name of record file
RecordStatus	Status of whether data and event information are saved to record file

Back to Top of Section

Callbacks

BytesAvailableFcn	Specify M-file callback function to execute when specified number of bytes are available in input buffer, or terminator is read
BytesAvailableFcnCount	Specify number of bytes that must be available in input buffer to generate bytes-available event
BytesAvailableFcnMode	Specify whether bytes-available event is generated after specified number of bytes are available in input buffer, or after terminator is read
ErrorFcn	Specify M-file callback function to execute when error event occurs
OutputEmptyFcn	Specify M-file callback function to execute when output buffer is empty
TimerFcn	Specify M-file callback function to execute when predefined period passes
TimerPeriod	Specify period between timer events

Back to Top of Section

General Purpose

ByteOrder	Specify byte order of instrument
Name	Specify descriptive name for instrument object
ObjectVisibility	Control access to instrument object
Status	Status of whether object is connected to instrument
Tag	Specify label to associate with instrument object
Type	Instrument object type
UserData	Specify data to associate with instrument object

Interface-Specific Properties

GPIB	Communication address, bus configuration, status
Serial Port	Communication settings, data format, signals and pins
TCPIP	Host and port information, terminator character
UDP	Host and port information, datagrams, terminator character
VISA-GPIB	Resource name, communication address, bus configuration, status
VISA-GPIB-VXI	Resource name, VXI memory, chassis information, communication address, bus configuration, status
VISA-RSIB	Resource name, communication address, communication settings
VISA-Serial	Resource name, communication settings, data format, signals and pins
VISA-TCPIP	Resource name, communication address, communication settings
VISA-USB	Resource name, communication address, communication settings
VISA-VXI	Resource name, VXI memory, chassis information, status

Back to Top of Section

GPIB

BoardIndex	Specify index number of interface board
BusManagementStatus	State of GPIB bus management lines
CompareBits	Specify number of bits that must match EOS character to complete read operation, or to assert EOI line
EOIMode	Specify if EOI line is asserted at end of write operation
EOSCharCode	Specify EOS character
EOSMode	Specify when EOS character is written or read
HandshakeStatus	State of GPIB handshake lines
PrimaryAddress	Specify primary address of GPIB instrument
SecondaryAddress	Specify secondary address of GPIB instrument

Back to Top of Section

Serial Port

BaudRate	Specify bit transmit rate
BreakInterruptFcn	Specify M-file callback function to execute when break-interrupt event occurs
DataBits	Specify number of data bits to transmit
DataTerminalReady	Specify state of DTR pin
FlowControl	Specify data flow control method to use
Parity	Specify type of parity checking
PinStatus	State of CD, CTS, DSR, and RI pins
PinStatusFcn	Specify M-file callback function to execute when CD, CTS, DSR, or RI pin changes state
Port	Specify platform-specific serial port name
ReadAsyncMode	Specify whether asynchronous read operation is continuous or manual
RequestToSend	Specify state of RTS pin
StopBits	Specify number of bits used to indicate end of byte
Terminator	Specify terminator character

Back to Top of Section

TCPIP

LocalHost	Specify local host
LocalPort	Specify local host port for connection
LocalPortMode	Specify local host port selection mode
ReadAsyncMode	Specify whether asynchronous read operation is continuous or manual
RemoteHost	Specify remote host
RemotePort	Specify remote host port for connection
Terminator	Specify terminator character
TransferDelay	Specify use of TCP segment transfer algorithm

Back to Top of Section

UDP

DatagramAddress	IP dotted decimal address of received datagram sender
DatagramPort	Port number of datagram sender
DatagramReceivedFcn	Specify M-file callback function to execute when datagram is received
DatagramTerminateMode	Configure terminate read mode when reading datagrams
LocalHost	Specify local host
LocalPort	Specify local host port for connection
LocalPortMode	Specify local host port selection mode
ReadAsyncMode	Specify whether asynchronous read operation is continuous or manual
RemoteHost	Specify remote host
RemotePort	Specify remote host port for connection
Terminator	Specify terminator character

Back to Top of Section

VISA-GPIB

BoardIndex	Specify index number of interface board
EOIMode	Specify if EOI line is asserted at end of write operation
EOSCharCode	Specify EOS character
EOSMode	Specify when EOS character is written or read
PrimaryAddress	Specify primary address of GPIB instrument
RsrcName	Resource name for VISA instrument
SecondaryAddress	Specify secondary address of GPIB instrument

Back to Top of Section

VISA-GPIB-VXI

BoardIndex	Specify index number of interface board
ChassisIndex	Specify index number of VXI chassis
EOIMode	Specify if EOI line is asserted at end of write operation
EOSCharCode	Specify EOS character
EOSMode	Specify when EOS character is written or read
LogicalAddress	Specify logical address of VXI instrument
MappedMemoryBase	Base memory address of mapped memory
MappedMemorySize	Size of mapped memory for low-level read and write operations
MemoryBase	Base address of A24 or A32 space
MemoryIncrement	Specify whether VXI register offset increments after data is transferred
MemorySize	Size of memory requested in A24 or A32 address space
MemorySpace	Address space used by instrument
PrimaryAddress	Specify primary address of GPIB instrument
RsrcName	Resource name for VISA instrument
SecondaryAddress	Specify secondary address of GPIB instrument
Slot	Slot location of VXI instrument

Back to Top of Section

VISA-RSIB

EOIMode	Specify if EOI line is asserted at end of write operation
RemoteHost	Specify remote host

Back to Top of Section

VISA-Serial

BaudRate	Specify bit transmit rate
DataBits	Specify number of data bits to transmit
DataTerminalReady	Specify state of DTR pin
FlowControl	Specify data flow control method to use
Parity	Specify type of parity checking
PinStatus	State of CD, CTS, DSR, and RI pins
Port	Specify platform-specific serial port name
ReadAsyncMode	Specify whether asynchronous read operation is continuous or manual
RequestToSend	Specify state of RTS pin
RsrcName	Resource name for VISA instrument
StopBits	Specify number of bits used to indicate end of byte
Terminator	Specify terminator character

Back to Top of Section

VISA-TCPIP

BoardIndex	Specify index number of interface board
EOIMode	Specify if EOI line is asserted at end of write operation
EOSCharCode	Specify EOS character
EOSMode	Specify when EOS character is written or read
LANName	Specify LAN device name
RemoteHost	Specify remote host

Back to Top of Section

VISA-USB

BoardIndex	Specify index number of interface board
EOIMode	Specify if EOI line is asserted at end of write operation
EOSCharCode	Specify EOS character
EOSMode	Specify when EOS character is written or read
InterfaceIndex	Specify USB interface number
ManufacturerID	Specify manufacturer ID of USB instrument
ModelCode	Specify model code of USB instrument
SerialNumber	Specify index of USB instrument on USB hub

Back to Top of Section

VISA-VXI

ChassisIndex	Specify index number of VXI chassis
EOIMode	Specify if EOI line is asserted at end of write operation
EOSCharCode	Specify EOS character
EOSMode	Specify when EOS character is written or read
InterruptFcn	Specify M-file callback function to execute when interrupt event occurs
LogicalAddress	Specify logical address of VXI instrument
MappedMemoryBase	Base memory address of mapped memory
MappedMemorySize	Size of mapped memory for low-level read and write operations
MemoryBase	Base address of A24 or A32 space
MemoryIncrement	Specify whether VXI register offset increments after data is transferred
MemorySize	Size of memory requested in A24 or A32 address space
MemorySpace	Address space used by instrument
RsrcName	Resource name for VISA instrument
Slot	Slot location of VXI instrument
TriggerFcn	Specify M-file callback function to execute when trigger event occurs
TriggerLine	Specify trigger line on VXI instrument
TriggerType	Specify trigger type

Device Object Base Properties

ConfirmationFcn	Specify M-file callback function to execute when confirmation event occurs
DriverType	Specify type of driver used to communicate with instrument
InstrumentModel	Instrument model that object connects to
Interface	Interface object that communicates with instrument
LogicalName	Specify description of interface used to communicate with instrument
Name	Specify descriptive name for instrument object
ObjectVisibility	Control access to instrument object
Status	Status of whether object is connected to instrument
Tag	Specify label to associate with instrument object
Timeout	Specify waiting time to complete read or write operation
Type	Instrument object type
UserData	Specify data to associate with instrument object

IVI Configuration Store Object Properties

ActualLocation	Configuration store file used by IVI configuration store object
DriverSessions	Array of driver sessions contained in IVI configuration store
HardwareAssets	Array of hardware assets contained in IVI configuration store
LogicalNames	Array of logical names contained in IVI configuration store
MasterLocation	Full pathname of master configuration store file
Name (iviconfigurationstore)	Name of IVI configuration server
ProcessLocation	Configuration store file for process to use if master configuration store is not used
PublishedAPIs	Array of published APIs in IVI configuration store
Revision	IVI configuration store version
ServerDescription	IVI configuration store server description
Sessions	Array of driver sessions in IVI configuration store
SoftwareModules	Array of software modules in IVI configuration store
SpecificationVersion	IVI configuration server specification version that this server revision complies with
Vendor	IVI configuration server vendor

visa

Properties — Alphabetical List

Properties — Alphabetical List

Recommended Products

Get MATLAB trial software

Includes the most popular MATLAB recorded presentations with Q&A sessions led by MATLAB experts.

Get the Interactive Kit

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