SLS Detector Package 4.2.0 released on 10.03.2020 (Minor Release)
===================================================================


This document describes the differences between 4.2.0 and 4.1.1 releases.   
    
    CONTENTS
    --------
    1.  Topics Concerning
    2.  Resolved Issues
    3.  Known Issues
    4.  Firmware Requirements
    5.  Download, Documentation & Support
    


1. Topics Concerning
====================

    - (Eiger) detector server startup with vcal = 0 to reduce noise
    - Deactivate will deactivate a module even if FEB does not work.
    - trimbits check
    - zmqsocket
    - fifo size (memory allocation print to mb)
    - subexptime also sets subperiod in master fle
    - minor check if no detectors ()xxxxxxxxxxxxxxxxxxxxxxx
    - setflippeddatax in users xxxxx
    - memory alignment in receiver



2. Resolved Issues
==================          

    Detector Server (Eiger)
    -----------------------
    
    1.  Vcal dac set to 0 at on-board detector server start up to
        reduce noise.

    2.  Deactivate will deactivate a module even if FEB does not work.

    3.  Trimbits values checked for values 0 - 63.

    Receiver
    --------

    1.  zmq socket send memory not overlapping
    2. fifo size not be large (and memory allocated print to mb)

    - subexptime also sets subperiod in master fle

3. Known Issues
===============
    
    
    
4. Firmware Requirements
========================
        
        Gotthard
        ========   
        Minimum compatible version  : 11.01.2013
        Latest compatible version   : 08.02.2018 (50um and 25um Master)
                                      09.02.2018 (25 um Slave) 
        Eiger
        =====  
        Minimum compatible version  : 24
        Latest compatible version   : 24
        
        Jungfrau
        ========       
        Minimum compatible version  : 26.02.2018
        Latest compatible version   : 06.12.2018

        
        Detector Upgrade
        ================
        Gotthard    Cannot be upgraded remotely. Requires programming via USB blaster
        Eiger       Can be upgraded remotely via bit files
        Jungfrau    Can be upgraded remotely using sls_detector_put programfpga <pof>
        
        Instructions available at
        https://slsdetectorgroup.github.io/slsDetectorPackage/docs/html/slsDetectorInstall/GOTTHARD_Firmware.html
        https://slsdetectorgroup.github.io/slsDetectorPackage/docs/html/slsDetectorInstall/EIGER_Firmware.html
        https://slsdetectorgroup.github.io/slsDetectorPackage/docs/html/slsDetectorInstall/JUNGFRAU_Firmware.html

         
    Please refer to the link below for more details on the firmware versions.
    https://www.psi.ch/en/detectors/firmware
    
    
        
5. Download, Documentation & Support
====================================

    Download
    --------
    
    The Source Code (Default C++ API):
         https://github.com/slsdetectorgroup/slsDetectorPackage
         
    The Conda Lib Package:
        https://github.com/slsdetectorgroup/sls_detector_lib
        
    The Conda GUI Package:
        https://github.com/slsdetectorgroup/sls_detector_gui    
        
    The Python Interface (including the package):
        https://github.com/slsdetectorgroup/sls_detector
    
    
    Documentation
    -------------
    
    Manual (HTML & PDF):
        https://www.psi.ch/en/detectors/documentation
        slsDetectorPackage/manual/docs/
        
    Command Line Documentation:
        https://slsdetectorgroup.github.io/slsDetectorPackage/docs/html/slsDetectorClientDocs/index.html
        https://slsdetectorgroup.github.io/slsDetectorPackage/docs/pdf/slsDetectorClientDocs.pdf

        manual/docs/html/slsDetectorClientDocs/index.html
        manual/docs/pdf/slsDetectorClientDocs.pdf
        
    C++ API Documentation:
        https://slsdetectorgroup.github.io/slsDetectorPackage/docs/html/slsDetectorUsersDocs/index.html
        https://slsdetectorgroup.github.io/slsDetectorPackage/docs/pdf/slsDetectorUsersDocs.pdf

        manual/docs/html/slsDetectorUsersDocs/index.html
        manual/docs/pdf/slsDetectorUsersDocs.pdf
        
    C++ API Example:
        https://slsdetectorgroup.github.io/slsDetectorPackage/exampleCode/slsDetectorUsersExample/index.html

        manual/manual-api/mainClient.cpp
        manual/manual-api/mainReceiver.cpp
        
    Python API Documentation:
        https://slsdetectorgroup.github.io/sls_detector/

    TroubleShotting:
        https://www.psi.ch/en/detectors/troubleshooting
        
    Further Documentation:
        https://www.psi.ch/en/detectors/users-support
        
    
    Support
    -------

        dhanya.thattil@psi.ch
        erik.frojdh@psi.ch
        anna.bergamaschi@psi.ch