Instrument Control Toolbox

Object-Specific Properties

Object-specific properties apply only to instrument objects of a given type (GPIB, VISA-VXI, and so on). For example, the BreakInterruptAction property is supported only for serial port objects. The object-specific properties are organized into the following categories based on instrument object type and usage.

GPIB Properties

GPIB Address Properties
BoardIndex	Specify the index number of the GPIB board
PrimaryAddress	Specify the primary address of the GPIB instrument
Secondary Address	Specify the secondary address of the GPIB instrument

GPIB Read/Write Properties
CompareBits	Specify the number of bits that must match the EOS character to complete a read operation, or to assert the EOI line
EOIMode	Specify if the EOI line is asserted at the end of a write operation
EOSCharCode	Specify the EOS character
EOSMode	Specify when the EOS character is written or read

GPIB Line Properties
BusManagement Status	Indicate the state of the GPIB bus management lines
HandshakeStatus	Indicate the state of the GPIB handshake lines

VISA-GPIB Properties

VISA-GPIB Address Properties
BoardIndex	Specify the index number of the GPIB board
PrimaryAddress	Specify the primary address of the GPIB instrument
Secondary Address	Specify the secondary address of the GPIB instrument

VISA-GPIB Read/Write Properties
CompareBits	Specify the number of bits that must match the EOS character to complete a read operation, or to assert the EOI line
EOIMode	Specify if the EOI line is asserted at the end of a write operation
EOSCharCode	Specify the EOS character
EOSMode	Specify when the EOS character is written or read

VISA-GPIB General Purpose Properties
RsrcName	Indicate the resource name for a VISA instrument

VISA-VXI Properties

VISA-VXI Address Properties
ChassisIndex	Indicate the index number of the VXI chassis
LogicalAddress	Specify the logical address of the VXI instrument
Slot	Indicate the slot location of the VXI instrument

VISA-VXI Read/Write Properties
CompareBits	Specify the number of bits that must match the EOS character to complete a read operation, or to assert the EOI line
EOIMode	Specify if the EOI line is asserted at the end of a write operation
EOSCharCode	Specify the EOS character
EOSMode	Specify when the EOS character is written or read

VISA-VXI Action Properties
Interrupt Action	Specify the M-file action function to execute when an interrupt event occurs
TriggerAction	Specify the M-file action function to execute when a trigger event occurs

VISA-VXI Register Properties
MappedMemory Base	Indicate the base memory address of the mapped memory
MappedMemory Size	Indicate the size of the mapped memory for low-level read and write operations
MemoryBase	Indicate the base address of the A24 or A32 space
MemorySize	Indicate the size of the memory requested in the A24 or A32 address space
MemorySpace	Define the address space used by the instrument

VISA-VXI Trigger Properties
TriggerLine	Specify the trigger line on the VXI instrument
TriggerType	Specify the trigger type

VISA-VXI General Purpose Properties
RsrcName	Indicate the resource name for a VISA instrument

VISA-GPIB-VXI Properties

VISA-GPIB-VXI Address Properties
BoardIndex	Specify the index number of the GPIB board
ChassisIndex	Indicate the index number of the VXI chassis
LogicalAddress	Specify the logical address of the VXI instrument
PrimaryAddress	Specify the primary address of the GPIB instrument
Secondary Address	Specify the secondary address of the GPIB instrument
Slot	Indicate the slot location of the VXI instrument

VISA-GPIB-VXI Read/Write Properties
CompareBits	Specify the number of bits that must match the EOS character to complete a read operation, or to assert the EOI line
EOIMode	Specify if the EOI line is asserted at the end of a write operation
EOSCharCode	Specify the EOS character
EOSMode	Specify when the EOS character is written or read

VISA-GPIB-VXI Register Properties
MappedMemory Base	Indicate the base memory address of the mapped memory
MappedMemory Size	Indicate the size of the mapped memory for low-level read and write operations
MemoryBase	Indicate the base address of the A24 or A32 space
MemorySize	Indicate the size of the memory requested in the A24 or A32 address space
MemorySpace	Define the address space used by the instrument

VISA-GPIB-VXI General Purpose Properties
RsrcName	Indicate the resource name for a VISA instrument

VISA-Serial Properties

VISA-Serial Communication Properties
BaudRate	Specify the rate at which bits are transmitted
DataBits	Specify the number of data bits to transmit
Parity	Specify the type of parity checking
StopBits	Specify the number of bits used to indicate the end of a byte
Terminator	Specify the terminator character

VISA-Serial Read Properties
ReadAsyncMode	Specify whether an asynchronous read operation is continuous or manual

VISA-Serial Control Pin Properties
DataTerminal Ready	Specify the state of the DTR pin
FlowControl	Specify the data flow control method to use
PinStatus	Indicate the state of the CD, CTS, DSR, and RI pins
RequestToSend	Indicate the state of the RTS pin

VISA-Serial General Purpose Properties
Port	Specify the platform-specific serial port name
RsrcName	Indicate the resource name for a VISA instrument

Serial Port Properties

Serial Port Communication Properties
BaudRate	Specify the rate at which bits are transmitted
DataBits	Specify the number of data bits to transmit
Parity	Specify the type of parity checking
StopBits	Specify the number of bits used to indicate the end of a byte
Terminator	Specify the terminator character

Serial Port Read Properties
ReadAsyncMode	Specify whether an asynchronous read operation is continuous or manual

Serial Port Action Properties
BreakInterrupt Action	Specify the M-file action function to execute when a break-interrupt event occurs
PinStatus Action	Specify the M-file action function to execute when the CD, CTS, DSR, or RI pins change state

Serial Port Control Pin Properties
DataTerminal Ready	Specify the state of the DTR pin
FlowControl	Specify the data flow control method to use
PinStatus	Indicate the state of the CD, CTS, DSR, and RI pins
RequestToSend	Indicate the state of the RTS pin

Serial Port General Purpose Properties
Port	Specify the platform-specific serial port name

Properties Grouped by Category

Alphabetical List of Properties