Skip to content

Commit dbc482e

Browse files
committed
Continued documentation update pass
1 parent 8766759 commit dbc482e

File tree

6 files changed

+60
-18
lines changed

6 files changed

+60
-18
lines changed

ng-images/dialog-logviewer.png

34.2 KB
Loading
18 KB
Loading
11.5 KB
Loading
2.13 KB
Loading

section-dialogs.tex

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ \subsection{Rendering}
6767

6868
Displays render loop framerate, monitor refresh rate, total time spent last frame in the rasterization and tone
6969
mapping shaders, and the number of vertices and indices drawn as Vulkan geometry. Note that waveforms are drawn by a
70-
compute shader and do not contribute towads the vertex/index totals, other than a single textured rectangle used for
70+
compute shader and do not contribute towards the vertex/index totals, other than a single textured rectangle used for
7171
displaying the shader output.
7272

7373
\subsection{Filter graph}
@@ -114,6 +114,27 @@ \subsection{Drivers}
114114

115115
This section allows you to configure default configurations for various instrument drivers.
116116

117+
\subsubsection{General}
118+
119+
\begin{itemize}
120+
\item \emph{Headless scope default state}: When connecting to a headless oscilloscope (one without a front panel
121+
display), specify the set of channels which should be shown after connecting.
122+
\end{itemize}
123+
124+
\subsubsection{Rigol DHO}
125+
126+
\begin{itemize}
127+
\item \emph{Data Width} (default on): Specifies whether to use 8 bit or 16 bit transfer format when downloading samples
128+
from the instrument, or automatically decide based on hardware configuration.
129+
\end{itemize}
130+
131+
\subsubsection{Siglent SDS HD}
132+
133+
\begin{itemize}
134+
\item \emph{Data Width} (default on): Specifies whether to use 8 bit or 16 bit transfer format when downloading samples
135+
from the instrument, or automatically decide based on hardware configuration.
136+
\end{itemize}
137+
117138
\subsubsection{Teledyne LeCroy}
118139

119140
\begin{itemize}
@@ -164,7 +185,8 @@ \subsubsection{Events}
164185
\section{Speed Bump}
165186
\label{dlg:speedbump}
166187

167-
The Speed Bump dialog is displayed when loading a session file, prior to committing changes to the instrument, if:
188+
The Speed Bump dialog is displayed when loading a session file online (reconnecting to and reconfiguring hardware),
189+
prior to committing changes to the instrument, if:
168190

169191
\begin{itemize}
170192
\item The session file contains any user-created notes on the lab setup

section-ng-mainwindow.tex

Lines changed: 36 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -70,12 +70,12 @@ \subsection{Add}
7070
\item \menustyle{BERT}\\
7171
Connect to a new, or recently used, bit error rate tester
7272

73+
\item \menustyle{Function Generator}\\
74+
Connect to a new, or recently used, function generator
75+
7376
\item \menustyle{Load}\\
7477
Connect to a new, or recently used, electronic load
7578

76-
\item \menustyle{Generator}\\
77-
Connect to a new, or recently used, function generator
78-
7979
\item \menustyle{Misc}\\
8080
Connect to a new, or recently used, miscellaneous instrument
8181

@@ -169,15 +169,6 @@ \subsection{Window}
169169
\item \menustyle{Power Supply}\\
170170
Opens the properties dialog for a currently connected power supply
171171

172-
\item \menustyle{SCPI Console}\\
173-
Opens a console window allowing you to send raw SCPI commands to a currently connected instrument.
174-
175-
This is a low level debug tool primarily intended for use by driver developers. The console is interlocked with
176-
background threads polling the instrument, so that replies to commands typed in the console will not be mixed with
177-
replies which the instrument driver is expecting to its own commands. However, commands sent in the console will bypass
178-
any caching in the driver and can easily lead to the driver and instrument firmware states becoming mutually
179-
inconsistent.
180-
181172
\item \menustyle{Lab Notes}\\
182173
Opens the \hyperref[dlg:labnotes]{Lab Notes} dialog, allowing you to take notes on your experiment.
183174

@@ -198,7 +189,16 @@ \subsection{Window}
198189
waveforms.
199190

200191
\item \menustyle{Filter Graph}\\
201-
Opens the filter graph editor (see Chapter \ref{grapheditor})
192+
Reopens the filter graph editor if it had been closed.
193+
194+
\item \menustyle{Stream Browser}\\
195+
Reopens the stream browser if it had been closed.
196+
197+
\item \menustyle{Filter Palette}\\
198+
Reopens the filter palette if it had been closed.
199+
200+
\item \menustyle{New Workspace}\\
201+
Create a new workspace to organize other windows in.
202202

203203
\end{itemize}
204204

@@ -208,13 +208,33 @@ \subsection{Debug}
208208

209209
Provides access to GUI toolkit test dialogs and other features intended only for developers.
210210

211+
\begin{itemize}
212+
213+
\item \menustyle{SCPI Console}\\
214+
Opens a console window allowing you to send raw SCPI commands to a currently connected instrument.
215+
216+
This is a low level debug tool primarily intended for use by driver developers. The console is interlocked with
217+
background threads polling the instrument, so that replies to commands typed in the console will not be mixed with
218+
replies which the instrument driver is expecting to its own commands. However, commands sent in the console will bypass
219+
any caching in the driver and can easily lead to the driver and instrument firmware states becoming mutually
220+
inconsistent.
221+
222+
\item \menustyle{ImGui Demo}\\
223+
224+
Launches a GUI library demo window allowing you to test out various widgets and features
225+
226+
\item \menustyle{Memory Leaker}\\
227+
228+
Allows you to allocate a large block of memory (up to 4GB per dialog instance, but multiple dialogs may be spawned) in
229+
order to induce video or system memory pressure.
230+
231+
\end{itemize}
232+
211233
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
212234

213235
\subsection{Help}
214236

215-
Nothing here yet, we should add at least an About dialog at some point...
216-
217-
%\textbf{About}: Displays program version and copyright information
237+
\textbf{About}: Displays program version and copyright information
218238

219239
\begin{comment}
220240
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

0 commit comments

Comments
 (0)