SCPI

Description: Send SCPI commands to any instrument
Library: Obsolete (not to be discontinued), Instruments
Class: SDFSCPI
Derived From: SDFInstrument
C++ Code: See doc/sp_items/SDFSCPI.html under your installation directory

Parameters

Name	Description	Default	Type
Interface	local/remote GPIB interface	lan[141.121.237.75]:gpib3	string
Address	address of instrument on GPIB bus	1	int
BeginCommands	Commands to send at simulation begin		string
WrapupCommands	Commands to send at simulation wrapup		string
SendIDCommand	send SCPI "*IDN" command to instrument (select NO for non-SCPI instrument): NO, YES	YES	enum

Notes/Equations

Note This component is obsolete for new designs. The component is available only for compatibility with designs created with ADS 1.3 or earlier. There are no plans to remove this component from future ADS releases; however, enhancements or fixes of any existing defects will not be made. A newer Connection Manager-based replacement component is available: CM\_SCPI. Please use the CM-based replacement components in your ADS designs; these components offer the following distinct advantages: supported on all ADS platforms; interactive instrument selection; industry standard drivers; support direct LAN instruments.

1. The SCPI model sends arbitrary commands to an instrument at the beginning and end of simulation. This model can be used for configuration of an instrument beyond what ADS Ptolemy models provide.
2. Prerequisites for using the SCPI model are:
   • Any instrument that understands commands in ASCII text format; for example, SCPI- compliant instruments.
   • Supported method of connecting the instrument to your computer.
   • Configured SICL interface. SICL (Standard Instrument Control Library) is part of Agilent IO libraries.
     Download and install the latest version of the IO libraries from the website http://www.agilent.com/find/iolib.
     A list of GPIB interfaces supported by SICL as well as installation and configuration steps are provided in the GPIB Interfaces section of the Instrument Server manual.
3. Commands sent to the instrument are echoed to the status server for confirmation. Enclose variable names inside your commands with curly braces. For example, if you have a variable F signifying the frequency, setting BeginCommands to :FREQ
   Unknown macro: {F}
   Hz sets the instrument frequency.
4. The Interface parameter specifies the IO interface to be used to connect to the instrument. This parameter is set according to whether you are connecting via a GPIB card or a GPIB/LAN gateway.
   If using a local GPIB interface like a GPIB card, set the Interface parameter to the SICL interface name, for example, gpib0 .
   If using a remote GPIB interface like a GPIB/LAN gateway, set the Interface parameter in this format:
   lan[<hostname>]:<sicl-name>, where
   <hostname> is the DNS hostname or IP address and
   <sicl-name> is the remote SICL interface name of the GPIB/LAN gateway.

   Note This component does not support direct LAN instruments.

5. The Address parameter identifies the instrument on a GPIB bus. Set the Address parameter to the address of the instrument on the GPIB bus.
6. The SendIDCommand parameter provides the flexibility to use the SCPI component to send commands to instruments that are not SCPI compliant. SendIDCommand = YES by default, which causes the SCPI identification command *IDN? to be transmitted during initialization. Set SendIDCommand to NO when used with non-SCPI instruments.
7. Refer to the appropriate instrument documentation for commands that correspond to the settings you want. Use semicolons to separate multiple commands. If you send a query command (one containing a question mark), the model reads the result and displays the result in the status server. A read operation on the bus is performed only for those query commands that end with ?.