WIP, doc

python/slsdet/detector.py

@@ -550,6 +550,12 @@ class Detector(CppDetectorApi):
 
     @property
     def rx_datastream(self):
+        """
+        Enable/ disable data streaming from receiver via zmq (eg. to GUI or to another process for further processing). \n
+        This creates/ destroys zmq streamer threads in receiver. \n
+        Switching to Gui automatically enables data streaming in receiver. \n
+        Switching back to command line acquire will require disabling data streaming in receiver for fast applications.
+        """
         return element_if_equal(self.getRxZmqDataStream())
 
     @rx_datastream.setter
@@ -1286,6 +1292,22 @@ class Detector(CppDetectorApi):
 
     @property
     def rx_dbitlist(self):
+        """
+        [Ctb] List of digital signal bits read out. 
+        
+        Notes
+        -----
+        Each element in list can be 0 - 63 and must be non repetitive.
+
+        Examples
+        ---------
+        >>> d.rxdbitlist = [0, 1, 61, 9]
+        >>> d.rxdbitlist
+        [0, 1, 61, 9]
+        >>> d.rxdbitlist = []
+        >>> d.rxdbitlist
+        []
+        """
         return element_if_equal(self.getRxDbitList())
 
     @rx_dbitlist.setter

slsDetectorSoftware/include/Detector.h

@@ -728,6 +728,13 @@ class Detector {
 
     Result<bool> getRxZmqDataStream(Positions pos = {}) const;
 
+    /** Enable/ disable data streaming from receiver via zmq (eg. to GUI or to
+     * another process for further processing). \n This creates/ destroys zmq
+     * streamer threads in receiver. \n Switching to Gui automatically enables
+     * data streaming in receiver. \n Switching back to command line or API
+     * acquire will require disabling data streaming in receiver for fast
+     * applications (if not needed for client data call backs).
+     */
     void setRxZmqDataStream(bool value, Positions pos = {});
 
     Result<int> getRxZmqFrequency(Positions pos = {}) const;

slsDetectorSoftware/src/CmdProxy.h

@@ -1839,12 +1839,12 @@ class CmdProxy {
 
     INTEGER_COMMAND(
         rx_datastream, getRxZmqDataStream, setRxZmqDataStream, StringTo<int>,
-        "[0, 1]\n\tData streaming from receiver enable (eg. to GUI ot another "
-        "process for further processing). 1 enables zmq data stream (creates "
-        "zmq streamer threads), 0 disables (destroys streamer threads). "
-        "Switching to Gui automatically enables data streaming in receiver. "
-        "Switching back to command line acquire will require disabling data "
-        "streaming in receiver for fast applications.");
+        "[0, 1]\n\tEnable/ disable data streaming from receiver via zmq (eg. "
+        "to GUI or to another process for further processing). This creates/ "
+        "destroys zmq streamer threads in receiver. \n\tSwitching to Gui "
+        "automatically enables data streaming in receiver. \n\tSwitching back "
+        "to command line acquire will require disabling data streaming in "
+        "receiver for fast applications. ");
 
     INTEGER_COMMAND(
         rx_readfreq, getRxZmqFrequency, setRxZmqFrequency, StringTo<int>,