WIp, doc

python/slsdet/detector.py

@@ -809,6 +809,17 @@ class Detector(CppDetectorApi):
 
     @property
     def udp_dstip(self):
+        """
+        Ip address of the receiver (destination) udp interface. 
+        Note
+        ----
+        If 'auto' used, then ip is set to ip of rx_hostname.
+        Example
+        ------
+        >>> d.udp_dstip = '192.168.1.110'
+        >>> d.udp_dstip
+        192.168.1.110
+        """
         return element_if_equal(self.getDestinationUDPIP())
 
     @udp_dstip.setter
@@ -819,6 +830,19 @@ class Detector(CppDetectorApi):
 
     @property
     def udp_dstip2(self):
+        """
+        [Jungfrau][Gotthard2] Ip address of the receiver (destination) udp interface 2.
+        Note
+        ----
+        [Jungfrau] bottom half \n
+        [Gotthard2] veto debugging \n
+        If 'auto' used, then ip is set to ip of rx_hostname.
+        Example
+        ------
+        >>> d.udp_dstip2 = '10.1.1.185'
+        >>> d.udp_dstip2
+        10.1.1.185
+        """
         return element_if_equal(self.getDestinationUDPIP2())
 
     @udp_dstip2.setter
@@ -829,6 +853,17 @@ class Detector(CppDetectorApi):
 
     @property
     def udp_dstmac(self):
+        """
+        Mac address of the receiver (destination) udp interface. 
+        Note
+        ----
+        Not mandatory to set as udp_dstip retrieves it from slsReceiver process but must be set if you use a custom receiver (not slsReceiver).
+        Example
+        -------
+        >>> d.udp_dstmac = '00:1b:31:01:8a:de'
+        d.udp_dstmac
+        00:1b:31:01:8a:de
+        """
         return element_if_equal(self.getDestinationUDPMAC())
 
     @udp_dstmac.setter
@@ -837,6 +872,19 @@ class Detector(CppDetectorApi):
 
     @property
     def udp_dstmac2(self):
+        """
+        [Jungfrau][Gotthard2] Mac address of the receiver (destination) udp interface 2.
+        Note
+        ----
+        Not mandatory to set as udp_dstip2 retrieves it from slsReceiver process but must be set if you use a custom receiver (not slsReceiver).
+        [Jungfrau] bottom half \n
+        [Gotthard2] veto debugging \n
+        Example
+        ------
+        >>> d.udp_dstmac2 = '00:1b:31:01:8a:de'
+        d.udp_dstmac2
+        00:1b:31:01:8a:de
+        """
         return element_if_equal(self.getDestinationUDPMAC2())
 
     @udp_dstmac2.setter

slsDetectorSoftware/include/Detector.h

@@ -551,24 +551,28 @@ class Detector {
     /** IP of the interface in receiver that the detector sends data to */
     void setDestinationUDPIP(const IpAddr ip, Positions pos = {});
 
-    /** [Jungfrau bottom half] */
+    /** [Jungfrau] bottom half \n [Gotthard2] veto debugging */
     Result<IpAddr> getDestinationUDPIP2(Positions pos = {}) const;
 
-    /** [Jungfrau bottom half] */
+    /** [Jungfrau] bottom half \n [Gotthard2] veto debugging */
     void setDestinationUDPIP2(const IpAddr ip, Positions pos = {});
 
     Result<MacAddr> getDestinationUDPMAC(Positions pos = {}) const;
 
-    /** MAC of the interface in receiver that the detector sends data to
+    /** Mac address of the receiver (destination) udp interface. Not mandatory
-     * Only needed if you use a custom receiver (not slsReceiver)
+     * to set as setDestinationUDPIP (udp_dstip) retrieves it from slsReceiver
-     * Must be followed by configuremac.
+     * process but must be set if you use a custom receiver (not slsReceiver).
      */
     void setDestinationUDPMAC(const MacAddr mac, Positions pos = {});
 
-    /** [Jungfrau bottom half] */
+    /** [Jungfrau] bottom half \n [Gotthard2] veto debugging */
     Result<MacAddr> getDestinationUDPMAC2(Positions pos = {}) const;
 
-    /** [Jungfrau bottom half] */
+    /* [Jungfrau][Gotthard2] Mac address of the receiver (destination) udp
+    interface 2. \n Not mandatory to set as udp_dstip2 retrieves it from
+    slsReceiver process but must be set if you use a custom receiver (not
+    slsReceiver). \n [Jungfrau] bottom half \n [Gotthard2] veto debugging \n
+    */
     void setDestinationUDPMAC2(const MacAddr mac, Positions pos = {});
 
     Result<int> getDestinationUDPPort(Positions pos = {}) const;

slsDetectorSoftware/src/CmdProxy.cpp

@@ -1112,10 +1112,10 @@ std::string CmdProxy::UDPDestinationIP2(int action) {
     std::ostringstream os;
     os << cmd << ' ';
     if (action == defs::HELP_ACTION) {
-        os << "[x.x.x.x] or auto\n\t[Jungfrau] Ip address of the receiver "
+        os << "[x.x.x.x] or auto\n\t[Jungfrau][Gotthard2] Ip address of the "
-              "(destination) udp interface where the second half of detector "
+              "receiver (destination) udp interface 2. If 'auto' used, then ip "
-              "data is sent to. If 'auto' used, then ip is set to ip of "
+              "is set to ip of rx_hostname.\n\t[Jungfrau] bottom half "
-              "rx_hostname."
+              "\n\t[Gotthard2] veto debugging. "
            << '\n';
     } else if (action == defs::GET_ACTION) {
         auto t = det->getDestinationUDPIP2({det_id});

slsDetectorSoftware/src/CmdProxy.h

@@ -1687,13 +1687,17 @@ class CmdProxy {
     INTEGER_COMMAND(
         udp_dstmac, getDestinationUDPMAC, setDestinationUDPMAC, MacAddr,
         "[x:x:x:x:x:x]\n\tMac address of the receiver (destination) udp "
-        "interface. Can be unused as udp_dstip retrieves it.");
+        "interface. Not mandatory to set as udp_dstip retrieves it from "
+        "slsReceiver process, but must be set if you use a custom receiver "
+        "(not slsReceiver).");
 
     INTEGER_COMMAND(
         udp_dstmac2, getDestinationUDPMAC2, setDestinationUDPMAC2, MacAddr,
         "[x:x:x:x:x:x]\n\t[Jungfrau] Mac address of the receiver (destination) "
-        "udp interface where the second half of detector data is sent to. Can "
+        "udp interface 2. Not mandatory to set as udp_dstip2 retrieves it from "
-        "be unused as udp_dstip2 retrieves it.");
+        "slsReceiver process but must be set if you use a custom receiver (not "
+        "slsReceiver). \n [Jungfrau] bottom half \n [Gotthard2] veto debugging "
+        "\n");
 
     INTEGER_COMMAND(udp_dstport, getDestinationUDPPort, setDestinationUDPPort,
                     StringTo<int>,