APPH module

Created on Tue Feb 15 10:57:49 2022

@author: Martin.Mihaylov

class APPH.APPH(resource_str)[source]

Bases: object

ANMeasExample(value)[source]: This is a small example how to make a phase noise measurement.

Abort()[source]

Returns:: Abort measurement
Return type:: None.

Close()[source]

FNMeasExample(value)[source]: This is a small example how to make a frequency noise measurement.

Init()[source]

Returns:: Initialize the measurement
Return type:: None.

PNMeasExample(value)[source]: This is a small example how to make a phase noise measurement.

VCOMeasExample(NoieseOffset1, NoieseOffset2, measPoints, tunRangeMin, tunRangeMax, SupplyVoltage, delay)[source]: This is a small example how to make a Voltage controlled oscillator noise measurement.

ask_ANSpot(value)[source]

Parameters:

value (TYPE) –

The parameter is given as offset frequency in [Hz]: Unit Hz Value - float

Returns:

Returns the phase noise value of the last measurement at the offset frequency defined in <value>. The parameter is given as offset frequency in [Hz] Unit Hz Value - float

Return type:

TYPE str

ask_ANTraceFreq()[source]

Returns:: Returns a list of offset frequency values of the current measurement as block data. Hz
Return type:: TYPE str

ask_ANTraceNoise()[source]

Returns:: Returns a list of amplitude noise spectrum values of the current measurement as block data Unit dBc/Hz
Return type:: TYPE str

ask_ANTraceSpurFreq()[source]

Returns:: Returns a list of offset frequencies of the spurs in the active trace as block data. Unit Hz
Return type:: TYPE str

ask_ANTraceSpurPower()[source]

Returns:: Returns a list of power values of the spurs in the active trace as block data. Unit dBc
Return type:: TYPE str

ask_CalcFreq()[source]

Returns:: Reads back the detected frequency from a frequency search.
Return type:: TYPE float

ask_CalcPower()[source]

Returns:: Reads back the detected power level from a frequency search.
Return type:: TYPE float

ask_DUTPortStatus()[source]

Returns:: stat – Query the status of the DUT TUNE port.
Return type:: str

ask_DUTPortVoltage()[source]

Returns:: Sets/gets the voltage at the DUT TUNE port. Returns the configured value. If the output is turned off, it doesn’t necessarily return 0, as an internal voltage may be configured.
Return type:: TYPE float

ask_FNSpot(value)[source]

Parameters:

value (float) –

The parameters defines the spot noise offset frequency in [Hz].: Units are in Hz. Value - float

Returns:

Returns the spot noise value at the specified offset frequency.

Return type:

TYPE str

ask_FNTraceFreq()[source]

Returns:: Returns a list of offset frequency values of the current measurement as block data. Unit Hz
Return type:: TYPE list

ask_FNTraceNoise()[source]

Returns:: Returns a list of phase noise spectrum values of the current measurement as block data. Units are in Hz.
Return type:: TYPE list

ask_FNTraceSpurFreq()[source]

Returns:: Returns a list of offset frequencies of the spurs in the active trace as block data. Units are in Hz.
Return type:: TYPE list

ask_FNTraceSpurPower()[source]

Returns:: Returns a list of power values of the spurs in the active trace as block data. Units are in Hz
Return type:: TYPE list

ask_PMTraceJitter()[source]

Returns:: Returns the RMS jitter of the current trace.
Return type:: TYPE str

ask_PMTraceNoise()[source]

Returns:: Returns a list of phase noise points of the most recent measurement as block data.
Return type:: TYPE list

ask_PNSpot(value)[source]

Parameters:: value (float) – The parameter is given as offset frequency in [Hz] Unit Hz Value - float
Returns:: Returns the phase noise value of the last measurement at the offset frequency defined in <value>. The parameter is given as offset frequency in [Hz] Unit Hz Value - float
Return type:: TYPE str

ask_PN_IFGain()[source]

Returns:: Range: 0-60 Query the IF gain for the measurement.
Return type:: TYPE float

ask_PN_StartFreq()[source]

Returns:: Query the start offset frequency
Return type:: TYPE float

ask_PN_StopFreq()[source]

Returns:: Query the stop offset frequency
Return type:: TYPE float

ask_SysMeasMode()[source]

Returns:: Gets the active measurement mode.
Return type:: TYPE str

ask_SystemError()[source]

Returns:: Return parameters: List of integer error numbers. This query is a request for all entries in the instrument’s error queue. Error messages in the queue contain an integer in the range [-32768,32768] denoting an error code and associated descriptive text. This query clears the instrument’s error queue.
Return type:: TYPE list

ask_VCOKPuShing()[source]

Returns:: Query the pushing parameter for the measurement
Return type:: TYPE str

ask_VCOKVCO()[source]

Returns:: Query the tune sensitivity parameter for the measurement.
Return type:: TYPE str

ask_VCOTYPE()[source]

Returns:: Query the DUT type for the measurement.
Return type:: TYPE str

ask_VCOTestISupply()[source]

Returns:: Query the supply current parameter for the measurement
Return type:: TYPE str

ask_VCOTestPNoise()[source]

Returns:: Query the phase noise parameter for the measurement.
Return type:: TYPE str

ask_VCOTestPnoiseOFFSet(state)[source]

Parameters:: state (int) – Can be set to [1,2,3,4]
Raises:: ValueError – Error massage
Returns:: Query the 4 offset frequencies at which the phase noise is measured
Return type:: TYPE str

ask_VCOTestPoint()[source]

Returns:: Query the number rof voltage points to use in the measurement
Return type:: TYPE str

ask_VCOTestPower()[source]

Returns:: Query the power parameter for the measurement.
Return type:: TYPE str

ask_VCOTestStart()[source]

Returns:: Query the start tuning voltage for the measurement. Units are in V.
Return type:: TYPE str

ask_VCOTestStop()[source]

Returns:: Query the stop tuning voltage for the measurement. Units are in V
Return type:: TYPE str

ask_VCOTraceFreq()[source]

Returns:: Returns a list of frequency values measured at each tune voltage point of the current measurement as block data2.
Return type:: TYPE list

ask_VCOTracePNoise(chan)[source]

Parameters:: chan (list) – Can be set to [1,2,3,4]
Raises:: ValueError – Error massage
Returns:: Returns a list of phase noise values measured at each tune voltage point of the current measurement as block data. The parameter 1-4 selects the offset frequency from the set defined by the SENS:VCO:TEST:PN:OFFS <list> command
Return type:: TYPE list

ask_VCOTracePower()[source]

Returns:: Returns a list of power values measured at each tune voltage point of the current measurement as block data.
Return type:: TYPE list

ask_VCOTraceVoltage()[source]

Returns:: Returns a list of tune voltage values measured at each tune voltage point of the current measurement as block data.
Return type:: TYPE list

ask_VSOTestFreq()[source]

Returns:: Query the frequency parameter for the measurement.
Return type:: TYPE str

ask_VSOTestNoise()[source]

Returns:: Query the phase noise parameter for the measurement.
Return type:: TYPE str

getIdn()[source]

Returns:: Queries the device serial number and name
Return type:: TYPE Str

query(message)[source]

set_CalcAverage(event)[source]

Parameters:: event (str) – Waits for the defined event NEXT: next iteration complete ALL: measurement complete <value>: specified iteration complete Optionally, a timeout in milliseconds can be specified as a second parameter. This command will block further SCPI requests until the specified event or the specified timeout has occurred. If no timeout is specified, the timeout will be initiated.
Return type:: None.

set_DUTPortStatus(state)[source]

Parameters:: state (str) – Enables/disables the DUT TUNE port. Can be [‘ON’,’OFF’]
Raises:: ValueError – Error massage
Return type:: None.

set_DUTPortVoltage(value)[source]

Parameters:: value (float) – Sets the voltage at the DUT TUNE port. Returns the configured value. If the output is turned off, it doesn’t necessarily return 0, as an internal voltage may be configured
Return type:: None.

set_FreqExecute()[source]

Returns:: Starts the frequency search. See function calculate subsystem on how to read out the result.
Return type:: None.

set_Output(status)[source]

Parameters:: status (str) – Set Output ON and OFF. CAn be [‘ON’,’OFF’]
Raises:: ValueError – Error massage
Return type:: None.

set_PNIFGain(value)[source]

Parameters:: value (float) – Range: 0-60 Sets the IF gain for the measurement.
Raises:: ValueError – Error massage
Return type:: None.

set_PNStartFreq(value)[source]

Parameters:: value (float) – Unit HZ Sets the start offset frequency.
Return type:: None.

set_PNStopFreq(value)[source]

Parameters:: value (float) – Unit HZ Sets the stop offset frequency.
Return type:: None.

set_PowerExecute()[source]

Returns:: Starts the power measurement. When performing SENS:FREQ:EXEC, this measurement will be automatically run at the end (if a signal is detected
Return type:: None.

set_SysMeasMode(state)[source]

Parameters:

state (str) –

Sets/gets the active measurement mode. Can be [‘PN’,’AN’,’FN’,’BB’,’TRAN’,’VCO’]

PN: phase noise measurement
AN: amplitude noise measurement
FN: frequency noise measurement (results are converted to phase noise)
BB: base band measurement (not yet available)
TRAN: transient analysis (not yet available)
VCO: voltage controlled oscillator characterization

Raises:

ValueError – Error massage

Return type:

None.

set_VCOKPuShing(state)[source]

Parameters:: state (str) – Enables/disables the pushing parameter for the measurement. Can be [‘ON’,’OFF’]
Raises:: ValueError – Error massage
Return type:: None.

set_VCOKVCO(state)[source]

Parameters:: state (str) – Enables/disables the tune sensitivity parameter for the measurement Can be [‘ON’,’OFF’]
Raises:: ValueError – Error massage
Return type:: None.

set_VCOTYPE(typ)[source]

Parameters:: typ (str) – Select the DUT type for the measurement. Distinguish between slow (VCXO) and fast (VCO) tuning sensitivities. Can be [‘VCO’,’VCXO’]
Raises:: ValueError – Error massage
Return type:: None.

set_VCOTestFreq(state)[source]

Parameters:: state (str) – Enables/Disables the frequency parameter for the measurement. Can be [‘ON’,’OFF’]
Raises:: ValueError – Error massage
Return type:: None.

set_VCOTestISupply(state)[source]

Parameters:: state (str) – Enables/disables the supply current parameter for the measurement. Can be [‘ON’,’OFF’]
Raises:: ValueError – Error massage
Return type:: None.

set_VCOTestNoise(state)[source]

Parameters:: state (str) – Enables/Disables the phase noise parameter for the measurement. Can be [‘ON’,’OFF’]
Raises:: ValueError – Error massage
Return type:: None.

set_VCOTestPNoise(state)[source]

Parameters:: state (str) – Enables/Disables the phase noise parameter for the measurement. Can be set to [‘ON’,’OFF’]
Raises:: ValueError – Error massage
Return type:: None.

set_VCOTestPnoiseOFFSet(value1, value2, value3, value4)[source]

Parameters:

value1 (float) – freq val 1
value2 (float) – freq val 2
value3 (float) – freq val 3
value4 (float) – freq val 4

Sets up to 4 offset frequencies at which the phase noise is measured. At least 1 parameter is required. Blank parameters are set to 0 (disabled). The query returns the set frequency for the specified offset. The offset can be specified with the <sel> parameter and can be chosen from 1|2|3|4

Unit HZ

Return type:: None.

set_VCOTestPoint(value)[source]

Parameters:: value (float) – Sets the number rof voltage points to use in the measurement
Return type:: None.

set_VCOTestPower(state)[source]

Parameters:: state (str) – Enables/Disables the power parameter for the measurement. Can be [‘ON’,’OFF’]
Raises:: ValueError – Error massage
Return type:: None.

set_VCOTestStart(value)[source]

Parameters:: value (float) – Sets the start tuning voltage for the measurement. Unit V
Return type:: None.

set_VCOTestStop(value)[source]

Parameters:: value (float) – Sets the stop tuning voltage for the measurement. Units are in V.
Return type:: None.

set_VCOWait(state, value)[source]

Parameters:

state (str) – Can be [‘ALL’,’NEXT’]
value (float) – This command requests a preliminary result during the measurement and blocks until the result is ready. The first parameter (required) specifies the target iteration to be saved. NEXT specifies the next possible iteration, ALL specifies the last iteration of the measurement (i.e. waits for the measurement to finish) and an integer specifies the specific iteration requested.The second parameter (optional) defines a timeout in milliseconds. If the command terminates without generating a preliminary result. It will produce an error. This error can be queried with SYST:ERR? or SYST:ERR:ALL?.

Returns:

DESCRIPTION.

Return type:

TYPE

write(message)[source]