slsDetectorPackage/RELEASE.txt

SLS Detector Package 5.0.0 released on xx.xx.2020 (Major Release)
=================================================================

    CONTENTS
    --------
    1.	Topics Concerning
    2.  New Features
    3.  Resolved Issues
    4.  Firmware Requirements
    5.  Download, Documentation & Support


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

    - Compilation requirements
    - Manuals
    - Client API complete change
    - Exceptions
    - Scans (dacs and trimbit)
    - Command line timing commands (s, ms, us etc.)
    - daclist, dacvalues, settingslist, drlist etc.
    - Detector Simulators
    - Zmq interface (ZmqSocket.h)
    - Gui (zmq high water mark)
    - Receiver (additional metadata)
    - (Jungfrau server) settings and default dacs
    - (Eiger server) blocked when stopping or status
    - UDP configuration change





2. New Features
===============

    Client
    ------
    1.  Compilation requirements are different now.
            https://slsdetectorgroup.github.io/devdoc/dependencies.html
        Gui not included in default cmk.sh script. Must be explicitly asked for.

    2.  Manuals can be compiled in the package. 
            https://slsdetectorgroup.github.io/devdoc/installation.html#build-this-documentation
        Or refer to the documentation provided in 
            https://slsdetectorgroup.github.io/devdoc/index.html

    3.  API changed to Detector class. 
        C++: Detector.h
            Documentation:
                https://slsdetectorgroup.github.io/devdoc/detector.html
            Examples to use the Detector class:
                https://github.com/slsdetectorgroup/api-examples

        Python API Documentation: 
            https://slsdetectorgroup.github.io/devdoc/pydetector.html

        Command line:
            Many commands have become deprecated. They will still execute, 
            but give a warning.
            Documentation:
                https://slsdetectorgroup.github.io/devdoc/commandline.html
    
    4.  Exceptions are thrown instead of providing error codes.
            sls_detector_exceptions.h
        Make sure you catch all exceptions in custom gui and handle them or 
        inform the user.


    Detector Servers
    ----------------

    1.  Detector Simulators or virtual detector servers for every detector 
        have been provided. They are compiled along with the client by enabling
        its option. They should also send fake data (increasing pixel/channel value).  


    
        
    


3. Resolved Issues
==================


4. 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

    
5. 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
        
    API Examples:
        https://github.com/slsdetectorgroup/api-examples

    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
        
    Info on Releases:
        https://www.psi.ch/en/detectors/software


    Support
    -------

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