mirror of
https://github.com/slsdetectorgroup/slsDetectorPackage.git
synced 2025-06-07 10:30:41 +02:00
doc update
This commit is contained in:
parent
c2d9532a69
commit
ff3c79eaaa
77
RELEASE.txt
77
RELEASE.txt
@ -1,4 +1,4 @@
|
||||
SLS Detector Package 5.0.0-rc2 released on 05.10.2020 (Release Candidate 2)
|
||||
SLS Detector Package 5.0.0-rc2 released on 07.10.2020 (Release Candidate 2)
|
||||
===========================================================================
|
||||
|
||||
CONTENTS
|
||||
@ -12,58 +12,56 @@ SLS Detector Package 5.0.0-rc2 released on 05.10.2020 (Release Candidate 2)
|
||||
|
||||
Eiger
|
||||
=====
|
||||
Minimum compatible version : 27
|
||||
Latest compatible version : 27
|
||||
Compatible version : 08.09.2020 (v27)
|
||||
|
||||
Jungfrau
|
||||
========
|
||||
Minimum compatible version (PCB v1.0) : 24.07.2020 (v1.1)
|
||||
Latest compatible version (PCB v1.0) : 24.07.2020 (v1.1)
|
||||
Minimum compatible version (PCB v2.0) : 21.07.2020 (v2.1)
|
||||
Latest compatible version (PCB v2.0) : 21.07.2020 (v2.1)
|
||||
Compatible version : 24.07.2020 (v1.1, PCB v1.0)
|
||||
: 21.07.2020 (v2.1, PCB v2.0)
|
||||
|
||||
Gotthard
|
||||
========
|
||||
Minimum compatible version : 11.01.2013
|
||||
Latest compatible version : 08.02.2018 (50um and 25um Master)
|
||||
09.02.2018 (25 um Slave)
|
||||
Compatible version : 08.02.2018 (50um and 25um Master)
|
||||
: 09.02.2018 (25 um Slave)
|
||||
|
||||
Mythen3
|
||||
=======
|
||||
Minimum compatible version : 25.09.2020
|
||||
Latest compatible version : 25.09.2020
|
||||
Compatible version : 25.09.2020 (v1.1)
|
||||
|
||||
Gotthard2
|
||||
=========
|
||||
Minimum compatible version : 25.09.2020
|
||||
Latest compatible version : 25.09.2020
|
||||
Compatible version : 25.09.2020 (development)
|
||||
|
||||
Moench
|
||||
======
|
||||
Minimum compatible version : 02.03.2020
|
||||
Latest compatible version : 02.03.2020
|
||||
Compatible version : 10.05.2020 (v1.0)
|
||||
|
||||
Ctb
|
||||
===
|
||||
Minimum compatible version : 27.11.2019
|
||||
Latest compatible version : 27.11.2019
|
||||
Compatible version : 10.05.2019 (v1.0)
|
||||
|
||||
|
||||
Detector Upgrade
|
||||
================
|
||||
Eiger Remotely via bit files
|
||||
Jungfrau Remotely using sls_detector_put programfpga <pof>
|
||||
Gotthard Cannot be upgraded remotely. Requires programming via USB blaster
|
||||
Mythen3 Remotely using sls_detector_put programfpga <rbf>
|
||||
Gotthard2 Remotely using sls_detector_put programfpga <rbf>
|
||||
Moench Remotely using sls_detector_put programfpga <pof>
|
||||
Ctb Remotely using sls_detector_put programfpga <pof>
|
||||
|
||||
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
|
||||
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
|
||||
Please refer to the link below for more details on the firmware versions.
|
||||
https://www.psi.ch/en/detectors/firmware
|
||||
|
||||
|
||||
2. Download, Documentation & Support
|
||||
@ -72,7 +70,7 @@ SLS Detector Package 5.0.0-rc2 released on 05.10.2020 (Release Candidate 2)
|
||||
Download
|
||||
--------
|
||||
|
||||
The Source Code (Default C++ API):
|
||||
The Source Code:
|
||||
https://github.com/slsdetectorgroup/slsDetectorPackage
|
||||
|
||||
Documentation
|
||||
@ -80,12 +78,24 @@ SLS Detector Package 5.0.0-rc2 released on 05.10.2020 (Release Candidate 2)
|
||||
|
||||
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
|
||||
@ -100,12 +110,15 @@ SLS Detector Package 5.0.0-rc2 released on 05.10.2020 (Release Candidate 2)
|
||||
https://slsdetectorgroup.github.io/devdoc/pyexamples.html
|
||||
|
||||
TroubleShooting:
|
||||
https://www.psi.ch/en/detectors/troubleshooting
|
||||
https://slsdetectorgroup.github.io/devdoc/troubleshooting.html
|
||||
|
||||
Further Documentation:
|
||||
https://www.psi.ch/en/detectors/users-support
|
||||
https://www.psi.ch/en/detectors/documentation
|
||||
|
||||
|
||||
Old Release notes:
|
||||
https://www.psi.ch/en/detectors/latest-installation
|
||||
|
||||
|
||||
Support
|
||||
-------
|
||||
|
||||
|
||||
@ -5,31 +5,43 @@ Firmware Upgrade
|
||||
|
||||
Eiger
|
||||
-------------
|
||||
.. note ::
|
||||
| Eiger firmware can be upgraded remotely.
|
||||
| The programming executable (bcp) and corresponding bit files are provided by the SLS Detector group.
|
||||
|
||||
|
||||
Compatibility
|
||||
Download
|
||||
^^^^^^^^^^^^^
|
||||
- `bcp script <https://github.com/slsdetectorgroup/slsDetectorFirmware/blob/master/binaries/eiger/bcp>`__
|
||||
|
||||
**Release candidate 5.0.0-rc1**
|
||||
.. code-block:: bash
|
||||
- detector server corresponding to package in slsDetectorPackage/serverBin
|
||||
|
||||
Minimum compatible version : 27
|
||||
Latest compatible version : 27
|
||||
|
||||
`Older versions <https://www.psi.ch/en/detectors/latest-installation>`_
|
||||
- bit files
|
||||
.. list-table::
|
||||
:widths: 20 20 20 20 20
|
||||
:header-rows: 1
|
||||
|
||||
* - slsDetectorPackage
|
||||
- Hardware
|
||||
- Release Date
|
||||
- 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/>`__
|
||||
-
|
||||
|
||||
Corrsponding Detector Server
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
| **Location:**
|
||||
| 5.0.0-rc1: slsDetectorPackage/slsDetectorServer/eigerDetectorServer/bin/eigerDetectorServer_developer
|
||||
|
||||
Upgrade
|
||||
^^^^^^^^
|
||||
#. Tftp must be already installed on your pc to use the bcp executable.
|
||||
#. 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.
|
||||
|
||||
@ -99,36 +111,46 @@ Upgrade
|
||||
|
||||
Jungfrau
|
||||
-------------
|
||||
.. note ::
|
||||
| Jungfrau firmware can be upgraded remotely.
|
||||
| The corresponding programming file (pof) is provided by the SLS Detector group.
|
||||
|
||||
|
||||
Compatibility
|
||||
Download
|
||||
^^^^^^^^^^^^^
|
||||
- detector server corresponding to package in slsDetectorPackage/serverBin
|
||||
|
||||
**Release candidate 5.0.0-rc1**
|
||||
- pof files
|
||||
.. list-table::
|
||||
:widths: 20 20 20 20 20
|
||||
:header-rows: 1
|
||||
|
||||
.. code-block:: bash
|
||||
* - slsDetectorPackage
|
||||
- Hardware
|
||||
- Release Date
|
||||
- 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>`__
|
||||
-
|
||||
|
||||
# PCB v1.0
|
||||
Minimum compatible version : 24.07.2020 (v1.1)
|
||||
Latest compatible version : 24.07.2020 (v1.1)
|
||||
# PCB v2.0
|
||||
Minimum compatible version : 21.07.2020 (v2.1)
|
||||
Latest compatible version : 21.07.2020 (v2.1)
|
||||
|
||||
`Older versions <https://www.psi.ch/en/detectors/latest-installation>`_
|
||||
|
||||
|
||||
Corrsponding Detector Server
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
| **Location:**
|
||||
| 5.0.0-rc1: slsDetectorPackage/slsDetectorServer/jungfrauDetectorServer/bin/jungfrauDetectorServer_developer
|
||||
|
||||
|
||||
Upgrade (from v4.x.x)
|
||||
^^^^^^^^^^^^^^^^^^^^
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
#. Tftp must be installed on pc.
|
||||
|
||||
#. Update client package to the latest (5.0.0-rc1).
|
||||
@ -179,8 +201,8 @@ Upgrade (from v4.x.x)
|
||||
jungfrauDetectorServervxxx --stop-server 1953
|
||||
|
||||
|
||||
Upgrade (from v5.0.0-rc1)
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
Upgrade (from v5.0.0-rcx)
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
#. Program from console
|
||||
.. code-block:: bash
|
||||
@ -197,33 +219,45 @@ Upgrade (from v5.0.0-rc1)
|
||||
Gotthard
|
||||
---------
|
||||
|
||||
Download
|
||||
^^^^^^^^^^^^^
|
||||
- detector server corresponding to package in slsDetectorPackage/serverBin
|
||||
|
||||
- pof files
|
||||
.. list-table::
|
||||
:widths: 15 15 15 15 5
|
||||
:header-rows: 1
|
||||
|
||||
* - slsDetectorPackage
|
||||
- Hardware
|
||||
- Release Date
|
||||
- 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.
|
||||
|
||||
|
||||
Compatibility
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
**Release candidate 5.0.0-rc1**
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
Minimum compatible version : 11.01.2013
|
||||
Latest compatible version : 08.02.2018 (50um and 25um Master)
|
||||
09.02.2018 (25 um Slave)
|
||||
|
||||
`Older versions <https://www.psi.ch/en/detectors/latest-installation>`_
|
||||
|
||||
Corrsponding Detector Server
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
| **Location:**
|
||||
| 5.0.0-rc1: slsDetectorPackage/slsDetectorServer/gotthardDetectorServer/bin/gotthardDetectorServer_developer
|
||||
|
||||
Upgrade
|
||||
^^^^^^^^
|
||||
|
||||
#. Download `Altera Quartus software or Quartus programmer <https://fpgasoftware.intel.com/20.1/?edition=standard&platform=linux&product=qprogrammer#tabs-4>`_.
|
||||
#. 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.
|
||||
@ -243,28 +277,30 @@ Upgrade
|
||||
|
||||
Mythen3
|
||||
-------
|
||||
.. note ::
|
||||
| Mythen3 firmware can be upgraded remotely.
|
||||
| The corresponding programming file (rbf) is provided by the SLS Detector group.
|
||||
|
||||
|
||||
Compatibility
|
||||
Download
|
||||
^^^^^^^^^^^^^
|
||||
- detector server corresponding to package in slsDetectorPackage/serverBin
|
||||
|
||||
**Release candidate 5.0.0-rc1**
|
||||
- rbf files
|
||||
.. list-table::
|
||||
:widths: 20 20 20 20 20
|
||||
:header-rows: 1
|
||||
|
||||
.. code-block:: bash
|
||||
* - slsDetectorPackage
|
||||
- Hardware
|
||||
- Release Date
|
||||
- Link
|
||||
- Comments
|
||||
* - v5.0.0-rcx
|
||||
-
|
||||
- 25.09.2020
|
||||
-
|
||||
-
|
||||
|
||||
Minimum compatible version : 25.09.2020
|
||||
Latest compatible version : 25.09.2020
|
||||
|
||||
Corrsponding Detector Server
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
| **Location:**
|
||||
| 5.0.0-rc1: slsDetectorPackage/slsDetectorServer/mythen3DetectorServer/bin/mythen3DetectorServer_developer
|
||||
|
||||
Upgrade (from v5.0.0-rc1)
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
Upgrade (from v5.0.0-rcx)
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
#. Program from console
|
||||
.. code-block:: bash
|
||||
@ -279,29 +315,30 @@ Upgrade (from v5.0.0-rc1)
|
||||
|
||||
|
||||
Gotthard2
|
||||
----------
|
||||
.. note ::
|
||||
| Gotthard2 firmware can be upgraded remotely.
|
||||
| The corresponding programming file (rbf) is provided by the SLS Detector group.
|
||||
-------------
|
||||
|
||||
|
||||
Compatibility
|
||||
Download
|
||||
^^^^^^^^^^^^^
|
||||
- detector server corresponding to package in slsDetectorPackage/serverBin
|
||||
|
||||
**Release candidate 5.0.0-rc1**
|
||||
- rbf files
|
||||
.. list-table::
|
||||
:widths: 20 20 20 20 20
|
||||
:header-rows: 1
|
||||
|
||||
.. code-block:: bash
|
||||
* - slsDetectorPackage
|
||||
- Hardware
|
||||
- Release Date
|
||||
- Link
|
||||
- Comments
|
||||
* - v5.0.0-rcx
|
||||
-
|
||||
- 25.09.2020
|
||||
-
|
||||
-
|
||||
|
||||
Minimum compatible version : 25.09.2020
|
||||
Latest compatible version : 25.09.2020
|
||||
|
||||
Corrsponding Detector Server
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
| **Location:**
|
||||
| 5.0.0-rc1: slsDetectorPackage/slsDetectorServer/gotthard2DetectorServer/bin/gotthard2DetectorServer_developer
|
||||
|
||||
Upgrade (from v5.0.0-rc1)
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
Upgrade (from v5.0.0-rcx)
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
#. Program from console
|
||||
.. code-block:: bash
|
||||
@ -316,29 +353,35 @@ Upgrade (from v5.0.0-rc1)
|
||||
|
||||
|
||||
Moench
|
||||
------
|
||||
.. note ::
|
||||
| Moench firmware can be upgraded remotely.
|
||||
| The corresponding programming file (pof) is provided by the SLS Detector group.
|
||||
-------
|
||||
|
||||
|
||||
Compatibility
|
||||
Download
|
||||
^^^^^^^^^^^^^
|
||||
- detector server corresponding to package in slsDetectorPackage/serverBin
|
||||
|
||||
**Release candidate 5.0.0-rc1**
|
||||
- pof files
|
||||
.. list-table::
|
||||
:widths: 20 20 20 20 20
|
||||
:header-rows: 1
|
||||
|
||||
.. code-block:: bash
|
||||
* - slsDetectorPackage
|
||||
- Hardware
|
||||
- Release Date
|
||||
- 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>`__
|
||||
-
|
||||
|
||||
Minimum compatible version : 02.03.2020
|
||||
Latest compatible version : 02.03.2020
|
||||
|
||||
Corrsponding Detector Server
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
| **Location:**
|
||||
| 5.0.0-rc1: slsDetectorPackage/slsDetectorServer/moenchDetectorServer/bin/moenchDetectorServer_developer
|
||||
|
||||
Upgrade (from v5.0.0-rc1)
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
Upgrade (from v5.0.0-rcx)
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
#. Program from console
|
||||
.. code-block:: bash
|
||||
@ -352,29 +395,35 @@ Upgrade (from v5.0.0-rc1)
|
||||
sls_detector_put programfpga xxx.pof
|
||||
|
||||
Ctb
|
||||
---
|
||||
.. note ::
|
||||
| Ctb firmware can be upgraded remotely.
|
||||
| The corresponding programming file (pof) is provided by the SLS Detector group.
|
||||
----
|
||||
|
||||
|
||||
Compatibility
|
||||
Download
|
||||
^^^^^^^^^^^^^
|
||||
- detector server corresponding to package in slsDetectorPackage/serverBin
|
||||
|
||||
**Release candidate 5.0.0-rc1**
|
||||
- pof files
|
||||
.. list-table::
|
||||
:widths: 20 20 20 20 20
|
||||
:header-rows: 1
|
||||
|
||||
.. code-block:: bash
|
||||
* - slsDetectorPackage
|
||||
- Hardware
|
||||
- Release Date
|
||||
- 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>`__
|
||||
-
|
||||
|
||||
Minimum compatible version : 27.11.2019
|
||||
Latest compatible version : 27.11.2019
|
||||
|
||||
Corrsponding Detector Server
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
| **Location:**
|
||||
| 5.0.0-rc1: slsDetectorPackage/slsDetectorServer/ctbDetectorServer/bin/ctbDetectorServer_developer
|
||||
|
||||
Upgrade (from v5.0.0-rc1)
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
Upgrade (from v5.0.0-rcx)
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
#. Program from console
|
||||
.. code-block:: bash
|
||||
|
||||
@ -70,12 +70,6 @@ exposed to Python through pybind11.
|
||||
.. autoclass:: masterFlags
|
||||
:undoc-members:
|
||||
|
||||
.. autoclass:: frameModeType
|
||||
:undoc-members:
|
||||
|
||||
.. autoclass:: detectorModeType
|
||||
:undoc-members:
|
||||
|
||||
.. autoclass:: burstMode
|
||||
:undoc-members:
|
||||
|
||||
|
||||
@ -217,9 +217,9 @@ The enums can be found in slsdet.enums
|
||||
|
||||
import slsdet
|
||||
>>> [e for e in dir(slsdet.enums) if not e.startswith('_')]
|
||||
['burstMode', 'clockIndex', 'dacIndex', 'detectorModeType',
|
||||
['burstMode', 'clockIndex', 'dacIndex',
|
||||
'detectorSettings', 'detectorType', 'dimension', 'externalSignalFlag',
|
||||
'fileFormat', 'frameDiscardPolicy', 'frameModeType', 'masterFlags',
|
||||
'fileFormat', 'frameDiscardPolicy', 'masterFlags',
|
||||
'readoutMode', 'runStatus', 'speedLevel', 'timingMode',
|
||||
'timingSourceType']
|
||||
|
||||
|
||||
@ -1,6 +1,32 @@
|
||||
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.
|
||||
@ -8,18 +34,3 @@ Detector Servers include:
|
||||
* 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.
|
||||
|
||||
.. _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
|
||||
|
||||
@ -7,8 +7,7 @@ Eiger
|
||||
-------------
|
||||
|
||||
|
||||
| **Location:**
|
||||
| 5.0.0-rc1: slsDetectorPackage/slsDetectorServer/eigerDetectorServer/bin/eigerDetectorServer_developer
|
||||
**Location:** slsDetectorPackage/serverBin/ folder for every release.
|
||||
|
||||
|
||||
#. Kill old server and copy new server
|
||||
@ -39,11 +38,10 @@ Eiger
|
||||
Jungfrau
|
||||
-------------
|
||||
|
||||
| **Location:**
|
||||
| 5.0.0-rc1: slsDetectorPackage/slsDetectorServer/jungfrauDetectorServer/bin/jungfrauDetectorServer_developer
|
||||
**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-rc1)
|
||||
#. Program from console (only from 5.0.0-rcx)
|
||||
.. code-block:: bash
|
||||
|
||||
# copies new server from pc tftp folder, respawns and reboots
|
||||
@ -53,11 +51,10 @@ Jungfrau
|
||||
Gotthard
|
||||
---------
|
||||
|
||||
| **Location:**
|
||||
| 5.0.0-rc1: slsDetectorPackage/slsDetectorServer/gotthardDetectorServer/bin/gotthardDetectorServer_developer
|
||||
**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-rc1)
|
||||
#. Program from console (only from 5.0.0-rcx)
|
||||
.. code-block:: bash
|
||||
|
||||
# copies new server from pc tftp folder, respawns and reboots
|
||||
@ -68,11 +65,10 @@ Gotthard
|
||||
Mythen3
|
||||
-------
|
||||
|
||||
| **Location:**
|
||||
| 5.0.0-rc1: slsDetectorPackage/slsDetectorServer/mythen3DetectorServer/bin/mythen3DetectorServer_developer
|
||||
**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-rc1)
|
||||
#. Program from console (only from 5.0.0-rcx)
|
||||
.. code-block:: bash
|
||||
|
||||
# copies new server from pc tftp folder and reboots (does not respawn)
|
||||
@ -82,11 +78,10 @@ Mythen3
|
||||
Gotthard2
|
||||
----------
|
||||
|
||||
| **Location:**
|
||||
| 5.0.0-rc1: slsDetectorPackage/slsDetectorServer/gotthard2DetectorServer/bin/gotthard2DetectorServer_developer
|
||||
**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-rc1)
|
||||
#. Program from console (only from 5.0.0-rcx)
|
||||
.. code-block:: bash
|
||||
|
||||
# copies new server from pc tftp folder and reboots (does not respawn)
|
||||
@ -96,11 +91,10 @@ Gotthard2
|
||||
Moench
|
||||
------
|
||||
|
||||
| **Location:**
|
||||
| 5.0.0-rc1: slsDetectorPackage/slsDetectorServer/moenchDetectorServer/bin/moenchDetectorServer_developer
|
||||
**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-rc1)
|
||||
#. Program from console (only from 5.0.0-rcx)
|
||||
.. code-block:: bash
|
||||
|
||||
# copies new server from pc tftp folder, respawns and reboots
|
||||
@ -110,11 +104,10 @@ Moench
|
||||
Ctb
|
||||
---
|
||||
|
||||
| **Location:**
|
||||
| 5.0.0-rc1: slsDetectorPackage/slsDetectorServer/ctbDetectorServer/bin/ctbDetectorServer_developer
|
||||
**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-rc1)
|
||||
#. Program from console (only from 5.0.0-rcx)
|
||||
.. code-block:: bash
|
||||
|
||||
# copies new server from pc tftp folder, respawns and reboots
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user