update tag version in client version

Zmqhwm

.clang-format

@@ -3,4 +3,5 @@ IndentWidth: 4
 
 UseTab: Never
 ColumnLimit: 80
-AlignConsecutiveAssignments: false 
+AlignConsecutiveAssignments: false 
+AlignConsecutiveMacros: true

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,42 @@
+---
+name: Bug Report
+about: Create a report to help us improve 
+title: New Bug Report
+labels: action - Bug, priority - Unclassified, status - Pending
+template: bug_report.md
+---
+<!-- 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: 
+<!-- RHEL7, RHEL6, Fedora, etc -->
+
+
+##### *Detector type: 
+<!-- If applicable, Eiger, Jungfrau, Mythen3, Gotthard2, Gotthard, Moench, ChipTestBoard -->
+
+##### *Software Package Version: 
+<!-- developer, 4.2.0, 4.1.1, etc -->
+
+##### Priority:
+<!-- Super Low, Low, Medium, High, Super High -->
+
+##### *Describe the bug
+<!--  A clear and concise description of what the bug is -->
+
+##### Expected behavior
+<!--  A clear and concise description of what you expected to happen. -->
+
+##### To Reproduce
+<!--  Steps to reproduce the behavior: -->
+<!--  1. Go to '...' -->
+<!--  2. Click on '....' -->
+<!--  3. Scroll down to '....' -->
+<!--  4. See error -->
+
+##### Screenshots
+<!--  If applicable, add screenshots to help explain your problem. -->
+
+##### Additional context
+<!--  Add any other context about the problem here. -->

.github/ISSUE_TEMPLATE/change_request.md

@@ -0,0 +1,28 @@
+---
+name: Change Request
+about: Suggest a change to an existing feature
+title: New Change Request
+labels: action - Change, priority - Unclassified, status - Pending
+template: change_request.md
+---
+<!-- 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: 
+<!-- If applicable, Eiger, Jungfrau, Mythen3, Gotthard2, Gotthard, Moench, ChipTestBoard -->
+
+##### *Software Package Version: 
+<!-- developer, 4.2.0, 4.1.1, etc -->
+
+##### Priority:
+<!-- 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 -->
+
+##### Is your change request related to a problem. Please describe:
+<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
+
+##### Additional context:
+<!--  Add any other context about the feature here -->

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,34 @@
+---
+name: Feature Request
+about: Suggest a feature, documentation or submit a question
+title: New Feature Request
+labels: action - Enhancement, priority - Unclassified, status - Pending
+template: feature_request.md
+---
+<!-- 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: 
+<!-- If applicable, Eiger, Jungfrau, Mythen3, Gotthard2, Gotthard, Moench, ChipTestBoard -->
+
+##### *Software Package Version: 
+<!-- developer, 4.2.0, 4.1.1, etc -->
+
+##### Priority:
+<!-- Super Low, Low, Medium, High, Super High -->
+
+##### *State the feature:
+<!--  A clear and concise description of what the feature is -->
+
+##### Is your feature request related to a problem. Please describe:
+<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
+
+##### Describe the solution you'd like:
+<!-- A clear and concise description of what you want to happen -->
+
+##### Describe alternatives you've considered:
+<!-- A clear and concise description of any alternative solutions or features you've considered -->
+
+##### Additional context:
+<!--  Add any other context about the feature here -->

CMakeLists.txt

@@ -45,18 +45,36 @@ option(SLS_USE_CTBGUI "ctb GUI" OFF)
 option(SLS_BUILD_DOCS "docs" OFF)
 option(SLS_BUILD_EXAMPLES "examples" OFF)
 option(SLS_TUNE_LOCAL "tune to local machine" OFF)
+option(SLS_DEVEL_HEADERS "install headers for devel" OFF)
+option(SLS_USE_MOENCH "compile zmq and post processing for Moench" OFF)
 
-# 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 ()
+# set(ClangFormat_BIN_NAME clang-format)
+set(ClangFormat_EXCLUDE_PATTERNS  "build/" 
+                                    "libs/" 
+                                    "slsDetectorCalibration/" 
+                                    "ctbGui/" 
+                                    "manual/"
+                                    "python/"
+                                    "sample/"
+                                    ${CMAKE_BINARY_DIR})
+find_package(ClangFormat)
+
+#Enable LTO if available
+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_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)
@@ -80,6 +98,7 @@ target_compile_options(slsProjectWarnings INTERFACE
                                             -Wformat=2
                                             -Wredundant-decls
                                             # -Wconversion
+                                            -Wvla
                                             -Wdouble-promotion
                                             -Werror=return-type
 
@@ -213,11 +232,16 @@ if(SLS_BUILD_DOCS)
     add_subdirectory(docs)
 endif(SLS_BUILD_DOCS)
 
+
+if(SLS_USE_MOENCH)
+    add_subdirectory(slsDetectorCalibration/moenchExecutables)
+endif(SLS_USE_MOENCH)
+
 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()

README.md

@@ -1,3 +1,8 @@
+### Note
+
+Please do not update to any xxxx.xx.xx.dev0 tags. They are not releases, but tags for internal usage.
+Use only releases with tags such as x.x.x or x.x.x-rcx.
+
 ### Documentation
 Detailed documentation can be found on the [official site.](https://www.psi.ch/detectors/users-support)
 

RELEASE.txt

@@ -1,2 +1,127 @@
-Draft
-- dr 4, 8, 16 in eiger -> speed 0, 32 stays same (speed 1)
+SLS Detector Package 5.0.0-rc2 released on 09.10.2020 (Release Candidate 2)
+===========================================================================
+
+    CONTENTS
+    --------
+    1.  Firmware Requirements
+    2.  Download, Documentation & Support
+
+
+1. Firmware Requirements
+========================
+        
+        Eiger
+        =====  
+        Compatible version : 08.09.2020 (v27)
+        
+        Jungfrau
+        ========       
+        Compatible version : 24.07.2020 (v1.1, PCB v1.0) 
+                           : 21.07.2020 (v2.1, PCB v2.0)
+
+        Gotthard
+        ========   
+        Compatible version : 08.02.2018 (50um and 25um Master)
+                           : 09.02.2018 (25 um Slave) 
+
+        Mythen3
+        =======
+        Compatible version : 25.09.2020 (development)
+
+        Gotthard2
+        =========
+        Compatible version : 25.09.2020 (development)
+
+        Moench
+        ======
+        Compatible version : 10.05.2020 (v1.0)
+
+        Ctb
+        ===
+        Compatible version : 10.05.2019 (v1.0)
+
+
+        Detector Upgrade
+        ================
+
+        The following can be upgraded remotely:
+        Eiger      via bit files
+        Jungfrau   via command <.pof>
+        Mythen3    via command <.rbf>
+        Gotthard2  via command <.rbf> 
+        Moench     via command <.pof>
+        Ctb        via command <.pof>
+
+        The following cannot be upgraded remotely:
+        Gotthard   
+
+        Instructions available at
+            https://slsdetectorgroup.github.io/devdoc/firmware.html
+        and
+            https://slsdetectorgroup.github.io/devdoc/serverupgrade.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:
+         https://github.com/slsdetectorgroup/slsDetectorPackage
+            
+    Documentation
+    -------------
+    
+    Installation:
+        https://slsdetectorgroup.github.io/devdoc/installation.html#
+        
+    Firmware Upgrade:
+        https://slsdetectorgroup.github.io/devdoc/firmware.html
+
+    Detector Server upgrade:
+        https://slsdetectorgroup.github.io/devdoc/serverupgrade.html
+
+    Detector Simulators:
+        https://slsdetectorgroup.github.io/devdoc/virtualserver.html
+
+    Consuming slsDetectorPackage:
+        https://slsdetectorgroup.github.io/devdoc/consuming.html
+        
+    Command Line Documentation:
+        https://slsdetectorgroup.github.io/devdoc/commandline.html
+
+    Quick Start Guide:
+        https://slsdetectorgroup.github.io/devdoc/quick_start_guide.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://slsdetectorgroup.github.io/devdoc/troubleshooting.html
+        
+    Further Documentation:
+        https://www.psi.ch/en/detectors/documentation
+        
+    Old Release notes:
+        https://www.psi.ch/en/detectors/latest-installation
+
+
+    Support
+    -------
+
+        dhanya.thattil@psi.ch
+        erik.frojdh@psi.ch
+        anna.bergamaschi@psi.ch

cmake/FindClangFormat.cmake

@@ -0,0 +1,39 @@
+# Find Clang format
+if(NOT ClangFormat_BIN_NAME)
+	set(ClangFormat_BIN_NAME clang-format)
+endif()
+
+# if custom path check there first
+if(ClangFormat_ROOT_DIR)
+    find_program(ClangFormat_BIN 
+        NAMES
+        ${ClangFormat_BIN_NAME}
+        PATHS
+        "${ClangFormat_ROOT_DIR}"
+        NO_DEFAULT_PATH)
+endif()
+
+find_program(ClangFormat_BIN NAMES ${ClangFormat_BIN_NAME})
+
+include(FindPackageHandleStandardArgs)
+FIND_PACKAGE_HANDLE_STANDARD_ARGS(
+    ClangFormat
+    DEFAULT_MSG 
+    ClangFormat_BIN)
+
+mark_as_advanced(
+    ClangFormat_BIN)
+
+if(ClangFormat_FOUND)
+    exec_program(${ClangFormat_BIN} ${CMAKE_CURRENT_SOURCE_DIR} ARGS --version OUTPUT_VARIABLE CLANG_VERSION_TEXT)
+    string(REGEX MATCH "([0-9]+)\\.[0-9]+\\.[0-9]+" CLANG_VERSION ${CLANG_VERSION_TEXT})
+    if((${CLANG_VERSION} GREATER "9") OR (${CLANG_VERSION} EQUAL "9"))
+        # A CMake script to find all source files and setup clang-format targets for them
+        message(STATUS "found clang-format \"${CLANG_VERSION}\" adding formatting targets")
+        include(clang-format)
+    else()
+        message(STATUS "clang-format version \"${CLANG_VERSION}\" found but need at least 9. Not setting up format targets")
+    endif()
+else()
+    message(STATUS "clang-format not found. Not setting up format targets")
+endif()

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)

cmake/clang-format.cmake

@@ -0,0 +1,47 @@
+# A CMake script to find all source files and setup clang-format targets for them
+
+# Find all source files
+set(ClangFormat_CXX_FILE_EXTENSIONS ${ClangFormat_CXX_FILE_EXTENSIONS} *.cpp *.h *.cxx *.hxx *.hpp *.cc *.ipp *.c)
+file(GLOB_RECURSE ALL_SOURCE_FILES ${ClangFormat_CXX_FILE_EXTENSIONS})
+
+# Don't include some common build folders
+set(ClangFormat_EXCLUDE_PATTERNS ${ClangFormat_EXCLUDE_PATTERNS} "/CMakeFiles/" "cmake")
+
+# get all project files file
+foreach (SOURCE_FILE ${ALL_SOURCE_FILES}) 
+    foreach (EXCLUDE_PATTERN ${ClangFormat_EXCLUDE_PATTERNS})
+        string(FIND ${SOURCE_FILE} ${EXCLUDE_PATTERN} EXCLUDE_FOUND) 
+        if (NOT ${EXCLUDE_FOUND} EQUAL -1) 
+            list(REMOVE_ITEM ALL_SOURCE_FILES ${SOURCE_FILE})
+        endif () 
+    endforeach ()
+endforeach ()
+
+#target for formatting soruce files
+add_custom_target(format
+    COMMENT "Running clang-format to change files"
+    COMMAND ${ClangFormat_BIN}
+    -style=file
+    -i
+    ${ALL_SOURCE_FILES}
+)
+
+
+#target to check format on source files 
+add_custom_target(format-check
+    COMMENT "Checking clang-format changes"
+    # Use ! to negate the result for correct output
+    COMMAND !
+    ${ClangFormat_BIN}
+    -style=file
+    -output-replacements-xml
+    ${ALL_SOURCE_FILES}
+    | grep -q "replacement offset" 
+)
+
+# debug to check which file will be formatted
+add_custom_target(
+    listformatfiles
+    COMMAND
+    echo ${ALL_SOURCE_FILES}
+)

cmk.sh

@@ -12,6 +12,8 @@ TESTS=0
 SIMULATOR=0
 CTBGUI=0
 MANUALS=0
+MANUALS_ONLY_RST=0
+MOENCHZMQ=0
 
 
 CLEAN=0
@@ -20,7 +22,7 @@ CMAKE_PRE=""
 CMAKE_POST=""
 
 usage() { echo -e "
-Usage: $0 [-c] [-b] [-p] [e] [t] [r] [g] [s] [u] [i] [m] [-h] [-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
@@ -36,6 +38,8 @@ Usage: $0 [-c] [-b] [-p] [e] [t] [r] [g] [s] [u] [i] [m] [-h] [-d <HDF5 director
  -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:
 ./cmk.sh -bj5
@@ -71,7 +75,7 @@ For rebuilding only certain sections
  
  " ; exit 1; }
 
-while getopts ":bpchd:j:trgeisum" opt ; do
+while getopts ":bpchd:j:trgeisumnz" opt ; do
 	case $opt in
 	b) 
 		echo "Building of CMake files Required"
@@ -130,6 +134,14 @@ while getopts ":bpchd:j:trgeisum" 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
+		;;
 	u)
 		echo "Compiling Options: Chip Test Gui"
 		CTBGUI=1
@@ -210,6 +222,12 @@ if [ $MANUALS -eq 1 ]; then
 	echo "Manuals Option enabled"
 fi 
 
+#Moench zmq processor
+if [ $MOENCHZMQ -eq 1 ]; then
+	CMAKE_POST+=" -DSLS_USE_MOENCH=ON "
+	echo "Moench Zmq Processor Option enabled"
+fi 
+
 #Chip Test Gui
 if [ $CTBGUI -eq 1 ]; then
 	CMAKE_POST+=" -DSLS_USE_CTBGUI=ON "
@@ -256,16 +274,36 @@ fi
 
 #make
 if [ $COMPILERTHREADS -gt 0 ]; then
-	BUILDCOMMAND="make -j$COMPILERTHREADS"
-	echo $BUILDCOMMAND
-	eval $BUILDCOMMAND
+	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
-	make
+	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
 
-if [ $MANUALS -eq 1 ]; then
-	make docs
-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}
 )

ctbGui/patternGenerator/generate.sh

@@ -21,6 +21,7 @@ if [ -f "$infile" ]
 then
 gcc -DINFILE="\"$infile\"" -DOUTFILE="\"$outfile\""  -DOUTFILEBIN="\"$outfilebin\"" -o $exe generator.c ; 
 echo compiling
+echo gcc -DINFILE="\"$infile\"" -DOUTFILE="\"$outfile\""  -DOUTFILEBIN="\"$outfilebin\"" -o $exe generator.c ; 
 $exe ; 
 echo cleaning
 rm $exe

docs/CMakeLists.txt

@@ -38,11 +38,19 @@ set(SPHINX_SOURCE_FILES
   src/pydetector.rst
   src/pyenums.rst
   src/pyexamples.rst
-  src/receiver.rst
+  src/servers.rst
+  src/receiver_api.rst
   src/result.rst
   src/type_traits.rst
   src/ToString.rst
   src/examples.rst
+  src/pygettingstarted.rst
+  src/firmware.rst
+  src/serverupgrade.rst
+  src/virtualserver.rst
+  src/serverdefaults.rst
+  src/quick_start_guide.rst
+  src/troubleshooting.rst
   
 )
 
@@ -56,8 +64,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
@@ -66,4 +87,11 @@ add_custom_target(docs
               ${SPHINX_BUILD}/html
               COMMENT "Generating documentation with Sphinx")
 
+add_custom_target(rst
+              COMMAND ${SPHINX_EXECUTABLE} -a -b html
+              -Dbreathe_projects.slsDetectorPackage=${CMAKE_CURRENT_BINARY_DIR}/xml
+              -c "${SPHINX_BUILD}"
+              ${SPHINX_BUILD}/src 
+              ${SPHINX_BUILD}/html
+              COMMENT "Generating documentation with Sphinx")
 

docs/conf.py.in

@@ -21,7 +21,7 @@ print(sys.path)
 # -- Project information -----------------------------------------------------
 
 project = 'slsDetectorPackage'
-copyright = '2019, PSD Detector Group'
+copyright = '2020, PSD Detector Group'
 author = 'PSD Detector Group'
 version = '@PROJECT_VERSION@'
 
@@ -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/consuming.rst

@@ -6,7 +6,7 @@ slsDetectorPackage there are a few different ways to
 consume our package. The recommended way is to use one of the 
 CMake approaches. 
 
-
+One can test with :ref:`detector simulators<Virtual Detector Servers>` before testing the API with a real detector or when a real detector is not at hand.
 
 CMake: slsDetectorPackage as submodule in your project
 ---------------------------------------

docs/src/dependencies.rst

@@ -42,7 +42,7 @@ The documentation that you are reading now is built with
 
  * Doxygen (to extract C++ classes etc.)
  * Breathe (Sphinx plugin to handle doxygen xml)
- * Sphinx 
+ * Sphinx with sphinx_rtd_theme 
 
 -----------------------
 Packaged in libs/

docs/src/firmware.rst

@@ -0,0 +1,446 @@
+Firmware Upgrade
+=================
+
+
+
+Eiger
+-------------
+
+Download 
+^^^^^^^^^^^^^
+- `bcp script <https://github.com/slsdetectorgroup/slsDetectorFirmware/blob/master/binaries/eiger/bcp>`__
+
+- detector server corresponding to package in slsDetectorPackage/serverBin
+
+- bit files
+    .. list-table:: 
+       :widths: 25 10 30 25 10
+       :header-rows: 1
+
+       * - Software
+         - Hardware
+         - Firmware Date
+         - Firmware Link
+         - Comments
+       * - v5.0.0-rcx
+         - 
+         - 08.09.2020
+         - `v27 <https://github.com/slsdetectorgroup/slsDetectorFirmware/blob/master/binaries/eiger/v27/>`__
+         - 
+       * - v4.0.0 - v4.2.0
+         - 
+         - 30.07.2019
+         - `v24 <https://github.com/slsdetectorgroup/slsDetectorFirmware/blob/master/binaries/eiger/v24/>`__
+         - 
+       * - v3.1.0 - v3.1.5
+         - 
+         - 17.08.2017
+         - `v20 <https://github.com/slsdetectorgroup/slsDetectorFirmware/blob/master/binaries/eiger/v20/>`__
+         -
+
+
+Upgrade
+^^^^^^^^
+#. Tftp must be already installed on your pc to use the bcp script.
+
+#. 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
+-------------
+
+Download 
+^^^^^^^^^^^^^
+- detector server corresponding to package in slsDetectorPackage/serverBin
+
+- pof files
+    .. list-table:: 
+       :widths: 25 10 30 25 10
+       :header-rows: 1
+
+       * - Software
+         - Hardware
+         - Firmware Date
+         - Firmware Link
+         - Comments
+       * - v5.0.0-rcx
+         - 2.0
+         - 21.07.2020
+         - `v2.1 <https://github.com/slsdetectorgroup/slsDetectorFirmware/blob/master/binaries/jungfrau/v2_1/jungfrau_v2_1.pof>`__
+         - 
+       * - v5.0.0-rcx
+         - 1.0
+         - 24.07.2020
+         - `v1.1 <https://github.com/slsdetectorgroup/slsDetectorFirmware/blob/master/binaries/jungfrau/v1_1/jungfrau_v1_1.pof>`__
+         - 
+       * - v4.0.1 - v4.2.0
+         - 1.0
+         - 06.12.2018
+         - `v0.7 <https://github.com/slsdetectorgroup/slsDetectorFirmware/blob/master/binaries/jungfrau/v0_7/jungfrau_v0_7.pof>`__
+         - 
+       * - v3.1.0 - v3.1.5
+         - 1.0
+         - 13.11.2017
+         - `v0.6 <https://github.com/slsdetectorgroup/slsDetectorFirmware/blob/master/binaries/jungfrau/v0_6/jungfrau_v0_6.pof>`__
+         -
+
+
+
+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 in server console.
+
+#. 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-rcx)
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+#. 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
+---------
+
+Download 
+^^^^^^^^^^^^^
+- detector server corresponding to package in slsDetectorPackage/serverBin
+
+- pof files
+    .. list-table:: 
+       :widths: 15 15 15 15 5
+       :header-rows: 1
+
+       * - Software
+         - Hardware
+         - Firmware Date
+         - Firmware Link
+         - Comments
+       * - All versions
+         - 50um
+         - 08.02.2018
+         - `50um <https://github.com/slsdetectorgroup/slsDetectorFirmware/blob/master/binaries/gotthard_I/50um/gotthard_I_50um.pof>`__
+         - 
+       * - All versions
+         - 25um (master)
+         - 08.02.2018
+         - `25um (master) <https://github.com/slsdetectorgroup/slsDetectorFirmware/blob/master/binaries/gotthard_I/25um/master/gotthard_I_25um_master.pof>`__
+         - 
+       * - All versions
+         - 25um (slave)
+         - 09.02.2018
+         - `25um (slave) <https://github.com/slsdetectorgroup/slsDetectorFirmware/blob/master/binaries/gotthard_I/25um/slave/gotthard_I_25um_slave.pof>`__
+         - 
+
+
+
+Upgrade
+^^^^^^^^
+.. warning ::
+    | Gotthard firmware cannot be upgraded remotely and requires the use of USB-Blaster.
+    | It is generally updated by the SLS Detector group.
+
+#. 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 :: 
+
+  As it is still in developement, the rbf files must be picked up from the SLS Detector Group.
+
+Download 
+^^^^^^^^^^^^^
+
+- detector server corresponding to package in slsDetectorPackage/serverBin
+
+- rbf files
+    .. list-table:: 
+       :widths: 25 10 30 25 10
+       :header-rows: 1
+
+       * - Software
+         - Hardware
+         - Firmware Date
+         - Firmware Link
+         - Comments
+       * - v5.0.0-rcx
+         - 
+         - 25.09.2020
+         - 
+         - development
+
+
+Upgrade (from v5.0.0-rcx)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+#. 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 :: 
+
+  As it is still in developement, the rbf files must be picked up from the SLS Detector Group.
+
+Download 
+^^^^^^^^^^^^^
+- detector server corresponding to package in slsDetectorPackage/serverBin
+
+- rbf files
+    .. list-table:: 
+       :widths: 25 10 30 25 10
+       :header-rows: 1
+
+       * - Software
+         - Hardware
+         - Firmware Date
+         - Firmware Link
+         - Comments
+       * - v5.0.0-rcx
+         - 
+         - 25.09.2020
+         - 
+         - development
+
+Upgrade (from v5.0.0-rcx)
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+#. 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
+-------
+
+Download 
+^^^^^^^^^^^^^
+- detector server corresponding to package in slsDetectorPackage/serverBin
+
+- pof files
+    .. list-table:: 
+       :widths: 25 10 30 25 10
+       :header-rows: 1
+
+       * - Software
+         - Hardware
+         - Firmware Date
+         - Firmware Link
+         - Comments
+       * - v5.0.0-rcx
+         - EPCQ128
+         - 05.10.2020
+         - `v1.0 <https://github.com/slsdetectorgroup/slsDetectorFirmware/blob/master/binaries/moench/EPCQ128/v1_0/moench_v1_0_201005.pof>`__
+         - 
+       * - v5.0.0-rcx
+         - EPCS128
+         - 05.10.2020
+         - `v1.0 <https://github.com/slsdetectorgroup/slsDetectorFirmware/blob/master/binaries/moench/EPCS128/v1_0/moench_v1_0_201005.pof>`__
+         - 
+
+Upgrade (from v5.0.0-rcx)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+#. 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
+----
+
+Download 
+^^^^^^^^^^^^^
+- detector server corresponding to package in slsDetectorPackage/serverBin
+
+- pof files
+    .. list-table:: 
+       :widths: 25 10 30 25 10
+       :header-rows: 1
+
+       * - Software
+         - Hardware
+         - Firmware Date
+         - Firmware Link
+         - Comments
+       * - v5.0.0-rcx
+         - EPCQ128
+         - 05.10.2020
+         - `v1.0 <https://github.com/slsdetectorgroup/slsDetectorFirmware/blob/master/binaries/ctb/EPCQ128/v1_0/ctb_v1_0_201005.pof>`__
+         - 
+       * - v5.0.0-rcx
+         - EPCS128
+         - 05.10.2020
+         - `v1.0 <https://github.com/slsdetectorgroup/slsDetectorFirmware/blob/master/binaries/ctb/EPCS128/v1_0/ctb_v1_0_201005.pof>`__
+         - 
+
+Upgrade (from v5.0.0-rcx)
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+#. 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

@@ -1,7 +1,7 @@
-/** 
- * Utility program to generate input files for the command line 
+/**
+ * Utility program to generate input files for the command line
  * documentation. Uses the string returned from sls_detector_help cmd
- * 
+ *
  */
 #include <fstream>
 #include <iostream>
@@ -9,7 +9,6 @@
 #include <string>
 #include <vector>
 
-
 #include "CmdProxy.h"
 #include "Detector.h"
 #include "sls_detector_defs.h"
@@ -49,8 +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

@@ -25,13 +25,14 @@ Welcome to slsDetectorPackage's documentation!
 
     detector
     result
-    receiver
+    receiver_api
     examples
 
 .. toctree::
     :caption: Python API
     :maxdepth: 2
 
+    pygettingstarted
     pydetector
     pyenums
     pyexamples
@@ -41,6 +42,7 @@ Welcome to slsDetectorPackage's documentation!
     :maxdepth: 2
 
     commandline  
+    quick_start_guide
 
 .. toctree::
     :caption: Developer
@@ -49,6 +51,27 @@ Welcome to slsDetectorPackage's documentation!
     type_traits
     ToString
 
+.. toctree::
+    :caption: Firmware
+    :maxdepth: 2
+
+    firmware 
+
+.. toctree::
+    :caption: Detector Server
+    :maxdepth: 2
+
+    servers
+    serverupgrade
+    virtualserver
+    serverdefaults
+
+.. toctree::
+    :caption: Troubleshooting
+
+    troubleshooting
+
+
 .. Indices and tables
 .. ==================
 

docs/src/installation.rst

@@ -1,9 +1,5 @@
 
-Installation
-==============================================
 
-Build from source using CMake
----------------------------------
 
 .. note :: 
 
@@ -13,17 +9,77 @@ Build from source using CMake
     without being communicated. If absolute stability of the API is needed please
     use one of the release versions. 
 
+.. warning ::
+    
+    Before building from source make sure that you have the 
+    :doc:`dependencies <../dependencies>` installed. If installing using conda, conda will 
+    manage the dependencies.
+    
+
+.. _Installation:
+
+Installation
+==============================================
+
+Build from source using CMake
+---------------------------------
+
+Note that on some systems, for example RH7,  cmake v3+ is available under the cmake3 alias.
+It is also required to clone with the option --recursive to get the git submodules used
+in the package. 
+
+
 .. code-block:: bash
 
-    git clone https://github.com/slsdetectorgroup/slsDetectorPackage.git
+    git clone --recursive https://github.com/slsdetectorgroup/slsDetectorPackage.git
     mkdir build && cd build
     cmake ../slsDetectorPackage -DCMAKE_INSTALL_PREFIX=/your/install/path
-    make -j12
+    make -j12 #or whatever number of cores you are using to build
     make install
 
+The easiest way to configure options is to use the ccmake utility. 
+
+.. code-block:: bash
+
+    #from the build directory
+    ccmake .
+
+
+Build using cmk.sh script
+-------------------------
+.. code-block:: bash
+
+    The binaries are generated in slsDetectorPackage/build/bin directory.
+
+    # 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
 --------------------------------
 
+Conda is not only useful to manage python environments but can also
+be used as a user space package manager. 
+
+We have three different packages available:
+
+ * **slsdetlib**, shared libraries and command line utilities 
+ * **slsdetgui**, GUI
+ * **slsdet**, Python bindings
+
+
 .. code-block:: bash
 
     #Add channels for dependencies and our library
@@ -32,14 +88,20 @@ Install binaries using conda
     conda config --set channel_priority strict
 
     #cerate an environment with our library, then activate
-    conda create -n myenv slsdetlib=2020.03.18.dev2
-    codna activate myenv
+    #replace 2020.07.20.dev0 with the required tag
+    conda create -n myenv slsdetlib=2020.07.23.dev0
+    conda activate myenv
 
     #ready to use
     sls_detector_get exptime
     etc ...
 
 
+.. code-block:: bash
+
+    #List available versions
+    conda search slsdet
+
 
 Build from source on old distributions
 -----------------------------------------
@@ -66,4 +128,11 @@ is to use conda
 
 .. code-block:: bash
 
-    conda create -n myenv python sphinx sphinx_rtd_theme
+    conda create -n myenv python sphinx sphinx_rtd_theme
+
+Then enable the option SLS_BUILD_DOCS to create the targets
+
+.. code-block:: bash
+
+    make docs # generate API docs and build Sphinx RST
+    make rst # rst only, saves time in case the API did not change

docs/src/pydetector.rst

@@ -6,4 +6,5 @@ Detector
 .. autoclass:: Detector
     :members:  
     :undoc-members:
-    :show-inheritance:
+    :show-inheritance:
+    :inherited-members:

docs/src/pyenums.rst

@@ -4,9 +4,74 @@ Enums
 These enums are defined in slsDetectorDefs in the C++ package and 
 exposed to Python through pybind11.
 
-.. py:currentmodule:: sls_detector
+
+::  
+
+    # 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
-    :members:  
     :undoc-members:
-    :show-inheritance:
+
+.. autoclass:: detectorType
+    :undoc-members:
+
+.. autoclass:: frameDiscardPolicy
+    :undoc-members:
+
+.. autoclass:: fileFormat
+    :undoc-members:
+
+.. autoclass:: dimension
+    :undoc-members:
+
+.. autoclass:: externalSignalFlag
+    :undoc-members:
+
+.. autoclass:: timingMode
+    :undoc-members:
+
+.. autoclass:: dacIndex
+    :undoc-members:
+
+.. autoclass:: detectorSettings
+    :undoc-members:
+
+.. autoclass:: clockIndex
+    :undoc-members:
+
+.. autoclass:: speedLevel
+    :undoc-members:
+
+.. autoclass:: readoutMode
+    :undoc-members:
+
+.. autoclass:: masterFlags
+    :undoc-members:
+
+.. autoclass:: burstMode
+    :undoc-members:
+
+.. autoclass:: timingSourceType
+    :undoc-members:

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 sls_detector 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 sls_detector 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()
+    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', 
+    'detectorSettings', 'detectorType', 'dimension', 'externalSignalFlag', 
+    'fileFormat', 'frameDiscardPolicy', '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/quick_start_guide.rst

@@ -0,0 +1,140 @@
+Quick Start Guide
+=================
+
+Detector
+--------
+Start up detector (with cooling if required). Ensure both control server and stop server is running on-board.
+
+Or use a detector simulator to test. Click :ref:`here<Virtual Detector Servers>` for further instructions.
+
+Receiver
+--------
+
+| One has to start the slsReceiver before loading config file or using any receiver commands (prefix: **rx_** )
+
+For a Single Module
+    .. code-block:: bash  
+
+        # default port 1954
+        slsReceiver
+
+        # custom port 2012
+        slsReceiver -t2012
+
+
+For Multiple Modules
+    .. code-block:: bash  
+
+        # slsMultiReceiver [starting port] [number of receivers] [print each frame header for debugging]
+        slsMultiReceiver 2012 2 0 
+
+
+Client
+------
+
+Refer :ref:`Sample Config file` to create config file.
+
+.. code-block:: bash  
+
+    # load config file
+    sls_detector_put config /path/sample.config
+
+    # set number of frames
+    sls_detector_put frames 5
+
+    # acquire
+    sls_detector_acquire
+
+
+.. _Sample Config file:
+
+Sample Config file
+^^^^^^^^^^^^^^^^^^
+There are sample config files for each detector in slsDetectorPackage/examples folder.
+
+For a Single Module
+    .. code-block:: bash  
+
+        # connects to module
+        hostname bchipxxx
+
+        # connects to receiver at default port
+        rx_hostname mpc1922
+        # or to connect to specific port
+        # rx_hostname mpc1922:2012
+
+        # sets destination udp ports (not needed, default is 50001)
+        udp_dstport 50012
+
+        # source udp ips must be same subnet at destintaion udp ips
+        udp_srcip 192.168.1.112
+
+        # destination udp ip picked up from rx_hostname (if auto)
+        udp_dstip auto
+
+        # set file path
+        fpath /tmp
+
+For a Single Module with custom Receiver (not slsReceiver)
+    .. code-block:: bash  
+
+        # connects to module
+        hostname bchipxxx
+
+        # sets destination udp ports (not needed, default is 50001)
+        udp_dstport 50012
+
+        # source udp ips must be same subnet at destintaion udp ips
+        udp_srcip 192.168.1.112
+
+        # destination udp ip 
+        udp_dstip 192.168.1.100
+
+        # source udp mac 
+        udp_srcmac aa:bb:cc:dd:ee:ff
+        
+        # destination udp mac 
+        udp_dstmac 3c:ab:98:bf:50:60
+
+        # set file path
+        fpath /tmp
+
+For Multiple Modules
+    .. code-block:: bash  
+
+        # connects to mulitple modules
+        hostname bchipxxx+bchipyyy+
+
+        # connects to receivers at ports 2012 and 2014
+        rx_hostname mpc1922:2012+mpc1922:2013+
+
+        # sets differernt destination udp ports
+        0:udp_dstport 50012
+        1:udp_dstport 50014
+
+        # source udp ips must be same subnet at destintaion udp ips
+        0:udp_srcip 192.168.1.112
+        1:udp_srcip 192.168.1.114
+
+        # destination udp ip picked up from rx_hostname (if auto)
+        udp_dstip auto
+
+        # set file path
+        fpath /tmp
+
+Gui
+----
+
+Compile with SLS_USE_GUI=ON in cmake or -g option in cmk.sh script. One can also just use the conda binary. Refer :ref:`installation instructions<Installation>`.
+
+.. code-block:: bash  
+
+    slsDetectorGui
+
+
+.. note ::
+    | The streaming high water mark (commmand: rx_zmqhwm) and the receiving high water mark (command: zmqhwm) is by default the lib zmq's default (currently 1000).
+    | At Gui startup, these values are set to 2. Hence, for very fast detectors, many frames will be dropped to be able to view the latest in the gui.
+    | One can still change this setting in the gui in the Plot tab (ZMQ Streaming), from the command line or API.
+    | Both hwm's can be set to a -1 to use the lib's default.
+    | Since the dummy end of acquisition packet streamed from receiver might also be lost, receiver restreams until gui acknowledges.

docs/src/receiver_api.rst

@@ -1,6 +1,6 @@
 Receiver
 ==============================================
 
-.. doxygenclass:: slsReceiver
+.. doxygenclass:: Receiver
    :members:
 ..    :undoc-members:

docs/src/serverdefaults.rst

@@ -0,0 +1,106 @@
+Default Values
+==============================================
+
+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/servers.rst

@@ -0,0 +1,36 @@
+Detector Servers
+=================
+
+Location
+---------
+   slsDetectorPackage/serverBin/ folder in every release.
+
+
+.. _Detector Server Arguments:
+
+Arguments
+---------
+
+   .. code-block:: bash  
+
+      Possible arguments are:
+      -v, --version            : Software version
+      -p, --port <port>        : TCP communication port with client. 
+      -g, --nomodule           : [Mythen3][Gotthard2] Generic or No Module mode. 
+                                 Skips detector type checks.
+      -f, --phaseshift <value> : [Gotthard] only. Sets phase shift. 
+      -d, --devel              : Developer mode. Skips firmware checks. 
+      -u, --update             : Update mode. Skips firmware checks and initial detector setup. 
+      -s, --stopserver         : Stop server. Do not use as it is created by control server 
+
+
+Basics
+------------
+
+Detector Servers include:
+   * Control server [default port: 1952]
+      * Almost all client communication.
+   * Stop server [default port: 1953]
+      *  Client requests for detector status, stop acquisition, temperature, advanced read/write registers.
+
+When using a blocking acquire command (sls_detector_acquire or Detector::acquire), the control server is blocked until end of acquisition. However, stop server commands could be used in parallel.

docs/src/serverupgrade.rst

@@ -0,0 +1,114 @@
+Detector Server Upgrade
+=======================
+
+
+
+Eiger
+-------------
+
+
+**Location:** slsDetectorPackage/serverBin/ folder for every release.
+
+
+#. 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
+-------------
+
+**Location:** slsDetectorPackage/serverBin/ folder for every release.
+
+#. Install tftp and copy detector server binary to tftp folder
+#. Program from console (only from 5.0.0-rcx)
+    .. code-block:: bash
+
+        # copies new server from pc tftp folder, respawns and reboots
+        sls_detector_put copydetectorserver jungfrauDetectorServerxxx pcxxx
+
+
+Gotthard
+---------
+
+**Location:** slsDetectorPackage/serverBin/ folder for every release.
+
+#. Install tftp and copy detector server binary to tftp folder
+#. Program from console (only from 5.0.0-rcx)
+    .. code-block:: bash
+
+        # copies new server from pc tftp folder, respawns and reboots
+        sls_detector_put copydetectorserver gotthardDetectorServerxxx pcxxx
+
+
+
+Mythen3
+-------
+
+**Location:** slsDetectorPackage/serverBin/ folder for every release.
+
+#. Install tftp and copy detector server binary to tftp folder
+#. Program from console (only from 5.0.0-rcx)
+    .. code-block:: bash
+
+        # copies new server from pc tftp folder and reboots (does not respawn)
+        sls_detector_put copydetectorserver mythen3DetectorServerxxx pcxxx
+
+
+Gotthard2
+----------
+
+**Location:** slsDetectorPackage/serverBin/ folder for every release.
+
+#. Install tftp and copy detector server binary to tftp folder
+#. Program from console (only from 5.0.0-rcx)
+    .. code-block:: bash
+
+        # copies new server from pc tftp folder and reboots (does not respawn)
+        sls_detector_put copydetectorserver gotthard2DetectorServerxxx pcxxx
+
+
+Moench
+------
+
+**Location:** slsDetectorPackage/serverBin/ folder for every release.
+
+#. Install tftp and copy detector server binary to tftp folder
+#. Program from console (only from 5.0.0-rcx)
+    .. code-block:: bash
+
+        # copies new server from pc tftp folder, respawns and reboots
+        sls_detector_put copydetectorserver moenchDetectorServerxxx pcxxx
+
+
+Ctb
+---
+
+**Location:** slsDetectorPackage/serverBin/ folder for every release.
+
+#. Install tftp and copy detector server binary to tftp folder
+#. Program from console (only from 5.0.0-rcx)
+    .. code-block:: bash
+
+        # copies new server from pc tftp folder, respawns and reboots
+        sls_detector_put copydetectorserver ctbDetectorServerxxx pcxxx

docs/src/troubleshooting.rst

@@ -0,0 +1,295 @@
+Troubleshooting
+=================
+
+Common
+------
+
+Missing Packets
+^^^^^^^^^^^^^^^
+Possible causes could be the following:
+
+#. Receiver PC is not tuned for socket buffer size and input packet queue.
+    * Refer to :ref:`Increase rmem_default, rmem_max and max_backlog<Receiver PC Tuning>`
+
+#. Wiring
+    * Faulty wiring or connecting cable to incorrect interface.
+
+#. Link up and speed
+    * Check to see if there is a blue LED on board to signal that the link is up. Check ethtool and find if Link Deteced:Yes and Speed is acceptable (>10k).
+
+#. Detector is not acquiring (Not Eiger)
+    * Take an acquisition with many images and using the following steps instead of acquire:
+        .. code-block:: bash
+
+            sls_detector_put status start
+            # keep executing this command to see if the number of frames left keeps decreasing,
+            # which means the detector is acquiring.
+            sls_detector_get framesl 
+
+    .. note ::
+    
+        If you are using multiple modules, the previous command can return -1 because each module will return different values. Then, check for a single module instead: sls_detector_get 0:framesl
+
+#. Data cable plugged into the wrong interface on board (Jungfrau)
+    * Please ensure that the data cable is plugged into the rightmost interface. The middle one is disabled for PCB v1.0 and must be selected via command for PCB v2.0.
+
+#. Detector is not sending data
+    * Check the board to see if the green LED is blinking next to the data cable, which means that the detector is sending data.
+
+#. Firewall or security feature
+    * A firewall or some security feature could be blocking the reception of data.
+
+#. Ethernet interface not configured properly
+    * Ensure that the interfaces used are configured properly with the right mask and ip. Eg. use ifconfig and route commands to verify.
+
+#. Ethernet interface not configured for Jumbo frames (10Gb)
+    * Ensure that the interfaces used in receiver pc have MTU 9000 (jumbo frames) enabled.
+
+#. Detector IP (Not Eiger)
+    * Ensure it is valid and does not end if 0 or 255. Also ensure that the detector ip is in the same subnet as rx_udpip and the masking in the interface configuration ensures this rule.
+
+#. Tcpdump or wireshark
+    * Use one of these to confirm that you receive packets (with the right filtering ie. source and destination ports, ip).
+
+#. Check SFP modules
+    * Check if the SFP modules on both sides of the fiber are of same type.
+
+#. Pinging the subnet (receiving only a few number of packets each time)
+    * If a switch is used between a receiver pc and detector instead of plugging the cables directly, one might have to ping any ip in the subnet of the Ethernet interface constantly so that it does not forget the ip during operation.
+    * Eg. if rx_udpip is 10.2.3.100, then ping constantly 10.2.3.xxx, where xxx is any ip other than 100.
+
+
+
+.. _Receiver PC Tuning:
+
+Receiver PC Tuning Options
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+#. Increase maximum receive socket buffer size and socket input packet queue. 
+    * Temporarily (until shut down)
+        .. code-block:: bash
+            
+            # check size
+            sysctl -a | grep rmem
+            sysctl -a | grep backlog
+
+            # set max and default (use 1Gb for Jungfrau and 100Mb for others)
+            sysctl net.core.rmem_max=$((100*1024*1024)) 
+            sysctl net.core.rmem_default=$((100*1024*1024))
+            sysctl net.core.netdev_max_backlog=250000
+
+
+    * Permanently
+            .. code-block:: bash
+
+                # edit /etc/sysctl.conf file
+                # set max and default (use 1Gb for Jungfrau and 100Mb for others)
+                net.core.rmem_max = 104857600
+                net.core.rmem_default= 104857600
+                net.core.netdev_max_backlog = 250000
+
+                # save file and run the following
+                sysctl -p
+
+    .. note ::
+        This is the most basic setting, which is sometimes more than enough.
+
+#. For 10Gb,
+    * MTU must be set up to 9000 for jumbo frames on detector, switch and server NIC
+    
+    * Set up static MAC address tables with separated VLANs
+
+#. Write to memory if not a large disk and pc not fast enough.
+    .. code-block:: bash
+
+        mount -t tmpfs none /ramdisk_folder
+        # or
+        mount -t tmpfs none /mnt/ramdisk -o size=10G
+        # check how many GB memory you can allocate, to avoid swapping otherwise    
+
+
+#. Modify ethtool settings. 
+    * rx ring parameters
+        .. code-block:: bash
+
+            # check 
+            ethtool -g xth1
+
+            # set to max value in your pc settings
+            ethtool -G xth1 rx 4096 
+
+    * coalesce settings (might not always work)
+        .. code-block:: bash
+
+            # check 
+            ethtool -c xth1
+
+            # set to max value in your pc settings
+            ethtool -C xth1 rx-usecs 100 
+
+    * pause parameters
+        .. code-block:: bash
+
+            # check 
+            ethtool -a xth1
+
+            # set to max value in your pc settings
+            ethtool -A xth1 rx on
+ 
+    .. note ::
+
+        | xth1 is example interface name. 
+        | These settings are lost at pc reboot.
+
+#. Give user speicific user scheduling privileges.
+    .. code-block:: bash
+
+        # edit /etc/security/limits.conf
+        # add following line or similar depending on your distribution
+        username rtprio 99
+
+    .. note ::
+
+        This is also set if slsReceiver is run as root user.
+        
+        
+#. Disable power saving in CPU frequency 
+    .. code-block:: bash
+
+        # or similar command depending on your distribution
+        cpupower frequency-info
+        cpupower frequency-set -g performance
+
+        # or
+        cpufreq-info
+        for i in ‘seq 0 7‘; do cpufreq-set -c $i -g performance; done
+
+
+slsReceiver Tuning
+^^^^^^^^^^^^^^^^^^
+
+#. Starting receiver as root to have scheduling privileges.
+
+#. For 10g, enable flow control
+    .. code-block:: bash
+
+        sls_detector_put flowcontrol10g 1
+
+#. Increase slsReceiver fifo depth between listening and processing threads.
+    .. code-block:: bash
+
+        sls_detector_get rx_fifodepth
+        # sets number of frames in fifo to 5000
+        sls_detector_put rx_fifodepth 5000
+
+#. Increase number of frames per file to reduce time taken to open and close files.
+    .. code-block:: bash
+
+        sls_detector_get rx_framesperfile
+        sls_detector_put rx_framesperfile 20000
+        # writes all frames into a single file
+        sls_detector_put rx_framesperfile 0
+
+
+Shared memory error
+^^^^^^^^^^^^^^^^^^^
+| For errors due to access or size, delete shared memory files nd try again.
+
+To list all shared memory files of sls detector package.
+    .. code-block:: bash
+        
+        ll /dev/shm/slsDetectorPackage*
+        -rw-------. 1 l_d l_d  136 Oct  1 11:42 /dev/shm/slsDetectorPackage_multi_0
+        -rw-------. 1 l_d l_d 3476 Oct  1 11:42 /dev/shm/slsDetectorPackage_multi_0_sls_0
+        -rw-------. 1 l_d l_d 3476 Oct  1 11:42 /dev/shm/slsDetectorPackage_multi_0_sls_1
+
+Cannot connect to detector
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+Ensure both control and stop servers are running on the detector.
+    .. code-block:: bash
+
+        ps -ef | grep jungfrauDetectorServer*
+
+Cannot connect to receiver
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+Start receiver before running a client command that needs to communicate with receiver.
+
+Receiver: cannot bind socket
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+#. slsReceiver or slsMultiReceiver is already open somewhere.
+    * Kill it and restart it.
+
+#. Tcp port is in use by another application.
+    * Start Receiver with a different tcp port and adjust it config file
+        .. code-block:: bash
+
+            # restart receiver with different port
+            slsReceiver -t1980
+
+            # adjust in config file
+            rx_hostname pcxxxx:1980
+
+.. _common troubleshooting multi module data:
+
+Cannot get multi module data
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Possible causes could be the following:
+
+#. Network
+    * If you have a direct connection, check to see if the network cables are connected correctly to corresponding interfaces on the PC side. Check also the network configuration and that the detectors and receivers are in the corresponding subnet.
+
+#. Power Supply
+    * Check power supply current limit.
+    * For Jungfrau, refer to :ref:`Jungfrau Power Supply Troubleshooting<Jungfrau Troubleshooting Power Supply>`.
+
+
+
+Gotthard
+----------
+
+
+Missing first frame or next frame after a delay
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Connect the data link from the Module directly to receiver pc or to a private network.
+
+
+Jungfrau
+---------
+
+Temperature event occured
+^^^^^^^^^^^^^^^^^^^^^^^^^
+This will occur only if:
+* temp_threshold (threshold temperature) has been set to a value
+* temp_control (temperature control) set to 1
+* and the temperature overshooted the threshold temperature.
+
+**Consequence**
+* sls_detector_get temp_event will give 1 # temperature event occured
+* the chip will be powered off
+
+**Solution**
+* Even after fixing the cooling, any subsequent powerchip command will fail unless the temperature event has been cleared.
+
+* Clear the temperature event
+    .. code-block:: bash
+        
+        # gives the current chip power status (zero currently as chip powered off)
+        sls_detector_get powerchip 
+
+        # clear temperature event
+        sls_detector_put temp_event 0
+
+        # power on the chip
+        sls_detector_put powerchip 1 
+
+
+.. _Jungfrau Troubleshooting Power Supply:
+
+Cannot get multi module data
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+#. Check :ref:`Common Multi Module Troubleshooting<common troubleshooting multi module data>`
+#. Power Supply
+    * Comment out this line in the config file: powerchip 1
+    * Powering on the chip increases the power consumption by a considerable amount. If commenting out this line aids in getting data (strange data due to powered off chip), then it could be the power supply current limit. Fix it (possibly to 8A current limit) and uncomment the powerchip line back in config file.
+

docs/src/virtualserver.rst

@@ -0,0 +1,148 @@
+.. _Virtual Detector Servers:
+Detector Simulators
+===================
+
+Compilation
+-----------
+
+* Using CMake, turn on the option 
+    .. code-block:: bash  
+        
+        SLS_USE_SIMULATOR=ON
+
+* Using cmk.sh script,
+     .. code-block:: bash  
+        
+        ./cmk.sh -b**s**j9 #option s is for simulator
+
+
+Binaries
+^^^^^^^^
+    .. code-block:: bash  
+
+        eigerDetectorServerMaster_virtual
+        eigerDetectorServerSlaveTop_virtual
+        eigerDetectorServerSlaveBottom_virtual
+        jungfrauDetectorServer_virtual
+        gotthardDetectorServer_virtual
+        gotthard2DetectorServer_virtual
+        mythen3DetectorServer_virtual
+        moenchDetectorServer_virtual
+        ctbDetectorServer_virtual
+
+
+Arguments
+---------
+
+The arguments are the same as the :ref:`normal server arguments<Detector Server Arguments>`.
+
+When using multiple modules, use different ports for each virtual server.
+    .. code-block:: bash  
+
+        # will start control server at port 1912 and stop server at port 1913
+        jungfrauDetectorServer --port 1912 &
+
+        # will start second control server at port 1914 and stop server at port 1915
+        jungfrauDetectorServer --port 1914 &
+
+
+Client
+------
+
+.. code-block:: bash  
+
+    # hostname should include the port (if not default)
+    sls_detector_put hostname localhost:1912+localhost:1914+
+
+    # or use virtual command, instead of hostname
+    # connects to 2 servers at localhost 
+    # (control servers: 1912, 1914; stop servers: 1913, 1915)
+    sls_detector_put virtual 2 1912 
+
+Use the same in the config file.
+
+
+Sample Config file
+^^^^^^^^^^^^^^^^^^
+There are sample config files for each detector in slsDetectorPackage/examples folder.
+
+For a Single Module
+    .. code-block:: bash  
+
+        # connects to control port 1912
+        hostname localhost:1912+
+
+        # connects to receiver at ports 2012
+        rx_hostname mpc1922:2012+
+
+        # sets destination udp ports (not needed, default is 50001)
+        udp_dstport 50012
+
+        # source udp ips must be same subnet at destintaion udp ips
+        udp_srcip 192.168.1.112
+
+        # destination udp ip picked up from rx_hostname (if auto)
+        udp_dstip auto
+
+        # set file path
+        fpath /tmp
+
+For Multiple Modules
+    .. code-block:: bash  
+
+        # connects to control ports 1912, 1914 and stop ports 1913, 1915
+        virtual 2 1912
+        # or hostname localhost:1912+localhost:1914+
+
+        # connects to receivers at ports 2012 and 2014
+        rx_hostname mpc1922:2012+mpc1922:2013+
+
+        # sets differernt destination udp ports
+        0:udp_dstport 50012
+        1:udp_dstport 50014
+
+        # source udp ips must be same subnet at destintaion udp ips
+        0:udp_srcip 192.168.1.112
+        1:udp_srcip 192.168.1.114
+
+        # destination udp ip picked up from rx_hostname (if auto)
+        udp_dstip auto
+
+        # set file path
+        fpath /tmp
+
+Receivers
+----------
+Same as if you would use an actual detector
+
+For a Single Module
+    .. code-block:: bash  
+
+        slsReceiver -t2012
+
+
+For Multiple Modules
+    .. code-block:: bash  
+
+        # slsMultiReceiver [starting port] [number of receivers] [print each frame header for debugging]
+        slsMultiReceiver 2012 2 0 
+
+Gui
+----
+| Same as if you would use an actual detector.
+| Compile with SLS_USE_GUI=ON in cmake or -g option in cmk.sh script.
+
+.. code-block:: bash  
+
+    slsDetectorGui
+
+Limitations
+-----------
+
+#. Data coming out of virtual server is fake. Value at each pixel/ channel is incremented by 1.
+
+#. A stop will stop the virtual acquisition only at the start of every new frame.
+
+#. Triggers are counted as number of virtual frames. trigger command to send a software trigger (Mythen3 & Eiger) is not implemented in virtual server.
+
+#. firmware version and serial number will give 0.

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/eiger_10Gb.config

@@ -1,33 +1,37 @@
-detsizechan 1024 512 
-#detetctor geometry, long side of the module first
+# detetctor geometry, long side of the module first
+detsize 1024 512 
+
+# detector hostname for controls
 hostname beb059+beb058+ 
-#1Gb detector hostname for controls
 
-0:rx_tcpport 1991 
-#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 
+# 1Gb receiver pc hostname with tcp port to configure receiver
+rx_hostname x12sa-vcons:1991+x12sa-vcons:1992
 
-1:rx_tcpport 1992 
-#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 
+# udp port first quadrant, first halfmodule         
+0:udp_dstport 50011 
 
-rx_hostname x12sa-vcons 
-#1Gb receiver pc hostname
+# udp port second quadrant, first halfmodule       
+0:udp_dstport2 50012 
 
-outdir /sls/X12SA/data/x12saop/Data10/Eiger0.5M
-threaded 1
+# udp IP of the receiver over 10Gb              
+0:udp_dstip 10.0.30.210 
+
+# first half module 10 Gb IP (same subnet as 0:udp_dstip)
+0:udp_srcip 10.0.30.100 
+
+# udp port first quadrant, second halfmodule       
+1:udp_dstport 50013 
+
+# udp port second quadrant, second halfmodule  
+1:udp_dstport2 50014 
+    
+# udp IP of the receiver over 10Gb, 
+1:udp_dstip 10.0.40.210  
+
+# second half module 10 Gb IP 
+# can be the same or different from 0:rx_udpip 
+# butsame subnet as 1:udp_dstip                              
+1:udp_srcip 10.0.40.101 
+
+# output directory
+fpath /sls/X12SA/data/x12saop/Data10/Eiger0.5M

examples/eiger_1Gb.config

@@ -1,24 +1,21 @@
-detsizechan 1024 512 
-#detetctor geometry, long side of the module first
+# detetctor geometry, long side of the module first
+detsize 1024 512 
+
+# detector hostname for controls
 hostname beb059+beb058+ 
-#1Gb detector hostname for controls
 
-0:rx_tcpport 1991 
-#tcpport for the first halfmodule                 
-0:rx_udpport 50011 
-#udp port first quadrant, first halfmodule         
-0:rx_udpport2 50012 
+# 1Gb receiver pc hostname with tcp port to configure receiver
+rx_hostname x12sa-vcons:1991+x12sa-vcons:1992
+
+# udp port first quadrant, first halfmodule         
+0:udp_dstport 50011 
 #udp port second quadrant, first halfmodule       
+0:udp_dstport2 50012 
 
-1:rx_tcpport 1992 
-#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  
+# udp port first quadrant, second halfmodule       
+1:udp_dstport 50013 
+# udp port second quadrant, second halfmodule  
+1:udp_dstport2 50014 
     
-rx_hostname x12sa-vcons 
-#1Gb receiver pc hostname
-
-outdir /sls/X12SA/data/x12saop/Data10/Eiger0.5M
-threaded 1
+# output directory
+fpath /sls/X12SA/data/x12saop/Data10/Eiger0.5M

examples/gotthard.config

@@ -1,27 +1,12 @@
+# detector hostname
 hostname bchip007
 
-#0:port 1952
-#0:stopport 1953
-#0:rx_tcpport 1956 must also have this in receiver config file
-0:angdir 1.000000
-0:moveflag 0.000000
-0:extsig:0 off
-#0:detectorip 129.129.202.9
-0:detectormac 00:aa:bb:cc:dd:ee
-0:rx_udpport 50004
-0:rx_udpip 129.129.202.98
-0:rx_hostname pc6898
-0:outdir /bigRAID/datadir_gotthard/rec_test_data
-0:vhighvoltage 120
-master -1
-sync none
-outdir /bigRAID/datadir_gotthard/rec_test_data
-headerbefore none
-headerafter none
-headerbeforepar none
-headerafterpar none
-badchannels none
-angconv none
-globaloff 0.000000
-binsize 0.001000
+# receiver pc hostname of 1Gb IP of the machine
+rx_hostname my_receiver_hostname
+
+# output directory
+fpath  /bigRAID/datadir_gotthard/rec_test_data
+
+# high voltage
+highvoltage 120
 

examples/gotthard2_veto_file.txt

@@ -0,0 +1,129 @@
+#Gain index    ADU value (12 bit)
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655
+1               3655

examples/gotthard2_veto_photon.txt

@@ -1,132 +1,129 @@
-#G1 Energy #G2 Energy
-300	7000
-
-#G0 pedestal    G1 pedestal    G2 pedestal    G0 gain    G1 gain    G2 gain (for every channel) ADU
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
-100        100        100        10        1        0.1
+#G0 pedestal    G1 pedestal    G2 pedestal    G0 gain    G1 gain    G2 gain     #G1 Energy      #G2 Energy
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000
+100             100             100             10        1             0.1     300	            7000

examples/gotthard_II.config

@@ -0,0 +1,34 @@
+# detector hostname
+hostname strip3
+
+# receiver pc hostname with tcp port
+rx_hostname pc12365:1982
+
+# udp source ip
+udp_srcip 10.1.1.184
+
+# udp destination ip (receiver interface ip)
+udp_dstip 10.1.1.107
+
+# only needed for debugging veto signals
+# udp destination port must be different from udp_dstport (default of 50001)
+udp_dstport2 50084
+udp_srcip2 10.1.1.185
+udp_dstip2 10.1.1.107
+
+# output directory
+fpath  /tmp
+
+# disable file writing
+fwrite 0
+
+# to enable 2nd interface for veto debugging
+numinterfaces 2
+
+# enable veto data streaming
+veto 1
+
+# Sampling pipeline 1 clk
+reg 0x120 0x00000010
+clkphase 1 135 deg
+

examples/gotthard_setup.det

@@ -1,32 +0,0 @@
-fname run
-index 0
-dr 16
-settings veryhighgain
-threshold 0
-exptime 0.000002990
-period 0.000024984
-delay 0.999999968
-gates 1
-frames 300000.000000000
-triggers 1.000000000
-timing auto
-fineoff 0.000000
-startscript none
-startscriptpar none
-stopscript none
-stopscriptpar none
-scriptbefore none
-scriptbeforepar none
-scriptafter none
-scriptafterpar none
-scan0script none
-scan0par none
-scan0prec 0
-scan0steps 0 
-scan1script none
-scan1par none
-scan1prec 0
-scan1steps 0 
-ratecorr 0.000000
-flatfield none
-badchannels none

examples/gotthard_two.config

@@ -1,17 +1,17 @@
-detsizechan 2560 1
-
+# detector hostname
 hostname bchip074+bchip075+
 
+# receiver pc hostname of 1Gb IP of the machine (with tcpport)
+rx_hostname my_receiver_hostname+my_receiver_hostname:1955
 
-0:extsig:0 trigger_in_rising_edge
-0:rx_tcpport 1954
-0:rx_udpport 50001
-0:vhighvoltage 0
+# default udp destination port 50001
+1:udp_dstport 50002
 
-1:extsig:0 trigger_in_rising_edge
-1:rx_tcpport 1955
-1:rx_udpport 50002
-1:vhighvoltage 0
+# output directory
+fpath  /tmp
+
+extsig 0 trigger_in_rising_edge
+highvoltage 0
 
 ##############################################################################
 #########
@@ -19,39 +19,27 @@ hostname bchip074+bchip075+
 #########
 ##############################################################################
 
-# #replace my_receiver_hostname with the hostname of IP of the machine where the receiver runs
-#0:rx_zmqip my_receiver_hostname 
-#0:rx_zmqport 30003
-# #replace my_client_hostname with the hostname of IP of the machine where the client/GUI or softIOC runs
-#0:zmqip my_client_hostname 
-#0:zmqport  40003
+## receiver pc hostname of 1Gb IP of the machine
+#rx_zmqip my_receiver_hostname 
+## client/gui or softIOc pc hostname
+#zmqip my_client_hostname 
 
-# #replace my_receiver_hostname with the hostname of IP of the machine where the receiver runs
-#1:rx_zmqip my_receiver_hostname 
+## rxr zmq streaming out port
+#0:rx_zmqport 30003
+## client zmq listening port
+#0:zmqport  40003
+## rxr zmq streaming out port
 #1:rx_zmqport 30004
-# #replace my_client_hostname with the hostname of IP of the machine where the client/GUI or softIOC runs
-#1:zmqip  my_client_hostname 
+## client zmq listening port
 #1:zmqport  40004
 
+## stream out every frame via zmq
+#rx_zmqfreq 1
+## enable zmq streaming
+#rx_zmqstream 1
+
 ##############################################################################
 #########
 ######### until here
 #########
 ##############################################################################
-
-
-r_readfreq 1
-rx_datastream 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
-outdir /tmp/
-
-
-settings veryhighgain
-exptime 0.000005
-period 0.0001
-
-vhighvoltage 90
-

examples/jctb_moench03_T1.config

@@ -8,8 +8,6 @@ adcclk 20
 dbitclk 40
 
 
-
-
 patword 0000 0000000000000000
 patword 0001 0000000000000000
 patword 0002 0008000900080000
@@ -424,21 +422,24 @@ patwaittime1 0
 patwait2 0400
 patwaittime2 0
 
-
-#0:rx_tcpport 1977
+#############################################
+### edit with hostname or 1Gbs IP address of your server
+############################################
+rx_hostname mpc2011
+#rx_hostname mpc2011:1977
 
 #############################################
 ### edit with 10 Gbs IP of your server
 ############################################
-0:udp_dstip 10.1.1.102
-#0:udp_dstip 129.129.202.136
+udp_dstip 10.1.1.102
+#udp_dstip 129.129.202.136
 #############################################
 ### edit with any number in the subnet of your server (first 3 numbers as above)
 ############################################
-0:udp_srcip 10.1.1.19
-#0:udp_srcip 129.129.202.13
+udp_srcip 10.1.1.19
+#udp_srcip 129.129.202.13
 
-0:udp_dstport 33410
+udp_dstport 33410
 #############################################
 ### edit with 10 Gbs IP of your server
 ############################################
@@ -452,15 +453,9 @@ patwaittime2 0
 #zmqport 50001
 
 
-#############################################
-### edit with hostname or 1Gbs IP address of your server
-############################################
-rx_hostname mpc2011
-
 tengiga 1
-
-rx_datastream 1
-rx_readfreq 1
+rx_zmqstream 1
+rx_zmqfreq 1
 
 
 dac 6 800
@@ -496,6 +491,5 @@ rx_jsonpara detectorMode analog
 #flags newpedestal
 #flags analog
 
-reg 0x5e 0x00010000
-#powerchip 1
-vhighvoltage 90
+powerchip 1
+highvoltage 90

examples/jungfrau.config

@@ -1,16 +1,41 @@
-hostname localhost
+# detector hostname
+hostname bchip052
 
-0:rx_udpport 50004
-0:rx_udpip 172.24.8.84
-0:detectorip 172.24.8.254
-rx_hostname localhost
+# 1Gb receiver pc hostname (default tcpport: 1954)
+rx_hostname pcmoench01
 
-#powerchip 1
-#vhighvoltage 200
+# udp destination port (receiver)
+udp_dstport 50004
 
-#extsig:0 trigger_in_rising_edge
-#timing trigger
+# udp destination ip (receiver)
+#udp_dstip 172.24.8.84
+# or to get ip from rx_hostname
+udp_dstip auto 
 
-outdir /tmp/slsdetector
+# udp source ip (same subnet as udp_dstip)
+udp_srcip 172.24.8.254
 
 
+# PCBv2.0 (using 2 interfaces)
+udp_dstport2 50005
+udp_dstip2 auto 
+udp_srcip2 172.24.8.111
+# enable two interfaces
+numinterfaces 2
+# select inner interface(effective only when numinterfaces is 1)
+#selinterface 1
+
+# power on chip
+powerchip 1
+
+# high voltage
+highvoltage 200
+
+# timing to trigger
+timing trigger
+
+# output file directory
+fpath /external_pool/jungfrau_data/softwaretest
+
+# disable file writing
+fwrite 0

examples/jungfrau_two.config

@@ -1,26 +1,49 @@
-detsizechan 1024 1024
+# detector geometry x, y
+detsize 1024 1024
+
+# detector hostname
 hostname bchip048+bchip052+
 
-0:rx_udpport 50004
-0:rx_udpip 10.1.1.100
-0:rx_udpmac F4:52:14:2F:32:00
-0:detectorip 10.1.1.10
-0:detectormac 00:aa:bb:cc:dd:33
+# 1Gb receiver pc hostname  (default tcpport: 1954)
+rx_hostname pcmoench01+pcmoench01:1955
 
-1:rx_tcpport 1955
-1:rx_udpport 50005
-1:rx_udpip 10.1.1.100
-1:rx_udpmac F4:52:14:2F:32:00
-1:detectorip 10.1.1.11
-1:detectormac 00:aa:bb:cc:dd:33
 
-rx_hostname pcmoench01
 
+# udp configurations for 1st module
+# udp destination port (receiver)
+0:udp_dstport 50004
+
+# udp destination ip (receiver)
+0:udp_dstip 10.1.1.100
+
+# udp source ip (same subnet as 0:udp_dstip)
+0:udp_srcip 10.1.1.10
+
+
+
+# udp configurations for 2nd module
+# udp destination port (receiver)
+1:udp_dstport 50005
+
+# udp destination ip (receiver)
+1:udp_dstip 10.1.1.100
+
+# udp source ip (same subnet as 1:udp_dstip)
+1:udp_srcip 10.1.1.11
+
+
+
+# power on chip
 powerchip 1
-vhighvoltage 200
-#extsig:0 trigger_in_rising_edge
-#timing trigger
 
-outdir /external_pool/jungfrau_data/softwaretest
+# high voltage
+highvoltage 200
 
+# timing to trigger
+timing trigger
 
+# output file directory
+fpath /external_pool/jungfrau_data/softwaretest
+
+# disable file writing
+fwrite 0

examples/measurement_setup.det

@@ -0,0 +1,32 @@
+# file name prefix
+fname measurement1
+
+# file acquisition index
+findex 3000
+
+# dynamic range (only for Mythen3 and Eiger)
+dr 32
+
+# settings 
+settings veryhighgain
+
+# exposure time
+exptime 100us
+
+# period
+period 2ms
+
+# frames per trigger
+frames 30000
+
+# timing mode
+timing trigger
+
+# triggers
+triggers 10
+
+# delay after trigger
+delay 1ms
+
+
+

examples/moench03_T1.config

@@ -9,7 +9,6 @@ hostname bchip181+
 ############################################
 rx_hostname mpc2011
 
-rx_tcpport 1954
 #############################################
 ### edit with 10 Gbs IP of your server
 ############################################
@@ -33,20 +32,20 @@ zmqport 50001
 
 
 
-
 tengiga 1
-rx_datastream 1
+rx_zmqstream 1
 
 
 
 frames 100000
 period 0.0006
+
 #############################################
 ### edit with directory you want to write to
 ############################################
 fpath /mnt/moench_data/scratch/
+
 fwrite 0
-rx_datastream 1
 
 rx_jsonpara frameMode frame
 rx_jsonpara detectorMode counting
@@ -56,7 +55,7 @@ rx_discardpolicy discardpartial
 adcpipeline 15
 
 powerchip 1
-vhighvoltage 90
+highvoltage 90
 
 #adcreg 0x14 0x40
 

examples/two_gotthard.config

@@ -1,55 +0,0 @@
-#####Any line with a # is not read######
-
-detsizechan 2560 1
-
-hostname bchip007+bchip009+
-
-#0:hostname bchip007
-#0:port 1952
-#0:stopport 1953
-#0:rx_tcpport 1956 
-0:angdir 1.000000
-0:moveflag 0.000000
-0:ffdir /home/l_msdetect
-0:extsig:0 off
-
-0:detectorip 10.1.1.2
-#0:detectormac 00:aa:bb:cc:dd:ee
-#0:rx_udpport 50001
-0:rx_udpip 10.1.1.1
-0:rx_hostname 129.129.202.134 
-0:outdir /data/speedt
-0:vhighvoltage 120
-
-
-#1:hostname bchip009
-#1:port 1952
-#1:stopport 1953
-1:rx_tcpport 1957
-1:angdir 1.000000
-1:moveflag 0.000000
-1:ffdir /home/l_msdetect
-1:extsig:0 off
-
-1:detectorip 10.1.2.2
-#1:detectormac 00:aa:bb:cc:dd:ee
-1:rx_udpport 50004
-1:rx_udpip 10.1.2.1
-1:rx_hostname 129.129.202.134 
-1:outdir /data/speedt
-1:vhighvoltage 120
-
-
-master -1
-sync none
-outdir /data/speedt
-ffdir /home/l_msdetect
-headerbefore none
-headerafter none
-headerbeforepar none
-headerafterpar none
-badchannels none
-angconv none
-globaloff 0.000000
-binsize 0.001000
-

examples/virtual_ctb_moench.config

@@ -0,0 +1,477 @@
+# detector hostname
+hostname localhost:1910
+
+# receiver hostname
+rx_hostname mpc1922:2010
+
+# udp destination ports
+udp_dstport 50010
+
+# udp destination ip from rx_hostname
+udp_dstip auto
+
+# udp source ip (same subnet as udp_dstip)
+udp_srcip 192.168.1.100
+
+# output file directory
+fpath /tmp
+
+# disable file writing
+fwrite 0
+
+
+# default clocks
+runclk 40
+adcclk 20
+dbitclk 40
+
+
+# patterns
+patword 0x0000 0x0000000000000000
+patword 0x0001 0x0000000000000000
+patword 0x0002 0x0008000900080000
+patword 0x0003 0x0008000900080000
+patword 0x0004 0x0008000900080000
+patword 0x0005 0x0008000900080000
+patword 0x0006 0x0008000900080000
+patword 0x0007 0x0008000900080000
+patword 0x0008 0x0008000900080000
+patword 0x0009 0x0008000900080000
+patword 0x000a 0x0008000900080000
+patword 0x000b 0x0008000900080000
+patword 0x000c 0x0008000900080000
+patword 0x000d 0x0008000900080000
+patword 0x000e 0x0008000900080000
+patword 0x000f 0x0008000900080000
+patword 0x0010 0x0008000900080000
+patword 0x0011 0x0008000900080000
+patword 0x0012 0x0008000900080000
+patword 0x0013 0x0008000900080000
+patword 0x0014 0x0008000900080000
+patword 0x0015 0x0008000900080000
+patword 0x0016 0x0008400900080020
+patword 0x0017 0x0008400900080020
+patword 0x0018 0x0008599f0418503a
+patword 0x0019 0x0008599f0418503a
+patword 0x001a 0x0108599f0418503a
+patword 0x001b 0x0108599f0418503a
+patword 0x001c 0x0108599f0418503a
+patword 0x001d 0x0108599f0418503a
+patword 0x001e 0x0108599f0418503a
+patword 0x001f 0x0108599f0418503a
+patword 0x0020 0x0108599f0418503a
+patword 0x0021 0x0108599f0418503a
+patword 0x0022 0x0108599f0418503a
+patword 0x0023 0x0108599f0418503a
+patword 0x0024 0x0108599f0418503a
+patword 0x0025 0x0108599f0418503a
+patword 0x0026 0x0108599f0418503a
+patword 0x0027 0x0108599f0418503a
+patword 0x0028 0x0108599f0418503a
+patword 0x0029 0x0108599f0418503a
+patword 0x002a 0x0108599f0418503a
+patword 0x002b 0x0108599f0418503a
+patword 0x002c 0x0108599f0418503a
+patword 0x002d 0x0108599f0418503a
+patword 0x002e 0x0108599f0418503a
+patword 0x002f 0x0108599f0418503a
+patword 0x0030 0x0108599f0418503a
+patword 0x0031 0x0108599f0418503a
+patword 0x0032 0x0108599f0418503a
+patword 0x0033 0x0108599f0418503a
+patword 0x0034 0x0108599f0418503a
+patword 0x0035 0x0108599f0418503a
+patword 0x0036 0x0108599f0418503a
+patword 0x0037 0x0108599f0418503a
+patword 0x0038 0x0108599f0418503a
+patword 0x0039 0x0108599f0418503a
+patword 0x003a 0x0108599f0418503a
+patword 0x003b 0x0108599f0418503a
+patword 0x003c 0x0108599f0418503a
+patword 0x003d 0x0108599f0418503a
+patword 0x003e 0x0108599f0418503a
+patword 0x003f 0x0108599f0418503a
+patword 0x0040 0x0108599f0418503a
+patword 0x0041 0x0108599f0418503a
+patword 0x0042 0x0108599f0418503a
+patword 0x0043 0x0108599f0418503a
+patword 0x0044 0x0108599f0418503a
+patword 0x0045 0x0108599f0418503a
+patword 0x0046 0x0108599f0418503a
+patword 0x0047 0x0108599f0418503a
+patword 0x0048 0x0108599f0418503a
+patword 0x0049 0x0108599f0418503a
+patword 0x004a 0x0108599f0418503a
+patword 0x004b 0x0108599f0418503a
+patword 0x004c 0x0108599f0418503a
+patword 0x004d 0x0108599f0418503a
+patword 0x004e 0x0108599f0418503a
+patword 0x004f 0x0108599f0418503a
+patword 0x0050 0x0108599f0418503a
+patword 0x0051 0x0108599f0418503a
+patword 0x0052 0x0108599f0418503a
+patword 0x0053 0x0108599f0418503a
+patword 0x0054 0x0108599f0418503a
+patword 0x0055 0x0108599f0418503a
+patword 0x0056 0x0108599f0418503a
+patword 0x0057 0x0108599f0418503a
+patword 0x0058 0x0108599f0418503a
+patword 0x0059 0x0108599f0418503a
+patword 0x005a 0x0108599f0418503a
+patword 0x005b 0x0108599f0418503a
+patword 0x005c 0x0108599f0418503a
+patword 0x005d 0x0108599f0418503a
+patword 0x005e 0x0108599f0418503a
+patword 0x005f 0x0108599f0418503a
+patword 0x0060 0x0108599f0418503a
+patword 0x0061 0x0108599f0418503a
+patword 0x0062 0x0108599f0418503a
+patword 0x0063 0x0108599f0418503a
+patword 0x0064 0x0108599f0418503a
+patword 0x0065 0x0108599f0418503a
+patword 0x0066 0x0108599f0418503a
+patword 0x0067 0x0108599f0418503a
+patword 0x0068 0x0108599f0418503a
+patword 0x0069 0x0108599f0418503a
+patword 0x006a 0x0108599f0418503a
+patword 0x006b 0x0108599f0418503a
+patword 0x006c 0x0108599f0418503a
+patword 0x006d 0x0108599f0418503a
+patword 0x006e 0x0108599f0418503a
+patword 0x006f 0x0108599f0418503a
+patword 0x0070 0x0108599f0418503a
+patword 0x0071 0x0108599f0418503a
+patword 0x0072 0x0108599f0418503a
+patword 0x0073 0x0108599f0418503a
+patword 0x0074 0x0108599f0418503a
+patword 0x0075 0x0108599f0418503a
+patword 0x0076 0x0108599f0418503a
+patword 0x0077 0x0108599f0418503a
+patword 0x0078 0x0108599f0418503a
+patword 0x0079 0x0108599f0418503a
+patword 0x007a 0x0108599f0418503a
+patword 0x007b 0x0108599f0418503a
+patword 0x007c 0x0108599f0418503a
+patword 0x007d 0x0108599f0418503a
+patword 0x007e 0x010859960418503a
+patword 0x007f 0x010859960418503a
+patword 0x0080 0x010859960418503a
+patword 0x0081 0x010859960418503a
+patword 0x0082 0x010859960418503a
+patword 0x0083 0x010859960418503a
+patword 0x0084 0x010859960418503a
+patword 0x0085 0x010859960418503a
+patword 0x0086 0x010859960418503a
+patword 0x0087 0x010859960418503a
+patword 0x0088 0x010859960418503a
+patword 0x0089 0x010859960418503a
+patword 0x008a 0x010859960418503a
+patword 0x008b 0x010859960418503a
+patword 0x008c 0x010859960418503a
+patword 0x008d 0x010859960418503a
+patword 0x008e 0x010859960418503a
+patword 0x008f 0x010859960418503a
+patword 0x0090 0x010859960418503a
+patword 0x0091 0x010859960418503a
+patword 0x0092 0x010819960418501a
+patword 0x0093 0x010819960418501a
+patword 0x0094 0x010819960418501a
+patword 0x0095 0x010819960418501a
+patword 0x0096 0x030819960418501a
+patword 0x0097 0x030819960418501a
+patword 0x0098 0x030819960418501a
+patword 0x0099 0x030819960418501a
+patword 0x009a 0x030819960418501a
+patword 0x009b 0x030819960418501a
+patword 0x009c 0x030819960418501a
+patword 0x009d 0x030819960418501a
+patword 0x009e 0x030819960418501a
+patword 0x009f 0x030819960418501a
+patword 0x00a0 0x030819960418501a
+patword 0x00a1 0x030819960418501a
+patword 0x00a2 0x030819960418501a
+patword 0x00a3 0x030819960418501a
+patword 0x00a4 0x030819960418501a
+patword 0x00a5 0x030819960418501a
+patword 0x00a6 0x030819960418501a
+patword 0x00a7 0x030819960418501a
+patword 0x00a8 0x030819960418501a
+patword 0x00a9 0x030819960418501a
+patword 0x00aa 0x030819960418501a
+patword 0x00ab 0x030819960418501a
+patword 0x00ac 0x030819960008501a
+patword 0x00ad 0x030819960008501a
+patword 0x00ae 0x030819960008501a
+patword 0x00af 0x030819960008501a
+patword 0x00b0 0x030819960008501a
+patword 0x00b1 0x030819960008501a
+patword 0x00b2 0x030819960008501a
+patword 0x00b3 0x030819960008501a
+patword 0x00b4 0x030819960008501a
+patword 0x00b5 0x030819960008501a
+patword 0x00b6 0x030819960008501a
+patword 0x00b7 0x030819960008501a
+patword 0x00b8 0x030819960008501a
+patword 0x00b9 0x030819960008501a
+patword 0x00ba 0x030819960008501a
+patword 0x00bb 0x030819960008501a
+patword 0x00bc 0x030819960008501a
+patword 0x00bd 0x030819960008501a
+patword 0x00be 0x030819960008501a
+patword 0x00bf 0x030819960008501a
+patword 0x00c0 0x0308199f0008501a
+patword 0x00c1 0x0308199f0008501a
+patword 0x00c2 0x0308199f0008501a
+patword 0x00c3 0x0308199f0008501a
+patword 0x00c4 0x0308199f0008501a
+patword 0x00c5 0x0308199f0008501a
+patword 0x00c6 0x0308199f0008501a
+patword 0x00c7 0x0308199f0008501a
+patword 0x00c8 0x0308199f0008501a
+patword 0x00c9 0x0308199f0008501a
+patword 0x00ca 0x0308199f0008501a
+patword 0x00cb 0x0308199f0008501a
+patword 0x00cc 0x0308199f0008501a
+patword 0x00cd 0x0308199f0008501a
+patword 0x00ce 0x0308199f0008501a
+patword 0x00cf 0x0308199f0008501a
+patword 0x00d0 0x0308199f0008501a
+patword 0x00d1 0x0308199f0008501a
+patword 0x00d2 0x0308199f0008501a
+patword 0x00d3 0x0308199f0008501a
+patword 0x00d4 0x0308599f0008503a
+patword 0x00d5 0x0308599f0008503a
+patword 0x00d6 0x030c599f000850ba
+patword 0x00d7 0x030c599f000850ba
+patword 0x00d8 0x030c599f000850ba
+patword 0x00d9 0x030c599f000850ba
+patword 0x00da 0x030c599f000850ba
+patword 0x00db 0x030c599f000850ba
+patword 0x00dc 0x030c599f000850ba
+patword 0x00dd 0x030c599f000850ba
+patword 0x00de 0x030c599f000850ba
+patword 0x00df 0x030c599f000850ba
+patword 0x00e0 0x030c599f000850ba
+patword 0x00e1 0x030c599f000850ba
+patword 0x00e2 0x030c599f000850ba
+patword 0x00e3 0x030c599f000850ba
+patword 0x00e4 0x030c599f000850ba
+patword 0x00e5 0x030c599f000850ba
+patword 0x00e6 0x030c599f000850ba
+patword 0x00e7 0x030c599f000850ba
+patword 0x00e8 0x030c599f000850ba
+patword 0x00e9 0x030c599f000850ba
+patword 0x00ea 0x030c799f010858ba
+patword 0x00eb 0x030c799f010858ba
+patword 0x00ec 0x030c599f000850ba
+patword 0x00ed 0x030c599f000850ba
+patword 0x00ee 0x030c599f000850ba
+patword 0x00ef 0x030c599f000850ba
+patword 0x00f0 0x030c599f000850ba
+patword 0x00f1 0x030c599f000850ba
+patword 0x00f2 0x030c599f000850ba
+patword 0x00f3 0x030c599f000850ba
+patword 0x00f4 0x030c599f000850ba
+patword 0x00f5 0x030c599f000850ba
+patword 0x00f6 0x030c599f000850ba
+patword 0x00f7 0x030c599f000850ba
+patword 0x00f8 0x030c599f000850ba
+patword 0x00f9 0x030c599f000850ba
+patword 0x00fa 0x030c599f000850ba
+patword 0x00fb 0x030c599f000850ba
+patword 0x00fc 0x030c599f000850ba
+patword 0x00fd 0x030c599f000850ba
+patword 0x00fe 0x030c599f000850ba
+patword 0x00ff 0x030c599f000850ba
+patword 0x0100 0x030c599f000850ba
+patword 0x0101 0x030c599f000850ba
+patword 0x0102 0x030c599f400850ba
+patword 0x0103 0x030c599f400850ba
+patword 0x0104 0x030c599f600850ba
+patword 0x0105 0x030c599f400850ba
+patword 0x0106 0x030c599f400850ba
+patword 0x0107 0x030c599f400850ba
+patword 0x0108 0x870c599f682e50ba
+patword 0x0109 0x870c599f482850ba
+patword 0x010a 0x870c599f000e50ba
+patword 0x010b 0x870c599f000850ba
+patword 0x010c 0x870c599f000e50ba
+patword 0x010d 0x870c599f000850ba
+patword 0x010e 0x870c599f000e50ba
+patword 0x010f 0x870c599f000850ba
+patword 0x0110 0x870c599f000e50ba
+patword 0x0111 0x870c599f000850ba
+patword 0x0112 0x870c599f000e50ba
+patword 0x0113 0x870c599f000850ba
+patword 0x0114 0x870c599f000e50ba
+patword 0x0115 0x870c599f000850ba
+patword 0x0116 0x870c599f000e50ba
+patword 0x0117 0x870c599f000850ba
+patword 0x0118 0x870c599f000e50ba
+patword 0x0119 0x870c599f000850ba
+patword 0x011a 0x870c599f000e50ba
+patword 0x011b 0x870c599f000850ba
+patword 0x011c 0x870c599f000e50ba
+patword 0x011d 0x870c599f000850ba
+patword 0x011e 0x870c599f000e50ba
+patword 0x011f 0x870c599f000850ba
+patword 0x0120 0x870c599f000e50ba
+patword 0x0121 0x870c599f000850ba
+patword 0x0122 0x870c599f200e50ba
+patword 0x0123 0x870c599f000850ba
+patword 0x0124 0x870c599f000e50ba
+patword 0x0125 0x870c599f000850ba
+patword 0x0126 0x870c599f000e50ba
+patword 0x0127 0x870c599f000850ba
+patword 0x0128 0x870c599f000e50ba
+patword 0x0129 0x870c599f000850ba
+patword 0x012a 0x870c599f000e50ba
+patword 0x012b 0x870c599f000850ba
+patword 0x012c 0x870c599f000e50ba
+patword 0x012d 0x870c599f000850ba
+patword 0x012e 0x870c599f000e50ba
+patword 0x012f 0x870c599f000850ba
+patword 0x0130 0x870c599f000e50ba
+patword 0x0131 0x870c599f000850ba
+patword 0x0132 0x870c599f000e50ba
+patword 0x0133 0x870c599f000850ba
+patword 0x0134 0x870c599f000e50ba
+patword 0x0135 0x870c599f000850ba
+patword 0x0136 0x870c599f000e50ba
+patword 0x0137 0x870c599f000850ba
+patword 0x0138 0x870c599f000e50ba
+patword 0x0139 0x870c599f000850ba
+patword 0x013a 0x870c599f282e50ba
+patword 0x013b 0x870c599f082850ba
+patword 0x013c 0x870c599f000e50ba
+patword 0x013d 0x870c599f000850ba
+patword 0x013e 0x870c599f000e50ba
+patword 0x013f 0x870c599f000850ba
+patword 0x0140 0x870c599f000e50ba
+patword 0x0141 0x870c599f000850ba
+patword 0x0142 0x870c599f000e50ba
+patword 0x0143 0x870c599f000850ba
+patword 0x0144 0x870c599f000e50ba
+patword 0x0145 0x870c599f000850ba
+patword 0x0146 0x870c599f000e50ba
+patword 0x0147 0x870c599f000850ba
+patword 0x0148 0x870c599f000e50ba
+patword 0x0149 0x870c599f000850ba
+patword 0x014a 0x870c599f000e50ba
+patword 0x014b 0x870c599f000850ba
+patword 0x014c 0x870c599f000e50ba
+patword 0x014d 0x870c599f000850ba
+patword 0x014e 0x870c599f000e50ba
+patword 0x014f 0x870c599f000850ba
+patword 0x0150 0x870c599f000e50ba
+patword 0x0151 0x870c599f000850ba
+patword 0x0152 0x870c599f000e50ba
+patword 0x0153 0x870c599f000850ba
+patword 0x0154 0x870c599f200e50ba
+patword 0x0155 0x870c599f000850ba
+patword 0x0156 0x870c599f000e50ba
+patword 0x0157 0x870c599f000850ba
+patword 0x0158 0x870c599f000e50ba
+patword 0x0159 0x870c599f000850ba
+patword 0x015a 0x870c599f000e50ba
+patword 0x015b 0x870c599f000850ba
+patword 0x015c 0x870c599f000e50ba
+patword 0x015d 0x870c599f000850ba
+patword 0x015e 0x870c599f000e50ba
+patword 0x015f 0x870c599f000850ba
+patword 0x0160 0x870c599f000e50ba
+patword 0x0161 0x870c599f000850ba
+patword 0x0162 0x870c599f000e50ba
+patword 0x0163 0x870c599f000850ba
+patword 0x0164 0x870c599f000e50ba
+patword 0x0165 0x870c599f000850ba
+patword 0x0166 0x870c599f000e50ba
+patword 0x0167 0x870c599f000850ba
+patword 0x0168 0x870c599f000e50ba
+patword 0x0169 0x870c599f000850ba
+patword 0x016a 0x870c599f000e50ba
+patword 0x016b 0x870c599f000850ba
+patword 0x016c 0x070c599f000850ba
+patword 0x016d 0x070c599f000850ba
+patword 0x016e 0x000c599f000850ba
+patword 0x016f 0x000c599f000850ba
+patword 0x0170 0x0008599f200e503a
+patword 0x0171 0x0008599f0008503a
+patword 0x0172 0x0008599f200e503a
+patword 0x0173 0x0008599f0008503a
+patword 0x0174 0x0008599f0008503a
+patword 0x0175 0x0008599f0008503a
+patword 0x0176 0x0008599f0008503a
+patword 0x0177 0x0008599f0008503a
+patword 0x0178 0x0008599f0008503a
+patword 0x0179 0x0008599f0008503a
+patword 0x017a 0x0008599f0008503a
+patword 0x017b 0x0008599f0008503a
+patword 0x017c 0x0008599f0008503a
+patword 0x017d 0x0008599f0008503a
+patword 0x017e 0x0008599f0008503a
+patword 0x017f 0x0008599f0008503a
+patword 0x0180 0x0008599f0008503a
+patword 0x0181 0x0008599f0008503a
+patword 0x0182 0x0008599f0008503a
+patword 0x0183 0x0008599f0008503a
+patword 0x0184 0x0008599f0008503a
+patword 0x0185 0x0008599f0008503a
+patword 0x0186 0x0008599f0008503a
+patword 0x0187 0x0008599f0008503a
+patword 0x0188 0x0008599f0008503a
+patword 0x0189 0x0008599f0008503a
+patword 0x018a 0x0008599f0008503a
+patword 0x018b 0x0008599f0008503a
+patword 0x018c 0x0008599f0008503a
+patword 0x018d 0x0008599f0008503a
+patioctrl 0x8f0effff6dbffdbf
+patlimits 0x0000 0x018c
+patloop0 0x013a 0x016b
+patnloop0 0x199
+patloop1 0x0400 0x0400
+patnloop1 0
+patloop2 0x0400 0x0400
+patnloop2 0
+patwait0 0x00aa
+patwaittime0 10000
+patwait1 0x0400
+patwaittime1 0
+patwait2 0x0400
+patwaittime2 0
+
+# dacs
+dac 6 800
+dac 0 1300
+dac 4 1428
+dac 1 1000
+dac 7 900
+dac 3 680
+dac 2 1400
+dac 5 1200
+
+
+adcinvert 4a342593
+
+# analog samples
+asamples 5000
+
+# digital samples
+dsamples 0
+
+# adc phase
+adcphase 30 deg
+
+# adc pipeline
+adcpipeline 14
+
+# analog readout
+romode analog
+
+# frames
+frames 1
+
+# period
+period 1ms
+
+

examples/virtual_eiger_1_half_module.config

@@ -0,0 +1,22 @@
+# detector hostname
+hostname localhost:1900
+
+# receiver hostname
+rx_hostname mpc1922:2000
+
+# udp destination ports
+udp_dstport 50000
+udp_dstport2 50001
+
+# udp destination ip from rx_hostname
+udp_dstip auto
+
+# output file directory
+fpath /tmp
+
+# disable file writing
+fwrite 0
+
+#imagetest 1
+
+

examples/virtual_eiger_2_half_modules.config

@@ -0,0 +1,23 @@
+# detector hostname
+hostname localhost:1900+localhost:1902+
+
+# receiver hostname
+rx_hostname mpc1922:2000+mpc1922:2001+
+
+# udp destination ports
+0:udp_dstport 50000
+0:udp_dstport2 50001
+1:udp_dstport 50002
+1:udp_dstport2 50003
+
+# udp destination ip from rx_hostname
+udp_dstip auto
+
+# output file directory
+fpath /tmp
+
+# disable file writing
+fwrite 0
+
+#imagetest 1
+

examples/virtual_gotthard.config

@@ -0,0 +1,23 @@
+# detector hostname
+hostname localhost:1904
+
+# receiver hostname
+rx_hostname mpc1922:2004
+
+# udp destination ports
+udp_dstport 50004
+
+# udp destination ip from rx_hostname
+udp_dstip auto
+
+# udp source ip (same subnet as udp_dstip)
+udp_srcip 192.168.1.100
+
+# output file directory
+fpath /tmp
+
+# disable file writing
+fwrite 0
+
+
+

examples/virtual_gotthard2.config

@@ -0,0 +1,37 @@
+# detector hostname
+hostname localhost:1914
+
+# receiver hostname
+rx_hostname mpc1922:2014
+
+# udp destination ports
+udp_dstport 50014
+
+# udp destination ip from rx_hostname
+udp_dstip auto
+
+# udp source ip (same subnet as udp_dstip)
+udp_srcip 192.168.1.100
+
+# output file directory
+fpath /tmp
+
+# disable file writing
+fwrite 0
+
+# enable 2nd interface for veto debugging
+# udp destination port for veto
+udp_dstport2 50015
+# udp destination ip (from rx_hostname)
+udp_dstip2 auto
+# udp source ip (same subnet as udp_dstip)
+udp_srcip2 192.168.1.100
+
+# to enable 2nd interface for veto debugging
+numinterfaces 2
+
+# enable veto data streaming
+veto 1
+
+
+

examples/virtual_jungfrau.config

@@ -0,0 +1,32 @@
+# detector hostname
+hostname localhost:1906
+
+# receiver hostname
+rx_hostname mpc1922:2006
+
+# udp destination ports
+udp_dstport 50006
+udp_dstport2 50007
+
+# udp destination ip from rx_hostname
+udp_dstip auto
+udp_dstip2 auto
+
+# udp source ip (same subnet as udp_dstip)
+udp_srcip 192.168.1.100
+udp_srcip2 192.168.1.100
+
+# output file directory
+fpath /tmp
+
+# disable file writing
+fwrite 0
+
+#imagetest 1
+#frames 1
+
+# enable two interfaces
+numinterfaces 2
+
+# select inner interface(effective only when numinterfaces is 1)
+#selinterface 1

examples/virtual_jungfrau_4.config

@@ -0,0 +1,47 @@
+# detector geometry
+detsize 2048 1024
+
+# detector hostname
+virtual 4 1952
+
+# receiver hostname and tcpports
+0:rx_tcpport 1970
+1:rx_tcpport 1971
+2:rx_tcpport 1972
+3:rx_tcpport 1973
+rx_hostname mpc1922
+
+# udp destination ports
+0:udp_dstport2 50001
+0:udp_dstport2 50002
+1:udp_dstport 50003
+1:udp_dstport2 50004
+2:udp_dstport 50005
+2:udp_dstport2 50006
+3:udp_dstport 50007
+3:udp_dstport2 50008
+
+# udp destination ip from rx_hostname
+udp_dstip auto
+udp_dstip2 auto
+
+# udp source ip (same subnet as udp_dstip)
+udp_srcip 192.168.1.100
+udp_srcip2 192.168.1.100
+
+# transmission delay frame
+0:txndelay_frame 0
+1:txndelay_frame 1
+2:txndelay_frame 2
+3:txndelay_frame 3
+
+# output file directory
+fpath /tmp
+
+# disable file writing
+fwrite 0
+
+#imagetest 1
+#frames 1
+
+

examples/virtual_moench.config

@@ -0,0 +1,21 @@
+# detector hostname
+hostname localhost:1908
+
+# receiver hostname
+rx_hostname mpc1922:2008
+
+# udp destination ports
+udp_dstport 50008
+
+# udp destination ip from rx_hostname
+udp_dstip auto
+
+# udp source ip (same subnet as udp_dstip)
+udp_srcip 192.168.1.100
+
+# output file directory
+fpath /tmp
+
+# disable file writing
+fwrite 0
+

examples/virtual_mythen3.config

@@ -0,0 +1,24 @@
+# detector hostname
+hostname localhost:1912
+
+# receiver hostname
+rx_hostname mpc1922:2012
+
+# udp destination ports
+udp_dstport 50012
+
+# udp destination ip from rx_hostname
+udp_dstip auto
+
+# udp source ip (same subnet as udp_dstip)
+udp_srcip 192.168.1.100
+
+# output file directory
+fpath /tmp
+
+# disable file writing
+fwrite 0
+
+# load ascii pattern file
+#pattern ../pat.txt
+

integrationTests/test-eigerIntegration.cpp

@@ -1,5 +1,5 @@
-#include "catch.hpp"
 #include "DetectorImpl.h"
+#include "catch.hpp"
 #include "string_utils.h"
 #include "tests/globals.h"
 #include <iostream>

integrationTests/test-integrationDectector.cpp

@@ -2,9 +2,9 @@
 #include "catch.hpp"
 
 #include "ClientSocket.h"
-#include "logger.h"
 #include "DetectorImpl.h"
 #include "Module.h"
+#include "logger.h"
 #include "sls_detector_defs.h"
 
 #include "Timer.h"
@@ -79,7 +79,6 @@ TEST_CASE("Set control port then create a new object with this control port",
     d.freeSharedMemory();
 }
 
-
 TEST_CASE("single EIGER detector no receiver basic set and get",
           "[.integration][eiger]") {
     // TODO! this test should take command line arguments for config
@@ -130,8 +129,6 @@ TEST_CASE("single EIGER detector no receiver basic set and get",
     d.freeSharedMemory();
 }
 
-
-
 TEST_CASE("Locking mechanism and last ip", "[.integration][.single]") {
     Module d(test::type);
     d.setHostname(test::hostname);
@@ -154,13 +151,12 @@ TEST_CASE("Locking mechanism and last ip", "[.integration][.single]") {
     d.freeSharedMemory();
 }
 
-TEST_CASE("Set settings", "[.integration][.single]"){
+TEST_CASE("Set settings", "[.integration][.single]") {
     Module d(test::type);
     d.setHostname(test::hostname);
     CHECK(d.setSettings(defs::STANDARD) == defs::STANDARD);
 }
 
-
 TEST_CASE("Timer functions", "[.integration][cli]") {
     // FRAME_NUMBER, /**< number of real time frames: total number of
     // acquisitions is number or frames*number of triggers */ ACQUISITION_TIME,
@@ -204,8 +200,7 @@ TEST_CASE("Timer functions", "[.integration][cli]") {
     if (test::type != dt::EIGER) {
         auto delay = 10000;
         d.setDelayAfterTrigger(delay);
-        CHECK(d.getDelayAfterTrigger() ==
-              delay);
+        CHECK(d.getDelayAfterTrigger() == delay);
     }
 
     auto triggers = 2;
@@ -218,10 +213,9 @@ TEST_CASE("Timer functions", "[.integration][cli]") {
         CHECK(d.getSubExptime() == subtime);
     }
     // for (int i =0; i!=frames; ++i)
-        d.startAndReadAll();
+    d.startAndReadAll();
 
     d.freeSharedMemory();
-
 }
 
 // TEST_CASE("Aquire", "[.integration][eiger]"){
@@ -382,8 +376,8 @@ TEST_CASE("Chiptestboard Loading Patterns", "[.ctbintegration]") {
     }
 }
 
-
-TEST_CASE("Chiptestboard Dbit offset, list, sampling, advinvert", "[.ctbintegration][dbit]") {
+TEST_CASE("Chiptestboard Dbit offset, list, sampling, advinvert",
+          "[.ctbintegration][dbit]") {
     SingleDetectorConfig c;
 
     // pick up multi detector from shm id 0
@@ -403,27 +397,27 @@ TEST_CASE("Chiptestboard Dbit offset, list, sampling, advinvert", "[.ctbintegrat
 
     // dbit list
 
-    std::vector <int> list = m.getReceiverDbitList();
+    std::vector<int> list = m.getReceiverDbitList();
     list.clear();
     for (int i = 0; i < 10; ++i)
         list.push_back(i);
     m.setReceiverDbitList(list);
-    
+
     CHECK(m.getReceiverDbitList().size() == 10);
 
     list.push_back(64);
     CHECK_THROWS_AS(m.setReceiverDbitList(list), sls::RuntimeError);
-    CHECK_THROWS_WITH(m.setReceiverDbitList(list), 
-        Catch::Matchers::Contains("be between 0 and 63"));
+    CHECK_THROWS_WITH(m.setReceiverDbitList(list),
+                      Catch::Matchers::Contains("be between 0 and 63"));
 
     list.clear();
     for (int i = 0; i < 65; ++i)
         list.push_back(i);
     CHECK(list.size() == 65);
-    CHECK_THROWS_WITH(m.setReceiverDbitList(list),  
-        Catch::Matchers::Contains("be greater than 64"));
+    CHECK_THROWS_WITH(m.setReceiverDbitList(list),
+                      Catch::Matchers::Contains("be greater than 64"));
 
-    list.clear(); 
+    list.clear();
     m.setReceiverDbitList(list);
     CHECK(m.getReceiverDbitList().empty());
 
@@ -441,8 +435,8 @@ TEST_CASE("Chiptestboard Dbit offset, list, sampling, advinvert", "[.ctbintegrat
     m.setExternalSamplingSource(62);
     CHECK(m.getExternalSamplingSource() == 62);
     CHECK_THROWS_WITH(m.setExternalSamplingSource(64),
-         Catch::Matchers::Contains("be 0-63"));
-    CHECK(m.getExternalSamplingSource() == 62); 
+                      Catch::Matchers::Contains("be 0-63"));
+    CHECK(m.getExternalSamplingSource() == 62);
     m.setExternalSampling(1);
     CHECK(m.getExternalSampling() == 1);
     m.setExternalSampling(0);
@@ -450,20 +444,23 @@ TEST_CASE("Chiptestboard Dbit offset, list, sampling, advinvert", "[.ctbintegrat
     m.setExternalSampling(1);
     CHECK(m.getExternalSampling() == 1);
     CHECK(m.readRegister(0x7b) == 0x1003E);
-    
 }
 
-TEST_CASE("Eiger or Jungfrau startingfnum", "[.eigerintegration][.jungfrauintegration][startingfnum]") {
+TEST_CASE("Eiger or Jungfrau startingfnum",
+          "[.eigerintegration][.jungfrauintegration][startingfnum]") {
     SingleDetectorConfig c;
 
     // pick up multi detector from shm id 0
     DetectorImpl m(0);
 
     // ensure ctb detector type, hostname and online
-    REQUIRE(((m.getDetectorTypeAsEnum() == slsDetectorDefs::detectorType::EIGER) || (m.getDetectorTypeAsEnum() == slsDetectorDefs::detectorType::JUNGFRAU)));
+    REQUIRE(
+        ((m.getDetectorTypeAsEnum() == slsDetectorDefs::detectorType::EIGER) ||
+         (m.getDetectorTypeAsEnum() ==
+          slsDetectorDefs::detectorType::JUNGFRAU)));
     REQUIRE(m.getHostname() == c.hostname);
 
-     CHECK(m.setNumberOfFrames(1) == 1);
+    CHECK(m.setNumberOfFrames(1) == 1);
 
     // starting fnum
     uint64_t val = 8;
@@ -498,7 +495,8 @@ TEST_CASE("Eiger readnlines", "[.eigerintegration][readnlines]") {
     DetectorImpl m(0);
 
     // ensure detector type, hostname
-    REQUIRE((m.getDetectorTypeAsEnum() == slsDetectorDefs::detectorType::EIGER));
+    REQUIRE(
+        (m.getDetectorTypeAsEnum() == slsDetectorDefs::detectorType::EIGER));
     REQUIRE(m.getHostname() == c.hostname);
 
     m.setDynamicRange(16);
@@ -507,7 +505,7 @@ TEST_CASE("Eiger readnlines", "[.eigerintegration][readnlines]") {
     CHECK(m.getReadNLines() == 256);
     m.setReadNLines(1);
     CHECK(m.getReadNLines() == 1);
-        
+
     m.setDynamicRange(8);
     m.setReadNLines(256);
     CHECK(m.getReadNLines() == 256);

integrationTests/test-integrationMulti.cpp

@@ -1,5 +1,5 @@
-#include "catch.hpp"
 #include "DetectorImpl.h"
+#include "catch.hpp"
 #include "string_utils.h"
 #include "tests/globals.h"
 #include <iostream>
@@ -24,8 +24,6 @@ TEST_CASE("Initialize a multi detector", "[.integration][.multi]") {
     d.freeSharedMemory();
 }
 
-
-
 TEST_CASE("Set and read timers", "[.integration][.multi]") {
 
     DetectorImpl d(0, true, true);
@@ -57,7 +55,6 @@ TEST_CASE("Set and read timers", "[.integration][.multi]") {
     // PROGRESS, /**< fraction of measurement elapsed - only get! */
     // MEASUREMENTS_NUMBER,
 
-
     // FRAMES_FROM_START,
     // FRAMES_FROM_START_PG,
     // SAMPLES,
@@ -78,7 +75,6 @@ TEST_CASE("Set and read timers", "[.integration][.multi]") {
         CHECK(d.setSubFrameExposureDeadTime(-1) == Approx(subframe_deadtime));
     }
 
-    
     if (test::type == dt::EIGER) {
         // 32bit is needed for subframe exposure
         d.setDynamicRange(32);

manual/manual-client/Eiger_short.tex

@@ -99,7 +99,7 @@ If one desires to set the zmqport manually, he offset has to be taken into accou
 
 {\tt{slsMultiReceiver}} uses two or more receivers in one single terminal: {\tt{./slsMultiReceiver startTCPPort numReceivers withCallback}}, where startTCPPort assumes the other ports are consecutively increased.
 
-The command {\tt{r\_framesperfile}} sets the number of frames written in the same file. By default now it is 10000. It can be changes. It needs to be lowered particularly if one wants to parallelize the following conversion of the files. 
+The command {\tt{r\_framesperfile}} (\tt{\textcolor{red}{rx\_framesperfile}}) sets the number of frames written in the same file. By default now it is 10000. It can be changes. It needs to be lowered particularly if one wants to parallelize the following conversion of the files. 
 
 
 \subsection{Mandatory setup - Client}
@@ -122,7 +122,23 @@ To do that:
 sls_detector_put 0-config mydetector.config
 \end{verbatim}
 
-In the config file, if client, receiver and detector are using \textbf{1GbE} the following lines are mandatory (see slsDetectorsPackage/examples/eiger\_1Gb.config):
+In the config file, if client, receiver and detector are using \textbf{1GbE} the following lines are mandatory (see slsDetectorsPackage/examples/eiger\_1Gb.config). It has been adapted to the the new 5.0 major release change:
+\begin{verbatim}
+detsize 1024 512 #detector geometry, long side of the module first
+hostname beb059+beb058+ #1Gb detector hostname for controls
+#1Gb receiver pc hostname to be inserted immediately and tcp\_ports to be stated immediately
+rx_hostname x12sa-vcons:1991+pc1875:1992+
+0:udp_dstport 50011 #udp port first quadrant, first halfmodule         
+0:udp_dstport2 50012 #udp port second quadrant, first halfmodule       
+1:udp_dstport 50013 #udp port first quadrant, second halfmodule       
+1:udp_dstport2 50014 #udp port second quadrant, second halfmodule      
+0:udp_srcip 129.129.202.237
+0:udp_dstip auto
+1:udp_srcip 129.129.202.236
+1:udp_dstip auto
+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
@@ -138,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}
@@ -172,24 +206,25 @@ configuremac 0
 rx_udpmac xx:xx:...
 \end{verbatim}
 
+Now we will give general communication commands. Commands with a diffent name in the \textcolor{red}{5.x} realease will be highlighted in \textcolor{red}{red}.
+
 One can configure all the detector settings in a parameter file {\tt{setup.det}}, which is loaded by doing:
 \begin{verbatim}
 sls_detector_put 0-parameters setup.det
 \end{verbatim}
 Note that the parameter file for any realease before 4.1.1 has not the possibility to understand parameters to be set differently for different half modules, i.e.  {\tt{0:txndelay\_left xxxxx},\tt{1:txndelay\_left yyyyy}}. 
 
-In the case of \E, the proper bias voltage of the sensor has to be setup, i.e. the {\tt{setup.det}} file needs to contain the line {\tt{vhighvoltage 150}}. Other detector functionality, which are rarely changed can be setup here. 
+In the case of \E, the proper bias voltage of the sensor has to be setup, i.e. the {\tt{setup.det}} file needs to contain the line {\tt{highvoltage 150}}. Other detector functionality, which are rarely changed can be setup here. 
 Other important settings that are configured in the {\tt{setup.det}} file are:
 \begin{itemize}
 \item {\tt{tengiga 0/1}}, which sets whether the detector is enabled to send data through the 1~or the 10~Gb Ethernet.
-\item {\tt{flags parallel/nonparallel}}, which sets whether the detector is set in parallel acquisition and readout or in sequential mode. This changes the readout time of the chip and affects the frame rate capability (faster is {\tt{parallel}}, with higher noise but needed when the frame rate is $>2$~kHz. 
+\item {\tt{flags parallel/nonparallel}} or {\tt{\textcolor{red}{parallel 1/0}}}, which sets whether the detector is set in parallel acquisition and readout or in sequential mode. This changes the readout time of the chip and affects the frame rate capability (faster is {\tt{parallel}}).
 \item {\tt{dr 32/16/8/4}} sets the detector in autosumming mode (32 bit counter or not autosumming, 12 bit out of the chip). This is strictly connected to what is required for the readout clock of chip. See next point.
-\item {\tt{clkdivider 0/1/2}}. Changes the readout clock: 200, 100, 50~MHz (also referred to as full, half, quarter speed). Note that autosumming mode ({\tt{dr 32}} only works at {clkdivider 2}=quarter speed). By selecting Refer to readout timing specifications in~section\ref{timing} for how to set the detector. 
+\item {\tt{clkdivider 0/1/2}} or {\tt{\textcolor{red}{speed full\_speed/half\_speed/quart\_speed}}}. Changes the readout clock: 200, 100, 50~MHz (also referred to as full, half, quarter speed). Note that autosumming mode ({\tt{dr 32}} only works at \tt{clkdivider 2}=\tt{quart\_speed}). By selecting Refer to readout timing specifications in~section\ref{timing} for how to set the detector. 
 \item {\tt{flags continuous/storeinram}}. Allows to take frame continuously or storing them on memory. Users should use the {\tt{continuous}} flags. Enabling the {\tt{stroreinram}} flag makes the data to be sent out all at the end of the acquisition. Refer to readout timing specifications in section~\ref{timing} for how to set the detector. Examples will be given in section~\ref{}.
 \end{itemize}
 
-One should notice that, by default, by choosing the option {\tt{dr 32}}, then the software automatically sets the detector to  {\tt{clkdivider 2}}. By choosing the option {\tt{dr 16}}, the software automatically sets the detector to  {\tt{clkdivider 1}}. One needs to choose {\tt{clkdivider 0}} after setting the {\tt{dr 16}} option to have the fastest frame rate. 
-We would recommend expert users (beamline people) to write their parameters file for the users. 
+One should notice that, by default, by choosing the option {\tt{dr 32}}, then the software automatically sets the detector to  {\tt{clkdivider 2}} ({\tt{\textcolor{red}{quart\_speed}}}). By choosing the option {\tt{dr 16}}, the software automatically sets the detector to  {\tt{clkdivider 1}} ({\tt{\textcolor{red}{speed quart\_speed}}}). From release 5.x, 
 
 \section{API versioning} \label{api}
 The eigerDetectorServer running on the boards has a versioning API scheme that will make it crash if used with a wrong firmware.
@@ -210,10 +245,18 @@ Killing and starting the server on the boards allows you to check the firmware v
 
 \section{Setting up the threshold}
 \begin{verbatim}
+sls_detector_put 0-settingsdir /path
 sls_detector_put 0-trimen N xxxx yyyy zzzz
 sls_detector_put 0-settings standard 
 sls_detector_put 0-threshold energy_in_eV standard
 \end{verbatim}
+or in \textcolor{red}{5.x}:
+\begin{verbatim}
+sls_detector_put 0-settingspath /path}
+sls_detector_put 0-trimen N xxxx yyyy zzzz}
+sls_detector_put 0-threshold energy_in_eV standard
+\end{verbatim}
+
 The first line requires to specify how many ({\tt{N}}) and at which energies in eV {\{tt{xxxx}}, {\tt{yyyy}}, {\tt{zzzz}} and so on) trimmed files were generated (to allow for an interpolation). This line should normally be included into the {\tt{mydetector.config}} file and should be set for you by one of the detector group.
 NORMALLY, in this new calibration scheme, only {\tt{settings standard}} will be provided to you, unless specific cases to be discussed.
 The threshold at 6000 eV , for example would be set as:{\tt{sls\_detector\_put 0-threshold 6000 standard}}.
@@ -244,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}
@@ -267,12 +310,17 @@ sls_detector_get receiver
 
 There is a more complex way of performing an acquisition, that is useful for debugging and in case one wants a non blocking behavior: 
 
-You can then reset to zero the number of frames caught, then  start the receiver and the detector:
+You can then reset to zero the number of frames caught (in releases<5.0), then  start the receiver and the detector:
 \begin{enumerate}
 \item {\tt{sls\_detector\_put 0-resetframescaught 0}} 
 \item {\tt{sls\_detector\_put 0-receiver start}} 
 \item {\tt{sls\_detector\_put 0-status start}} 
 \end{enumerate}
+In release \textcolor{red}{5.0} it is not needed to reset the frames caughts and the commands are:
+ \begin{enumerate}
+\item \textcolor{red}{{\tt{sls\_detector\_put 0-rx\_start}}} 
+\item \textcolor{red}{{\tt{sls\_detector\_put 0-start}}} 
+\end{enumerate}
 
 You can poll the detector status using:
 \begin{verbatim}
@@ -281,17 +329,17 @@ sls_detector_get 0-status
 When the detector is {\tt{idle}}, then the acquisition is done but the receiver could still be receiving data. If you want, you can check if the receiver is finished receiving as many frames as you were expecting (this is optional but required for many many frames acquisition or when using some delays to send data at very high frame rate.
 \begin{enumerate}
 \setcounter{enumi}{3}
-\item {\tt{sls\_detector\_get framescaught}} 
+\item {\tt{sls\_detector\_get framescaught}} (\textcolor{red}{rx\_framescaught})
 \end{enumerate}
 Then you can stop the receiver as well now:
 \begin{enumerate}
 \setcounter{enumi}{4}
-\item {\tt{sls\_detector\_put 0-receiver stop}} 
+\item {\tt{sls\_detector\_put 0-receiver stop} (\textcolor{red}{sls\_detector\_put 0-rx\_stop})}
 \end{enumerate}
 
 The detector will not accept other commands while acquiring. If an acquisition wishes to be properly aborted, then:
 \begin{itemize}
-\item {\tt{sls\_detector\_put 0-status stop}} 
+\item {\tt{sls\_detector\_put 0-status stop} (\textcolor{red}{sls\_detector\_put 0-stop})} 
 \end{itemize}
 this same command can be used after a non proper abortion of the acquisition to reset to normal status the detector.
 
@@ -347,8 +395,11 @@ col                        : 257 pixels
 \end{verbatim}
 
 \section{Readout timing- maximum frame rate}\label{timing}
-IMPORTANT: to have faster readout and smaller dead time, one can configure {\tt{clkdivider}}, i.e. the speed at which the data are read, i.e. 200/100/50~MHz for {\tt{clkdivider 0/1/2}} and the dead time between frames through {\tt{flags parallel}}, i.e. acquire and read at the same time or acquire and then read out.
-The configuration of this timing variables allows to achieve different frame rates. NOTE THAT IN EIGER, WHATEVER YOU DO, THE FRAME RATE LIMITATIONS COME FROM THE NETWORK BOTTLENECK AS THE HARDWARE GOES FASTER THAN THE DATA OUT.
+IMPORTANT: to have faster readout and smaller dead time, one can configure {\tt{clkdivider}}, i.e. the {\tt{textcolor}{red}{speed} at which the data are read, i.e. 200/100/50~MHz for {\tt{clkdivider 0/1/2}} ({\tt{
+\textcolor{red}{speed full\_speed/half\_speed/quart\_speed}}) and the dead time between frames through {\tt{flags parallel}} or {\tt{\textcolor{red}{parallel 1}}}, i.e. acquire and read at the same time or acquire and then read out.
+The configuration of this timing variables allows to achieve different frame rates. NOTE THAT IN EIGER, WHATEVER YOU DO, THE FRAME RATE LIMITATIONS COME FROM THE NETWORK BOTTLENECK AS THE HARDWARE GOES FASTER THAN THE DATA OUT. WE recconmmend using the detector in \tt{dr 4/8/16}, \tt{\textcolor{red}{speed full\_speed}}, \tt{parallel 1} or \tt{dr 32}, \tt{\textcolor{red}{speed quart\_speed}}, \tt{parallel 1. All those options are now the defaults options starting from version 5.x.
+
+
 
 In the case of REAL CONTINUOUS readout, i.e. continuous acquire and readout from the boards (independent on how the chip is set), the continuous frame rates are listed in table~\ref{tcont}. The time to send out the frame out of the board 
 \begin{table} 
@@ -360,16 +411,16 @@ In the case of REAL CONTINUOUS readout, i.e. continuous acquire and readout from
 \hline 
 1 &  32 &  \textbf{128} & 7820 & \\
 \hline 
-10 & 4 & \textbf{10240} & 98 & 105/128\\
+10 & 4 & \textbf{7813} & 98 & 105/128\\
 \hline 
-10 & 8 & \textbf{5120} & 196 & 210/250\\
+10 & 8 & \textbf{4000} & 196 & 210/250\\
 \hline
-10 & 16 & \textbf{2560} & 391 & 420/490\\  
+10 & 16 & \textbf{2000} & 391 & 420/490\\  
 \hline 
-10 & 32 & \textbf{1280} & 782 & 840/977\\  
+10 & 32 & \textbf{1023} & 782 & 840/977\\  
 \hline 
 \end{tabular}
-\caption{Frame rate limits for the CONTINUOS streaming out of images, i.e. the data rate out is just below 1Gb/s or 10Gb/s. 1280~Hz for 32-bit, 10GbE is obtained from the 10GbE limitation. The maximum achievable frame rate is 977~Hz.} 
+\caption{Frame rate limits for the CONTINUOS streaming out of images, i.e. the data rate out is just below 1Gb/s or 10Gb/s. 1023~Hz for 32-bit, 10GbE is obtained from the 10GbE limitation. The maximum achievable frame rate is 977~Hz.} 
 \label{tcont}\end{table}
  Note that in the {\tt{continuous}} flag mode, some buffering is still done on the memories, so a higher frame rate than the proper real continuous one can be achieved. Still, this extra buffering is possible till the memories are not saturated. The number of images that can be stored on the DDR2 on board memories are listed in table~\ref{timgs}.
 \begin{table}
@@ -384,11 +435,11 @@ dynamic range & images\\
 16 & 7600\\
 \hline
 \end{tabular}
-\caption{Amount of images that can be stored on board. As while we store them, we start to send them out, the effective number of images could be larger than this, but it will depend on the network setup (how fats you stream out images).}
+\caption{Amount of images that can be stored on board. As while we store them, we start to send them out, the effective number of images could be larger than this, but it will depend on the network setup (how fast you stream out images).}
 \label{timgs}
 \end{table}
 
-The maximum frame rate achievable with 10~GbE, {\tt{dr 16}}, {\tt{flags continuous}}, {\tt{flags parallel}},{\tt{clkdivider 0}}, \textbf{6.1~kHz}. This is currently limited by the connection between the Front End Board and the Backend board. We expect the 32 bit mode limit, internally, to be \textbf{2~kHz} ({\tt{clkdivider 2}}).
+The maximum frame rate achievable with 10~GbE, {\tt{dr 16}}, {\tt{flags continuous}}, {\tt{flags parallel}} ({\tt{\textcolor{red}{parallel 1}}}),{\tt{clkdivider 0}} ({\tt{\textcolor{red}{speed full\_speed}}}), \textbf{6.1~kHz}. This is currently limited by the connection between the Front End Board and the Backend board. We expect the 32 bit mode limit, internally, to be \textbf{2~kHz} ({\tt{clkdivider 2}}).
  In dynamic range {\tt{dr 8}} the frame rate is \textbf{11~kHz} and for{\tt{dr 4}} is \textbf{22~kHz}. For 4 and 8 bit mode the frame rate are directly limited by the speed of the detector chip and not by the readout boards.    
 
 \subsection{Minimum time between frames and Maximum frame rate}
@@ -459,6 +510,23 @@ where the 'minimum time between frames' and the minimum period will be discussed
 
 \textbf{From software version 4.0.0, there is a very useful function {\tt{sls\_detector\_get measuredperiod}} which return the measured period AFTER the acquisition. This is important to check that the settings to obtain the targeted frame rate was correct.} 
 
+In release \textcolor{red}{5.0} in 4-bit modes one can set a sort of ROI in the detector such to read half of the module (the central part) or a quarter of it with almost double or four times the frame rate. By default the \tt{\textcolor{red}{readnlines}} is set to \tt{256} meaning the whole chip. With \tt{\textcolor{red}{readnlines 128}} or \tt{\textcolor{red}{readnlines 64}} one sets to read half/quarter rows from the chip. In table~\ref{table:hfrpartial} the maximum frame rates, exposure time and period for the partial readout.\\
+
+
+\begin{tabular}{|c|c|c|c|c|c|c|}
+\hline
+ readnlines & \# pixels & Active area (cm$^2$) & Max frame rate (kHz) & Period ($\mu$s) & Dead time ($\mu$s) & \# buffered images\\
+\hline
+256 &1024 $\times$ 512 & 8 $\times$ 3.8 & 22.7 & 44.0 &4.1 & 30k\\
+\hline
+128 &1024 $\times$ 256 & 8 $\times$ 1.9 & 42.1 & 23.7 &4.2 & 60k\\
+\hline
+64 & 1024 $\times$ 128 & 8 $\times$ 0.95 & 73.5 & 13.6 &4.2 & 120k\\
+\hline
+\end{tabular}
+\label{table:hfrpartial}
+
+
 \textbf{If you run too fast, the detector could become noisier (see problem shooting), it is important to match the detector settings to your frame rate. This can be done having more parameters files and load the one suitable with your experiment.} We experienced that with low energy settings could not reach 6~kHz and no noise.
 In 16 bit mode, it could make sense, in case of noise and low threshold to either reduce the frame rate:
 \begin{equation} 
@@ -579,10 +647,10 @@ The number of subframes composing a single 32bit acquisition can be calculated a
 \end{equation}
 This also means that {\tt{exptime}}$<${\tt{subexptime}} will be rounded to{\tt{subexptime}}. If you want shorter acquisitions, either reduce the {\tt{subexptime}} or switch two 16-bit mode (you can always sum offline if needed).   
 
-From release 4.0.0, an extra {\tt{flag overflow/nooverflow}} is added, with {\tt{nooverflow}} default:
+From release 4.0.0, an extra {\tt{flag overflow/nooverflow}} is added (\tt{\textcolor{red}{overflow 0/1}}), with {\tt{nooverflow}} (\tt{\textcolor{red}{overflow 0}}) default:
 \begin{itemize}
-\item {\tt{nooverflow}}: the internal 12-bit result is summed, even if there was saturation of the 12-bit counter (4095) in any of the subframes. Note that if there is saturation for every subframe, you might get as a result a value of the counter equal to (4095$\times$~number~of~subframes), which you need to correctly identify. On the other hand if the saturation occurred only one time, you will get something "close'' to the real number.
-\item {\tt{overflow}}: In this case, even if a pixel saturate only 1 time in a subframe, you will be returned as a value of the counter for that pixel: $2^{32}-1$, i.e. 4294967295.  
+\item {\tt{nooverflow}} (\tt{\textcolor{red}{overflow 0}}): the internal 12-bit result is summed, even if there was saturation of the 12-bit counter (4095) in any of the subframes. Note that if there is saturation for every subframe, you might get as a result a value of the counter equal to (4095$\times$~number~of~subframes), which you need to correctly identify. On the other hand if the saturation occurred only one time, you will get something "close'' to the real number.
+\item {\tt{overflow}} (\tt{\textcolor{red}{overflow 1}})): In this case, even if a pixel saturate only 1 time in a subframe, you will be returned as a value of the counter for that pixel: $2^{32}-1$, i.e. 4294967295.  
 \end{itemize}
 
 The UDP header will contain, after you receive the data, the effective number of subframe per image (see section~\ref{UDP}) as  "SubFrame Num or Exp Time", i.e. the number of subframes recorded  (32 bit eiger).
@@ -610,17 +678,17 @@ The detector can be setup such to receive external triggers. Connect a LEMO sign
 \begin{verbatim}
 sls_detector_put 0-timing [auto/trigger/burst_trigger/gating]
 sls_detector_put 0-frames x
-sls_detector_put 0-cycles y
+sls_detector_put 0-cycles y  (\textcolor{red}{triggers})
 sls_detector_acquire 0-
 \end{verbatim}
 No timeout is expected between the start of the acquisition and the arrival of the first trigger. 
 
 Here are the implemented options so far:
 \begin{itemize}
-\item {\tt{auto}} is the software controlled acquisition (does not use triggers), where {\tt{exptime}} and {\tt{period}} have to be set. Set number of cycles (i.e. triggers) to 1 using {\tt{cycles}}. Set number of frames using {\tt{frames}}.
-\item {\tt{trigger}} 1 frame taken for 1 trigger. Your {\tt{frames}} needs to be  1 always, {\tt{cycles}} can be changed and defines how many triggers are considered.  {\tt{exptime}} needs to be set. In the GUI this is called trigger exposure series.  
-\item {\tt{burst\_trigger}} gets only 1 trigger, but allows to take many frames. With {\tt{frames}} one can change the number of frames. {\tt{cycles}} needs to be 1.  {\tt{exptime}} and {\tt{period}} have to be set. In the gui it is called trigger readout.
-\item{\tt{gating}} allows to get a frame only when the trigger pulse is gating. Note that in this case the exp time and period only depend on the gating signal. {\tt{cycles}} allows to select how many gates to consider.  Set number of frames to 1 using {\tt{frames}}. IMPORTANT: Up to firmware 23, the last subframe is oblige to finish being taken, despite the gate signal going down. This will be configurable from later fw and software version. Also, in gating mode, due to timimg of the state machine, you need to leave 500~$\mu$s deadtime between the end on an acquisition and the next. This is as the state machine is unable to check for changes in the status in the first 500~$\mu$s. ATTENTION: if you are in 16 bit mode and you are applying online rate corrections, as now the exptime is generated by the trigger, you might not have correct rate corrections. If you know what the exposure time is in the gating signal, then you can set the {\tt{exptime}} once and the rate corrections will be correct. In 32 bit mode, it does not matter as the rate corrections depends on the {\tt{subexptime}} which is software set independently from the gate exptime.
+\item {\tt{auto}} is the software controlled acquisition (does not use triggers), where {\tt{exptime}} and {\tt{period}} have to be set. Set number of {\tt{cycles}} (\textcolor{red}{triggers}) to 1. Set number of frames using {\tt{frames}}.
+\item {\tt{trigger}} 1 frame taken for 1 trigger. Your {\tt{frames}} needs to be  1 always, {\tt{cycles}} ({\tt{\textcolor{red}{triggers}}}) can be changed and defines how many triggers are considered.  {\tt{exptime}} needs to be set. In the GUI this is called trigger exposure series.  
+\item {\tt{burst\_trigger}} gets only 1 trigger, but allows to take many frames. With {\tt{frames}} one can change the number of frames. {\tt{cycles}} ({\tt{\textcolor{red}{triggers}}}) needs to be 1.  {\tt{exptime}} and {\tt{period}} have to be set. In the gui it is called trigger readout.
+\item{\tt{gating}} allows to get a frame only when the trigger pulse is gating. Note that in this case the exp time and period only depend on the gating signal. {\tt{cycles}} (\tt{\textcolor{red}{triggers}}) allows to select how many gates to consider.  Set number of frames to 1 using {\tt{frames}}. IMPORTANT: Up to firmware 23, the last subframe is oblige to finish being taken, despite the gate signal going down. This will be configurable from later fw and software version. Also, in gating mode, due to timimg of the state machine, you need to leave 500~$\mu$s deadtime between the end on an acquisition and the next. This is as the state machine is unable to check for changes in the status in the first 500~$\mu$s. ATTENTION: if you are in 16 bit mode and you are applying online rate corrections, as now the exptime is generated by the trigger, you might not have correct rate corrections. If you know what the exposure time is in the gating signal, then you can set the {\tt{exptime}} once and the rate corrections will be correct. In 32 bit mode, it does not matter as the rate corrections depends on the {\tt{subexptime}} which is software set independently from the gate exptime.
 
 ATTENTION: From release 4.1.1 with the {\tt{trigger}} option it is possible to have software triggers as a debugging tool (instead of the hardware trigger signal. One should start the acquisition (with the blocking {\tt{sls\_detector\_acquire}} if wanted and with another client one can send the softare trigger {\tt{sls\_detector\_put status trigger}}. This option allows for example to perform a motor scan (moving a motor in between single images) and still writing all images to the same file. 
 When using 32-bit mode, by default the acquisition ends the last complete subframe that was started when still the acquisition time was valid. This has been chosen as many people wants to know the exact acquisition time for when the detector was taking data and also, if {\tt{ratecorr}} are active, the last subframe will be correctly corrected, while otherwise it will be corrected with a wrong subdeadtime. 
@@ -630,13 +698,13 @@ However, from 4.1.0, in gating mode, an option to immediately terminate the subf
 
 Hardware-wise, the ENABLE OUT signal outputs when the chips are really acquiring. This means that the single subframes will be output in 32 bit mode. The TRIGGER OUT outputs the sum-up-signal at the moment (which is useless). This will be changed in the future to output the envelop of the enable signal. 
 
-We are planning to change some functionality, i.e. unify the {\tt{trigger}} and {\tt{burst\_trigger}} trigger modes and make both {\tt{frames}} and {\tt{cycles}} configurable at the same time.
+We are planning to change some functionality, i.e. unify the {\tt{trigger}} and {\tt{burst\_trigger}} trigger modes and make both {\tt{frames}} and {\tt{cycles}} (\tt{\textcolor{red}{triggers}}) configurable at the same time.
 
 There is the possibility to use {\tt{timing trigger/burst\_trigger}} and send software single commands to fake the trigger. This is done with:
 \begin{verbatim}
 sls_detector_put 0-timing [trigger/burst_trigger]
 sls_detector_put 0-frames x
-sls_detector_put 0-cycles y
+sls_detector_put 0-cycles y (\textcolor{red}{triggers})
 sls_detector_status trigger
 \end{verbatim}
  Note that this functionality is very (!) useful if you need to do something between and acquisition and the next. This can be used to do a fast threshold scan for example. See section~\ref{sec:fastthresholdscan}.
@@ -716,8 +784,8 @@ If \textbf{dr} is 32 and \textbf{clkdivider} is not 2, whatever the detector get
 
 Here is a list of parameters that should be reset:
 \begin{enumerate}
-\item  \textbf{resetframescaught} should be reset to zero after every acquisition taken with {\tt{receiver start}},{\tt{status start}},{\tt{receiver stop}}. If the acquisition is taken with {\tt{sls\_detector\_acquire}}, there is no need to reset this.
-\item After changing the {\tt{timing}} mode of the detector, one should reset to '1' the unused value, in that specific timing mode, between \textbf{frames} and \textbf{cycles}. See section~\ref{triggering} for how to use the timing. At the present moment the detector will acquire more frames than planned if the variable not used between \textbf{frames} and \textbf{cycles} is not reset. In future releases, the unused variable will be ignored. Still resetting is a good practice.
+\item  \textbf{resetframescaught} (only for releases < 5.x) should be reset to zero after every acquisition taken with {\tt{receiver start}},{\tt{status start}},{\tt{receiver stop}}. If the acquisition is taken with {\tt{sls\_detector\_acquire}}, there is no need to reset this.
+\item After changing the {\tt{timing}} mode of the detector, one should reset to '1' the unused value, in that specific timing mode, between \textbf{frames} and \textbf{cycles} (\tt{\textcolor{red}{triggers}}). See section~\ref{triggering} for how to use the timing. At the present moment the detector will acquire more frames than planned if the variable not used between \textbf{frames} and \textbf{cycles} (\tt{\textcolor{red}{trigger}}) is not reset. In future releases, the unused variable will be ignored. Still resetting is a good practice.
       
 \end{enumerate}
 
@@ -746,7 +814,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}
@@ -839,7 +907,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}
@@ -992,9 +1060,9 @@ Note that if one wants to  reconstruct the real time the detector was acquiring
 \subsection{Offline image reconstruction}
 The offline image reconstruction{\tt{slsImageReconstruction}} is not part of the package anymore. However, it can be retrieved from \\
 {\tt{git clone https://github.com/slsdetectorgroup/slsImageReconstruction.git slsImageReconstruction}}.\\
-Checkout the {\tt{v3.1}} branch if in a 3.1.X release, the {\tt{v4.0.0}} branch if in 4.0.X release, or the {\tt{v4.1}} branch if in 4.1.X release of the {\tt{slsDetector}} code. There is a {\tt{developer}} branch that has newer updates but needs to be tested.
+Checkout the {\tt{v3.1}} branch if in a 3.1.X release, the {\tt{v4.0.0}} branch if in 4.0.X release, or the {\tt{v4.1}} branch if in 4.1.X release of the {\tt{slsDetector}} code. There is a {\tt{developer}} branch that is following the 5.X chnages but it is not officila yet.
 
-Three possible conversions are possible: into \textbf{cbf}, \textbf{hdf5}. \textbf{tiff} and  \textbf{root} format. The detector writes 2 raw files per receiver. An offline image reconstruction executable has been written to collate the possible files together and produce output files. By default an interpolation between the values of the large pixels is performed. Gap pixels between modules are also inserted.
+Four possible conversions are possible: into \textbf{cbf}, \textbf{hdf5}. \textbf{tiff} and  \textbf{root} format. The detector writes 2 raw files per receiver. An offline image reconstruction executable has been written to collate the possible files together and produce output files. By default an interpolation between the values of the large pixels is performed. Gap pixels between modules are also inserted.
 
 Note that the number of images per file in the 3.1.X release is hardcoded and needs to match whatever you are using in \\
 {\tt{slsDetectorsPackage/slsReceiverSoftware/include/sls\_receiver\_defs.h}}:
@@ -1128,10 +1196,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 vhighvoltage 150
-./sls_detector_get vhighvoltage 
+./sls_detector_put vhighvoltage 150 (\textcolor{red}{highvoltage})
+./sls_detector_get vhighvoltage (\textcolor{red}{highvoltage})
 \end{verbatim}
-Note that the get {\tt{vhighvoltage}} would return the measured HV from the master module only. If getting the vhighvoltage 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
 
@@ -1213,13 +1281,21 @@ do the same for the other boards. You can program in parallel many boards, but y
 There are two ways to pulse the detector: 
 \begin{itemize}
 \item \textbf{Pulse digitally:} when you are interested to the output readout and do not care about the analog response from the pixels:
- \begin{verbatim}
+\begin{verbatim}
 sls_detector_put vthreshold 4000
 sls_detector_put vtr 4000
 sls_detector_put pulsechip N #to pulse N
 sls_detector_put pulsechip -1 #to get out of testing mode 
 \end{verbatim}
 Note that the answer will be $2 \cdot \textrm{{\tt{N}}} +2$ in this case.
+Or in \textcolor{red}{5.x}:
+\begin{verbatim}
+sls_detector_put vthreshold 4000
+sls_detector_put vtrim 4000
+sls_detector_put pulsechip N #to pulse N
+sls_detector_put pulsechip -1 #to get out of testing mode
+\end{verbatim}
+Note that the answer will be $2 \cdot \textrm{{\tt{N}}} +4$ in this case.
 
 \item  \textbf{Pulse analogically:} You want to really check the analogical part of the detector, not just the readout.
 
@@ -1238,8 +1314,25 @@ sls_detector_put resmat 0
 sls_detector_acquire
 \end{verbatim}
 You read {\tt{N}} in every pixel if you are setup correctly. 
+or in realese \textcolor{red}{5.x}:
+\begin{verbatim}
+sls_detector_put vcal 3600
+sls_detector_put vthreshold 1700
+sls_detector_put vrpreamp 3100
+for i in $(seq 0 7) ;
+do px=$((-255+i));
+sls_detector_put  pulse 0 $px 0;
+for j in $(seq 0 255) ; do
+sls_detector_put pulsenmove 100 0 1;
+done;
+done;
+sls_detector_put partialreset 1
+\end{verbatim}
 \end{itemize}
  
+
+
+
 \section{Load a noise pattern with shape}
 For debug purposes, we have created a noise pattern with a shape. If you reconstruct correctly your image, you should be able to read ".EIGER'' in the same direction for both the top and bottom in normal human readable orientation.
 To load the special noise file look at {\tt{settingsdir/eiger/standard/eigernoise.sn0xx}} in the package. 
@@ -1262,10 +1355,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
+./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); 
@@ -1383,7 +1476,7 @@ Environment variable SLSDETNAME can be set for using 2 different detectors from
 \subsection{Measure the HV}
 For every system: 
 \begin{itemize}
-\item Software-wise measure it (now the software returns the measured value), with {\tt{sls\_detector\_get vhighvoltage}}. The returned value is the HV (for proper Eiger setting is approximately 150~V) if it is correctly set. If two master modules are presents (multi systems), the average is returned (still to be tested). If one asks for the individual $n$ half module bias voltage through {\tt{sls\_detector\_get n:vhighvoltage}}, if the $n$ module is a master, the actual voltage will be returned. If it is a slave, -999 will be returned. 
+\item Software-wise measure it (now the software returns the measured value), with {\tt{sls\_detector\_get highvoltage}}. The returned value is the HV (for proper Eiger setting is approximately 150~V) if it is correctly set. If two master modules are presents (multi systems), the average is returned (still to be tested). If one asks for the individual $n$ half module bias voltage through {\tt{sls\_detector\_get n:highvoltage}}, if the $n$ module is a master, the actual voltage will be returned. If it is a slave, -999 will be returned. 
 \item Hardware-wise (opening the detector) measure value of HV on C14 on the power distribution board. Check also that the small HV connector cable is really connected. 
  \end{itemize}
 
@@ -1434,7 +1527,7 @@ Scroll up in the terminal till you find:\\
 There is also an easier way, that is that only the master module will return the real value of the HV. If you have more than 1 detector system, then you will have more than 1 physical master, as the HV needs to be applied to all the systems.
 
 \begin{verbatim}
-for i in $(seq 0 36); do sls_detector_put $i:vhighvoltage; done
+for i in $(seq 0 36); do sls_detector_put $i:highvoltage; done
 \end{verbatim}
  Only the master will return to you a sensible number (150 normally). the others will return -999.
 
@@ -1595,10 +1688,10 @@ ratecorr number
 where {\tt{number}} is a string that should be interpreted as a float in s.  0.000000 means correction off. Values above zero are the value of $\tau$ in ns.
 
 \item \begin{verbatim}
-sls_detector_get vhighvoltage
-vhighvoltage number
+sls_detector_get highvoltage
+highvoltage number
 \end{verbatim}
-where {\tt{number}} is a string that should be interpreted as an int and for proper Eiger setting is approximately 150~V if it is correctly set. If two master modules are presents (multi systems), the average is returned (still to be tested). If one asks for the individual $n$ half module bias voltage through {\tt{sls\_detector\_get n:vhighvoltage}}, if the $n$ module is a master, the actual voltage will be returned. If it is a slave, -999 will be returned. 
+where {\tt{number}} is a string that should be interpreted as an int and for proper Eiger setting is approximately 150~V if it is correctly set. If two master modules are presents (multi systems), the average is returned (still to be tested). If one asks for the individual $n$ half module bias voltage through {\tt{sls\_detector\_get n:highvoltage}}, if the $n$ module is a master, the actual voltage will be returned. If it is a slave, -999 will be returned. 
   
 \item \begin{verbatim}
 sls_detector_get busy

manual/manual-client/commands.txt

@@ -142,7 +142,7 @@
  "vpreamp"; // sets/get vpreamp value  (advanced! Mythen)
  "vshaper1"; // sets/get vshaper1 value  (advanced! Mythen)
  "vshaper2"; // sets/get vshaper2 value  (advanced! Mythen)
- "vhighvoltage"; // sets/get vhighvoltage value  (advanced! Chiptest board and Eiger)
+ "highvoltage"; // sets/get highvoltage value  (advanced! Chiptest board and Eiger)
  "vapower"; // sets/get vapower value  (advanced! Chiptest board)
  "vddpower"; // sets/get vddpower value  (advanced! Chiptest board)
  "vshpower"; // sets/get vshpower value  (advanced! Chiptest board)

manual/manual-client/slsDetectorClientHowTo.tex

@@ -335,7 +335,7 @@ Advanced settings changing the analog or digital performance of the acquisition.
 \item[vpreamp n]  Sets the DAC value of the preamp feedback  to n.
 \item[vshaper1 n]  Sets the DAC value of the shaper1 feedback  to n.  
 \item[vshaper2 n]   Sets the DAC value of the shaper2 feedback  to n.      
-\item[vhighvoltage n]   Sets the DAC value of the high voltage to n (in V).           
+\item[highvoltage n]   Sets the DAC value of the high voltage to n (in V).           
 \item[vapower n]   CHIPTEST BOARD ONLY - Sets the DAC value of the analog voltage to n. 
 \item[vddpower n]     CHIPTEST BOARD ONLY - Sets the DAC value of the analog voltage to n.      
 \item[vshpower n]     CHIPTEST BOARD ONLY - Sets the comparator power supply in dac units (0-1024).   
@@ -648,7 +648,7 @@ Advanced settings changing the analog or digital performance of the acquisition.
 \item[vpreamp]  Returns the DAC value of the preamp feedback  to n.
 \item[vshaper1]  Returns the DAC value of the shaper1 feedback  to n.  
 \item[vshaper2]  Returns the DAC value of the shaper2 feedback  to n.      
-\item[vhighvoltage]  Returns the DAC value of the high voltage to n.           
+\item[highvoltage]  Returns the DAC value of the high voltage to n.           
 \item[vapower]   CHIPTEST BOARD ONLY - Returns the DAC value of the analog voltage to n. 
 \item[vddpower]     CHIPTEST BOARD ONLY - Returns the DAC value of the analog voltage to n.      
 \item[vshpower]     CHIPTEST BOARD ONLY - Returns the comparator power supply in dac units (0-1024).   
@@ -714,7 +714,7 @@ One can configure all the detector settings in a parameter file {\tt{setup.det}}
 sls_detector_put parameters setup.det
 \end{verbatim}
 
-In the case of \E, the parameter file ({\tt{setup.det}} needs to setup the proper bias voltage of the sensor, i.e. needs to contain the line {\tt{vhighvoltage 150}}.
+In the case of \E, the parameter file ({\tt{setup.det}} needs to setup the proper bias voltage of the sensor, i.e. needs to contain the line {\tt{highvoltage 150}}.
 
 \subsection{Standard acquisition}
 

manual/manual-main/slsDetectorClientHowTo.tex

@@ -322,7 +322,7 @@ Advanced settings changing the analog or digital performance of the acquisition.
 \item[vpreamp n]  Sets the DAC value of the preamp feedback  to n.
 \item[vshaper1 n]  Sets the DAC value of the shaper1 feedback  to n.  
 \item[vshaper2 n]   Sets the DAC value of the shaper2 feedback  to n.      
-\item[vhighvoltage n]   CHIPTEST BOARD ONLY - Sets the DAC value of the high voltage to n.           
+\item[highvoltage n]   CHIPTEST BOARD ONLY - Sets the DAC value of the high voltage to n.           
 \item[vapower n]   CHIPTEST BOARD ONLY - Sets the DAC value of the analog voltage to n. 
 \item[vddpower n]     CHIPTEST BOARD ONLY - Sets the DAC value of the analog voltage to n.      
 \item[vshpower n]     CHIPTEST BOARD ONLY - Sets the comparator power supply in dac units (0-1024).   
@@ -594,7 +594,7 @@ Advanced settings changing the analog or digital performance of the acquisition.
 \item[vpreamp]  Returns the DAC value of the preamp feedback  to n.
 \item[vshaper1]  Returns the DAC value of the shaper1 feedback  to n.  
 \item[vshaper2]  Returns the DAC value of the shaper2 feedback  to n.      
-\item[vhighvoltage]   CHIPTEST BOARD ONLY - Returns the DAC value of the high voltage to n.           
+\item[highvoltage]   CHIPTEST BOARD ONLY - Returns the DAC value of the high voltage to n.           
 \item[vapower]   CHIPTEST BOARD ONLY - Returns the DAC value of the analog voltage to n. 
 \item[vddpower]     CHIPTEST BOARD ONLY - Returns the DAC value of the analog voltage to n.      
 \item[vshpower]     CHIPTEST BOARD ONLY - Returns the comparator power supply in dac units (0-1024).   

python/CMakeLists.txt

@@ -11,7 +11,8 @@ pybind11_add_module(_slsdet
 target_link_libraries(_slsdet PUBLIC 
                         slsDetectorShared
                         slsReceiverShared
-                        slsSupportLib
+                        slsSupportShared
+                        ${ZeroMQ_LIBRARIES}
                         )  
 
 
@@ -29,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/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']
-
-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_enums.py

@@ -11,6 +11,10 @@ import subprocess
 
 from parse import remove_comments
 
+def single_line_enum(line):
+    sub = line[line.find('{')+1:line.find('}')]
+    return sub.strip().split(',')
+
 def extract_enums(lines):
     line_iter = iter(lines)
     enums = {}
@@ -18,19 +22,27 @@ def extract_enums(lines):
         m = re.search("(?<=enum )\w+(?= {)", line)
         if m:
             enum_name = m.group()
-            # print(enum_name)
+            print(enum_name)
+            # print(line)
             fields = []
-            while True:
-                l  = next(line_iter)
-                if '};' in l:
-                    break
-                m = re.search("\w+", l)
-                try:
-                    # print('\t', m.group())
-                    fields.append(m.group())
 
-                except:
-                    pass
+            #deal with single line enums
+            if '};' in line:
+                fields = single_line_enum(line)
+            else:
+                #deal with multi line enums
+                while True:
+                    l  = next(line_iter)
+                    if '};' in l:
+                        break
+                    m = re.search("\w+", l)
+                    try:
+                        # print('\t', m.group())
+                        fields.append(m.group())
+
+                    except:
+                        pass
+            fields = [f.strip() for f in fields]
             enums[enum_name] = fields
     return enums
 

python/scripts/generate_functions.py

@@ -47,6 +47,8 @@ lines = []
 
 ag2 = []
 
+cn = []
+
 def get_arguments(node):
     args = [a.type.spelling for a in node.get_arguments()]
     args = [
@@ -58,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()]
@@ -66,8 +85,12 @@ def get_fdec(node):
     else:
         return_type = 'void'
     
+    if node.is_const_method():
+        const = 'const'
+    else:
+        const = ''
     args = ", ".join(args)
-    args = f'({return_type}(Detector::*)({args}))'
+    args = f'({return_type}(Detector::*)({args}){const})'
     return args
 
 
@@ -80,11 +103,13 @@ 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})'
                     )
+                    cn.append(child)
     for child in node.get_children():
         visit(child)
 

python/setup.py

@@ -1,5 +1,5 @@
 """
-Setup file for sls_detector
+Setup file for slsdet
 Build upon the pybind11 example found here: https://github.com/pybind/python_example
 """
 from setuptools import setup, Extension, find_packages

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
-vhighvoltage 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