From 8e6dfe9b0f1dae9c0e8743bdc7fca31cc2e72a2e Mon Sep 17 00:00:00 2001 From: Dhanya Thattil Date: Wed, 25 Nov 2020 16:22:24 +0100 Subject: [PATCH] update docs --- RELEASE.txt | 6 +- docs/src/consuming.rst | 2 +- docs/src/firmware.rst | 176 +++++------------------------------------ 3 files changed, 22 insertions(+), 162 deletions(-) diff --git a/RELEASE.txt b/RELEASE.txt index bfdd95954..fc1c3793e 100755 --- a/RELEASE.txt +++ b/RELEASE.txt @@ -1,5 +1,5 @@ -SLS Detector Package 5.0.1 released on 18.11.2020 (Bugfix Release) -================================================================= +SLS Detector Package 5.0.1 released on 25.11.2020 (Bug Fix Release) +=================================================================== This document describes the differences between 5.0.1 and 5.0.0 releases. @@ -41,7 +41,7 @@ This document describes the differences between 5.0.1 and 5.0.0 releases. CMake improvements ------------------ - 1. Explicitly state Python 3.6 or greater + 1. Explicitly state Python 3.6 or greater. 2. Finds the Python of the activated environment when using conda without having to supply additional arguments. diff --git a/docs/src/consuming.rst b/docs/src/consuming.rst index ccf1453db..b66a01b23 100644 --- a/docs/src/consuming.rst +++ b/docs/src/consuming.rst @@ -9,7 +9,7 @@ CMake approaches. One can test with :ref:`detector simulators` before testing the API with a real detector or when a real detector is not at hand. CMake: slsDetectorPackage as submodule in your project ---------------------------------------- +--------------------------------------------------------------- If you are using CMake to build your integration and want to build everything in one go, we support adding slsDetectorPackage as a subfolder in your cmake project. diff --git a/docs/src/firmware.rst b/docs/src/firmware.rst index 98d75c45e..9eb00547a 100644 --- a/docs/src/firmware.rst +++ b/docs/src/firmware.rst @@ -12,32 +12,7 @@ Download - 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 `__ - - - * - v4.0.0 - v4.2.0 - - - - 30.07.2019 - - `v24 `__ - - - * - v3.1.0 - v3.1.5 - - - - 17.08.2017 - - `v20 `__ - - - +- `bit files `__ Upgrade ^^^^^^^^ @@ -116,37 +91,7 @@ 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 `__ - - - * - v5.0.0-rcx - - 1.0 - - 24.07.2020 - - `v1.1 `__ - - - * - v4.0.1 - v4.2.0 - - 1.0 - - 06.12.2018 - - `v0.7 `__ - - - * - v3.1.0 - v3.1.5 - - 1.0 - - 13.11.2017 - - `v0.6 `__ - - - +- `pof files `__ Upgrade (from v4.x.x) @@ -156,7 +101,7 @@ Check :ref:`firmware troubleshooting ` if you #. Tftp must be installed on pc. -#. Update client package to the latest (5.0.0-rc1). +#. Update client package to the latest (5.x.x). #. Disable server respawning or kill old server .. code-block:: bash @@ -204,7 +149,7 @@ Check :ref:`firmware troubleshooting ` if you jungfrauDetectorServervxxx --stop-server 1953 -Upgrade (from v5.0.0-rcx) +Upgrade (from v5.0.0) ^^^^^^^^^^^^^^^^^^^^^^^^^^ Check :ref:`firmware troubleshooting ` if you run into issues while programming firmware. @@ -230,31 +175,8 @@ Download ^^^^^^^^^^^^^ - detector server corresponding to package in slsDetectorPackage/serverBin -- pof files - .. list-table:: - :widths: 15 15 15 15 5 - :header-rows: 1 +- `pof files `__ - * - Software - - Hardware - - Firmware Date - - Firmware Link - - Comments - * - All versions - - 50um - - 08.02.2018 - - `50um `__ - - - * - All versions - - 25um (master) - - 08.02.2018 - - `25um (master) `__ - - - * - All versions - - 25um (slave) - - 09.02.2018 - - `25um (slave) `__ - - .. _firmware upgrade using blaster for blackfin: @@ -294,24 +216,10 @@ 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 +- rbf files (in developement) -Upgrade (from v5.0.0-rcx) +Upgrade (from v5.0.0) ^^^^^^^^^^^^^^^^^^^^^^^^^^^ #. Program from console @@ -337,23 +245,10 @@ Download ^^^^^^^^^^^^^ - detector server corresponding to package in slsDetectorPackage/serverBin -- rbf files - .. list-table:: - :widths: 25 10 30 25 10 - :header-rows: 1 +- rbf files (in development) - * - Software - - Hardware - - Firmware Date - - Firmware Link - - Comments - * - v5.0.0-rcx - - - - 25.09.2020 - - - - development -Upgrade (from v5.0.0-rcx) +Upgrade (from v5.0.0) ^^^^^^^^^^^^^^^^^^^^^^^^^^ #. Program from console @@ -375,28 +270,10 @@ Download ^^^^^^^^^^^^^ - detector server corresponding to package in slsDetectorPackage/serverBin -- pof files - .. list-table:: - :widths: 25 10 30 25 10 - :header-rows: 1 +- `pof files `__ - * - Software - - Hardware - - Firmware Date - - Firmware Link - - Comments - * - v5.0.0-rcx - - EPCQ128 - - 05.10.2020 - - `v1.0 `__ - - - * - v5.0.0-rcx - - EPCS128 - - 05.10.2020 - - `v1.0 `__ - - -Upgrade (from v5.0.0-rcx) +Upgrade (from v5.0.0) ^^^^^^^^^^^^^^^^^^^^^^^^^^^ Check :ref:`firmware troubleshooting ` if you run into issues while programming firmware. @@ -419,28 +296,10 @@ Download ^^^^^^^^^^^^^ - detector server corresponding to package in slsDetectorPackage/serverBin -- pof files - .. list-table:: - :widths: 25 10 30 25 10 - :header-rows: 1 +- `pof files `__ - * - Software - - Hardware - - Firmware Date - - Firmware Link - - Comments - * - v5.0.0-rcx - - EPCQ128 - - 05.10.2020 - - `v1.0 `__ - - - * - v5.0.0-rcx - - EPCS128 - - 05.10.2020 - - `v1.0 `__ - - -Upgrade (from v5.0.0-rcx) +Upgrade (from v5.0.0) ^^^^^^^^^^^^^^^^^^^^^^^^^^ Check :ref:`firmware troubleshooting ` if you run into issues while programming firmware. @@ -462,11 +321,12 @@ Check :ref:`firmware troubleshooting ` if you Firmware Troubleshooting with blackfin ---------------------------------------- -#. v4.x.x client after programming will most likely reboot the blackfin processor, regardless of error. +1. v4.x.x client after programming will most likely reboot the blackfin processor, regardless of error. -#. v5.x.x-rcx client after programming will not reboot the blackfin processor, if error occurred. +2. v5.x.x-rcx client after programming will not reboot the blackfin processor, if error occurred. + +3. If a reboot occured with an incomplete firmware in flash, the blackfin will most likely not find the mtd3 drive. To see if this drive exists: -#. If a reboot occured with an incomplete firmware in flash, the blackfin will most likely not find the mtd3 drive. To see if this drive exists: .. code-block:: bash # connect to the board @@ -482,7 +342,7 @@ Firmware Troubleshooting with blackfin 4. If one can see the mtd3 drive, one can already try to flash again using the **programfpga** command (without rebooting blackfin or detector). -#. If one can't list it, read the next section to try to get the blackfin to list it. +5. If one can't list it, read the next section to try to get the blackfin to list it. How to get back mtd3 drive remotely ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^