mirror of
https://github.com/slsdetectorgroup/slsDetectorPackage.git
synced 2025-04-23 23:10:02 +02:00
89 lines
5.3 KiB
TeX
89 lines
5.3 KiB
TeX
Commands to setup the network between client, detector and receiver
|
|
\begin{DoxyItemize}
|
|
\item {\bfseries rx\_\-hostname \mbox{[}s\mbox{]}} sets/gets the receiver hostname or IP address, configures detector mac with all network parameters and updates receiver with acquisition parameters. Normally used for single detectors (Can be multi-\/detector). {\ttfamily none} disables. If used, use as last network command in configuring detector MAC. {\ttfamily Returns} {\ttfamily }(string)
|
|
\end{DoxyItemize}
|
|
|
|
|
|
\begin{DoxyItemize}
|
|
\item {\bfseries rx\_\-udpip \mbox{[}ip\mbox{]}} sets/gets the ip address of the receiver UDP interface where the data from the detector will be streamed to. Normally used for single detectors (Can be multi-\/detector). Used if different from eth0. {\ttfamily Returns} {\ttfamily }(string)
|
|
\end{DoxyItemize}
|
|
|
|
|
|
\begin{DoxyItemize}
|
|
\item {\bfseries rx\_\-udpmac \mbox{[}mac\mbox{]}} sets/gets the mac address of the receiver UDP interface where the data from the detector will be streamed to. Normally used for single detectors (Can be multi-\/detector). {\ttfamily Returns} {\ttfamily }(string)
|
|
\end{DoxyItemize}
|
|
|
|
|
|
\begin{DoxyItemize}
|
|
\item {\bfseries rx\_\-udpport \mbox{[}port\mbox{]}} sets/gets the port of the receiver UDP interface where the data from the detector will be streamed to. Use single-\/detector command. {\ttfamily Returns} {\ttfamily }(int)
|
|
\end{DoxyItemize}
|
|
|
|
|
|
\begin{DoxyItemize}
|
|
\item {\bfseries rx\_\-udpport2 \mbox{[}port\mbox{]}} sets/gets the second port of the receiver UDP interface where the data from the second half of the detector will be streamed to. Use single-\/detector command. Used for EIGER only. {\ttfamily Returns} {\ttfamily }(int)
|
|
\end{DoxyItemize}
|
|
|
|
|
|
\begin{DoxyItemize}
|
|
\item {\bfseries detectormac \mbox{[}mac\mbox{]}} sets/gets the mac address of the detector UDP interface from where the detector will stream data. Use single-\/detector command. Normally unused. {\ttfamily Returns} {\ttfamily }(string)
|
|
\end{DoxyItemize}
|
|
|
|
|
|
\begin{DoxyItemize}
|
|
\item {\bfseries detectorip \mbox{[}ip\mbox{]}} sets/gets the ip address of the detector UDP interface from where the detector will stream data. Use single-\/detector command. Keep in same subnet as rx\_\-udpip (if rx\_\-udpip specified). {\ttfamily Returns} {\ttfamily }(string)
|
|
\end{DoxyItemize}
|
|
|
|
|
|
\begin{DoxyItemize}
|
|
\item {\bfseries txndelay\_\-left \mbox{[}delay\mbox{]}} sets/gets the transmission delay of first packet in an image being streamed out from the detector's left UDP port. Use single-\/detector command. Used for EIGER only. {\ttfamily Returns} {\ttfamily }(int)
|
|
\end{DoxyItemize}
|
|
|
|
|
|
\begin{DoxyItemize}
|
|
\item {\bfseries txndelay\_\-right \mbox{[}delay\mbox{]}} sets/gets the transmission delay of first packet in an image being streamed out from the detector's right UDP port. Use single-\/detector command. Used for EIGER only. {\ttfamily Returns} {\ttfamily }(int)
|
|
\end{DoxyItemize}
|
|
|
|
|
|
\begin{DoxyItemize}
|
|
\item {\bfseries txndelay\_\-frame \mbox{[}delay\mbox{]}} sets/gets the transmission frame period of entire frame being streamed out from the detector for both ports. Use single-\/detector command. Used for EIGER only. {\ttfamily Returns} {\ttfamily }(int)
|
|
\end{DoxyItemize}
|
|
|
|
|
|
\begin{DoxyItemize}
|
|
\item {\bfseries flowcontrol\_\-10g \mbox{[}delay\mbox{]}} Enables/disables 10 GbE flow control. 1 enables, 0 disables. Used for EIGER only. {\ttfamily Returns} {\ttfamily }(int)
|
|
\end{DoxyItemize}
|
|
|
|
|
|
\begin{DoxyItemize}
|
|
\item {\bfseries zmqport \mbox{[}port\mbox{]}} sets/gets the 0MQ (TCP) port of the receiver from where data is streamed to the client. Use single-\/detector command to set individually or multi-\/detector command to calculate based on {\ttfamily port} for the rest. {\ttfamily Returns} {\ttfamily }(int)
|
|
\end{DoxyItemize}
|
|
|
|
|
|
\begin{DoxyItemize}
|
|
\item {\bfseries configuremac \mbox{[}i\mbox{]}} configures the MAC of the detector with these parameters: detectorip, detectormac, rx\_\-udpip, rx\_\-udpmac, rx\_\-udpport, rx\_\-udpport2 (if applicable). This command is already included in {\ttfamily rx\_\-hsotname}. Only put!. {\ttfamily Returns} {\ttfamily }(int)
|
|
\end{DoxyItemize}
|
|
|
|
|
|
\begin{DoxyItemize}
|
|
\item {\bfseries rx\_\-tcpport \mbox{[}port\mbox{]}} sets/gets the port of the client-\/receiver TCP interface. Use single-\/detector command. Is different for each detector if same {\ttfamily rx\_\-hostname} used. Must be first command to communicate with receiver. {\ttfamily Returns} {\ttfamily }(int)
|
|
\end{DoxyItemize}
|
|
|
|
|
|
\begin{DoxyItemize}
|
|
\item {\bfseries port \mbox{[}port\mbox{]}} sets/gets the port of the client-\/detector control server TCP interface. Use single-\/detector command. Default value is 1952 for all detectors. Normally not changed. {\ttfamily Returns} {\ttfamily }(int)
|
|
\end{DoxyItemize}
|
|
|
|
|
|
\begin{DoxyItemize}
|
|
\item {\bfseries stopport \mbox{[}port\mbox{]}} sets/gets the port of the client-\/detector stop server TCP interface. Use single-\/detector command. Default value is 1953 for all detectors. Normally not changed. {\ttfamily Returns} {\ttfamily }(int)
|
|
\end{DoxyItemize}
|
|
|
|
|
|
\begin{DoxyItemize}
|
|
\item {\bfseries lock \mbox{[}i\mbox{]}} Locks/Unlocks the detector to communicate with this client. 1 locks, 0 unlocks. {\ttfamily Returns} {\ttfamily }(int)
|
|
\end{DoxyItemize}
|
|
|
|
|
|
\begin{DoxyItemize}
|
|
\item {\bfseries lastclient } Gets the last client communicating with the detector. Cannot put!. {\ttfamily Returns} {\ttfamily }(string)
|
|
\end{DoxyItemize} |