instrument-control

Low level I/O functions for serial, i2c, spi, parallel, tcp, gpib, vxi11, udp and usbtmc interfaces.

Select category:

Common Functions

flushinput
Flush the instruments input buffers
flushoutput
Flush the instruments output buffers
readbinblock
read a binblock of data from a instrument device
readline
read data from a instrument device excluding terminator value
writebinblock
Write a IEEE 488.2 binblock of data to a instrument device
writeline
Write data to a instrument device including terminator value
writeread
write a ASCII command and read data from a instrument device.

General

instrhelp
Display instrument help
instrhwinfo
Query available hardware for instrument-control
resolvehost
Resolve a network host name or address to network name and address

GPIB

clrdevice
Send clear command to Clear GPIB instrument.
gpib
Open gpib interface.
gpib_read
Read from gpib interface.
gpib_write
Write data to a gpib interface.
gpib_timeout
Set new or get existing gpib interface timeout parameter.
gpib_close
Close the interface and release a file descriptor.
spoll
Serial polls GPIB instruments.
trigger
Triggers GPIB instrument.
@octave_gpib/fclose
Closes connection to GPIB device OBJ
@octave_gpib/fopen
Opens connection to GPIB device OBJ This currently is a dummy function to improve compatibility to MATLAB
@octave_gpib/fprintf
Writes string CMD to GPIB instrument
@octave_gpib/fread
Reads DATA from GPIB instrument
@octave_gpib/fscanf
Reads data RES from GPIB instrument
@octave_gpib/fwrite
Writes DATA to GPIB instrument

I2C

i2c
Open i2c interface.
i2c_addr
Set new or get existing i2c slave device address.
i2c_close
Close the interface and release a file descriptor.
i2c_read
Read from i2c slave device.
i2c_write
Write data to a i2c slave device.
@octave_i2c/fclose
Closes I2C connection OBJ
@octave_i2c/fopen
Opens I2C connection OBJ
@octave_i2c/fread
Reads DATA from I2C instrument
@octave_i2c/fwrite
Writes DATA to I2C instrument
@octave_i2c/get
Get the properties of i2c object.
@octave_i2c/set
Set the properties of i2c object.

Modbus

modbus
Open modbus interface using a specified transport of ’tcpip’ or ’serialrtu’.
@octave_modbus/get
Get the properties of modbus object.
@octave_modbus/maskWrite
Read holding register at ADDRESS from modbus device DEV apply masking and write the change data.
@octave_modbus/read
Read data from modbus device DEV target TARGET starting at address ADDRESS.
@octave_modbus/set
Set the properties of modbus object.
@octave_modbus/write
Write data DATA to modbus device DEV target TARGET starting at address ADDRESS.
@octave_modbus/writeRead
Write data VALUES to the modbus device DEV holding registers starting at address WRITEADDRESS and then read READCOUNT register values starting at address READADDRESS.

Parallel

parallel
Open Parallel interface.
pp_close
Close the interface and release a file descriptor.
pp_ctrl
Sets or Read the Control lines.
pp_data
Sets or Read the Data lines.
pp_datadir
Controls the Data line drivers.
pp_stat
Reads the Status lines.
@octave_parallel/fclose
Closes parallel connection OBJ
@octave_parallel/fopen
Opens parallel interface OBJ
@octave_parallel/fread
Reads DATA from parallel instrument
@octave_parallel/fwrite
Writes DATA to parallel instrument

Serial (Deprecated)

serial
Open serial interface.
seriallist
Returns a list of all serial ports detected in the system.
srl_read
Read from serial interface.
srl_write
Write data to a serial interface.
@octave_serial/fopen
Opens SERIAL interface OBJ
@octave_serial/fclose
Closes SERIAL connection OBJ
@octave_serial/flushinput
Flush the pending input, which will also make the BytesAvailable property be 0.
@octave_serial/flushoutput
Flush the output buffer.
@octave_serial/fprintf
Writes formatted string TEMPLATE using optional parameters to serial instrument
@octave_serial/fread
Reads DATA from serial instrument
@octave_serial/fwrite
Writes DATA to serial instrument
@octave_serial/get
Get the properties of serial object.
@octave_serial/serialbreak
Send a break to the serial port
@octave_serial/set
Set the properties of serial object.
@octave_serial/srl_baudrate
Set new or get existing serial interface baudrate parameter.
@octave_serial/srl_bytesize
Set new or get existing serial interface byte size parameter.
@octave_serial/srl_close
Close the interface and release a file descriptor.
@octave_serial/srl_flush
Flush the pending input/output.
@octave_serial/srl_parity
Set new or get existing serial interface parity parameter.
@octave_serial/srl_stopbits
Set new or get existing serial interface stop bits parameter.
@octave_serial/srl_timeout
Set new or get existing serial interface timeout parameter used for srl_read() requests.

Serial Port

serialport
Open serial port interface.
serialportlist
Returns a list of all serial ports detected in the system.
@octave_serialport/configureTerminator
Set terminator for ASCII string manipulation
@octave_serialport/flush
Flush the serial port buffers
@octave_serialport/fprintf
Writes formatted string TEMPLATE using optional parameters to serialport instrument
@octave_serialport/fread
Reads DATA from serial port instrument
@octave_serialport/fwrite
Writes DATA to serial port instrument
@octave_serialport/get
Get the properties of serialport object.
@octave_serialport/getpinstatus
Get status of serial pins
@octave_serialport/read
Read a specified number of values from a serialport using optional precision for valuesize.
@octave_serialport/serialbreak
Send a break to the serial port
@octave_serialport/set
Set the properties of serialport object.
@octave_serialport/setDTR
Set the state of the DTR line
@octave_serialport/setRTS
Set the state of the RTS line
@octave_serialport/write
Writes DATA to serialport instrument

SPI

spi
Open a spi interface.
spi_close
Close the interface and release a file descriptor.
spi_read
Read from spi slave device.
spi_write
Write data to a spi slave device.
spi_writeAndRead
Write data to a spi slave device and then read same number of values.
@octave_spi/fclose
Closes SPI connection OBJ
@octave_spi/fopen
Opens SPI connection OBJ
@octave_spi/fread
Reads DATA from a SPI instrument
@octave_spi/fwrite
Writes DATA to SPI instrument
@octave_spi/get
Get the properties of spi object.
@octave_spi/read
Reads DATA from SPI instrument
@octave_spi/set
Set the properties of spi object.
@octave_spi/write
Writes DATA to SPI instrument
@octave_spi/writeAndRead
Writes and reads DATA from SPI instrument

TCP (Deprecated)

tcp
Open tcp interface.
tcp_close
Close the interface and release a file descriptor.
tcp_read
Read from tcp interface.
tcp_write
Write data to a tcp interface.
tcp_timeout
Set new or get existing tcp interface timeout parameter used for tcp_read() requests.
tcpip
Matlab compatible wrapper to the tcp interface.
@octave_tcp/fclose
Closes TCP connection OBJ
@octave_tcp/flush
Flush the tcp socket buffers
@octave_tcp/flushinput
Flush the pending input, which will also make the BytesAvailable property be 0.
@octave_tcp/flushoutput
Flush the output buffer.
@octave_tcp/fopen
Opens TCP connection OBJ
@octave_tcp/fprintf
Writes formatted string TEMPLATE using optional parameters to TCP instrument
@octave_tcp/fread
Reads DATA from TCP instrument
@octave_tcp/fwrite
Writes DATA to TCP instrument
@octave_tcp/get
Get the properties of tcp object.
@octave_tcp/read
Reads DATA from TCP instrument
@octave_tcp/set
Set the properties of tcp object.
@octave_tcp/write
Writes DATA to TCP instrument

TCP Client

tcpclient
Open tcpclient interface.
@octave_tcpclient/configureTerminator
Set terminator on a tcpclient object for ASCII string manipulation
@octave_tcpclient/flush
Flush the tcpclient socket buffers
@octave_tcpclient/get
Get the properties of tcpclient object.
@octave_tcpclient/read
Reads DATA from TCP instrument
@octave_tcpclient/set
Set the properties of tcpclient object.
@octave_tcpclient/write
Writes DATA to TCP instrument

TCP Server

tcpserver
Open tcpserver interface.
@octave_tcpserver/configureTerminator
Set terminator on a tcpserver object for ASCII string manipulation
@octave_tcpserver/flush
Flush the tcpserver socket buffers
@octave_tcpserver/get
Get the properties of tcpserver object.
@octave_tcpserver/read
Reads DATA from TCP instrument
@octave_tcpserver/set
Set the properties of tcpserver object.
@octave_tcpserver/write
Writes DATA to TCP instrument

UDP (Deprecated)

udp
Open udp interface.
udp_close
Close the interface and release a file descriptor.
udp_demo
Run test SNTP demonstration for udp class
udp_read
Read from udp interface.
udp_timeout
Set new or get existing udp interface timeout parameter used for udp_read() requests.
udp_write
Write data to a udp interface.
@octave_udp/fclose
Closes UDP connection OBJ
@octave_udp/flush
Flush the udp socket buffers
@octave_udp/flushinput
Flush the pending input, which will also make the BytesAvailable property be 0.
@octave_udp/flushoutput
Flush the output buffer.
@octave_udp/fopen
Opens UDP connection OBJ This currently is a dummy function to improve compatibility to MATLAB
@octave_udp/fprintf
Writes formatted string TEMPLATE using optional parameters to UDP instrument
@octave_udp/fread
Reads DATA from UDP instrument
@octave_udp/fwrite
Writes DATA to UDP instrument
@octave_udp/get
Get the properties of udp object.
@octave_udp/read
Reads DATA from UDP instrument
@octave_udp/set
Set the properties of udp object.
@octave_udp/write
Writes DATA to UDP instrument

UDP Port

udpport
Open udpport interface.
@octave_udpport/configureMulticast
Configure udpport device to receive multicast data
@octave_udpport/configureTerminator
Set terminator for ASCII string manipulation
@octave_udpport/flush
Flush the udpport socket buffers
@octave_udpport/fread
Reads DATA from UDP instrument
@octave_udpport/fwrite
Writes DATA to UDP instrument
@octave_udpport/fprintf
Writes formatted string TEMPLATE using optional parameters to UDP instrument
@octave_udpport/get
Get the properties of udpport object.
@octave_udpport/read
Reads DATA from UDP instrument
@octave_udpport/set
Set the properties of udpport object.
@octave_udpport/write
Writes DATA to UDP instrument
@octave_udpport/writeline
Write data to a udpport including terminator value

USBTMC

usbtmc
Open usbtmc interface.
usbtmc_read
Read from usbtmc slave device.
usbtmc_write
Write data to a usbtmc slave device.
usbtmc_close
Close the interface and release a file descriptor.
@octave_usbtmc/fclose
Closes USBTMC connection OBJ
@octave_usbtmc/fopen
Opens USBTMC connection OBJ This currently is a dummy function to improve compatibility to MATLAB
@octave_usbtmc/fread
Reads DATA from usbtmc instrument
@octave_usbtmc/fwrite
Writes DATA to an usbtmc instrument

VXI11

vxi11
Open vxi11 interface.
vxi11_close
Close the interface and release a file descriptor.
vxi11_read
Read from vxi11 slave device.
vxi11_write
Write data to a vxi11 slave device.
@octave_vxi11/fclose
Closes VXI11 connection OBJ
@octave_vxi11/fopen
Opens VXI11 connection OBJ This currently is a dummy function to improve compatibility to MATLAB
@octave_vxi11/fread
Reads DATA from vxi11 instrument
@octave_vxi11/fwrite
Writes DATA to vxi11 instrument

Package: instrument-control