add documentation for new SCPI commands

This commit is contained in:
Jan Käberich 2024-04-22 17:03:15 +02:00
parent a6c70e0bfa
commit dbc99c011d
2 changed files with 22 additions and 0 deletions

View file

@ -257,6 +257,14 @@ This section contains general device commands, available regardless of the curre
206039903350 206039903350
\end{example} \end{example}
\subsubsection{DEVice:UPDATE}
\event{Updates the firmware of the connected device}{DEVice:UPDATE <fw\_file>}{<fw\_file> Path to the firmware file}
Important points when saving/loading setup files through SCPI commands:
\begin{itemize}
\item The path must be either absolute or relative to the location of the GUI application.
\item If the LibreVNA-GUI (and thus also the SCPI server) is running on a different machine than the SCPI client, the firmware file must be stored on the machine that runs the GUI.
\end{itemize}
\subsubsection{DEVice:LIST} \subsubsection{DEVice:LIST}
\query{Lists all available devices by their serial numbers}{DEVice:LIST?}{None}{List of serialnumbers} \query{Lists all available devices by their serial numbers}{DEVice:LIST?}{None}{List of serialnumbers}
\begin{example} \begin{example}
@ -394,6 +402,13 @@ These commands change or query VNA settings. Although most of them are available
\event{Sets the stop power of the power sweep}{VNA:POWer:STOP}{<stop power>, in dBm} \event{Sets the stop power of the power sweep}{VNA:POWer:STOP}{<stop power>, in dBm}
\query{Queries the currently selected stop power}{VNA:POWer:STOP?}{None}{stop power in dBm} \query{Queries the currently selected stop power}{VNA:POWer:STOP?}{None}{stop power in dBm}
\subsubsection{VNA:ACQuisition:RUN}
\event{Puts the VNA into run mode (sweep active)}{VNA:ACQuisition:RUN}{None}
\query{Queries whether the VNA is in run mode}{VNA:ACQuisition:RUN?}{None}{TRUE or FALSE}
\subsubsection{VNA:ACQuisition:STOP}
\event{Puts the VNA into stop mode (sweep inactive)}{VNA:ACQuisition:STOP}{None}
\subsubsection{VNA:ACQuisition:IFBW} \subsubsection{VNA:ACQuisition:IFBW}
\event{Sets the IF bandwidth}{VNA:ACQuisition:IFBW}{<IF bandwidth>, in Hz} \event{Sets the IF bandwidth}{VNA:ACQuisition:IFBW}{<IF bandwidth>, in Hz}
\query{Queries the currently selected IF bandwidth}{VNA:ACQuisition:IFBW?}{None}{IF bandwidth in Hz} \query{Queries the currently selected IF bandwidth}{VNA:ACQuisition:IFBW?}{None}{IF bandwidth in Hz}
@ -652,6 +667,13 @@ These commands change or query spectrum analyzer settings. Although most of them
\subsubsection{SA:FREQuency:ZERO} \subsubsection{SA:FREQuency:ZERO}
\event{Sets the device to zero span mode}{SA:FREQuency:ZERO}{None} \event{Sets the device to zero span mode}{SA:FREQuency:ZERO}{None}
\subsubsection{SA:ACQuisition:RUN}
\event{Puts the spectrum analyzer into run mode (sweep active)}{SA:ACQuisition:RUN}{None}
\query{Queries whether the spectrum analyzer is in run mode}{SA:ACQuisition:RUN?}{None}{TRUE or FALSE}
\subsubsection{SA:ACQuisition:STOP}
\event{Puts the spectrum analyzer into stop mode (sweep inactive)}{SA:ACQuisition:STOP}{None}
\subsubsection{SA:ACQuisition:RBW} \subsubsection{SA:ACQuisition:RBW}
\event{Sets the resolution bandwidth}{SA:ACQuisition:IFBW}{<resolution bandwidth>, in Hz} \event{Sets the resolution bandwidth}{SA:ACQuisition:IFBW}{<resolution bandwidth>, in Hz}
\query{Queries the currently selected resolution bandwidth}{SA:ACQuisition:IFBW?}{None}{resolution bandwidth in Hz} \query{Queries the currently selected resolution bandwidth}{SA:ACQuisition:IFBW?}{None}{resolution bandwidth in Hz}