Getting Help

On this page…
instrhelp Function propinfo Function instrsupport Function Online Support

instrhelp Function

You can use the instrhelp function to:

• Display command-line help for functions and properties.

• List all the functions and properties associated with a specific instrument object.

An instrument object is not only for you to obtain this information. For example, to display all functions and properties associated with a GPIB object, as well as the constructor help, type:

instrhelp gpib

To display help for the EOIMode property, type:

instrhelp EOIMode

You can also display help for an existing instrument object. For example, to display help for the MemorySpace property associated with a VISA-GPIB-VXI object, type:

v = visa('agilent','GPIB-VXI0::80::INSTR');
out = instrhelp(v,'MemorySpace');

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

Back to Top

propinfo Function

You can use the propinfo function to return the characteristics of the Instrument Control Toolbox properties. For example, you can find the default value for any property using this function. propinfo returns a structure containing the following fields:

Field Name	Description
Type	The property data type. Possible values are any, ASCII value, callback, double, string, and struct.
Constraint	The type of constraint on the property value. Possible values are ASCII value, bounded, callback, enum, and none.
ConstraintValue	The property value constraint. The constraint can be a range of values or a list of string values.
DefaultValue	The property default value.
ReadOnly	The condition under which a property is read only. Possible values are always, never, whileOpen, and whileRecording.
InterfaceSpecific	If the property is interface-specific, a 1 is returned. If the property is supported for all interfaces, a 0 is returned.

For example, to display the property characteristics for the EOIMode property associated with the GPIB object g,

g = gpib('ni',0,2);
EOIinfo = propinfo(g,'EOIMode')

EOIinfo = 
                 Type: 'string'
           Constraint: 'enum'
      ConstraintValue: {2x1 cell}
         DefaultValue: 'on'
             ReadOnly: 'never'
    InterfaceSpecific: 1

This information tells you the following:

• The property value data type is a string.

• The property value is constrained as an enumerated list of values.

• There are two possible property values.

• The default value is on.

• The property can be configured at any time (it is never read-only).

• The property is not supported for all interfaces.

To display the property value constraints,

EOIinfo.ConstraintValue
ans = 
    'on'
    'off'

Back to Top

instrsupport Function

Execute this function to get diagnostic information for all installed hardware adaptors on your system. The information is stored in a text file, instrsupport.txt in your current folder and you can use this information to troubleshoot issues.

Back to Top

Online Support

For online support of Instrument Control Toolbox software, visit the Web site http://www.mathworks.com/support/product/IC/. This site includes documentation, examples, solutions, downloads, system requirements, and contact information.

Back to Top

General Preferences for Instrument Control

Examples

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