caiyu/LibreVNA
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update docs with standby configuration and InitiateSweep packet

Browse Source
This commit is contained in:
Andre Dunford 2022-12-17 00:37:46 -08:00
parent 08fa3fa0a0
commit a294a92e2f
2 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
Documentation/DeveloperInfo/USB_protocol_v12.pdf
View File

Binary file not shown.

15
Documentation/DeveloperInfo/USB_protocol_v12.tex
View File

@ -250,6 +250,7 @@ The following packet types are available:
29 & ClearTrigger & D$\leftrightarrow$H & Updates the trigger status for synchronization over USB & None\\
30 & StopStatusUpdates & H$\rightarrow$D & Stops the automatic transmission of device status packets & None\\
31 & StartStatusUpdates & H$\rightarrow$D & Starts the automatic transmission of device status packets & None\\
32 & InitiateSweep & H$\rightarrow$D & Initiates a single sweep when configured for standby operation & None\\
\end{longtable}
\end{ThreePartTable}
An Ack is transmitted by the device for every received command after it has been handled successfully. If additional responses are triggered by the command, they are transmitted after this Ack.
@ -299,7 +300,7 @@ The packet contains the following fields:
\rwbits{12}{1}{FP}
\rwbits{13}{1}{SP}
\rwbits{14}{1}{SM}
\robits{15}{1}{}
\rwbits{15}{1}{SO}
\end{tikzpicture}
\end{center}
\begin{itemize}
@ -337,6 +338,15 @@ Setting & Behavior\\
\end{tabularx}
\end{center}
\item \textbf{SM:} Sync Master. Must be set to 1 at exactly one device when multiple devices are synchronized. Set to 0 when synchronization is disabled.
\item \textbf{SO:} Standby Operation. Indicates whether the VNA will timeout automatically, or wait in the configured state indefinitely for the next sweep to be triggered. Standy operation allows for lower latency of intermittent single sweeps.
\begin{center}
\begin{tabularx}{\textwidth}{ c|X }
Setting & Behavior\\
\hline
0 & VNA will timeout to idle mode after 100ms in the halted state, or 1000ms after a sucessfully completed sweep. Requires a new SweepSettings packet to be sent for subsequent sweeps after timeout. \\
1 & VNA will wait indefinitely in a configured state for an InitiateSweep packet. The host application is responsible for putting the VNA into idle mode with a SetIdle packet.\\
\end{tabularx}
\end{center}
\end{itemize}
\subsection{ManualStatusV1}
@ -1018,4 +1028,7 @@ This packet instructs the device to stop sending automatically scheduled DeviceS
\subsection{StartStatusUpdates}
This packet instructs the device to start sending automatically scheduled DeviceStatusV1 packets. This restores default update behaviour if a StopStatusUpdates packet has previously been sent.
\subsection{InitiateSweep}
This packet instructs the device to initiate a new single sweep when the VNA is configured for standby operation. This triggering method can be used for fast intermittent single sweeps with minimum latency. The packet will be acknowledged but quietly ignored if the SweepSettings are not configured for standby operation.
\end{document}