diff --git a/RELEASE.txt b/RELEASE.txt index b6174fc8f..acb80f938 100755 --- a/RELEASE.txt +++ b/RELEASE.txt @@ -1,7 +1,7 @@ -SLS Detector Package 6.0.0 released on 21.10.2021 +SLS Detector Package x.x.x released on xx.xx.2021 ================================================== -This document describes the differences between v6.0.0 and v5.1.0. +This document describes the differences between vx.x.x and v6.0.0. @@ -20,272 +20,17 @@ This document describes the differences between v6.0.0 and v5.1.0. 1. New or Changed Features ========================== - Client - ------ - 1. Shared libraries - They are versioned from this release on (6.0.0). - - 2. [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 and HW 2.0. - - 3. [Jungfrau] Chip configuration (only chipv1.1) - powering on the chip and changing settings will configure the chip. - Hence, required before acquisition. - - 4. [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 - (vref_prech, vref_ds and vref_comp) and reconfigures chip (only v1.1) - - 5. [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). - Command line: extrastoragecells, Previous Command line: storagecells - API: remains the same. - - 6. [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. - - 7. [Jungfrau] Filter cell (only chipv1.1) - Command line: filtercells, API: getNumberOfFilterCells/ setNumberOfFilterCells - Set filter cell. Options: [0-12]. Advanced user command. - - 8. [Jungfrau] Comparator disable time (only chipv1.1) - Command line: compdisabletime, API: getComparatorDisableTime/ - setComparatorDisableTime - One can customize the period to disable comparator. - - 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. - [Jungfrau] Can choose to fix, select source and choose normal or low - current. Normal/ low only for chipv1.1. - Select source is 0-63 for chipv1.0 and a 64 bit mask for chipv1.1. - - 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. - - 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 - 10GbE (as before) will enable 2 udp interfaces in receiver. - - 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 - - 19. [Eiger][Jungfrau] Round Robin commands - Command line, udp_dstlist, API: getDestinationUDPList/ - setDestinationUDPList - Round robin commands at the moment does not configure the receiver. - Set multiple udp destinations in the detector to stream udp data packets - to. Upto 32 destinations. Refer documentation for details. - - Command line, udp_numdst, API: getNumberofUDPDestinations - - [Jungfrau] Command line, udp_firstdst, API: getFirstUDPDestination/ - setFirstUDPDestination - - 20. Command Line Parsing - Parsing of detector index and module index has been modified to - integrate round robin index. - [detector index]-[module index]:[round robin index] [command] - - It is backwards compatible. - For ease, one can also execute - sls_detector_put [module index] [command] - - 21. Clear Udp Destination - Command line, udp_cleardst, API: clearUDPDestinations - This is useful when changing receivers for a detector or for round robin - system. - - 22. Shared Memory Naming - Shared memory name has been changed to reflect a more appropriate naming - scheme. - - 23. [Eiger][Mythen3] Blocking trigger - Command line: blockingtrigger, API: sendSoftwareTrigger - Sends software trigger signal to detector and blocks till frames are - sent out for that trigger. - - 24. [Eiger] Data stream enable for ports - Command line: datastream, API: getDataStream/ setDataStream - Enable or disable each port. Default: enabled - - 25. Changing TCP ports - This will only affect shared memory and will not try to change the - current tcp port of the control/stop server in detector. - - 26. [Eiger][Jungfrau][Gotthard2] Speed - Command line: readoutspeed, readoutspeedlist API: getReadoutSpeed/ setReadoutSpeed / - getReadoutSpeedList - Previous command: speed, setSpeed/ getSpeed - [Eiger][Jungfrau] same as before. - [Gotthard2] New command to set readout speed. Options: 108, 144 (in MHz) - - 27. [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. - - 28. [Jungfrau] - Command line changes: autocompdisable, Previous command line: auto_comp_disable - - - Detector servers - ---------------- - - 1. [Gotthard2] Bad Channels moved to a new register, default settings - including clock frequency changed - - 2. [Gotthard2] Updated config file in detector server - - - Virtual servers - ---------------- - - 1. Artifical pixel values increasing by every packet, instead of every pixel. - - 2. All possible features updated. - - - Receiver - -------- - - 1. Frames caught in metadata - Frames caught by the master receiver is added to master file metadata. - Hdf5 and Binary version numbers changed to 6.3 - - 2. Removed Padding option for Deactivated half modules. - - 3. Changing Receiver TCP ports - This will only affect shared memory and will not try to change the - current tcp port of the receiver. - - Gui - ---- - - 1. [Mythen3] counters added in settings tab - 2. Resolved Issues ================== - Detector Servers - ---------------- - - 1. [Gotthard2] Tolerance in time parameters. - Eg. 220 ns was being set to 215 ns, instead of 222ns. - - 2. [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 next firmware release. - - 3. [Jungfrau][CTB][Moench][Gotthard][Gotthard2][Mythen3] Firmware Programming - Firmware programming incorporates more validations such as checksum of - program. Always ensure client and server are of same release before - programming firmware. - - 4. [Eiger] Stop sends last frame - Stop acquisition will now also send out all complete frames in fifo. - - 5. [Eiger] Bottom not rotated in quad mode. Fixed. - - 6. [Mythen3] counter mask effect on vthreshold - Setting counter mask changes vth daac values (ie. disabling sets to 2800), - vthreshold only changes for enabled counters, setting vth overwrites - dac even if counter disabled and when counters enabled, remembers set - values. - - 7. [Eiger] fast quad fix for loading trimbits - - 8. [Eiger] Can also use copydetectorserver command. - [All] copydetectorserver command also creates a link to the binary copied - with a shorter name ([detector]DetectorServer only) - - Receiver - -------- - - 1. Disabled port or deactivated (half) modules will not create files. - - - +- setting rx_hostname to none threw an exception. fixed. 3. Known Issues =============== - Receiver - -------- - 1. It does not handle readnrows or partial readout. Only the summary - is adjusted to print in red. However, it will still write complete - images with missing data padded. Roi will be implemented in future - that can be complemented with this feature to remove the additional - data in files. - - 2. Round robin is not implemented in receiver side, ie. one cannot configure - more than 1 receiver at a time. This will/might be done in the future. - - - - -4. Changes in Next Major Release -================================ - - 1. Naming of Package - The package might be renamed and so might the binaries, libraries, - namespace,include paths in the next major release (which is breaking API). - - 5. Firmware Requirements