RSM Class

Vision™ MX280001A Spectrum Monitoring Application Programming Interface : Vision API Reference : RSM Class

RSM Class

The RSM Class provides a easy means for controlling a remote spectrum monitor. The properties and methods of this class map directly to the SCPI commands described in the instrument Programming Manual.

Since the properties and methods act directly on a remote spectrum monitor, you must first set the URL property before using other properties and methods.

Properties

RSM.AntennaPort Property

Gets or sets the active antenna port of multi-channel remote spectrum monitors such as MS27103A.

Public Property AntennaPort() As Integer

public int AntennaPort {get; set;}

C++

public int AntennaPort {get; set;}

RSM.Attenuation Property

Gets or sets the attenuation value of the remote spectrum monitor.

Public Property Attenuation() As String

public string Attenuation {get; set;}

C++

public string Attenuation {get; set;}

RSM.AudioMute Property

This property controls whether or not audio is output through the system speaker (default audio device) when doing AM.FM streaming.

Public ReadOnly Property AudioMute() As Boolean

public bool AudioMute {get;}

C++

public bool AudioMute {get;}

Remarks

Returns True if audio output is muted; False if audio output will be played.

RSM.AverageCount Property

Gets or sets the average count for use in calculating the average display value.

Public Property AverageCount() As Integer

public int AverageCount {get; set;}

C++

public int AverageCount {get; set;}

RSM.BWRatio Property

The ratio of VBW to RBW when VBW is in auto mode.

Public Property BWRatio() As String

public string BWRatio {get; set;}

C++

public string BWRatio {get; set;}

RSM.CenterFrequency Property

Gets or sets the center frequency of the active remote spectrum monitor.

Public Property CenterFrequency() As String

public string CenterFrequency {get; set;}

C++

public string CenterFrequency {get; set;}

Property Value

Type: String. Units are expected. If no units are provided, Hz is assumed.

Remarks

Setting the Center Frequency does not change the span, but does change both the start and stop frequencies. Allowed units are 'Hz', 'kHz', 'MHz' and 'GHz'. The Vision API verifies that the value is positive but does not verify the upper range, as this can vary across the support products. If the value is not valid, nothing is set. Reading back the value is the best way to verify success.

RSM.ChannelPower Property

Returns the Channel Power calculated for the most recent trace acquired from the active remote spectrum monitor.

Public ReadOnly Property ChannelPower() As String

public string ChannelPower {get;}

C++

public string ChannelPower {get;}

RSM.ConnectionOK Property

Gets a value indicating whether Vision API has an active connection to a remote spectrum monitor.

Public ReadOnly Property ConnectionOK() As Boolean

public bool ConnectionOK {get;}

C++

public bool ConnectionOK {get;}

Property Value

true if yes; otherwise, false.

Remarks

The return value indicates if the connection is valid and active. When true, this means the connection is useful, not that it is busy.

RSM.Detection Property

Gets or sets the detection method for calculating each display point.

Public Property Detection() As String

public string Detection {get; set;}

C++

public string Detection {get; set;}

Remarks

Each display point represents several measurements. The detection type determines how the display point is derived from its associated measurements.

RSM.DisplayPoints Property

Gets or sets the number of display points the remote spectrum monitor currently measures.

Public Property DisplayPoints() As Integer

public int DisplayPoints {get; set;}

C++

public int DisplayPoints {get; set;}

Remarks

Increasing the number of display points can improve the resolution of measurements but will also increase the sweep time.

RSM.FormatFrequency Property

Formats the frequency value as appropriate for display set in Parameters.

Public ReadOnly Property FormatFrequency(ByVal Freq As Double,ByVal Digits As Integer) As String

[System.Runtime.CompilerServices.IndexerName("FormatFrequency")]
public string this[double Freq,int Digits] {get;}

C++

[System.Runtime.CompilerServices.IndexerName("FormatFrequency")]
public string this[double Freq,int Digits] {get;}

Parameters

Freq: Frequency value in Hz.

Digits: Number of digits to display after the decimal.

RSM.FrequencySpan Property

Gets or sets the Frequency Span of the active remote spectrum monitor.

Public Property FrequencySpan() As String

public string FrequencySpan {get; set;}

C++

public string FrequencySpan {get; set;}

Property Value

Type: String. Units are expected. If no units are provided, then 'Hz' is assumed.

Remarks

Setting the Frequency Span changes the start and stop frequencies, but does not change the center frequency. The value must be positive.

RSM.FrequencyValue Property

Converts a formatted frequency value to a integer value in Hertz.

Public ReadOnly Property FrequencyValue(ByVal Freq As String) As Long

[System.Runtime.CompilerServices.IndexerName("FrequencyValue")]
public long this[string Freq] {get;}

C++

[System.Runtime.CompilerServices.IndexerName("FrequencyValue")]
public long this[string Freq] {get;}

Parameters

Freq: A string value including units. Units are not case-sensitive. Expected units are Hz, kHz, MHz, and GHz.

RSM.GPS Property

Obtains the latitude and longitude coordinates of the remote spectrum monitors.

Public ReadOnly Property GPS() As String

public string GPS {get;}

C++

public string GPS {get;}

RSM.GPSDisplay Property

Gets or sets a parameter that determines how GPS coordinates are displayed.

Public Property GPSDisplay() As GPSDisplayMode

public GPSDisplayMode GPSDisplay {get; set;}

C++

public GPSDisplayMode GPSDisplay {get; set;}

Property Value

Either GPSDisplayMode.GPS_Decimal or GPSDisplayMode.GPS_DMS

Remarks

Sets whether GPS coordinates are displayed as decimal numbers, or with degree-minute-second format. This is not a setting on the remote spectrum monitor. It affects the Vision API behavior only.

RSM.IQBandwidth Property

Gets or sets the I/Q capture bandwidth.

Public Property IQBandwidth() As String

public string IQBandwidth {get; set;}

C++

public string IQBandwidth {get; set;}

Property Value

Type: String. The value is expected to carry units (kHz or MHz). If no units are included, Hz is assumed.

The allowed values are limited to a redefined set. These are: 13.3 kHz, 26.7 kHz, 66.7 kHz, 133 kHz, 267 kHz, 667 kHz, 1.33 MHz, 2.67 MHz, 6.67 MHz, 13.3 MHz and 20 MHz. If you try to set a different value, the next higher value is chosen. So if you try to set it to 200 kHz, you will get 267 kHz.

Remarks

Setting the bandwidth also sets the sample rate. Higher bandwidths use higher sample rates.

You can refer to the UG for the remote spectrum monitor for the exact correlation to bandwidth and sample rates. Generally, the sample rate is about equal to the bandwidth. For example, a bandwidth of 133 kHz has a sample rate of 150,000 I/Q samples/second. A bandwidth of 20 MHz has a sample rate of about 25,000,000 sample per second. So increasing the sample rate greatly increases the number of bytes that have to be transfered and stored when doing an I/Q capture. Consequently, the capture length can be constrained by the bandwidth. At lower capture bandwidths you can do 10 second captures. At higher bandwidths this is not possible. At 20 MHz, 2 seconds is the longest allowed capture length.

RSM.IQBitDepth Property

Gets or sets the I/Q capture bit resolution.

Public Property IQBitDepth() As BitDepth

public BitDepth IQBitDepth {get; set;}

C++

public BitDepth IQBitDepth {get; set;}

Property Value

Type: Vision.RSM.BitDepth

Allowed values are: Vision.RSM.BitDepth.Eight, Vision.RSM.BitDepth.Ten, Vision.RSM.BitDepth.Sixteen, Vision.RSM.BitDepth.TwentyFour

Remarks

Setting the bit depth affects several aspects of the I/Q capture process.

First, the higher the bit resolution, the larger the capture size in bytes. When compared to an 8 bit capture, a 24 bit capture takes 3 times as long to download from the probe, and also occupies 3 times as much disk space. The remote probes have a fixed amount of memory for storing I/Q capture data, so higher resolution may affect available capture lengths.

Second, a higher bit resolution greatly increases the integrity of the captured signal. An 8 bit capture usually is insufficient for a useful capture. If the reference level is not set near to the peak level of the signal being captured, then the effective resolution is lower, as several of the higher bits will never be used. It isn't unusual in an 8 bit capture to only use 4 bits for the actual data because of where the reference level is set. When this is plotted, the I/Q pairs will form a series of columns and rows on the plot showing the very low resolution of the actual data capture. In most cases, 16 bit is the best trade-off between data integrity and size/speed considerations.

When doing TDOA, one of the bits in each sample is used to carry timing information. For 10 and 24 bit depths, there are extra bits available and the resolution is not affected. For 8 and 16 bit depths, turning on the time stamping effectively lowers the resolution by one bit.

RSM.IQCaptureLength Property

Gets or sets the time length of an I/Q capture. Input is in milliseconds

Public Property IQCaptureLength() As Integer

public int IQCaptureLength {get; set;}

C++

public int IQCaptureLength {get; set;}

Property Value

Type: Integer. The number of milliseconds to capture.

Remarks

Capture length is directly proportional to capture size. The allowed length is constrained to some degree by both the bit solution and by the capture bandwidth.

RSM.IQ_I Property

Gets the I values following an I/Q capture.

Public ReadOnly Property IQ_I() As Integer()

public int[] IQ_I {get;}

C++

public int[] IQ_I {get;}

Property Value

Type: Integer

Remarks

Following a successful I/Q capture, use IQ_I to return a reference to the integer array hold the I values. Use IQ_I.Count to get the number of samples. Use IQ_I.Clone to make a deep copy.

RSM.IQ_Plot Property

Returns a bitmap of the IQ values plotted with I on the horizontal axis and Q on the vertical. This must follow a call to IQCapture.

Public ReadOnly Property IQ_Plot(ByVal Width As Integer,ByVal Height As Integer) As Bitmap

[System.Runtime.CompilerServices.IndexerName("IQ_Plot")]
public Bitmap this[int Width,int Height] {get;}

C++

[System.Runtime.CompilerServices.IndexerName("IQ_Plot")]
public Bitmap this[int Width,int Height] {get;}

Parameters

Width: The width of the resultant bitmap.

Height: The height of the resultant bitmap.

Property Value

Type: Bitmap

Remarks

Typically, you will define a target, such as s picture box or panel that you want to assign the bitmap to, using either the Image property or the BackgroundImage property of the target control. Then you can use PictureBox.Image = Probe.IQPlot().

Since the IQPlot method returns a reference to a standard Windows Bitmap, you can use it anyplace in code where you might use a bitmap reference. To save directly to file, you can use the Save property of the Bitmap object. For example, Probe.IQPlot().Save(Filename, Filetype).

Calling IQPlot must follow a call to IQCapture.

RSM.IQ_Q Property

Gets the Q values following an I/Q capture.

Public ReadOnly Property IQ_Q() As Integer()

public int[] IQ_Q {get;}

C++

public int[] IQ_Q {get;}

Remarks

Following a successful I/Q capture, use IQ_Q to return a reference to the integer array hold the Q values. Use IQ_Q.Count to get the numbe of samples.

Use IQ_Q.Clone to make a deep copy.

RSM.MeasurementStatus Property

Use this property to get the status of FM Deviation or AM Modulation measurements.

Public ReadOnly Property MeasurementStatus() As Boolean

public bool MeasurementStatus {get;}

C++

public bool MeasurementStatus {get;}

Remarks

Returns True if either FM Deviation or AM Modulation Index measurements are in progress; False otherwise.

RSM.OBW Property

Returns the Occupied Bandwidth for the most recent trace acquired from the active remote spectrum monitor.

Public ReadOnly Property OBW() As String

public string OBW {get;}

C++

public string OBW {get;}

RSM.OBWPercent Property

Gets or sets the percentage of carrier power used to measure the occupied bandwidth.

Public Property OBWPercent() As Integer

public int OBWPercent {get; set;}

C++

public int OBWPercent {get; set;}

RSM.Options Property

Options are returned as a string of 3 digit numbers, separated by a forward slash character (“\”).

Public ReadOnly Property Options() As String

public string Options {get;}

C++

public string Options {get;}

Remarks

Returns installed options on the indicated RSM.

RSM.Preamp Property

Gets and sets the Preamp On/Off.

Public Property Preamp() As Integer

public int Preamp {get; set;}

C++

public int Preamp {get; set;}

RSM.ProductID Property

Gets the assembly name and version number for the Vision API dll assembly.

Public ReadOnly Property ProductID() As String

public string ProductID {get;}

C++

public string ProductID {get;}

Property Value

Type: String.

Remarks

Used this property to verify the version number of the installed Vision files.

RSM.RBW Property

Gets or sets the Resolution Bandwidth for the active remote spectrum monitor.

Public Property RBW() As String

public string RBW {get; set;}

C++

public string RBW {get; set;}

Property Value

Type: String

Remarks

RBW values are restricted to a predefined set. Allowed values are: 3 Hz, 10 Hz, 30 Hz, 100 Hz, 300 Hz, 1 kHz, 3 kHz, 10 kHz, 30 kHz, 100 kHz, 300 kHz, 1 MHz, 3 MHz.

RSM.RBWAuto Property

Gets or sets the Auto RBW state of the remote spectrum monitor

Public Property RBWAuto() As String

public string RBWAuto {get; set;}

C++

public string RBWAuto {get; set;}

Property Value

Type: String

Remarks

The return value is either 'On' or 'Off'. Use these same string values for setting the state.

RSM.RBWRatio Property

Gets or sets the RBW ratio.

Public Property RBWRatio() As String

public string RBWRatio {get; set;}

C++

public string RBWRatio {get; set;}

RSM.ReferenceLevel Property

Gets or sets the reference level amplitude value.

Public Property ReferenceLevel() As String

public string ReferenceLevel {get; set;}

C++

public string ReferenceLevel {get; set;}

Remarks

This value is the display reference level, which means it has the reference level offset applied. It also means that a change to the reference level offset will change this setting (though the actual, unadjusted reference level will stay the same).

RSM.ReferenceLevelOffset Property

Gets or sets the reference level offset value for the y-axis.

Public Property ReferenceLevelOffset() As String

public string ReferenceLevelOffset {get; set;}

C++

public string ReferenceLevelOffset {get; set;}

Remarks

This offset is used for display purposes only, and does not affect the actual reference level used for auto attenuation coupling, or any other settings that depend on reference level.

RSM.StartFrequency Property

Gets or sets the start frequency for the active remote spectrum monitor.

Public Property StartFrequency() As String

public string StartFrequency {get; set;}

C++

public string StartFrequency {get; set;}

Property Value

Type: String. Units are expected. If no units are provided, 'Hz' is assumed.

Remarks

Setting the Start Frequency also changes the span and center frequency. It does not change the stop frequency. Frequency inputs are ranged checked to be positive, but no upper range is verified as the frequency range varies across supported products.Remarkse best way to verify the setting is to read back the value.

RSM.StopFrequency Property

Gets or sets the Stop Frequency of the active remote spectrum monitor.

Public Property StopFrequency() As String

public string StopFrequency {get; set;}

C++

public string StopFrequency {get; set;}

Property Value

Type: String. Units are expected. If no units are provided, 'Hz' is assumed.

Remarks

Setting the Stop Frequency also changes the span and center frequency. It does not change the start frequency. Frequency inputs are ranged checked to be positive, but no upper range is verified as the frequency range varies across supported products. The best way to verify the setting is to read back the value.

RSM.Streaming Property (Read Only)

AM/FM streaming is a continuous process that once started, continues until it is either stopped by the RSM.StopStreaming() method or by a change in sweep parameters on the RSM. To determine if the RSM is still streaming audio, check this property.

Public Property Streaming() As Boolean

public bool Streaming {get; set;}

C++

public bool Streaming {get; set;}

Remarks

True is AM or FM audio is currently streaming; False otherwise.

RSM.SweepMode Property

Gets or sets the type of sweep mode for active remote spectrum monitor. Modes are Single Trace, All Traces, Min Hold Trace, Max Hold Trace, and Average Trace.

Public Property SweepMode() As String

public string SweepMode {get; set;}

C++

public string SweepMode {get; set;}

RSM.Sweeping Property

Checks the status of Sweeping.

Public Property Sweeping() As Boolean

public bool Sweeping {get; set;}

C++

public bool Sweeping {get; set;}

RSM.Trace Property

Gets the trace of the remote spectrum monitor.

Public ReadOnly Property Trace() As String

public string Trace {get;}

C++

public string Trace {get;}

RSM.TraceMode Property

Gets or sets the type of sweep mode for active remote spectrum monitor. Modes are Normal Trace, Rolling Min, Rolling Averaging, Rolling Max, and Trace Count.

Public Property TraceMode() As String

public string TraceMode {get; set;}

C++

public string TraceMode {get; set;}

RSM.URL Property

Gets or sets the URL of the desired remote spectrum monitor.

Public Property URL() As String

public string URL {get; set;}

C++

public string URL {get; set;}

Property Value

Type: String. Default value is null reference (Nothing in Visual Basic)

Remarks

This property must be set before other methods and property can be used in any meaningful way.

The URL can be an IP address (xxx.xxx.xxx.xxx) or a host name registered with a domain name server. It is the same name for the probe that would be used if accessing the probe via the web browser interface.

RSM.Units Property

Gets or sets the units of the desired measurement type.

Public Property Units() As String

public string Units {get; set;}

C++

public string Units {get; set;}

RSM.VBW Property

Gets or sets video bandwidth of the active remote spectrum monitor.

Public Property VBW() As String

public string VBW {get; set;}

C++

public string VBW {get; set;}

RSM.VBWAuto Property

Gets or sets the Auto VBW state of the remote spectrum monitor.

Public Property VBWAuto() As String

public string VBWAuto {get; set;}

C++

public string VBWAuto {get; set;}

Property Value

Type: String.

Remarks

The return value is either 'On' or 'Off'. Use these same string values for setting the state.

RSM.VBWType Property

Gets or sets VBW Tpye for the active remote spectrum monitor.

Public Property VBWType() As String

public string VBWType {get; set;}

C++

public string VBWType {get; set;}

Property Value

Type: String. Either 'Linear' or 'Logarithmic'

RSM.Version Property

Obtains the application version.

Public ReadOnly Property Version() As String

public string Version {get;}

C++

public string Version {get;}

RSM.YScale Property

Gets or sets the number of dBm/division when plotting sweep trace data.

Public Property YScale() As Integer

public int YScale {get; set;}

C++

public int YScale {get; set;}

Remarks

This value is not sent to the remote spectrum monitor and does not affect its display. The Vision API generates its own trace graphs from trace data downloaded from the remote probe. This value is internal only. Valid values range from 1 to 20 dBm/Division.

Methods

RSM.AMModulation Method

Sets the frequency of the RSM and an appropriate bandwidth for an AM signal. Measures the AM Modulation for the indicated time, then returns a numeric value indicating the Modulation Index as a percentage.

(ByValue CarrierFrequency as Long, ByVal RunTimeSeconds as Integer)

Input Fields

Public AmModulation(ByVal CarrierFrequency As String,ByVal Integer,ByVal RunTimeSeconds Integer)

public AmModulation(string CarrierFrequency,int RunTimeSeconds,int

C++

public AmModulation(string CarrierFrequency,int RunTimeSeconds,int

Remarks

Input Fields

CarrierFrequency (String): The carrier frequency of the signal to measure. Units are allowed. If units are not included, Hz is assumed.

RunTimeSeconds (Integer): The number of seconds to perform the measurement.

Return Type: SingleReturns the AM modulation index at the set frequency, measured over the set time, as a percentage.

RSM.CaptureIQ Method

Initiates IQ capture on the current probe. When complete, the I/Q sample pairs are available using the IQ_I and IQ_Q properties of the class.

Public Function CaptureIQ() As Boolean

public bool CaptureIQ()

C++

public bool CaptureIQ()

Returns

Type: Boolean. Returns true if the IQ capture is successful; otherwise, returns false.

Remarks

Before using the CaptureIQ method, you must first set the following properties: center frequency, reference level, IQBitDepth, IQBandwidth, & IQCaptureLength. Failing to do so will produce undefined results, meaning previous or default values may be used. If you are making repeat measurements on the same probe and with the same capture parameters, you do not need to reset them between each call to IQCapture. However, if another remote user accesses the probe, the parameters may change.

On a multi-channel probe, be sure to set the correct antenna channel.

This function may take several seconds to return, depending on the capture length, bit depth and bandwidth, and also on the Internet connection bandwidth. I/Q captures can produce very large result arrays, so the download time will be long on a slow network connection. For instance, a 16 bit capture at 20 MHz for 1 second produces 100 MBytes of data.

RSM.CheckOption Method

Public Function CheckOption(ByVal As String) Return Type As Boolean

public string CheckOption as(bool)

C++

public string CheckOption as(bool)

Return Value 

True if the option is installed; False if it is not installed.

RSM.CreatePlayBackWaveFile

When streaming AM or FM audio, small (~ 3 second) sound chunks are received and stored as .wav files in a temporary folder on your PC. This method combines these files into a single output file and moves it to the location of your choice. The smaller files are deleted from the temporary folder.

There is a program named Lame.exe that is included in the application folder. If this program is present, then it is used to convert the .wav output into mp3 format. The .wav files are uncompressed audio, and take up a lot of space. The mp3 files are much more compact. If you intended to capture a lot of audio, you will want to use the compressed format.

CreatePlayBackWaveFile(string Filename)

C++

CreatePlayBackWaveFile(string Filename)

RSM.DeleteFile Method

Deletes the file set in parameters.

Public Function DeleteFile(ByVal RemoteFilename As String) As Boolean

public bool DeleteFile(string RemoteFilename)

C++

public bool DeleteFile(string RemoteFilename)

Parameters

RemoteFilename: Fully qualified path name. Network paths must be mapped to a drive letter.

RSM.DisplayStoredTrace Method

Returns a bitmap image plotting the trace data in the requested file on the remote spectrum monitor.

Public Function DisplayStoredTrace(ByVal RemoteFilename As String,ByVal Width As Integer,ByVal Height As Integer) As Bitmap

public Bitmap DisplayStoredTrace(string RemoteFilename,int Width,int Height)

C++

public Bitmap DisplayStoredTrace(string RemoteFilename,int Width,int Height)

Parameters

RemoteFilename: Filename of an RSM file on a remote spectrum monitor.

Width: Desired width, in pixels, of the resultant bitmap.

Height: Desired height, in pixels, of the resultant bitmap.

RSM.DownloadFile Method

Downloads a file into the database set by parameters.

Public Function DownloadFile(ByVal RemoteFilename As String,ByVal LocalPath As String) As Boolean

public bool DownloadFile(string RemoteFilename,string LocalPath)

C++

public bool DownloadFile(string RemoteFilename,string LocalPath)

Parameters

RemoteFilename: Filename of an RSM file on a remote spectrum monitor.

LocalPath: It is the local directory path where you want the remote file to be stored.

RSM.GetFiles Method

Returns the list of files in the Remote Folder.

Public Function GetFiles(ByVal RemoteFolder As String) As String()

public string[] GetFiles(string RemoteFolder)

C++

public string[] GetFiles(string RemoteFolder)

Parameters

RemoteFolder: Folder on the RSM. This folder is expected to exist and contain 1 or more measurement files (*.RSM).

RSM.GetFolders Method

Returns the list of folders in Remote Folder.

Public Function GetFolders(ByVal RemoteFolder As String) As String()

public string[] GetFolders(string RemoteFolder)

C++

public string[] GetFolders(string RemoteFolder)

Parameters

RemoteFolder: Folder on the RSM. This folder is expected to exist. The return will be a list of sub-folders to the folder provided.

RSM.NewFolder Method

If true, enter a new folder as set by Parameters.

Public Function NewFolder(ByVal RemoteFolder As String) As Boolean

public bool NewFolder(string RemoteFolder)

C++

public bool NewFolder(string RemoteFolder)

Parameters

RemoteFolder: Folder on the RSM. This folder is expected to exist and a new sub-folder will be created within.

RSM.PlayIQ_AM Method

This attempts to do AM demodulation of the current I/Q capture data and play it on the system speaker.

Public Sub PlayIQ_AM()

public System.Void PlayIQ_AM()

C++

public System.Void PlayIQ_AM()

Remarks

This can produce decent output if you have captured an AM signal, with appropriate depth and bandwidth. For best results, set the reference level within 10 dB of the signal peak height.

RSM.PlayIQ_FM Method

This attempts to do an FM demodulation of the current I/Q capture data and play it on the system speaker.

Public Sub PlayIQ_FM()

public System.Void PlayIQ_FM()

C++

public System.Void PlayIQ_FM()

Remarks

This can produce decent output if you have captured an FM signal, with appropriate depth and bandwidth. Wide-band FM typically works best with 267 khz capture bandwidth at 16 bit resolution. You can capture upto 5 seconds of audio with these parameters. For narrow-band FM, you can capture longer. For best results, set the reference level within 10 dB of the signal peak height.

RSM.Preset Method

Presets all traces.

Public Sub Preset()

public System.Void Preset()

C++

public System.Void Preset()

RSM.Reboot Method

Reboots the selected remote spectrum monitor.

Public Sub Reboot()

public System.Void Reboot()

C++

public System.Void Reboot()

RSM.RecallMeasurement Method

Lists all of the measurements in the file set by Parameters.

Public Function RecallMeasurement(ByVal RemoteFilename As String) As Boolean

public bool RecallMeasurement(string RemoteFilename)

C++

public bool RecallMeasurement(string RemoteFilename)

Parameters

RemoteFilename: The name of a measurement file on the remote spectrum analyzer.

RSM.ResetCmdPort Method

Resets the SCPI command port on a remote spectrum monitor

Public Sub ResetCmdPort()

public System.Void ResetCmdPort()

C++

public System.Void ResetCmdPort()

Remarks

Under unusual circumstances, the Ethernet port that receives and processes SCPI commands on the remote probe can get stuck. When this occurs, this API command may remove the obstruction.

RSM.SaveIQ Method

Save I/Q capture data to disk file.

Public Sub SaveIQ(ByVal Filename As String)

public System.Void SaveIQ(string Filename)

C++

public System.Void SaveIQ(string Filename)

Parameters

Filename: Filename where the data is to be saved. This includes full path information. Network paths must be mapped to a drive letter.

Remarks

Existing files will be overwritten. If you want overwrite protection, provide that in the parent application. If you write to a protected folder, or try to overwrite an open file, an error will be returned.

Output format is ASCII. Two columns of integer values (I, Q) tab delimited, with each line ending in carriage return/line feed.

RSM.SaveIQ_AM Method

Save AM demodulated audio to a Windows .wav file for future playback.

Public Sub SaveIQ_AM(ByVal Filename As String)

public System.Void SaveIQ_AM(string Filename)

C++

public System.Void SaveIQ_AM(string Filename)

Parameters

Filename: Fully qualified path name. Network paths must be mapped to a drive letter.

Remarks

An existing file will be overwritten. Overwrite protection must be implemented in the parent application.

RSM.SaveIQ_FM Method

Save FM demodulated audio to a Windows .wav file.

Public Sub SaveIQ_FM(ByVal Filename As String)

public System.Void SaveIQ_FM(string Filename)

C++

public System.Void SaveIQ_FM(string Filename)

Parameters

Filename: Fully qualified path name. Network paths must be mapped to a drive letter.

Remarks

An existing file will be overwritten. Overwrite protection must be implemented in the parent application.

RSM.SaveMeasurement Method

Initiates a save measurement set by parameters.

Public Function SaveMeasurement(ByVal RemoteFilename As String) As Boolean

public bool SaveMeasurement(string RemoteFilename)

C++

public bool SaveMeasurement(string RemoteFilename)

Parameters

RemoteFilename: The filename under which to save the measurement file. A folder can be specified as part of the filename. If a folder is given, that folder is expected to exist.

RSM.SaveSetup Method

Initiates a save configuration setup set by parameters.

Public Function SaveSetup(ByVal RemoteFilename As String) As Boolean

public bool SaveSetup(string RemoteFilename)

C++

public bool SaveSetup(string RemoteFilename)

Parameters

RemoteFilename: The filename under which to save the current instrument setup. A folder can be specified as part of the filename. If a folder is given, that folder is expected to exist.

RSM.SendCommand Method

This method provides a means to send a SCPI command directly to the remote spectrum monitor. Although the properties and methods of this class cover most SCPI commands, there may be occasions where a user wants direct control to send exactly a sequence of Commands, or to send a command that is not mapped in the RSM Class. This method provides a simple interface to send any command detailed in the RSM Programming Manual directly to the RSM.

RSM.SweepGraph Method

Returns an image as a Windows Bitmap with the height and width as specified in the Parameters. This image is the Trace sweep graphed in standard X-Y coordinates.

Public Function SweepGraph(ByVal Width As Integer,ByVal Height As Integer) As Bitmap

public Bitmap SweepGraph(int Width,int Height)

C++

public Bitmap SweepGraph(int Width,int Height)

Parameters

Width: Width of the return bitmap in pixels.

Height: Height of the return bitmap in pixels

RSM.SweepGraph64 Method

Returns an image as a Base64 encoded string of a Windows Bitmap, with the height and width as specified in the Parameters. This image is the Trace sweep graphed in standard X-Y coordinates.

Public Function SweepGraph64(ByVal Width As Integer,ByVal Height As Integer) As String

public string SweepGraph64(int Width,int Height)

C++

public string SweepGraph64(int Width,int Height)

Parameters

Width: Width of the return bitmap in pixels.

Height: Height of the return bitmap in pixels

RSM.TriggerSweep Method

In single sweep mode, triggers a sweep.

Public Sub TriggerSweep()

public System.Void TriggerSweep()

C++

public System.Void TriggerSweep()

Events

OnFrequencyChange Event

Returns a notification that the sweep parameters have changed in the remote spectrum analyzer.

Public Event OnFrequencyChange(ByVal FrequencyArgs As FrequencyParameters)

public event OnFrequencyChangeEventHandler OnFrequencyChange
delegate void OnFrequencyChangeEventHandler(FrequencyParameters FrequencyArgs)

C++

public event OnFrequencyChangeEventHandler OnFrequencyChange
delegate void OnFrequencyChangeEventHandler(FrequencyParameters FrequencyArgs)

Parameters

FrequencyArgs: Start Frequency, Stop Frequency, Center Frequency, and Frequency Span.

Structures

FrequencyParameters Structure

Public Structure FrequencyParameters

public struct FrequencyParameters

C++

public struct FrequencyParameters

Fields

CenterFrequency Field

Gets or sets the center frequency of the active remote spectrum monitor.

Public CenterFrequency As Long

public long CenterFrequency

C++

public long CenterFrequency

Property Value

Type: String. Units are expected. If no units are provided, Hz is assumed.

FrequencySpan Field

Public FrequencySpan As Long

public long FrequencySpan

C++

public long FrequencySpan

StartFrequency Field

The sweep Start Frequency in Hz.

Public StartFrequency As Long

public long StartFrequency

C++

public long StartFrequency

StopFrequency Field

The sweep Stop Frequency in Hz.

Public StopFrequency As Long

public long StopFrequency

C++

public long StopFrequency

Enumerations

BitDepth Enumeration

Designates the number of bits used in I/Q captures. Higher bit resolution increases the size of the download from each target receiver. Lower bit resolution is not appropriate for most purposes; the I/Q plot will look odd, with I/Q values lining up in rows and columns. The best choice for most applications is 16 bits.

Value

BitDepth Values and Definitions
Value	Definition
Eight	8-bits used for each I & Q value.
Ten	10-bits used for each I & Q value.
Sixteen	16-bits used for each I & Q value.
TwentyFour	24-bits used for each I & Q value.

GPSDisplayMode Enumeration

Designates the display format for GPS coordinates.

Value

GPSDisplayMode Values and Definitions
Value	Definition
GPS_Decimal	Sets GPS display format to decimal notation.
GPS_DMS	Sets GPS display format to Degrees-Minutes-Seconds.

Structures

FileHeader Structure

Public Structure FileHeader

public struct FileHeader

C++

public struct FileHeader

Fields

Bandwidth Field

The bandwidth of I/Q Capture.

Public Bandwidth As Double

public double Bandwidth

C++

public double Bandwidth

CaptureLength Field

Time in milliseconds of the I/Q Capture.

Public CaptureLength As Integer

public int CaptureLength

C++

public int CaptureLength

CenterFrequency Field

Gets or sets the center frequency of the active remote spectrum monitor.

Public CenterFrequency As Double

public double CenterFrequency

C++

public double CenterFrequency

Property Value

Type: String. Units are expected. If no units are provided, Hz is assumed.

TimeStamp Field

Sets the date and time.

Public TimeStamp As Date

public DateTime TimeStamp

C++

public DateTime TimeStamp

Version Field

Obtains the application version.

Public Version As Integer

public int Version

C++

public int Version


	Anritsu Company 1-800-ANRITSU 10450-00062, Rev. M