Merge branch 'developer' of github.com:slsdetectorgroup/slsDetectorPackage into developer

G2cont

.github/ISSUE_TEMPLATE/bug_report.md

@@ -5,40 +5,22 @@ title: New Bug Report
 labels: action - Bug, priority - Unclassified, status - Pending
 template: bug_report.md
 ---
-
-<!--  Check an option by - [x], Uncheck an option by - [ ] -->
-<!-- Please preview to see your option has been selected -->
-
+<!-- Preview changes before submitting -->
 <!-- Please fill out everything with an *, as this report will be discarded otherwise -->
+<!-- This is a comment, the syntax is a bit different from c++ or bash -->
 
 ##### *Distribution: 
-- [x] RHEL7
-- [ ] RHEL6
-- [ ] Fedora
-- [ ] Other
+<!-- RHEL7, RHEL6, Fedora, etc -->
+
 
 ##### *Detector type: 
-- [x] Not applicable
-- [ ] Eiger
-- [ ] Jungfrau
-- [ ] Mythen3
-- [ ] Gotthard2
-- [ ] Gotthard
-- [ ] Moench
-- [ ] ChipTestBoard
+<!-- If applicable, Eiger, Jungfrau, Mythen3, Gotthard2, Gotthard, Moench, ChipTestBoard -->
 
 ##### *Software Package Version: 
-- [ ] developer
-- [ ] 4.2.0
-- [ ] 4.1.1
-<!-- If others, please describe -->
+<!-- developer, 4.2.0, 4.1.1, etc -->
 
 ##### Priority:
-- [ ] Super Low
-- [ ] Low
-- [ ] Medium
-- [ ] High
-- [ ] Super High
+<!-- Super Low, Low, Medium, High, Super High -->
 
 ##### *Describe the bug
 <!--  A clear and concise description of what the bug is -->

.github/ISSUE_TEMPLATE/change_request.md

@@ -5,34 +5,18 @@ title: New Change Request
 labels: action - Change, priority - Unclassified, status - Pending
 template: change_request.md
 ---
-
-<!--  Check an option by - [x], Uncheck an option by - [ ] -->
-<!-- Please preview to see your option has been selected -->
-
+<!-- Preview changes before submitting -->
 <!-- Please fill out everything with an *, as this report will be discarded otherwise -->
+<!-- This is a comment, the syntax is a bit different from c++ or bash -->
 
 ##### *Detector type: 
-- [x] Not applicable
-- [ ] Eiger
-- [ ] Jungfrau
-- [ ] Mythen3
-- [ ] Gotthard2
-- [ ] Gotthard
-- [ ] Moench
-- [ ] ChipTestBoard
+<!-- If applicable, Eiger, Jungfrau, Mythen3, Gotthard2, Gotthard, Moench, ChipTestBoard -->
 
 ##### *Software Package Version: 
-- [ ] developer
-- [ ] 4.2.0
-- [ ] 4.1.1
-<!-- If others, please describe -->
+<!-- developer, 4.2.0, 4.1.1, etc -->
 
 ##### Priority:
-- [ ] Super Low
-- [ ] Low
-- [ ] Medium
-- [ ] High
-- [ ] Super High
+<!-- Super Low, Low, Medium, High, Super High -->
 
 ##### *State the change request:
 <!--  A clear and concise description of what the change is to an existing feature -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,38 +1,22 @@
 ---
 name: Feature Request
-about: Suggest a feature
+about: Suggest a feature, documentation or submit a question
 title: New Feature Request
 labels: action - Enhancement, priority - Unclassified, status - Pending
 template: feature_request.md
 ---
-
-<!--  Check an option by - [x], Uncheck an option by - [ ] -->
-<!-- Please preview to see your option has been selected -->
-
+<!-- Preview changes before submitting -->
 <!-- Please fill out everything with an *, as this report will be discarded otherwise -->
+<!-- This is a comment, the syntax is a bit different from c++ or bash -->
 
 ##### *Detector type: 
-- [x] Not applicable
-- [ ] Eiger
-- [ ] Jungfrau
-- [ ] Mythen3
-- [ ] Gotthard2
-- [ ] Gotthard
-- [ ] Moench
-- [ ] ChipTestBoard
+<!-- If applicable, Eiger, Jungfrau, Mythen3, Gotthard2, Gotthard, Moench, ChipTestBoard -->
 
 ##### *Software Package Version: 
-- [ ] developer
-- [ ] 4.2.0
-- [ ] 4.1.1
-<!-- If others, please describe -->
+<!-- developer, 4.2.0, 4.1.1, etc -->
 
 ##### Priority:
-- [ ] Super Low
-- [ ] Low
-- [ ] Medium
-- [ ] High
-- [ ] Super High
+<!-- Super Low, Low, Medium, High, Super High -->
 
 ##### *State the feature:
 <!--  A clear and concise description of what the feature is -->

CMakeLists.txt

@@ -63,17 +63,18 @@ find_package(ClangFormat)
 check_ipo_supported(RESULT SLS_LTO_AVAILABLE)
 
 
-# Use ld.gold if it is available and isn't disabled explicitly
-option(SLS_USE_LD_GOLD "Use GNU gold linker" ON)
-if (SLS_USE_LD_GOLD)
-    execute_process(COMMAND ${CMAKE_C_COMPILER} -fuse-ld=gold -Wl,--version ERROR_QUIET OUTPUT_VARIABLE LD_VERSION)
-    if ("${LD_VERSION}" MATCHES "GNU gold")
-        set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fuse-ld=gold")
-        set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fuse-ld=gold")
-    else ()
-        message(WARNING "GNU gold linker isn't available, using the default system linker.")
-    endif ()
-endif ()
+# # Use ld.gold if it is available and isn't disabled explicitly
+# option(SLS_USE_LD_GOLD "Use GNU gold linker" ON)
+# if (SLS_USE_LD_GOLD)
+#     execute_process(COMMAND ${CMAKE_C_COMPILER} -fuse-ld=gold -Wl,--version ERROR_QUIET OUTPUT_VARIABLE LD_VERSION)
+#     if ("${LD_VERSION}" MATCHES "GNU gold")
+#         set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -fuse-ld=gold")
+#         set(CMAKE_STATIC_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -fuse-ld=gold")
+#         set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -fuse-ld=gold")
+#     else ()
+#         message(WARNING "GNU gold linker isn't available, using the default system linker.")
+#     endif ()
+# endif ()
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 
 if (NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
@@ -240,7 +241,7 @@ if(SLS_MASTER_PROJECT)
     # Set install dir CMake packages
     set(CMAKE_INSTALL_DIR "share/cmake/${PROJECT_NAME}")
     # Set the list of exported targets
-    set(PROJECT_LIBRARIES slsSupportLib slsDetectorShared slsReceiverShared)
+    set(PROJECT_LIBRARIES slsSupportShared slsDetectorShared slsReceiverShared)
     # Generate and install package config file and version
     include(cmake/package_config.cmake)
 endif()

RELEASE.txt

@@ -1,2 +1,114 @@
-Draft
-- dr 4, 8, 16 in eiger -> speed 0, 32 stays same (speed 1)
+SLS Detector Package 5.0.0-rc1 released on 25.09.2020 (Release Candidate 1)
+===========================================================================
+
+    CONTENTS
+    --------
+    1.  Firmware Requirements
+    2.  Download, Documentation & Support
+
+
+1. Firmware Requirements
+========================
+        
+        Eiger
+        =====  
+        Minimum compatible version  : 27
+        Latest compatible version   : 27
+        
+        Jungfrau
+        ========       
+        Minimum compatible version (PCB v1.0)  : 24.07.2020 (v0.8)
+        Latest compatible version  (PCB v1.0)  : 24.07.2020 (v0.8)
+        Minimum compatible version (PCB v2.0)  : 21.07.2020 (v2.1)
+        Latest compatible version  (PCB v2.0)  : 21.07.2020 (v2.1)
+
+        Gotthard
+        ========   
+        Minimum compatible version  : 11.01.2013
+        Latest compatible version   : 08.02.2018 (50um and 25um Master)
+                                      09.02.2018 (25 um Slave) 
+
+        Mythen3
+        =======
+        Minimum compatible version  : 25.09.2020
+        Latest compatible version   : 25.09.2020
+
+        Gotthard2
+        =========
+        Minimum compatible version  : 25.09.2020
+        Latest compatible version   : 25.09.2020
+
+        Moench
+        ======
+        Minimum compatible version : 02.03.2020
+        Latest compatible version  : 02.03.2020 
+
+        Ctb
+        ===
+        Minimum compatible version : 27.11.2019
+        Latest compatible version  : 27.11.2019
+
+
+        Detector Upgrade
+        ================
+        Eiger      Remotely via bit files
+        Jungfrau   Remotely using sls_detector_put programfpga <pof>
+        Gotthard   Cannot be upgraded remotely. Requires programming via USB blaster
+        Mythen3    Remotely using sls_detector_put programfpga <rbf>
+        Gotthard2  Remotely using sls_detector_put programfpga <rbf> 
+        Moench     Remotely using sls_detector_put programfpga <pof>
+        Ctb        Remotely using sls_detector_put programfpga <pof>
+
+        Instructions available at
+        https://slsdetectorgroup.github.io/devdoc/firmware.html
+
+    Please refer to the link below for more details on the firmware versions.
+    https://www.psi.ch/en/detectors/firmware
+
+    
+2. Download, Documentation & Support
+====================================
+
+    Download
+    --------
+    
+    The Source Code (Default C++ API):
+         https://github.com/slsdetectorgroup/slsDetectorPackage
+            
+    Documentation
+    -------------
+    
+    Installation:
+        https://slsdetectorgroup.github.io/devdoc/installation.html#
+
+    Consuming slsDetectorPackage:
+        https://slsdetectorgroup.github.io/devdoc/consuming.html
+        
+    Command Line Documentation:
+        https://slsdetectorgroup.github.io/devdoc/commandline.html
+        
+    C++ API Documentation:
+        https://slsdetectorgroup.github.io/devdoc/detector.html
+       
+    C++ API Example:
+        https://slsdetectorgroup.github.io/devdoc/examples.html#
+        
+    Python API Documentation:
+        https://slsdetectorgroup.github.io/devdoc/pygettingstarted.html
+
+    Python API Example:
+        https://slsdetectorgroup.github.io/devdoc/pyexamples.html
+
+    TroubleShooting:
+        https://www.psi.ch/en/detectors/troubleshooting
+        
+    Further Documentation:
+        https://www.psi.ch/en/detectors/users-support
+        
+    
+    Support
+    -------
+
+        dhanya.thattil@psi.ch
+        erik.frojdh@psi.ch
+        anna.bergamaschi@psi.ch

cmake/FindSphinx.cmake

@@ -1,6 +1,6 @@
 #Look for an executable called sphinx-build
 find_program(SPHINX_EXECUTABLE
-             NAMES sphinx-build
+             NAMES sphinx-build sphinx-build-3.6
              DOC "Path to sphinx-build executable")
  
 include(FindPackageHandleStandardArgs)

cmk.sh

@@ -12,6 +12,7 @@ TESTS=0
 SIMULATOR=0
 CTBGUI=0
 MANUALS=0
+MANUALS_ONLY_RST=0
 MOENCHZMQ=0
 
 
@@ -21,7 +22,7 @@ CMAKE_PRE=""
 CMAKE_POST=""
 
 usage() { echo -e "
-Usage: $0 [-c] [-b] [-p] [e] [t] [r] [g] [s] [u] [i] [m] [-h] [z] [-d <HDF5 directory>] [-j] <Number of threads>
+Usage: $0 [-c] [-b] [-p] [e] [t] [r] [g] [s] [u] [i] [m] [n] [-h] [z] [-d <HDF5 directory>] [-j] <Number of threads>
  -[no option]: only make
  -c: Clean
  -b: Builds/Rebuilds CMake files normal mode
@@ -37,6 +38,7 @@ Usage: $0 [-c] [-b] [-p] [e] [t] [r] [g] [s] [u] [i] [m] [-h] [z] [-d <HDF5 dire
  -e: Debug mode
  -i: Builds tests
  -m: Manuals
+ -n: Manuals without compiling doxygen (only rst)
  -z: Moench zmq processor
 
 Rebuild when you switch to a new build and compile in parallel:
@@ -73,7 +75,7 @@ For rebuilding only certain sections
  
  " ; exit 1; }
 
-while getopts ":bpchd:j:trgeisumz" opt ; do
+while getopts ":bpchd:j:trgeisumnz" opt ; do
 	case $opt in
 	b) 
 		echo "Building of CMake files Required"
@@ -132,6 +134,10 @@ while getopts ":bpchd:j:trgeisumz" opt ; do
 		echo "Compiling Manuals"
 		MANUALS=1
 		;;
+	n)	
+		echo "Compiling Manuals (Only RST)"
+		MANUALS_ONLY_RST=1
+		;;
 	z)	
 		echo "Compiling Moench Zmq Processor"
 		MOENCHZMQ=1
@@ -268,20 +274,33 @@ fi
 
 #make
 if [ $COMPILERTHREADS -gt 0 ]; then
+	if [ $MANUALS -eq 0 ] && [ $MANUALS_ONLY_RST -eq 0 ]; then
 		BUILDCOMMAND="make -j$COMPILERTHREADS"
 		echo $BUILDCOMMAND
 		eval $BUILDCOMMAND
+	else
 		if [ $MANUALS -eq 1 ]; then
 			BUILDCOMMAND="make docs -j$COMPILERTHREADS"
 			echo $BUILDCOMMAND
 			eval $BUILDCOMMAND
+		else
+			BUILDCOMMAND="make rst -j$COMPILERTHREADS"
+			echo $BUILDCOMMAND
+			eval $BUILDCOMMAND		
+		fi
 	fi 
 else
+	if [ $MANUALS -eq 0 ] && [ $MANUALS_ONLY_RST -eq 0 ]; then
 		echo "make"
 		make
+	else
 		if [ $MANUALS -eq 1 ]; then
 			echo "make docs"
 			make docs
+		else
+			echo "make rst"
+			make rst
+		fi
 	fi 
 fi
 

conda-recepie/meta.yaml

@@ -33,6 +33,7 @@ requirements:
     - {{ cdt('libselinux') }}            # [linux]
     - {{ cdt('libxdamage') }}            # [linux]
     - {{ cdt('libxxf86vm') }}            # [linux]
+    - expat
 
   host:
     - libstdcxx-ng
@@ -45,6 +46,7 @@ requirements:
     - xorg-libxau
     - xorg-libxrender
     - xorg-libxfixes
+    - expat
 
   run:
     - zeromq
@@ -96,3 +98,4 @@ outputs:
         - {{ pin_subpackage('slsdetlib', exact=True) }}
         - qwt 6.*
         - qt 4.8.*
+        - expat

ctbGui/CMakeLists.txt

@@ -59,14 +59,13 @@ set( HEADERS
 #set(ROOT_INCLUDE_PATH ${CMAKE_CURRENT_SOURCE_DIR})
 
 # ROOT dictionary generation 
-include("${ROOT_DIR}/modules/RootNewMacros.cmake")
+include("${ROOT_DIR}/RootMacros.cmake")
 root_generate_dictionary(ctbDict ${HEADERS} LINKDEF ctbLinkDef.h)
 add_library(ctbRootLib SHARED ctbDict.cxx)
 target_include_directories(ctbRootLib PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})
 target_link_libraries(ctbRootLib PUBLIC 
     ROOT::Core 
     slsDetectorShared
-    slsSupportLib
     ${ROOT_LIBRARIES} 
     ${ROOT_EXE_LINKER_FLAGS}
 )
@@ -78,7 +77,6 @@ set_target_properties(
 
 target_link_libraries(ctbGui PUBLIC 
     slsDetectorShared
-    slsSupportLib
     ctbRootLib
     ${TIFF_LIBRARIES}
 )

docs/CMakeLists.txt

@@ -38,11 +38,15 @@ set(SPHINX_SOURCE_FILES
   src/pydetector.rst
   src/pyenums.rst
   src/pyexamples.rst
+  src/servers.rst
   src/receiver.rst
   src/result.rst
   src/type_traits.rst
   src/ToString.rst
   src/examples.rst
+  src/pygettingstarted.rst
+  src/firmware.rst
+  src/serverupgrade.rst
   
 )
 
@@ -56,8 +60,21 @@ configure_file(
   "${SPHINX_BUILD}/conf.py"
   @ONLY)
 
+configure_file(
+  "${CMAKE_CURRENT_SOURCE_DIR}/gen_server_doc.py.in"
+  "${SPHINX_BUILD}/gen_server_doc.py"
+  @ONLY)
+
+  configure_file(
+  "${CMAKE_CURRENT_SOURCE_DIR}/static/extra.css"
+  "${SPHINX_BUILD}/static/css/extra.css"
+  @ONLY)
+
+add_custom_target(server_rst python gen_server_doc.py)  
+
 add_custom_target(docs
               gendoc
+              COMMAND python gen_server_doc.py
               COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_OUT}
               COMMAND ${SPHINX_EXECUTABLE} -a -b html
               -Dbreathe_projects.slsDetectorPackage=${CMAKE_CURRENT_BINARY_DIR}/xml
@@ -73,3 +90,4 @@ add_custom_target(rst
               ${SPHINX_BUILD}/src 
               ${SPHINX_BUILD}/html
               COMMENT "Generating documentation with Sphinx")
+

docs/conf.py.in

@@ -59,4 +59,8 @@ html_theme = "sphinx_rtd_theme"
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-#html_static_path = ['_static']
+html_static_path = ['static']
+
+
+def setup(app):
+    app.add_stylesheet('css/extra.css')  # may also be an URL

docs/gen_server_doc.py.in

@@ -0,0 +1,86 @@
+import os 
+import re
+from pathlib import Path
+def remove_comments(text):
+    def replacer(match):
+        s = match.group(0)
+        if s.startswith('/'):
+            return " " # note: a space and not an empty string
+        else:
+            return s
+    pattern = re.compile(
+        r'//.*?$|/\*.*?\*/|\'(?:\\.|[^\\\'])*\'|"(?:\\.|[^\\"])*"',
+        re.DOTALL | re.MULTILINE
+    )
+    return re.sub(pattern, replacer, text)
+
+
+# @CMAKE_CURRENT_BINARY_DIR@
+
+print('\n\n\n\n SERVER CSV')
+
+src = Path('@CMAKE_SOURCE_DIR@')/'slsDetectorServers/'
+detectors = ['Mythen3', 'Gotthard2', 'Eiger', 
+            'Jungfrau', 'Moench', 'Gotthard', 'Ctb']
+
+
+for det in detectors:
+    print(det)
+    in_fname = src/f'{det.lower()}DetectorServer/slsDetectorServer_defs.h'
+    #print(f'Reading: {in_fname}')
+    with open(in_fname) as f:
+        lines = f.read().replace('\\\n', '')
+        lines = lines.splitlines(keepends = True)
+
+    lines = [l.strip('#define').strip(' ') for l in lines if l.startswith('#define')]
+    output = []
+    signals = []
+    fields = ['Name,', 'Value', 'Comment']
+    excluded = ['DAC_NAMES', 'DEFAULT_DAC_VALS', 'CLK_NAMES', 'ONCHIP_DAC_NAMES']
+    header = f'{fields[0]:35}{fields[1]:35}\n'
+    output.append(header)
+    signals.append(header)
+    dac_names = []
+    dac_values = []
+    for line in lines:
+        name, *parts = line.split()
+        arg = ' '.join(parts)
+        value, *comments = arg.split('//') 
+        value = value.strip('() ')
+        # value = value.replace(', ', ' ')
+        value = value.replace('\"', '')
+        if name not in excluded:
+            name += ','
+            if name.startswith('SIGNAL_'):
+                signals.append(f'{name:35}{value}\n')
+            else:
+                output.append(f'{name:35}\"{value}\"\n')
+        elif name == 'DAC_NAMES':
+            dac_names = [v.strip(', ') for v in value.split()]
+            dac_names = [n+',' for n in dac_names]
+        elif name == 'DEFAULT_DAC_VALS':
+            dac_values = remove_comments(value).strip('{}; ')
+            dac_values = dac_values.replace(',', '').split()
+            dac_values = [v.strip('') for v in dac_values]
+
+    print(f"dac_names: {len(dac_names)}, dac_values={len(dac_values)}")
+    if len(dac_values) == 0:
+        dac_values = ['N/A']*len(dac_names)
+
+    
+
+    rstpath = Path('@CMAKE_SOURCE_DIR@')/'docs/src/'
+
+    out_fname = Path.cwd()/f'src/{det.lower()}.csv'
+    out_dac_fname = Path.cwd()/f'src/{det.lower()}-dacs.csv'
+    #print(f'Writing: {out_fname}')
+    with open(out_fname, 'w') as f:
+        f.writelines(output)
+
+    output = [f'{n:35}{v}\n' for n,v in zip(dac_names, dac_values)]
+    output.insert(0, header)
+
+    with open(out_dac_fname, 'w') as f:
+        f.writelines(output)
+
+print('END\n\n\n\n')

docs/src/commandline.rst

@@ -4,12 +4,28 @@ Command line interface
 Usage
 -------------
 
-Commands can be uses either with sls_detector_get or sls_detector_put
+Commands can be used either with sls_detector_get or sls_detector_put
 
 .. code-block::
 
     sls_detector_get vrf
 
+Help
+--------
+
+.. code-block::
+
+    # get list of commands
+    sls_detector_get list
+
+    # search for a particular command using a word
+    sls_detector_get list | grep adc
+
+    # get help for a particular command
+    sls_detector_get -h fpath
+    sls_detector_help fpath
+  
+
 Commands
 -----------
 

docs/src/firmware.rst

@@ -0,0 +1,357 @@
+Firmware Upgrade
+=================
+
+
+
+Eiger
+-------------
+.. note ::
+    | Eiger firmware can be upgraded remotely.
+    | The programming executable (bcp) and corresponding bit files are provided by the SLS Detector group.
+
+
+Compatibility 
+^^^^^^^^^^^^^
+
+**Release candidate 5.0.0-rc1**
+    .. code-block:: bash
+
+        Minimum compatible version  : 27
+        Latest compatible version   : 27  
+    
+`Older versions <https://www.psi.ch/en/detectors/latest-installation>`_
+
+
+Upgrade
+^^^^^^^^
+#. Tftp must be already installed on your pc to use the bcp executable.
+
+#. Kill the on-board servers and copy new servers to the board. 
+
+    .. code-block:: bash
+
+        # Option 1: from detector console
+        # kill old server
+        ssh root@bebxxx
+        killall eigerDetectorServer
+
+        # copy new server
+        cd executables
+        scp user@pc:/path/eigerDetectorServerxxx .
+        chmod 777 eigerDetectorServerxxx
+        ln -sf eigerDetectorServerxxx eigerDetectorServer
+        sync
+
+        # Options 2: from client console for multiple modules
+        for i in bebxxx bebyyy;
+        do ssh root@$i killall eigerDetectorServer;
+        scp eigerDetectorServerxxx root@$i:~/executables/eigerDetectorServer;
+        ssh root@$i sync; done
+
+
+    * This is crucial when registers between firmwares change. Failure to do so will result in linux on boards to crash and boards can't be pinged anymore.
+
+#. Bring the board into programmable mode using either of the 2 ways. Both methods result in only the central LED blinking.
+    
+    * **Manual:**
+    
+        Do a hard reset for each half module on back panel boards, between the LEDs, closer to each of the 1G ethernet connectors. Push until all LEDs start to blink.
+    
+    * Software:  
+        .. code-block:: bash
+
+            ssh root@bebxxx
+            cd executables
+            ./boot_recovery
+
+#. Start a terminal for each half module and run the following to see progress.
+
+    .. code-block:: bash
+    
+    	nc -p 3000 -u bebxxx 3000
+        # Press enter twice to see prompt with board name.
+        > bebxxx
+        # After each bcp command, wait for this terminal to print "Success".
+
+
+#. In another terminal, run the following to update firmware. Please update bit files with great caution as it could make your board inaccessible, if done incorrectly.
+
+    .. code-block:: bash
+    
+        #update back end fpga
+        bcp download.bit bebxxx:/fw0
+
+        #update front left fpga
+        bcp download.bit bebxxx:/febl
+
+        #update front right fpga
+        bcp download.bit bebxxx:/febr
+
+        #update kernel (only if required by the SLS Detector Group)
+        bcp download.bit bebxxx:/kernel
+
+#. Reboot the detector.
+
+Jungfrau
+-------------
+.. note ::
+    | Jungfrau firmware can be upgraded remotely.
+    | The corresponding programming file (pof) is provided by the SLS Detector group.
+
+
+Compatibility 
+^^^^^^^^^^^^^
+
+**Release candidate 5.0.0-rc1**
+
+    .. code-block:: bash
+
+        # PCB v1.0
+        Minimum compatible version : 24.07.2020 (v0.8)
+        Latest compatible version  : 24.07.2020 (v0.8)
+        # PCB v2.0
+        Minimum compatible version : 21.07.2020 (v2.1)
+        Latest compatible version  : 21.07.2020 (v2.1) 
+    
+`Older versions <https://www.psi.ch/en/detectors/latest-installation>`_
+
+
+Upgrade (from v4.x.x)
+^^^^^^^^^^^^^^^^^^^^
+#. Tftp must be installed on pc.
+
+#. Update client package to the latest (5.0.0-rc1).
+
+#. Disable server respawning or kill old server
+    .. code-block:: bash
+
+        # Option 1: if respawning enabled
+        telnet bchipxxx
+        # edit /etc/inittab
+        # comment out line #ttyS0::respawn:/jungfrauDetectorServervxxx
+        reboot
+        # ensure servers did not start up after reboot
+        telnet bchipxxx
+        ps
+
+        #  Option 2: if respawning already disabled
+        telnet bchipxxx
+        killall jungfrauDetectorServerv*
+
+#. Copy new server and start in update mode
+    .. code-block:: bash
+
+        tftp pcxxx -r jungfrauDetectorServervxxx -g
+        chmod 777 jungfrauDetectorServervxxx
+        ./jungfrauDetectorServervxxx -u
+
+#. Program fpga from the client console
+    .. code-block:: bash
+
+        sls_detector_get free
+        # Crucial that the next command executes without any errors
+        sls_detector_put hostname bchipxxx
+        sls_detector_put programfpga xxx.pof
+
+#. After programming, kill update server using Ctrl + C.
+
+#. Enable server respawning if needed
+    .. code-block:: bash
+
+        telnet bchipxxx
+        # edit /etc/inittab
+        # uncomment out line #ttyS0::respawn:/jungfrauDetectorServervxxx
+        # ensure the line has the new server name
+        reboot
+        # ensure both servers are running using ps
+        jungfrauDetectorServervxxx
+        jungfrauDetectorServervxxx --stop-server 1953
+
+
+Upgrade (from v5.0.0-rc1)
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+#. Program from console
+    .. code-block:: bash
+
+        # copies server from tftp folder of pc, programs fpga,
+        # removes old server from respawn, sets up new server to respawn
+        # and reboots
+        sls_detector_put update jungfrauDetectorServervxxx pcxxx xx.pof
+
+        # Or only program firmware
+        sls_detector_put programfpga xxx.pof
+
+
+Gotthard
+---------
+
+.. warning ::
+    | Gotthard firmware cannot be upgraded remotely and requires the use of USB-Blaster.
+    | It is generally updated by the SLS Detector group.
+
+
+Compatibility 
+^^^^^^^^^^^^^
+
+**Release candidate 5.0.0-rc1**
+
+    .. code-block:: bash
+
+        Minimum compatible version  : 11.01.2013
+        Latest compatible version   : 08.02.2018 (50um and 25um Master)
+                                  09.02.2018 (25 um Slave)  
+    
+`Older versions <https://www.psi.ch/en/detectors/latest-installation>`_
+
+
+Upgrade
+^^^^^^^^
+
+#. Download `Altera Quartus software or Quartus programmer <https://fpgasoftware.intel.com/20.1/?edition=standard&platform=linux&product=qprogrammer#tabs-4>`_.
+   
+
+#. Start Quartus programmer, click on Hardware Setup. In the "Currently selected hardware" window, select USB-Blaster.
+
+#. In the Mode combo box, select "Active Serial Programming".
+
+#. Plug the end of your USB-Blaster with the adaptor provided to the connector 'AS config' on the Gotthard board.
+
+#. Click on 'Add file'. Select programming (pof) file provided by the SLS Detector group.
+
+#. Check "Program/Configure" and "Verify". Push the start button. Wait until the programming process is finished.
+
+#. In case of error messages, check the polarity of cable (that pin1 corresponds) and that the correct programming connector is selected.
+
+#. Reboot the detector.
+
+
+Mythen3
+-------
+.. note ::
+    | Mythen3 firmware can be upgraded remotely.
+    | The corresponding programming file (rbf) is provided by the SLS Detector group.
+
+
+Compatibility 
+^^^^^^^^^^^^^
+
+**Release candidate 5.0.0-rc1**
+
+    .. code-block:: bash
+
+        Minimum compatible version : 25.09.2020
+        Latest compatible version  : 25.09.2020
+    
+
+Upgrade (from v5.0.0-rc1)
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+#. Program from console
+    .. code-block:: bash
+
+        # copies server from tftp folder of pc, programs fpga,
+        # and reboots (new server not respawned currently)
+        sls_detector_put update mythen3DetectorServervxxx pcxxx xxx.rbf
+
+        # Or only program firmware
+        sls_detector_put programfpga xxx.rbf
+
+
+
+Gotthard2
+----------
+.. note ::
+    | Gotthard2 firmware can be upgraded remotely.
+    | The corresponding programming file (rbf) is provided by the SLS Detector group.
+
+
+Compatibility 
+^^^^^^^^^^^^^
+
+**Release candidate 5.0.0-rc1**
+
+    .. code-block:: bash
+
+        Minimum compatible version : 25.09.2020
+        Latest compatible version  : 25.09.2020
+    
+
+Upgrade (from v5.0.0-rc1)
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+#. Program from console
+    .. code-block:: bash
+
+        # copies server from tftp folder of pc, programs fpga,
+        # and reboots (new server not respawned currently)
+        sls_detector_put update gotthard2DetectorServervxxx pcxxx xxx.rbf
+
+        # Or only program firmware
+        sls_detector_put programfpga xxx.rbf
+
+
+
+Moench
+------
+.. note ::
+    | Moench firmware can be upgraded remotely.
+    | The corresponding programming file (pof) is provided by the SLS Detector group.
+
+
+Compatibility 
+^^^^^^^^^^^^^
+
+**Release candidate 5.0.0-rc1**
+
+    .. code-block:: bash
+
+        Minimum compatible version : 02.03.2020
+        Latest compatible version  : 02.03.2020 
+    
+
+Upgrade (from v5.0.0-rc1)
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+#. Program from console
+    .. code-block:: bash
+
+        # copies server from tftp folder of pc, programs fpga,
+        # removes old server from respawn, sets up new server to respawn
+        # and reboots
+        sls_detector_put update moenchDetectorServervxxx pcxxx xx.pof
+
+        # Or only program firmware
+        sls_detector_put programfpga xxx.pof
+
+Ctb
+---
+.. note ::
+    | Ctb firmware can be upgraded remotely.
+    | The corresponding programming file (pof) is provided by the SLS Detector group.
+
+
+Compatibility 
+^^^^^^^^^^^^^
+
+**Release candidate 5.0.0-rc1**
+
+    .. code-block:: bash
+
+        Minimum compatible version : 27.11.2019
+        Latest compatible version  : 27.11.2019
+    
+
+Upgrade (from v5.0.0-rc1)
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+#. Program from console
+    .. code-block:: bash
+
+        # copies server from tftp folder of pc, programs fpga,
+        # removes old server from respawn, sets up new server to respawn
+        # and reboots
+        sls_detector_put update ctbDetectorServervxxx pcxxx xx.pof
+
+        # Or only program firmware
+        sls_detector_put programfpga xxx.pof

docs/src/gendoc.cpp

@@ -48,7 +48,7 @@ int main() {
         auto tmp = os.str().erase(0, cmd.size());
         auto usage = tmp.substr(0, tmp.find_first_of('\n'));
         tmp.erase(0, usage.size());
-        auto help = replace_all(tmp, "\n\t", "\n\t\t");
+        auto help = replace_all(tmp, "\n\t", "\n\t\t| ");
         fs << '\t' << cmd << usage << help << "\n";
     }
 }

docs/src/index.rst

@@ -32,6 +32,7 @@ Welcome to slsDetectorPackage's documentation!
     :caption: Python API
     :maxdepth: 2
 
+    pygettingstarted
     pydetector
     pyenums
     pyexamples
@@ -49,6 +50,17 @@ Welcome to slsDetectorPackage's documentation!
     type_traits
     ToString
 
+.. toctree::
+    :caption: Servers
+
+    servers
+    serverupgrade
+
+.. toctree::
+    :caption: Firmware
+
+    firmware 
+
 .. Indices and tables
 .. ==================
 

docs/src/installation.rst

@@ -44,6 +44,26 @@ The easiest way to configure options is to use the ccmake utility.
     ccmake .
 
 
+Build using cmk.sh script
+-------------------------
+.. code-block:: bash
+
+    # new build and make with 9 parallel threads
+    ./cmk.sh -cbj9
+
+    # build with python
+    ./cmk.sh -bpj9
+
+    # build with GUI
+    ./cmk.sh -bgj9
+
+    # build with hdf5
+    ./cmk.sh -hj9 -d [path of hdf5 dir]
+
+    # get all options
+    ./cmk.sh -?
+
+
 Install binaries using conda
 --------------------------------
 

docs/src/pydetector.rst

@@ -7,3 +7,4 @@ Detector
     :members:  
     :undoc-members:
     :show-inheritance:
+    :inherited-members:

docs/src/pyenums.rst

@@ -4,6 +4,31 @@ Enums
 These enums are defined in slsDetectorDefs in the C++ package and 
 exposed to Python through pybind11.
 
+
+::  
+
+    # Most settings are represented as enums that can be 
+    # explicitly imported
+
+    from slsdet import Detector, fileFormat
+    d = Detector()
+    d.fformat = fileFormat.BINARY
+
+    # Altough not recommended for convenience all enums 
+    # and some other things can be impored using *
+
+    from slsdet import *
+    d.speed = speedLevel.FULL_SPEED 
+
+    # To list the available enums, use dir()
+
+    import slsdet.enums
+    for enum in dir(slsdet.enums):
+        # filter out special memebers
+        if not enum.startswith('_'):
+            print(enum)
+
+
 .. py:currentmodule:: slsdet
 
 .. autoclass:: runStatus

docs/src/pyexamples.rst

@@ -1,7 +1,73 @@
 Examples
 ================
 
-Some short hints on how to use the detector
+Some short examples on how to use slsdet. If something is missing don't hesitate to
+open an issue in our our  `github repo
+<https://github.com/slsdetectorgroup/slsDetectorPackage>`_. 
+
+
+------------------------------------
+Setting exposure time 
+------------------------------------
+
+Setting and reading back exposure time can be done either using a Python datetime.timedelta
+or by setting the time in seconds. 
+
+::
+
+    # Set exposure time to 1.2 seconds
+    >>> d.exptime = 1.2
+
+    # Setting exposure time using timedelta
+    import datetime as dt
+    >>> d.exptime = dt.timedelta(seconds = 1.2)
+
+    # With timedelta any arbitrary combination of units can be used
+    >>> t = dt.timedelta(microseconds = 100, seconds = 5.3, minutes = .3)
+
+    # To set exposure time for individual detector one have to resort
+    # to the C++ style API.
+    # Sets exposure time to 1.2 seconds for module 0, 6 and 12
+    >>> d.setExptime(1.2, [0, 6, 12]) 
+    >>> d.setExptime(dt.timedelta(seconds = 1.2), [0, 6, 12]) 
+
+
+
+------------------------------------
+Converting numbers to hex
+------------------------------------
+
+Python support entering numbers in  format by using the 0x prefix. However, when reading 
+back you will get a normal integer. This can then be converted to a hex string representation
+using the built in hex() function. 
+
+.. code-block :: python
+
+    from slsdet import Detector
+    >>> d = Detector()
+    >>> d.patwait0 = 0xaa
+    >>> d.patwait0
+    170
+
+    # Convert to  string
+    >>> hex(d.patwait0)
+    '0xaa'
+
+For multiple values one can use a list comprehension to loop over the values. 
+
+.. code-block :: python
+
+    >>> values = [1,2,3,4,5]
+    >>> [(v) for v in values]
+    ['0x1', '0x2', '0x3', '0x4', '0x5']
+
+    # or to a single string by passing the list to .join
+    >>> ', '.join([hex(v) for v in values])
+    '0x1, 0x2, 0x3, 0x4, 0x5'
+
+
+
+    
 
 ------------------------
 Simple threshold scan
@@ -74,37 +140,39 @@ But lets start looking at the at the manual way:
 ::
 
     import time
-    from slsdet import Eiger
-    d = Eiger()
+    from slsdet import Detector, runStatus
 
-    n = 10
-    t = 1
 
-    d.exposure_time = t
-    d.n_frames = n
-    d.reset_frames_caught()
+    n_frames = 10
+    t_exp = 1
 
-    #Start the measurement
+    # Set exposure time and number of frames
+    d = Detector()
+    d.exptime = t_exp
+    d.frames = n_frames
+
+    # Start the measurement
     t0 = time.time()
-    d.start_receiver()
-    d.start_detector()
+    d.startDetector()
+    d.startReceiver()
 
-    #Wait for the detector to be ready or do other important stuff
-    time.sleep(t*n)
+    # Wait for the detector to be ready or do other important stuff
+    time.sleep(t_exp * n_frames)
 
-    #check if the detector is ready otherwise wait a bit longer
-    while d.status != 'idle':
+    # check if the detector is ready otherwise wait a bit longer
+    while d.status != runStatus.IDLE:
         time.sleep(0.1)
 
-    #Stop the receiver after we got the frames
-    #Detector is already idle so we don't need to stop it
-    d.stop_receiver()
+    # Stop the receiver after we got the frames
+    # Detector is already idle so we don't need to stop it
+    d.stopReceiver()
+
+    lost = d.rx_framescaught - n_frames
+    print(
+        f"{n_frames} frames of {t_exp}s took {time.time()-t0:{.3}}s with {lost} frames lost "
+    )
 
-    lost = d.frames_caught - n
-    print(f'{n} frames of {t}s took {time.time()-t0:{.3}}s with {lost} frames lost ')
 
-    #Reset to not interfere with a potential next measurement
-    d.reset_frames_caught()
 
 Instead launching d.acq() from a different process is a bit easier since the control of receiver and detector
 is handled in the acq call. However, you need to join the process used otherwise a lot of zombie processes would
@@ -114,30 +182,104 @@ hang around until the main process exits.
 
     import time
     from multiprocessing import Process
-    from slsdet import Eiger
+    from slsdet import Detector, runStatus
 
-    def acquire():
-        """
-        Create a new Eiger object that still referes to the same actual detector
-        and same shared memory. Then launch acq.
-        """
-        detector = Eiger()
-        detector.acq()
 
-    #This is the detector we use throughout the session
-    d = Eiger()
+    d = Detector()
 
-    #Process to run acquire
-    p = Process(target=acquire)
+    #Create a separate process to run acquire in
+    p = Process(target=d.acquire)
 
     #Start the thread and short sleep to allow the acq to start
     p.start()
     time.sleep(0.01)
 
     #Do some other work
-    while d.busy is True:
-        print(d.busy)
+    while d.status != runStatus.IDLE:
+        print("Working")
         time.sleep(0.1)
 
     #Join the process
     p.join()
+
+
+------------------------------
+Setting and getting times
+------------------------------
+
+::
+
+    import datetime as dt
+    from slsdet import Detector
+    from slsdet.utils import element_if_equal
+
+    d = Detector()
+
+    # The simplest way is to set the exposure time in 
+    # seconds by using the exptime property
+    # This sets the exposure time for all modules
+    d.exptime = 0.5
+
+    # exptime also accepts a python datetime.timedelta
+    # which can be used to set the time in almost any unit
+    t = dt.timedelta(milliseconds = 2.3)
+    d.exptime = t
+
+    # or combination of units
+    t = dt.timedelta(minutes = 3, seconds = 1.23)
+    d.exptime = t
+
+    # exptime however always returns the time in seconds
+    >>> d.exptime
+    181.23 
+
+    # To get back the exposure time for each module 
+    # it's possible to use getExptime, this also returns
+    # the values as datetime.timedelta
+
+    >>> d.getExptime()
+    [datetime.timedelta(seconds=181, microseconds=230000), datetime.timedelta(seconds=181, microseconds=230000)]
+
+    # In case the values are the same it's possible to use the
+    # element_if_equal function to reduce the values to a single 
+    # value
+
+    >>> t = d.getExptime()
+    >>> element_if_equal(t)
+    datetime.timedelta(seconds=1)
+
+--------------
+Reading dacs
+--------------
+
+::
+
+    from slsdet import Detector, Eiger, dacIndex
+
+    #using the specialized class
+    e = Eiger()
+    >>> e.dacs
+    ========== DACS =========
+    vsvp      :    0    0
+    vtrim     : 2480 2480
+    vrpreamp  : 3300 3300
+    vrshaper  : 1400 1400
+    vsvn      : 4000 4000
+    vtgstv    : 2556 2556
+    vcmp_ll   : 1000 1000
+    vcmp_lr   : 1000 1000
+    vcal      :    0    0
+    vcmp_rl   : 1000 1000
+    rxb_rb    : 1100 1100
+    rxb_lb    : 1100 1100
+    vcmp_rr   : 1000 1000
+    vcp       : 1000 1000
+    vcn       : 2000 2000
+    vishaper  : 1550 1550
+    iodelay   :  650  650
+
+    # or using the general class and the list
+    d = Detector()
+    for dac in d.daclist:
+        r = d.getDAC(dac, False)
+        print(f'{dac.name:10s} {r}')

docs/src/pygettingstarted.rst

@@ -0,0 +1,228 @@
+Getting Started 
+==================
+
+
+--------------------
+Which Python?  
+--------------------
+
+We require at lest Python 3.6 and strongly recommended that you don't use the system
+Python installation. The examples in this documentation uses `conda
+<https://docs.conda.io/en/latest/miniconda.html>`_ since it provides good support
+also for non Python packages but there are also other alternatives like, pyenv. 
+
+Using something like conda also allows you to quickly switch beteen different Python 
+environments. 
+
+.. warning ::
+
+    If you use conda avoid also installing packages with pip. 
+
+---------------------
+PYTHONPATH 
+---------------------
+
+If you install slsdet using conda everything is set up and you can
+directly start using the Python bindings. However, if you build 
+from source you need to tell Python where to find slsdet. This
+is be done by adding your build/bin directory to PYTHONPATH. 
+
+.. code-block:: bash
+
+    export PYTHONPATH = /path/to/your/build/bin:$PYTHONPATH
+
+.. note ::
+
+    Don't forget to compile with the option SLS_USE_PYTHON=ON to enable
+    the Python bindings or if you use the cmk.sh script -p.
+
+--------------------------------------
+Which detector class should I use? 
+--------------------------------------
+
+We provide a generic class called Detector and detector specific 
+versions like, Eiger, Jungfrau etc. The most or all functionality 
+is there in the base class except the convenient access to dacs
+and temperatures. 
+
+:: 
+
+    from slsdet import Detector, Eiger
+
+    d = Detector()
+    e = Eiger()
+
+    # Both classes can be used to control an Eiger detector
+    d.exptime = 0.5
+    e.period = 1
+
+    # But Eiger gives a simpler interface to the dacs
+    >>> e.dacs
+    ========== DACS =========
+    vsvp           :    0
+    vtrim          : 2480
+    vrpreamp       : 3300
+    vrshaper       : 1400
+    vsvn           : 4000
+    vtgstv         : 2556
+    vcmp_ll        : 1000
+    vcmp_lr        : 1000
+    vcal           :    0
+    vcmp_rl        : 1000
+    rxb_rb         : 1100
+    rxb_lb         : 1100
+    vcmp_rr        : 1000
+    vcp            : 1000
+    vcn            : 2000
+    vishaper       : 1550
+    iodelay        :  650
+
+
+.. note ::
+
+    Depending on user feedback we might move some detector specific
+    functionality to the specialized classes.
+
+
+----------------------------------
+Hey, there seems to be two APIs?
+----------------------------------
+
+To make the Python API approachable, both if you come from the command line 
+or are using the C++ API, we provide two interfaces to the detector. 
+One is property based and tries to stay as close to the command line syntax
+as is possible, and the other one directly maps the C++ API found in Detector.h.
+There is also an underlying design reason for the two APIs since we auto 
+generate the bindings to the C++ code using a mix of pybind11 and clang-tools. 
+The property based API covers most of the functionality but in some cases 
+you have to reach for the C++ like interface. 
+
+
+::  
+
+    d = Detector()
+
+    # C++ like API 
+    d.setExptime(0.1)
+
+    # or a bit more pythonic
+    d.exptime = 0.1
+
+The c++ style API offers more control over access to individual modules
+in a large detector.
+
+:: 
+
+    # Set exposure time for module 1, 5 and 7
+    d.setExptime(0.1, [1,5,7])
+
+--------------------
+Finding functions 
+--------------------
+
+To find out which properties and methods that a Python object have you
+can use dir()
+
+::
+
+    >>> from slsdet import Detector
+    >>> d = Detector()
+    >>> dir(d)
+    ['__class__', '__delattr__', '__dict__', '__dir__', '__doc__', 
+    '__eq__', '__format__', '__ge__', '__getattribute__', '__gt__', 
+    '__hash__', '__init__', '__init_subclass__', '__le__', '__len__', 
+    '__lt__', '__module__', '__ne__', '__new__', '__reduce__', 
+    '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', 
+    '__str__', '__subclasshook__', '_adc_register', '_frozen', 
+    '_register', 'acquire', 'adcclk', 'adcphase', 'adcpipeline', 
+    'adcreg', 'asamples', 'auto_comp_disable', 'clearAcquiringFlag', 
+    'clearBit', 'clearROI', 'client_version', 'config', 'copyDetectorServer', 
+    'counters', 'daclist', 'dacvalues', 'dbitclk', 'dbitphase' ...
+
+Since the list for Detector is rather long it's an good idea to filter it. 
+The following example gives you properties and methods containing time in 
+their name.
+
+:: 
+
+    >>> [item for item in dir(d) if 'time' in item]
+    ['exptime', 'getExptime', 'getExptimeForAllGates', 'getExptimeLeft', 
+    'getSubExptime', 'patwaittime0', 'patwaittime1', 'patwaittime2', 
+    'setExptime', 'setSubExptime', 'subdeadtime', 'subexptime']
+
+The above method works on any Python object but for convenience we also 
+included two functions to find names. View prints the names one per line
+while find returns a list of names. 
+
+::
+
+    from slsdet.lookup import view, find
+
+    >>> view('exptime')
+    exptime
+    getExptime
+    getExptimeForAllGates
+    getExptimeLeft
+    getSubExptime
+    setExptime
+    setSubExptime
+    subexptime
+
+    >>> find('exptime')
+    ['exptime', 'getExptime', 'getExptimeForAllGates', 'getExptimeLeft', 
+    'getSubExptime', 'setExptime', 'setSubExptime', 'subexptime']
+
+
+------------------------------------
+Finding out what the function does
+------------------------------------
+
+To access the documentation of a function directly from the Python prompt use help(). 
+
+.. code-block :: python
+
+    >>> help(Detector.period)
+    Help on property:
+
+        Period between frames, accepts either a value in seconds or datetime.timedelta
+
+        Note
+        -----
+        :getter: always returns in seconds. To get in datetime.delta, use getPeriod
+
+        Examples
+        -----------
+        >>> d.period = 1.05
+        >>> d.period = datetime.timedelta(minutes = 3, seconds = 1.23)
+        >>> d.period
+        181.23
+        >>> d.getPeriod()
+        [datetime.timedelta(seconds=181, microseconds=230000)]
+
+
+----------------------
+Where are the ENUMs?
+----------------------
+
+To set some of the detector settings like file format you have
+to pass in an enum. 
+
+:: 
+
+    >>> d.setFileFormat(fileFormat.BINARY)
+    
+The enums can be found in slsdet.enums 
+
+::
+
+    import slsdet
+    >>> [e for e in dir(slsdet.enums) if not e.startswith('_')]
+    ['burstMode', 'clockIndex', 'dacIndex', 'detectorModeType', 
+    'detectorSettings', 'detectorType', 'dimension', 'externalSignalFlag', 
+    'fileFormat', 'frameDiscardPolicy', 'frameModeType', 'masterFlags', 
+    'readoutMode', 'runStatus', 'speedLevel', 'timingMode', 
+    'timingSourceType']
+
+    # Even though importing using * is not recommended one could
+    # get all the enums like this: 
+    >>> from slsdet.enums import *

docs/src/servers.rst

@@ -0,0 +1,108 @@
+Default values
+==============================================
+
+Some general intro 
+
+Mythen3
+-------------
+
+.. csv-table:: Default values
+   :file: mythen3.csv
+   :widths: 35, 35
+   :header-rows: 1
+
+DACS
+^^^^^^^^^^^^^
+
+.. csv-table:: Mythen3 DACS
+   :file: mythen3-dacs.csv
+   :widths: 35, 35
+   :header-rows: 1
+
+Gotthard2
+-------------
+
+.. csv-table:: Default values
+   :file: gotthard2.csv
+   :widths: 35, 35
+   :header-rows: 1
+
+DACS
+^^^^^^^^^^^^^
+
+.. csv-table:: Gotthard 2 DACS
+   :file: gotthard2-dacs.csv
+   :widths: 35, 35
+   :header-rows: 1
+
+Moench
+-------------
+
+.. csv-table:: Default values
+   :file: moench.csv
+   :widths: 35, 35
+   :header-rows: 1
+
+DACS
+^^^^^^^^^^^^^
+
+.. csv-table:: Moench DACS
+   :file: moench-dacs.csv
+   :widths: 35, 35
+   :header-rows: 1
+
+Ctb
+-------------
+
+.. csv-table:: Default values
+   :file: ctb.csv
+   :widths: 35, 35
+   :header-rows: 1
+
+Eiger
+-------------
+
+.. csv-table:: Default values
+   :file: eiger.csv
+   :widths: 35, 35
+   :header-rows: 1
+
+DACS
+^^^^^^^^^^^^^
+
+.. csv-table:: Eiger DACS
+   :file: eiger-dacs.csv
+   :widths: 35, 35
+   :header-rows: 1
+
+Jungfrau
+-------------
+
+.. csv-table:: Default values
+   :file: jungfrau.csv
+   :widths: 35, 35
+   :header-rows: 1
+
+DACS
+^^^^^^^^^^^^^
+
+.. csv-table:: Jungfrau DACS
+   :file: jungfrau-dacs.csv
+   :widths: 35, 35
+   :header-rows: 1
+
+Gotthard
+-------------
+
+.. csv-table:: Default values
+   :file: gotthard.csv
+   :widths: 35, 35
+   :header-rows: 1
+
+DACS
+^^^^^^^^^^^^^
+
+.. csv-table:: Gotthard DACS
+   :file: gotthard-dacs.csv
+   :widths: 35, 35
+   :header-rows: 1

docs/src/serverupgrade.rst

@@ -0,0 +1,88 @@
+Server Upgrade
+=================
+
+
+
+Eiger
+-------------
+
+#. Kill old server and copy new server
+    .. code-block:: bash
+
+        # Option 1: from detector console
+        # kill old server
+        ssh root@bebxxx
+        killall eigerDetectorServer
+
+        # copy new server
+        cd executables
+        scp user@pc:/path/eigerDetectorServerxxx .
+        chmod 777 eigerDetectorServerxxx
+        ln -sf eigerDetectorServerxxx eigerDetectorServer
+        sync
+
+        # Options 2: from client console for multiple modules
+        for i in bebxxx bebyyy;
+        do ssh root@$i killall eigerDetectorServer;
+        scp eigerDetectorServerxxx root@$i:~/executables/eigerDetectorServer;
+        ssh root@$i sync; done
+
+
+#. Reboot the detector.
+
+
+Jungfrau
+-------------
+
+#. Program from console (only from 5.0.0-rc1)
+    .. code-block:: bash
+
+        # copies new server from pc tftp folder, respawns and reboots
+        sls_detector_put copydetectorserver jungfrauDetectorServerxxx pcxxx
+
+
+Gotthard
+---------
+#. Program from console (only from 5.0.0-rc1)
+    .. code-block:: bash
+
+        # copies new server from pc tftp folder, respawns and reboots
+        sls_detector_put copydetectorserver gotthardDetectorServerxxx pcxxx
+
+
+
+Mythen3
+-------
+
+#. Program from console (only from 5.0.0-rc1)
+    .. code-block:: bash
+
+        # copies new server from pc tftp folder and reboots (does not respawn)
+        sls_detector_put copydetectorserver mythen3DetectorServerxxx pcxxx
+
+
+Gotthard2
+----------
+#. Program from console (only from 5.0.0-rc1)
+    .. code-block:: bash
+
+        # copies new server from pc tftp folder and reboots (does not respawn)
+        sls_detector_put copydetectorserver gotthard2DetectorServerxxx pcxxx
+
+
+Moench
+------
+#. Program from console (only from 5.0.0-rc1)
+    .. code-block:: bash
+
+        # copies new server from pc tftp folder, respawns and reboots
+        sls_detector_put copydetectorserver moenchDetectorServerxxx pcxxx
+
+
+Ctb
+---
+#. Program from console (only from 5.0.0-rc1)
+    .. code-block:: bash
+
+        # copies new server from pc tftp folder, respawns and reboots
+        sls_detector_put copydetectorserver ctbDetectorServerxxx pcxxx

docs/static/extra.css

@@ -0,0 +1,4 @@
+/* override table no-wrap */
+.wy-table-responsive table td, .wy-table-responsive table th {
+    white-space: normal;
+}

examples/gotthard_two.config

@@ -41,11 +41,11 @@ hostname bchip074+bchip075+
 
 
 r_readfreq 1
-rx_datastream 1
+rx_zmqstream 1
 
 #replace my_receiver_hostname with the hostname of 1Gb IP of the machine where the receiver runs
 rx_hostname my_receiver_hostname
-rx_datastream 1
+rx_zmqstream 1
 outdir /tmp/
 
 

examples/jctb_moench03_T1.config

@@ -459,8 +459,8 @@ rx_hostname mpc2011
 
 tengiga 1
 
-rx_datastream 1
-rx_readfreq 1
+rx_zmqstream 1
+rx_zmqfreq 1
 
 
 dac 6 800

examples/moench03_T1.config

@@ -35,7 +35,7 @@ zmqport 50001
 
 
 tengiga 1
-rx_datastream 1
+rx_zmqstream 1
 
 
 
@@ -46,7 +46,7 @@ period 0.0006
 ############################################
 fpath /mnt/moench_data/scratch/
 fwrite 0
-rx_datastream 1
+rx_zmqstream 1
 
 rx_jsonpara frameMode frame
 rx_jsonpara detectorMode counting

manual/manual-client/Eiger_short.tex

@@ -154,21 +154,39 @@ threaded 1
 \end{verbatim}
 
 In the config file, if client, receiver and detector commands are on 1Gb, but detector data to receiver are sent using \textbf{10GbE} the following lines are mandatory (see slsDetectorsPackage/examples/eiger\_10Gb.config):
+ It has been adapted to the the new 5.0 major release change:
+\begin{verbatim}
+detsize 1024 512
+hostname beb059+beb058+ 
+rx_hostname pc1875:1955+pc1875:1956+
+0:udp_dstport 50011
+0:udp_dstport2 50012
+0:udp_dstip 10.0.30.210 
+0:udp_srcip 10.0.30.100  
+1:flippeddatax 1
+1:udp_dstport 50013
+1:udp_dstport2 50014
+1:udp_dstip 0.0.40.210 
+1:udp_srcip 10.0.40.101
+fpath /sls/X12SA/data/x12saop/Data10/Eiger0.5M
+\end{verbatim}
+In the old 3.x and 4.x release it was: 
 \begin{verbatim}
 detsizechan 1024 512 #detector geometry, long side of the module first
 hostname beb059+beb058+ #1Gb detector hostname for controls
-0:rx_tcpport 1991 #tcpport for the first halfmodule                 
+0:rx_tcpport 1955 #tcpport for the first halfmodule                 
 0:rx_udpport 50011 #udp port first quadrant, first halfmodule       
 0:rx_udpport2 50012 #udp port second quadrant, first halfmodule       
 0:rx_udpip 10.0.30.210 #udp IP of the receiver over 10Gb              
 0:detectorip 10.0.30.100  #first half module 10 Gb IP 
-1:rx_tcpport 1992 #tcpport for the second halfmodule                  
+1:flippeddatax 1
+1:rx_tcpport 1956 #tcpport for the second halfmodule                  
 1:rx_udpport 50013 #udp port first quadrant, second halfmodule     
 1:rx_udpport2 50014 #udp port second quadrant, second halfmodule  
 1:rx_udpip 10.0.40.210  #udp IP of the receiver over 10Gb, 
                         can be the same or different from 0:rx_udpip                                   
 1:detectorip 10.0.40.101 #second half module 10 Gb IP 
-rx_hostname x12sa-vcons #1Gb receiver pc hostname
+rx_hostname  pc1875   #1Gb receiver pc hostname
 outdir /sls/X12SA/data/x12saop/Data10/Eiger0.5M
 threaded 1
 \end{verbatim}
@@ -269,11 +287,11 @@ In this acquisition 10 consecutive 1~s frames will be acquired. Note that {\tt{p
 
 You need to setup where the files will be written to
 \begin{verbatim}
-sls_detector_put 0-outdir /scratch
+sls_detector_put 0-outdir /scratch (\textcolor{red}{0-fpath})
 sls_detector_put 0-fname run
-sls_detector_put 0-index 0
+sls_detector_put 0-index 0 (\textcolor{red}{0-findex})
 \end{verbatim}
-this way your files will all be named /scratch/run\_dj\_i.raw where $j$ is relative to each specific half module, $i$ in the {\tt{index}} starts from 0 when starting the detector the first time and is automatically incremented. The next acquisition {\tt{index}} will be 1. One can reset the  {\tt{index}} to what wished.
+this way your files will all be named /scratch/run\_dj\_i.raw where $j$ is relative to each specific half module, $i$ in the {\tt{index}} starts from 0 when starting the detector the first time and is automatically incremented. The next acquisition {\tt{index}} will be 1. One can reset the  {\tt{index}} (\tt{\textcolor{red}{findex}}) to what wished.
 
 To acquire simply type:
 \begin{verbatim}
@@ -792,7 +810,7 @@ Extremely advanced options allow to:
 \begin{itemize}
 \item Activate the flow control for 10~Gb/s~E (by default the 1~Gb/s~E is always active and cannot be switched off:
 \begin{verbatim}
-./sls_detector_put flowcontrol_10g 1
+./sls_detector_put flowcontrol_10g 1 (\textcolor{red}{flowcontrol10g})
 \end{verbatim}
 \item  Delay the transmission of the left port. This delay option is useful in the case of many simultaneous receivers running, such that it reduces the throughput to the receivers all at the same time. To be used board by board (i.e {\tt{X:, Y:,etc..}} with different units:
 \begin{verbatim}
@@ -885,7 +903,7 @@ NOTE THAT THIS SETTINGS WILL BE LOST IF YOU REBOOT THE COMPUTER.
 
 Very important is to activate the flow control in 10Gb (in 1Gb it is on by default and not configurable)
 \begin{verbatim}
-./sls_detector_put flowcontrol_10g 1
+./sls_detector_put flowcontrol_10g 1 (\textcolor{red}{flowcontrol10g 1})
 \end{verbatim}
 You ned to check that flow control is setup on the reeceiving interfaces. Check with:
 \begin{verbatim}
@@ -1174,10 +1192,10 @@ In 500k--2M pixel systems there is a hardware temperature safety switch, which w
  
 The HV can also be set and read through the software:
 \begin{verbatim}
-./sls_detector_put highvoltage 150
-./sls_detector_get highvoltage 
+./sls_detector_put vhighvoltage 150 (\textcolor{red}{highvoltage})
+./sls_detector_get vhighvoltage (\textcolor{red}{highvoltage})
 \end{verbatim}
-Note that the get {\tt{highvoltage}} would return the measured HV from the master module only. If getting the highvoltage for individual halfmodules, only the master will have a value different from -999.
+Note that the get {\tt{vhighvoltage}}(\tt{\textcolor{red}{highvoltage}}) would return the measured HV from the master module only. If getting the highvoltage for individual halfmodules, only the master will have a value different from -999.
 
 \appendix
 
@@ -1333,10 +1351,10 @@ We have also been requested if we could speed up the threshold scan. At the mome
 \begin{verbatim}
 ./sls_detector_put exptime 0.01
 ./sls_detector_put timing trigger
-./sls_detector_put enablefwrite 0
-./sls_detector_put resetframescaught 0 
-./sls_detector_put index 0
-./sls_detector_put cycles 21  (\textcolor{red}{triggers})
+./sls_detector_put enablefwrite 0 (\textcolor{red}{fwrite} 0)
+./sls_detector_put resetframescaught 0  (\textcolor{red}{not needed anymore})
+./sls_detector_put index 0  (\textcolor{red}{findex} 0)
+./sls_detector_put cycles 21  (\textcolor{red}{triggers} 21)
 ./sls_detector_put receiver start
 ./sls_detector_put status start 
 for i in $(seq 0 20); 

python/CMakeLists.txt

@@ -11,7 +11,7 @@ pybind11_add_module(_slsdet
 target_link_libraries(_slsdet PUBLIC 
                         slsDetectorShared
                         slsReceiverShared
-                        slsSupportLib
+                        slsSupportShared
                         ${ZeroMQ_LIBRARIES}
                         )  
 
@@ -30,11 +30,17 @@ set( PYTHON_FILES
     detector_property.py
     detector.py
     eiger.py
+    enums.py
     errors.py
+    gotthard.py
+    gotthard2.py
+    moench.py
+    proxy.py
     ctb.py
     jungfrau.py
     mythen3.py
     registers.py
+    temperature.py
     lookup.py
     utils.py
 

python/api-tests/test_detector.py

@@ -1,82 +0,0 @@
-import pytest
-import datetime as dt
-from slsdet import Detector, timingMode, detectorType
-
-not_eiger = pytest.mark.skipif(
-    Detector().type == detectorType.EIGER, reason="Does not work for eiger"
-)
-
-
-@pytest.fixture
-def det():
-    from slsdet import Detector
-
-    return Detector()
-
-
-def test_frames(det):
-    for n in [1, 100, 3245, 10000]:
-        det.frames = n
-        assert det.frames == n
-    det.frames = 1
-
-
-def test_triggers(det):
-    for n in [1, 100, 3245, 10000]:
-        det.triggers = n
-        assert det.triggers == n
-    det.triggers = 1
-
-
-def test_exptime(det):
-    det.exptime = 1
-    assert det.exptime == 1
-    det.exptime = dt.timedelta(milliseconds=10)
-    assert det.exptime == 0.01
-    det.exptime = 1
-
-
-def test_period(det):
-    det.period = 3.2
-    assert det.period == 3.2
-
-    p = dt.timedelta(microseconds=1020)
-    det.period = p
-    assert det.period == 0.001020
-    r = det.getPeriod()
-    assert r[0] == p
-    det.period = 0
-    assert det.period == 0
-
-
-def test_lock(det):
-    for l in [True, False]:
-        det.lock = l
-        assert det.lock == l
-
-
-def test_timing(det):
-    # auto and trigger is available for all det
-    for m in [timingMode.TRIGGER_EXPOSURE, timingMode.AUTO_TIMING]:
-        det.timing = m
-        assert det.timing == m
-
-@not_eiger
-def test_delay(det):
-    det.delay = 1
-    assert det.delay == 1
-
-    t  = dt.timedelta(microseconds=1)
-    det.delay = t
-    assert det.delay == t.total_seconds()
-
-    r = det.getDelayAfterTrigger()[0]
-    assert r == t
-
-    det.delay = 0
-    assert det.delay == 0
-
-
-@not_eiger
-def test_delayl(det):
-    assert det.delayl == 0

python/api-tests/test_jungfrau.py

@@ -1,89 +0,0 @@
-import pytest
-import datetime as dt
-from slsdet import Detector, detectorType
-
-"""
-These tests are designed to work the API and catch
-any changes in behavior or naming. Tests are expected
-to pass with a virtual detector or a real one
-
-"""
-
-
-@pytest.fixture
-def jf():
-    from slsdet import Jungfrau
-    return Jungfrau()
-
-
-jungfrautest = pytest.mark.skipif(
-    Detector().type != detectorType.JUNGFRAU, reason="Only valid for Jungfrau"
-)
-
-
-@jungfrautest
-def test_storagecells(jf):
-    for i in range(16):
-        jf.storagecells = i
-        assert jf.storagecells == i
-    jf.storagecells = 0  # default
-
-@jungfrautest
-def test_storagecell_start(jf):
-    for i in range(16):
-        jf.storagecell_start = i
-        assert jf.storagecell_start == i
-    jf.storagecells = 15  # default
-
-@jungfrautest
-def test_storagecell_delay(jf):
-    for t in [0.001, 0.0002, 0.0013]:
-        jf.storagecell_delay = t
-        assert jf.storagecell_delay == t
-    jf.storagecell_delay = 0  # default
-
-@jungfrautest
-def test_temp_event(jf):
-    # hard to test with virtual server
-    assert jf.temp_event == 0
-
-@jungfrautest
-def test_temp_threshold(jf):
-    for th in [0, 10, 43, 72]:
-        jf.temp_threshold = th
-        assert jf.temp_threshold == th
-    jf.temp_threshold = 0
-
-@jungfrautest
-def test_auto_comp_disable(jf):
-    for v in [True, False]:
-        jf.auto_comp_disable = v
-        assert jf.auto_comp_disable == v
-
-@jungfrautest
-def test_numinterfaces(jf):
-    for n in [2, 1]:
-        jf.numinterfaces = n
-        assert jf.numinterfaces == n
-
-@jungfrautest
-def test_dr(jf):
-    assert jf.dr == 16
-
-@jungfrautest
-def test_temp_control(jf):
-    for v in [True, False]:
-        jf.temp_control = v
-        assert jf.temp_control == v
-
-@jungfrautest
-def test_startingfnum(jf):
-    for n in [10, 127, 43321, 1]:
-        jf.startingfnum = n
-        assert jf.startingfnum == n
-
-@jungfrautest
-def test_selinterface(jf):
-    for i in [1, 0]:
-        jf.selinterface = i
-        assert jf.selinterface == i

python/examples/exposure_time.py

@@ -0,0 +1,42 @@
+"""
+Example showing how to set and get exposure times
+"""
+
+import datetime as dt
+from slsdet import Detector
+from slsdet.utils import element_if_equal
+
+d = Detector()
+
+# The simplest way is to set the exposure time in 
+# seconds by using the exptime property
+# This sets the exposure time for all modules
+d.exptime = 0.5
+
+# exptime also accepts a python datetime.timedelta
+# which can be used to set the time in almost any unit
+t = dt.timedelta(milliseconds = 2.3)
+d.exptime = t
+
+# or combination of units
+t = dt.timedelta(minutes = 3, seconds = 1.23)
+d.exptime = t
+
+#exptime however always returns the time in seconds
+# >>> d.exptime
+# 181.23 
+
+# To get back the exposure time for each module 
+# it's possible to use getExptime, this also returns
+# the values as datetime.timedelta
+
+# >>> d.getExptime()
+# [datetime.timedelta(seconds=181, microseconds=230000), datetime.timedelta(seconds=181, microseconds=230000)]
+
+# In case the values are the same it's possible to use the
+# element_if_equal function to reduce the values to a single 
+# value
+
+# >>> t = d.getExptime()
+# >>> element_if_equal(t)
+# datetime.timedelta(seconds=1)

python/examples/non-blocking-acquire-process.py

@@ -0,0 +1,21 @@
+import time
+from multiprocessing import Process
+from slsdet import Detector, runStatus
+
+
+d = Detector()
+
+#Create a separate process to run acquire in
+p = Process(target=d.acquire)
+
+#Start the thread and short sleep to allow the acq to start
+p.start()
+time.sleep(0.01)
+
+#Do some other work
+while d.status != runStatus.IDLE:
+    print("Working")
+    time.sleep(0.1)
+
+#Join the process
+p.join()

python/examples/non-blocking-acquire.py

@@ -0,0 +1,33 @@
+import time
+from slsdet import Detector, runStatus
+
+
+n_frames = 10
+t_exp = 1
+
+# Set exposure time and number of frames
+d = Detector()
+d.exptime = t_exp
+d.frames = n_frames
+
+# Start the measurement
+t0 = time.time()
+d.startDetector()
+d.startReceiver()
+
+# Wait for the detector to be ready or do other important stuff
+time.sleep(t_exp * n_frames)
+
+# check if the detector is ready otherwise wait a bit longer
+while d.status != runStatus.IDLE:
+    time.sleep(0.1)
+
+# Stop the receiver after we got the frames
+# Detector is already idle so we don't need to stop it
+d.stopReceiver()
+
+lost = d.rx_framescaught - n_frames
+print(
+    f"{n_frames} frames of {t_exp}s took {time.time()-t0:{.3}}s with {lost} frames lost "
+)
+

python/examples/reading_dacs.py

@@ -0,0 +1,32 @@
+from slsdet import Detector, Eiger, dacIndex
+
+
+#using the specialized class
+
+e = Eiger()
+e.dacs
+# >>> e.dacs
+# ========== DACS =========
+# vsvp      :    0    0
+# vtrim     : 2480 2480
+# vrpreamp  : 3300 3300
+# vrshaper  : 1400 1400
+# vsvn      : 4000 4000
+# vtgstv    : 2556 2556
+# vcmp_ll   : 1000 1000
+# vcmp_lr   : 1000 1000
+# vcal      :    0    0
+# vcmp_rl   : 1000 1000
+# rxb_rb    : 1100 1100
+# rxb_lb    : 1100 1100
+# vcmp_rr   : 1000 1000
+# vcp       : 1000 1000
+# vcn       : 2000 2000
+# vishaper  : 1550 1550
+# iodelay   :  650  650
+
+# or using the general class and the list
+d = Detector()
+for dac in d.daclist:
+    r = d.getDAC(dac, False)
+    print(f'{dac.name:10s} {r}')

python/examples/reading_temperature.py

@@ -0,0 +1,45 @@
+from slsdet import Detector, Eiger, dacIndex
+
+
+
+#Using the general detector class and calling with an index
+d = Detector()
+fpga_temp = d.getTemperature(dacIndex.TEMPERATURE_FPGA)
+print(f'fpga_temp: {fpga_temp}\n')
+
+#Using the specialized detector class
+e = Eiger()
+print("All temperatures for Eiger\n")
+print(e.temp)
+# >>> e.temp
+# temp_fpga      :   54°C   60°C
+# temp_fpgaext   :   49°C   52°C
+# temp_10ge      :   47°C   45°C
+# temp_dcdc      :   52°C   53°C
+# temp_sodl      :   51°C   53°C
+# temp_sodl      :   51°C   51°C
+# temp_fpgafl    :   45°C   49°C
+# temp_fpgafr    :   39°C   42°C
+
+# The temperatures can also be returned in a dictionary
+t = e.temp.to_dict()
+print(t)
+# >>> e.temp.to_dict()
+# {'fpga': array([55, 60]), 'fpgaext': array([49, 52]), 
+# 't10ge': array([47, 45]), 'dcdc': array([52, 53]), 
+# 'sodl': array([51, 53]), 'sodr': array([51, 51]), '
+# temp_fpgafl': array([45, 49]), 
+# 'temp_fpgafr': array([39, 42])}
+
+# or in a numpy array
+t = e.temp.to_array()
+print(t)
+# >>> e.temp.to_array()
+# array([[55, 60],
+#        [49, 52],
+#        [47, 45],
+#        [52, 53],
+#        [51, 53],
+#        [51, 51],
+#        [45, 49],
+#        [40, 43]])

python/examples/threshold_scan.py

@@ -0,0 +1,8 @@
+from slsdet import Eiger
+
+d = Eiger()
+threshold = range(0, 2000, 200)
+for th in threshold:
+    print(f'{th=}')
+    d.vthreshold = th
+    d.acquire()

python/examples/use_enum.py

@@ -0,0 +1,20 @@
+# Most settings are represented as enums that can be 
+# explicitly imported
+
+from slsdet import Detector, fileFormat
+d = Detector()
+d.fformat = fileFormat.BINARY
+
+# Altough not recommended for convenience all enums 
+# and some other things can be impored using *
+
+from slsdet import *
+d.speed = speedLevel.FULL_SPEED 
+
+# To list the available enums, use dir()
+
+import slsdet.enums
+for enum in dir(slsdet.enums):
+    # filter out special memebers
+    if not enum.startswith('_'):
+        print(enum)

python/scripts/basic.py

@@ -1,15 +1,20 @@
 import os
 import sys
 import numpy as np
+from pathlib import Path
 sys.path.append(os.path.join(os.getcwd(), 'bin'))
 
-from slsdet import Detector, Mythen3, Eiger, Jungfrau, DetectorDacs, Dac, Ctb
+from slsdet import Detector, Mythen3, Eiger, Jungfrau, DetectorDacs, Dac, Ctb, Gotthard2, Moench
 from slsdet import dacIndex, readoutMode
 from slsdet.lookup import view, find
+import slsdet
+
 
 d = Detector()
-# e = Eiger()
+e = Eiger()
 c = Ctb()
+g = Gotthard2()
 # j = Jungfrau()
 # m = Mythen3()
+m = Moench()
 

python/scripts/cmd_python.py

@@ -1,26 +0,0 @@
-import subprocess
-import locale
-out = subprocess.run(['g', 'list'], stdout = subprocess.PIPE, encoding=locale.getpreferredencoding())
-cmd = out.stdout.splitlines()
-cmd.pop(0)
-
-from slsdet import Detector, Eiger, Ctb
-
-pycmd = dir(Detector)+dir(Eiger)+dir(Ctb)
-
-#Add commands that we should not expect as direct commands in python
-pycmd += ['vrf', 'vtr', 'vrs', 'vtgstv', 'vsvn', 'vtrim',
-'vsvp', 'vth1', 'vth2', 'vth3', 'vshaper', 'vshaperneg', 'rxb_rb',
-'rxb_lb', 'vref_prech', 'vref_rstore', 'vref_cds',
-'vpreamp', 'vref_comp', 'vref_comp_fe vref_ds', 'vref_h_adc', 
-'vref_l_adc', 'iodelay', 'list', 'vref_ds', 'vis', 'vpl', 
-'vref_comp_fe', 'vph', 'vout_cm', 'vcp', 'vcn', 'vcmp_ll', 'vcmp_lr'
-, 'vcmp_rl', 'vcmp_rr', 'daclist', 'dacvalues', 'vcal', 'vcas']
-
-missing = []
-for c in cmd:
-    if c not in pycmd:
-        print(c)
-        missing.append(c)
-
-print(f'Missing: {len(missing)} commands')

python/scripts/compare_with_commandline.py

@@ -0,0 +1,143 @@
+import subprocess
+import locale
+out = subprocess.run(['g', 'list'], stdout = subprocess.PIPE, encoding=locale.getpreferredencoding())
+cmd = out.stdout.splitlines()
+cmd.pop(0)
+
+from slsdet import Detector
+
+pycmd = dir(Detector)
+
+
+# dacs are in general not included in the python commands and we expect to
+# set them from the specialized class or using an enum 
+dacs = [
+        'adcvpp',
+        'iodelay',
+        'list',
+        'rxb_lb',
+        'rxb_rb',
+        'v_chip',
+        'vb_comp',
+        'vb_comp_adc',
+        'vb_comp_fe',
+        'vb_cs',
+        'vb_ds',
+        'vb_opa_1st',
+        'vb_opa_fd',
+        'vb_pixbuf',
+        'vb_sda',
+        'vbp_colbuf',
+        'vcal',
+        'vcal_n',
+        'vcal_p',
+        'vipre_out',
+        'vcas',
+        'vcasc_out',
+        'vcasc_sfp',
+        'vcascn_pb',
+        'vcascp_pb',
+        'vcassh',
+        'vchip_comp_adc',
+        'vchip_comp_fe',
+        'vchip_cs',
+        'vchip_opa_1st',
+        'vchip_opa_fd',
+        'vchip_ref_comp_fe',
+        'vcmp_ll',
+        'vcmp_lr',
+        'vcmp_rl',
+        'vcmp_rr',
+        'vcn',
+        'vcom_adc1',
+        'vcom_adc2',
+        'vcom_cds',
+        'vcp',
+        'vdcsh',
+        'vdd_prot',
+        'vicin',
+        'vin_cm',
+        'vin_com',
+        'vipre',
+        'vipre_cds',
+        'vipre_out',
+        'vishaper',
+        'vout_cm',
+        'vref_cds',
+        'vref_comp',
+        'vref_comp_fe',
+        'vref_ds',
+        'vref_h_adc',
+        'vref_l_adc',
+        'vref_prech',
+        'vref_rstore',
+        'vrpreamp',
+        'vrshaper',
+        'vrshaper_n',
+        'vsvn',
+        'vsvp',
+        'vtgstv',
+        'vth1',
+        'vth2',
+        'vth3',
+        'vtrim',
+        'ib_test_c',
+        'ibias_sfp',
+
+]
+
+intentionally_missing  = [
+                        'activate', #use getActive and getRxPadDeactivatedMode syntax is not a good fit for python
+                        'temp_10ge', #temperatures already available from enum or specialized class
+                        'temp_adc',
+                        'temp_dcdc',
+                        'temp_fpga',
+                        'temp_fpgaext', 
+                        'temp_fpgafl', 
+                        'temp_fpgafr',
+                        'temp_slowadc',
+                        'temp_sodl',
+                        'temp_sodr',
+                        'trigger', #use sendSoftwareTrigger
+                        'update', #use updateServerAndFirmare
+                        'udp_validate', #use validateUdpConfiguration
+                        'udp_reconfigure', #use reconfigureUdpDestination
+                        'pulse', # use pulseChip pulsePixel pulsePixelNmove
+                        'pulsechip', 
+                        'pulsenmove',
+                        'savepattern', #use savePattern()
+                        'resetfpga', #use resetFPGA()
+                        'rebootcontroller', #use rebootController()
+                        'firmwaretest', #use executeFirmwareTest
+                        'bustest', # executeBusTest
+                        'programfpga', #programFPGA
+                        'dac', #use setDAC or detector specific class
+                        'clearroi', #clearROI
+]
+
+pycmd += intentionally_missing
+pycmd += dacs
+missing = []
+for c in cmd:
+    if c not in pycmd:
+        print(c)
+        missing.append(c)
+
+print(f'\nMissing: {len(missing)} commands')
+print(f'Excluded: {len(dacs)} dacs')
+print(f'Excluded: {len(intentionally_missing)} other commands')
+
+
+
+not_in_cmd = []
+for c in pycmd:
+    if c.islower() and not c.startswith('_'):
+        if c not in cmd:
+            not_in_cmd.append(c)
+print(f'\nCommands in Python and NOT in command line: {len(not_in_cmd)}')
+for c in not_in_cmd:
+    print(c)
+
+
+
+#  print(',\n'.join([f'\'{d}\'' for d in sorted(dacs)]))

python/scripts/generate_functions.py

@@ -60,6 +60,23 @@ def get_arguments(node):
         args = f", {args}"
     return args
 
+def get_arguments_with_default(node):
+    args = []
+    for arg in node.get_arguments():
+        tokens = [t.spelling for t in arg.get_tokens()]
+        print(tokens)
+        if '=' in tokens:
+            if arg.type.spelling == "sls::Positions": #TODO! automate
+                args.append("py::arg() = Positions{}")
+            else:
+                args.append('py::arg()' + ''.join(tokens[tokens.index('='):]))
+        else:
+            args.append('py::arg()')
+    args = ", ".join(args)
+    if args:
+        args = f", {args}"
+    return args
+
 
 def get_fdec(node):
     args = [a.type.spelling for a in node.get_arguments()]
@@ -86,7 +103,8 @@ def visit(node):
                     and child.access_specifier == cindex.AccessSpecifier.PUBLIC
                 ):
                     m.append(child)
-                    args = get_arguments(child)
+                    # args = get_arguments(child)
+                    args = get_arguments_with_default(child)
                     fs = get_fdec(child)
                     lines.append(
                         f'.def("{child.spelling}",{fs} &Detector::{child.spelling}{args})'

python/simple-integration-tests/eiger/config_test.py

@@ -1,17 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-"""
-Created on Tue Nov 14 16:49:07 2017
-
-@author: l_frojdh
-"""
-
-fw_version = 23
-detector_type = 'Eiger'
-known_hostnames = ['beb083', 'beb098']
-image_size = (512,1024) #rows, cols
-module_geometry = (1,2) #horizontal, vertical
-
-#Remember to change these in the settings file as well!
-settings_path = '/home/l_frojdh/slsDetectorPackage/settingsdir/eiger'
-file_path = '/home/l_frojdh/out'

python/simple-integration-tests/eiger/fixtures.py

@@ -1,27 +0,0 @@
-import pytest
-
-from sls_detector import Detector
-
-@pytest.fixture
-def detector():
-    from sls_detector import Detector
-    return Detector()
-
-@pytest.fixture
-def eiger():
-    from sls_detector import Eiger
-    d = Eiger()
-    d.n_frames = 1
-    d.exposure_time = 1
-    d.file_write = False
-    return d
-
-
-@pytest.fixture
-def jungfrau():
-    from sls_detector import Jungfrau
-    return Jungfrau()
-
-detector_type = Detector().detector_type
-eigertest = pytest.mark.skipif(detector_type != 'Eiger', reason = 'Only valid for Eiger')
-jungfrautest = pytest.mark.skipif(detector_type != 'Jungfrau', reason = 'Only valid for Jungfrau')

python/simple-integration-tests/eiger/test.config

@@ -1,33 +0,0 @@
-detsizechan 1024 512
-
-#hostname for top+bottom+
-hostname beb083+beb098+
-
-#top
-0:rx_tcpport 1954
-0:lock 0
-0:rx_udpport 50010
-0:rx_udpport2 50011
-0:rx_hostname mpc2048
-0:flippeddatax 0
-
-#bottom
-1:rx_tcpport 1955
-1:lock 0
-1:rx_udpport 50004
-1:rx_udpport2 50005
-1:rx_hostname mpc2048
-1:flippeddatax 1
-
-settingsdir /home/l_frojdh/slsDetectorPackage/settingsdir/eiger
-outdir /home/l_frojdh/out
-vthreshold 1500
-vtr 4000
-dr 32
-
-threaded 1
-tengiga 0
-highvoltage 150
-iodelay 660
-
-#gappixels 1

python/simple-integration-tests/eiger/test.par

@@ -1,2 +0,0 @@
-vrf 3000
-vthreshold 1800

python/simple-integration-tests/eiger/test_dynamic_range.py

@@ -1,44 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-"""
-Testing setting dynamic range for Eiger. 
-If the detector is not Eiger the tests are skipped
-"""
-import pytest
-import config_test
-from fixtures import detector, eiger, jungfrau, eigertest, jungfrautest
-from sls_detector.errors import DetectorValueError
-
-
-@eigertest
-def test_set_dynamic_range_and_make_acq(eiger):
-    eiger.exposure_time = 0.5
-    eiger.n_frames = 2
-    for dr in [4, 8, 16, 32]:
-        eiger.dynamic_range = dr
-        assert eiger.dynamic_range == dr
-        eiger.acq()
-        assert eiger.frames_caught == 2
-
-
-@eigertest
-def test_set_dynamic_range_raises(eiger):
-    with pytest.raises(DetectorValueError):
-        eiger.dynamic_range = 1
-    with pytest.raises(DetectorValueError):
-        eiger.dynamic_range = 75
-    with pytest.raises(DetectorValueError):
-        eiger.dynamic_range = -3
-    with pytest.raises(DetectorValueError):
-        eiger.dynamic_range = 12
-
-@eigertest
-def test_set_dynamic_range_reduces_speed(eiger):
-    eiger.readout_clock = 'Full Speed'
-    eiger.dynamic_range = 32
-    assert eiger.dynamic_range == 32
-    assert eiger.readout_clock == 'Quarter Speed'
-
-    eiger.dynamic_range = 16
-    assert eiger.dynamic_range == 16
-    assert eiger.readout_clock == 'Half Speed'

python/simple-integration-tests/eiger/test_eiger_specific.py

@@ -1,119 +0,0 @@
-import pytest
-import config_test
-import time
-from sls_detector.errors import DetectorValueError
-
-from fixtures import eiger, eigertest
-
-
-
-
-
-@eigertest
-def test_set_matrix_reset(eiger):
-    eiger.eiger_matrix_reset = False
-    assert eiger.eiger_matrix_reset == False
-    eiger.eiger_matrix_reset = True
-    assert eiger.eiger_matrix_reset == True
-
-@eigertest
-def test_set_tx_delay_left_single(eiger):
-    eiger.tx_delay.left[0] = 130
-    assert eiger.tx_delay.left[0] == 130
-    eiger.tx_delay.left[1] = 150
-    assert eiger.tx_delay.left[1] == 150
-    eiger.tx_delay.left[0] = 0
-    eiger.tx_delay.left[1] = 0
-    assert eiger.tx_delay.left[0] == 0
-    assert eiger.tx_delay.left[1] == 0
-
-@eigertest
-def test_set_tx_delay_right_single(eiger):
-    eiger.tx_delay.right[0] = 130
-    assert eiger.tx_delay.right[0] == 130
-    eiger.tx_delay.right[1] = 150
-    assert eiger.tx_delay.right[1] == 150
-    eiger.tx_delay.right[0] = 0
-    eiger.tx_delay.right[1] = 0
-    assert eiger.tx_delay.right[0] == 0
-    assert eiger.tx_delay.right[1] == 0
-
-@eigertest
-def test_set_tx_delay_frame_single(eiger):
-    eiger.tx_delay.frame[0] = 500
-    eiger.tx_delay.frame[1] = 600
-    assert eiger.tx_delay.frame[0] == 500
-    assert eiger.tx_delay.frame[1] == 600
-
-    eiger.tx_delay.frame[0] = 0
-    eiger.tx_delay.frame[1] = 0
-    assert eiger.tx_delay.frame[0] == 0
-    assert eiger.tx_delay.frame[1] == 0
-
-@eigertest
-def test_tx_delay_from_list(eiger):
-    eiger.tx_delay.left = [123,456]
-    assert eiger.tx_delay.left[:] == [123,456]
-    eiger.tx_delay.right = [789,100]
-    assert eiger.tx_delay.right[:] == [789,100]
-    eiger.tx_delay.frame = [1000,90000]
-    assert eiger.tx_delay.frame[:] == [1000,90000]
-
-    eiger.tx_delay.left = [0, 0]
-    eiger.tx_delay.right = [0, 0]
-    eiger.tx_delay.frame = [0, 0]
-    assert eiger.tx_delay.left[:] == [0, 0]
-    assert eiger.tx_delay.right[:] == [0, 0]
-    assert eiger.tx_delay.frame[:] == [0, 0]
-
-@eigertest
-def test_acitve(eiger):
-    eiger.file_write = False
-    eiger.reset_frames_caught()
-    eiger.active[1] = False
-    eiger.acq()
-    assert eiger._api.getFramesCaughtByReceiver(1) == 0
-    assert eiger._api.getFramesCaughtByReceiver(0) == 1
-    eiger.active = True
-    time.sleep(0.5)
-    eiger.acq()
-    assert eiger.frames_caught == 1
-
-@eigertest
-def test_set_default_settings(eiger):
-    eiger.default_settings()
-    assert eiger.n_frames == 1
-    assert eiger.exposure_time == 1
-    assert eiger.period == 0
-    assert eiger.n_cycles == 1
-    assert eiger.dynamic_range == 16
-
-@eigertest
-def test_flowcontrol10g(eiger):
-    eiger.flowcontrol_10g = True
-    assert eiger.flowcontrol_10g == True
-    eiger.flowcontrol_10g = False
-    assert eiger.flowcontrol_10g == False
-
-@eigertest
-def test_read_vcmp(eiger):
-    eiger.vthreshold = 1500
-    assert eiger.vcmp[:]  == [1500]*4*eiger.n_modules
-
-@eigertest
-def test_set_vcmp(eiger):
-    eiger.vcmp = [1000,1100,1200,1300,1400,1500,1600,1700]
-    assert eiger.vcmp[:] == [1000,1100,1200,1300,1400,1500,1600,1700]
-    eiger.vthreshold = 1500
-
-#Disabled only works with receiver on the same pc
-# @eigertest
-# def test_setup500k():
-#     from sls_detector import Eiger, free_shared_memory
-#     free_shared_memory()
-#     d = Eiger()
-#     d.setup500k(config_test.known_hostnames)
-#     d.acq()
-#     assert d.rx_tcpport == [1954,1955]
-#     assert d.frames_caught == 1
-#     #could assert more setting but if the frame is caught it worked...

python/simple-integration-tests/eiger/test_firmware.py

@@ -1,129 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-"""
-Tests specific for the firmware.
-
-Check that register values are correct after starting an exposure
-
-0x4 exposure time
-0x5 period
-0x6 sub exposure time
-
-"""
-import pytest
-import config_test
-from fixtures import detector, eiger, jungfrau, eigertest, jungfrautest
-from sls_detector.errors import DetectorValueError
-from sls_detector.utils import  eiger_register_to_time
-
-# testdata_exptimes = [0.001, 0.002, 0.0236]
-
-@eigertest
-def test_short_exposure_time(eiger):
-    t = 1.23
-    eiger.exposure_time = t
-    eiger.file_write = False
-    eiger.start_detector()
-    eiger.stop_detector()
-
-    #Register 0x4 holds exposure time
-    reg = eiger.register[0x4]
-    assert pytest.approx(t, 1e-9) == eiger_register_to_time(reg)
-
-@eigertest
-def test_short_minimal_exposure_time(eiger):
-    t = 1e-8
-    eiger.exposure_time = t
-    eiger.file_write = False
-    eiger.start_detector()
-    eiger.stop_detector()
-
-    #Register 0x4 holds exposure time
-    reg = eiger.register[0x4]
-    assert pytest.approx(t, 1e-9) == eiger_register_to_time(reg)
-
-
-@eigertest
-def test_long_exposure_time(eiger):
-    t = 623
-    eiger.exposure_time = t
-    eiger.file_write = False
-    eiger.start_detector()
-    eiger.stop_detector()
-
-    # Register 0x4 holds exposure time
-    reg = eiger.register[0x4]
-    assert pytest.approx(t, 1e-9) == eiger_register_to_time(reg)
-
-
-@eigertest
-def test_short_period(eiger):
-    t = 0.1
-    eiger.exposure_time = 0.001
-    eiger.period = t
-    eiger.file_write = False
-    eiger.start_detector()
-    eiger.stop_detector()
-
-    # Register 0x5 holds period
-    reg = eiger.register[0x5]
-    assert pytest.approx(t, 1e-9) == eiger_register_to_time(reg)
-
-
-@eigertest
-def test_long_period(eiger):
-    t = 8900
-    eiger.exposure_time = 0.001
-    eiger.period = t
-    eiger.file_write = False
-    eiger.start_detector()
-    eiger.stop_detector()
-
-    # Register 0x5 holds period
-    reg = eiger.register[0x5]
-    assert pytest.approx(t, 1e-9) == eiger_register_to_time(reg)
-
-@eigertest
-def test_zero_period_with_acq(eiger):
-    t = 0
-    eiger.exposure_time = 0.001
-    eiger.period = t
-    eiger.file_write = False
-    eiger.start_detector()
-    eiger.stop_detector()
-
-    # Register 0x5 holds period
-    reg = eiger.register[0x5]
-    assert pytest.approx(t, 1e-9) == eiger_register_to_time(reg)
-
-
-testdata_times = [0.001, 0.002, 0.0236]
-@eigertest
-@pytest.mark.parametrize("t", testdata_times)
-def test_subexptime(eiger,t):
-    eiger.sub_exposure_time = t
-    eiger.file_write = False
-    eiger.start_detector()
-    eiger.stop_detector()
-
-    # Register 0x6 holds sub exposure time
-    # time is stored straight as n clocks
-    reg = eiger.register[0x6]
-    assert pytest.approx(t, 1e-9) == reg/100e6
-
-
-@eigertest
-@pytest.mark.parametrize("t", testdata_times)
-def test_subdeadtime(eiger, t):
-    eiger.sub_deadtime = t
-    eiger.sub_exposure_time = 1
-    eiger.sub_exposure_time = 0.001
-    eiger.file_write = False
-    eiger.start_detector()
-    eiger.stop_detector()
-
-    # Register 0x7 holds sub period
-    # time is stored straight as n clocks
-    # exptime+deadtime
-    reg = eiger.register[0x7]
-    assert pytest.approx(t, 1e-7) == (reg/100e6-0.001)

python/simple-integration-tests/eiger/test_general.py

@@ -1,187 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-"""
-General tests for the Detector class. Should not depend on the connected detector. Aim is to have tests working
-for both Jungfrau and Eiger.
-
-NOTE! Uses hostnames from config_test
-"""
-
-import pytest
-import config_test
-from fixtures import detector
-from sls_detector.errors import DetectorValueError, DetectorError
-
-
-
-def test_error_handling(detector):
-    with pytest.raises(DetectorError):
-        detector._provoke_error()
-
-def test_not_busy(detector):
-    """Test that the detector is not busy from the start"""
-    assert detector.busy == False
-
-def test_reset_frames_caught(detector):
-    detector.file_write = False
-    detector.acq()
-    assert detector.frames_caught == 1
-    detector.reset_frames_caught()
-    assert detector.frames_caught == 0
-
-def test_set_busy_true_then_false(detector):
-    """Test both cases of assignment"""
-    detector.busy = True
-    assert detector.busy == True
-    detector.busy = False
-    assert detector.busy == False
-
-def test_set_readout_speed(detector):
-    for s in ['Full Speed', 'Half Speed', 'Quarter Speed', 'Super Slow Speed']:
-        detector.readout_clock = s
-        assert detector.readout_clock == s
-
-def test_wrong_speed_raises_error(detector):
-    with pytest.raises(KeyError):
-        detector.readout_clock = 'Something strange'
-
-def test_readout_clock_remains(detector):
-    s = detector.readout_clock
-    try:
-        detector.readout_clock = 'This does not exists'
-    except KeyError:
-        pass
-    assert detector.readout_clock == s
-
-def test_len_method(detector):
-    """to test this we need to know the length, this we get from the configuration of hostnames"""
-    assert len(detector) == len(config_test.known_hostnames)
-
-def test_setting_n_cycles_to_zero_gives_error(detector):
-    with pytest.raises(DetectorValueError):
-        detector.n_cycles = 0
-
-def test_setting_n_cycles_to_negative_gives_error(detector):
-    with pytest.raises(DetectorValueError):
-        detector.n_cycles = -50
-
-def test_set_cycles_frome_one_to_ten(detector):
-    for i in range(1,11):
-        detector.n_cycles = i
-        assert detector.n_cycles == i
-        detector.n_cycles = 1
-        assert detector.n_cycles == 1
-
-def test_get_detector_type(detector):
-    assert detector.detector_type == config_test.detector_type
-
-
-
-def test_set_file_index(detector):
-    detector.file_index = 5
-    assert detector.file_index == 5
-
-def test_negative_file_index_raises(detector):
-    with pytest.raises(ValueError):
-        detector.file_index = -8
-
-def test_setting_file_name(detector):
-    fname = 'hej'
-    detector.file_name = fname
-    assert detector.file_name == fname
-
-def test_set_file_write(detector):
-    detector.file_write = True
-    assert detector.file_write == True
-
-    detector.file_write = False
-    assert detector.file_write == False
-
-
-
-def test_set_high_voltage(detector):
-    detector.high_voltage = 55
-    assert detector.high_voltage == 55
-
-def test_negative_voltage_raises(detector):
-    with pytest.raises(DetectorValueError):
-        detector.high_voltage = -5
-
-def test_high_voltage_raises_on_to_high(detector):
-    with pytest.raises(DetectorValueError):
-        detector.high_voltage = 500
-
-
-
-def test_get_image_size(detector):
-    """Compares with the size in the config file"""
-    assert detector.image_size.rows == config_test.image_size[0]
-    assert detector.image_size.cols == config_test.image_size[1]
-
-def test_get_module_geometry(detector):
-    """Compares with the size in the config file"""
-    assert detector.module_geometry.horizontal == config_test.module_geometry[0]
-    assert detector.module_geometry.vertical == config_test.module_geometry[1]
-
-def test_set_nframes(detector):
-    detector.n_frames = 5
-    assert detector.n_frames == 5
-    detector.n_frames = 1
-    assert detector.n_frames == 1
-
-def test_set_n_measurements(detector):
-    detector.n_measurements = 7
-    assert detector.n_measurements == 7
-    detector.n_measurements = 1
-    assert detector.n_measurements == 1
-
-def test_negative_nframes_raises(detector):
-    with pytest.raises(DetectorValueError):
-        detector.n_frames = -2
-
-def test_nmodules(detector):
-    """Assume that the number of modules should be the same as the number of hostnames"""
-    assert detector.n_modules == len(config_test.known_hostnames)
-
-def test_is_detector_online(detector):
-    assert detector.online == True
-
-def test_set_online(detector):
-    detector.online = False
-    assert detector.online == False
-    detector.online = True
-    assert detector.online == True
-
-
-
-def test_receiver_is_online(detector):
-    assert detector.receiver_online == True
-
-def test_set_receiver_online(detector):
-    detector.receiver_online = False
-    assert detector.receiver_online == False
-    detector.receiver_online = True
-    assert detector.receiver_online == True
-
-def test_set_receiver_online_raises_on_non_bool(detector):
-    with pytest.raises(TypeError):
-        detector.receiver_online = 'probably not this'
-
-
-
-
-def test_set_period(detector):
-    detector.period = 5.123
-    assert detector.period == 5.123
-    detector.period = 0
-    assert detector.period == 0
-
-
-
-def test_set_timing_mode(detector):
-    detector.timing_mode = 'trigger'
-    assert detector.timing_mode == 'trigger'
-    detector.timing_mode = 'auto'
-    assert detector.timing_mode == 'auto'
-
-

python/simple-integration-tests/eiger/test_load_config.py

@@ -1,38 +0,0 @@
-
-import pytest
-import config_test
-import os
-dir_path = os.path.dirname(os.path.realpath(__file__))
-from sls_detector.detector import element_if_equal
-from sls_detector.errors import DetectorValueError
-
-
-from fixtures import eiger, eigertest
-
-
-@eigertest
-def test_load_config_file_eiger(eiger):
-    """Load a settings file and assert all settings"""
-    eiger.load_config(os.path.join(dir_path, 'test.config'))
-
-
-    assert eiger.rx_tcpport == [1954, 1955]
-    assert eiger.lock == False
-    assert eiger.rx_udpport == [50010, 50011, 50004, 50005]
-    assert eiger.rx_hostname == 'mpc2048'
-    assert eiger.flipped_data_x[:] == [False, True]
-    assert eiger.settings_path == config_test.settings_path
-    assert eiger.file_path == config_test.file_path
-    assert eiger.vthreshold == 1500
-    assert element_if_equal(eiger.dacs.vtr[:]) == 4000
-    assert eiger.dynamic_range == 32
-    assert eiger.tengiga == False
-    assert eiger.high_voltage == 150
-    assert element_if_equal(eiger.dacs.iodelay[:]) == 660
-
-@eigertest
-def test_load_parameters_file_eiger(eiger):
-    """Load a parametes file and assert the settings in the file"""
-    eiger.load_parameters(os.path.join(dir_path, 'test.par'))
-    assert element_if_equal(eiger.dacs.vrf[:]) == 3000
-    assert eiger.vthreshold == 1800

python/simple-integration-tests/eiger/test_network.py

@@ -1,81 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-"""
-Tests for network related functions of the detector
-"""
-import pytest
-import config_test
-from fixtures import eiger, eigertest, detector
-
-
-# def test_last_client(detector):
-#     import socket
-#     # We probably should check for multiple ip's
-#     myip = socket.gethostbyname_ex(socket.gethostname())[-1][0]
-#     assert detector.last_client_ip == myip
-
-def test_get_hostname(detector):
-    for detector_host, config_host in zip(detector.hostname, config_test.known_hostnames):
-        assert detector_host == config_host
-
-def test_hostname_has_same_length_as_n_modules(detector):
-    assert len(detector.hostname) == detector.n_modules
-
-
-# # def test_get_receiver_hostname(detector):
-# #     """Assume that the receiver are on the local computer"""
-# #     import socket
-# #     host = socket.gethostname().split('.')[0]
-# #     assert detector.rx_hostname == host
-
-# def test_set_receiver_hostname(detector):
-#     import socket
-#     host = socket.gethostname().split('.')[0]
-#     phony_host = 'madeup'
-#     detector.rx_hostname = phony_host
-#     assert detector.rx_hostname == phony_host
-#     detector.rx_hostname = host
-#     assert detector.rx_hostname == host
-
-@eigertest
-def test_set_rx_zmqport_single_value(eiger):
-    eiger.rx_zmqport = 35000
-    assert eiger.rx_zmqport == [35000, 35001, 35002, 35003]
-
-@eigertest
-def test_set_rx_zmqport_list(eiger):
-    eiger.rx_zmqport = [37000, 38000]
-    assert eiger.rx_zmqport == [37000, 37001, 38000, 38001]
-
-@eigertest
-def test_set_rx_updport(eiger):
-    ports = [60010,60011,60012,60013]
-    eiger.rx_udpport = ports
-    assert eiger.rx_udpport == ports
-    eiger.acq()
-    assert eiger.frames_caught == 1
-
-@eigertest
-def test_rx_tcpport(eiger):
-    ports = eiger.rx_tcpport
-    eiger.rx_tcpport = [2000,2001]
-    assert eiger.rx_tcpport == [2000,2001]
-    eiger.rx_tcpport = ports
-    assert eiger.rx_tcpport == ports
-    eiger.acq()
-    assert eiger.frames_caught == 1
-
-# @eigertest
-# @pytest.mark.new
-# def test_enable_disable_tengiga(eiger):
-#     """
-#     This test does not check for dat on the 10Gbit link, only the set and get functions
-#     """
-#     eiger.tengiga = True
-#     assert eiger.tengiga == True
-#     eiger.tengiga = False
-#     assert eiger.tengiga == False
-
-
-
-#TODO! Add test for Jungfrau

python/simple-integration-tests/eiger/test_paths_and_files.py

@@ -1,54 +0,0 @@
-import pytest
-import config_test
-from fixtures import detector, eiger, jungfrau, eigertest, jungfrautest
-from sls_detector.errors import DetectorValueError
-
-
-
-
-@eigertest
-@pytest.mark.local
-def test_set_path(eiger, tmpdir):
-    import os
-    path = os.path.join(tmpdir.dirname, tmpdir.basename)
-    eiger.file_path = path
-    assert eiger.file_path == path
-
-@eigertest
-@pytest.mark.local
-def test_set_path_and_write_files(eiger, tmpdir):
-    import os
-    prefix = 'testprefix'
-    path = os.path.join(tmpdir.dirname, tmpdir.basename)
-    eiger.file_path = path
-    eiger.file_write = True
-    eiger.exposure_time = 0.1
-    eiger.n_frames = 1
-    eiger.timing_mode = 'auto'
-    eiger.file_name = prefix
-    eiger.file_index = 0
-    eiger.acq()
-
-    files = [f.basename for f in tmpdir.listdir()]
-
-    assert len(files) == 5
-    assert (prefix+'_d0_0.raw' in files) == True
-    assert (prefix+'_d1_0.raw' in files) == True
-    assert (prefix+'_d2_0.raw' in files) == True
-    assert (prefix+'_d3_0.raw' in files) == True
-
-def test_set_discard_policy(detector):
-    detector.frame_discard_policy = 'nodiscard'
-    assert detector.frame_discard_policy == 'nodiscard'
-    detector.frame_discard_policy = 'discardpartial'
-    assert detector.frame_discard_policy == 'discardpartial'
-    detector.frame_discard_policy = 'discardempty'
-    assert detector.frame_discard_policy == 'discardempty'
-
-def test_set_discard_policy_raises(detector):
-    with pytest.raises(ValueError):
-        detector.frame_discard_policy = 'adjfvadksvsj'
-
-def test_set_frames_perfile(detector):
-    detector.frames_per_file = 5000
-    assert detector.frames_per_file == 5000

python/simple-integration-tests/eiger/test_threshold.py

@@ -1,47 +0,0 @@
-import pytest
-import config_test
-import time
-from sls_detector.errors import DetectorValueError
-import os
-from fixtures import eiger, eigertest
-
-
-testdata_th = [0,333,500,1750,2000]
-
-@eigertest
-@pytest.mark.parametrize("th", testdata_th)
-def test_set_vthreshold(eiger, th):
-    eiger.vthreshold = th
-    assert eiger.vthreshold == th
-
-@eigertest
-def test_vthreshold_with_different_vcmp(eiger):
-    #When vcmp is different for the chip vthreshold should return -1
-    eiger.vthreshold = 1500
-    eiger.dacs.vcmp_ll = 1400
-    assert eiger.vthreshold == -1
-
-@eigertest
-def test_set_settingsdir(eiger):
-    path = os.path.dirname( os.path.realpath(__file__) )
-    path = os.path.join(path, 'settingsdir')
-    eiger.settings_path = path
-    assert eiger.settings_path == path
-
-@eigertest
-def test_set_trimmed_energies(eiger):
-    en = [5000,6000,7000]
-    eiger.trimmed_energies = en
-    assert eiger.trimmed_energies == en
-
-
-#TODO! add checks for vcmp as well and improve naming
-#TODO! remove dependency on beb number
-testdata_en = [(5000, 500),(5500,750),(6000,1000),(6200,1100),(7000,1500)]
-@eigertest
-@pytest.mark.parametrize('val', testdata_en)
-def test_set_energy_threshold(eiger, val):
-    eiger.settings = 'standard'
-    eiger.threshold = val[0]
-    assert eiger.threshold == val[0]
-    assert eiger.dacs.vrf[0] == val[1]

python/simple-integration-tests/eiger/test_time.py

@@ -1,136 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-"""
-Tests regarding exposure time and period of the detector
-Set and get test as well as test for duration and on detector 
-measurement of the time.
-"""
-import pytest
-import config_test
-from fixtures import detector, eiger, jungfrau, eigertest, jungfrautest
-from sls_detector.errors import DetectorValueError, DetectorError
-import time
-
-
-testdata_times = [1e-8, 0.001, 0.5, 3.125, 5.0, 600, 784]
-@pytest.mark.parametrize("t", testdata_times)
-def test_set_and_get_exposure_time(eiger, t):
-    """
-    Test that the exposure time we set in the detector
-    is the same as the one read back
-    """
-    eiger.exposure_time = t
-    assert eiger.exposure_time == t
-
-
-def test_negative_exposure_time_raises_error(eiger):
-    with pytest.raises(DetectorValueError):
-        eiger.exposure_time = -15
-
-
-testdata_times = [0.001, 0.0025, 0.005, 5]
-@pytest.mark.parametrize("t", testdata_times)
-def test_set_subexptime(eiger, t):
-    eiger.sub_exposure_time = t
-    assert eiger.sub_exposure_time == t
-
-
-testdata_times = [-5,6,7,50]
-@pytest.mark.parametrize("t", testdata_times)
-def test_set_subextime_too_large_or_neg(eiger, t):
-    with pytest.raises((DetectorError, DetectorValueError)):
-        eiger.sub_exposure_time = t
-
-
-
-testdata_times = [0.2, 0.5, 1, 2, 5, 7]
-@pytest.mark.slow
-@pytest.mark.parametrize("t", testdata_times)
-def test_measure_exposure_time_from_python(eiger, t):
-    """ 
-    The main idea with this test is to make sure the overhead of a
-    single acq is less than tol[s]. This test also catches stupid bugs
-    that would for example not change the exposure time or make acquire 
-    not blocking. 
-    """
-    tol = 0.5
-    eiger.dynamic_range = 16
-    eiger.file_write = False
-    eiger.n_frames = 1
-    eiger.exposure_time = t
-    assert eiger.exposure_time == t
-    t0 = time.time()
-    eiger.acq()
-    duration = time.time()-t0
-    assert duration < (t+tol)
-
-
-testdata_times = [0.5, 1, 3, 5]
-
-
-@pytest.mark.slow
-@pytest.mark.parametrize("t", testdata_times)
-def test_measure_period_from_python_and_detector(eiger, t):
-    tol = 0.5
-    nframes = 5
-    eiger.dynamic_range = 16
-    eiger.file_write = False
-    eiger.n_frames = nframes
-    eiger.exposure_time = 0.001
-    eiger.period = t
-    t0 = time.time()
-    eiger.acq()
-    duration = time.time()-t0
-    assert duration < t*(nframes-1)+tol
-    for mp in eiger.measured_period:
-        assert pytest.approx(mp, 1e-5) == t
-
-
-testdata_times = [0.001, 0.002, 0.003, 0.005, 0.01]
-@pytest.mark.parametrize("t", testdata_times)
-def test_measure_subperiod_nonparallel(eiger, t):
-    readout_time = 500e-6
-    eiger.dynamic_range = 32
-    eiger.file_write = False
-    eiger.flags = 'nonparallel'
-    eiger.n_frames = 1
-    eiger.period = 0
-    eiger.exposure_time = 0.5
-    eiger.sub_exposure_time = t
-    eiger.sub_deadtime = 0
-    eiger.acq()
-    for mp in eiger.measured_subperiod:
-        assert pytest.approx(mp, abs=1e-5) == t+readout_time
-
-
-@pytest.mark.parametrize("t", testdata_times)
-def test_measure_subperiod_parallel(eiger, t):
-    readout_time = 12e-6
-    eiger.dynamic_range = 32
-    eiger.file_write = False
-    eiger.flags = 'parallel'
-    eiger.n_frames = 1
-    eiger.period = 0
-    eiger.exposure_time = 0.5
-    eiger.sub_exposure_time = t
-    eiger.sub_deadtime = 0
-    eiger.acq()
-    for mp in eiger.measured_subperiod:
-        assert pytest.approx(mp, abs=1e-5) == t+readout_time
-
-
-@pytest.mark.parametrize("t", testdata_times)
-def test_measure_subperiod_parallel_when_changing_deadtime(eiger, t):
-    readout_time = 12e-6
-    exposure_time = 0.001
-    eiger.dynamic_range = 32
-    eiger.file_write = False
-    eiger.flags = 'parallel'
-    eiger.n_frames = 1
-    eiger.period = 0
-    eiger.exposure_time = 0.5
-    eiger.sub_exposure_time = exposure_time
-    eiger.sub_deadtime = t
-    eiger.acq()
-    for mp in eiger.measured_subperiod:
-        assert pytest.approx(mp, abs=1e-5) == t+exposure_time

python/simple-integration-tests/eiger/test_trimbits_and_dacs.py

@@ -1,34 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-"""
-Tests for trimbit and dac related functions
-"""
-import pytest
-import config_test
-from fixtures import detector, eiger, jungfrau, eigertest, jungfrautest
-from sls_detector.errors import DetectorValueError
-
-
-@eigertest
-def test_set_trimbits(eiger):
-    """Limited values due to time"""
-    for i in [17, 32, 60]:
-        print(i)
-        eiger.trimbits = i
-        assert eiger.trimbits == i
-
-@eigertest
-def test_set_trimbits_raises_on_too_big(eiger):
-    with pytest.raises(DetectorValueError):
-        eiger.trimbits = 75
-
-@eigertest
-def test_set_trimbits_raises_on_negative(eiger):
-    with pytest.raises(DetectorValueError):
-        eiger.trimbits = -5
-
-
-# @jungfrautest
-# def test_jungfrau(jungfrau):
-#     """Example of a test that is not run with Eiger connected"""
-#     pass

python/simple-integration-tests/eiger/test_version_numbers.py

@@ -1,16 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-"""
-Tests for hostname related functions of the detector
-"""
-import pytest
-import config_test
-from fixtures import detector, eiger, jungfrau, eigertest, jungfrautest
-from sls_detector.errors import DetectorValueError
-
-
-
-def test_firmware_version(detector):
-    assert detector.firmware_version == config_test.fw_version
-
-

python/simple-integration-tests/eiger/write_tb_files.py

@@ -1,42 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-"""
-Created on Tue May 22 14:13:48 2018
-
-@author: l_frojdh
-"""
-import os
-from sls_detector_tools.io import write_trimbit_file
-from sls_detector_tools import mask
-
-energy = [5000, 6000, 7000]
-vrf =     [500, 1000, 1500]
-
-for i,e in enumerate(energy):
-    dacs = np.array(  [[   0.,    0.],   #vsvp
-                       [4000., 4000.],  #vtr
-                       [vrf[i], vrf[i]],  #vrf
-                       [1400., 1400.],  #vrs
-                       [4000., 4000.],  #vsvn
-                       [2556., 2556.],  #vtgstv
-                       [1400., 1400.],  #vcmp_ll
-                       [1500., 1500.],  #vcmp_lr
-                       [4000., 4000.],  #vcall
-                       [1500., 1500.],  #vcmp_rl
-                       [1100., 1100.],  #rxb_rb
-                       [1100., 1100.],  #rxb_lb
-                       [1500., 1500.],  #vcmp_rr
-                       [1500., 1500.],  #vcp
-                       [2000., 2000.],  #vcn
-                       [1550., 1550.],  #vis
-                       [ 660.,  660.],  #iodelay
-                       [   0.,    0.],  #tau
-                       ]) 
-    
-    tb = np.zeros((256,1024))
-    
-    for beb in [83,98]:
-        write_trimbit_file(f'settingsdir/standard/{e}eV/noise.sn{beb:03d}', tb, dacs[:,0])
-#print(os.getcwd())
-    
-#print( os.path.realpath(__file__))

python/simple-integration-tests/jungfrau_0_6/config_test.py

@@ -1,17 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-"""
-Created on Tue Nov 14 16:49:07 2017
-
-@author: l_frojdh
-"""
-
-fw_version = 0x180220
-detector_type = 'Jungfrau'
-known_hostnames = ['bchip038']
-image_size = (512,1024) #rows, cols
-module_geometry = (1,1) #horizontal, vertical
-
-#Remember to change these in the settings file as well!
-settings_path = '/home/l_lopez/projects/slsDetectorPackage/settingsdir/jungfrau'
-file_path = '/home/l_lopez/out'

python/simple-integration-tests/jungfrau_0_6/fixtures.py

@@ -1,23 +0,0 @@
-import pytest
-
-from sls_detector import Detector
-
-@pytest.fixture
-def detector():
-    from sls_detector import Detector
-    return Detector()
-
-@pytest.fixture
-def eiger():
-    from sls_detector import Eiger
-    return Eiger()
-
-
-@pytest.fixture
-def jungfrau():
-    from sls_detector import Jungfrau
-    return Jungfrau()
-
-detector_type = Detector().detector_type
-eigertest = pytest.mark.skipif(detector_type != 'Eiger', reason = 'Only valid for Eiger')
-jungfrautest = pytest.mark.skipif(detector_type != 'Jungfrau', reason = 'Only valid for Jungfrau')

python/simple-integration-tests/jungfrau_0_6/test_main.py

@@ -1,17 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-"""
-General tests for the Jungfrau detector.
-
-NOTE! Uses hostnames from config_test
-"""
-
-import pytest
-import config_test
-import tests
-
-import os
-dir_path = os.path.dirname(os.path.realpath(__file__))
-
-pytest.main(['-x', '-s', os.path.join(dir_path, 'tests/test_load_config.py')])            #Test 1
-pytest.main(['-x', '-s', os.path.join(dir_path, 'tests/test_overtemperature.py')])        #Test 2

python/simple-integration-tests/jungfrau_0_6/tests/test.config

@@ -1,21 +0,0 @@
-detsizechan 1024 512
-
-settingsdir /home/l_lopez/projects/slsDetectorPackage/settingsdir/jungfrau
-caldir /home/l_lopez/projects/slsDetectorPackage/settingsdir/jungfrau
-lock 0
-
-hostname bchip094+
-
-rx_udpport 1754
-rx_udpip 10.1.1.107
-rx_udpmac 90:E2:BA:9A:4F:D4
-detectorip 10.1.1.9
-detectormac 00:aa:bb:cc:dd:ee
-configuremac 0
-
-powerchip 1
-timing auto
-
-outdir /home/l_lopez/out
-threaded 1
-high

python/simple-integration-tests/jungfrau_0_6/tests/test.par

@@ -1 +0,0 @@
-highvoltage 200

python/simple-integration-tests/jungfrau_0_6/tests/test_load_config.py

@@ -1,43 +0,0 @@
-
-import pytest
-import config_test
-import os
-dir_path = os.path.dirname(os.path.realpath(__file__))
-
-from fixtures import jungfrau, jungfrautest
-
-
-def load_config_file_jungfrau_test(jungfrau):
-    """Load a settings file and assert all settings"""
-
-    print('\tStarting load_config_file_jungfrau_test test case')
-
-    jungfrau.free_shared_memory
-    jungfrau.load_config(os.path.join(dir_path, 'test.config'))
-
-    assert jungfrau.lock == False
-    assert jungfrau.rx_udpport == ['1754']
-    assert jungfrau.hostname == ['bchip094']
-    assert jungfrau.firmware_version == config_test.fw_version
-
-    print('\tFinished load_config_file_jungfrau_test test case')
-
-def load_parameters_file_jungfrau_test(jungfrau):
-    """Load a parametes file and assert the settings in the file"""
-
-    print('\tStarting load_parameters_file_jungfrau_test test case')
-
-    jungfrau.load_parameters(os.path.join(dir_path, 'test.par'))
-    assert jungfrau.high_voltage == 200
-
-    print('\tFinished load_parameters_file_jungfrau_test test case')
-
-@jungfrautest
-def test_main(jungfrau):
-    print('\nTesting configuration file loading')
-
-    load_config_file_jungfrau_test(jungfrau)
-    load_parameters_file_jungfrau_test(jungfrau)
-
-    print('Tested configuration file loading')
-

python/simple-integration-tests/jungfrau_0_6/tests/test_overtemperature.py

@@ -1,68 +0,0 @@
-
-import pytest
-import config_test
-import time
-from fixtures import jungfrau, jungfrautest
-
-def powerchip_test(jungfrau, control):
-    """
-
-    Test the main overtemperature protection control
-
-    """
-    #Set test initial conditions
-    print('\tStarting powerchip_test test case')
-
-    jungfrau.power_chip = False
-    jungfrau.temperature_control = control
-    assert jungfrau.power_chip == False
-    jungfrau.temperature_threshold = 35
-    jungfrau.power_chip = True
-
-
-    if jungfrau.temperature_control is True:
-        if jungfrau.temperature_event is True:
-            assert jungfrau.power_chip == False
-            jungfrau.power_chip = True
-            assert jungfrau.power_chip == False
-            jungfrau.temperature_control = False
-            assert jungfrau.power_chip == True
-            jungfrau.temperature_control = True
-            jungfrau.temperature_threshold = 50
-            assert jungfrau.power_chip == False
-
-            print('\t\tWaiting to cool down the board. This may take a while...')
-            while jungfrau.temperature_threshold < jungfrau.temp.fpga[0]:
-                time.sleep(5)
-                print('\t\tJungfrau MCB temperature: {0:.2f} °C'.format(jungfrau.temp.fpga[0]))
-
-            #Leave enough time to let the board cool down a bit more
-            time.sleep(30)
-            jungfrau.reset_temperature_event()
-
-            assert jungfrau.temperature_event == False
-            assert jungfrau.power_chip == True
-
-        else:
-            assert jungfrau.power_chip == True
-    else:
-        print('\t\tWaiting to warm up the board. This may take a while...')
-        while jungfrau.temperature_threshold > jungfrau.temp.fpga[0]:
-            time.sleep(5)
-            print('\t\tJungfrau MCB temperature: {0:.2f} °C'.format(jungfrau.temp.fpga[0]))
-
-        assert jungfrau.temperature_event == False
-        assert jungfrau.power_chip == True
-
-    print('\tFinished powerchip_test test case')
-
-
-#@jungfrautest
-def test_main(jungfrau):
-
-    print('\nTesting overtemperature protection control')
-
-    powerchip_test(jungfrau, False)
-    powerchip_test(jungfrau, True)
-
-    print('Tested overtemperature protection control')

python/slsdet/__init__.py

@@ -5,32 +5,15 @@ from .dacs import DetectorDacs, Dac
 from .detector import Detector
 from .jungfrau import Jungfrau
 from .mythen3 import Mythen3
-# from .jungfrau_ctb import JungfrauCTB
-# from _slsdet import DetectorApi
+from .gotthard2 import Gotthard2
+from .gotthard import Gotthard
+from .moench import Moench
 
 import _slsdet
-
+xy = _slsdet.xy
 defs = _slsdet.slsDetectorDefs
-runStatus = _slsdet.slsDetectorDefs.runStatus
-speedLevel = _slsdet.slsDetectorDefs.speedLevel
 
-
-detectorType = _slsdet.slsDetectorDefs.detectorType
-frameDiscardPolicy = _slsdet.slsDetectorDefs.frameDiscardPolicy
-fileFormat = _slsdet.slsDetectorDefs.fileFormat
-dimension = _slsdet.slsDetectorDefs.dimension
-externalSignalFlag = _slsdet.slsDetectorDefs.externalSignalFlag
-timingMode = _slsdet.slsDetectorDefs.timingMode
-dacIndex = _slsdet.slsDetectorDefs.dacIndex
-detectorSettings = _slsdet.slsDetectorDefs.detectorSettings
-clockIndex = _slsdet.slsDetectorDefs.clockIndex
-readoutMode = _slsdet.slsDetectorDefs.readoutMode
-masterFlags = _slsdet.slsDetectorDefs.masterFlags
-
-frameModeType = _slsdet.slsDetectorDefs.frameModeType
-detectorModeType = _slsdet.slsDetectorDefs.detectorModeType
-burstMode = _slsdet.slsDetectorDefs.burstMode
-timingSourceType = _slsdet.slsDetectorDefs.timingSourceType
+from .enums import *
 
 
 IpAddr = _slsdet.IpAddr

python/slsdet/adcs.py

@@ -1,23 +1,33 @@
 from functools import partial
 class Adc:
-    def __init__(self, name, detector):
+    def __init__(self, name, enum, detector):
         self.name = name
+        self.enum = enum
         self._detector = detector
-        self.get_nmod = self._detector._api.getNumberOfDetectors
+        self.get_nmod = self._detector.size
         # Bind functions to get and set the dac
-        self.get = partial(self._detector._api.getAdc, self.name)
+        self.get = partial(self._detector.getAdc, self.enum)
 
         
     def __getitem__(self, key):
-        """
-        Get dacs either by slice, key or list
-        """
         if key == slice(None, None, None):
-            return [self.get(i) / 1000 for i in range(self.get_nmod())]
+            return self.get()
         elif isinstance(key, Iterable):
-            return [self.get(k) / 1000 for k in key]
+            return self.get(list(key))
         else:
-            return self.get(key) / 1000
+            return self.get([key])[0] #No list for single value
+
+
+    # def __getitem__(self, key):
+    #     """
+    #     Get dacs either by slice, key or list
+    #     """
+    #     if key == slice(None, None, None):
+    #         return [self.get(i) / 1000 for i in range(self.get_nmod())]
+    #     elif isinstance(key, Iterable):
+    #         return [self.get(k) / 1000 for k in key]
+    #     else:
+    #         return self.get(key) / 1000
 
     def __repr__(self):
         """String representation for a single adc in all modules"""

python/slsdet/dacs.py

@@ -32,10 +32,9 @@ class Dac(DetectorProperty):
     def __repr__(self):
         """String representation for a single dac in all modules"""
         dacstr = ''.join([f'{item:5d}' for item in self.get()])
-        return f'{self.__name__:10s}:{dacstr}'
+        return f'{self.__name__:15s}:{dacstr}'
+
 
-# a = Dac('vrf', dacIndex.VRF, 0, 4000, 2500, d )
-# @freeze
 class DetectorDacs:
     _dacs = []
     _dacnames = [_d[0] for _d in _dacs]
@@ -93,6 +92,9 @@ class DetectorDacs:
             dac_array[i,:] = _d[:]
         return dac_array
 
+    def to_array(self):
+        return self.get_asarray()
+
     def set_from_array(self, dac_array):
         """
         Set the dacs from an numpy array with dac values. [ndacs, nmodules]
@@ -101,6 +103,9 @@ class DetectorDacs:
         for i, _d in enumerate(self):
             _d[:] = dac_array[i]
 
+    def from_array(self, dac_array):
+        self.set_from_array(dac_array)
+
     def set_default(self):
         """
         Set all dacs to their default values

python/slsdet/eiger.py

@@ -6,22 +6,17 @@ Created on Wed Dec  6 11:51:18 2017
 @author: l_frojdh
 """
 
-
 from .detector import Detector
-
-# from .adcs import Adc, DetectorAdcs
+from .temperature import Temperature, DetectorTemperature
 from .dacs import DetectorDacs
 import _slsdet
 dacIndex = _slsdet.slsDetectorDefs.dacIndex
 from .detector_property import DetectorProperty
-# from .utils import element_if_equal
-# from sls_detector.errors import DetectorValueError, DetectorError
 
 class EigerVcmp:
     """
     Convenience class to be able to loop over vcmp for Eiger
     
-    
     .. todo::
         
         Support single assignment and perhaps unify with Dac class
@@ -79,58 +74,6 @@ class EigerDacs(DetectorDacs):
              ('iodelay',  dacIndex.IO_DELAY,0, 4000,  660)]
     _dacnames = [_d[0] for _d in _dacs]
 
-# # noinspection PyProtectedMember
-# class DetectorDelays:
-#     _delaynames = ['frame', 'left', 'right']
-
-#     def __init__(self, detector):
-#         # We need to at least initially know which detector we are connected to
-#         self._detector = detector
-        
-#         setattr(self, '_frame', DetectorProperty(detector._api.getDelayFrame,
-#                                                  detector._api.setDelayFrame,
-#                                                  detector._api.getNumberOfDetectors,
-#                                                  'frame'))
-
-#         setattr(self, '_left', DetectorProperty(detector._api.getDelayLeft,
-#                                                 detector._api.setDelayLeft,
-#                                                 detector._api.getNumberOfDetectors,
-#                                                 'left'))
-
-#         setattr(self, '_right', DetectorProperty(detector._api.getDelayRight,
-#                                                  detector._api.setDelayRight,
-#                                                  detector._api.getNumberOfDetectors,
-#                                                  'right'))
-#         # Index to support iteration
-#         self._current = 0
-
-#     def __getattr__(self, name):
-#         return self.__getattribute__('_' + name)
-
-#     def __setattr__(self, name, value):
-#         if name in self._delaynames:
-#             return self.__getattribute__('_' + name).__setitem__(slice(None, None, None), value)
-#         else:
-#             super().__setattr__(name, value)
-
-#     def __next__(self):
-#         if self._current >= len(self._delaynames):
-#             self._current = 0
-#             raise StopIteration
-#         else:
-#             self._current += 1
-#             return self.__getattr__(self._delaynames[self._current-1])
-
-#     def __iter__(self):
-#         return self
-
-#     def __repr__(self):
-#         hn = self._detector.hostname
-#         r_str = ['Transmission delay [ns]\n'
-#                  '{:11s}{:>8s}{:>8s}{:>8s}'.format('', 'left', 'right', 'frame')]
-#         for i in range(self._detector.n_modules):
-#             r_str.append('{:2d}:{:8s}{:>8d}{:>8d}{:>8d}'.format(i, hn[i], self.left[i], self.right[i], self.frame[i]))
-#         return '\n'.join(r_str)
 
 from .detector import freeze
 
@@ -152,76 +95,18 @@ class Eiger(Detector):
         self._dacs = EigerDacs(self)
         self._vcmp = EigerVcmp(self)
 
-        # self._active = DetectorProperty(self.getActive,
-        #                                 self.setActive,
-        #                                 self.size,
-        #                                 'active')   
+        # Eiger specific adcs
+        self._temp = DetectorTemperature()
+        self._temp.fpga = Temperature('temp_fpga', dacIndex.TEMPERATURE_FPGA, self)
+        self._temp.fpgaext = Temperature('temp_fpgaext', dacIndex.TEMPERATURE_FPGAEXT, self)
+        self._temp.t10ge = Temperature('temp_10ge', dacIndex.TEMPERATURE_10GE, self)
+        self._temp.dcdc = Temperature('temp_dcdc', dacIndex.TEMPERATURE_DCDC, self)
+        self._temp.sodl = Temperature('temp_sodl', dacIndex.TEMPERATURE_SODL, self)
+        self._temp.sodr = Temperature('temp_sodl', dacIndex.TEMPERATURE_SODR, self)
+        self._temp.temp_fpgafl = Temperature('temp_fpgafl', dacIndex.TEMPERATURE_FPGA2, self)
+        self._temp.temp_fpgafr = Temperature('temp_fpgafr', dacIndex.TEMPERATURE_FPGA3, self)
 
-#         self._trimbit_limits = namedtuple('trimbit_limits', ['min', 'max'])(0, 63)
-#         self._delay = DetectorDelays(self)
 
-#         # Eiger specific adcs
-#         self._temp = DetectorAdcs()
-#         self._temp.fpga = Adc('temp_fpga', self)
-#         self._temp.fpgaext = Adc('temp_fpgaext', self)
-#         self._temp.t10ge = Adc('temp_10ge', self)
-#         self._temp.dcdc = Adc('temp_dcdc', self)
-#         self._temp.sodl = Adc('temp_sodl', self)
-#         self._temp.sodr = Adc('temp_sodr', self)
-#         self._temp.fpgafl = Adc('temp_fpgafl', self)
-#         self._temp.fpgafr = Adc('temp_fpgafr', self)
-
-    # @property
-    # def active(self):
-    #     """
-    #     Is the detector active? Can be used to enable or disable a detector
-    #     module
-        
-    #     Examples
-    #     ----------
-        
-    #     ::
-            
-    #         d.active
-    #         >> active: [True, True]
-            
-    #         d.active[1] = False
-    #         >> active: [True, False]
-    #     """
-    #     return self._active
-    
-    # @active.setter
-    # def active(self, value):
-    #     self._active[:] = value
-    
-#     @property
-#     def measured_period(self):
-#         return self._api.getMeasuredPeriod()
-
-#     @property
-#     def measured_subperiod(self):
-#         return self._api.getMeasuredSubPeriod()
-
-#     @property
-#     def add_gappixels(self):
-#        """Enable or disable the (virual) pixels between ASICs
-
-#        Examples
-#        ----------
-
-#        ::
-
-#            d.add_gappixels = True
-
-#            d.add_gappixels
-#            >> True
-
-#        """
-#        return self._api.getGapPixels()
-
-#     @add_gappixels.setter
-#     def add_gappixels(self, value):
-#        self._api.setGapPixels(value)
 
     @property
     def dacs(self):
@@ -284,68 +169,6 @@ class Eiger(Detector):
         """
         return self._dacs
 
-#     @property
-#     def tx_delay(self):
-#         """
-#         Transmission delay of the modules to allow running the detector
-#         in a network not supporting the full speed of the detector.
-
-
-#         ::
-            
-#             d.tx_delay
-#             >>
-#             Transmission delay [ns]
-#                            left   right   frame
-#              0:beb048         0   15000       0
-#              1:beb049       100  190000     100
-             
-#              d.tx_delay.left = [2000,5000]
-#         """
-#         return self._delay
-
-#     def pulse_all_pixels(self, n):
-#         """
-#         Pulse each pixel of the chip **n** times using the analog test pulses.
-#         The pulse height is set using d.dacs.vcall with 4000 being 0 and 0 being
-#         the highest pulse.
-        
-#         ::
-            
-#             #Pulse all pixels ten times
-#             d.pulse_all_pixels(10)
-            
-#             #Avoid resetting before acq
-#             d.eiger_matrix_reset = False
-            
-#             d.acq() #take frame
-            
-#             #Restore normal behaviour
-#             d.eiger_matrix_reset = True
-        
-        
-#         """
-#         self._api.pulseAllPixels(n)
-        
-
-#     def pulse_diagonal(self, n):
-#         """
-#         Pulse pixels in super colums in a diagonal fashion. Used for calibration
-#         of vcall. Saves time compared to pulsing all pixels.
-#         """
-#         self._api.pulseDiagonal(n)
-
-
-#     def pulse_chip(self, n):
-#         """
-#         Advance the counter by toggling enable. Gives 2*n+2 int the counter
-        
-#         """
-#         n = int(n)
-#         if n >= -1:
-#             self._api.pulseChip(n)
-#         else:
-#             raise ValueError('n must be equal or larger than -1')
 
     @property
     def vcmp(self):
@@ -437,40 +260,33 @@ class Eiger(Detector):
 #         else:
 #             self._api.setReceiverStreamingPort(port, -1)
 
-#     @property
-#     def temp(self):
-#         """
-#         An instance of DetectorAdcs used to read the temperature
-#         of different components
+    @property
+    def temp(self):
+        """
+        An instance of DetectorAdcs used to read the temperature
+        of different components
 
-#         Examples
-#         -----------
+        Examples
+        -----------
 
-#         ::
+        ::
 
-#             detector.temp
-#             >>
-#             temp_fpga     :  36.90°C,  45.60°C
-#             temp_fpgaext  :  31.50°C,  32.50°C
-#             temp_10ge     :   0.00°C,   0.00°C
-#             temp_dcdc     :  36.00°C,  36.00°C
-#             temp_sodl     :  33.00°C,  34.50°C
-#             temp_sodr     :  33.50°C,  34.00°C
-#             temp_fpgafl   :  33.81°C,  30.93°C
-#             temp_fpgafr   :  27.88°C,  29.15°C
+            detector.temp
+            >>
+            temp_fpga     :  36.90°C,  45.60°C
+            temp_fpgaext  :  31.50°C,  32.50°C
+            temp_10ge     :   0.00°C,   0.00°C
+            temp_dcdc     :  36.00°C,  36.00°C
+            temp_sodl     :  33.00°C,  34.50°C
+            temp_sodr     :  33.50°C,  34.00°C
+            temp_fpgafl   :  33.81°C,  30.93°C
+            temp_fpgafr   :  27.88°C,  29.15°C
 
-#             a = detector.temp.fpga[:]
-#             a
-#             >> [36.568, 45.542]
+            a = detector.temp.fpga[:]
+            a
+            >> [36.568, 45.542]
 
 
-#         """
-#         return self._temp
-
-
-
-#     def set_delays(self, delta):
-#         self.tx_delay.left = [delta*(i*2) for i in range(self.n_modules)]
-#         self.tx_delay.right = [delta*(i*2+1) for i in range(self.n_modules)]
-
+        """
+        return self._temp
 

python/slsdet/enums.py

@@ -0,0 +1,17 @@
+
+import _slsdet
+runStatus = _slsdet.slsDetectorDefs.runStatus
+speedLevel = _slsdet.slsDetectorDefs.speedLevel
+detectorType = _slsdet.slsDetectorDefs.detectorType
+frameDiscardPolicy = _slsdet.slsDetectorDefs.frameDiscardPolicy
+fileFormat = _slsdet.slsDetectorDefs.fileFormat
+dimension = _slsdet.slsDetectorDefs.dimension
+externalSignalFlag = _slsdet.slsDetectorDefs.externalSignalFlag
+timingMode = _slsdet.slsDetectorDefs.timingMode
+dacIndex = _slsdet.slsDetectorDefs.dacIndex
+detectorSettings = _slsdet.slsDetectorDefs.detectorSettings
+clockIndex = _slsdet.slsDetectorDefs.clockIndex
+readoutMode = _slsdet.slsDetectorDefs.readoutMode
+masterFlags = _slsdet.slsDetectorDefs.masterFlags
+burstMode = _slsdet.slsDetectorDefs.burstMode
+timingSourceType = _slsdet.slsDetectorDefs.timingSourceType

python/slsdet/gotthard.py

@@ -0,0 +1,51 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""
+This file contains the specialization for the Moench detector
+"""
+
+
+from .detector import Detector, freeze
+from .dacs import DetectorDacs
+import _slsdet
+dacIndex = _slsdet.slsDetectorDefs.dacIndex
+from .detector_property import DetectorProperty
+
+# @freeze
+
+# vref_ds, vcascn_pb, vcascp_pb, vout_cm, vcasc_out, vin_cm, vref_comp, ib_test_c
+class GotthardDacs(DetectorDacs):
+    _dacs = [('vref_ds',     dacIndex.VREF_DS,    0, 4000,   660),
+             ('vcascn_pb',   dacIndex.VCASCN_PB,  0, 4000,   650),
+             ('vcascp_pb,',  dacIndex.VCASCP_PB,  0, 4000,  1480),
+             ('vout_cm',     dacIndex.VOUT_CM,    0, 4000,  1520),
+             ('vcasc_out',   dacIndex.VCASC_OUT,  0, 4000,  1320),
+             ('vin_cm',      dacIndex.VIN_CM,     0, 4000,  1350),
+             ('vref_comp',   dacIndex.VREF_COMP,  0, 4000,   350),
+             ('ib_test_c',   dacIndex.IB_TESTC,   0, 4000,   2001),
+            ]
+    _dacnames = [_d[0] for _d in _dacs]
+
+#vthreshold??
+
+
+@freeze
+class Gotthard(Detector):
+    """
+    Subclassing Detector to set up correct dacs and detector specific 
+    functions. 
+    """
+    _detector_dynamic_range = [16]
+
+
+    _settings = ['standard', 'highgain', 'lowgain', 'veryhighgain', 'verylowgain']
+    """available settings for Eiger, note almost always standard"""
+
+    def __init__(self, id=0):
+        super().__init__(id)
+        self._frozen = False 
+        self._dacs = GotthardDacs(self)
+    
+    @property
+    def dacs(self):
+        return self._dacs

python/slsdet/gotthard2.py

@@ -0,0 +1,61 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""
+This file contains the specialization for the Jungfrau detector
+"""
+
+
+from .detector import Detector, freeze
+
+# from .adcs import Adc, DetectorAdcs
+from .dacs import DetectorDacs
+import _slsdet
+dacIndex = _slsdet.slsDetectorDefs.dacIndex
+from .detector_property import DetectorProperty
+
+
+# @freeze
+class Gotthard2Dacs(DetectorDacs):
+    """
+    Gotthard2 specific DACs
+    """
+    _dacs = [('vref_h_adc',     dacIndex.VREF_H_ADC,   0, 4000, 2116),
+             ('vb_comp_fe',     dacIndex.VB_COMP_FE,   0, 4000,    0),
+             ('vb_comp_adc',    dacIndex.VB_COMP_ADC,  0, 4000,    0),
+             ('vcom_cds',      dacIndex.VCOM_CDS,      0, 4000,  705),
+             ('vref_rstore',   dacIndex.VREF_RSTORE,   0, 4000,  205),
+             ('vb_opa_1st',    dacIndex.VB_OPA_1ST,    0, 4000,    0),
+             ('vref_comp_fe',  dacIndex.VREF_COMP_FE,  0, 4000,    0),
+             ('vcom_adc1',     dacIndex.VCOM_ADC1,     0, 4000,  705),
+             ('vref_prech',    dacIndex.VREF_PRECH,    0, 4000,  900),
+             ('vref_l_adc',    dacIndex.VREF_L_ADC,    0, 4000,  700),
+             ('vref_cds',      dacIndex.VREF_CDS,      0, 4000,  600),
+             ('vb_cs',         dacIndex.VB_CS,         0, 4000, 2799),
+             ('vb_opa_fd',     dacIndex.VB_OPA_FD,     0, 4000,    0),
+             ('vcom_adc2',      dacIndex.VCOM_ADC2,    0, 4000,  704),
+            ]
+    _dacnames = [_d[0] for _d in _dacs]
+
+
+
+
+@freeze
+class Gotthard2(Detector):
+    """
+    Subclassing Detector to set up correct dacs and detector specific 
+    functions. 
+    """
+    _detector_dynamic_range = [16]
+
+
+    _settings = ['standard', 'highgain', 'lowgain', 'veryhighgain', 'verylowgain']
+    """available settings for Eiger, note almost always standard"""
+
+    def __init__(self, id=0):
+        super().__init__(id)
+        self._frozen = False 
+        self._dacs = Gotthard2Dacs(self)
+    
+    @property
+    def dacs(self):
+        return self._dacs

python/slsdet/moench.py

@@ -0,0 +1,52 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""
+This file contains the specialization for the Moench detector
+"""
+
+
+from .detector import Detector, freeze
+from .dacs import DetectorDacs
+import _slsdet
+dacIndex = _slsdet.slsDetectorDefs.dacIndex
+from .detector_property import DetectorProperty
+
+# @freeze
+class MoenchDacs(DetectorDacs):
+    """
+    Jungfrau specific DACs
+    """
+    _dacs = [('vbp_colbuf',     dacIndex.VBP_COLBUF,    0, 4000,  1300),
+             ('vipre',          dacIndex.VIPRE,         0, 4000,  1000),
+             ('vin_cm,',        dacIndex.VIN_CM,        0, 4000,  1400),
+             ('vb_sda',         dacIndex.VB_SDA,        0, 4000,   680),
+             ('vcasc_sfp',      dacIndex.VCASC_SFP,     0, 4000,  1428),
+             ('vout_cm',        dacIndex.VOUT_CM,       0, 4000,  1200),
+             ('vipre_cds',      dacIndex.VIPRE_CDS,     0, 4000,   800),
+             ('ibias_sfp',      dacIndex.IBIAS_SFP,     0, 4000,   900),
+            ]
+    _dacnames = [_d[0] for _d in _dacs]
+
+#vthreshold??
+
+
+@freeze
+class Moench(Detector):
+    """
+    Subclassing Detector to set up correct dacs and detector specific 
+    functions. 
+    """
+    _detector_dynamic_range = [16]
+
+
+    _settings = ['standard', 'highgain', 'lowgain', 'veryhighgain', 'verylowgain']
+    """available settings for Eiger, note almost always standard"""
+
+    def __init__(self, id=0):
+        super().__init__(id)
+        self._frozen = False 
+        self._dacs = MoenchDacs(self)
+    
+    @property
+    def dacs(self):
+        return self._dacs

python/slsdet/mythen3.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 """
-This file contains the specialization for the Jungfrau detector
+This file contains the specialization for the Mythen3 detector
 """
 
 

python/slsdet/proxy.py

@@ -0,0 +1,128 @@
+from .utils import element_if_equal
+from .enums import dacIndex
+
+
+def set_proxy_using_dict(func, key, value):
+    if isinstance(value, dict) and all(isinstance(k, int) for k in value.keys()):
+        for dkey, dvalue in value.items():
+            func(key, dvalue, [dkey])
+    else:
+        func(key, value)
+
+class JsonProxy:
+    """
+    Proxy class to allow for intuitive setting and getting of rx_jsonpara
+    This class is returned by Detectr.rx_jsonpara
+    """
+    def __init__(self, det):
+        self.det = det
+
+    def __getitem__(self, key):
+        return element_if_equal(self.det.getAdditionalJsonParameter(key))
+
+    def __setitem__(self, key, value):
+        self.det.setAdditionalJsonParameter(key, str(value))
+
+    def __repr__(self):
+        r = element_if_equal(self.det.getAdditionalJsonHeader())
+        if isinstance(r, list):
+            rstr = ''
+            for i, list_item in enumerate(r):
+                list_item = dict(list_item)
+                rstr += ''.join([f'{i}:{key}: {value}\n' for key, value in list_item.items()])
+
+            return rstr.strip('\n')
+        else:
+            r = dict(r)
+            return '\n'.join([f'{key}: {value}' for key, value in r.items()])
+
+    
+
+class SlowAdcProxy:
+    """
+    Proxy class to allow for more intuitive reading the slow ADCs
+    """
+    def __init__(self, det):
+        self.det = det
+
+    def __getitem__(self, key):
+        dac_index = dacIndex(int(dacIndex.SLOW_ADC0)+key)
+        return element_if_equal(self.det.getSlowADC(dac_index))
+
+    def __repr__(self):
+        rstr = ''
+        for i in range(8):
+            r = element_if_equal(self.__getitem__(i))
+            if isinstance(r, list):
+                rstr += ' '.join(f'{item} uV' for item in r)
+            else:
+                rstr += f'{i}: {r} uV\n'
+        
+        return rstr.strip('\n')
+
+class ClkDivProxy:
+    """
+    Proxy class to allow for more intuitive reading clockdivider
+    """
+    def __init__(self, det):
+        self.det = det
+
+    def __getitem__(self, key):
+        return element_if_equal(self.det.getClockDivider(key))
+
+    def __setitem__(self, key, value):
+        set_proxy_using_dict(self.det.setClockDivider, key, value)
+
+    def __repr__(self):
+        rstr = ''
+        for i in range(6):
+            r = element_if_equal(self.__getitem__(i))
+            if isinstance(r, list):
+                rstr += ' '.join(f'{item}' for item in r)
+            else:
+                rstr += f'{i}: {r}\n'
+        
+        return rstr.strip('\n')
+
+
+class MaxPhaseProxy:
+    """
+    Proxy class to allow for more intuitive reading clockdivider
+    """
+    def __init__(self, det):
+        self.det = det
+
+    def __getitem__(self, key):
+        return element_if_equal(self.det.getMaxClockPhaseShift(key))
+
+    def __repr__(self):
+        rstr = ''
+        for i in range(5):
+            r = element_if_equal(self.__getitem__(i))
+            if isinstance(r, list):
+                rstr += ' '.join(f'{item}' for item in r)
+            else:
+                rstr += f'{i}: {r}\n'
+        
+        return rstr.strip('\n')
+
+class ClkFreqProxy:
+    """
+    Proxy class to allow for more intuitive reading clockdivider
+    """
+    def __init__(self, det):
+        self.det = det
+
+    def __getitem__(self, key):
+        return element_if_equal(self.det.getClockFrequency(key))
+
+    def __repr__(self):
+        rstr = ''
+        for i in range(5):
+            r = element_if_equal(self.__getitem__(i))
+            if isinstance(r, list):
+                rstr += ' '.join(f'{item}' for item in r)
+            else:
+                rstr += f'{i}: {r}\n'
+        
+        return rstr.strip('\n')

python/slsdet/temperature.py

@@ -0,0 +1,50 @@
+from functools import partial
+from collections.abc import Iterable
+import numpy as np
+class Temperature:
+    degree_sign = u"\N{DEGREE SIGN}"
+
+    def __init__(self, name, enum, detector):
+        self.name = name
+        self.enum = enum
+        self._detector = detector
+        self.get_nmod = self._detector.size
+        # Bind functions to get and set the dac
+        self.get = partial(self._detector.getTemperature, self.enum)
+
+    def __getitem__(self, key):
+        if key == slice(None, None, None):
+            return self.get()
+        elif isinstance(key, Iterable):
+            return self.get(list(key))
+        else:
+            return self.get([key])[0]  # No list for single value
+
+    def __repr__(self):
+        """String representation for a single temperature in all modules"""
+        
+        tempstr = ''.join([f'{item:5d}{self.degree_sign}C' for item in self.get()])
+        return f'{self.name:15s}:{tempstr}'
+
+class DetectorTemperature:
+    """
+    Interface to temperatures on the readout board
+    """
+
+    def __iter__(self):
+        for attr, value in self.__dict__.items():
+            yield value
+
+    def __repr__(self):
+        """String representation of all temps all mods"""
+        r_str = '\n'.join([repr(temp) for temp in self])
+        return r_str
+
+    def to_dict(self):
+        """Get temperatures as a dictionary with numpy arrays"""
+        return {attr:np.array(value.get()) for attr, value in self.__dict__.items()}
+
+    def to_array(self):
+        """Get all temperatures as a numpy array"""
+        t = self.to_dict()
+        return np.vstack([value for key, value in t.items()])

python/slsdet/utils.py

@@ -3,14 +3,17 @@ Utility functions that are useful for testing and troubleshooting
 but not directly used in controlling the detector
 """
 
-
 from collections import namedtuple
 import _slsdet  #C++ lib
 import functools
 import datetime as dt
+import pathlib
+import os
+from pathlib import Path
 
 Geometry = namedtuple('Geometry', ['x', 'y'])
 
+
 def is_iterable(item):
     try:
         iter(item)
@@ -18,11 +21,13 @@ def is_iterable(item):
         return False
     return True
 
+
 def get_set_bits(mask):
     """
     Return a list of the set bits in a python integer
     """
-    return [i for i in range(mask.bit_length()) if (mask>>i)&1]
+    return [i for i in range(mask.bit_length()) if (mask >> i) & 1]
+
 
 def list_to_bitmask(values):
     """
@@ -35,11 +40,21 @@ def list_to_bitmask(values):
         mask += 1 << v
     return mask
 
+def make_bitmask(args):
+    if isinstance(args, list):
+        return list_to_bitmask(args)
+    elif isinstance(args, dict):
+        return {key: list_to_bitmask(value) for key, value in args.items()}
+    else:
+        raise ValueError("Cannot convert arg to bitmask")
+
+
 def to_geo(value):
     if isinstance(value, _slsdet.xy):
-        return Geometry(x = value.x, y = value.y)
+        return Geometry(x=value.x, y=value.y)
     else:
-        raise ValueError("Can only convert sls_detector.xy")
+        raise ValueError("Can only convert slsdet.xy")
+
 
 def all_equal(mylist):
     """If all elements are equal return true otherwise false"""
@@ -59,6 +74,7 @@ def element_if_equal(mylist):
     else:
         return mylist
 
+
 def reduce_time(mylist):
     res = element_if_equal(element_if_equal(mylist))
     if isinstance(res, dt.timedelta):
@@ -68,6 +84,7 @@ def reduce_time(mylist):
     else:
         return [r.total_seconds() for r in res]
 
+
 def element(func):
     """
     Wrapper to return either list or element
@@ -75,8 +92,10 @@ def element(func):
     @functools.wraps(func)
     def wrapper(self, *args, **kwargs):
         return element_if_equal(func(self, *args, **kwargs))
+
     return wrapper
 
+
 def eiger_register_to_time(register):
     """
     Decode register value and return time in s. Values are stored in
@@ -86,10 +105,157 @@ def eiger_register_to_time(register):
     """
     clocks = register >> 3
     exponent = register & 0b111
-    return clocks*10**exponent / 100e6
+    return clocks * 10**exponent / 100e6
+
 
 def make_timedelta(t):
     if isinstance(t, dt.timedelta):
         return t
     else:
         return dt.timedelta(seconds=t)
+
+
+def _make_string_path(path):
+    """
+    Accepts either a pathlib.Path or a string, expands ~ to user and convert
+    Path to str
+    """
+    if isinstance(path, pathlib.Path):
+        return path.expanduser().as_posix()
+    elif isinstance(path, str):
+        return os.path.expanduser(path)
+    else:
+        raise ValueError("Cannot convert argument to posix path")
+
+
+def make_string_path(path):
+    return _make(path, _make_string_path)
+
+
+def make_ip(arg):
+    return _make(arg, _slsdet.IpAddr)
+
+
+def make_mac(arg):
+    return _make(arg, _slsdet.MacAddr)
+
+
+def make_path(arg):
+    return _make(arg, Path)
+
+
+def _make(arg, transform):
+    """Helper function for make_mac and make_ip special cases for
+    dict, list and tuple. Otherwise just calls transform"""
+    if isinstance(arg, dict):
+        return {key: transform(value) for key, value in arg.items()}
+    elif isinstance(arg, list):
+        return [transform(a) for a in arg]
+    elif isinstance(arg, tuple):
+        return tuple(transform(a) for a in arg)
+    else:
+        return transform(arg)
+
+
+def set_using_dict(func, *args):
+
+    if len(args) == 1 and isinstance(args[0], dict) and all(
+            isinstance(k, int) for k in args[0].keys()):
+        for key, value in args[0].items():
+            if not isinstance(value, tuple):
+                value = (value,)
+            try:
+                func(*value, [key])
+            except TypeError:
+                func(*value, key)
+    else:
+        func(*args)
+
+
+def set_time_using_dict(func, args):
+    if isinstance(args, dict) and all(isinstance(k, int) for k in args.keys()):
+        for key, value in args.items():
+            if isinstance(value, int):
+                value = float(value)
+            func(value, [key])
+    else:
+        if isinstance(args, int):
+            args = float(args)
+        func(args)
+
+
+def lhex(iterable):
+    return [hex(item) for item in iterable]
+
+
+def lpath(iterable):
+    return [Path(item) for item in iterable]
+
+def add_argument_before(a, args):
+    """Add a before the other arguments. Also works with
+    dict that holds args to several modules. Always puts the
+    args in a dict to be compatible with set_using_dict"""
+    if isinstance(args, tuple):
+        return (a, *args)
+    elif isinstance(args, dict):
+        ret = {}
+        for key, value in args.items():
+            if isinstance(value, tuple):
+                ret[key] = (a, *value)
+            else:
+                ret[key] = (a, value)
+        return (ret,)
+    return a, args
+
+def add_argument_after(args, a):
+    """Add a before the other arguments. Also works with
+    dict that holds args to several modules. Always puts the
+    args in a dict to be compatible with set_using_dict"""
+    if isinstance(args, tuple):
+        return (*args, a)
+    elif isinstance(args, dict):
+        ret = {}
+        for key, value in args.items():
+            if isinstance(value, tuple):
+                ret[key] = (*value, a)
+            else:
+                ret[key] = (value, a)
+        return (ret,)
+    return args, a
+
+def pop_dict(args):
+    for i,a in enumerate(args):
+        if isinstance(a, dict):
+            return args.pop(i), i
+
+def tuplify(args):
+    if not isinstance(args, tuple):
+        return (args, )
+    else:
+        return args
+
+def merge_args(*args):
+    n_dict = sum(isinstance(a, dict) for a in args)
+    
+    if n_dict == 0: #no dict just make a tuple of arguments
+        ret = []
+        for a in args:
+            if isinstance(a, tuple):
+                ret.extend(a)
+            else:
+                ret.append(a)
+        return tuple(ret)
+
+    elif n_dict == 1:
+        args = [a for a in args] #these are the args to be added
+        values,pos = pop_dict(args)
+        ret = {}
+        for k, v in values.items():
+            v = tuplify(v)
+            items = [a for a in args]
+            items[pos:pos] = v
+            ret[k] = tuple(items)
+        return (ret,)
+
+    else:
+        raise ValueError("Multiple dictionaries passes cannot merge args")

python/src/detector.cpp

@@ -36,6 +36,10 @@ void init_det(py::module &m) {
              (void (Detector::*)(const std::string &)) &
                  Detector::loadParameters,
              py::arg())
+        .def("loadParameters",
+             (void (Detector::*)(const std::vector<std::string> &)) &
+                 Detector::loadParameters,
+             py::arg())
         .def("getHostname",
              (Result<std::string>(Detector::*)(sls::Positions) const) &
                  Detector::getHostname,
@@ -180,6 +184,14 @@ void init_det(py::module &m) {
              (Result<sls::ns>(Detector::*)(sls::Positions) const) &
                  Detector::getDelayAfterTriggerLeft,
              py::arg() = Positions{})
+        .def("getDynamicRange",
+             (Result<int>(Detector::*)(sls::Positions) const) &
+                 Detector::getDynamicRange,
+             py::arg() = Positions{})
+        .def("setDynamicRange",
+             (void (Detector::*)(int)) & Detector::setDynamicRange, py::arg())
+        .def("getDynamicRangeList", (std::vector<int>(Detector::*)() const) &
+                                        Detector::getDynamicRangeList)
         .def("getTimingMode",
              (Result<defs::timingMode>(Detector::*)(sls::Positions) const) &
                  Detector::getTimingMode,
@@ -188,6 +200,9 @@ void init_det(py::module &m) {
              (void (Detector::*)(defs::timingMode, sls::Positions)) &
                  Detector::setTimingMode,
              py::arg(), py::arg() = Positions{})
+        .def("getTimingModeList",
+             (std::vector<defs::timingMode>(Detector::*)() const) &
+                 Detector::getTimingModeList)
         .def("getSpeed",
              (Result<defs::speedLevel>(Detector::*)(sls::Positions) const) &
                  Detector::getSpeed,
@@ -238,10 +253,6 @@ void init_det(py::module &m) {
              (Result<int>(Detector::*)(int, sls::Positions)) &
                  Detector::getClockFrequency,
              py::arg(), py::arg() = Positions{})
-        .def("setClockFrequency",
-             (void (Detector::*)(int, int, sls::Positions)) &
-                 Detector::setClockFrequency,
-             py::arg(), py::arg(), py::arg() = Positions{})
         .def("getClockPhase",
              (Result<int>(Detector::*)(int, sls::Positions)) &
                  Detector::getClockPhase,
@@ -294,6 +305,9 @@ void init_det(py::module &m) {
              (void (Detector::*)(const int, sls::Positions)) &
                  Detector::setImageTestMode,
              py::arg(), py::arg() = Positions{})
+        .def("getTemperatureList",
+             (std::vector<defs::dacIndex>(Detector::*)() const) &
+                 Detector::getTemperatureList)
         .def("getTemperature",
              (Result<int>(Detector::*)(defs::dacIndex, sls::Positions) const) &
                  Detector::getTemperature,
@@ -304,11 +318,11 @@ void init_det(py::module &m) {
              (Result<int>(Detector::*)(defs::dacIndex, bool, sls::Positions)
                   const) &
                  Detector::getDAC,
-             py::arg(), py::arg(), py::arg() = Positions{})
+             py::arg(), py::arg() = false, py::arg() = Positions{})
         .def("setDAC",
              (void (Detector::*)(defs::dacIndex, int, bool, sls::Positions)) &
                  Detector::setDAC,
-             py::arg(), py::arg(), py::arg(), py::arg() = Positions{})
+             py::arg(), py::arg(), py::arg() = false, py::arg() = Positions{})
         .def("getOnChipDAC",
              (Result<int>(Detector::*)(defs::dacIndex, int, sls::Positions)
                   const) &
@@ -328,6 +342,14 @@ void init_det(py::module &m) {
                                  sls::Positions)) &
                  Detector::setExternalSignalFlags,
              py::arg(), py::arg(), py::arg() = Positions{})
+        .def("getParallelMode",
+             (Result<bool>(Detector::*)(sls::Positions) const) &
+                 Detector::getParallelMode,
+             py::arg() = Positions{})
+        .def("setParallelMode",
+             (void (Detector::*)(bool, sls::Positions)) &
+                 Detector::setParallelMode,
+             py::arg(), py::arg() = Positions{})
         .def("acquire", (void (Detector::*)()) & Detector::acquire)
         .def("clearAcquiringFlag",
              (void (Detector::*)()) & Detector::clearAcquiringFlag)
@@ -364,6 +386,18 @@ void init_det(py::module &m) {
              (void (Detector::*)(sls::Positions)) &
                  Detector::sendSoftwareTrigger,
              py::arg() = Positions{})
+        .def("getScan",
+             (Result<defs::scanParameters>(Detector::*)(sls::Positions) const) &
+                 Detector::getScan,
+             py::arg() = Positions{})
+        .def("setScan",
+             (void (Detector::*)(const defs::scanParameters)) &
+                 Detector::setScan,
+             py::arg())
+        .def("getScanErrorMessage",
+             (Result<std::string>(Detector::*)(sls::Positions) const) &
+                 Detector::getScanErrorMessage,
+             py::arg() = Positions{})
         .def("getNumberofUDPInterfaces",
              (Result<int>(Detector::*)(sls::Positions) const) &
                  Detector::getNumberofUDPInterfaces,
@@ -450,14 +484,22 @@ void init_det(py::module &m) {
              py::arg() = Positions{})
         .def("setDestinationUDPPort",
              (void (Detector::*)(int, int)) & Detector::setDestinationUDPPort,
-             py::arg(), py::arg())
+             py::arg(), py::arg() = -1)
         .def("getDestinationUDPPort2",
              (Result<int>(Detector::*)(sls::Positions) const) &
                  Detector::getDestinationUDPPort2,
              py::arg() = Positions{})
         .def("setDestinationUDPPort2",
              (void (Detector::*)(int, int)) & Detector::setDestinationUDPPort2,
-             py::arg(), py::arg())
+             py::arg(), py::arg() = -1)
+        .def("reconfigureUDPDestination",
+             (void (Detector::*)(sls::Positions)) &
+                 Detector::reconfigureUDPDestination,
+             py::arg() = Positions{})
+        .def("validateUDPConfiguration",
+             (void (Detector::*)(sls::Positions)) &
+                 Detector::validateUDPConfiguration,
+             py::arg() = Positions{})
         .def("printRxConfiguration",
              (Result<std::string>(Detector::*)(sls::Positions) const) &
                  Detector::printRxConfiguration,
@@ -522,7 +564,7 @@ void init_det(py::module &m) {
                  Detector::getRxPort,
              py::arg() = Positions{})
         .def("setRxPort", (void (Detector::*)(int, int)) & Detector::setRxPort,
-             py::arg(), py::arg())
+             py::arg(), py::arg() = -1)
         .def("getRxFifoDepth",
              (Result<int>(Detector::*)(sls::Positions) const) &
                  Detector::getRxFifoDepth,
@@ -623,13 +665,10 @@ void init_det(py::module &m) {
                  Detector::setFileWrite,
              py::arg(), py::arg() = Positions{})
         .def("getMasterFileWrite",
-             (Result<bool>(Detector::*)(sls::Positions) const) &
-                 Detector::getMasterFileWrite,
-             py::arg() = Positions{})
+             (bool (Detector::*)() const) & Detector::getMasterFileWrite)
         .def("setMasterFileWrite",
-             (void (Detector::*)(bool, sls::Positions)) &
-                 Detector::setMasterFileWrite,
-             py::arg(), py::arg() = Positions{})
+             (void (Detector::*)(bool)) & Detector::setMasterFileWrite,
+             py::arg())
         .def("getFileOverWrite",
              (Result<bool>(Detector::*)(sls::Positions) const) &
                  Detector::getFileOverWrite,
@@ -670,13 +709,21 @@ void init_det(py::module &m) {
              (void (Detector::*)(int, sls::Positions)) &
                  Detector::setRxZmqTimer,
              py::arg(), py::arg() = Positions{})
+        .def("getRxZmqStartingFrame",
+             (Result<int>(Detector::*)(sls::Positions) const) &
+                 Detector::getRxZmqStartingFrame,
+             py::arg() = Positions{})
+        .def("setRxZmqStartingFrame",
+             (void (Detector::*)(int, sls::Positions)) &
+                 Detector::setRxZmqStartingFrame,
+             py::arg(), py::arg() = Positions{})
         .def("getRxZmqPort",
              (Result<int>(Detector::*)(sls::Positions) const) &
                  Detector::getRxZmqPort,
              py::arg() = Positions{})
         .def("setRxZmqPort",
              (void (Detector::*)(int, int)) & Detector::setRxZmqPort, py::arg(),
-             py::arg())
+             py::arg() = -1)
         .def("getRxZmqIP",
              (Result<sls::IpAddr>(Detector::*)(sls::Positions) const) &
                  Detector::getRxZmqIP,
@@ -691,7 +738,7 @@ void init_det(py::module &m) {
              py::arg() = Positions{})
         .def("setClientZmqPort",
              (void (Detector::*)(int, int)) & Detector::setClientZmqPort,
-             py::arg(), py::arg())
+             py::arg(), py::arg() = -1)
         .def("getClientZmqIp",
              (Result<sls::IpAddr>(Detector::*)(sls::Positions) const) &
                  Detector::getClientZmqIp,
@@ -700,12 +747,6 @@ void init_det(py::module &m) {
              (void (Detector::*)(const sls::IpAddr, sls::Positions)) &
                  Detector::setClientZmqIp,
              py::arg(), py::arg() = Positions{})
-        .def("getDynamicRange",
-             (Result<int>(Detector::*)(sls::Positions) const) &
-                 Detector::getDynamicRange,
-             py::arg() = Positions{})
-        .def("setDynamicRange",
-             (void (Detector::*)(int)) & Detector::setDynamicRange, py::arg())
         .def("getSubExptime",
              (Result<sls::ns>(Detector::*)(sls::Positions) const) &
                  Detector::getSubExptime,
@@ -730,7 +771,8 @@ void init_det(py::module &m) {
              (void (Detector::*)(int, defs::detectorSettings, bool,
                                  sls::Positions)) &
                  Detector::setThresholdEnergy,
-             py::arg(), py::arg(), py::arg(), py::arg() = Positions{})
+             py::arg(), py::arg() = defs::STANDARD, py::arg() = true,
+             py::arg() = Positions{})
         .def("getSettingsPath",
              (Result<std::string>(Detector::*)(sls::Positions) const) &
                  Detector::getSettingsPath,
@@ -739,14 +781,6 @@ void init_det(py::module &m) {
              (void (Detector::*)(const std::string &, sls::Positions)) &
                  Detector::setSettingsPath,
              py::arg(), py::arg() = Positions{})
-        .def("getParallelMode",
-             (Result<bool>(Detector::*)(sls::Positions) const) &
-                 Detector::getParallelMode,
-             py::arg() = Positions{})
-        .def("setParallelMode",
-             (void (Detector::*)(bool, sls::Positions)) &
-                 Detector::setParallelMode,
-             py::arg(), py::arg() = Positions{})
         .def("getOverFlowMode",
              (Result<bool>(Detector::*)(sls::Positions) const) &
                  Detector::getOverFlowMode,
@@ -931,6 +965,10 @@ void init_det(py::module &m) {
              (void (Detector::*)(sls::ns, sls::Positions)) &
                  Detector::setBurstPeriod,
              py::arg(), py::arg() = Positions{})
+        .def("getNumberOfBurstsLeft",
+             (Result<int64_t>(Detector::*)(sls::Positions) const) &
+                 Detector::getNumberOfBurstsLeft,
+             py::arg() = Positions{})
         .def("getInjectChannel",
              (Result<std::array<int, 2>>(Detector::*)(sls::Positions)) &
                  Detector::getInjectChannel,
@@ -939,11 +977,11 @@ void init_det(py::module &m) {
              (void (Detector::*)(const int, const int, sls::Positions)) &
                  Detector::setInjectChannel,
              py::arg(), py::arg(), py::arg() = Positions{})
-        .def(
-            "getVetoPhoton",
-            (Result<std::vector<int>>(Detector::*)(const int, sls::Positions)) &
+        .def("getVetoPhoton",
+             (void (Detector::*)(const int, const std::string &,
+                                 sls::Positions)) &
                  Detector::getVetoPhoton,
-            py::arg(), py::arg() = Positions{})
+             py::arg(), py::arg(), py::arg() = Positions{})
         .def("setVetoPhoton",
              (void (Detector::*)(const int, const int, const int,
                                  const std::string &, sls::Positions)) &
@@ -954,6 +992,11 @@ void init_det(py::module &m) {
              (void (Detector::*)(const int, const int, sls::Positions)) &
                  Detector::setVetoReference,
              py::arg(), py::arg(), py::arg() = Positions{})
+        .def("setVetoFile",
+             (void (Detector::*)(const int, const std::string &,
+                                 sls::Positions)) &
+                 Detector::setVetoFile,
+             py::arg(), py::arg(), py::arg() = Positions{})
         .def("getBurstMode",
              (Result<defs::burstMode>(Detector::*)(sls::Positions)) &
                  Detector::getBurstMode,
@@ -962,6 +1005,20 @@ void init_det(py::module &m) {
              (void (Detector::*)(defs::burstMode, sls::Positions)) &
                  Detector::setBurstMode,
              py::arg(), py::arg() = Positions{})
+        .def("getCDSGain",
+             (Result<bool>(Detector::*)(sls::Positions) const) &
+                 Detector::getCDSGain,
+             py::arg() = Positions{})
+        .def("setCDSGain",
+             (void (Detector::*)(bool, sls::Positions)) & Detector::setCDSGain,
+             py::arg(), py::arg() = Positions{})
+        .def("getFilter",
+             (Result<int>(Detector::*)(sls::Positions) const) &
+                 Detector::getFilter,
+             py::arg() = Positions{})
+        .def("setFilter",
+             (void (Detector::*)(int, sls::Positions)) & Detector::setFilter,
+             py::arg(), py::arg() = Positions{})
         .def("getCurrentSource",
              (Result<bool>(Detector::*)(sls::Positions) const) &
                  Detector::getCurrentSource,
@@ -987,6 +1044,24 @@ void init_det(py::module &m) {
              (void (Detector::*)(const bool, sls::Positions)) &
                  Detector::setVeto,
              py::arg(), py::arg() = Positions{})
+        .def("getADCConfiguration",
+             (Result<int>(Detector::*)(const int, const int, sls::Positions)
+                  const) &
+                 Detector::getADCConfiguration,
+             py::arg(), py::arg(), py::arg() = Positions{})
+        .def("setADCConfiguration",
+             (void (Detector::*)(const int, const int, const int,
+                                 sls::Positions)) &
+                 Detector::setADCConfiguration,
+             py::arg(), py::arg(), py::arg(), py::arg() = Positions{})
+        .def("getBadChannels",
+             (void (Detector::*)(const std::string &, sls::Positions) const) &
+                 Detector::getBadChannels,
+             py::arg(), py::arg() = Positions{})
+        .def("setBadChannels",
+             (void (Detector::*)(const std::string &, sls::Positions)) &
+                 Detector::setBadChannels,
+             py::arg(), py::arg() = Positions{})
         .def("getCounterMask",
              (Result<uint32_t>(Detector::*)(sls::Positions) const) &
                  Detector::getCounterMask,
@@ -1267,31 +1342,6 @@ void init_det(py::module &m) {
                                  sls::Positions)) &
                  Detector::setAdditionalJsonParameter,
              py::arg(), py::arg(), py::arg() = Positions{})
-        .def("getDetectorMinMaxEnergyThreshold",
-             (Result<int>(Detector::*)(const bool, sls::Positions) const) &
-                 Detector::getDetectorMinMaxEnergyThreshold,
-             py::arg(), py::arg() = Positions{})
-        .def("setDetectorMinMaxEnergyThreshold",
-             (void (Detector::*)(const bool, const int, sls::Positions)) &
-                 Detector::setDetectorMinMaxEnergyThreshold,
-             py::arg(), py::arg(), py::arg() = Positions{})
-        .def("getFrameMode",
-             (Result<defs::frameModeType>(Detector::*)(sls::Positions) const) &
-                 Detector::getFrameMode,
-             py::arg() = Positions{})
-        .def("setFrameMode",
-             (void (Detector::*)(defs::frameModeType, sls::Positions)) &
-                 Detector::setFrameMode,
-             py::arg(), py::arg() = Positions{})
-        .def("getDetectorMode",
-             (Result<defs::detectorModeType>(Detector::*)(sls::Positions)
-                  const) &
-                 Detector::getDetectorMode,
-             py::arg() = Positions{})
-        .def("setDetectorMode",
-             (void (Detector::*)(defs::detectorModeType, sls::Positions)) &
-                 Detector::setDetectorMode,
-             py::arg(), py::arg() = Positions{})
         .def("programFPGA",
              (void (Detector::*)(const std::string &, sls::Positions)) &
                  Detector::programFPGA,
@@ -1328,6 +1378,10 @@ void init_det(py::module &m) {
              (void (Detector::*)(uint32_t, int, sls::Positions)) &
                  Detector::clearBit,
              py::arg(), py::arg(), py::arg() = Positions{})
+        .def("getBit",
+             (Result<int>(Detector::*)(uint32_t, int, sls::Positions)) &
+                 Detector::getBit,
+             py::arg(), py::arg(), py::arg() = Positions{})
         .def("executeFirmwareTest",
              (void (Detector::*)(sls::Positions)) &
                  Detector::executeFirmwareTest,

python/src/enums.cpp

@@ -259,24 +259,13 @@ void init_enums(py::module &m) {
         .value("IS_SLAVE", slsDetectorDefs::masterFlags::IS_SLAVE)
         .export_values();
 
-    py::enum_<slsDetectorDefs::frameModeType>(Defs, "frameModeType")
-        .value("PEDESTAL", slsDetectorDefs::frameModeType::PEDESTAL)
-        .value("NEW_PEDESTAL", slsDetectorDefs::frameModeType::NEW_PEDESTAL)
-        .value("FLATFIELD", slsDetectorDefs::frameModeType::FLATFIELD)
-        .value("NEW_FLATFIELD", slsDetectorDefs::frameModeType::NEW_FLATFIELD)
-        .export_values();
-
-    py::enum_<slsDetectorDefs::detectorModeType>(Defs, "detectorModeType")
-        .value("COUNTING", slsDetectorDefs::detectorModeType::COUNTING)
-        .value("INTERPOLATING",
-               slsDetectorDefs::detectorModeType::INTERPOLATING)
-        .value("ANALOG", slsDetectorDefs::detectorModeType::ANALOG)
-        .export_values();
-
     py::enum_<slsDetectorDefs::burstMode>(Defs, "burstMode")
-        .value("BURST_OFF", slsDetectorDefs::burstMode::BURST_OFF)
         .value("BURST_INTERNAL", slsDetectorDefs::burstMode::BURST_INTERNAL)
         .value("BURST_EXTERNAL", slsDetectorDefs::burstMode::BURST_EXTERNAL)
+        .value("CONTINUOUS_INTERNAL",
+               slsDetectorDefs::burstMode::CONTINUOUS_INTERNAL)
+        .value("CONTINUOUS_EXTERNAL",
+               slsDetectorDefs::burstMode::CONTINUOUS_EXTERNAL)
         .value("NUM_BURST_MODES", slsDetectorDefs::burstMode::NUM_BURST_MODES)
         .export_values();
 

python/tests/test_utils.py

@@ -0,0 +1,342 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""
+Testing functions from utils.py
+"""
+
+import pytest
+from slsdet.utils import *
+from slsdet import IpAddr, MacAddr
+import datetime as dt
+import pathlib
+from pathlib import Path
+
+
+def test_iterable():
+    assert is_iterable(5) == False
+    assert is_iterable('abc') == True
+    assert is_iterable([]) == True
+    assert is_iterable(5.9) == False
+
+
+def test_reduce_time_to_single_value_from_list():
+    t = 3 * [dt.timedelta(seconds=1)]
+    assert reduce_time(t) == 1
+
+
+def test_reduce_time_to_single_value_from_list_of_lists():
+    t = 3 * [dt.timedelta(seconds=3.3)]
+    tt = 5 * t
+    assert reduce_time(tt) == 3.3
+
+
+def test_reduce_time_when_sublist_is_different():
+    t = [
+        dt.timedelta(seconds=1),
+        dt.timedelta(seconds=2),
+        dt.timedelta(seconds=1)
+    ]
+    tt = [t for i in range(4)]
+    assert reduce_time(tt) == [1, 2, 1]
+
+
+def test_convert_zero():
+    assert eiger_register_to_time(0) == 0
+
+
+def test_convert_smallest_unit():
+    assert pytest.approx(eiger_register_to_time(0b1000), 1e-9) == 1e-8
+
+
+def test_convert_second_smallest_unit():
+    assert pytest.approx(eiger_register_to_time(0b10000), 1e-9) == 2e-8
+
+
+def test_convert_one_ms_using_exponent():
+    assert pytest.approx(eiger_register_to_time(0b1101), 1e-9) == 1e-3
+
+
+def test_convert_five_seconds():
+    assert pytest.approx(eiger_register_to_time(0b1001110001000101),
+                         1e-9) == 5.0
+
+
+def test_all_equal_int():
+    assert all_equal([5, 5]) == True
+
+
+def test_all_equal_fails():
+    assert all_equal([5, 6]) == False
+
+
+def test_all_equal_tuple():
+    assert all_equal(('a', 'a', 'a')) == True
+
+
+def test_all_equal_str():
+    assert all_equal('aaa') == True
+
+
+def test_all_equal_str_fails():
+    assert all_equal('aaab') == False
+
+
+def test_element_if_equal_int():
+    assert element_if_equal([5, 5]) == 5
+
+
+def test_element_if_equal_str():
+    assert element_if_equal('hhh') == 'h'
+
+
+def test_element_if_equal_int_fails():
+    assert element_if_equal([5, 6, 7]) == [5, 6, 7]
+
+
+def test_make_timedelta_from_double():
+    t = 1.7
+    r = make_timedelta(t)
+    assert t == r.total_seconds()
+    assert r == dt.timedelta(seconds=t)
+
+
+def test_make_timedelta_from_timedelta():
+    t = dt.timedelta(minutes=1)
+    r = make_timedelta(t)
+    assert 60 == r.total_seconds()
+    assert r == dt.timedelta(minutes=1)
+
+
+def test_make_string_path_from_Path():
+    pathstr = "/some/temp/path"
+    p = pathlib.Path(pathstr)
+    r = make_string_path(p)
+    assert isinstance(r, str)
+    assert r == p.as_posix()
+    assert r == pathstr
+
+
+def test_make_string_path_expand_user():
+    pathstr = "~/tmp/virtual.config"
+    home = pathlib.Path.home()
+    expanded_str = pathstr.replace('~', home.as_posix())
+    p = pathlib.Path(pathstr)
+    rp = make_string_path(p)
+    rs = make_string_path(pathstr)
+    assert rp == expanded_str
+    assert rs == expanded_str
+
+
+def test_lhex_passing_list():
+    values = [0, 1, 2, 3, 4]
+    assert lhex(values) == ["0x0", "0x1", "0x2", "0x3", "0x4"]
+
+
+def test_lhex_emty_list():
+    assert lhex([]) == []
+
+
+def test_make_ip_from_dict():
+    arg = {0: 0, 1: "192.168.1.1"}
+    res = make_ip(arg)
+    assert res == {0: IpAddr("0.0.0.0"), 1: IpAddr("192.168.1.1")}
+    assert res[0].str() == "0.0.0.0"
+    assert res[1].str() == "192.168.1.1"
+
+
+def test_make_ip_from_str():
+    ip = "192.168.1.1"
+    assert make_ip(ip).str() == ip
+
+
+def test_make_ip_from_list():
+    arg = ["192.168.1.1", "192.168.1.2", "127.0.0.1"]
+    assert make_ip(arg) == [IpAddr(a) for a in arg]
+
+
+def test_make_ip_from_tuple():
+    arg = ("127.0.0.1")
+    assert make_ip(arg) == (IpAddr(arg))
+
+
+def test_make_mac_from_dict():
+    arg = {6: "84:a9:aa:24:32:88", 12: "84:a9:3e:24:32:aa"}
+    res = make_mac(arg)
+    assert res == {
+        6: MacAddr("84:a9:aa:24:32:88"),
+        12: MacAddr("84:a9:3e:24:32:aa")
+    }
+    assert res[6].str() == "84:a9:aa:24:32:88"
+    assert res[12].str() == "84:a9:3e:24:32:aa"
+
+
+def test_make_mac_from_str():
+    mac = "84:a9:aa:24:32:88"
+    assert make_mac(mac) == MacAddr(mac)
+    assert make_mac(mac).str() == mac
+
+
+def test_make_mac_from_list():
+    arg = ["84:a9:aa:24:32:88", "84:a9:3e:24:32:aa"]
+    assert make_mac(arg) == [MacAddr(a) for a in arg]
+
+
+def test_make_mac_from_tuple():
+    arg = ("84:a9:aa:24:32:88", "84:a9:3e:24:32:aa")
+    assert make_mac(arg) == (MacAddr("84:a9:aa:24:32:88"),
+                             MacAddr("84:a9:3e:24:32:aa"))
+
+
+def test_make_path_from_str():
+    assert make_path("/") == Path("/")
+    assert make_path("/home") == Path("/home")
+
+
+def test_make_path_from_list():
+    arg = ["/", "/home", "/another/path"]
+    assert make_path(arg) == [Path(p) for p in arg]
+
+
+def test_make_string_path_from_str():
+    arg = "/path/to/something"
+    assert make_string_path(arg) == arg
+
+
+def test_make_string_path_from_Path():
+    s = "/path/to/something"
+    arg = Path(s)
+    assert make_string_path(arg) == s
+
+
+def test_make_string_path_from_list_of_Path_and_string():
+    args = ["/path/to", Path("/something/something"), "else/"]
+    assert make_string_path(args) == [
+        "/path/to", "/something/something", "else/"
+    ]
+
+
+def test_make_string_path_from_Path_list():
+    s = "/path/to/something"
+    arg = [Path(s)]
+    assert make_string_path(arg) == [s]
+
+
+def test_make_string_path_from_dict():
+    args = {0: "/path/to/something", 1: Path("/something/else")}
+    assert make_string_path(args) == {
+        0: "/path/to/something",
+        1: "/something/else"
+    }
+
+
+class DummyClass:
+    def __init__(self):
+        self.args = []
+
+    def call(self, *args):
+        """Normal type call in slsdet where list of detectors is passed"""
+        self.args.append(args)
+
+    def call_int_id(self, *args):
+        """call where det_is is an int"""
+        *args, i = args
+        if isinstance(i, list):
+            raise TypeError
+        self.args.append((*args, i))
+
+
+def test_set_using_dict_single_int():
+    c = DummyClass()
+    set_using_dict(c.call, 5)
+    assert c.args == [(5, )]
+
+
+def test_set_using_dict_two_ints():
+    c = DummyClass()
+    set_using_dict(c.call, 1, 2)
+    assert c.args == [(1, 2)]
+
+
+def test_set_using_dict_passing_dict():
+    c = DummyClass()
+    set_using_dict(c.call, {0: 5, 8: 3, 9: 7})
+    assert len(c.args) == 3
+    assert c.args == [(5, [0]), (3, [8]), (7, [9])]
+
+
+def test_set_using_dict_calling_int_id():
+    c = DummyClass()
+    set_using_dict(c.call_int_id, {0: "hej", 8: 3, 9: 7})
+    assert len(c.args) == 3
+    assert c.args == [("hej", 0), (3, 8), (7, 9)]
+
+
+def test_set_using_dict_pass_multiple_args():
+    c = DummyClass()
+    set_using_dict(c.call, "a", "b", "c")
+    assert len(c.args) == 1
+    assert c.args == [("a", "b", "c")]
+
+
+def test_set_using_dict_passing_dict_with_multiple_args():
+    c = DummyClass()
+    set_using_dict(c.call, {0: ("a", "b"), 1: ("c", "d")})
+    assert c.args == [("a", "b", [0]), ("c", "d", [1])]
+
+
+def test_get_set_bits():
+    assert (get_set_bits(0) == [])
+    assert get_set_bits(7) == [0, 1, 2]
+
+
+def test_list_to_mask():
+    assert (list_to_bitmask([0, 1, 2]) == 7)
+    assert (list_to_bitmask([]) == 0)
+    assert (list_to_bitmask([0]) == 1)
+    assert (list_to_bitmask([1]) == 2)
+    assert (list_to_bitmask([3]) == 8)
+    assert (list_to_bitmask([1, 1, 1]) == 2)
+
+
+def test_make_bitmask_from_list_of_int():
+    assert make_bitmask([0, 1, 2]) == 0b111
+    assert make_bitmask([0, 1, 7]) == 0b10000011
+    assert make_bitmask([1, 1, 1]) == 0b10
+
+
+def test_make_bitmask_from_dict():
+    assert make_bitmask({0: [0, 1], 1: [0, 1, 7]}) == {0: 0b11, 1: 0b10000011}
+
+
+def test_add_argument_before():
+    assert add_argument_before("a", 5) == ("a", 5)
+    assert add_argument_before(3, ("a", "b")) == (3, "a", "b")
+
+
+def test_add_argument_before_dict():
+    assert add_argument_before(5, {0: "a"}) == ({0: (5, "a")},)
+    assert add_argument_before(0, {0: 1}) == ({0: (0, 1)},)
+    assert add_argument_before(5, {0: ("a", "b")}) == ({0: (5, "a", "b")}, )
+    assert add_argument_before(6, "hej") == (6, "hej")
+    assert add_argument_before("another", {9: "string"}) == ({
+        9: ("another", "string")
+    }, )
+
+
+def test_add_argument_after():
+    assert add_argument_after("a", 5) == ("a", 5)
+    assert add_argument_after(("a", "b"), 3) == ("a", "b", 3)
+
+def test_add_argument_after_dict():
+    assert add_argument_after({0: "a"}, "b") == ({0: ("a", "b")},)
+    assert add_argument_after({0: ("a", 1)}, True) == ({0: ("a", 1, True)}, )
+
+def test_merge_args():
+    assert merge_args("a", "b", 1) == ("a", "b", 1)
+    assert merge_args({0:1, 1:2}, "a") == ({0: (1, "a"), 1: (2, "a")},)
+
+def test_merge_args_tuple():
+    assert merge_args(*("a", "b"), 5) == ("a", "b", 5)
+
+def test_merge_args_dict_with_tuple():
+    assert merge_args({0: (1,2)}, 3) == ({0: (1,2,3)},)

python/unit-tests/dac_test.py

@@ -1,173 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-"""
-Testing setting and getting dacs from the detector
-"""
-from unittest.mock import Mock, call
-import pytest
-from pytest_mock import mocker
-import numpy as np
-
-from sls_detector import Eiger
-from sls_detector import DetectorApi
-
-
-def test_get_vrf_for_three_mod(mocker):
-    m2= mocker.patch.object(DetectorApi, 'getNumberOfDetectors', autospec=True)
-    m2.return_value = 3
-    m = mocker.patch.object(DetectorApi, 'getDac', autospec=True)
-    m.return_value = 1560
-    d = Eiger()
-    vrf = d.dacs.vrf[:]
-    assert vrf == [1560, 1560, 1560]
-    
-def test_set_vrf_for_three_mod_same_value(mocker):
-    m2= mocker.patch.object(DetectorApi, 'getNumberOfDetectors', autospec=True)
-    m2.return_value = 3
-    m = mocker.patch.object(DetectorApi, 'setDac', autospec=True)
-#    m.return_value = 1560
-    d = Eiger()
-    d.dacs.vrf[:] = 1500
-    calls = [call('vrf', 0, 1500), call('vrf', 1, 1500), call('vrf', 2, 1500)]
-    m.assert_has_calls(calls)
-    assert m.call_count == 3
-    
-def test_set_vrf_for_four_mod_different_value(mocker):
-    m2= mocker.patch.object(DetectorApi, 'getNumberOfDetectors', autospec=True)
-    m2.return_value = 4
-    m = mocker.patch.object(DetectorApi, 'setDac', autospec=True)
-#    m.return_value = 1560
-    d = Eiger()
-    d.dacs.vrf =  [1500, 1600, 1800, 1502]
-    calls = [call('vrf', 0, 1500), 
-             call('vrf', 1, 1600), 
-             call('vrf', 2, 1800),
-             call('vrf', 3, 1502)]
-    m.assert_has_calls(calls)
-    assert m.call_count == 4
-    
-def test_set_vrf_for_four_mod_different_value_slice(mocker):
-    m2= mocker.patch.object(DetectorApi, 'getNumberOfDetectors', autospec=True)
-    m2.return_value = 4
-    m = mocker.patch.object(DetectorApi, 'setDac', autospec=True)
-#    m.return_value = 1560
-    d = Eiger()
-    d.dacs.vrf[:] =  [1500, 1600, 1800, 1502]
-    calls = [call('vrf', 0, 1500), 
-             call('vrf', 1, 1600), 
-             call('vrf', 2, 1800),
-             call('vrf', 3, 1502)]
-    m.assert_has_calls(calls)
-    assert m.call_count == 4
-    
-def test_set_vcp_single_call(mocker):
-    m2= mocker.patch.object(DetectorApi, 'getNumberOfDetectors', autospec=True)
-    m2.return_value = 2
-    m = mocker.patch.object(DetectorApi, 'setDac', autospec=True)
-#    m.return_value = 1560
-    d = Eiger()
-    d.dacs.vcp[1] =  1637
-    m.assert_called_once_with('vcp', 1, 1637)
-    
-def test_iterate_on_index_call_vcn(mocker):
-    m2= mocker.patch.object(DetectorApi, 'getNumberOfDetectors', autospec=True)
-    m2.return_value = 10
-    m = mocker.patch.object(DetectorApi, 'setDac', autospec=True)
-#    m.return_value = 1560
-    d = Eiger()
-    d.dacs.vcn[0,3,8] = 1532
-    calls = [call('vcn', 0, 1532), 
-             call('vcn', 3, 1532), 
-             call('vcn', 8, 1532)]
-    m.assert_has_calls(calls)
-    assert m.call_count == 3
-
-def test_set_dac_from_element_in_numpy_array(mocker):
-    m2= mocker.patch.object(DetectorApi, 'getNumberOfDetectors', autospec=True)
-    m2.return_value = 2
-    m = mocker.patch.object(DetectorApi, 'setDac', autospec=True)  
-    d = Eiger()
-    
-    vrf = np.array((1600,1700,1800))
-    d.dacs.vrf = vrf[0]
-    calls = [call('vrf', 0, 1600),
-             call('vrf', 1, 1600),]
-    m.assert_has_calls(calls)
-    assert m.call_count == 2
-
-def test_set_dac_from_element_in_numpy_array_using_slice(mocker):
-    m2= mocker.patch.object(DetectorApi, 'getNumberOfDetectors', autospec=True)
-    m2.return_value = 2
-    m = mocker.patch.object(DetectorApi, 'setDac', autospec=True)  
-    d = Eiger()
-    
-    vrf = np.array((1600,1700,1800))
-    d.dacs.vrf[:] = vrf[0]
-    calls = [call('vrf', 0, 1600),
-             call('vrf', 1, 1600),]
-    m.assert_has_calls(calls)
-    assert m.call_count == 2
-    
-def test_set_eiger_default(mocker):
-    m2= mocker.patch.object(DetectorApi, 'getNumberOfDetectors', autospec=True)
-    m2.return_value = 2
-    m = mocker.patch.object(DetectorApi, 'setDac', autospec=True)
-#    m.return_value = 1560
-    d = Eiger()
-    d.dacs.set_default()
-    calls = [call('vsvp', 0, 0),
-             call('vsvp', 1, 0),
-             call('vtr', 0, 2500),
-             call('vtr', 1, 2500),
-             call('vrf', 0, 3300),
-             call('vrf', 1, 3300),
-             call('vrs', 0, 1400),
-             call('vrs', 1, 1400),
-             call('vsvn', 0, 4000),
-             call('vsvn', 1, 4000),
-             call('vtgstv', 0, 2556),
-             call('vtgstv', 1, 2556),
-             call('vcmp_ll', 0, 1500),
-             call('vcmp_ll', 1, 1500),
-             call('vcmp_lr', 0, 1500),
-             call('vcmp_lr', 1, 1500),
-             call('vcall', 0, 4000),
-             call('vcall', 1, 4000),
-             call('vcmp_rl', 0, 1500),
-             call('vcmp_rl', 1, 1500),
-             call('rxb_rb', 0, 1100),
-             call('rxb_rb', 1, 1100),
-             call('rxb_lb', 0, 1100),
-             call('rxb_lb', 1, 1100),
-             call('vcmp_rr', 0, 1500),
-             call('vcmp_rr', 1, 1500),
-             call('vcp', 0, 200),
-             call('vcp', 1, 200),
-             call('vcn', 0, 2000),
-             call('vcn', 1, 2000),
-             call('vis', 0, 1550),
-             call('vis', 1, 1550),
-             call('iodelay', 0, 660),
-             call('iodelay', 1, 660)]
-
-    m.assert_has_calls(calls)
-    assert m.call_count == 17*2
-    
-def test_set_eiger_set_from_array_call_count(mocker):
-    import numpy as np
-    m2= mocker.patch.object(DetectorApi, 'getNumberOfDetectors', autospec=True)
-    m2.return_value = 3
-    m = mocker.patch.object(DetectorApi, 'setDac', autospec=True)
-#    m.return_value = 1560
-    d = Eiger()
-    d.dacs.set_from_array( np.zeros((17,3)))
-    assert m.call_count == 17*3
-    
-def test_get_fpga_temp(mocker):
-    m2= mocker.patch.object(DetectorApi, 'getNumberOfDetectors', autospec=True)
-    m2.return_value = 2
-    m = mocker.patch.object(DetectorApi, 'getAdc', autospec=True)
-    m.return_value = 34253
-    d = Eiger()
-    t = d.temp.fpga[:]
-    assert t == [34.253, 34.253]

python/unit-tests/detector_eiger.py

@@ -1,489 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-"""
-Testing parameters and methods of the Detector class using mocks
-"""
-from unittest.mock import Mock
-import pytest
-from pytest_mock import mocker
-
-
-
-@pytest.fixture
-def d():
-    from sls_detector import Eiger
-    return Eiger()
-
-
-def test_acq_call(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.acq')
-    d.acq()
-    m.assert_called_once_with()
-
-def test_busy_call(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.getAcquiringFlag')
-    m.return_value = False
-    assert d.busy == False
-
-
-def test_assign_to_detector_type(d):
-    with pytest.raises(AttributeError):
-        d.detector_type = 'Eiger'
-
-def test_det_type(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.getDetectorType')
-    m.return_value = 'Eiger'
-    assert d.detector_type == 'Eiger'
-
-def test_set_dynamic_range_4(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.setDynamicRange')
-    d.dynamic_range = 4
-    m.assert_called_with(4)
-
-def test_set_dynamic_range_8(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.setDynamicRange')
-    d.dynamic_range = 8
-    m.assert_called_with(8)
-
-
-def test_set_dynamic_range_16(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.setDynamicRange')
-    d.dynamic_range = 16
-    m.assert_called_with(16)
-
-def test_set_dynamic_range_32(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.setDynamicRange')
-    d.dynamic_range = 32
-    m.assert_called_with(32)
-
-def test_set_dynamic_range_raises_exception(d, mocker):
-    mocker.patch('_slsdet.DetectorApi.setDynamicRange')
-    with pytest.raises(ValueError):
-        d.dynamic_range = 17
-
-def test_get_dynamic_range_32(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.getDynamicRange')
-    m.return_value = 32
-    dr = d.dynamic_range
-    assert dr == 32
-
-def test_eiger_matrix_reset(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.getCounterBit')
-    m.return_value = True
-    assert d.eiger_matrix_reset == True
-
-def test_set_eiger_matrix_reset(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.setCounterBit')
-    d.eiger_matrix_reset = True
-    m.assert_called_once_with(True)
-
-
-def test_get_exposure_time(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.getExposureTime')
-    m.return_value = 100000000
-    assert d.exposure_time == 0.1
-
-def test_set_exposure_time(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.setExposureTime')
-    d.exposure_time = 1.5
-    m.assert_called_once_with(1500000000)
-
-def test_set_exposure_time_less_than_zero(d, mocker):
-    mocker.patch('_slsdet.DetectorApi.setExposureTime')
-    with pytest.raises(ValueError):
-        d.exposure_time = -7
-
-
-def test_get_file_index(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.getFileIndex')
-    m.return_value = 8
-    assert d.file_index == 8
-
-def test_set_file_index(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.setFileIndex')
-    d.file_index = 9
-    m.assert_called_with(9)
-
-
-def test_set_file_index_raises_on_neg(d, mocker):
-    mocker.patch('_slsdet.DetectorApi.setFileIndex')
-    with pytest.raises(ValueError):
-        d.file_index = -9
-
-
-def test_get_file_name(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.getFileName')
-    d.file_name
-    m.assert_called_once_with()
-
-def test_set_file_name(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.setFileName')
-    d.file_name = 'hej'
-    m.assert_called_once_with('hej')
-
-def test_get_file_path(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.getFilePath')
-    d.file_path
-    m.assert_called_once_with()
-
-def test_set_file_path_when_path_exists(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.setFilePath')
-    #To avoid raising an exception because path is not there
-    mock_os = mocker.patch('os.path.exists')
-    mock_os.return_value = True
-    d.file_path = '/path/to/something/'
-    m.assert_called_once_with('/path/to/something/')
-
-def test_set_file_path_raises_when_not_exists(d, mocker):
-    mocker.patch('_slsdet.DetectorApi.setFilePath')
-    mock_os = mocker.patch('os.path.exists')
-    mock_os.return_value = False
-    with pytest.raises(FileNotFoundError):
-        d.file_path = '/path/to/something/'
-
-def test_get_file_write(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.getFileWrite')
-    m.return_value = False
-    assert d.file_write == False
-
-def test_set_file_write(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.setFileWrite')
-    d.file_write = True
-    m.assert_called_once_with(True)
-
-
-def test_get_firmware_version(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.getFirmwareVersion')
-    m.return_value = 20
-    assert d.firmware_version == 20
-
-def test_cannot_set_fw_version(d):
-    with pytest.raises(AttributeError):
-        d.firmware_version = 20
-
-def test_get_high_voltage_call_signature(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.getDac')
-    d.high_voltage
-    m.assert_called_once_with('highvoltage', -1)
-
-def test_get_high_voltage(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.getDac')
-    m.return_value = 80
-    assert d.high_voltage == 80
-
-#self._api.setDac('highvoltage', -1, voltage)
-def test_set_high_voltage(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.setDac')
-    d.high_voltage = 80
-    m.assert_called_once_with('highvoltage', -1, 80)
-
-def test_decode_hostname_two_names(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.getHostname')
-    m.return_value = 'beb059+beb048+'
-    assert d.hostname == ['beb059', 'beb048']
-
-def test_decode_hostname_four_names(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.getHostname')
-    m.return_value = 'beb059+beb048+beb120+beb153+'
-    assert d.hostname == ['beb059', 'beb048', 'beb120', 'beb153']
-
-def test_decode_hostname_blank(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.getHostname')
-    m.return_value = ''
-    assert d.hostname == []
-
-def test_get_image_size_gives_correct_size(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.getImageSize')
-    m.return_value = (512,1024)
-    im_size = d.image_size
-    assert im_size.rows == 512
-    assert im_size.cols == 1024
-
-
-
-def test_load_config(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.readConfigurationFile')
-    #To avoid raising an exception because path is not there
-    mock_os = mocker.patch('os.path.isfile')
-    mock_os.return_value = True
-    d.load_config('/path/to/my/file.config')
-    m.assert_called_once_with('/path/to/my/file.config')
-
-def test_load_config_raises_when_file_is_not_found(d, mocker):
-    mocker.patch('_slsdet.DetectorApi.readConfigurationFile')
-    mock_os = mocker.patch('os.path.isfile')
-    mock_os.return_value = False
-    with pytest.raises(FileNotFoundError):
-        d.load_config('/path/to/my/file.config')
-
-def test_load_parameters(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.readParametersFile')
-    #To avoid raising an exception because path is not there
-    mock_os = mocker.patch('os.path.isfile')
-    mock_os.return_value = True
-    d.load_parameters('/path/to/my/file.par')
-    m.assert_called_once_with('/path/to/my/file.par')
-
-def test_load_parameters_raises_when_file_is_not_found(d, mocker):
-    mocker.patch('_slsdet.DetectorApi.readParametersFile')
-    mock_os = mocker.patch('os.path.isfile')
-    mock_os.return_value = False
-    with pytest.raises(FileNotFoundError):
-        d.load_parameters('/path/to/my/file.par')
-
-#getDetectorGeometry
-def test_get_module_geometry_gives_correct_size(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.getDetectorGeometry')
-    m.return_value = (13,7)
-    g = d.module_geometry
-    assert g.vertical == 7
-    assert g.horizontal == 13
-
-def test_get_module_geometry_access(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.getDetectorGeometry')
-    m.return_value = (12,3)
-    assert d.module_geometry[0] == 12
-    assert d.module_geometry[1] == 3
-    assert d.module_geometry.vertical == 3
-    assert d.module_geometry.horizontal == 12
-
-def test_get_n_frames(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.getNumberOfFrames')
-    m.return_value = 3
-    assert d.n_frames == 3
-
-def test_set_n_frames(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.setNumberOfFrames')
-    d.n_frames = 9
-    m.assert_called_once_with(9)
-
-def test_set_n_frames_raises_on_neg(d, mocker):
-    mocker.patch('_slsdet.DetectorApi.setNumberOfFrames')
-    with pytest.raises(ValueError):
-        d.n_frames = -1
-
-def test_set_n_frames_raises_on_zero(d, mocker):
-    mocker.patch('_slsdet.DetectorApi.setNumberOfFrames')
-    with pytest.raises(ValueError):
-        d.n_frames = 0
-
-def test_get_n_modules(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.getNumberOfDetectors')
-    m.return_value = 12
-    assert d.n_modules == 12
-
-def test_get_period_time(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.getPeriod')
-    m.return_value = 130000000
-    assert d.period == 0.13
-
-def test_set_period_time(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.setPeriod')
-    d.period = 1.953
-    m.assert_called_once_with(1953000000)
-
-def test_set_period_time_less_than_zero(d, mocker):
-    mocker.patch('_slsdet.DetectorApi.setPeriod')
-    with pytest.raises(ValueError):
-        d.period = -7
-
-def test_pulse_chip_call(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.pulseChip')
-    d.pulse_chip(15)
-    m.assert_called_once_with(15)
-
-def test_pulse_chip_call_minus_one(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.pulseChip')
-    d.pulse_chip(-1)
-    m.assert_called_once_with(-1)
-
-def test_pulse_chip_asserts_on_smaller_than_minus_one(d, mocker):
-    mocker.patch('_slsdet.DetectorApi.pulseChip')
-    with pytest.raises(ValueError):
-        d.pulse_chip(-3)
-#--------------------------------------------------------------------subexptime
-def test_get_sub_exposure_time(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.getSubExposureTime')
-    m.return_value = 2370000
-    assert d.sub_exposure_time == 0.00237
-
-
-def test_set_sub_exposure_time(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.setSubExposureTime')
-    d.sub_exposure_time = 0.002
-    m.assert_called_once_with(2000000)
-
-def test_set_sub_exposure_time_raises_on_zero(d, mocker):
-    mocker.patch('_slsdet.DetectorApi.setSubExposureTime')
-    with pytest.raises(ValueError):
-        d.sub_exposure_time = 0
-
-#-------------------------------------------------------------Rate correction
-def test_get_rate_correction(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.getRateCorrection')
-    m.return_value = [132,129]
-    assert d.rate_correction == [132,129]
-
-def test_set_rate_correction(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.setRateCorrection')
-    mock_n = mocker.patch('_slsdet.DetectorApi.getNumberOfDetectors')
-    mock_n.return_value = 3
-    d.rate_correction = [123,90,50]
-    m.assert_called_once_with([123,90,50])
-
-def test_set_rate_correction_raises_on_wrong_number_of_values(d, mocker):
-    mocker.patch('_slsdet.DetectorApi.setRateCorrection')
-    mock_n = mocker.patch('_slsdet.DetectorApi.getNumberOfDetectors')
-    mock_n.return_value = 4
-    with pytest.raises(ValueError):
-        d.rate_correction = [123,90,50]
-
-#----------------------------------------------------------------Readout clock
-def test_get_readout_clock_0(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.getReadoutClockSpeed')
-    m.return_value = 0
-    assert d.readout_clock == 'Full Speed'
-
-def test_get_readout_clock_1(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.getReadoutClockSpeed')
-    m.return_value = 1
-    assert d.readout_clock == 'Half Speed'
-
-def test_get_readout_clock_2(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.getReadoutClockSpeed')
-    m.return_value = 2
-    assert d.readout_clock == 'Quarter Speed'
-
-def test_get_readout_clock_3(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.getReadoutClockSpeed')
-    m.return_value = 3
-    assert d.readout_clock == 'Super Slow Speed'
-
-def test_set_readout_clock_0(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.setReadoutClockSpeed')
-    d.readout_clock = 'Full Speed'
-    m.assert_called_once_with(0)
-
-def test_set_readout_clock_1(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.setReadoutClockSpeed')
-    d.readout_clock = 'Half Speed'
-    m.assert_called_once_with(1)
-
-def test_set_readout_clock_2(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.setReadoutClockSpeed')
-    d.readout_clock = 'Quarter Speed'
-    m.assert_called_once_with(2)
-
-def test_set_readout_clock_3(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.setReadoutClockSpeed')
-    d.readout_clock = 'Super Slow Speed'
-    m.assert_called_once_with(3)
-
-#----------------------------------------------------------------rx_datastream
-def test_get_rx_datastream(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.getRxDataStreamStatus')
-    m.return_value = False
-    assert d.rx_datastream == False
-
-def test_set_rx_datastream(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.setRxDataStreamStatus')
-    d.rx_datastream = True
-    m.assert_called_once_with(True)
-
-def test_get_rx_zmqip(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.getNetworkParameter')
-    d.rx_zmqip
-    m.assert_called_once_with('rx_zmqip')
-
-def test_get_rx_zmqport_call(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.getNetworkParameter')
-    d.rx_zmqport
-    m.assert_called_once_with('rx_zmqport')
-
-def test_get_rx_zmqport_decode(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.getNetworkParameter')
-    m.return_value = '30001+30003+'
-    assert d.rx_zmqport == [30001, 30002, 30003, 30004]
-
-def test_get_rx_zmqport_empty(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.getNetworkParameter')
-    m.return_value = ''
-    assert d.rx_zmqport == []
-
-
-#--------------------------------------------------------------------status
-def test_status_call(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.getRunStatus')
-    d.status
-    m.assert_called_once_with()
-
-def test_start_acq_call(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.startAcquisition')
-    d.start_acq()
-    m.assert_called_once_with()
-
-def test_stop_acq_call(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.stopAcquisition')
-    d.stop_acq()
-    m.assert_called_once_with()
-
-#--------------------------------------------------------------------subexptime
-def test_get_sub_exposure_time(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.getSubExposureTime')
-    m.return_value = 2370000
-    assert d.sub_exposure_time == 0.00237
-
-
-def test_set_sub_exposure_time(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.setSubExposureTime')
-    d.sub_exposure_time = 0.002
-    m.assert_called_once_with(2000000)
-
-def test_set_sub_exposure_time_raises_on_zero(d, mocker):
-    mocker.patch('_slsdet.DetectorApi.setSubExposureTime')
-    with pytest.raises(ValueError):
-        d.sub_exposure_time = 0
-
-#------------------------------------------------------------------timing mode
-def test_get_timing_mode(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.getTimingMode')
-    d.timing_mode
-    m.assert_called_once_with()
-
-def test_set_timing_mode(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.setTimingMode')
-    d.timing_mode = 'auto'
-    m.assert_called_once_with('auto')
-
-#----------------------------------------------------------------vthreshold
-def test_get_vthreshold(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.getDac')
-    d.vthreshold
-    m.assert_called_once_with('vthreshold', -1)
-
-def test_set_vthreshold(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.setDac')
-    d.vthreshold = 1675
-    m.assert_called_once_with('vthreshold', -1, 1675)
-
-#----------------------------------------------------------------trimbits
-def test_get_trimbits(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.getAllTrimbits')
-    d.trimbits
-    m.assert_called_once_with()
-
-def test_set_trimbits(d, mocker):
-    m = mocker.patch('_slsdet.DetectorApi.setAllTrimbits')
-    d.trimbits = 15
-    m.assert_called_once_with(15)
-
-def test_set_trimbits_raises_outside_range(d, mocker):
-    mocker.patch('_slsdet.DetectorApi.setAllTrimbits')
-
-    with pytest.raises(ValueError):
-        d.trimbits = 69
-
-    with pytest.raises(ValueError):
-        d.trimbits = -5
-
-

python/unit-tests/detector_test.py

@@ -1,489 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-"""
-Testing the Detector python class by mocking calls. 
-Should only be used when there is functionality in 
-the detector.py file. 
-
-An example is converting a mask to a list of set bits.
-"""
-
-from unittest.mock import Mock
-import pytest
-from pytest_mock import mocker
-
-import sys
-sys.path.append('/home/l_frojdh/slsdetectorgrup/sls_detector')
-
-import _slsdet
-from sls_detector.errors import DetectorValueError, DetectorError
-from sls_detector.utils import all_equal, element_if_equal
-
-@pytest.fixture
-def d():
-    from sls_detector import Detector
-    return Detector()
-
-def test_length(d, mocker):
-    m = mocker.patch('sls_detector.Detector.size')
-    m.return_value = 5
-    assert(len(d) == 5)
-
-def test_counters_single(d, mocker):
-    m = mocker.patch('sls_detector.Detector.getCounterMask')
-    m.return_value = [7]
-    assert(d.counters == [0,1,2])
-
-def test_counters_multi(d, mocker):
-    m = mocker.patch('sls_detector.Detector.getCounterMask')
-    m.return_value = [7, 9]
-    assert(d.counters == [[0,1,2],[0,3]])
-
-def test_set_counters_single(d, mocker):
-    m = mocker.patch('sls_detector.Detector.setCounterMask')
-    d.counters = [0,2]
-    m.assert_called_once_with(5)
-
-
-
-# def test_busy_call(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.getAcquiringFlag')
-#     m.return_value = False
-#     assert d.busy == False
-
-# def test_set_busy(d):
-#     d.busy = True
-#     assert d.busy == True
-#     assert d._api.getAcquiringFlag() == True
-#     d.busy = False
-#     assert d.busy == False
-#     assert d._api.getAcquiringFlag() == False
-
-# def test_error_mask(d):
-#     d._api.setErrorMask(1)
-#     assert d.error_mask == 1
-#     d.clear_errors()
-
-# def test_error_handling(d):
-#     with pytest.raises(DetectorError):
-#         d._provoke_error()
-
-# def test_assign_to_detector_type(d):
-#     with pytest.raises(AttributeError):
-#         d.detector_type = 'Eiger'
-
-# def test_det_type(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.getDetectorType')
-#     m.return_value = 'Eiger'
-#     assert d.detector_type == 'Eiger'
-
-
-# def test_get_exposure_time(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.getExposureTime')
-#     m.return_value = 100000000
-#     assert d.exposure_time == 0.1
-
-# def test_set_exposure_time(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.setExposureTime')
-#     d.exposure_time = 1.5
-#     m.assert_called_once_with(1500000000)
-
-# def test_set_exposure_time_less_than_zero(d, mocker):
-#     mocker.patch('_slsdet.DetectorApi.setExposureTime')
-#     with pytest.raises(DetectorValueError):
-#         d.exposure_time = -7
-
-
-# def test_get_file_index(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.getFileIndex')
-#     m.return_value = 8
-#     assert d.file_index == 8
-
-# def test_set_file_index(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.setFileIndex')
-#     d.file_index = 9
-#     m.assert_called_with(9)
-
-
-# def file_index_with_no_detector(d):
-#     assert d.file_index == -100
-
-# def dr_with_no_detector(d):
-#     assert d.dynamic_range == -100
-
-# def test_set_file_index_raises_on_neg(d, mocker):
-#     mocker.patch('_slsdet.DetectorApi.setFileIndex')
-#     with pytest.raises(ValueError):
-#         d.file_index = -9
-
-
-# def test_get_file_name(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.getFileName')
-#     d.file_name
-#     m.assert_called_once_with()
-
-# def test_set_file_name(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.setFileName')
-#     d.file_name = 'hej'
-#     m.assert_called_once_with('hej')
-
-# def test_get_file_path(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.getFilePath')
-#     d.file_path
-#     m.assert_called_once_with()
-
-# def test_set_file_path_when_path_exists(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.setFilePath')
-#     #To avoid raising an exception because path is not there
-#     mock_os = mocker.patch('os.path.exists')
-#     mock_os.return_value = True
-#     d.file_path = '/path/to/something/'
-#     m.assert_called_once_with('/path/to/something/')
-
-# def test_set_file_path_raises_when_not_exists(d, mocker):
-#     mocker.patch('_slsdet.DetectorApi.setFilePath')
-#     mock_os = mocker.patch('os.path.exists')
-#     mock_os.return_value = False
-#     with pytest.raises(FileNotFoundError):
-#         d.file_path = '/path/to/something/'
-
-# def test_get_file_write(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.getFileWrite')
-#     m.return_value = False
-#     assert d.file_write == False
-
-# def test_set_file_write(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.setFileWrite')
-#     d.file_write = True
-#     m.assert_called_once_with(True)
-
-
-# def test_get_firmware_version(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.getFirmwareVersion')
-#     m.return_value = 20
-#     assert d.firmware_version == 20
-
-# def test_cannot_set_fw_version(d):
-#     with pytest.raises(AttributeError):
-#         d.firmware_version = 20
-
-# def test_get_high_voltage_call_signature(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.getDac')
-#     d.high_voltage
-#     m.assert_called_once_with('highvoltage', -1)
-
-# def test_get_high_voltage(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.getDac')
-#     m.return_value = 80
-#     assert d.high_voltage == 80
-
-# #self._api.setDac('highvoltage', -1, voltage)
-# def test_set_high_voltage(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.setDac')
-#     d.high_voltage = 80
-#     m.assert_called_once_with('highvoltage', -1, 80)
-
-# def test_decode_hostname_two_names(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.getHostname')
-#     m.return_value = 'beb059+beb048+'
-#     assert d.hostname == ['beb059', 'beb048']
-
-# def test_decode_hostname_four_names(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.getHostname')
-#     m.return_value = 'beb059+beb048+beb120+beb153+'
-#     assert d.hostname == ['beb059', 'beb048', 'beb120', 'beb153']
-
-# def test_decode_hostname_blank(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.getHostname')
-#     m.return_value = ''
-#     assert d.hostname == []
-
-# def test_get_image_size_gives_correct_size(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.getImageSize')
-#     m.return_value = (512,1024)
-#     im_size = d.image_size
-#     assert im_size.rows == 512
-#     assert im_size.cols == 1024
-
-
-
-# def test_load_config(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.readConfigurationFile')
-#     #To avoid raising an exception because path is not there
-#     mock_os = mocker.patch('os.path.isfile')
-#     mock_os.return_value = True
-#     d.load_config('/path/to/my/file.config')
-#     m.assert_called_once_with('/path/to/my/file.config')
-
-# def test_load_config_raises_when_file_is_not_found(d, mocker):
-#     mocker.patch('_slsdet.DetectorApi.readConfigurationFile')
-#     mock_os = mocker.patch('os.path.isfile')
-#     mock_os.return_value = False
-#     with pytest.raises(FileNotFoundError):
-#         d.load_config('/path/to/my/file.config')
-
-# def test_load_parameters(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.readParametersFile')
-#     #To avoid raising an exception because path is not there
-#     mock_os = mocker.patch('os.path.isfile')
-#     mock_os.return_value = True
-#     d.load_parameters('/path/to/my/file.par')
-#     m.assert_called_once_with('/path/to/my/file.par')
-
-# def test_load_parameters_raises_when_file_is_not_found(d, mocker):
-#     mocker.patch('_slsdet.DetectorApi.readParametersFile')
-#     mock_os = mocker.patch('os.path.isfile')
-#     mock_os.return_value = False
-#     with pytest.raises(FileNotFoundError):
-#         d.load_parameters('/path/to/my/file.par')
-
-# #getDetectorGeometry
-# def test_get_module_geometry_gives_correct_size(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.getDetectorGeometry')
-#     m.return_value = (13,7)
-#     g = d.module_geometry
-#     assert g.vertical == 7
-#     assert g.horizontal == 13
-
-# def test_get_module_geometry_access(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.getDetectorGeometry')
-#     m.return_value = (12,3)
-#     assert d.module_geometry[0] == 12
-#     assert d.module_geometry[1] == 3
-#     assert d.module_geometry.vertical == 3
-#     assert d.module_geometry.horizontal == 12
-
-# def test_module_geometry_without_detectors(d):
-#     t = d.module_geometry
-#     assert t.horizontal == 0
-#     assert t.vertical == 0
-
-# def test_get_n_frames(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.getNumberOfFrames')
-#     m.return_value = 3
-#     assert d.n_frames == 3
-
-# def test_set_n_frames(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.setNumberOfFrames')
-#     d.n_frames = 9
-#     m.assert_called_once_with(9)
-
-# def test_nframes_without_detector(d):
-#     assert d.n_frames == -100
-
-# def test_set_n_frames_raises_on_neg(d, mocker):
-#     mocker.patch('_slsdet.DetectorApi.setNumberOfFrames')
-#     with pytest.raises(DetectorValueError):
-#         d.n_frames = -1
-
-# def test_set_n_frames_raises_on_zero(d, mocker):
-#     mocker.patch('_slsdet.DetectorApi.setNumberOfFrames')
-#     with pytest.raises(DetectorValueError):
-#         d.n_frames = 0
-
-# def test_n_cycles_without_detector(d):
-#     assert d.n_cycles == -100
-
-# def test_set_n_cycles_raises_on_zero(d, mocker):
-#     mocker.patch('_slsdet.DetectorApi.setCycles')
-#     with pytest.raises(DetectorValueError):
-#         d.n_cycles = 0
-
-# def test_set_n_cycles(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.setCycles')
-#     d.n_cycles = 56
-#     m.assert_called_once_with(56)
-
-
-
-# def test_n_measurements_without_detector(d):
-#     assert d.n_measurements == -100
-
-# def test_set_n_measurements_raises_on_zero(d, mocker):
-#     mocker.patch('_slsdet.DetectorApi.setNumberOfMeasurements')
-#     with pytest.raises(DetectorValueError):
-#         d.n_measurements = 0
-
-# def test_set_n_measurements(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.setNumberOfMeasurements')
-#     d.n_measurements = 560
-#     m.assert_called_once_with(560)
-
-# def test_get_n_modules_no_detector(d):
-#     assert d.n_modules == 0
-
-# def test_get_n_modules(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.getNumberOfDetectors')
-#     m.return_value = 12
-#     assert d.n_modules == 12
-
-# def test_get_period_time(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.getPeriod')
-#     m.return_value = 130000000
-#     assert d.period == 0.13
-
-# def test_set_period_time(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.setPeriod')
-#     d.period = 1.953
-#     m.assert_called_once_with(1953000000)
-
-# def test_set_period_time_less_than_zero(d, mocker):
-#     mocker.patch('_slsdet.DetectorApi.setPeriod')
-#     with pytest.raises(ValueError):
-#         d.period = -7
-
-
-# def test_get_online(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.getOnline')
-#     d.online
-#     m.assert_called_once_with()
-
-# def test_set_online(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.setOnline')
-#     d.online = True
-#     m.assert_called_once_with(True)
-
-# def test_last_client_ip_no_detector(d):
-#     assert d.last_client_ip == ''
-
-# def test_last_cliten_ip_call(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.getLastClientIP')
-#     d.last_client_ip
-#     m.assert_called_once_with()
-
-# #-------------------------------------------------------------Rate correction
-# def test_get_rate_correction(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.getRateCorrection')
-#     m.return_value = [132,129]
-#     assert d.rate_correction == [132,129]
-
-# def test_set_rate_correction(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.setRateCorrection')
-#     mock_n = mocker.patch('_slsdet.DetectorApi.getNumberOfDetectors')
-#     mock_n.return_value = 3
-#     d.rate_correction = [123,90,50]
-#     m.assert_called_once_with([123,90,50])
-
-# def test_set_rate_correction_raises_on_wrong_number_of_values(d, mocker):
-#     mocker.patch('_slsdet.DetectorApi.setRateCorrection')
-#     mock_n = mocker.patch('_slsdet.DetectorApi.getNumberOfDetectors')
-#     mock_n.return_value = 4
-#     with pytest.raises(ValueError):
-#         d.rate_correction = [123,90,50]
-
-# #----------------------------------------------------------------Readout clock
-# def test_get_readout_clock_0(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.getReadoutClockSpeed')
-#     m.return_value = 0
-#     assert d.readout_clock == 'Full Speed'
-
-# def test_get_readout_clock_1(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.getReadoutClockSpeed')
-#     m.return_value = 1
-#     assert d.readout_clock == 'Half Speed'
-
-# def test_get_readout_clock_2(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.getReadoutClockSpeed')
-#     m.return_value = 2
-#     assert d.readout_clock == 'Quarter Speed'
-
-# def test_get_readout_clock_3(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.getReadoutClockSpeed')
-#     m.return_value = 3
-#     assert d.readout_clock == 'Super Slow Speed'
-
-# def test_set_readout_clock_0(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.setReadoutClockSpeed')
-#     d.readout_clock = 'Full Speed'
-#     m.assert_called_once_with(0)
-
-# def test_set_readout_clock_1(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.setReadoutClockSpeed')
-#     d.readout_clock = 'Half Speed'
-#     m.assert_called_once_with(1)
-
-# def test_set_readout_clock_2(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.setReadoutClockSpeed')
-#     d.readout_clock = 'Quarter Speed'
-#     m.assert_called_once_with(2)
-
-# def test_set_readout_clock_3(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.setReadoutClockSpeed')
-#     d.readout_clock = 'Super Slow Speed'
-#     m.assert_called_once_with(3)
-
-# #----------------------------------------------------------------rx_datastream
-# def test_get_rx_datastream(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.getRxDataStreamStatus')
-#     m.return_value = False
-#     assert d.rx_datastream == False
-
-# def test_set_rx_datastream(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.setRxDataStreamStatus')
-#     d.rx_datastream = True
-#     m.assert_called_once_with(True)
-
-# def test_get_rx_zmqip(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.getNetworkParameter')
-#     d.rx_zmqip
-#     m.assert_called_once_with('rx_zmqip')
-
-# def test_get_rx_zmqport_call(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.getNetworkParameter')
-#     d.rx_zmqport
-#     m.assert_called_once_with('rx_zmqport')
-
-# def test_get_rx_zmqport_decode(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.getNetworkParameter')
-#     m.return_value = ['30001', '30003']
-#     assert d.rx_zmqport == [30001, 30003]
-
-# def test_get_rx_zmqport_empty(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.getNetworkParameter')
-#     m.return_value = ''
-#     assert d.rx_zmqport == []
-
-
-# #--------------------------------------------------------------------status
-# def test_status_call(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.getRunStatus')
-#     d.status
-#     m.assert_called_once_with()
-
-# def test_start_detecor(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.startAcquisition')
-#     d.start_detector()
-#     m.assert_called_once_with()
-
-# def test_stop_acq_call(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.stopAcquisition')
-#     d.stop_detector()
-#     m.assert_called_once_with()
-
-
-
-# #------------------------------------------------------------------timing mode
-# def test_get_timing_mode(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.getTimingMode')
-#     d.timing_mode
-#     m.assert_called_once_with()
-
-# def test_set_timing_mode(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.setTimingMode')
-#     d.timing_mode = 'auto'
-#     m.assert_called_once_with('auto')
-
-# #----------------------------------------------------------------vthreshold
-# def test_get_vthreshold(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.getDac')
-#     d.vthreshold
-#     m.assert_called_once_with('vthreshold', -1)
-
-# def test_set_vthreshold(d, mocker):
-#     m = mocker.patch('_slsdet.DetectorApi.setDac')
-#     d.vthreshold = 1675
-#     m.assert_called_once_with('vthreshold', -1, 1675)
-
-
-
-

python/unit-tests/test_detector_property.py

@@ -1,76 +0,0 @@
-import pytest
-from sls_detector.detector_property import DetectorProperty
-
-class Holder:
-    """
-    This class does nothing except hold values
-    for testing of the DetectorProperty class
-    """
-    def __init__(self, N):
-        self.values = [i for i in range(N)]
-    def get(self, i):
-        return self.values[i]
-    def set(self, i,v):
-        self.values[i] = v
-    def nmod(self):
-        return len(self.values)
-
-@pytest.fixture
-def p():
-    h = Holder(5)
-    return DetectorProperty(h.get, h.set, h.nmod, 'prop')
-
-def test_initialization():
-    def getf(i):
-        return 5
-    def setf():
-        return
-    def nmod():
-        return 3
-    name = 'a property'
-    p = DetectorProperty(getf, setf, nmod, name)
-    assert p.get == getf
-    assert p.set == setf
-    assert p.get_nmod == nmod
-    assert p.__name__ == name
-
-def test_get_single_value(p):
-    assert p[2] == 2
-
-def test_get_all_values(p):
-    assert p[:] == [0, 1, 2, 3, 4]
-
-def test_get_values_by_iterable(p):
-    vals = p[1,3]
-    assert vals == [1,3]
-
-def test_set_single_value(p):
-    p[2] = 7
-    assert p[:] == [0,1,7,3,4]
- 
-def test_set_all(p):
-     p[:] = 10
-     assert p[:] == [10,10,10,10,10]
-
-def test_set_all_by_list(p):
-    p[:] = [7,8,9,10,11]
-    assert p[:] == [7,8,9,10,11]
-
-def test_set_all_bool(p):
-    p[:] = True
-    assert p[:] == [True]*5
-
-def test_set_by_iter(p):
-    keys = [2,4]
-    vals = [18,23]
-    p[keys] = vals
-    assert p[:] == [0,1,18,3,23]
-
-def test_set_by_iter_single_val(p):
-    keys = [2,4]
-    val = 9
-    p[keys] = val
-    assert p[:] == [0,1,9,3,9]
-
-def test_print_values(p):
-    assert repr(p) == 'prop: [0, 1, 2, 3, 4]'

python/unit-tests/test_utils.py

@@ -1,96 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-"""
-Testing functions from utils.py
-"""
-
-import pytest
-from slsdet.utils import *
-import datetime as dt
-
-def test_iterable():
-    assert is_iterable(5) == False
-    assert is_iterable('abc') == True
-    assert is_iterable([]) == True
-    assert is_iterable(5.9) == False
-
-def test_reduce_time_to_single_value_from_list():
-    t = 3*[dt.timedelta(seconds = 1)]
-    assert reduce_time(t) == 1
-
-def test_reduce_time_to_single_value_from_list_of_lists():
-    t = 3*[dt.timedelta(seconds = 3.3)]
-    tt = 5*t
-    assert reduce_time(tt) == 3.3
-
-def test_reduce_time_when_sublist_is_different():
-    t = [dt.timedelta(seconds = 1), dt.timedelta(seconds = 2), dt.timedelta(seconds = 1)]
-    tt = [t for i in range(4)]
-    assert reduce_time(tt) == [1,2,1]
-
-
-def test_convert_zero():
-    assert eiger_register_to_time(0) == 0
-
-def test_convert_smallest_unit():
-    assert pytest.approx(eiger_register_to_time(0b1000), 1e-9) == 1e-8
-
-def test_convert_second_smallest_unit():
-    assert pytest.approx(eiger_register_to_time(0b10000), 1e-9) == 2e-8
-
-def test_convert_one_ms_using_exponent():
-    assert pytest.approx(eiger_register_to_time(0b1101), 1e-9) == 1e-3
-
-def test_convert_five_seconds():
-    assert pytest.approx(eiger_register_to_time(0b1001110001000101), 1e-9) == 5.0
-
-def test_all_equal_int():
-    assert all_equal([5,5]) == True
-
-def test_all_equal_fails():
-    assert all_equal([5,6])  == False
-
-def test_all_equal_tuple():
-    assert all_equal(('a', 'a', 'a')) == True
-
-def test_all_equal_str():
-    assert all_equal('aaa') == True
-
-def test_all_equal_str_fails():
-    assert all_equal('aaab') == False
-
-
-
-def test_element_if_equal_int():
-    assert element_if_equal([5,5]) == 5
-
-def test_element_if_equal_str():
-    assert element_if_equal('hhh') == 'h'
-
-def test_element_if_equal_int_fails():
-    assert element_if_equal([5, 6, 7]) == [5, 6, 7]
-
-def test_get_set_bits():
-    assert(get_set_bits(0) == [])
-    assert get_set_bits(7) == [0, 1, 2]
-    
-def test_list_to_mask():
-    assert(list_to_bitmask([0,1,2]) == 7)
-    assert(list_to_bitmask([]) == 0)
-    assert(list_to_bitmask([0]) == 1)
-    assert(list_to_bitmask([1]) == 2)
-    assert(list_to_bitmask([3]) == 8)
-    assert(list_to_bitmask([1,1,1]) == 2)
-
-
-def test_make_timedelta_from_double():
-    t = 1.7
-    r = make_timedelta(t)
-    assert t == r.total_seconds()
-    assert r == dt.timedelta(seconds=t)
-
-def test_make_timedelta_from_timedelta():
-    t = dt.timedelta(minutes=1)
-    r = make_timedelta(t)
-    assert 60 == r.total_seconds()
-    assert r == dt.timedelta(minutes=1)

sample/CMakeLists.txt

@@ -1,6 +1,6 @@
 add_executable(using_logger using_logger.cpp)
 target_link_libraries(using_logger 
-    slsSupportLib
+    slsSupportShared
     pthread
     rt
 )  
@@ -22,7 +22,7 @@ set_target_properties(using_logger PROPERTIES
 # add_executable(udp udp.cpp)
 # target_link_libraries(udp 
 #     slsDetectorShared
-#     slsSupportLib
+#     slsSupportShared
 #     pthread
 #     rt
 #     fmt