From 6fb2479178f55f89f4e494f06e31b3a9b5ae2e44 Mon Sep 17 00:00:00 2001 From: Dhanya Thattil Date: Fri, 9 Oct 2020 08:52:19 +0200 Subject: [PATCH] updated docs --- docs/src/quick_start_guide.rst | 9 +++++---- slsDetectorGui/forms/form_tab_plot.ui | 2 +- slsSupportLib/include/versionAPI.h | 4 ++-- 3 files changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/src/quick_start_guide.rst b/docs/src/quick_start_guide.rst index e35b499d5..1e17ebfc4 100644 --- a/docs/src/quick_start_guide.rst +++ b/docs/src/quick_start_guide.rst @@ -133,7 +133,8 @@ Compile with SLS_USE_GUI=ON in cmake or -g option in cmk.sh script. One can also .. note :: - | The streaming frequency (commmand: rx_zmqfreq) is set by default in the receiver to 1 (send every frame). - | At Gui startup, this value is set to 0. It will set to use a timer of 500 ms. Hence, every frame will not be streamed to the gui. This is done to reduce the load for fast and large detectors for display purposes. - | One can still change this setting in the gui in the Plot tab (Plotting frequency) or from the command line (rx_zmqfreq). - | First frame is always streamed out, no matter if timer or frequency is used. \ No newline at end of file + | The streaming high water mark (commmand: rx_zmqhwm) and the receiving high water mark (command: zmqhwm) is by default the lib zmq's default (currently 1000). + | At Gui startup, these values are set to 2. Hence, for very fast detectors, many frames will be dropped to be able to view the latest in the gui. + | One can still change this setting in the gui in the Plot tab (ZMQ Streaming), from the command line or API. + | Both hwm's can be set to a -1 to use the lib's default. + | Since the dummy end of acquisition packet streamed from receiver might also be lost, receiver restreams until gui acknowledges. \ No newline at end of file diff --git a/slsDetectorGui/forms/form_tab_plot.ui b/slsDetectorGui/forms/form_tab_plot.ui index 573ed181c..a8a125290 100755 --- a/slsDetectorGui/forms/form_tab_plot.ui +++ b/slsDetectorGui/forms/form_tab_plot.ui @@ -2008,7 +2008,7 @@ Displays minimum, maximum and sum of values for each plot. <html><head/><body><p>Sets the pace at which the receiver streams out images. Images in between the timeout or frequency are not sent out.<br/><br/><span style=" font-weight:600;">Time Interval</span>: Streaming time interval when an image should be streamed. <br/><span style=" font-weight:600;">Every nth Image</span>: Only every nth image is streamed. </p><p><br/></p><p><br/></p></body></html> - Receiver Streaming + ZMQ Streaming Qt::AlignLeading|Qt::AlignLeft|Qt::AlignVCenter diff --git a/slsSupportLib/include/versionAPI.h b/slsSupportLib/include/versionAPI.h index c44ff83d7..85f7078dc 100644 --- a/slsSupportLib/include/versionAPI.h +++ b/slsSupportLib/include/versionAPI.h @@ -1,5 +1,5 @@ /** API versions */ -#define GITBRANCH "5.0.0-rc2" +#define GITBRANCH "developer" #define APICTB 0x201008 #define APIGOTTHARD 0x201008 #define APIGOTTHARD2 0x201008 @@ -9,4 +9,4 @@ #define APIEIGER 0x201008 #define APILIB 0x201008 #define APIRECEIVER 0x201008 -#define APIGUI 0x201008 +#define APIGUI 0x201009