Merge pull request #1178 from slsdetectorgroup/main_910/conda_build_fix

fixed conda build

CMakeFiles/cmake.check_cache

@@ -1 +0,0 @@
-# This file is generated by cmake for dependency checking of the CMakeCache.txt file

CMakeLists.txt

@@ -249,8 +249,8 @@ endif()
 if(SLS_USE_SANITIZER)
     target_compile_options(slsProjectOptions INTERFACE -fsanitize=address,undefined -fno-omit-frame-pointer)
     target_link_libraries(slsProjectOptions INTERFACE -fsanitize=address,undefined)
-    # target_compile_options(slsProjectOptions INTERFACE -fsanitize=thread)
-    # target_link_libraries(slsProjectOptions INTERFACE -fsanitize=thread)
+    #target_compile_options(slsProjectOptions INTERFACE -fsanitize=thread -fno-omit-frame-pointer)
+    #target_link_libraries(slsProjectOptions INTERFACE -fsanitize=thread)
 endif()
 
 

RELEASE.txt

@@ -1,21 +1,15 @@
-SLS Detector Package Major Release x.x.x released on xx.xx.202x
+SLS Detector Package Minor Release 9.1.0 released on 28.03.2025
 ===============================================================
 
-This document describes the differences between vx.x.x and vx.0.2   
+This document describes the differences between v9.1.0 and v9.0.0   
 
 
 
     CONTENTS
     --------
-    1           New, Changed or Resolved Features
-        1.1     Compilation
-        1.2     Callback
-        1.3     Python
-        1.4     Client
-        1.5     Detector Server
-        1.6     Simulator
-        1.7     Receiver
-        1.8     Gui
+    1           Changes
+        1.1     New or Changed Features
+        1.2     Resolved Features
     2           On-board Detector Server Compatibility
     3           Firmware Requirements
     4           Kernel Requirements
@@ -24,11 +18,131 @@ This document describes the differences between vx.x.x and vx.0.2
 
 
 
-1 New, Changed or Resolved Features
-=====================================
+1 Changes
+==========
 
 
+
+1.1 New or Changed Features
+============================
+
+
+    Receiver
+    --------
+
+
+    *   Frame Synchronizer (experimental)
+        Added a new binary, similar to slsMultiReceiver, to collect images from
+        several receivers and stream them out as a ZMQ  multipart message 
+        (one part for each UDP port). No reconstuction of the image. Includeds start 
+        and end ZMQ messages as well for the start and end callback parameters.
+
+
+    Documentation
+    -------------
+
+
+    *   Command line - multi module and multi detector indices
+        Help on this topic has been added to the 'Command line' topic.
+
+
+    *   Row and column index (UDP header or callback)
+        Help on how this is determined from the hostname is added to the 'UDP
+        Header' and the 'Quick Start Guide' topics. Also added to the help in '
+        hostname' command line help. Please note that this can be overwritten by
+        corresponding row and column commands.
+
+
+
+1.2 Resolved Features 
+======================
+
+
+    Firmware
+    ---------
+
+
+    *   [Jungfrau] Column select and filter resistor
+        Configuration fix for chip v1.1 for these parameters
+
+
+    Firmware &/ On-board Detector Server
+    ------------------------------------
+
+
+    *   [Jungfrau] Timing Info Decoder 
+        Only allowed for hardware v2.0 now.
+
+
+    *   [Jungfrau] Auto Comparator Disable - chip v1.0
+        Previously, this mode for chip v1.0 automatically disabled the on-chip
+        gain switching compatator after a fixed portion of the exposure time.
+        Now, one must set also the comparator disable time using 'compdisabletime'
+        just as in chip v1.1.
+
+
+    *   [Mythen3] Default period on server start up is 0 now.
+        
+
+    Client
+    -------
+
+
+    *   Command line - Multi detector index inside file
+        Multi detector index '[index]-' was ignored silently in the config/parameter
+        file since 5.0.0. Now, it will throw an exception. Please use the multi
+        detector index on the 'config' or 'parameter' command instead.
+
+
+    *   [Mythen3] patternX command autocompletes the argument to a path now.
+
+
+    Receiver
+    --------
+
+
+    *   Multiple Receiver objects in multiple threads
+        slsMultiReceiver uses child processes, but if user rewrote to use multiple
+        receiver objects in multiple threads instead, a callback mutex is now
+        implemented to handle the locking mechanism between threads for the callbacks. 
+
+
+    *   Removed potentially unsafe str().c_str() calls.
+
+
+    *   slsMultiReceiver Ctrl + C
+        Now cleans up properly upon Ctrl + C, including exiting the Arping thread.
+
+    
+    *   slsMultiReceiver version
+        --version or -v now gives the version of slsMultiReceiver.
+
  
+    ZMQ
+    ---
+
+
+    *   [Moench] Reduced significant print out in zmq processing using energy
+        threshold.
+
+
+    *   [Moench] Zmq dummy packet restreaming command did nothing
+        Temporary solution was to move from 'stop' to 'rx_stop' as 'stop' did not
+        go further if module is idle.
+
+
+    *   [Moench] Too many Zmq dummy packets- unclear end in acquire
+        Give time to process dummy packet before restreaming it and wait more 
+        before restreaming to reduce amoutn of zmq dummy packets to process.
+
+
+    Simulators
+    -----------
+
+
+    *   [Jungfrau][Moench] Slightly faster transmistting time by removing sleeping
+        only if there is a transmission delay
+
 
 
 2  On-board Detector Server Compatibility
@@ -36,8 +150,8 @@ This document describes the differences between vx.x.x and vx.0.2
 
 
     Eiger       9.0.0
-    Jungfrau    9.0.0
-    Mythen3     9.0.0
+    Jungfrau    9.1.0
+    Mythen3     9.1.0
     Gotthard2   9.0.0
     Gotthard    9.0.0
     Moench      9.0.0
@@ -66,14 +180,14 @@ This document describes the differences between vx.x.x and vx.0.2
 
     Eiger       02.10.2023 (v32)                    (updated in 7.0.3)
     
-    Jungfrau    20.09.2023 (v1.5, HW v1.0)          (updated in 8.0.0)
-                21.09.2023 (v2.5, HW v2.0)          (updated in 8.0.0)
+    Jungfrau    09.02.2025 (v1.6, HW v1.0)          (updated in 9.1.0)
+                08.02.2025 (v2.6, HW v2.0)          (updated in 9.1.0)
 
-    Mythen3     11.10.2024 (v1.5)                   (updated in 9.0.0)
+    Mythen3     13.11.2024 (v2.0)                   (updated in 9.0.0)
 
     Gotthard2   03.10.2024 (v1.0)                   (updated in 9.0.0)
 
-    Moench      26.10.2023 (v2.0)                   (updated in 9.0.0)
+    Moench      26.10.2023 (v2.0)                   (updated in 8.0.2)
 
     Gotthard    08.02.2018 (50um and 25um Master)
                 09.02.2018 (25 um Slave) 

VERSION

@@ -1 +1 @@
-0.0.0
+9.1.0

conda-recipe/conda_build_config.yaml

@@ -6,3 +6,9 @@ python:
     - 3.12
     - 3.13
 
+
+c_stdlib:
+  - sysroot                    # [linux]
+
+c_stdlib_version:              # [linux]
+  - 2.17                       # [linux]

conda-recipe/meta.yaml

@@ -15,36 +15,19 @@ build:
 requirements:
   build:
     - {{ compiler('c') }}
+    - {{stdlib('c')}}
     - {{compiler('cxx')}}
-    - cmake
+    - cmake<=3.28
+    - ninja
     - qt 5.*
-    - xorg-libx11
-    - xorg-libice
-    - xorg-libxext
-    - xorg-libsm
-    - xorg-libxau
-    - xorg-libxrender
-    - xorg-libxfixes
-    - {{ cdt('mesa-libgl-devel') }}      # [linux]
-    - {{ cdt('mesa-libegl-devel') }}     # [linux]
-    - {{ cdt('mesa-dri-drivers') }}      # [linux]
-    - {{ cdt('libselinux') }}            # [linux]
-    - {{ cdt('libxdamage') }}            # [linux]
-    - {{ cdt('libxxf86vm') }}            # [linux]
-    - expat
 
   host:
     - libstdcxx-ng
     - libgcc-ng
-    - xorg-libx11
-    - xorg-libice
-    - xorg-libxext
-    - xorg-libsm
-    - xorg-libxau
-    - xorg-libxrender
-    - xorg-libxfixes
-    - expat
-
+    - libgl-devel
+    - libtiff
+    - zlib
+  
   run:
     - libstdcxx-ng
     - libgcc-ng 
@@ -123,3 +106,4 @@ outputs:
       run:
         - {{ pin_subpackage('slsdetlib', exact=True) }}
         - expat
+

docs/conf.py.in

@@ -63,4 +63,4 @@ html_static_path = ['static']
 
 
 def setup(app):
-    app.add_stylesheet('css/extra.css')  # may also be an URL
+    app.add_css_file('css/extra.css')  # may also be an URL

docs/src/commandline.rst

@@ -4,11 +4,54 @@ Command line interface
 Usage
 -------------
 
-Commands can be used either with sls_detector_get or sls_detector_put
+The syntax is *'[detector index]-[module index]:[command]'*, where the indices are by default '0', when not specified.
+
+Module index
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Modules are indexed based on their order in the hostname command. They are used to configure a specific module within a detector and are followed by a ':' in syntax.
+
+    .. code-block::
+
+        # Applies to all modules of detector 0
+        sls_detector_put exptime 5s
+
+        # Applies to only the 4th module
+        sls_detector_put 3:exptime 5s
+
+
+Detector index
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+This index is useful when configuring multiple detectors from a single host. Each detector uses a unique shared memory identified by a detector index, derived again from the hostname command. It is followed by a '-'. 
+
+    .. code-block::
+
+        # For detector with index 2 in shared memory
+        sls_detector_put 2-hostname bchip133+bchip123+bchip456
+        
+        # Without '-', the detector index defaults to 0
+        sls_detector_put hostname bchip133+bchip123+bchip456
+
+        # Accessing all modules with detector index 2
+        sls_detector_put 2-exptime
+
+        # Starting acquisition only for detector with index 2
+        sls_detector_put 2-start
+
+        # Applies only to the 2nd detector, 4th module
+        sls_detector_put 1-3:exptime 5s
+
+
+Command Execution
+^^^^^^^^^^^^^^^^^^^^^^^
+Commands can be executed using:
+
+*   **sls_detector_put**: setting values
+*   **sls_detector_get**: getting values
+*   **sls_detector**: automatically infers based on the number of arguments.
+*   **sls_detector_help**: gets help on the specific command
+*   **sls_detector_acquire**: initiates acquisition with the detector. This command blocks until the entire acquisition process is completed.
 
-.. code-block::
 
-    sls_detector_get exptime
 
 Help
 --------
@@ -28,12 +71,15 @@ Help
     # list of deprecated commands
     list deprecated
 
-    # autocompletion
-    # bash_autocomplete.sh or zsh_autocomplete.sh must be sourced from the 
-    # main package folder to enable auto completion of commands and arguments 
-    # for the command line on that shell.
-    source bash_autocomplete.sh
 
+Autocompletion
+---------------
+
+bash_autocomplete.sh or zsh_autocomplete.sh must be sourced from the main package folder to enable auto completion of commands and arguments for the command line on that shell.
+
+.. code-block::
+
+    source bash_autocomplete.sh
   
 
 Commands

docs/src/detector.rst

@@ -13,7 +13,6 @@ containing results from all modules. (:ref:`Result class<Result Class>`)
 
 Here are some :ref:`examples <Cplusplus Api Examples>` on how to use the API.
 
-.. _Cplusplus Api Examples:
 .. doxygenclass:: sls::Detector
    :members:
    :undoc-members:

docs/src/index.rst

@@ -39,7 +39,7 @@ Welcome to slsDetectorPackage's documentation!
 
 .. toctree::
     :caption: Command line
-    :maxdepth: 2
+    :maxdepth: 1
 
     commandline  
     quick_start_guide

docs/src/masterfileattributes.rst

@@ -1,5 +1,6 @@
 
 .. _master file attributes:
+
 Master File Attributes
 =======================
 

docs/src/quick_start_guide.rst

@@ -128,6 +128,10 @@ For Multiple Modules
         # set file path
         fpath /tmp
 
+.. note ::   
+    The **hostname** and **detsize** command in a multi module system can affect the row and column values in the udp/zmq header. The modules are stacked row by row until they reach the y-axis limit set by detsize (if specified). Then, stacking continues in the next column and so on. 
+
+    
 Gui
 ----
 

docs/src/servers.rst

@@ -39,13 +39,13 @@ Arguments
 
 
 .. _Automatic start servers:
+
 Automatic start 
 ------------------
 
 One can start the on-board detector server automatically upon powering on the board.
 
-#. Create a soft link to the binary on board 
-   :
+#. Create a soft link to the binary on board:
       .. code-block:: bash
       
          ln -sf someDetectorServervx.x.x someDetectorServer
@@ -87,8 +87,7 @@ One can start the on-board detector server automatically upon powering on the bo
          /root/xxxDetectorServer >> /dev/null &
 
 
-#. Sync, reboot and verify
-   :
+#. Sync, reboot and verify:
       .. code-block:: bash
       
          sync

docs/src/udpheader.rst

@@ -73,9 +73,9 @@ Description
 
 * **modId**: module ID picked up from det_id_[detector type].txt on the detector cpu.
 
-* **row**: row position of the module in the detector system. It is calculated by the order of the module in hostname command, as well as the detsize command.
+* **row**: row position of the module in the detector system. It is calculated by the order of the module in hostname command, as well as the detsize command. The modules are stacked row by row until they reach the y-axis limit set by detsize (if specified). Then, stacking continues in the next column and so on.
 
-* **column**: column position of the module in the detector system.  It is calculated by the order of the module in hostname command, as well as the detsize command.
+* **column**: column position of the module in the detector system.  It is calculated by the order of the module in hostname command, as well as the detsize command. The modules are stacked row by row until they reach the y-axis limit set by detsize (if specified). Then, stacking continues in the next column and so on.
 
 * **detType**: detector type from enum of detectorType in the package.
 

python/scripts/frameSynchronizerPullSocket.py

@@ -0,0 +1,19 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
+# Script to get combined zmq packets from frame synchronizer using pull zmq sockets
+import json
+import zmq
+
+c = zmq.Context()
+s = c.socket(zmq.PULL)
+s.connect("tcp://127.0.0.1:5555")
+
+while True:
+     m = s.recv_multipart()
+     for p in m:
+         if p.startswith(b"{"):
+             print(p.decode().strip())
+         else:
+             print("binary")
+     print("--------")
+

python/scripts/generate_functions.py

@@ -123,6 +123,9 @@ def visit(node):
     if node.kind == cindex.CursorKind.CLASS_DECL:
         if node.displayname == "Detector":
             for child in node.get_children():
+                # Skip assignment operators
+                if child.kind == cindex.CursorKind.CXX_METHOD and child.spelling == "operator=":
+                    continue
                 if (
                     child.kind == cindex.CursorKind.CXX_METHOD
                     and child.access_specifier == cindex.AccessSpecifier.PUBLIC

python/slsdet/detector.py

@@ -151,6 +151,10 @@ class Detector(CppDetectorApi):
     def hostname(self):
         """Frees shared memory and sets hostname (or IP address) of all modules concatenated by + 
         Virtual servers can already use the port in hostname separated by ':' and ports incremented by 2 to accomodate the stop server as well.
+
+        Note
+        -----
+        The row and column values in the udp/zmq header are affected by the order in this command and the detsize command. The modules are stacked row by row until they reach the y-axis limit set by detsize (if specified). Then, stacking continues in the next column and so on. This only affects row and column in udp/zmq header.
         
         Example
         -------
@@ -2566,7 +2570,7 @@ class Detector(CppDetectorApi):
 
         Note
         -----
-        By default, the on-chip gain switching is active during the entire exposure. This mode disables the on-chip gain switching comparator automatically after 93.75% of exposure time (only for longer than 100us). The % is only for chipv1.0, the duration can be set for chipv1.1.\n
+        By default, the on-chip gain switching is active during the entire exposure. This mode disables the on-chip gain switching comparator automatically and the duration is set using compdisabletime.\n
         Default is 0 or this mode disabled (comparator enabled throughout). 1 enables mode. 0 disables mode. 
         """
         return self.getAutoComparatorDisable()
@@ -2580,10 +2584,6 @@ class Detector(CppDetectorApi):
     def compdisabletime(self):
         """[Jungfrau] Time before end of exposure when comparator is disabled. 
 
-        Note
-        -----
-        It is only possible for chipv1.1.
-
         :getter: always returns in seconds. To get in DurationWrapper, use getComparatorDisableTime
 
         Example
@@ -2913,7 +2913,7 @@ class Detector(CppDetectorApi):
     @property
     @element
     def timing_info_decoder(self):
-        """[Jungfrau] [Jungfrau] Advanced Command and only for SWISSFEL and SHINE. Sets the bunch id or timing info decoder. Default is SWISSFEL.
+        """[Jungfrau] [Jungfrau] Advanced Command and only for SWISSFEL and SHINE. Sets the bunch id or timing info decoder. Default is SWISSFEL. Only allowed for pcbv2.0.
         Enum: timingInfoDecoder
         """
         return self.getTimingInfoDecoder()

serverBin/ctbDetectorServer_developer

@@ -1 +0,0 @@
-../slsDetectorServers/ctbDetectorServer/bin/ctbDetectorServer_developer

serverBin/ctbDetectorServerv9.1.0

@@ -0,0 +1 @@
+../slsDetectorServers/ctbDetectorServer/bin/ctbDetectorServerv9.1.0

serverBin/eigerDetectorServer_developer

@@ -1 +0,0 @@
-../slsDetectorServers/eigerDetectorServer/bin/eigerDetectorServer_developer

serverBin/eigerDetectorServerv9.0.0

@@ -0,0 +1 @@
+../slsDetectorServers/eigerDetectorServer/bin/eigerDetectorServerv9.0.0

serverBin/gotthard2DetectorServer_developer

@@ -1 +0,0 @@
-../slsDetectorServers/gotthard2DetectorServer/bin/gotthard2DetectorServer_developer

serverBin/gotthard2DetectorServerv9.0.0

@@ -0,0 +1 @@
+../slsDetectorServers/gotthard2DetectorServer/bin/gotthard2DetectorServerv9.0.0

serverBin/gotthardDetectorServer_developer

@@ -1 +0,0 @@
-../slsDetectorServers/gotthardDetectorServer/bin/gotthardDetectorServer_developer

serverBin/gotthardDetectorServerv9.0.0

@@ -0,0 +1 @@
+../slsDetectorServers/gotthardDetectorServer/bin/gotthardDetectorServerv9.0.0

serverBin/jungfrauDetectorServer_developer

@@ -1 +0,0 @@
-../slsDetectorServers/jungfrauDetectorServer/bin/jungfrauDetectorServer_developer

serverBin/jungfrauDetectorServerv9.1.0

@@ -0,0 +1 @@
+../slsDetectorServers/jungfrauDetectorServer/bin/jungfrauDetectorServerv9.1.0

serverBin/moenchDetectorServer_developer

@@ -1 +0,0 @@
-../slsDetectorServers/moenchDetectorServer/bin/moenchDetectorServer_developer

serverBin/moenchDetectorServerv9.0.0

@@ -0,0 +1 @@
+../slsDetectorServers/moenchDetectorServer/bin/moenchDetectorServerv9.0.0

serverBin/mythen3DetectorServer_developer

@@ -1 +0,0 @@
-../slsDetectorServers/mythen3DetectorServer/bin/mythen3DetectorServer_developer

serverBin/mythen3DetectorServerv9.1.0

@@ -0,0 +1 @@
+../slsDetectorServers/mythen3DetectorServer/bin/mythen3DetectorServerv9.1.0

serverBin/xilinx_ctbDetectorServerv9.1.0

@@ -0,0 +1 @@
+../slsDetectorServers/xilinx_ctbDetectorServer/bin/xilinx_ctbDetectorServerv9.1.0

slsDetectorCalibration/singlePhotonDetector.h

@@ -503,6 +503,7 @@ class singlePhotonDetector : public analogDetector<uint16_t> {
                 }
 #endif
                 if (ee == PHOTON && val[iy * nx + ix] == max) {
+                    good = 1;
                     ee = PHOTON_MAX;
                     // cout << "**" <<id<< " " << iframe << " "  << nDark << " "
                     // << ix << " " << iy << " " << rms << " " << max << " " <<
@@ -536,7 +537,6 @@ class singlePhotonDetector : public analogDetector<uint16_t> {
 		      cout << max << " " <<  val[iy * nx + ix] << endl;
 		    }
 		    //else (clusters + nph)->print();
-                    good = 1;
                     if (eMin > 0 && tot < eMin)
                         good = 0;
                     if (eMax > 0 && tot > eMax)

slsDetectorServers/jungfrauDetectorServer/slsDetectorFunctionList.c

@@ -1974,9 +1974,6 @@ int autoCompDisable(int on) {
 }
 
 int setComparatorDisableTime(int64_t val) {
-    if (getChipVersion() != 11) {
-        return FAIL;
-    }
     if (val < 0) {
         LOG(logERROR,
             ("Invalid comp disable time: %lld ns\n", (long long int)val));
@@ -2817,7 +2814,8 @@ void *start_timer(void *arg) {
         getNextFrameNumber(&frameNr);
         int iRxEntry = firstDest;
         for (int iframes = 0; iframes != numFrames; ++iframes) {
-            usleep(transmissionDelayUs);
+            if (transmissionDelayUs)
+                usleep(transmissionDelayUs);
 
             // check if manual stop
             if (sharedMemory_getStop() == 1) {

slsDetectorServers/jungfrauDetectorServer/slsDetectorServer_defs.h

@@ -5,8 +5,8 @@
 #include "sls/sls_detector_defs.h"
 
 #define MIN_REQRD_VRSN_T_RD_API  0x171220
-#define REQRD_FRMWRE_VRSN_BOARD2 0x230920 // 1.0 pcb (version = 010)
-#define REQRD_FRMWRE_VRSN        0x230921 // 2.0 pcb (version = 011)
+#define REQRD_FRMWRE_VRSN_BOARD2 0x250209 // 1.0 pcb (version = 010)
+#define REQRD_FRMWRE_VRSN        0x250208 // 2.0 pcb (version = 011)
 
 #define NUM_HARDWARE_VERSIONS (2)
 #define HARDWARE_VERSION_NUMBERS                                               \

slsDetectorServers/moenchDetectorServer/slsDetectorFunctionList.c

@@ -1927,7 +1927,8 @@ void *start_timer(void *arg) {
         getNextFrameNumber(&frameNr);
         int iRxEntry = firstDest;
         for (int iframes = 0; iframes != numFrames; ++iframes) {
-            usleep(transmissionDelayUs);
+            if (transmissionDelayUs)
+                usleep(transmissionDelayUs);
 
             // check if manual stop
             if (sharedMemory_getStop() == 1) {

slsDetectorServers/mythen3DetectorServer/slsDetectorServer_defs.h

@@ -50,7 +50,7 @@
 #define DEFAULT_NUM_CYCLES               (1)
 #define DEFAULT_GATE_WIDTH               (100 * 1000 * 1000) // ns
 #define DEFAULT_GATE_DELAY               (0)
-#define DEFAULT_PERIOD                   (2 * 1000 * 1000) // ns
+#define DEFAULT_PERIOD                   (0) // ns
 #define DEFAULT_DELAY_AFTER_TRIGGER      (0)
 #define DEFAULT_HIGH_VOLTAGE             (0)
 #define DEFAULT_TIMING_MODE              (AUTO_TIMING)

slsDetectorServers/slsDetectorServer/src/slsDetectorServer_funcs.c

@@ -9090,16 +9090,9 @@ int get_comp_disable_time(int file_des) {
     functionNotImplemented();
 #else
     // get only
-    if (getChipVersion() != 11) {
-        ret = FAIL;
-        strcpy(mess,
-               "Cannot get comparator disable time. Only valid for chipv1.1\n");
-        LOG(logERROR, (mess));
-    } else {
-        retval = getComparatorDisableTime();
-        LOG(logDEBUG1,
-            ("retval comp disable time %lld ns\n", (long long int)retval));
-    }
+    retval = getComparatorDisableTime();
+    LOG(logDEBUG1,
+        ("retval comp disable time %lld ns\n", (long long int)retval));
 #endif
     return Server_SendResult(file_des, INT64, &retval, sizeof(retval));
 }
@@ -9117,23 +9110,16 @@ int set_comp_disable_time(int file_des) {
 #else
     // only set
     if (Server_VerifyLock() == OK) {
-        if (getChipVersion() != 11) {
-            ret = FAIL;
-            strcpy(mess, "Cannot get comparator disable time. Only valid for "
-                         "chipv1.1\n");
+        ret = setComparatorDisableTime(arg);
+        int64_t retval = getComparatorDisableTime();
+        LOG(logDEBUG1,
+            ("retval get comp disable time %lld ns\n", (long long int)retval));
+        if (ret == FAIL) {
+            sprintf(mess,
+                    "Could not set comp disable time. Set %lld ns, read "
+                    "%lld ns.\n",
+                    (long long int)arg, (long long int)retval);
             LOG(logERROR, (mess));
-        } else {
-            ret = setComparatorDisableTime(arg);
-            int64_t retval = getComparatorDisableTime();
-            LOG(logDEBUG1, ("retval get comp disable time %lld ns\n",
-                            (long long int)retval));
-            if (ret == FAIL) {
-                sprintf(mess,
-                        "Could not set comp disable time. Set %lld ns, read "
-                        "%lld ns.\n",
-                        (long long int)arg, (long long int)retval);
-                LOG(logERROR, (mess));
-            }
         }
     }
 #endif
@@ -11104,11 +11090,18 @@ int get_timing_info_decoder(int file_des) {
     functionNotImplemented();
 #else
     // get only
-    ret = getTimingInfoDecoder(&retval);
-    LOG(logDEBUG1, ("retval timing info decoder: %d\n", retval));
-    if (ret == FAIL) {
-        strcpy(mess, "Could not get timing info decoder\n");
+    if (isHardwareVersion_1_0()) {
+        ret = FAIL;
+        sprintf(mess, "Could not get timing info decoder. Not supported "
+                      "for hardware version 1.0\n");
         LOG(logERROR, (mess));
+    } else {
+        ret = getTimingInfoDecoder(&retval);
+        LOG(logDEBUG1, ("retval timing info decoder: %d\n", retval));
+        if (ret == FAIL) {
+            strcpy(mess, "Could not get timing info decoder\n");
+            LOG(logERROR, (mess));
+        }
     }
 #endif
     return Server_SendResult(file_des, INT32, &retval, sizeof(retval));
@@ -11136,6 +11129,12 @@ int set_timing_info_decoder(int file_des) {
             modeNotImplemented("Timing info decoder index", (int)arg);
             break;
         }
+        if (ret == OK && isHardwareVersion_1_0()) {
+            ret = FAIL;
+            sprintf(mess, "Could not set timing info decoder. Not supported "
+                          "for hardware version 1.0\n");
+            LOG(logERROR, (mess));
+        }
         if (ret == OK) {
             ret = setTimingInfoDecoder(arg);
             if (ret == FAIL) {

slsDetectorSoftware/generator/commands.yaml

@@ -468,7 +468,7 @@ subdeadtime:
       function: setSubDeadTime
 
 compdisabletime:
-  help: "[duration] [(optional unit) ns|us|ms|s]\n\t[Jungfrau] Time before end of exposure when comparator is disabled. It is only possible for chipv1.1."
+  help: "[duration] [(optional unit) ns|us|ms|s]\n\t[Jungfrau] Time before end of exposure when comparator is disabled."
   inherit_actions: TIME_COMMAND
   actions:
     GET:
@@ -1123,7 +1123,7 @@ temp_control:
       input_types: [ bool ]
 
 autocompdisable:
-  help: "[0, 1]\n\t[Jungfrau] Auto comparator disable mode. By default, the on-chip gain switching is active during the entire exposure.This mode disables the on - chip gain switching comparator automatically after 93.75% (only for chipv1.0) of exposure time (only for longer than 100us). It is possible to set the duration for chipv1.1 using compdisabletime command.\n\tDefault is 0 or this mode disabled(comparator enabled throughout). 1 enables mode. 0 disables mode. "
+  help: "[0, 1]\n\t[Jungfrau] Auto comparator disable mode. By default, the on-chip gain switching is active during the entire exposure.This mode disables the on - chip gain switching comparator automatically and the duration is set using compdisabletime command.\n\tDefault is 0 or this mode disabled(comparator enabled throughout). 1 enables mode. 0 disables mode. "
   inherit_actions: INTEGER_COMMAND_VEC_ID
   actions:
     GET:
@@ -1210,7 +1210,7 @@ polarity:
       input_types: [ defs::polarity ]
 
 timing_info_decoder:
-  help: "[swissfel|shine]\n\t[Jungfrau] Advanced Command and only for Swissfel and Shine. Sets the bunch id or timing info decoder. Default is swissfel."
+  help: "[swissfel|shine]\n\t[Jungfrau] Advanced Command and only for Swissfel and Shine. Sets the bunch id or timing info decoder. Default is swissfel. Only allowed for pcbv2.0."
   inherit_actions: INTEGER_COMMAND_VEC_ID
   actions:
     GET:
@@ -3429,7 +3429,7 @@ udp_dstlist:
       output: [ ToString(args) ]
 
 txdelay:
-  help: "[n_delay]\n\t[Eiger][Jungfrau][Moench][Mythen3] Set transmission delay for all modules in the detector using the step size provided.Sets up \n\t[Eiger] txdelay_left to (2 * mod_index * n_delay), \n\t[Eiger] txdelay_right to ((2 * mod_index + 1) * n_delay) and \n\t[Eiger] txdelay_frame to (2 *num_modules * n_delay)\n\t[Jungfrau][Moench][Mythen3] txdelay_frame to (num_modules * n_delay) for every module."
+  help: "[n_delay]\n\t[Eiger][Jungfrau][Moench][Mythen3] Set transmission delay for all modules in the detector using the step size provided.Sets up \n\t[Eiger] txdelay_left to (2 * mod_index * n_delay), \n\t[Eiger] txdelay_right to ((2 * mod_index + 1) * n_delay) and \n\t[Eiger] txdelay_frame to (2 * num_modules * n_delay)\n\t[Jungfrau][Moench][Mythen3] txdelay_frame to (num_modules * n_delay) for every module."
   actions:
     GET:
       argc: 0

slsDetectorSoftware/generator/extended_commands.yaml

@@ -762,10 +762,9 @@ autocompdisable:
   function_alias: autocompdisable
   help: "[0, 1]\n\t[Jungfrau] Auto comparator disable mode. By default, the on-chip\
     \ gain switching is active during the entire exposure.This mode disables the on\
-    \ - chip gain switching comparator automatically after 93.75% (only for chipv1.0)\
-    \ of exposure time (only for longer than 100us). It is possible to set the duration\
-    \ for chipv1.1 using compdisabletime command.\n\tDefault is 0 or this mode disabled(comparator\
-    \ enabled throughout). 1 enables mode. 0 disables mode. "
+    \ - chip gain switching comparator automatically and the duration is set using\
+    \ compdisabletime command.\n\tDefault is 0 or this mode disabled(comparator enabled\
+    \ throughout). 1 enables mode. 0 disables mode. "
   infer_action: true
   template: true
 badchannels:
@@ -1607,7 +1606,7 @@ compdisabletime:
   command_name: compdisabletime
   function_alias: compdisabletime
   help: "[duration] [(optional unit) ns|us|ms|s]\n\t[Jungfrau] Time before end of\
-    \ exposure when comparator is disabled. It is only possible for chipv1.1."
+    \ exposure when comparator is disabled."
   infer_action: true
   template: true
 confadc:
@@ -11488,7 +11487,8 @@ timing_info_decoder:
   command_name: timing_info_decoder
   function_alias: timing_info_decoder
   help: "[swissfel|shine]\n\t[Jungfrau] Advanced Command and only for Swissfel and\
-    \ Shine. Sets the bunch id or timing info decoder. Default is swissfel."
+    \ Shine. Sets the bunch id or timing info decoder. Default is swissfel. Only allowed\
+    \ for pcbv2.0."
   infer_action: true
   template: true
 timinglist:
@@ -11915,7 +11915,7 @@ txdelay:
   help: "[n_delay]\n\t[Eiger][Jungfrau][Moench][Mythen3] Set transmission delay for\
     \ all modules in the detector using the step size provided.Sets up \n\t[Eiger]\
     \ txdelay_left to (2 * mod_index * n_delay), \n\t[Eiger] txdelay_right to ((2\
-    \ * mod_index + 1) * n_delay) and \n\t[Eiger] txdelay_frame to (2 *num_modules\
+    \ * mod_index + 1) * n_delay) and \n\t[Eiger] txdelay_frame to (2 * num_modules\
     \ * n_delay)\n\t[Jungfrau][Moench][Mythen3] txdelay_frame to (num_modules * n_delay)\
     \ for every module."
   infer_action: true

slsDetectorSoftware/include/sls/Detector.h

@@ -65,7 +65,12 @@ class Detector {
 
     Result<std::string> getHostname(Positions pos = {}) const;
 
-    /**Frees shared memory, adds detectors to the list. */
+    /**Frees shared memory, adds detectors to the list. The row and column
+     * values in the udp/zmq header are affected by the order in this command
+     * and the setDetectorSize function. The modules are stacked row by row
+     * until they reach the y-axis limit set by detsize (if specified). Then,
+     * stacking continues in the next column and so on. This only affects row
+     * and column in udp/zmq header.*/
     void setHostname(const std::vector<std::string> &hostname);
 
     /** connects to n servers at local host starting at specific control port.
@@ -1304,11 +1309,9 @@ class Detector {
      * //TODO naming
      * By default, the on-chip gain switching is active during the
      * entire exposure. This mode disables the on-chip gain switching comparator
-     * automatically after 93.75% of exposure time (only for longer than 100us).
-     * The % is for chipv1.0. One can set the duration for chipv1.1 using
-     * setComparatorDisableTime\n Default is false or this mode
-     * disabled(comparator enabled throughout). true enables mode. 0 disables
-     * mode.
+     * automatically and the duration is set using setComparatorDisableTime\n
+     * Default is false or this mode disabled(comparator enabled throughout).
+     * true enables mode. 0 disables mode.
      */
     void setAutoComparatorDisable(bool value, Positions pos = {});
 
@@ -1316,7 +1319,7 @@ class Detector {
     Result<ns> getComparatorDisableTime(Positions pos = {}) const;
 
     /** [Jungfrau] Time before end of exposure when comparator is
-     * disabled. It is only possible for chipv1.1.*/
+     * disabled.*/
     void setComparatorDisableTime(ns t, Positions pos = {});
 
     /** [Jungfrau] Advanced TODO naming */
@@ -1382,7 +1385,7 @@ class Detector {
     Result<defs::timingInfoDecoder>
     getTimingInfoDecoder(Positions pos = {}) const;
 
-    /** [Jungfrau] Advanced Command! */
+    /** [Jungfrau] Advanced Command! Only for pcb v2.0 */
     void setTimingInfoDecoder(defs::timingInfoDecoder value,
                               Positions pos = {});
 

slsDetectorSoftware/src/Caller.cpp

@@ -1018,7 +1018,7 @@ std::string Caller::autocompdisable(int action) {
     // print help
     if (action == slsDetectorDefs::HELP_ACTION) {
         os << R"V0G0N([0, 1]
-	[Jungfrau] Auto comparator disable mode. By default, the on-chip gain switching is active during the entire exposure.This mode disables the on - chip gain switching comparator automatically after 93.75% (only for chipv1.0) of exposure time (only for longer than 100us). It is possible to set the duration for chipv1.1 using compdisabletime command.
+	[Jungfrau] Auto comparator disable mode. By default, the on-chip gain switching is active during the entire exposure.This mode disables the on - chip gain switching comparator automatically and the duration is set using compdisabletime command.
 	Default is 0 or this mode disabled(comparator enabled throughout). 1 enables mode. 0 disables mode.  )V0G0N"
            << std::endl;
         return os.str();
@@ -2108,7 +2108,7 @@ std::string Caller::compdisabletime(int action) {
     // print help
     if (action == slsDetectorDefs::HELP_ACTION) {
         os << R"V0G0N([duration] [(optional unit) ns|us|ms|s]
-	[Jungfrau] Time before end of exposure when comparator is disabled. It is only possible for chipv1.1. )V0G0N"
+	[Jungfrau] Time before end of exposure when comparator is disabled. )V0G0N"
            << std::endl;
         return os.str();
     }
@@ -14744,7 +14744,7 @@ std::string Caller::timing_info_decoder(int action) {
     // print help
     if (action == slsDetectorDefs::HELP_ACTION) {
         os << R"V0G0N([swissfel|shine]
-	[Jungfrau] Advanced Command and only for Swissfel and Shine. Sets the bunch id or timing info decoder. Default is swissfel. )V0G0N"
+	[Jungfrau] Advanced Command and only for Swissfel and Shine. Sets the bunch id or timing info decoder. Default is swissfel. Only allowed for pcbv2.0. )V0G0N"
            << std::endl;
         return os.str();
     }
@@ -15365,7 +15365,7 @@ std::string Caller::txdelay(int action) {
 	[Eiger][Jungfrau][Moench][Mythen3] Set transmission delay for all modules in the detector using the step size provided.Sets up 
 	[Eiger] txdelay_left to (2 * mod_index * n_delay), 
 	[Eiger] txdelay_right to ((2 * mod_index + 1) * n_delay) and 
-	[Eiger] txdelay_frame to (2 *num_modules * n_delay)
+	[Eiger] txdelay_frame to (2 * num_modules * n_delay)
 	[Jungfrau][Moench][Mythen3] txdelay_frame to (num_modules * n_delay) for every module. )V0G0N"
            << std::endl;
         return os.str();

slsDetectorSoftware/src/CallerSpecial.cpp

@@ -210,7 +210,12 @@ std::string Caller::hostname(int action) {
         os << "\n\tFrees shared memory and sets hostname (or IP address) of "
               "all modules concatenated by +.\n\t Virtual servers can already "
               "use the port in hostname separated by ':' and ports incremented "
-              "by 2 to accomodate the stop server as well."
+              "by 2 to accomodate the stop server as well. The row and column "
+              "values in the udp/zmq header are affected by the order in this "
+              "command and the detsize command. The modules are stacked row by "
+              "row until they reach the y-axis limit set by detsize (if "
+              "specified). Then, stacking continues in the next column and so "
+              "on. This only affects row and column in udp/zmq header."
            << '\n';
     } else if (action == defs::GET_ACTION) {
         if (!args.empty()) {

slsDetectorSoftware/src/Detector.cpp

@@ -99,6 +99,12 @@ void Detector::loadParameters(const std::vector<std::string> &parameters) {
     CmdParser parser;
     for (const auto &current_line : parameters) {
         parser.Parse(current_line);
+        if (parser.multi_id() != 0) {
+            throw RuntimeError(
+                "Multi-detector indices [" + std::to_string(parser.multi_id()) +
+                "] are not allowed in the file. Instead, use the index for "
+                "'config' or 'parameters' command?");
+        }
         caller.call(parser.command(), parser.arguments(), parser.detector_id(),
                     defs::PUT_ACTION, std::cout, parser.receiver_id());
     }

slsDetectorSoftware/src/DetectorImpl.cpp

@@ -1177,9 +1177,19 @@ int DetectorImpl::acquire() {
         if (dataReady == nullptr) {
             setJoinThreadFlag(true);
         } else if (receiver) {
-            while (numZmqRunning != 0) {
-                Parallel(&Module::restreamStopFromReceiver, {});
-                std::this_thread::sleep_for(std::chrono::milliseconds(200));
+            // wait for postprocessor to process dummies
+            if (dataReady != nullptr) {
+                // process dummy from stop receier
+                if (numZmqRunning != 0)
+                    std::this_thread::sleep_for(std::chrono::milliseconds(200));
+                while (numZmqRunning != 0) {
+                    Parallel(&Module::restreamStopFromReceiver, {});
+                    // time to process restream dummy
+                    std::this_thread::sleep_for(std::chrono::milliseconds(200));
+                    // increase time for fewer dummies and to catch up
+                    if (numZmqRunning != 0)
+                        std::this_thread::sleep_for(std::chrono::seconds(2));
+                }
             }
         }
         dataProcessingThread.join();

slsDetectorSoftware/src/Module.cpp

@@ -905,8 +905,13 @@ void Module::startReceiver() {
 }
 
 void Module::stopReceiver() {
+    auto rxStatusPrior = getReceiverStatus();
     sendToReceiver(F_STOP_RECEIVER, static_cast<int>(shm()->stoppedFlag),
                    nullptr);
+
+    if (rxStatusPrior == IDLE && getReceiverStreaming()) {
+        restreamStopFromReceiver();
+    }
 }
 
 void Module::startAcquisition() {
@@ -920,26 +925,8 @@ void Module::startReadout() {
 }
 
 void Module::stopAcquisition() {
-
-    // get det status before stopping acq
-    runStatus detStatus = ERROR;
-    try {
-        detStatus = getRunStatus();
-    } catch (...) {
-    }
-
     sendToDetectorStop(F_STOP_ACQUISITION);
     shm()->stoppedFlag = true;
-
-    // restream dummy header, if rxr streaming and det idle before stop
-    try {
-        if (shm()->useReceiverFlag && getReceiverStreaming()) {
-            if (detStatus == IDLE && getReceiverStatus() == IDLE) {
-                restreamStopFromReceiver();
-            }
-        }
-    } catch (...) {
-    }
 }
 
 void Module::restreamStopFromReceiver() {

slsDetectorSoftware/tests/Caller/test-Caller-jungfrau.cpp

@@ -262,8 +262,7 @@ TEST_CASE("compdisabletime", "[.cmdcall]") {
     Detector det;
     Caller caller(&det);
     auto det_type = det.getDetectorType().squash();
-    if (det_type == defs::JUNGFRAU &&
-        det.getChipVersion().squash() * 10 == 11) {
+    if (det_type == defs::JUNGFRAU) {
         auto prev_val = det.getComparatorDisableTime();
         {
             std::ostringstream oss;
@@ -670,7 +669,8 @@ TEST_CASE("pedestalmode", "[.cmdcall]") {
 TEST_CASE("timing_info_decoder", "[.cmdcall]") {
     Detector det;
     Caller caller(&det);
-    if (det.getDetectorType().squash() == defs::JUNGFRAU) {
+    if (det.getDetectorType().squash() == defs::JUNGFRAU &&
+        det.getHardwareVersion().squash() == "2.0") {
         auto prev_val = det.getTimingInfoDecoder();
         /*{
             std::ostringstream oss;

slsDetectorSoftware/tests/Caller/test-Caller.cpp

@@ -3323,7 +3323,7 @@ TEST_CASE("reg", "[.cmdcall]") {
             addr = 0x80;
         }
         if (det_type == defs::GOTTHARD2) {
-            addr = 0x20;
+            addr = 0x298;
         }
         std::string saddr = ToStringHex(addr);
         auto prev_val = det.readRegister(addr);
@@ -3379,7 +3379,7 @@ TEST_CASE("setbit", "[.cmdcall]") {
             addr = 0x80;
         }
         if (det_type == defs::GOTTHARD2) {
-            addr = 0x20;
+            addr = 0x298;
         }
         std::string saddr = ToStringHex(addr);
         auto prev_val = det.readRegister(addr);
@@ -3409,7 +3409,7 @@ TEST_CASE("clearbit", "[.cmdcall]") {
             addr = 0x80;
         }
         if (det_type == defs::GOTTHARD2) {
-            addr = 0x20;
+            addr = 0x298;
         }
         std::string saddr = ToStringHex(addr);
         auto prev_val = det.readRegister(addr);
@@ -3439,7 +3439,7 @@ TEST_CASE("getbit", "[.cmdcall]") {
             addr = 0x80;
         }
         if (det_type == defs::GOTTHARD2) {
-            addr = 0x20;
+            addr = 0x298;
         }
         std::string saddr = ToStringHex(addr);
         auto prev_val = det.readRegister(addr);

slsReceiverSoftware/CMakeLists.txt

@@ -138,13 +138,34 @@ if (SLS_USE_RECEIVER_BINARIES)
         slsProjectWarnings
     )
 
-    install(TARGETS slsReceiver slsMultiReceiver
+    add_executable(slsFrameSynchronizer
+        src/FrameSynchronizerApp.cpp
+    )
+
+    set_target_properties(slsFrameSynchronizer PROPERTIES
+        RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin
+    )
+    if((CMAKE_BUILD_TYPE STREQUAL "Release") AND SLS_LTO_AVAILABLE)
+        set_property(TARGET slsFrameSynchronizer PROPERTY INTERPROCEDURAL_OPTIMIZATION True)
+    endif()
+
+    target_link_libraries(slsFrameSynchronizer 
+    PUBLIC
+        slsReceiverStatic
+        pthread
+        rt
+    PRIVATE
+        slsProjectWarnings
+        "$<BUILD_INTERFACE:libzmq-static>"
+    )
+
+    install(TARGETS slsReceiver slsMultiReceiver slsFrameSynchronizer
         EXPORT "${TARGETS_EXPORT_NAME}"
         RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
         LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
         ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
         PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/sls
-)
+    )
 
 endif(SLS_USE_RECEIVER_BINARIES)
 

slsReceiverSoftware/src/ClientInterface.cpp

@@ -33,6 +33,8 @@ using Interface = ServerInterface;
 #define gettid() syscall(SYS_gettid)
 #endif
 
+std::mutex ClientInterface::callbackMutex;
+
 ClientInterface::~ClientInterface() {
     killTcpThread = true;
     LOG(logINFO) << "Shutting down TCP Socket on port " << portNumber;
@@ -55,12 +57,14 @@ std::string ClientInterface::getReceiverVersion() { return APIRECEIVER; }
 /***callback functions***/
 void ClientInterface::registerCallBackStartAcquisition(
     int (*func)(const startCallbackHeader, void *), void *arg) {
+    std::lock_guard<std::mutex> lock(callbackMutex);
     startAcquisitionCallBack = func;
     pStartAcquisition = arg;
 }
 
 void ClientInterface::registerCallBackAcquisitionFinished(
     void (*func)(const endCallbackHeader, void *), void *arg) {
+    std::lock_guard<std::mutex> lock(callbackMutex);
     acquisitionFinishedCallBack = func;
     pAcquisitionFinished = arg;
 }
@@ -69,6 +73,7 @@ void ClientInterface::registerCallBackRawDataReady(
     void (*func)(sls_receiver_header &, dataCallbackHeader, char *, size_t &,
                  void *),
     void *arg) {
+    std::lock_guard<std::mutex> lock(callbackMutex);
     rawDataReadyCallBack = func;
     pRawDataReady = arg;
 }
@@ -461,15 +466,18 @@ void ClientInterface::setDetectorType(detectorType arg) {
                            std::string(e.what()) + ']');
     }
     // callbacks after (in setdetectortype, the object is reinitialized)
-    if (startAcquisitionCallBack != nullptr)
-        impl()->registerCallBackStartAcquisition(startAcquisitionCallBack,
-                                                 pStartAcquisition);
-    if (acquisitionFinishedCallBack != nullptr)
-        impl()->registerCallBackAcquisitionFinished(acquisitionFinishedCallBack,
-                                                    pAcquisitionFinished);
-    if (rawDataReadyCallBack != nullptr)
-        impl()->registerCallBackRawDataReady(rawDataReadyCallBack,
-                                             pRawDataReady);
+    {
+        std::lock_guard<std::mutex> lock(callbackMutex);
+        if (startAcquisitionCallBack != nullptr)
+            impl()->registerCallBackStartAcquisition(startAcquisitionCallBack,
+                                                     pStartAcquisition);
+        if (acquisitionFinishedCallBack != nullptr)
+            impl()->registerCallBackAcquisitionFinished(
+                acquisitionFinishedCallBack, pAcquisitionFinished);
+        if (rawDataReadyCallBack != nullptr)
+            impl()->registerCallBackRawDataReady(rawDataReadyCallBack,
+                                                 pRawDataReady);
+    }
 
     impl()->setThreadIds(parentThreadId, tcpThreadId);
 }

slsReceiverSoftware/src/ClientInterface.h

@@ -194,6 +194,8 @@ class ClientInterface : private virtual slsDetectorDefs {
     pid_t tcpThreadId{0};
     std::vector<std::string> udpips =
         std::vector<std::string>(MAX_NUMBER_OF_LISTENING_THREADS);
+    // necessary if Receiver objects using threads with callbacks
+    static std::mutex callbackMutex;
 };
 
 } // namespace sls

slsReceiverSoftware/src/FrameSynchronizerApp.cpp

@@ -0,0 +1,635 @@
+// SPDX-License-Identifier: LGPL-3.0-or-other
+// Copyright (C) 2021 Contributors to the SLS Detector Package
+/* Creates the slsFrameSynchronizer for running multiple receivers in different
+ * threads form a single binary that will spit out zmq streams without
+ * reconstructing image. Sample python script for pull socket for this combiner
+ * in python/scripts folder. TODO: Not handling empty frames from one socket
+ */
+#include "sls/Receiver.h"
+#include "sls/ToString.h"
+#include "sls/container_utils.h"
+#include "sls/logger.h"
+#include "sls/sls_detector_defs.h"
+#include "sls/versionAPI.h"
+
+#include <csignal> //SIGINT
+#include <cstdio>
+#include <cstring>
+#include <iostream>
+#include <mutex>
+#include <ostream>
+#include <semaphore.h>
+#include <sys/socket.h>
+#include <sys/wait.h> //wait
+#include <thread>
+#include <unistd.h>
+
+#include <set>
+#include <vector>
+#include <zmq.h>
+
+std::vector<std::thread> threads;
+std::vector<sem_t *> semaphores;
+sls::TLogLevel printHeadersLevel = sls::logDEBUG;
+
+/** Define Colors to print data call back in different colors for different
+ * recievers */
+#define PRINT_IN_COLOR(c, f, ...)                                              \
+    printf("\033[%dm" f RESET, 30 + c + 1, ##__VA_ARGS__)
+
+/** Structure handling different threads */
+using ZmqMsgList = std::vector<zmq_msg_t *>;
+using FrameMap = std::map<uint64_t, ZmqMsgList>;
+using PortFrameMap = std::map<uint16_t, FrameMap>;
+struct FrameStatus {
+    bool starting = true;
+    bool terminate = false;
+    int num_receivers;
+    sem_t available;
+    std::mutex mtx;
+    ZmqMsgList headers;
+    PortFrameMap frames;
+    ZmqMsgList ends;
+
+    FrameStatus(bool start, bool term, int num_recv)
+        : starting(start), terminate(term), num_receivers(num_recv) {
+        sem_init(&available, 0, 0);
+    }
+};
+FrameStatus *global_frame_status = nullptr;
+
+/**
+ * Control+C Interrupt Handler
+ * to let all the processes know to exit properly
+ */
+void sigInterruptHandler(int p) {
+    for (size_t i = 0; i != semaphores.size(); ++i) {
+        sem_post(semaphores[i]);
+    }
+}
+
+void cleanup() {
+    if (global_frame_status) {
+        std::lock_guard<std::mutex> lock(global_frame_status->mtx);
+        for (auto &outer_pair : global_frame_status->frames) {
+            for (auto &inner_pair : outer_pair.second) {
+                for (zmq_msg_t *msg : inner_pair.second) {
+                    if (msg) {
+                        zmq_msg_close(msg);
+                        delete msg;
+                    }
+                }
+                inner_pair.second.clear();
+            }
+            outer_pair.second.clear();
+        }
+        global_frame_status->frames.clear();
+    }
+}
+
+/**
+ * prints usage of this example program
+ */
+std::string getHelpMessage() {
+    std::ostringstream os;
+    os << "\nUsage:\n"
+       << "./slsFrameSynchronizer --version or -v\n"
+       << "\t - Gets the slsFrameSynchronizer version\n\n"
+       << "./slsFrameSynchronizer [start tcp port] [num recevers] [print "
+          "callback headers (optional)]\n"
+       << "\t - tcp port has to be non-zero and 16 bit\n"
+       << "\t - print callback headers option is 0 (disabled) by default\n";
+    return os.str();
+}
+
+void zmq_free(void *data, void *hint) { delete[] static_cast<char *>(data); }
+
+void print_frames(const PortFrameMap &frame_port_map) {
+    LOG(sls::logDEBUG) << "Printing frames";
+    for (const auto &it : frame_port_map) {
+        uint16_t udpPort = it.first;
+        const auto &frame_map = it.second;
+        LOG(sls::logDEBUG) << "UDP port: " << udpPort;
+        for (const auto &frame : frame_map) {
+            uint64_t fnum = frame.first;
+            const auto &msg_list = frame.second;
+            LOG(sls::logDEBUG)
+                << "  acq index: " << fnum << '[' << msg_list.size() << ']';
+        }
+    }
+}
+
+/** Valid frame numbers mean they exist across all ports or
+ * has at least a larger fnum in the port with the missing fnum **/
+std::set<uint64_t> get_valid_fnums(const PortFrameMap &port_frame_map) {
+    // empty list
+    std::set<uint64_t> valid_fnums;
+    if (port_frame_map.empty()) {
+        return valid_fnums;
+    }
+
+    // collect all unique frame numbers from all ports
+    std::set<uint64_t> unique_fnums;
+    for (auto it = port_frame_map.begin(); it != port_frame_map.begin(); ++it) {
+        const FrameMap &frame_map = it->second;
+        for (auto frame = frame_map.begin(); frame != frame_map.end();
+             ++frame) {
+            unique_fnums.insert(frame->first);
+        }
+    }
+
+    // collect valid frame numbers
+    for (auto &fnum : unique_fnums) {
+        bool is_valid = true;
+        for (auto it = port_frame_map.begin(); it != port_frame_map.end();
+             ++it) {
+            uint16_t port = it->first;
+            const FrameMap &frame_map = it->second;
+            auto frame = frame_map.find(fnum);
+            // invalid: fnum missing in one port
+            if (frame == frame_map.end()) {
+                LOG(sls::logDEBUG)
+                    << "Fnum " << fnum << " is missing in port " << port;
+                // invalid: fnum greater than all in that port
+                auto last_frame = std::prev(frame_map.end());
+                auto last_fnum = last_frame->first;
+                if (fnum > last_fnum) {
+                    LOG(sls::logDEBUG) << "And no larger fnum found. Fnum "
+                                       << fnum << " is invalid.\n";
+                    is_valid = false;
+                    break;
+                }
+            }
+        }
+        if (is_valid) {
+            valid_fnums.insert(fnum);
+        }
+    }
+
+    return valid_fnums;
+}
+
+int zmq_send_multipart(void *socket, const ZmqMsgList &messages) {
+    size_t num_messages = messages.size();
+    for (size_t i = 0; i != num_messages; ++i) {
+        zmq_msg_t *msg = messages[i];
+        // determine flags: ZMQ_SNDMORE for all messages except the last
+        int flags = (i == num_messages - 1) ? 0 : ZMQ_SNDMORE;
+        if (zmq_msg_send(msg, socket, flags) == -1) {
+            LOG(sls::logERROR)
+                << "Error sending message: " << zmq_strerror(zmq_errno());
+            return slsDetectorDefs::FAIL;
+        }
+    }
+    return slsDetectorDefs::OK;
+}
+
+void Correlate(FrameStatus *stat) {
+    void *context = zmq_ctx_new();
+
+    void *socket = zmq_socket(context, ZMQ_PUSH);
+    int rc = zmq_bind(socket, "tcp://*:5555");
+    if (rc != 0) {
+        LOG(sls::logERROR) << "failed to bind";
+    }
+
+    while (true) {
+        sem_wait(&(stat->available));
+        {
+            std::lock_guard<std::mutex> lock(stat->mtx);
+
+            if (stat->terminate) {
+                break;
+            }
+
+            if (stat->starting) {
+                // sending all start packets
+                if (static_cast<int>(stat->headers.size()) ==
+                    stat->num_receivers) {
+                    stat->starting = false;
+                    // clean up
+                    zmq_send_multipart(socket, stat->headers);
+                    for (zmq_msg_t *msg : stat->headers) {
+                        if (msg) {
+                            zmq_msg_close(msg);
+                            delete msg;
+                        }
+                    }
+                    stat->headers.clear();
+                }
+            } else {
+                // print_frames(stat->frames);
+                auto valid_fnums = get_valid_fnums(stat->frames);
+                // sending all valid fnum data packets
+                for (const auto &fnum : valid_fnums) {
+                    ZmqMsgList msg_list;
+                    PortFrameMap &port_frame_map = stat->frames;
+                    for (auto it = port_frame_map.begin();
+                         it != port_frame_map.end(); ++it) {
+                        uint16_t port = it->first;
+                        const FrameMap &frame_map = it->second;
+                        auto frame = frame_map.find(fnum);
+                        if (frame != frame_map.end()) {
+                            msg_list.insert(msg_list.end(),
+                                            stat->frames[port][fnum].begin(),
+                                            stat->frames[port][fnum].end());
+                            // clean up
+                            for (zmq_msg_t *msg : stat->frames[port][fnum]) {
+                                if (msg) {
+                                    zmq_msg_close(msg);
+                                    delete msg;
+                                }
+                            }
+                            stat->frames[port].erase(fnum);
+                        }
+                    }
+                    LOG(printHeadersLevel)
+                        << "Sending data packets for fnum " << fnum;
+                    zmq_send_multipart(socket, msg_list);
+                }
+            }
+            // sending all end packets
+            if (static_cast<int>(stat->ends.size()) == stat->num_receivers) {
+                zmq_send_multipart(socket, stat->ends);
+                // clean up
+                for (zmq_msg_t *msg : stat->ends) {
+                    if (msg) {
+                        zmq_msg_close(msg);
+                        delete msg;
+                    }
+                }
+                stat->ends.clear();
+            }
+        }
+    }
+    zmq_close(socket);
+    zmq_ctx_destroy(context);
+}
+
+int StartAcquisitionCallback(
+    const slsDetectorDefs::startCallbackHeader callbackHeader,
+    void *objectPointer) {
+    LOG(printHeadersLevel)
+        << "Start Acquisition:"
+        << "\n\t["
+        << "\n\tUDP Port : " << sls::ToString(callbackHeader.udpPort)
+        << "\n\tDynamic Range : " << callbackHeader.dynamicRange
+        << "\n\tDetector Shape : "
+        << sls::ToString(callbackHeader.detectorShape)
+        << "\n\tImage Size : " << callbackHeader.imageSize
+        << "\n\tFile Path : " << callbackHeader.filePath
+        << "\n\tFile Name : " << callbackHeader.fileName
+        << "\n\tFile Index : " << callbackHeader.fileIndex
+        << "\n\tQuad Enable : " << callbackHeader.quad
+        << "\n\tAdditional Json Header : "
+        << sls::ToString(callbackHeader.addJsonHeader).c_str() << "\n\t]";
+    std::ostringstream oss;
+    oss << "{\"htype\":\"header\""
+        << ", \"udpPorts\":" << sls::ToString(callbackHeader.udpPort)
+        << ", \"bitmode\":" << callbackHeader.dynamicRange
+        << ", \"filePath\":\"" << callbackHeader.filePath
+        << "\", \"fileName\":\"" << callbackHeader.fileName
+        << "\", \"fileIndex\":" << callbackHeader.fileIndex
+        << ", \"detshape\":" << sls::ToString(callbackHeader.detectorShape)
+        << ", \"size\":" << callbackHeader.imageSize
+        << ", \"quad\":" << (callbackHeader.quad ? 1 : 0);
+
+    if (!callbackHeader.addJsonHeader.empty()) {
+        oss << ", \"addJsonHeader\": {";
+        for (auto it = callbackHeader.addJsonHeader.begin();
+             it != callbackHeader.addJsonHeader.end(); ++it) {
+            if (it != callbackHeader.addJsonHeader.begin()) {
+                oss << ", ";
+            }
+            oss << "\"" << it->first.c_str() << "\":\"" << it->second.c_str()
+                << "\"";
+        }
+        oss << " } ";
+    }
+    oss << "}\n";
+
+    std::string message = oss.str();
+    LOG(sls::logDEBUG) << "Start Acquisition message:" << std::endl << message;
+
+    int length = message.length();
+    char *hdata = new char[length];
+    memcpy(hdata, message.c_str(), length);
+    zmq_msg_t *hmsg = new zmq_msg_t;
+    zmq_msg_init_data(hmsg, hdata, length, zmq_free, NULL);
+
+    // push zmq msg into stat to be processed
+    FrameStatus *stat = static_cast<FrameStatus *>(objectPointer);
+    {
+        std::lock_guard<std::mutex> lock(stat->mtx);
+        stat->headers.push_back(hmsg);
+        stat->starting = true;
+        // clean up old frames
+        for (int port : callbackHeader.udpPort) {
+            for (auto &frame_map : stat->frames[port]) {
+                for (zmq_msg_t *msg : frame_map.second) {
+                    if (msg) {
+                        zmq_msg_close(msg);
+                        delete msg;
+                    }
+                }
+                frame_map.second.clear();
+            }
+            stat->frames[port].clear();
+        }
+    }
+    sem_post(&stat->available);
+    return slsDetectorDefs::OK; // TODO: change return to void
+}
+
+void AcquisitionFinishedCallback(
+    const slsDetectorDefs::endCallbackHeader callbackHeader,
+    void *objectPointer) {
+    LOG(printHeadersLevel) << "Acquisition Finished:"
+                           << "\n\t["
+                           << "\n\tUDP Port : "
+                           << sls::ToString(callbackHeader.udpPort)
+                           << "\n\tComplete Frames : "
+                           << sls::ToString(callbackHeader.completeFrames)
+                           << "\n\tLast Frame Index : "
+                           << sls::ToString(callbackHeader.lastFrameIndex)
+                           << "\n\t]";
+    std::ostringstream oss;
+    oss << "{\"htype\":\"series_end\""
+        << ", \"udpPorts\":" << sls::ToString(callbackHeader.udpPort)
+        << ", \"comleteFrames\":"
+        << sls::ToString(callbackHeader.completeFrames)
+        << ", \"lastFrameIndex\":"
+        << sls::ToString(callbackHeader.lastFrameIndex) << "}\n";
+    std::string message = oss.str();
+    int length = message.length();
+    LOG(sls::logDEBUG) << "Acquisition Finished message:" << std::endl
+                       << message;
+
+    char *hdata = new char[length];
+    memcpy(hdata, message.c_str(), length);
+    zmq_msg_t *hmsg = new zmq_msg_t;
+    zmq_msg_init_data(hmsg, hdata, length, zmq_free, NULL);
+
+    // push zmq msg into stat to be processed
+    FrameStatus *stat = static_cast<FrameStatus *>(objectPointer);
+    {
+        std::lock_guard<std::mutex> lock(stat->mtx);
+        stat->ends.push_back(hmsg);
+    }
+    sem_post(&stat->available);
+}
+
+void GetDataCallback(slsDetectorDefs::sls_receiver_header &header,
+                     slsDetectorDefs::dataCallbackHeader callbackHeader,
+                     char *dataPointer, size_t &imageSize,
+                     void *objectPointer) {
+
+    slsDetectorDefs::sls_detector_header detectorHeader = header.detHeader;
+
+    if (printHeadersLevel < sls::logDEBUG) {
+        // print in different color for each udp port
+        PRINT_IN_COLOR((callbackHeader.udpPort % 10),
+                       "Data: "
+                       "\n\tCallback Header: "
+                       "\n\t["
+                       "\n\tUDP Port: %u"
+                       "\n\tShape: [%u, %u]"
+                       "\n\tAcq Index : %lu"
+                       "\n\tFrame Index :%lu"
+                       "\n\tProgress : %.2f%%"
+                       "\n\tComplete Image :%s"
+                       "\n\tFlip Rows :%s"
+                       "\n\tAdditional Json Header : %s"
+                       "\n\t]"
+                       "\n\ttReceiver Header: "
+                       "\n\t["
+                       "\n\tFrame Number : %lu"
+                       "\n\tExposure Length :%u"
+                       "\n\tPackets Caught :%u"
+                       "\n\tDetector Specific 1: %lu"
+                       "\n\tTimestamp : %lu"
+                       "\n\tModule Id :%u"
+                       "\n\tRow : %u"
+                       "\n\tColumn :%u"
+                       "\n\tDetector Specific 2 : %u"
+                       "\n\tDetector Specific 3 : %u"
+                       "\n\tDetector Specific 4 : %u"
+                       "\n\tDetector Type : %s"
+                       "\n\tVersion: %u"
+                       "\n\t]"
+                       "\n\tFirst Byte Data: 0x%x"
+                       "\n\tImage Size: %zu\n\n",
+                       callbackHeader.udpPort, callbackHeader.shape.x,
+                       callbackHeader.shape.y, callbackHeader.acqIndex,
+                       callbackHeader.frameIndex, callbackHeader.progress,
+                       sls::ToString(callbackHeader.completeImage).c_str(),
+                       sls::ToString(callbackHeader.flipRows).c_str(),
+                       sls::ToString(callbackHeader.addJsonHeader).c_str(),
+                       detectorHeader.frameNumber, detectorHeader.expLength,
+                       detectorHeader.packetNumber, detectorHeader.detSpec1,
+                       detectorHeader.timestamp, detectorHeader.modId,
+                       detectorHeader.row, detectorHeader.column,
+                       detectorHeader.detSpec2, detectorHeader.detSpec3,
+                       detectorHeader.detSpec4,
+                       sls::ToString(detectorHeader.detType).c_str(),
+                       detectorHeader.version,
+                       // header->packetsMask.to_string().c_str(),
+                       ((uint8_t)(*((uint8_t *)(dataPointer)))), imageSize);
+    }
+    std::ostringstream oss;
+    oss << "{\"htype\":\"module\""
+        << ", \"port\":" << callbackHeader.udpPort
+        << ", \"shape\":" << sls::ToString(callbackHeader.shape)
+        << ", \"acqIndex\":" << callbackHeader.acqIndex
+        << ", \"frameIndex\":" << callbackHeader.frameIndex
+        << ", \"flipRows\":" << (callbackHeader.flipRows ? 1 : 0)
+        << ", \"progress\":" << callbackHeader.progress
+        << ", \"completeImage\":" << (callbackHeader.completeImage ? 1 : 0)
+        << ", \"imageSize\":" << imageSize
+        << ", \"frameNumber\":" << detectorHeader.frameNumber
+        << ", \"expLength\":" << detectorHeader.expLength
+        << ", \"packetNumber\":" << detectorHeader.packetNumber
+        << ", \"detSpec1\":" << detectorHeader.detSpec1
+        << ", \"timestamp\":" << detectorHeader.timestamp
+        << ", \"modId\":" << detectorHeader.modId
+        << ", \"row\":" << detectorHeader.row
+        << ", \"column\":" << detectorHeader.column
+        << ", \"detSpec2\":" << detectorHeader.detSpec2
+        << ", \"detSpec3\":" << detectorHeader.detSpec3
+        << ", \"detSpec4\":" << detectorHeader.detSpec4
+        << ", \"detType\":" << static_cast<int>(detectorHeader.detType)
+        << ", \"version\":" << static_cast<int>(detectorHeader.version);
+
+    if (!callbackHeader.addJsonHeader.empty()) {
+        oss << ", \"addJsonHeader\": {";
+        for (auto it = callbackHeader.addJsonHeader.begin();
+             it != callbackHeader.addJsonHeader.end(); ++it) {
+            if (it != callbackHeader.addJsonHeader.begin()) {
+                oss << ", ";
+            }
+            oss << "\"" << it->first.c_str() << "\":\"" << it->second.c_str()
+                << "\"";
+        }
+        oss << " } ";
+    }
+    oss << "}\n";
+    std::string message = oss.str();
+    LOG(sls::logDEBUG) << "Data message:" << std::endl << message;
+
+    // creating header part of data packet
+    int length = message.length();
+    char *hdata = new char[length];
+    memcpy(hdata, message.c_str(), length);
+    zmq_msg_t *hmsg = new zmq_msg_t;
+    zmq_msg_init_data(hmsg, hdata, length, zmq_free, NULL);
+
+    // created data part of data packet
+    char *data = new char[imageSize];
+    zmq_msg_t *msg = new zmq_msg_t;
+    zmq_msg_init_data(msg, data, imageSize, zmq_free, NULL);
+
+    // push both parts into stat to be processed
+    FrameStatus *stat = static_cast<FrameStatus *>(objectPointer);
+    {
+        std::lock_guard<std::mutex> lock(stat->mtx);
+        stat->frames[callbackHeader.udpPort][header.detHeader.frameNumber]
+            .push_back(hmsg);
+        stat->frames[callbackHeader.udpPort][header.detHeader.frameNumber]
+            .push_back(msg);
+    }
+    sem_post(&stat->available);
+}
+
+/**
+ * Example of main program using the Receiver class
+ *
+ * - Defines in file for:
+ *  	- Default Number of receivers is 1
+ *  	- Default Start TCP port is 1954
+ */
+int main(int argc, char *argv[]) {
+
+    // version
+    if (argc == 2) {
+        std::string sargv1 = std::string(argv[1]);
+        if (sargv1 == "--version" || sargv1 == "-v") {
+            std::cout << "slsFrameSynchronizer Version: " << APIRECEIVER
+                      << std::endl;
+            exit(EXIT_SUCCESS);
+        }
+    }
+
+    /**	- set default values */
+    int numReceivers = 1;
+    uint16_t startTCPPort = DEFAULT_TCP_RX_PORTNO;
+    bool printHeaders = false;
+
+    /**	- get number of receivers and start tcp port from command line
+     * arguments */
+    if (argc > 1) {
+        try {
+            if (argc == 3 || argc == 4) {
+                startTCPPort = sls::StringTo<uint16_t>(argv[1]);
+                if (startTCPPort == 0) {
+                    throw std::runtime_error("Invalid start tcp port");
+                }
+                numReceivers = std::stoi(argv[2]);
+                if (numReceivers > 1024) {
+                    cprintf(RED,
+                            "Did you mix up the order of the arguments?\n%s\n",
+                            getHelpMessage().c_str());
+                    return EXIT_FAILURE;
+                }
+                if (numReceivers == 0) {
+                    cprintf(RED, "Invalid number of receivers.\n%s\n",
+                            getHelpMessage().c_str());
+                    return EXIT_FAILURE;
+                }
+                if (argc == 4) {
+                    printHeaders = sls::StringTo<bool>(argv[3]);
+                    if (printHeaders) {
+                        printHeadersLevel = sls::logINFOBLUE;
+                    }
+                }
+            } else
+                throw std::runtime_error("Invalid number of arguments");
+        } catch (const std::exception &e) {
+            cprintf(RED, "Error: %s\n%s\n", e.what(), getHelpMessage().c_str());
+            return EXIT_FAILURE;
+        }
+    }
+
+    cprintf(RESET, "Number of Receivers: %d\n", numReceivers);
+    cprintf(RESET, "Start TCP Port: %hu\n", startTCPPort);
+    cprintf(RESET, "Print Callback Headers: %s\n\n",
+            (printHeaders ? "Enabled" : "Disabled"));
+
+    /** - Catch signal SIGINT to close files and call destructors properly */
+    struct sigaction sa;
+    sa.sa_flags = 0;                     // no flags
+    sa.sa_handler = sigInterruptHandler; // handler function
+    sigemptyset(&sa.sa_mask); // dont block additional signals during invocation
+                              // of handler
+    if (sigaction(SIGINT, &sa, nullptr) == -1) {
+        cprintf(RED, "Could not set handler function for SIGINT\n");
+    }
+
+    /** - Ignore SIG_PIPE, prevents global signal handler, handle locally,
+       instead of a server crashing due to client crash when writing, it just
+       gives error */
+    struct sigaction asa;
+    asa.sa_flags = 0;          // no flags
+    asa.sa_handler = SIG_IGN;  // handler function
+    sigemptyset(&asa.sa_mask); // dont block additional signals during
+                               // invocation of handler
+    if (sigaction(SIGPIPE, &asa, nullptr) == -1) {
+        cprintf(RED, "Could not set handler function for SIGPIPE\n");
+    }
+
+    FrameStatus stat{true, false, numReceivers};
+    // store pointer for signal handler
+    global_frame_status = &stat;
+
+    // thread synchronizing all packets
+    void *user_data = static_cast<void *>(&stat);
+    std::thread combinerThread(Correlate, &stat);
+
+    for (int i = 0; i != numReceivers; ++i) {
+        sem_t *semaphore = new sem_t;
+        sem_init(semaphore, 1, 0);
+        semaphores.push_back(semaphore);
+
+        uint16_t port = startTCPPort + i;
+        threads.emplace_back([i, semaphore, port, user_data]() {
+            sls::Receiver receiver(port);
+            receiver.registerCallBackStartAcquisition(StartAcquisitionCallback,
+                                                      user_data);
+            receiver.registerCallBackAcquisitionFinished(
+                AcquisitionFinishedCallback, user_data);
+            receiver.registerCallBackRawDataReady(GetDataCallback, user_data);
+            /**	- as long as no Ctrl+C */
+            sem_wait(semaphore);
+            sem_destroy(semaphore);
+            delete semaphore;
+
+            // clean up frames
+            if (i == 0)
+                cleanup();
+        });
+    }
+
+    for (auto &thread : threads) {
+        thread.join();
+    }
+
+    {
+        std::lock_guard<std::mutex> lock(stat.mtx);
+        stat.terminate = true;
+        sem_post(&stat.available);
+    }
+    combinerThread.join();
+    sem_destroy(&stat.available);
+
+    LOG(sls::logINFOBLUE) << "Goodbye!";
+    return EXIT_SUCCESS;
+}

slsReceiverSoftware/src/Listener.cpp

@@ -149,12 +149,12 @@ void Listener::CreateUDPSocket(int &actualSize) {
             packetSize = generalData->vetoPacketSize;
         }
 
-        std::string ip =
-            (eth.length() ? InterfaceNameToIp(eth).str().c_str() : "");
-
+        std::string ip;
+        if (eth.length() > 0)
+            ip = InterfaceNameToIp(eth).str();
         udpSocket = nullptr;
         udpSocket = make_unique<UdpRxSocket>(
-            udpPortNumber, packetSize, (ip.length() ? ip.c_str() : nullptr),
+            udpPortNumber, packetSize, (ip.empty() ? nullptr : ip.c_str()),
             generalData->udpSocketBufferSize);
         LOG(logINFO) << index << ": UDP port opened at port " << udpPortNumber
                      << " (" << (ip.length() ? ip : "any") << ')';
@@ -213,10 +213,13 @@ void Listener::CreateDummySocketForUDPSocketBufferSize(int s, int &actualSize) {
     try {
         // to allowe ports to be bound from udpsocket
         udpSocket.reset();
-        UdpRxSocket g(
-            udpPortNumber, packetSize,
-            (eth.length() ? InterfaceNameToIp(eth).str().c_str() : nullptr),
-            generalData->udpSocketBufferSize);
+
+        std::string ip;
+        if (eth.length() > 0)
+            ip = InterfaceNameToIp(eth).str();
+        UdpRxSocket g(udpPortNumber, packetSize,
+                      (ip.empty() ? nullptr : ip.c_str()),
+                      generalData->udpSocketBufferSize);
 
         // doubled due to kernel bookkeeping (could also be less due to
         // permissions)

slsReceiverSoftware/src/MultiReceiverApp.cpp

@@ -7,6 +7,7 @@
 #include "sls/container_utils.h"
 #include "sls/logger.h"
 #include "sls/sls_detector_defs.h"
+#include "sls/versionAPI.h"
 
 #include <csignal> //SIGINT
 #include <cstring>
@@ -39,7 +40,9 @@ void sigInterruptHandler(int p) { sem_post(&semaphore); }
  */
 std::string getHelpMessage() {
     std::ostringstream os;
-    os << "\nUsage:\n"
+    os << "\nUsage:\n\n"
+       << "./slsMultiReceiver --version or -v\n"
+       << "\t - Gets the slsMultiReceiver version\n\n"
        << "./slsMultiReceiver [start tcp port] [num recevers] [call back "
           "option (optional)]\n"
        << "\t - tcp port has to be non-zero and 16 bit\n"
@@ -160,6 +163,16 @@ void GetData(slsDetectorDefs::sls_receiver_header &header,
  */
 int main(int argc, char *argv[]) {
 
+    // version
+    if (argc == 2) {
+        std::string sargv1 = std::string(argv[1]);
+        if (sargv1 == "--version" || sargv1 == "-v") {
+            std::cout << "slsMultiReceiver Version: " << APIRECEIVER
+                      << std::endl;
+            exit(EXIT_SUCCESS);
+        }
+    }
+
     /**	- set default values */
     int numReceivers = 1;
     uint16_t startTCPPort = DEFAULT_TCP_RX_PORTNO;
@@ -242,40 +255,43 @@ int main(int argc, char *argv[]) {
         else if (pid == 0) {
             cprintf(BLUE, "Child process %d [ Tid: %ld ]\n", i, (long)gettid());
 
-            std::unique_ptr<sls::Receiver> receiver = nullptr;
             try {
-                receiver = sls::make_unique<sls::Receiver>(startTCPPort + i);
+                uint16_t port = startTCPPort + i;
+                sls::Receiver receiver(port);
+
+                /**	- register callbacks. remember to set file write enable
+                 * to 0 (using the client) if we should not write files and you
+                 * will write data using the callbacks */
+                if (withCallback) {
+
+                    /** - Call back for start acquisition */
+                    cprintf(BLUE, "Registering StartAcq()\n");
+                    receiver.registerCallBackStartAcquisition(StartAcq,
+                                                              nullptr);
+
+                    /** - Call back for acquisition finished */
+                    cprintf(BLUE, "Registering AcquisitionFinished()\n");
+                    receiver.registerCallBackAcquisitionFinished(
+                        AcquisitionFinished, nullptr);
+
+                    /* 	- Call back for raw data */
+                    cprintf(BLUE, "Registering GetData() \n");
+                    receiver.registerCallBackRawDataReady(GetData, nullptr);
+                }
+
+                /**	- as long as no Ctrl+C */
+                sem_wait(&semaphore);
+                sem_destroy(&semaphore);
+
             } catch (...) {
                 LOG(sls::logINFOBLUE)
                     << "Exiting Child Process [ Tid: " << gettid() << " ]";
                 throw;
             }
-            /**	- register callbacks. remember to set file write enable to 0
-             * (using the client) if we should not write files and you will
-             * write data using the callbacks */
-            if (withCallback) {
 
-                /** - Call back for start acquisition */
-                cprintf(BLUE, "Registering StartAcq()\n");
-                receiver->registerCallBackStartAcquisition(StartAcq, nullptr);
-
-                /** - Call back for acquisition finished */
-                cprintf(BLUE, "Registering AcquisitionFinished()\n");
-                receiver->registerCallBackAcquisitionFinished(
-                    AcquisitionFinished, nullptr);
-
-                /* 	- Call back for raw data */
-                cprintf(BLUE, "Registering GetData() \n");
-                receiver->registerCallBackRawDataReady(GetData, nullptr);
-            }
-
-            /**	- as long as no Ctrl+C */
-            sem_wait(&semaphore);
-            sem_destroy(&semaphore);
             cprintf(BLUE, "Exiting Child Process [ Tid: %ld ]\n",
                     (long)gettid());
             exit(EXIT_SUCCESS);
-            break;
         }
     }
 

slsReceiverSoftware/src/Receiver.cpp

@@ -62,7 +62,7 @@ Receiver::Receiver(int argc, char *argv[]) : tcpipInterface(nullptr) {
         "\t                          started with privileges. \n\n";
 
     while (c != -1) {
-        c = getopt_long(argc, argv, "hvf:t:u:", long_options, &option_index);
+        c = getopt_long(argc, argv, "hvt:u:", long_options, &option_index);
 
         // Detect the end of the options.
         if (c == -1)
@@ -87,7 +87,7 @@ Receiver::Receiver(int argc, char *argv[]) : tcpipInterface(nullptr) {
             break;
 
         case 'v':
-            std::cout << "SLS Receiver Version: " << APIRECEIVER << std::endl;
+            std::cout << "slsReceiver Version: " << APIRECEIVER << std::endl;
             LOG(logINFOBLUE) << "Exiting [ Tid: " << gettid() << " ]";
             exit(EXIT_SUCCESS);
 

slsSupportLib/include/sls/logger.h

@@ -16,6 +16,8 @@ enum TLogLevel {
     logINFOBLUE,
     logINFOGREEN,
     logINFORED,
+    logINFOCYAN,
+    logINFOMAGENTA,
     logINFO,
     logDEBUG,
     logDEBUG1,
@@ -60,16 +62,25 @@ class Logger {
     // Danger this buffer need as many elements as TLogLevel
     static const char *Color(TLogLevel level) noexcept {
         static const char *const colors[] = {
-            RED BOLD, YELLOW BOLD, BLUE,  GREEN, RED,   RESET,
-            RESET,    RESET,       RESET, RESET, RESET, RESET};
+            RED BOLD, YELLOW BOLD, BLUE,  GREEN, RED,   CYAN,  MAGENTA,
+            RESET,    RESET,       RESET, RESET, RESET, RESET, RESET};
+        // out of bounds
+        if (level < 0 || level >= sizeof(colors) / sizeof(colors[0])) {
+            return RESET;
+        }
         return colors[level];
     }
 
     // Danger this buffer need as many elements as TLogLevel
     static std::string ToString(TLogLevel level) {
         static const char *const buffer[] = {
-            "ERROR", "WARNING", "INFO",   "INFO",   "INFO",   "INFO",
-            "DEBUG", "DEBUG1",  "DEBUG2", "DEBUG3", "DEBUG4", "DEBUG5"};
+            "ERROR",  "WARNING", "INFO",   "INFO",  "INFO",
+            "INFO",   "INFO",    "INFO",   "DEBUG", "DEBUG1",
+            "DEBUG2", "DEBUG3",  "DEBUG4", "DEBUG5"};
+        // out of bounds
+        if (level < 0 || level >= sizeof(buffer) / sizeof(buffer[0])) {
+            return "UNKNOWN";
+        }
         return buffer[level];
     }
 

slsSupportLib/include/sls/versionAPI.h

@@ -1,13 +1,13 @@
 // SPDX-License-Identifier: LGPL-3.0-or-other
 // Copyright (C) 2021 Contributors to the SLS Detector Package
 /** API versions */
-#define APICTB       "developer 0x241107"
-#define APIGOTTHARD  "developer 0x241107"
-#define APIGOTTHARD2 "developer 0x241107"
-#define APIMOENCH    "developer 0x241107"
-#define APIXILINXCTB "developer 0x241107"
-#define APIEIGER     "developer 0x241107"
-#define APIJUNGFRAU  "developer 0x241120"
-#define APIMYTHEN3   "developer 0x241121"
-#define APILIB       "developer 0x241122"
-#define APIRECEIVER  "developer 0x241122"
+#define APIGOTTHARD  "9.0.0 0x241121"
+#define APIGOTTHARD2 "9.0.0 0x241121"
+#define APIMOENCH    "9.0.0 0x241121"
+#define APIEIGER     "9.0.0 0x241121"
+#define APICTB       "9.1.0 0x250204"
+#define APIXILINXCTB "9.1.0 0x250204"
+#define APIMYTHEN3   "9.1.0 0x250304"
+#define APIJUNGFRAU  "9.1.0 0x250318"
+#define APILIB       "9.1.0 0x250325"
+#define APIRECEIVER  "9.1.0 0x250325"