rfsiggen

Connection to Quick-Control RF Signal Generator instrument

Description

The Quick-Control RF Signal Generator can be used for any RF signal generator that uses an underlying IVI-C driver. You can also use it for an NI™ Vector Signal Transceiver (VST) or Vector Signal Generator (VSG) that uses the NI-RFSG driver. You do not have to directly deal with the underlying drivers.

For information on the prerequisites for using rfsiggen, see Quick-Control RF Signal Generator Requirements.

Creation

Syntax

rf = rfsiggen

rf = rfsiggen(resource)

rf = rfsiggen(resource,driver)

Description

rf = rfsiggen creates the RF signal generator object rf to communicate with an RF signal generator instrument. You must specify a resource or a resource and driver later.

rf = rfsiggen(resource) additionally specifies the resource, and connects it to the RF signal generator instrument designated by the resource. This is the VISA resource string for the instrument.

rf = rfsiggen(resource,driver) additionally specifies the driver, which is the underlying driver to use with the instrument. If it is not specified, the driver is auto-detected.

Input Arguments

resource — VISA resource string for your instrument

string

VISA resource string for your instrument, specified as a string. Set this before connecting to the instrument. Setting it during object creation is optional and can be used if you know the resource string for your instrument. Otherwise, you can set it after object creation.

Example: rf = rfsiggen('TCPIP0::172.28.22.99::inst0::INSTR')

Data Types: char | string

driver — Underlying driver to use with the instrument

string

Underlying driver to use with the instrument, specified as a string. Set this before connecting to the instrument. If it is not specified, the driver is auto-detected.

Example: rf = rfsiggen('TCPIP0::172.28.22.99::inst0::INSTR','AgRFSigGen')

Data Types: char | string

Properties

Instrument Settings

Frequency — Frequency of generated signal

numeric

This property is read-only.

Frequency of the generated RF output signal, specified as a number in Hz.

Data Types: double

PowerLevel — Amplitude of generated signal

0 (default) | numeric

This property is read-only.

Amplitude (power/level) of the RF output signal, specified as a number in dBm.

Data Types: double

OutputEnabled — Whether signal is enabled

true or 1 | false or 0

This property is read-only.

Whether the RF output signal is enabled or disabled, specified as a numeric or logical 1 (true) or 0 (false).

Data Types: logical

IQEnabled — Whether IQ modulation is enabled

true or 1 | false or 0

This property is read-only.

Whether IQ (vector) modulation of the RF output signal is enabled or disabled, specified as a numeric or logical 1 (true) or 0 (false).

Data Types: logical

IQSource — Source of signal for signal modulation

character vector

This property is read-only.

Source of the signal that the signal generator uses for IQ modulation, specified as a character vector.

Data Types: char | string

IQSwapEnabled — Whether inverse phase rotation is enabled

true or 1 | false or 0

This property is read-only.

Whether the inverse phase rotation of the IQ signal by swapping the I and Q inputs is enabled or disabled, specified as a numeric or logical 1 (true) or 0 (false).

Data Types: logical

ArbGenerator Settings

ClockFrequency — Sample frequency

numeric

This property is read-only.

Sample frequency, specified as a number in Hz.

Data Types: double

ArbTriggerSource — Trigger source for ARB waveform

character vector

This property is read-only.

Trigger source for the ARB waveform, specified as a character vector.

Data Types: char | string

ArbSelectedWaveform — Selected waveform

character vector

This property is read-only.

Selected waveform from the pool of available waveforms, specified as a character vector.

Data Types: char | string

Communication Properties

Status — Communication status

'open' (default) | 'closed'

This property is read-only.

Communication status, specified as 'open' or 'closed'.

Data Types: char | string

Resource — RF signal generator identifier

character vector

RF signal generator identifier, specified as a character vector.

Data Types: char | string

DriverDetectionMode — Driver configuration

'auto' (default) | 'manual'

Driver configuration, specified as 'auto' or 'manual'. If set to 'auto', you do not have to set a driver name before connecting to an instrument. If set to 'manual', a driver name must be provided before connecting.

Data Types: char | string

Driver — RF signal generator driver

character vector

RF signal generator driver, specified as a character vector. Use only if DriverDetectionMode is set to 'manual'. Use it to give driver name. Only use if driver name cannot be figured out programmatically.

Data Types: char | string

Object Functions

Use these object functions with any Quick-Control interface.

drivers	List of available instrument drivers for Quick-Control interfaces
resources	List of available instrument resources for Quick-Control interfaces
connect	Connect device object to instrument
disconnect	Disconnect device object from instrument

Use these object functions with Quick-Control RF signal generators.

download	Downloads arbitrary waveform to RF signal generator
start	Enables RF signal generator signal output and modulation output

Examples

Create RF Signal Generator Object

You can create the rfsiggen object without setting the resource, and then set it after object creation.

Create the RF Signal Generator object with no arguments.

rf = rfsiggen()

Find available resources using the resources function.

targets = resources(rf)

It returns a list of possible VISA resource strings, for example TCPIP0::172.28.22.99::inst0::INSTR.

Set the RF signal generator resource using the Resource property.

rf.Resource = 'TCPIP0::172.28.22.99::inst0::INSTR';

Connect to the instrument. When you assign the resource after object creation, you need to explicitly connect to the instrument.

connect(rf);

Create RF Signal Generator Object and Set Resource and Driver

You can create the rfsiggen object and set the resource and driver during object creation. If those properties are valid, the object automatically connects to the instrument.

Create the RF signal generator object and connect using the specified resource string and driver.

rf = rfsiggen('TCPIP0::172.28.22.99::inst0::INSTR','AgRfSigGen')

Version History

Introduced in R2017b