diff --git a/RELEASE.txt b/RELEASE.txt index 1cb0a2d35..f27091e52 100755 --- a/RELEASE.txt +++ b/RELEASE.txt @@ -19,65 +19,62 @@ This document describes the differences between 6.0.0 and 5.2.0 releases. 1. New or Changed Features ========================== - Jungfrau - -------- + Client + ------ - 1. Features for chipv1.1 incorporated - - 2. Chip version + 1. [Jungfrau] Chip version + Features for chipv1.1 incorporated Command line: chipversion, API: getchipVersion gets chip version (1.0 or 1.1) chipv1.1 requires config_jungfrau.txt on detector server. - 3. Chip configuration (only chipv1.1) + 2. [Jungfrau] Chip configuration (only chipv1.1) powering on the chip and changing settings will configure the chip. Hence, required before acquisition. - 4. Settings and Gain mode + 3. [Jungfrau] Settings and Gain mode Settings can be gain0 and highgain0. Gain mode can be dynamicgain, forceswitchg1, forceswitchg2, fixg1, fixg2, fixg0. fixg0 must be used with EXTRA caution as you can damage the detector. Changing settings also changes dac values of 3 dacs () and reconfigures chip (only v1.1) - 5. Storage cells (only chipv1.1) + 4. [Jungfrau] Storage cells (only chipv1.1) Additional number of storage cells not applicable for chipv1.1. Storage cell start is only allowed from 0 - 3 for chipv1.1 (0 - 15 for chipv1.0). - 6. Filter cell (only chipv1.1) - Command line: filtercell, API: getFilterCell/ setFilterCell - Set filter cell. Options: [0-12]. Advanced user command. - - 7. Comparator disable time (only chipv1.1) - Command line: comp_disable_time, API: getComparatorDisableTime/ - setComparatorDisableTime - One can customize the period to disable comparator. - - Others - ------ - - 1. Flip rows [Eiger][Jungfrau] - Command line: fliprows, API: getFlipRows/ setFlipRows - Previous command: flippeddatax, setBottom/ getBottom - [Jungfrau] Flips rows in detector only for HW v2.0. - slsReceiver and slsDetectorGui will not flip them again. - [Eiger] same as before. - - 2. Read n rows [Eiger][Jungfrau] - Command line: readnrows, API: getReadNRows/ setReadNRows - Previous Command: readnlines, getPartialReadout/ setPartialReadout - [Eiger] same as before - [Jungfrau] Options: 8 - 512, multiples of 8. Default is 512. - - 2. Filter Resistor [Gotthard2][Jungfrau] + 5. [Gotthard2][Jungfrau] Filter Resistor Command line: filterresistor, API: getFilterResistor/ setFilterResistor Previous Command: filter, setFilter/ getFilter Set Filter resistor. Increasing values for increasing resistance. [Jungfrau] only for chipv1.1. Options: [0|1]. Default is 1. [Gotthard2] Options: [0|1|2|3]. Default is 0. - 3. Current source [Gotthard2][Jungfrau] + 6. [Jungfrau] Filter cell (only chipv1.1) + Command line: filtercell, API: getFilterCell/ setFilterCell + Set filter cell. Options: [0-12]. Advanced user command. + + 7. [Jungfrau] Comparator disable time (only chipv1.1) + Command line: comp_disable_time, API: getComparatorDisableTime/ + setComparatorDisableTime + One can customize the period to disable comparator. + + 8. [Eiger][Jungfrau] Flip rows + Command line: fliprows, API: getFlipRows/ setFlipRows + Previous command: flippeddatax, setBottom/ getBottom + [Jungfrau] Flips rows in detector only for HW v2.0. + slsReceiver and slsDetectorGui will not flip them again. + [Eiger] same as before. + + 9. [Eiger][Jungfrau] Read n rows + Command line: readnrows, API: getReadNRows/ setReadNRows + Previous Command: readnlines, getPartialReadout/ setPartialReadout + [Eiger] same as before + [Jungfrau] Options: 8 - 512, multiples of 8. Default is 512. + + + 10. [Gotthard2][Jungfrau] Current source Command line: currentsource, API: getCurrentSource, setCurrentSource Enable or disable current source. Default is disabled. [Gotthard2] Can only enable or disable. @@ -85,87 +82,80 @@ This document describes the differences between 6.0.0 and 5.2.0 releases. current. Normal/ low only for chipv1.1. Select source is 0-63 for chipv1.0 and a 64 bit mask for chipv1.1. - 2. Default dac + 11. Default dac Command line: defaultdac, API: getDefaultDac/ setDefaultDac change default value of a dac [Jungfrau][Mythen3] Also change default value of dac for particular setting. - 3. Reset dacs + 12. Reset dacs Command line: resetdacs, API: resetToDefaultDacs Previous command: defaultdacs Resets dacs to their default values or hard coded values. - + 13. [Mythen3] Gain Capacitance + Command line: gaincaps, API: getGainCaps/ setGainCaps + Set various gain capacitances. + 14. [Gotthard2] Veto Streaming from chip + Command line: veto, API: getVeto/ setVeto + This command used to mean veto streaming from detector. Now, it means + veto streaming from chip (New feature). Default is disabled. + 15. [Gotthard2] Veto streaming from detector + Command line: vetostream, API: getVetoStream, setVetoStream + Options: None, local link interface, 10 10GbE, Both + Default: None - Client - ------ - 1. Setting Mythen3 gain from command line - - - 2. (Gotthard2) veto streaming - New command to enable/ disable veto streaming via 2.5GbE or/ and 10GbE - (debugging). - Command: vetostream, Detector::setVetoStream + 16. [Gotthard2] Veto algorithm + Command line: vetoalg, API: getVetoAlgorithm/ setVetoAlgorithm + Set veto algorithm for each interface. + Options: hits, raw + 17. [Eiger][Gotthard2][Mythen3] Module ID + Command line: moduleid, API: getModuleId + Previous command (Eiger only): serialnumber, getSerialNumber + Unique id read from txt file on detector and streamed out in udp header. + + 18. [Gotthard2] + Command line: dbitpipeline, API: getDBITPipeline/ setDBITPipeline + Set pipeline to latch digital bits. Options: 0-7 - 2. (Gotthard2) veto algorithm - New command to set veto algorithm for 2.5GbE or 10GbE (debugging). - Command: vetoalg, Detector::setVetoAlgorithm - Gotthard2 server + Detector servers ---------------- - 1. Bad Channels moved to a new register + 1. [Gotthard2] Bad Channels moved to a new register + + 2. [Gotthard2] Updated config file in detector server - Jungfrau- many Features + Virtual servers + ---------------- + + 1. Artifical pixel values increasing by every packet, instead of every pixel. + + - 2. Resolved Issues ================== - Jungfrau - -------- - - 1. - - Gotthard2 Server + Detector Servers ---------------- - 1. Tolerance in time parameters. + 1. [Gotthard2] Tolerance in time parameters. Eg. 220 ns was being set to 215 ns, instead of 222ns. - - - Jungfrau Server - ---------------- - - 1. Stopping in trigger mode and then switching to auto timing mode + 1. [Jungfrau] Stopping in trigger mode and then switching to auto timing mode blocks data streaming from detector. Workaround fix made in - detector server to reset core until firmware release. + detector server to reset core until next firmware release. -getAutoCompDisable->getAutoComparatorDisable -filter->filterResistor -setBottom->setFlipRows -currentsource expects currentsrcparameters structure instread of bool - -g2: -updated config file indetector server -vetoalg -vetostream -serialnumber (put) -dbitpipeline -readnlines->readnrows -serialnumber->moduleid setting number of udp interfaces from 1 to 2, didnt get image in gui -virtual server plots increasing values for every packet.. not every pixel + 3. Firmware Requirements ======================== @@ -222,6 +212,7 @@ virtual server plots increasing values for every packet.. not every pixel + 5. Known Issues =============== diff --git a/python/slsdet/detector.py b/python/slsdet/detector.py index 888d7df0e..12449391e 100755 --- a/python/slsdet/detector.py +++ b/python/slsdet/detector.py @@ -2454,7 +2454,7 @@ class Detector(CppDetectorApi): Note ---- Options: - (vetoAlgorithm): ALG_HITS, ALG_RAW + (vetoAlgorithm): ALG_HITS (default), ALG_RAW (streamingInterface): ETHERNET_10GB, LOW_LATENCY_LINK Example ---------- diff --git a/slsDetectorSoftware/include/sls/Detector.h b/slsDetectorSoftware/include/sls/Detector.h index 7f4082370..01dd0dcb4 100644 --- a/slsDetectorSoftware/include/sls/Detector.h +++ b/slsDetectorSoftware/include/sls/Detector.h @@ -1363,7 +1363,7 @@ class Detector { getVetoAlgorithm(const defs::streamingInterface value, Positions pos = {}) const; - /** [Gotthard2] Options(vetoAlgorithm): ALG_HITS, ALG_RAW. + /** [Gotthard2] Options(vetoAlgorithm): ALG_HITS (default), ALG_RAW. * Options(streamingInterface): LOW_LATENCY_LINK, ETHERNET_10GB */ void setVetoAlgorithm(const defs::vetoAlgorithm alg, const defs::streamingInterface value, diff --git a/slsDetectorSoftware/src/CmdProxy.cpp b/slsDetectorSoftware/src/CmdProxy.cpp index 833a4008f..5f4842a9a 100644 --- a/slsDetectorSoftware/src/CmdProxy.cpp +++ b/slsDetectorSoftware/src/CmdProxy.cpp @@ -2136,7 +2136,7 @@ std::string CmdProxy::VetoAlgorithm(int action) { os << cmd << ' '; if (action == defs::HELP_ACTION) { os << "[hits|raw] [lll|10gbe]\n\t[Gotthard2] Set the veto " - "algorithm." + "algorithm. Default is hits." << '\n'; } else if (action == defs::GET_ACTION) { if (args.size() != 1) {