instrhwinfo

Information about available hardware

Syntax

out = instrhwinfo

out = instrhwinfo("spi")

out = instrhwinfo("matlab")

out = instrhwinfo("matlab",drivername)

out = instrhwinfo(obj)

out = instrhwinfo(obj,"FieldName")

Description

out = instrhwinfo returns hardware information to the structure out. This information includes the toolbox version, the MATLAB^® software version, and supported interfaces and drivers.

out = instrhwinfo("spi") returns information related to the SPI interface.

out = instrhwinfo("matlab") returns information related to the MATLAB instrument drivers found on the MATLAB software path.

out = instrhwinfo("matlab",drivername) returns information related to the specified MATLAB instrument driver drivername. The available drivername values are returned by out = instrhwinfo("matlab") .

out = instrhwinfo(obj) returns information on the adaptor and vendor-supplied DLL associated with the VISA or GPIB object obj. If obj is a serial port, TCPIP, or UDP object, then JAR file information is returned. If obj is an array of instrument objects, then out is a 1-by-n cell array of structures where n is the length of obj.

out = instrhwinfo(obj,"FieldName") returns hardware information for the field name specified by FieldName. FieldName can be a single character vector or a cell array of character vectors. out is an m-by-n cell array where m is the length of obj and n is the length of FieldName. You can return the supported values for FieldName using the instrhwinfo(obj) syntax.

Version History

Introduced before R2006a

expand all

R2023a: `i2c` object interface will be removed

Using the input argument i2c with instrhwinfo runs without warning but will be removed in a future release. The i2c function, its object functions, and its properties will also be removed. View a list of available I2C controllers available to connect to using aardvarklist or ni845xlist instead.

Functionality	Use This Instead	Additional Information
`instrhwinfo("i2c")`	`aardvarklist`	Transition Your Code to aardvark or ni845x Interface
`instrhwinfo("i2c")`	`ni845xlist`	Transition Your Code to aardvark or ni845x Interface

R2022b: Not recommended

Using the input arguments ivi and vxipnp with instrhwinfo runs without warning but is not recommended. View installed MATLAB instrument drivers by using ividriverlist or ividevlist instead.

Functionality	Use This Instead
info = instrhwinfo("ivi"); drivers = info.Modules;	info = ividriverlist; drivers = info.VendorDriver(info.IVIClass ~= "VXIPnP");
info = instrhwinfo("vxipnp"); drivers = info.Modules;	info = ividriverlist; drivers = info.VendorDriver(info.IVIClass == "VXIPnP");

Functionality

Use This Instead

info = instrhwinfo("ivi");
drivers = info.Modules;

info = ividriverlist;
drivers = info.VendorDriver(info.IVIClass ~= "VXIPnP");

info = instrhwinfo("vxipnp");
drivers = info.Modules;

info = ividriverlist;
drivers = info.VendorDriver(info.IVIClass == "VXIPnP");

You can also use ividevlist to list physically connected instruments and their drivers.

R2022a: Warns

Using the input arguments serial, serialport, Bluetooth, tcpip, udp, visa, and gpib with instrhwinfo returns a warning that it will be removed in a future release. The interfaces associated with these input arguments will also be removed, as previously announced. Use the following interfaces instead.

Functionality	Use This Instead	Additional Information
`instrhwinfo("serial")`	`serialportlist`	Transition Your Code to serialport Interface
`instrhwinfo("serialport")`	`serialportlist`	Transition Your Code to serialport Interface
`instrhwinfo("Bluetooth")`	`bluetoothlist`	Transition Your Code to bluetooth Interface
`instrhwinfo("tcpip")`	There is no direct replacement.	Transition Your Code to tcpclient Interface
`instrhwinfo("tcpip")`	There is no direct replacement.	Transition Your Code to tcpserver Interface
`instrhwinfo("udp")`	There is no direct replacement.	Transition Your Code to udpport Interface
`instrhwinfo("visa")`	`visadevlist`	Transition Your Code to visadev Interface
`instrhwinfo("gpib")`	`visadevlist`	Transition Your Code to VISA-GPIB Interface

The recommended interfaces have additional capabilities and improved performance. For more information about the recommended interfaces, see Interface-Based Instrument Communication.

R2021b: `gpib` object interface will be removed

Using the input argument gpib with instrhwinfo runs without warning but will be removed in a future release.

R2021a: `visa` and `serial` object interfaces will be removed

Using the input arguments visa and serial with instrhwinfo runs without warning but will be removed in a future release.

R2020b: `Bluetooth`, `tcpip`, and `udp` object interfaces will be removed

Using the input arguments Bluetooth, tcpip, and udp with instrhwinfo runs without warning but will be removed in a future release.