Boonton55xxx IVI Driver Reference

Attributes

Name

Description

BTN55XXX_ATTR_ATTENUATION

Attenuation in dB for the sensor.

BTN55XXX_ATTR_AVERAGE

Set or return the number of traces averaged together to form the measurement result on the selected channel.

BTN55XXX_ATTR_AVERAGING_AUTO_ENABLED

Class-compliant IIviPwrMeter property specifying whether auto-averaging is enabled or disabled for a particular input channel

BTN55XXX_ATTR_AVERAGING_COUNT

Class-compliant IIviPwrMeter property specifying the averaging count. When the Auto Averaging Enabled attribute is set to False, the driver filters the input signal by averaging it the number of times specified by this property

BTN55XXX_ATTR_BANDWIDTH

Set or return the sensor video bandwidth for the selected sensor.

BTN55XXX_ATTR_CACHE

Drivers may choose to always cache some instrument settings, never cache others, and optionally cache others, to avoid unecessary I/O to the instrument. If True, the driver caches optionally cached instrument settings.

BTN55XXX_ATTR_CAL_FACTOR

Set or return the frequency calfactor currently in use on the selected channel.

BTN55XXX_ATTR_CAPTURE

Set/return whether statical capture is enabled.

BTN55XXX_ATTR_CHANNEL_COUNT

Class-compliant IIviPwrMeter property that indicates the number of channels available on the instrument

BTN55XXX_ATTR_CHANNEL_ENABLED

Class-compliant IIviPwrMeter property specifying whether the power meter should take a measurement on a particular input channel. The power meter will take a measurement on a channel only if that channel is enabled

BTN55XXX_ATTR_CHANNEL_UNITS

Set or return units for the selected channel. Voltage is calculated with reference to the sensor input impedance. Note that for ratiometric results, logarithmic units will always return dBr (dB relative) while linear units return percent.

BTN55XXX_ATTR_CORRECTION_FREQUENCY

Class-compliant IIviPwrMeter property specifying the frequency of the input signal in Hertz. The instrument uses this value to determine the appropriate correction factor for the sensor

BTN55XXX_ATTR_CURRENT_TEMP

Return current sensor internal temperature in degrees C

BTN55XXX_ATTR_DELAY

Set or return the trigger delay time in seconds with respect to the trigger for the trigger display location in the LEFT position. Positive values cause the actual trigger to occur after the trigger condition is met. This places the trigger event to the left of the trigger point on the display, and is useful for viewing events during a pulse, some fixed delay time after the rising edge trigger. Negative trigger delay places the trigger event to the right of the trigger point on the display, and is useful for looking at events before the trigger edge.

BTN55XXX_ATTR_DISTAL

Set or return the pulse amplitude percentage, which is used to define the end of a rising edge or beginning of a falling edge transition.

BTN55XXX_ATTR_DRIVER_SETUP

The driver setup string. It is either specified in the Configuration Store or passed in the OptionString parameter of the Initialize function. Driver setup is empty if the driver is not initialized.

BTN55XXX_ATTR_DURATION

Set/get the duration samples are captured during each timed mode acquisiton.

BTN55XXX_ATTR_DUTY_CYCLE_CORRECTION

Class-compliant IIviPwrMeter property specifying the duty cycle correction the power meter uses to calculate the pulse power of a pulse-modulated signal. The value of this attribute is specified as a percentage

BTN55XXX_ATTR_DUTY_CYCLE_CORRECTION_ENABLED

Class-compliant IIviPwrMeter property specifying whether duty cycle correction is enabled on a particular channel

BTN55XXX_ATTR_ENABLED

Set or return the measurement state of the selected channel. When the value is true, the channel performs measurements; when the value is false, the channel is disabled and no measurements are performed.

BTN55XXX_ATTR_END_DELAY

Set/get delay time added to the detected end of a burst for analysis. Typically negative. Typically used to exclude the falling edge of a burst.

BTN55XXX_ATTR_END_GATE

Set or return the point on a pulse, which is used to define the end of the pulse?s active interval.

BTN55XXX_ATTR_END_QUAL

Set/get the minimum amount of time power remains below the trigger point to be counted as the end of a burst.

BTN55XXX_ATTR_EXTERNAL_SKEW

Adjusts the skew for the external trigger.

BTN55XXX_ATTR_FACTORY_CAL_DATE

The date the last time the sensor was calibrated at the factory.

BTN55XXX_ATTR_FETCH_LATENCY

The maximum amount of latency a fetch measurement may have. This setting adjusts how often automatic measurements and marker measurements are recalculated.

BTN55XXX_ATTR_FILTER_STATE

Set or return the current setting of the integration filter on the selected channel.

BTN55XXX_ATTR_FILTER_TIME

Set or return the current length of the integration filter on the selected channel.

BTN55XXX_ATTR_FIRMWARE_VERSION

Returns the firmware version of the power meter associated with this channel.

BTN55XXX_ATTR_FPGA_VERSION

Returns the FPGA version for the power meter associated with this channel.

BTN55XXX_ATTR_FREQUENCY

Set or return the RF frequency for the current sensor, and apply the appropriate frequency calfactor from the sensor?s EEPROM table.

BTN55XXX_ATTR_GATE_MODE

Each Buffer Entry is controlled by a "buffer gate" that defines the start and end of the entry time interval. The gate signal may be internally or externally generated in several different ways.

BTN55XXX_ATTR_GATING

Set/return whether the statical capture is gated by markers or free-running.

BTN55XXX_ATTR_GROUP_CAPABILITIES

A comma-separated list of the class capability groups implemented by the driver. Capability group names are documented in the IVI class specifications. If the driver is not class compliant, the driver returns an empty string.

BTN55XXX_ATTR_HOLDOFF

Set or return the trigger holdoff time in seconds. Trigger holdoff is used to disable the trigger for a specified amount of time after each trigger event. The holdoff time starts immediately after each valid trigger edge, and will not permit any new triggers until the time has expired. When the holdoff time is up, the trigger re-arms, and the next valid trigger event (edge) will cause a new sweep. This feature is used to help synchronize the power meter with burst waveforms such as a TDMA or GSM frame. The trigger holdoff resolution is 10 nanoseconds, and it should be set to a time that is just slightly shorter than the frame repetition interval.

BTN55XXX_ATTR_HOLDOFF_MODE

Sets the holdoff mode to normal or gap holdoff.

BTN55XXX_ATTR_HORIZONTAL_OFFSET

Set or return the statistical mode horizontal scale offset in dB. The offset value will appear at the leftmost edge of the scale with units dBr (decibels relative).

BTN55XXX_ATTR_HORIZONTAL_SCALE

Set or return the statistical mode horizontal scale in dB/Div.

BTN55XXX_ATTR_IMPEDANCE

Input impedence of the sensor.

BTN55XXX_ATTR_INITIATE_CONTINUOUS

Set or return the data acquisition mode for single or free-run measurements. If INITiate:CONTinuous is set to ON, the instrument immediately begins taking measurements (Modulated, CW and Statistical Modes), or arms its trigger and takes a measurement each time a trigger occurs (Pulse Mode). If set to OFF, the measurement will begin (or be armed) as soon as the INITiate command is issued, and will stop once the measurement criteria (averaging, filtering or sample count) has been satisfied. Note that INITiate:IMMediate and READ commands are invalid when INITiate:CONTinuous is set to ON; however, by convention this situation does not result in a SCPI error.

BTN55XXX_ATTR_INSTRUMENT_FIRMWARE_REVISION

The firmware revision reported by the physical instrument. If Simulation is enabled or the instrument is not capable of reporting the firmware revision, a string is returned that explains the condition.

BTN55XXX_ATTR_INSTRUMENT_MANUFACTURER

The name of the manufacturer reported by the physical instrument. If Simulation is enabled or the instrument is not capable of reporting the name of the manufacturer, a string is returned that explains the condition. Manufacturer is limited to 256 bytes

BTN55XXX_ATTR_INSTRUMENT_MODEL

The model number or name reported by the physical instrument. If Simulation is enabled or the instrument is not capable of reporting the model number or name, a string is returned that explains the condition. Model is limited to 256 bytes

BTN55XXX_ATTR_INTERCHANGE_CHECK

If True, the driver maintains a record of interchangeability warnings. If the driver does not support interchangeability checking, attempts to set InterchangeCheck to True return an error.

BTN55XXX_ATTR_INTERNAL_SKEW

Adjusts the skew for the internal trigger and master trigger output.

BTN55XXX_ATTR_INTERNAL_TRIGGER_EVENT_SOURCE

Class-compliant IIviPwrMeter property specifying the channel that the power meter uses to monitor the internal trigger event

BTN55XXX_ATTR_INTERNAL_TRIGGER_LEVEL

Class-compliant IIviPwrMeter property specifying the trigger level for the measurement signal. The value of this property is specified in the same unit as the value of the Channels.Units property

BTN55XXX_ATTR_INTERNAL_TRIGGER_SLOPE

Class-compliant IIviPwrMeter property specifying whether the power meter should trigger on the rising or falling edge of the measurement signal

BTN55XXX_ATTR_IO_RESOURCE_DESCRIPTOR

The resource descriptor specifies the connection to a physical device. It is either specified in the Configuration Store or passed in the ResourceName parameter of the Initialize function. It is empty if the driver is not initialized.

BTN55XXX_ATTR_IS_AVAILABLE

Returns true if modulated/CW measurement system is available. Will always retrun false if measurement buffer is enabled.

BTN55XXX_ATTR_IS_RUNNING

Returns true if modulated/CW measuremnts are actively running.

BTN55XXX_ATTR_LEVEL

Set or return the trigger level for synchronizing data acquisition with a pulsed input signal. The internal trigger level entered should include any global offset and will also be affected by the frequency cal factor. The available internal trigger level range is sensor dependent. The trigger level is set and returned in dBm.

BTN55XXX_ATTR_LINEAR_RESOLUTION

Set or return the resolution for linear power and voltage readings. The number of significant digits displayed is equal to the value.

BTN55XXX_ATTR_LOG_RESOLUTION

Set or return the resolution for logarithmic power and voltage readings. The number of decimal places displayed is equal to the value.

BTN55XXX_ATTR_LOGICAL_NAME

Logical Name identifies a driver session in the Configuration Store. If Logical Name is not empty, the driver was initialized from information in the driver session. If it is empty, the driver was initialized without using the Configuration Store.

BTN55XXX_ATTR_MANUFACTURE_DATE

Date the sensor was manufactured.

BTN55XXX_ATTR_MAX_FREQ_HIGH_BANDWIDTH

Maximum frequency the sensor can measure in high bandwidth.

BTN55XXX_ATTR_MAX_FREQ_LOW_BANDWIDTH

Maximum frequency the sensor can measure in low bandwidth.

BTN55XXX_ATTR_MAX_TIMEBASE

Returns the maximum timebase available.

BTN55XXX_ATTR_MEAS_BUFF_ENABLED

Enable or disable the measurement buffer. Disabling the measurement buffer enables modulated/CW measurements. Conversely, enabling it disables modulated/CW measurements.

BTN55XXX_ATTR_MEASUREMENT_MODE

There are three basic measurement modes - pulse power, modulated power, and statistical power. Each mode is targeted towards a specific type of measurement.The Pulse Mode is used with peak power sensors. The instrument functions as an enhanced peak power analyzer and provides the functionality of a random repetitive sampling oscilloscope for viewing and analyzing the RF power envelope of signals.The Modulated Mode is designed for continuous, true average power measurements of complex modulated signals. The Statistical Mode is used for advanced analysis of non-periodic modulated signals. This mode does not require a trigger event to make measurements and is useful for signals that are noise-like such as CDMA, OFDM, or QAM. In Statistical Mode, the RF signal is sampled continuously at high speed, without discarding or losing any data.

BTN55XXX_ATTR_MEASUREMENTS_AVAILABLE

Gets the number of measurements available in the power meter's internal buffer. Note: The number of readings that have been acquired may be more or less.

BTN55XXX_ATTR_MESIAL

Set or return the pulse amplitude percentage, which is used to define the beginning of a rising edge or end of a falling edge transition.

BTN55XXX_ATTR_MIN_FREQ_HIGH_BANDWIDTH

Minimum frequency the sensor can measure in high bandwidth.

BTN55XXX_ATTR_MIN_FREQ_LOW_BANDWIDTH

Minimum frequency the sensor can measure in low bandwidth.

BTN55XXX_ATTR_MINIMUM_TRIG

Minimum trigger level in dBm.

BTN55XXX_ATTR_MODE

Set or return the trigger mode for synchronizing data acquisition with pulsed signals.

BTN55XXX_ATTR_MODEL

Model number of the meter connected to the specified channel.

BTN55XXX_ATTR_MODULATED_TIMEBASE

Set or return the Modulated Mode timebase in seconds/division. The power meter has fixed timebase settings, primarily in a 1-2-5 sequence. If the argument does not match one of these settings, it will be forced to the next highest entry.Value = 5e-9 to 10.0, (1-2-5 sequence)30, 60, 120, 300, 600, 1800, and 3600

BTN55XXX_ATTR_MODULATED_TIMESPAN

Set or return the horizontal time span of the trace in modulated mode. Time span = 10* Time/Division. Value = 5e-8 to 100 sec in a 1-2-5 sequence, 300, 600, 1200, 3000, 6000, 18000, and 36000

BTN55XXX_ATTR_OFFSET

Class-compliant IIviPwrMeter property specifying an offset to be added to the measured value in units of dB. This property can be used to compensate for system losses or gains between the unit under test and the power sensor

BTN55XXX_ATTR_OFFSETDB

Set or return a measurement offset in dB for the selected sensor. This is used to compensate for external couplers, attenuators or amplifiers in the RF signal path ahead of the power sensor.

BTN55XXX_ATTR_OVER_RAN

Flag indicating whether the power meter's internal buffer filled up before beign emptied.

BTN55XXX_ATTR_PEAK_HOLD_DECAY

Set or return the number of min/max traces averaged together to form the peak hold measurement results on the selected channel.

BTN55XXX_ATTR_PEAK_HOLD_TRACKING

Sets or returns whether peak hold decay automatically tracks trace averaging. If set to true, the peak hold decay and trace averaging values are the same. If set to false, peak hold decay is indepedent.

BTN55XXX_ATTR_PEAK_POWER_MAX

Maximum power level the sensor can measure.

BTN55XXX_ATTR_PEAK_POWER_MIN

Minimum power level the sensor can measure.

BTN55XXX_ATTR_PERCENT_POSITION

Set/return the cursor percent on the CCDF plot.

BTN55XXX_ATTR_PERIOD

Set/get the period each timed mode acquisition is started.

BTN55XXX_ATTR_POSITION

Set or return the position of the trigger event on displayed sweep.

BTN55XXX_ATTR_POWER_POSITION

Set/return the cursor power in dB on the CCDF plot.

BTN55XXX_ATTR_PROXIMAL

Set or return the pulse amplitude percentage, which is used to define the beginning of a rising edge or end of a falling edge transition.

BTN55XXX_ATTR_PULSE_TIMEBASE

Set or return the Pulse Mode timebase in seconds/division.

BTN55XXX_ATTR_PULSE_TIMESPAN

Set or return the horizontal time span of the trace in pulse mode. Time span = 10* Time/Division. Value = 5e-8 to 100 sec in a 1-2-5 sequence, 300, 600, 1200, 3000, 6000, 18000, and 36000

BTN55XXX_ATTR_PULSE_UNITS

Set or return the units for entering the pulse distal, mesial and proximal levels.

BTN55XXX_ATTR_QUERY_INSTRUMENT_STATUS

If True, the driver queries the instrument status at the end of each method or property that performs I/O to the instrument. If an error is reported, use ErrorQuery to retrieve error messages one at a time from the instrument.

BTN55XXX_ATTR_RANGE_AUTO_ENABLED

Class-compliant IIviPwrMeter property specifying if the power meter should set the best range for the measurement. If True, the instrument automatically sets the best range. If False, set the range using the Range.Upper and Range.Lower properties

BTN55XXX_ATTR_RANGE_CHECK

Drivers may choose to always validate some property/parameter values, never validate others, and optionally validate others, to avoid sending invalid commands to the instrument. If True, the driver performs optional validations.

BTN55XXX_ATTR_RANGE_LOWER

Class-compliant IIviPwrMeter property specifying the lower limit (minimum) of the expected value of the measurement. The value of this property is specified in the same units as the value of the Channels.Units property

BTN55XXX_ATTR_RANGE_UPPER

Class-compliant IIviPwrMeter property specifying the upper limit (maximum) of the expected value of the measurement. The value of this property is specified in the same units as the value of the Channels.Units property

BTN55XXX_ATTR_READ_BUFFER_SIZE

Sets or gets the size of the SCPI read buffer in bytes.

BTN55XXX_ATTR_READING_PERIOD

Returns the period (rate) in seconds per new filtered reading.

BTN55XXX_ATTR_RECORD_COERCIONS

If True, the driver keeps a list of the value coercions it makes for ViInt32 and ViReal64 attributes. If the driver does not support coercion recording, attempts to set RecordCoercions to True will return an error.

BTN55XXX_ATTR_REF_OSCILLATOR_ENABLED

Class-compliant IIviPwrMeter property specifying if the internal reference oscillator is enabled

BTN55XXX_ATTR_REF_OSCILLATOR_FREQUENCY

Class-compliant IIviPwrMeter property specifying the frequency of the signal generated by the reference oscillator in Hertz

BTN55XXX_ATTR_REF_OSCILLATOR_LEVEL

Class-compliant IIviPwrMeter property specifying the power level of the signal generated by the reference oscillator in dBm

BTN55XXX_ATTR_RETURN_COUNT

Set/get the return count for each measurement query.

BTN55XXX_ATTR_SERIAL_NUMBER

Serial number of the sensor.

BTN55XXX_ATTR_SESSION_COUNT

Set/get the count of elements for this measurement buffer session. Set to 0 for the meter to continuously acquire measurements.

BTN55XXX_ATTR_SESSION_TIMEOUT

Set/get the time out for this measurement buffer session in seconds. Set to 0.0 for the meter to ignore the time out.

BTN55XXX_ATTR_SIMULATE

If True, the driver does not perform I/O to the instrument, and returns simulated values for output parameters.

BTN55XXX_ATTR_SLAVE_SKEW

Adjusts the skew for the slave trigger.

BTN55XXX_ATTR_SLOPE

Set or return the trigger slope or polarity. When set to POS, trigger events will be generated when a signal?s rising edge crosses the trigger level threshold. When NEG, trigger events are generated on the falling edge of the pulse.

BTN55XXX_ATTR_SOURCE

The signal the power meter monitors for a trigger. It can be channel or one of many other values.

BTN55XXX_ATTR_SPECIFIC_DRIVER_CLASS_SPEC_MAJOR_VERSION

Returns the major version number of the class specification in accordance with which the IVI specific driver was developed. Zero is returned if the driver is not compliant with a class specification.

BTN55XXX_ATTR_SPECIFIC_DRIVER_CLASS_SPEC_MINOR_VERSION

Returns the minor version number of the class specification in accordance with which the IVI specific driver was developed. Zero is returned if the driver is not compliant with a class specification.

BTN55XXX_ATTR_SPECIFIC_DRIVER_DESCRIPTION

Returns a brief description of the IVI specific driver. The string that this attribute returns contains a maximum of 256 bytes including the NUL byte.

BTN55XXX_ATTR_SPECIFIC_DRIVER_PREFIX

Returns the case-sensitive prefix of the user-callable functions that the IVI-C specific driver exports. The string that this attribute returns contains a maximum of 32 bytes including the NUL byte.

BTN55XXX_ATTR_SPECIFIC_DRIVER_REVISION

Returns version information about the IVI specific driver. The string that this attribute returns contains a maximum of 256 bytes including the NUL byte.

BTN55XXX_ATTR_SPECIFIC_DRIVER_VENDOR

Returns the name of the vendor that supplies the IVI specific driver. The string that this attribute returns contains a maximum of 256 bytes including the NUL byte.

BTN55XXX_ATTR_START_DELAY

Set/get delay time added to the detected beginning of a burst for analysis. Typically used to exclude the rising edge of a burst.

BTN55XXX_ATTR_START_GATE

Set or return the point on a pulse, which is used to define the beginning of the pulse?s active interval.

BTN55XXX_ATTR_START_MODE

Mode used to start acquisition of buffer entries.

BTN55XXX_ATTR_START_QUAL

Set/get the minimum amount of time power remains above the trigger point to be counted as the beginning of a burst.

BTN55XXX_ATTR_STATUS

The status of the triggering system.

BTN55XXX_ATTR_SUPPORTED_INSTRUMENT_MODELS

A comma-separated list of instrument models that the IVI specific driver can control. The string does not include an abbreviation for the manufacturer if it is the same for all models.

BTN55XXX_ATTR_TEMP_COMP

Set or return the state of the peak sensor temperature compensation system.

BTN55XXX_ATTR_TERM_ACTION

Set/return the termination action for statistical capturing.

BTN55XXX_ATTR_TERM_COUNT

Set/return the termination count for statistical capturing. After the sample count has been reached, the action determined by TermAction is taken.

BTN55XXX_ATTR_TERM_TIME

Set/return the termination time for statistical capturing. After the time has elapsed, the action determined by TermAction is taken.

BTN55XXX_ATTR_TIME_PER_POINT

Time spacing for each waveform point in seconds.

BTN55XXX_ATTR_TIMED_OUT

Check if the last measurement buffer session timed out.

BTN55XXX_ATTR_TRACE_COUNT

Set/return the number of points in the CCDF trace plot.

BTN55XXX_ATTR_TRIGGER_SOURCE

Class-compliant IIviPwrMeter property specifying the trigger source that the power meter monitors for a trigger event

BTN55XXX_ATTR_UNITS

Class-compliant IIviPwrMeter property specifying the unit to which the RF power is converted after measurement

BTN55XXX_ATTR_VERNIER

Set or return the fine position of the trigger event on displayed sweep.

BTN55XXX_ATTR_VERTICAL_CENTER

Set/Query vertical center based on current units: <arg> = (range varies by units)

BTN55XXX_ATTR_VERTICAL_SCALE

Set/Query vertical scale based on current units: <arg> = (range varies by units)

BTN55XXX_ATTR_WRITE_BUFFER_SIZE

Sets or gets the size of the SCPI write buffer in bytes.

BTN55XXX_ATTR_WRITE_PROTECTION

Set true to allow the measurement buffer to overwrite members that have not been read by the user.