This information is relevant for SSA-J enhancement introduced in the E5052B Firmware revision A.03.10.
Previous to Firmware revision A.03.10, the SSA-J save/recall functionality used the E5052B save/recall function with using the trace data region for USER window. When the data was recalled, it required the User to press the SSA-J renewal button after the recall. From ver A.03.10, this recall is automatic and User is not required to take any action.
If save type value is not "State & Data" at saving time, SSA-J application Save/Recall doesn't operates.
Even through recall, if the update button of SSA-J is not pressed, the recalled content is not reflected to SSA-J.
From firmware revisoin A.03.10, two new commands SCPI.PROGram.COMMand <command_string> and SCPI.PROGram.QUERy are added which can be used to control SSA-J remotely through a VBA program.
SCPI.PROGram.COMMand <command_string> sends a OnCommand event to the VBA Application and the <command_string> is passed to the event handler as the parameter.
When this command is executed, the execution is followed with the description in OnCommand event handler written by VBA Application developer. Till the processing of this command continues, executing new command is not supported and generates an error (93, Program command error).
The following section explain the Event handler specifications for OnCommand:
OnCommand(ByVal CommandStr As String)
<command_string> passed in parameter for CommandStr : PROGram:COMMand
nError : if set other than 0, PROGram:COMMand reports SCPI error.
:PROGram:QUERy? <query_string> sends a OnQuery event to the VBA Application and the <query_string> is passed to the event handler as the parameter. It can also be used to receive the return value for event handler as the query_response.
When this command is executed, the execution is followed with the description in OnQuery event handler written by VBA Application developer. Till the processing of this command continues, executing new command is not supported and generates an error (92, Program not running).
The following section explain the Event handler specifications for OnQuery:
OnQuery(ByVal QueryStr As String, RespStr As String)
<query_string> passed at the parameter for PROGram:QUERy?
This RspStr value is returned as the response of PROGram:QUERy?
nError : if set other than 0, PROGram:COMMand reports SCPI error.
The E5052B executes the command sequence below when SSA-J application starts:
Saves settings for Save type (SCPI.MMEMory.STORe.STYPe) of Save/Recall function.
Sets the Save type value to STATe (E5052B State Only).
Saves the current status.
Sets the Save type value to DSTate (E5052B State & Data)
Sets Macro Setup > E5052 Event > ON.
Refer to the command sequence below to start the SSA-J functionality remotely through VBA:
MMEMory:LOAD:PROGram "C:\Program Files\Agilent\E5052\vba\AgtJitter.vba".
PROGram:SELected:NAME "E5052.Module1.main".
The E5052B executes the command sequence below when SSA-J application exits:
Restores backup setting at boot for Save type (SCPI.MMEMory.STORe.STYPe) of Save/Recall function.
Recalls the state file to be saved at boot up.
Sets Macro Setup > E5052 Event > OFF.
To exit SSA-J application manually, click [x] right above button of the Jitter application window.
When AgtJitter.vba is terminated with Macro Break key, the SSA-J application exits without performing the normal termination processing and is not a recommended process to exit from SSA-J application.
Use PROGram:COMMand "CLOS" to exit from SSA-J functionality remotely through VBA.
When AgtJitter.vba is terminated with PROGram:SELected:STATe STOP Command remotely using VBA, the SSA-J application exits without performing the normal termination processing and is not a recommended process to exit from SSA-J application. A warning message in Echo window (If Echo State is ON) is displayed which can be turned ON/OFF using Macro Setup > Echo Window Menu > Echo Window.
SSA-J remote control is executed through SCPI commands: SCPI.PROGram.COMMand and PROGram:QUERy?.
Following are the <command_string>that can be designated as the parameter of PROGram:COMMand.
• TRIG RUN : Trigger RUN
• TRIG STOP : Trigger STOP
• JUN SEC : jitter unit sec
• JUN UI : jitter unit UI
• UPD : Executes the renewal of the display.
• PAGE RJ : select RJ tab
• PAGE PJF : select PJ Frequency tab
• PAGE PJD : select PJ Decomposition tab
• IBWL <value> : Sets the Low side frequency of Integrated BW for RJ tab to <value>
• IBWH <value> : Sets the High side frequency of Integrated BW for RJ tab to <value>
• SORT JITT : Sort by Jitter
• SORT FREQ : Sort by Frequency
• ICL <value> : Sets the input clock frequency for PJ Decomposition tab to <value>.
• TPFR <value> : Sets the Target PJ frequency for PJ Decomposition tab to <value>
• PAN JTR : Jitter Trend
• PAN JHIS : Jitter Histogram
• PAN PJS : PJ Separation
• ATC ON|OFF : Auto trend correction setting for PJ Decomposition tab.
• CLOS : Exit SSA-J.
Following are the definition of <query_string> and <query_response> which can be designated as the parameter of PROGram:QUERy?
TRIG (Response: RUN|STOP|WAIT) : WAIT is returned at the waiting status for the end of measurement. (The status from TRIG STOP is received to the actual end of measurement)
• JUN (Response: SEC|UI)
• PAGE (Response: RJ|PJF|PJD>
• RJDC (Response: <value>) : Queries the Detected clock value for RJ tab [Query only]
• RJIT (Response: <value>) : Queries the Jitter value for RJ tab [Query only]
• IBWL (Response: <value>)
• IBWH (Response: <value>)
• SORT (Response: JITT|FREQ)
• PFDC (Response: <value>) : Queries the Detected clock value for PJ frequency tab [Query only]
• JLIS : Queries the content of the list ordering frequency1, jitter1, frequency2, jitter2, ... displayed in jitter list [Query only]
• ICL (Response: <value>)
• TPFR (Response: <value>)
• PAN (Response: JTR|JHIS|PJS)
• ATC (Response: ON|OFF)
• PPTJ (Response: <value>) : Queries the PP TJ value of Result window for PJ Decomposition tab [Query only]
• RTJ (Response: <value>) : Queries the RMS TJ value of Result window for PJ Decomposition tab [Query only]
• NSAM (Response: <value>) : Queries the # Samples value of Result window for PJ Decomposition tab [Query only]
• RPJ (Response: <value>) : Queries the RMS PJ dd value of Result window for PJ Decomposition tab [Query only]
• PJDD (Response: <value>): Queries the RMS PJ dd value of Result window for PJ Decomposition tab [Query only]
• PDDC (Response: <value>): Query the Det. Clock value of Result window for PJ Decomposition tab. On screen display, it is displayed when Auto trend correction value is ON.
• ERR (Response: <string>): Returns the error occurred in the end of SSA-J command/query performance. [Query only]. After query, the content of the error is cleared. A SCPI error occurs with PROGram:COMMand, PROGram:QUERy?.
When (93, Program command error) occurs, the the command is enable to get the further information and any of the following values is returned:
• No error
• Invalid character
• Invalid separator
• Parameter not allowed
• Missing parameter
• Undefined header
• Invalid character in number
• Exponent too large
• Suffix not allowed
• Character data not allowed
• Execution error
• Data out of range
• Illegal parameter value
For example, when perform PROGram:COMMand "IBWL 1.0E30000", 93, Program command erroris reported as SCPI error. After that, "Exponent too learge" is returned as the result of query if perform PROGRam: QUERy? "ERR".