mirror of
https://github.com/slsdetectorgroup/slsDetectorPackage.git
synced 2025-06-23 10:07:59 +02:00
command line docu. more coming up
This commit is contained in:
@ -2,7 +2,17 @@ Commands to control the acquisition
|
||||
|
||||
|
||||
\begin{DoxyItemize}
|
||||
\item {\bfseries acquire} blocking acquisition (like calling sls\_\-detector\_\-acquire). Starts receiver and detector, writes and processes the data, stops detector. Only get!
|
||||
\item {\bfseries acquire} blocking acquisition (like calling sls\_\-detector\_\-acquire). Starts receiver and detector, writes and processes the data, stops detector. Only get! {\ttfamily Returns} (string){\ttfamily \char`\"{}acquire unsuccessful\char`\"{}} if fails, else \char`\"{}\char`\"{} for MYTHEN, {\ttfamily \char`\"{}Acquired (int)\char`\"{}} for others, where int is number of frames caught.
|
||||
\end{DoxyItemize}
|
||||
|
||||
|
||||
\begin{DoxyItemize}
|
||||
\item {\bfseries busy} returns {\ttfamily 1} if the acquisition is active, {\ttfamily 0} otherwise. Works when the acquisition is started in blocking mode. Only get! {\ttfamily Returns} {\ttfamily }(int)
|
||||
\end{DoxyItemize}
|
||||
|
||||
|
||||
\begin{DoxyItemize}
|
||||
\item {\bfseries status \mbox{[}s\mbox{]} } starts or stops acquisition in detector in non blocking mode. {\ttfamily s:} \mbox{[}{\ttfamily start}, {\ttfamily stop}\mbox{]}. {\ttfamily Returns} the detector status: \mbox{[}{\ttfamily running}, {\ttfamily error}, {\ttfamily transmitting}, {\ttfamily finished}, {\ttfamily waiting}, {\ttfamily idle}\mbox{]}. {\ttfamily Returns} {\ttfamily }(string)
|
||||
\end{DoxyItemize}
|
||||
|
||||
|
||||
@ -16,16 +26,6 @@ Commands to control the acquisition
|
||||
\end{DoxyItemize}
|
||||
|
||||
|
||||
\begin{DoxyItemize}
|
||||
\item {\bfseries status} {\ttfamily returns} the detector status (string)-\/ can be: {\ttfamily running}, {\ttfamily error}, {\ttfamily transmitting}, {\ttfamily finished}, {\ttfamily waiting} or {\ttfamily idle}; {\ttfamily put} can be {\ttfamily start} or {\ttfamily stop}
|
||||
\end{DoxyItemize}
|
||||
|
||||
|
||||
\begin{DoxyItemize}
|
||||
\item {\bfseries busy} returns {\ttfamily 1} if the acquisition is active, {\ttfamily 0} otherwise. Works when the acquisition is started in non-\/blocking mode. Only get!
|
||||
\end{DoxyItemize}
|
||||
|
||||
|
||||
\begin{DoxyItemize}
|
||||
\item {\bfseries readctr } Reads the counters from the detector memory (analog detector returning values translated into number of photons -\/ only GOTTHARD). Cannot put.
|
||||
\end{DoxyItemize}
|
||||
|
Reference in New Issue
Block a user