From ea5ac6ad0375f1b22179c185d4aa5785802c3ae0 Mon Sep 17 00:00:00 2001
From: Dhanya Thattil <dhanya.thattil@psi.ch>
Date: Tue, 20 Aug 2019 13:20:25 +0200
Subject: [PATCH] WIP

---
 slsDetectorSoftware/include/Detector.h                | 6 +++---
 slsDetectorSoftware/src/slsDetector.cpp               | 2 +-
 slsDetectorSoftware/src/slsDetectorCommand.cpp        | 6 +++---
 slsReceiverSoftware/src/slsReceiverImplementation.cpp | 2 +-
 4 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/slsDetectorSoftware/include/Detector.h b/slsDetectorSoftware/include/Detector.h
index 695266dea..386abfcb0 100644
--- a/slsDetectorSoftware/include/Detector.h
+++ b/slsDetectorSoftware/include/Detector.h
@@ -480,7 +480,7 @@ class Detector {
 
     Result<int> getFramesPerFile(Positions pos = {}) const;
 
-    /** -1 will set frames per file to unlimited //TODO check if it is -1 or 0 */
+    /** 0 will set frames per file to unlimited */
     void setFramesPerFile(int n, Positions pos = {});
 
 
@@ -500,8 +500,8 @@ class Detector {
     /** @param freq nth frame streamed out of receiver.
      * If 0, streaming timer is the timeout,
      * after which current frame sent out. Default is 0 at 200 ms.
-     * Default is 0. This is more for gui purposes to not send every frame.
-     * If you want every frame, set freq to 1.
+     * Default is 1: send every frame.
+     * If you want just to see some frames for gui purposes, set to 0 (200ms default timer).
      */
     void setRxZmqFrequency(int freq, Positions pos = {});
 
diff --git a/slsDetectorSoftware/src/slsDetector.cpp b/slsDetectorSoftware/src/slsDetector.cpp
index 226f31fc4..9e300c2f3 100755
--- a/slsDetectorSoftware/src/slsDetector.cpp
+++ b/slsDetectorSoftware/src/slsDetector.cpp
@@ -356,7 +356,7 @@ void slsDetector::initializeDetectorStructure(detectorType type) {
     shm()->rxZmqport = DEFAULT_ZMQ_RX_PORTNO +
                        (detId * ((shm()->myDetectorType == EIGER) ? 2 : 1));
     shm()->rxUpstream = false;
-    shm()->rxReadFreq = 0;
+    shm()->rxReadFreq = 1;
     shm()->zmqip = 0u;
     shm()->rxZmqip = 0u;
     shm()->gappixels = 0u;
diff --git a/slsDetectorSoftware/src/slsDetectorCommand.cpp b/slsDetectorSoftware/src/slsDetectorCommand.cpp
index 3a9e56f10..3dc96c33f 100755
--- a/slsDetectorSoftware/src/slsDetectorCommand.cpp
+++ b/slsDetectorSoftware/src/slsDetectorCommand.cpp
@@ -1826,7 +1826,7 @@ slsDetectorCommand::slsDetectorCommand(multiSlsDetector *det) {
     ++i;
 
     /*! \page receiver
-   - <b>rx_readfreq [i]</b> sets/gets the stream frequency of data from receiver to client. i > 0 is the nth frame being streamed. 0 sets frequency to a default timer (200ms). \c Returns \c (int)
+   - <b>rx_readfreq [i]</b> sets/gets the stream frequency of data from receiver to client. i > 0 is the nth frame being streamed. 0 sets frequency to a default timer (200ms). Default: sends every frame \c Returns \c (int)
 	 */
     descrToFuncMap[i].m_pFuncName = "rx_readfreq";
     descrToFuncMap[i].m_pFuncPtr = &slsDetectorCommand::cmdReceiver;
@@ -5076,7 +5076,7 @@ std::string slsDetectorCommand::helpReceiver(int action) {
     if (action == PUT_ACTION || action == HELP_ACTION) {
         os << "receiver [status] \t starts/stops the receiver to listen to detector packets. - can be start, stop." << std::endl;
         os << "resetframescaught [any value] \t resets frames caught by receiver" << std::endl;
-        os << "rx_readfreq \t sets the gui read frequency of the receiver, 0 if gui requests frame, >0 if receiver sends every nth frame to gui" << std::endl;
+        os << "rx_readfreq \t sets the gui read frequency of the receiver, 0 if gui requests frame, >0 if receiver sends every nth frame to gui. Default : 1" << std::endl;
         os << "tengiga \t sets system to be configure for 10Gbe if set to 1, else 1Gbe if set to 0" << std::endl;
         os << "rx_fifodepth [val]\t sets receiver fifo depth to val" << std::endl;
         os << "rx_silent [i]\t sets receiver in silent mode, ie. it will not print anything during real time acquisition. 1 sets, 0 unsets." << std::endl;
@@ -5093,7 +5093,7 @@ std::string slsDetectorCommand::helpReceiver(int action) {
         os << "receiver \t returns the status of receiver - can be running or idle" << std::endl;
         os << "framescaught \t returns the number of frames caught by receiver(average for multi)" << std::endl;
         os << "frameindex \t returns the current frame index of receiver(average for multi)" << std::endl;
-        os << "rx_readfreq \t returns the gui read frequency of the receiver" << std::endl;
+        os << "rx_readfreq \t returns the gui read frequency of the receiver. DEfault: 1" << std::endl;
         os << "tengiga \t returns 1 if the system is configured for 10Gbe else 0 for 1Gbe" << std::endl;
         os << "rx_fifodepth \t returns receiver fifo depth" << std::endl;
         os << "rx_silent \t returns receiver silent mode enable. 1 is silent, 0 not silent." << std::endl;
diff --git a/slsReceiverSoftware/src/slsReceiverImplementation.cpp b/slsReceiverSoftware/src/slsReceiverImplementation.cpp
index f4788a177..4791a66d7 100755
--- a/slsReceiverSoftware/src/slsReceiverImplementation.cpp
+++ b/slsReceiverSoftware/src/slsReceiverImplementation.cpp
@@ -107,7 +107,7 @@ void slsReceiverImplementation::InitializeMembers() {
     roi.xmin = -1;
     roi.xmax = -1;
     adcEnableMask = BIT32_MASK;
-    streamingFrequency = 0;
+    streamingFrequency = 1;
     streamingTimerInMs = DEFAULT_STREAMING_TIMER_IN_MS;
     dataStreamEnable = false;
     streamingPort = 0;