add documentation for new SCPI commands

jankae · Apr 22, 2024 · dbc99c0 · dbc99c0
1 parent a6c70e0
commit dbc99c0
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/Documentation/UserManual/ProgrammingGuide.pdf b/Documentation/UserManual/ProgrammingGuide.pdf
diff --git a/Documentation/UserManual/ProgrammingGuide.tex b/Documentation/UserManual/ProgrammingGuide.tex
@@ -257,6 +257,14 @@ \subsubsection{DEVice:CONNect}
 206039903350
 \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}
 \query{Lists all available devices by their serial numbers}{DEVice:LIST?}{None}{List of serialnumbers}
 \begin{example}
@@ -394,6 +402,13 @@ \subsubsection{VNA:POWer:STOP}
 \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}
 
+\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}
 \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}
@@ -652,6 +667,13 @@ \subsubsection{SA:FREQuency:FULL}
 \subsubsection{SA:FREQuency:ZERO}
 \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}
 \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}