External Device Commands

Configures and makes settings for an external device.

SYSTem:CONFigure:EDEVice:

Click on a red keyword to view the command details.

See Also

Learn about: Configure an External Source
Learn about: Configure a PMAR Device
Example: Configure an External Source
Example: Configure a PMAR Device
SYST:PREF:ITEM:EDEV:DPOL - Determines whether external devices remain activated or are de-activated when the VNA is Preset or when a Instrument State is recalled.
Synchronizing the Analyzer and Controller
SCPI Command Tree

SYSTem:CONFigure:EDEVice:ADD <name>

Applicable Models: All (Write-only) Adds an external device to the list of configured devices. This is the same as pressing New on the Select an external device dialog. Upon creation, all settings on the new device are set to the defaults. The device is not active until set using SYST:CONF:EDEV:STAT
Parameters
<name>	String - Model and type of the external device. To see a list of configured external devices, use SYST:CONF:EDEV:CAT?
Examples	SYST:CONF:EDEV:ADD "myDevice" system:configure:edevice:add "myDevice"
Query Syntax	Not Applicable
Default	Not Applicable

SYSTem:CONFigure:EDEVice:CAT?

Applicable Models: All (Read-only) Returns a list of names of all configured devices. These are devices that appear in the external devices dialog. Use SENS:FOM:CAT? to report all active devices. Use Source:CAT? to report all active sources.
Parameters	None
Example	SYST:CONF:EDEV:CAT? system:configure:edevice:cat
Return Type	String of comma-separated devices. "Device0:Driver0, Device1:Driver1"
Default	Not applicable

SYSTem:CONFigure:EDEVice:DRIVer <name>,<value>

Applicable Models: All (Read-Write) Sets and returns the external device driver (model).
Parameters
<name>	String - Name of the device.
<value>	String - External device driver (model). Choose from the following: "AGPM" for all power meters. "AGPULSEGEN" for supported pulse generators. "DCSource" for all supported DC Sources "DCMeter" for all supported DC Meters See a list of supported external source drivers.
Examples	SYST:CONF:EDEV:DRIV "myDevice","AGPM" system:configure:edevice:driver "myDevice","AGESG"
Query Syntax	SYSTem:CONFigure:EDEVice:DRIVer? <name>
Return Type	String
Default	"AGGeneric"

SYSTem:CONFigure:EDEVice:DTYPe <name>,<type>

Applicable Models: All (Read-Write) Sets and returns the Device Type for the external device.
Parameters
<name>	String - Name of the device to modify.
<type>	String - Device type - not case sensitive. Choose from: "None" "Source" - external source "Power Meter" - power meter "DC Meter" - DC voltmeter "DC Source" - DC power supply "Pulse Generator" - external pulse generator "SMU" - Source Measure Unit
Examples	SYST:CONF:EDEV:DTYP "myDevice","Power Meter" system:configure:edevice:dtype "myDevice","Source"
Query Syntax	SYSTem:CONFigure:EDEVice:DTYPe? <name>
Return Type	String
Default	Source

SYSTem:CONFigure:EDEVice:EXISts? <string>

Applicable Models: All (Read-only) Returns whether the named device is present on the bus for which it is configured.
Parameters
<string>	Name of the external device.
Example	SYST:CONF:EDEV:EXIS? "MyPowerMeter"
Return Type	Boolean 0 - The device is not in the collection or the device fails to respond and times out when communication is attempted. 1 - The device responds when communication is attempted.
Default	Not applicable

SYSTem:CONFigure:EDEVice:IOConfig <name>,<value>

Applicable Models: All (Read-Write) Sets and return the configuration path for the specified external device.
Parameters
<name>	String - Name of the device.
<value>	String - Configuration path. Any valid VISA resource shown in the IO Configuration field of the external devices dialog, enclosed in quotes. Use the SYST:COMM:VISA:RDEV:FIND? command to return IO devices that the visa subsystem can identify. This command will return addresses for devices found on GPIB, USB, or LAN.
Examples	SYST:CONF:EDEV:IOC "myDevice","GPIB0::13::INSTR" SYST:CONF:EDEV:IOC "myDevice","TCPIP0::141.121.148.119::inst0::INSTR" system:configure:edevice:ioconfig "myDevice","USB0::10893::19457::MZ00703073::0::INSTR"
Query Syntax	SYSTem:CONFigure:EDEVice:IOConfig? <name>
Return Type	String
Default	"" Empty String

SYSTem:CONFigure:EDEVice:IOENable <name>,<value>

Applicable Models: All (Read-Write) Enable or disable communication with an external device. When disabled (OFF), the VNA will NOT attempt to connect to the external device regardless of the instrument state command (SYST:CONF:EDEV:STATe). Therefore, no errors will be produced if the device is not connected. This command is useful for debugging and testing states when the external device is not connected. This command is unnecessary in ordinary operation (when the device is connected).
Parameters
<name>	String - Name of the device.
<value>	Boolean - Choose from: OFF or 0 - Device communication disabled ON or 1 - Device communication enabled
Examples	SYST:CONF:EDEV:IOEN "myDevice", ON system:configure:edevice:ioenable "myDevice", 0
Query Syntax	SYSTem:CONFigure:EDEVice:IOENable? <name>
Return Type	Boolean
Default	ON

SYSTem:CONFigure:EDEVice:LOAD <file>,<name>

Applicable Models: All (Write-only) Recalls an external device configuration file from the VNA hard drive. Currently, only DC Supply and DC Meter configuration files are supported. See more DC Device commands. Use SYST:CONF:EDEV:SAVE to save a configuration file.
Parameters
<file>	String - Filename of the external device configuration file. If <file> is not a full path, it is assumed to be a relative path based at "D:\Drivers". The file specified using <file> cannot be the same file as "D:\Drivers\<name>.xml".
<name>	String - Name of the external device. Currently, only DC Supply and DC Meter configuration files are supported.
Examples	SYST:CONF:EDEV:LOAD "D:\Drivers\MyConfigFile.xml","MyDevice"
Query Syntax	Not Applicable
Default	Not Applicable

SYSTem:CONFigure:EDEVice:REMove <name>

Applicable Models: All (Write-only) Removes the specified device from the list of configured devices. If the device is a Source and both Active and I/O Enabled is checked (ON), then the RF power state is set to OFF. Learn more.
Parameters
<name>	String - Name of the device. Not case sensitive. Use SYST:CONF:EDEV:CAT? to return a list of configured devices.
Examples	SYST:CONF:EDEV:REM "myDevice" system:configure:edevice:remove "myDevice"
Query Syntax	Not Applicable
Default	Not Applicable

SYSTem:CONFigure:EDEVice:SAVE <file>,<name>

Applicable Models: All (Write-only) Saves an external device configuration file to the VNA hard drive. Currently, only DC Supply and DC Meter configuration files are supported. See more DC Device commands. Use SYST:CONF:EDEV:LOAD to recall a configuration file.
Parameters
<file>	String - Filename of the external device configuration file.
<name>	String - Name of the external device. Currently, only DC Supply and DC Meter configuration files are supported.
Examples	SYST:CONF:EDEV:SAVE "myDevice.xml","MyDCSupply"
Query Syntax	Not Applicable
Default	Not Applicable

SYSTem:CONFigure:EDEVice:STATe <name>,<state>

Applicable Models: All (Read-Write) Set and return the state of activation of the device. When SYST:CONF:EDEV:IOEN = ON, and this command is set to ON, the VNA will attempt communication with the external device. Send this command AFTER sending other external device settings (especially SYST:CONF:EDEV:DTYP) to avoid communicating with the device before it has been fully configured. See Also: SYST:PREF:ITEM:EDEV:DPOL - Determines whether external devices remain activated or are de-activated when the VNA is Preset or when a Instrument State is recalled.
Parameters
<name>	String - Name of the device.
<state>	Boolean - Choose from: OFF or 0 - Device is NOT activated ON or 1 - Device is activated.
Examples	SYST:CONF:EDEV:STAT "myDevice", ON system:configure:edevice:state "myDevice", 0
Query Syntax	SYSTem:CONFigure:EDEVice:STATe? <name>
Return Type	Boolean
Default	OFF - When configured using the front panel user interface, the device is ON (activated) by default.

SYSTem:CONFigure:EDEVice:TOUT <name>,<value>

Applicable Models: All (Read-Write) Set and return the time out value for the specified external device. This is the time allowed for communication with the device before an error is generated.
Parameters
<name>	String - Name of the device.
<value>	Time out value in seconds.
Examples	SYST:CONF:EDEV:TOUT "myDevice",2 system:configure:edevice:tout "myDevice",5
Query Syntax	SYSTem:CONFigure:EDEVice:TOUT? <name>
Return Type	Numeric
Default	20

SYSTem:CONFigure:EDEVice:SOURce:DPPoint <name>,<value>

Applicable Models: All (Read-Write) Sets and returns the amount of time the VNA should wait after for an external source to settle before making a measurement at each data point. This setting applies to all channels that use this external source.
Parameters
<name>	String - Name of the device.
<value>	Dwell time in seconds.
Examples	SYST:CONF:EDEV:SOUR:DPP "myDevice",2 system:configure:edevice:source:dppoint "myDevice",.1
Query Syntax	SYSTem:CONFigure:EDEVice:SOURce:DPP? <name>
Return Type	Numeric
Default	3.114 e-3

SYSTem:CONFigure:EDEVice:SOURce:HYBRid:GAIN:NOMinal <value>

Applicable Models: All (Read-Write) This is the nominal gain of the SSB mixer system. The nominal gain value is used to set the input source power in order to get the desired output source power. The user may choose to add an amplifier to the hybrid source to get more output power. Note that if the input multiplier is set to some value other than 1, then the concept of amplification not very clear. In this case, we will assume that the gain represents the gain from the input power limit value to the resulting output power.
Parameters
<value>	Gain in dB. Range is -200 to 100
Examples	SYST:CONF:EDEV:SOUR:HYBR:GAIN:NOM 10
Query Syntax	SYSTem:CONFigure:EDEVice:SOURce:HYBRid:NOMinal? <value>
Return Type	Numeric
Default	0 dB

SYSTem:CONFigure:EDEVice:SOURce:HYBRid:INPut:FREQuency:CARRier <value>

Applicable Models: All (Read-Write) For an SSB Mixer, the center of the input modulated signal is offset from DC by the carrier frequency. The Hybrid Source will adjust the LO Source to set the frequency of the output. In some cases, the Input Carrier frequency must be adjusted by a slight amount so that the input mixed with the LO results in the desired output. This entry is labeled as being "Nominal" because the value may be changed by the Hybrid Source.
Parameters
<value>	Carrier in Hz. Range is 0 to 10 GHz.
Examples	SYST:CONF:EDEV:SOUR:HYBRid:INPut:FREQuency:CARRier 100000000
Query Syntax	SYSTem:CONFigure:EDEVice:SOURce:HYBRid:INPut:FREQuency:CARRier? <value>
Return Type	Numeric
Default	0 Hz

SYSTem:CONFigure:EDEVice:SOURce:HYBRid:INPut:FREQuency:MULTiplier <value>

Applicable Models: All (Read-Write) If there is a multiplier placed between the Input Source and the SSB mixer, then use this command to specify the multiplication factor.
Parameters
<value>	Muliplier. Range is 1 to 999.
Examples	SYST:CONF:EDEV:SOUR:HYBR:INP:FREQ:MULT 10
Query Syntax	SYSTem:CONFigure:EDEVice:SOURce:HYBRid:INPut:FREQuency:MULTiplier? <value>
Return Type	Numeric
Default	1

SYSTem:CONFigure:EDEVice:SOURce:HYBRid:INPut:NAME <name>

Applicable Models: All (Read-Write) Select external or internal sources for the input source.
Parameters
<name>	String - Name of the input source.
Examples	SYST:CONF:EDEV:SOUR:HYBR:INP:NAME "Port1"
Query Syntax	SYSTem:CONFigure:EDEVice:SOURce:HYBRid:INPut:NAME? <name>
Return Type	String
Default	None

SYSTem:CONFigure:EDEVice:SOURce:HYBRid:INPut:POWer:LIMit <value>

Applicable Models: All (Read-Write) This is the maximum power setting allowed for the Input Source. The system will adjust the output power of the Hybrid Source by changing the power level of the Input Source and correcting for the Nominal Gain. This limit ensures that the Input Source is not set to a power level that will damage the SSB mixer.
Parameters
<value>	Power Limit in dBm. Range is -200 to 100.
Examples	SYST:CONF:EDEV:SOUR:HYBR:INP:POW:LIM 10
Query Syntax	SYSTem:CONFigure:EDEVice:SOURce:HYBRid:INPut:POWer:LIMit? <value>
Return Type	Numeric
Default	0

SYSTem:CONFigure:EDEVice:SOURce:HYBRid:LO:FREQuency:MULTiplier <value>

Applicable Models: All (Read-Write) If there is a multiplier placed between the LO Source and the SSB mixer, then use this command to specify the multiplication factor.
Parameters
<value>	Muliplier. Range is 1 to 999.
Examples	SYST:CONF:EDEV:SOUR:HYBR:LO:FREQ:MULT 10
Query Syntax	SYSTem:CONFigure:EDEVice:SOURce:HYBRid:LO:FREQuency:MULTiplier? <value>
Return Type	Numeric
Default	1

SYSTem:CONFigure:EDEVice:SOURce:HYBRid:LO:NAME <name>

Applicable Models: All (Read-Write) Select external or internal sources for the LO source.
Parameters
<name>	String - Name of the LO source.
Examples	SYST:CONF:EDEV:SOUR:HYBR:LO:NAME "Port1"
Query Syntax	SYSTem:CONFigure:EDEVice:SOURce:HYBRid:LO:NAME? <name>
Return Type	String
Default	None

SYSTem:CONFigure:EDEVice:SOURce:HYBRid:LO:POWer <value>

Applicable Models: All (Read-Write) Sets and returns the amount of time the VNA should wait after for an external source to settle before making a measurement at each data point. This setting applies to all channels that use this external source.
Parameters
<value>	LO Power in dBm. Range is -200 to 100.
Examples	SYST:CONF:EDEV:SOUR:HYBR:LO:POW 10
Query Syntax	SYSTem:CONFigure:EDEVice:SOURce:HYBRid:LO:POWer? <value>
Return Type	Numeric
Default	0

SYSTem:CONFigure:EDEVice:SOURce:HYBRid:TYPE <name>

Applicable Models: All (Read-Write) Currently provides two selections: SSB Mixer (default) and Multiplier. The External Device dialog changes appearance and available settings according to the Hybrid Type you select.
Parameters
<name>	String - Name of the Hybrid Type.
Examples	SYST:CONF:EDEV:SOUR:HYBR:TYPE "Multiplier"
Query Syntax	SYSTem:CONFigure:EDEVice:SOURce:HYBRid:TYPE? <name>
Return Type	String
Default	SSB Mixer

SYSTem:CONFigure:EDEVice:SOURce:MODulation:CONTrol:STATe <name>,<state>

Applicable Models: All (Read-Write) Sets and reads the state of the modulation control. Modulation control must be ON to control the modulation of an external source.
Parameters
<name>	String - Name of the device.
<state>	ON (or 1) Enable control of external modulation. OFF (or 0) Disable control of external modulation. Learn about these settings and about adding an external source.
Examples	SYST:CONF:EDEV:SOUR:MOD:CONT:STAT "qasmxg",1 system:configure:edevice:source:modulation:control:state "qasmxg",OFF
Query Syntax	SYSTem:CONFigure:EDEVice:SOURce:MODulation:CONTrol:STATe? "qasmxg"
Default	OFF

SYSTem:CONFigure:EDEVice:SOURce:TMODe <name>,<value>

Applicable Models: All (Read-Write) Sets and returns the trigger mode for an external source. Learn more.
Parameters
<name>	String - Name of the device.
<value>	Trigger Mode. Choose from: CW - Software CW mode HW - Hardware list mode
Examples	SYST:CONF:EDEV:SOUR:TMOD "myDevice",CW system:configure:edevice:source:tmode "myDevice",hw
Query Syntax	SYSTem:CONFigure:EDEVice:SOURce:TMODe? "myDevice"
Return Type	Character
Default	Depends on Source and VNA Model

SYSTem:CONFigure:EDEVice:SOURce:TPORt <name>,<value>

Applicable Models: All (Read-Write) Sets and returns the VNA port through which an external source is to be triggered.
Parameters
<name>	String - Name of the device.
<value>	Trigger Port. Choose from aux1 or aux2
Examples	system:configure:edevice:source:tport "myDevice",aux1
Query Syntax	SYSTem:CONFigure:EDEVice:SOURce:TPORt? <name>
Return Type	Character
Default	aux1