instrhelp

(To be removed) Help for instrument object type, function, or property

This function that uses serial, Bluetooth, tcpip, udp, visa, gpib, or i2c will be removed in a future release. Use serialport, bluetooth, tcpclient, tcpserver, udpport, visadev, aardvark/device, or ni845x/device instead. For more information on updating your code, see Version History.

Syntax

instrhelp instrhelp('name') out = instrhelp('name') instrhelp(obj) instrhelp(obj,'name') out = instrhelp(obj,'name')

Arguments

`'``name``'`	A function name, property name, or instrument object type.
`obj`	An instrument object.
`out`	The help text.

Description

instrhelp returns a complete listing of toolbox functions, with a brief description of each.

instrhelp('name') returns help for the function, property, or instrument object type specified by name.

You can return specific instrument object information by specifying name in the form object/function or object.property. For example, to return the help for a serial port object's fprintf function, name would be serial/fprintf. To return the help for a serial port object's Parity property, name would be serial.parity.

out = instrhelp('name') returns the help text to out.

instrhelp(obj) returns a complete listing of functions and properties for obj, with a brief description of each. Help for the constructor is also returned.

instrhelp(obj,'name') returns help for the function or property specified by name associated with obj.

out = instrhelp(obj,'name') returns the help text to out.

Examples

The following commands illustrate some of the ways you can get function and property help without creating an instrument object:

instrhelp gpib

out = instrhelp('gpib.m');

instrhelp set

instrhelp EOSCharCode

instrhelp('gpib.eoscharcode')

The following commands illustrate some of the ways you can get function and property help for an existing instrument object:

g = gpib('ni',0,1);

instrhelp(g)

instrhelp(g,'EOSMode');

out = instrhelp(g,'trigger')

Tips

When returning property help, the names in the See Also section that contain all uppercase letters are function names. The names that contain a mixture of upper and lowercase letters are property names. When returning function help, the See Also section contains only function names.

You can also display help via the Workspace browser by right-clicking an instrument object, and selecting Instrument Help from the context menu.

Version History

Introduced before R2006a

expand all

R2024b: Warns

Updates to icdevice will result in the future removal of the following functions.

To accommodate the transition, the icdevice function now has a new name-value argument called LegacyMode.

LegacyMode=true (default) creates an icdevice object using the legacy mode, consistent with past releases. In this mode, these properties and functions continue to operate.
LegacyMode=false creates an icdevice object in the new mode. Use of the mentioned properties and functions might generate warnings or errors. You cannot combine this mode with name-value arguments for any of the properties being removed. This option is required when combining usage with icdevicefind.

Functionality	Use This Instead	Additional Information
`instrfind`	`icdevicefind`	To use replacement, call `icdevice` with name-value argument `LegacyMode=false`
`instrfindall`	`icdevicefind`	To use replacement, call `icdevice` with name-value argument `LegacyMode=false`

It is recommended that you update your code to use the new icdevice mode as soon as possible.

R2022b: Warns

This function returns a warning that it will be removed in a future release.

This function is used by the serial, Bluetooth, tcpip, udp, visa, gpib and i2c interfaces. These interfaces will also be removed in a future release, as previously announced. Use the following interfaces instead.

Functionality	Use This Instead	Additional Information
`serial`	`serialport`	Transition Your Code to serialport Interface
`Bluetooth`	`bluetooth` (case-sensitive)	Transition Your Code to bluetooth Interface
`tcpip`	`tcpclient`	Transition Your Code to tcpclient Interface
`tcpip`	`tcpserver`	Transition Your Code to tcpserver Interface
`udp`	`udpport`	Transition Your Code to udpport Interface
`visa`	`visadev`	Transition Your Code to visadev Interface
`gpib`	VISA-GPIB interface with `visadev`	Transition Your Code to VISA-GPIB Interface
`i2c`	`device` function with `aardvark` or `ni845x` object	Transition Your Code to aardvark or ni845x Interface

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

R2022a: To be removed

This function runs without warning but will be removed in a future release.