diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt index 3671653c1..ceb5fa66a 100644 --- a/docs/CMakeLists.txt +++ b/docs/CMakeLists.txt @@ -48,6 +48,7 @@ set(SPHINX_SOURCE_FILES src/firmware.rst src/serverupgrade.rst src/virtualserver.rst + src/serverdefaults.rst ) diff --git a/docs/src/index.rst b/docs/src/index.rst index 9df1cc852..ee91fcd73 100644 --- a/docs/src/index.rst +++ b/docs/src/index.rst @@ -61,6 +61,7 @@ Welcome to slsDetectorPackage's documentation! servers serverupgrade virtualserver + serverdefaults diff --git a/docs/src/serverdefaults.rst b/docs/src/serverdefaults.rst new file mode 100644 index 000000000..fa372c426 --- /dev/null +++ b/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 \ No newline at end of file diff --git a/docs/src/servers.rst b/docs/src/servers.rst index c68b97f65..a573cb850 100644 --- a/docs/src/servers.rst +++ b/docs/src/servers.rst @@ -1,108 +1,25 @@ -Default values -============================================== +Detector Servers +================= -Some general intro +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. -Mythen3 -------------- +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. -.. csv-table:: Default values - :file: mythen3.csv - :widths: 35, 35 - :header-rows: 1 +.. _Detector Server Arguments: +Arguments +--------- -DACS -^^^^^^^^^^^^^ + .. code-block:: bash -.. 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 \ No newline at end of file + Possible arguments are: + -v, --version : Software version + -p, --port : TCP communication port with client. + -g, --nomodule : [Mythen3][Gotthard2] Generic or No Module mode. Skips detector type checks. + -f, --phaseshift : [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 diff --git a/docs/src/virtualserver.rst b/docs/src/virtualserver.rst index d56bbe6c1..e142e3327 100644 --- a/docs/src/virtualserver.rst +++ b/docs/src/virtualserver.rst @@ -34,26 +34,16 @@ Binaries Arguments --------- -The arguments are the same as the normal server. - .. code-block:: bash - - Possible arguments are: - -v, --version : Software version - -p, --port : TCP communication port with client. - -g, --nomodule : [Mythen3][Gotthard2] Generic or No Module mode. Skips detector type checks. - -f, --phaseshift : [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 +The arguments are the same as the :ref:`normal server arguments`. When using multiple modules, the most important one for the virtual server is to have different ports for each virtual server. .. code-block:: bash # will start control server at port 1912 and stop server at port 1913 - mythen3DetectorServer --port 1912 & + jungfrauDetectorServer --port 1912 & # will start second control server at port 1914 and stop server at port 1915 - mythen3DetectorServer --port 1914 & + jungfrauDetectorServer --port 1914 & Client